Acceptance tests for dynamic library support. #18

Also a fix for a bug found by the tests.

Author: pekkaklarck

src/robotremoteserver.py

@@ -234,7 +234,7 @@ def _get_kwargs_support(self, run_keyword):
         return len(spec.args) > 3    # self, name, args, kwargs=None
 
     def run_keyword(self, name, args, kwargs=None):
-        args = [name, args, kwargs]
+        args = [name, args, kwargs] if kwargs else [name, args]
         return KeywordRunner(self._run_keyword).run_keyword(args)
 
     def get_keyword_arguments(self, name):

test/atest/dynamic.robot

@@ -0,0 +1,42 @@
+*** Settings ***
+Resource          resource.robot
+Suite Setup       Start And Import Remote Library    Dynamic.py
+Suite Teardown    Stop Remote Library
+
+*** Test Cases ***
+Passing
+    Passing
+    Passing    one arg accepted
+
+Failing
+    [Documentation]    FAIL The message
+    Failing    The message
+
+Logging
+    [Documentation]    LOG 1 INFO Hello, world!    LOG 2 DEBUG Hi!
+    Logging    Hello, world!
+    Logging    Hi!    DEBUG
+
+Returning
+    ${result} =    Returning
+    Should Be Equal    ${result}    Hello, world!
+
+Named arguments
+    [Documentation]    FAIL Bye!!    LOG 2 INFO Hi, again!    LOG 3 FAIL Bye!!
+    Passing    arg=ignored
+    Logging    level=INFO    message=Hi, again!
+    Failing    message=Bye!!
+
+Kwargs
+    [Template]    Kwargs
+    ${EMPTY}
+    a: 1    a=1
+    c=3    a=1    expected=a: 1, b: 2, c: 3    b=2
+
+Called with invalid arguments when arguments are known
+    [Documentation]    FAIL Keyword 'Remote.Passing' expected 0 to 1 arguments, got 6.
+    Passing    more    than    one    arg    not    accepted
+
+Called with invalid arguments when arguments are not known
+    [Documentation]    FAIL GLOB: TypeError: *returning* *0* *3*
+    Returning    too    many    arguments

test/atest/hybrid.robot

@@ -0,0 +1,38 @@
+*** Settings ***
+Resource          resource.robot
+Suite Setup       Start And Import Remote Library    Hybrid.py
+Suite Teardown    Stop Remote Library
+
+*** Test Cases ***
+Passing
+    Passing
+    Passing    one arg accepted
+
+Failing
+    [Documentation]    FAIL The message
+    Failing    The message
+
+Logging
+    [Documentation]    LOG 1 INFO Hello, world!    LOG 2 DEBUG Hi!
+    Logging    Hello, world!
+    Logging    Hi!    DEBUG
+
+Returning
+    ${result} =    Returning
+    Should Be Equal    ${result}    Hello, world!
+
+Named arguments
+    [Documentation]    FAIL Bye!!    LOG 2 INFO Hi, again!    LOG 3 FAIL Bye!!
+    Passing    arg=ignored
+    Logging    level=INFO    message=Hi, again!
+    Failing    message=Bye!!
+
+Kwargs
+    [Template]    Kwargs
+    ${EMPTY}
+    a: 1    a=1
+    c=3    a=1    expected=a: 1, b: 2, c: 3    b=2
+
+Called with invalid arguments
+    [Documentation]    FAIL Keyword 'Remote.Passing' expected 0 to 1 arguments, got 6.
+    Passing    more    than    one    arg    not    accepted

test/libs/Dynamic.py

@@ -0,0 +1,45 @@
+class Dynamic(object):
+    kws = {'passing': ['arg=None'],
+           'failing': ['message'],
+           'logging': ['message', 'level=INFO'],
+           'returning': None,
+           'kwargs': ['expected', '**kws']}
+
+    def get_keyword_names(self):
+        return list(self.kws)
+
+    def run_keyword(self, name, args, kwargs=None):
+        kw = globals()[name]
+        return kw(*args, **(kwargs or {}))
+
+    def get_keyword_arguments(self, name):
+        return self.kws[name]
+
+
+def passing(arg=None):
+    assert not arg or '=' not in arg
+
+
+def failing(message):
+    raise AssertionError(message)
+
+
+def logging(message, level='INFO'):
+    print('*%s* %s' % (level, message))
+
+
+def returning():
+    return 'Hello, world!'
+
+
+def kwargs(expected, **kws):
+    actual = ', '.join('%s: %s' % (k, kws[k]) for k in sorted(kws))
+    assert actual == expected
+
+
+if __name__ == '__main__':
+    import sys
+    from robotremoteserver import RobotRemoteServer
+
+    RobotRemoteServer(Dynamic(), '127.0.0.1', *sys.argv[1:])
+

test/libs/Hybrid.py

@@ -0,0 +1,39 @@
+class Hybrid(object):
+
+    def get_keyword_names(self):
+        return ['passing', 'failing', 'logging', 'returning', 'kwargs']
+
+    def __getattr__(self, name):
+        try:
+            return globals()[name]
+        except KeyError:
+            raise AttributeError(name)
+
+
+def passing(arg=None):
+    assert not arg or '=' not in arg
+
+
+def failing(message):
+    raise AssertionError(message)
+
+
+def logging(message, level='INFO'):
+    print('*%s* %s' % (level, message))
+
+
+def returning():
+    return 'Hello, world!'
+
+
+def kwargs(expected, **kws):
+    actual = ', '.join('%s: %s' % (k, kws[k]) for k in sorted(kws))
+    assert actual == expected
+
+
+if __name__ == '__main__':
+    import sys
+    from robotremoteserver import RobotRemoteServer
+
+    RobotRemoteServer(Hybrid(), '127.0.0.1', *sys.argv[1:])
+

test/utest/test_robotremoteserver.py

@@ -66,7 +66,7 @@ def get_keyword_names(self):
 
     def run_keyword(self, name, args, kwargs=None):
         kw = getattr(self.library, name)
-        return kw(*args, **kwargs)
+        return kw(*args, **(kwargs or {}))
 
     def not_included(self):
         """Not returned by get_keyword_names"""
@@ -76,6 +76,17 @@ def streams(self):
         return self.library.streams
 
 
+class DynamicLibraryWithoutKwargs(DynamicLibrary):
+
+    def run_keyword(self, name, args):
+        kwargs = dict(item for item in self._pop_kwargs(args))
+        return DynamicLibrary.run_keyword(self, name, args, kwargs)
+
+    def _pop_kwargs(self, args):
+        while args and '=' in args[-1]:
+            yield args.pop().split('=', 1)
+
+
 class TestStaticApi(unittest.TestCase):
     library = StaticLibrary()
 
@@ -155,5 +166,13 @@ class TestDynamicApi(TestStaticApi):
     library = DynamicLibrary()
 
 
+class TestDynamicApiWithoutKwargs(TestStaticApi):
+    library = DynamicLibraryWithoutKwargs()
+
+    def _run(self, kw, *args, **kwargs):
+        args = list(args) + ['%s=%s' % item for item in kwargs.items()]
+        return self.server.run_keyword(kw, args)
+
+
 if __name__ == '__main__':
     unittest.main()