Explicit test for using library implemented as a module. #43

Author: pekkaklarck

test/atest/basic_communication.robot

@@ -1,4 +1,7 @@
 *** Settings ***
+Documentation     Testing basic communication using a class based library.
+...               `module.robot` contains same tests using a library
+...               implemented as a module.
 Resource          resource.robot
 Suite Setup       Start And Import Remote Library    Basics.py
 Suite Teardown    Stop Remote Library

test/atest/module.robot

@@ -0,0 +1,45 @@
+*** Settings ***
+Documentation     Testing basic communication using a module based library.
+...               `basic_communication.robot` contains same tests using
+...               a library implemented as a class.
+Resource          resource.robot
+Suite Setup       Start And Import Remote Library    Module.py
+Suite Teardown    Stop Remote Library
+
+*** Variables ***
+${COUNT}          100
+
+*** Test Cases ***
+Passing
+    Passing
+
+Failing
+    [Documentation]    FAIL This is the error we get
+    Failing    This is the error we get
+    Fail    This should not be executed
+
+Logging
+    [Documentation]    LOG 1 INFO Hello, world! LOG 2 WARN Warning, warning!!
+    Logging    Hello, world!
+    Logging    Warning, warning!!    WARN
+
+Returning
+    ${ret} =    Returning    return this
+    Should Be Equal    ${ret}    return this
+
+Use multiple times
+    [Documentation]
+    ...    LOG 1.1.2 Round 1
+    ...    LOG 1.2.2 Round 2
+    ...    LOG 1.${COUNT}.2 Round ${COUNT}
+    : FOR    ${i}    IN RANGE    ${COUNT}
+    \    Passing
+    \    Logging    Round ${i + 1}
+
+Private methods should ne ignored
+    [Documentation]    FAIL No keyword with name 'Private Method' found.
+    Private Method
+
+Attributes should be ignored
+    [Documentation]    FAIL No keyword with name 'ATTRIBUTE' found.
+    ATTRIBUTE

test/libs/Basics.py

@@ -2,7 +2,10 @@
 
 
 class BasicCommunication(object):
-    """Testing basic communication and keyword documentation."""
+    """Testing basic communication and keyword documentation using a class.
+
+    Module.py has same stuff but using a module, not a class, as a library.
+    """
 
     def passing(self):
         """This keyword passes.
@@ -12,9 +15,7 @@ def passing(self):
         pass
 
     def get_pid(self):
-        """
-        Returns process id for the remote server that is serving this library.
-        """
+        """Return process id of the server that is serving this library."""
         return os.getpid()
 
     def failing(self, message):

test/libs/Module.py

@@ -0,0 +1,66 @@
+import os
+
+
+"""Testing basic communication and keyword documentation using module.
+
+Same stuff as in Basics.py but this library is implemented as a module,
+not as a class.
+"""
+
+
+def passing():
+    """This keyword passes.
+
+    See `Failing`, `Logging`, and `Returning` for other basic keywords.
+    """
+    pass
+
+
+def get_pid():
+    """Return process id of the server that is serving this library."""
+    return os.getpid()
+
+
+def failing(message):
+    """This keyword fails with provided `message`"""
+    raise AssertionError(message)
+
+
+def logging(message, level='INFO'):
+    """This keywords logs given `message` with given `level`
+
+    Example:
+    | Logging | Hello, world! |      |
+    | Logging | Warning!!!    | WARN |
+    """
+    print('*%s* %s' % (level, message))
+
+
+def returning(value):
+    """This keyword returns the given `value`."""
+    return value
+
+
+def _private_method():
+    """This is not a keyword. Nor is the next one."""
+    pass
+
+
+def __private_method():
+    pass
+
+
+ATTRIBUTE = 'Not a keyword'
+
+
+if __name__ == '__main__':
+    import sys
+    from robotremoteserver import RobotRemoteServer
+
+    if sys.argv[-1] == 'no_stop':
+        conf = {'allow_remote_stop': False}
+        sys.argv.pop()
+    else:
+        conf = {}
+    library = sys.modules[__name__]
+    RobotRemoteServer(library, '127.0.0.1', *sys.argv[1:], **conf)