Fix additional properties and auto-mode serialization (#120)

* Fix additional properties and auto-mode serialization

* msrest 0.5.5

Author: lmazuel

README.rst

@@ -20,6 +20,14 @@ To install:
 Release History
 ---------------
 
+2018-09-04 Version 0.5.5
+++++++++++++++++++++++++
+
+**Bugfixes**
+
+- Fix a serialization issue if additional_properties is declared, and "automatic model" syntax is used
+  ("automatic model" being the ability to pass a dict to command and have the model auto-created)  # 120
+
 2018-07-12 Version 0.5.4
 ++++++++++++++++++++++++
 

msrest/serialization.py

@@ -465,8 +465,9 @@ def _serialize(self, target_obj, data_type=None, **kwargs):
                 if not keep_readonly and target_obj._validation.get(attr_name, {}).get('readonly', False):
                     continue
 
-                if attr_name == "additional_properties" and attr_desc["key"] == '' and target_obj.additional_properties:
-                    serialized.update(target_obj.additional_properties)
+                if attr_name == "additional_properties" and attr_desc["key"] == '':
+                    if target_obj.additional_properties is not None:
+                        serialized.update(target_obj.additional_properties)
                     continue
                 try:
                     ### Extract sub-data to serialize from model ###
@@ -548,6 +549,9 @@ def body(self, data, data_type, **kwargs):
         if internal_data_type and not isinstance(internal_data_type, Enum):
             try:
                 deserializer = Deserializer(self.dependencies)
+                # Since it's on serialization, it's almost sure that format is not JSON REST
+                # We're not able to deal with additional properties for now.
+                deserializer.additional_properties_detection = False
                 if issubclass(internal_data_type, Model) and internal_data_type.is_xml_model():
                     deserializer.key_extractors = [
                         attribute_key_case_insensitive_extractor,
@@ -1196,6 +1200,13 @@ def __init__(self, classes=None):
             rest_key_extractor,
             xml_key_extractor
         ]
+        # Additional properties only works if the "rest_key_extractor" is used to
+        # extract the keys. Making it to work whatever the key extractor is too much
+        # complicated, with no real scenario for now.
+        # So adding a flag to disable additional properties detection. This flag should be
+        # used if your expect the deserialization to NOT come from a JSON REST syntax.
+        # Otherwise, result are unexpected
+        self.additional_properties_detection = True
 
     def __call__(self, target_obj, response_data, content_type=None):
         """Call the deserializer to process a REST response.
@@ -1279,10 +1290,12 @@ def _deserialize(self, target_obj, data):
             msg = "Unable to deserialize to object: " + class_name
             raise_with_traceback(DeserializationError, msg, err)
         else:
-            additional_properties = self._build_additional_properties(response._attribute_map, data)
+            additional_properties = self._build_additional_properties(attributes, data)
             return self._instantiate_model(response, d_attrs, additional_properties)
 
     def _build_additional_properties(self, attribute_map, data):
+        if not self.additional_properties_detection:
+            return None
         if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != '':
             # Check empty string. If it's not empty, someone has a real "additionalProperties"
             return None

msrest/version.py

@@ -25,4 +25,4 @@
 # --------------------------------------------------------------------------
 
 #: version of this package. Use msrest.__version__ instead
-msrest_version = "0.5.4"
+msrest_version = "0.5.5"

setup.py

@@ -28,7 +28,7 @@
 
 setup(
     name='msrest',
-    version='0.5.4',
+    version='0.5.5',
     author='Microsoft Corporation',
     packages=find_packages(exclude=["tests", "tests.*"]),
     url=("https://github.com/Azure/msrest-for-python"),

tests/test_serialization.py

@@ -1176,6 +1176,33 @@ def __init__(self, name=None, additional_properties=None):
 
         self.assertEqual(serialized, expected_message)
 
+
+    def test_additional_properties_with_auto_model(self):
+
+        class AdditionalTest(Model):
+
+            _attribute_map = {
+                "name": {"key":"Name", "type":"str"},
+                "display_name": {"key":"DisplayName", "type":"str"},
+                'additional_properties': {'key': '', 'type': '{object}'}
+            }
+
+        o = {
+            'name': 'test',
+            'display_name': "display_name"
+        }
+
+        expected_message = {
+            "Name": "test",
+            "DisplayName": "display_name",
+        }
+
+        s = Serializer({'AdditionalTest': AdditionalTest})
+
+        serialized = s.body(o, 'AdditionalTest')
+
+        self.assertEqual(serialized, expected_message)
+
     def test_additional_properties_declared(self):
 
         class AdditionalTest(Model):
@@ -2133,15 +2160,13 @@ class AdditionalTest(Model):
 
             _attribute_map = {
                 "name": {"key":"Name", "type":"str"},
+                "display_name": {"key":"DisplayName", "type":"str"},
                 'additional_properties': {'key': '', 'type': '{object}'}
             }
 
-            def __init__(self, name=None, additional_properties=None):
-                self.name = name
-                self.additional_properties = additional_properties
-
         message = {
             "Name": "test",
+            "DisplayName": "diplay_name",
             "PropInt": 2,
             "PropStr": "AdditionalProperty",
             "PropArray": [1,2,3],
@@ -2153,6 +2178,7 @@ def __init__(self, name=None, additional_properties=None):
         m = d('AdditionalTest', message)
 
         self.assertEquals(m.name, "test")
+        self.assertEquals(m.display_name, "diplay_name")
         self.assertEquals(m.additional_properties['PropInt'], 2)
         self.assertEquals(m.additional_properties['PropStr'], "AdditionalProperty")
         self.assertEquals(m.additional_properties['PropArray'], [1,2,3])