[ignore] Added append_update_ops_data function to utils to handle the…

… latest NDO module update operations (CiscoDevNet#569)

plugins/module_utils/utils.py

@@ -7,6 +7,8 @@
 
 __metaclass__ = type
 
+import copy
+
 
 def generate_api_endpoint(path, **kwargs):
     """
@@ -26,3 +28,120 @@ def generate_api_endpoint(path, **kwargs):
     # return full_url
 
     return path if not kwargs else "{0}?{1}".format(path, "&".join(["{0}={1}".format(key, value) for key, value in kwargs.items()]))
+
+
+def append_update_ops_data(ops, existing_data, update_path, replace_data=None, remove_data=None):
+    """
+    Append Update ops payload data.
+    :param ops: Variable which contains the PATCH replace actions for the update operation -> List
+    :param existing_data: Variable which contains the existing data -> Dict
+    :param update_path: The object path is used to update an existing object -> Str
+    :param replace_data: Defaults to None when not specified, expected a dictionary object. Which contains the attribute to be updated and its new value -> Dict
+    :param remove_data: Defaults to None when not specified, expected a list of string or tuple, value used to clear the existing configuration -> List
+    :return: None
+                If attributes is not empty then the ops and existing_data are updated with the input value.
+
+    Sample Existing Data:
+    ---------------------
+    existing_data = {
+        "name": "name",
+        "description": "description",
+        "bfdMultiHopPol": {
+            "adminState": "enabled",
+            "minRxInterval": 250,
+            "ifControl": {"adminState": "enabled"},
+        },
+        "bfdPol": {
+            "adminState": "enabled",
+            "detectionMultiplier": 3,
+        }
+    }
+
+    ops = []
+    update_path = "/tenantPolicyTemplate/template/l3OutIntfPolGroups/0"
+    replace_data = {
+        ("name"): "new_name",
+        "description": "new_description",
+        ("ospfIntfPol"): dict(ifControl=dict(adminState="disbaled"), cost=0),
+    }
+    remove_data = [("bfdMultiHopPol", "ifControl", "adminState"), "bfdPol"]
+
+    append_update_ops_data(ops, existing_data, update_path, replace_data, remove_data)
+
+    Standard Output Data:
+    ---------------------
+    {
+        "bfdMultiHopPol": {
+            "adminState": "enabled",
+            "minRxInterval": 250,
+            "ifControl": {},
+        },
+        "name": "new_name",
+        "description": "new_description",
+        "ospfIntfPol": {
+            "ifControl": {
+                "adminState": "disbaled",
+            },
+            "cost": 0,
+        },
+    }
+
+    API Input Data:
+    ---------------
+    [
+        {"op": "replace", "path": "/tenantPolicyTemplate/template/l3OutIntfPolGroups/1/name", "value": "new_name"},
+        {"op": "replace", "path": "/tenantPolicyTemplate/template/l3OutIntfPolGroups/1/description", "value": "new_description"},
+        {
+            "op": "replace",
+            "path": "/tenantPolicyTemplate/template/l3OutIntfPolGroups/1/ospfIntfPol",
+            "value": {"ifControl": {"adminState": "disbaled"}, "cost": 0},
+        },
+        {"op": "remove", "path": "/tenantPolicyTemplate/template/l3OutIntfPolGroups/1/bfdPol"},
+        {"op": "remove", "path": "/tenantPolicyTemplate/template/l3OutIntfPolGroups/1/bfdMultiHopPol/ifControl/adminState"},
+    ]
+    """
+
+    def recursive_replace(data, path, keys, new_value):
+        key = keys[0]
+        if len(keys) == 1:
+            # Update the existing configuration
+            if new_value is not None and data.get(key) != new_value:
+                data[key] = new_value
+                ops.append(
+                    dict(
+                        op="replace",
+                        path="{}/{}".format(path, key),
+                        value=copy.deepcopy(new_value),
+                    )
+                )
+        elif key in data:
+            recursive_replace(data[key], "{}/{}".format(path, key), keys[1:], new_value)
+
+    def recursive_delete(data, path, keys):
+        key = keys[0]
+        if len(keys) == 1:
+            # Clear the existing configuration
+            if key in data:
+                data.pop(key)
+                ops.append(
+                    dict(
+                        op="remove",
+                        path="{}/{}".format(path, key),
+                    )
+                )
+        elif key in data:
+            recursive_delete(data[key], "{}/{}".format(path, key), keys[1:])
+
+    if replace_data:
+        if not isinstance(replace_data, dict):
+            raise TypeError("replace_data must be a dict")
+
+        for key, value in replace_data.items():
+            recursive_replace(existing_data, update_path, key if isinstance(key, tuple) else (key,), value)
+
+    if remove_data:
+        if not isinstance(remove_data, list):
+            raise TypeError("remove_data must be a list of string or tuples")
+
+        for key in remove_data:
+            recursive_delete(existing_data, update_path, key if isinstance(key, tuple) else (key,))