Merge pull request #50 in PYTHON/python-devicecloud from ming/add-attribute-to-sci-send-message-operation to master

* commit '65eaac5934392c35ad86d513d0e71fcca2ad8212':
  Added test_sci_update_firmware_attribute test for testing attribute parameter in send_sci function
  ADded attribute to send sci operaton tag

Author: brandonmoser

devicecloud/sci.py

@@ -12,7 +12,7 @@
 
 SCI_TEMPLATE = """\
 <sci_request version="1.0">
-  <{operation}{reply}{synchronous}{cache}{sync_timeout}{allow_offline}{wait_for_reconnect}>
+  <{operation}{attribute}{reply}{synchronous}{cache}{sync_timeout}{allow_offline}{wait_for_reconnect}>
     <targets>
       {targets}
     </targets>
@@ -131,7 +131,7 @@ def send_sci_async(self, operation, target, payload, **sci_options):
         return AsyncRequestProxy(job_id, self._conn)
 
     def send_sci(self, operation, target, payload, reply=None, synchronous=None, sync_timeout=None,
-                 cache=None, allow_offline=None, wait_for_reconnect=None):
+                 cache=None, allow_offline=None, wait_for_reconnect=None, attribute=None):
         """Send SCI request to 1 or more targets
 
         :param str operation: The operation is one of {send_message, update_firmware, disconnect, query_firmware_targets,
@@ -204,6 +204,11 @@ def send_sci(self, operation, target, payload, reply=None, synchronous=None, syn
         else:
             wait_for_reconnect_xml = ''
 
+        if attribute is not None:
+            operation_attribute = ' ' + attribute
+        else:
+            operation_attribute = ''
+
         full_request = SCI_TEMPLATE.format(
             operation=operation,
             targets=targets_xml,
@@ -213,7 +218,8 @@ def send_sci(self, operation, target, payload, reply=None, synchronous=None, syn
             cache=cache_xml,
             allow_offline=allow_offline_xml,
             wait_for_reconnect=wait_for_reconnect_xml,
-            payload=payload
+            payload=payload,
+            attribute=operation_attribute
         )
 
         # TODO: do parsing here?

devicecloud/test/unit/test_sci.py

@@ -74,6 +74,16 @@
 </sci_reply>
 """
 
+EXAMPLE_UPDATE_FIRMWARE_INVALID_ATTRIBUTE_REQUEST_PAYLOAD = """
+<data>aHNxcAbAADUct1cAAACAHEBAAAEABEAwAIBAAQAAACOFFzU</data>
+"""
+
+EXAMPLE_UPDATE_FIRMWARE_INVALID_ATTRIBUTE_RESPONSE = """\
+<sci_reply version="1.0"><update_firmware><device id="00000000-00000000-00409dff-ffaabbcc"/>
+<error><desc>Default target not availabe, specify a target number of filename</desc></error>
+</device></update_firmware>
+</sci_reply>
+"""
 
 class TestSCI(HttpTestBase):
     def _prepare_sci_response(self, response, status=200):
@@ -179,6 +189,27 @@ def test_sci_with_parameters(self):
                                '</send_message>'
                                '</sci_request>'))
 
+    def test_sci_update_firmware_attribute(self):
+
+        self._prepare_sci_response(EXAMPLE_UPDATE_FIRMWARE_INVALID_ATTRIBUTE_RESPONSE)
+        self.dc.get_sci_api().send_sci(
+            operation="update_firmware",
+            attribute="filename=\"abcd.bin\"",
+            target=DeviceTarget('00000000-00000000-00409dff-ffaabbcc'),
+            payload=EXAMPLE_UPDATE_FIRMWARE_INVALID_ATTRIBUTE_REQUEST_PAYLOAD)
+
+        request = httpretty.last_request().body.decode('utf8')
+        request = ''.join([line.strip() for line in request.splitlines()])
+        self.assertEqual(request,
+                         six.u('<sci_request version="1.0">'
+                               '<update_firmware filename="abcd.bin">'
+                               '<targets>'
+                               '<device id="00000000-00000000-00409dff-ffaabbcc"/>'
+                               '</targets>'
+                               '<data>aHNxcAbAADUct1cAAACAHEBAAAEABEAwAIBAAQAAACOFFzU</data>'
+                               '</update_firmware>'
+                               '</sci_request>'))
+
 
 class TestGetAsync(HttpTestBase):
     def test_sci_get_async(self):

devicecloud/version.py

@@ -5,4 +5,4 @@
 # Copyright (c) 2015-2018 Digi International Inc.
 
 
-__version__ = "0.5.3"
+__version__ = "0.5.4"