Handle binary arguments recursively

Author: pekkaklarck

src/robotremoteserver.py

@@ -357,8 +357,8 @@ def __init__(self, keyword):
         self._keyword = keyword
 
     def run_keyword(self, args, kwargs=None):
-        # TODO: Handle binary in lists/dicts in args/kwargs
-        args, kwargs = self._handle_binary_args(args, kwargs or {})
+        args = self._handle_binary(args)
+        kwargs = self._handle_binary(kwargs or {})
         result = KeywordResult()
         with StandardStreamInterceptor() as interceptor:
             try:
@@ -375,13 +375,17 @@ def run_keyword(self, args, kwargs=None):
         result.set_output(interceptor.output)
         return result.data
 
-    def _handle_binary_args(self, args, kwargs):
-        args = [self._handle_binary_arg(a) for a in args]
-        kwargs = dict((k, self._handle_binary_arg(v)) for k, v in kwargs.items())
-        return args, kwargs
-
-    def _handle_binary_arg(self, arg):
-        return arg if not isinstance(arg, Binary) else arg.data
+    def _handle_binary(self, arg):
+        # No need to compare against other iterables or mappings because we
+        # only get actual lists and dicts over XML-RPC. Binary cannot be
+        # a dictionary key either.
+        if isinstance(arg, list):
+            return [self._handle_binary(item) for item in arg]
+        if isinstance(arg, dict):
+            return dict((key, self._handle_binary(arg[key])) for key in arg)
+        if isinstance(arg, Binary):
+            return arg.data
+        return arg
 
 
 class StandardStreamInterceptor(object):

test/atest/argument_types.robot

@@ -68,6 +68,11 @@ Dictionary With Non-String Keys
     [Documentation]    XML-RPC supports only strings as keys so must convert them
     {42: 42, True: False, None: None}    {'42': 42, 'True': False, '': ''}
 
+Binary in lists and dicts
+    [Documentation]    Binary values should be handled recursively
+    (b'\x01', [b'\x02', set([u'\x03'])])    [b'\x01', [b'\x02', [b'\x03']]]
+    {'k1': b'\x01', 'k2': [b'\x02', {'k3': b'\x03'}]}
+
 *** Keywords ***
 Argument Should Be Correct
      [Arguments]    ${argument}    ${expected}=

test/atest/kwargs.robot

@@ -57,3 +57,8 @@ Non-string kwargs
     ${list} =    Create List    1    ${2}
     ${result} =    Kwargs    a=${1}    b=${True}    c=${list}
     Should Be Equal    ${result}    a:1 (int), b:True (bool), c:['1', 2] (list)
+
+Binary kwargs
+    ${tuple} =    Evaluate    ('\x02',)
+    ${result} =    Kwargs    a=\x00    b=\x01    c=${tuple}
+    Should Be Equal    ${result}    a:\x00, b:\x01, c:['\\x02'] (list)

test/libs/Arguments.py

@@ -1,3 +1,5 @@
+from robotremoteserver import Binary
+
 try:
     basestring
 except:
@@ -10,6 +12,18 @@ def argument_should_be_correct(self, argument, expected):
         expected = eval(expected)
         if argument != expected:
             raise AssertionError('%r != %r' % (argument, expected))
+        self.should_not_contain_binary(argument)
+
+    def should_not_contain_binary(self, argument):
+        if isinstance(argument, Binary):
+            raise AssertionError('Binary with data %r found!' % argument.data)
+        if isinstance(argument, dict):
+            for key, value in argument.items():
+                self.should_not_contain_binary(key)
+                self.should_not_contain_binary(value)
+        if isinstance(argument, list):
+            for item in argument:
+                self.should_not_contain_binary(item)
 
     def no_arguments(self):
         return self._format_args()
@@ -33,6 +47,7 @@ def required_defaults_and_varargs(self, req, default='world', *varargs):
         return self._format_args(req, default, *varargs)
 
     def kwargs(self, **kwargs):
+        self.should_not_contain_binary(kwargs)
         return self._format_args(**kwargs)
 
     def args_and_kwargs(self, arg1, arg2='default', **kwargs):