Proposed fix for issue 44 (#45)

* propose fix ofr issue 44

* using flatten list utils

* add test with index in result

* improve reference key normal logic

* Update netcompare/check_types.py

Co-authored-by: Patryk Szulczewski <[email protected]>

* Update netcompare/check_types.py

Co-authored-by: Patryk Szulczewski <[email protected]>

* Update netcompare/check_types.py

Co-authored-by: Patryk Szulczewski <[email protected]>

* Update netcompare/check_types.py

Co-authored-by: Patryk Szulczewski <[email protected]>

* Update netcompare/check_types.py

Co-authored-by: Patryk Szulczewski <[email protected]>

Co-authored-by: Patryk Szulczewski <[email protected]>

Author: lvrfrc87

netcompare/check_types.py

@@ -57,6 +57,9 @@ def get_value(output: Union[Mapping, List], path: str, exclude: List = None) ->
             Evaluated data, may be anything depending on JMESPath used.
         """
         if exclude and isinstance(output, Dict):
+            if not isinstance(exclude, list):
+                raise ValueError(f"Exclude list must be defined as a list. You have {type(exclude)}")
+
             exclude_filter(output, exclude)  # exclude unwanted elements
 
         if not path:
@@ -81,9 +84,21 @@ def get_value(output: Union[Mapping, List], path: str, exclude: List = None) ->
 
         paired_key_value = associate_key_of_my_value(jmespath_value_parser(path), values)
 
-        if re.search(r"\$.*\$", path):  # normalize
+        # We need to get a list of reference keys - list of strings.
+        # Based on the expression or output type we might have different data types
+        # therefore we need to normalize.
+        if re.search(r"\$.*\$", path):
             wanted_reference_keys = jmespath.search(jmespath_refkey_parser(path), output)
-            list_of_reference_keys = keys_cleaner(wanted_reference_keys)
+
+            if isinstance(wanted_reference_keys, dict):  # when wanted_reference_keys is dict() type
+                list_of_reference_keys = keys_cleaner(wanted_reference_keys)
+            elif any(isinstance(element, list) for element in wanted_reference_keys):  # when wanted_reference_keys is a nested list
+                list_of_reference_keys = flatten_list(wanted_reference_keys)[0]
+            elif isinstance(wanted_reference_keys, list):  # when wanted_reference_keys is a list
+                list_of_reference_keys = wanted_reference_keys
+            else:
+                raise ValueError("Reference Key normalization failure. Please verify data type returned.")
+
             return keys_values_zipper(list_of_reference_keys, paired_key_value)
 
         return values

tests/mock/raw_novalue_exclude/pre.json

@@ -8,7 +8,7 @@
             "lastStatusChangeTimestamp": 1626247820.0720868,
             "lanes": 0,
             "name": "Management1",
-            "interfaceStatus": "connected",
+            "interfaceStatus": "down",
             "autoNegotiate": "success",
             "burnedInAddress": "08:00:27:e6:b2:f8",
             "loopbackMode": "loopbackNone",

tests/test_diff_generator.py

@@ -57,6 +57,7 @@
         "result": {
             "interfaces": {
                 "Management1": {
+                    "interfaceStatus": {"new_value": "connected", "old_value": "down"},
                     "lastStatusChangeTimestamp": {"new_value": 1626247821.123456, "old_value": 1626247820.0720868},
                     "interfaceAddress": {
                         "primaryIp": {"address": {"new_value": "10.2.2.15", "old_value": "10.0.2.15"}}
@@ -148,6 +149,21 @@
     },
 )
 
+exact_match_test_issue_44_case_1 = (
+    "raw_novalue_exclude",
+    "result[*].interfaces.*.[$name$,interfaceStatus]",
+    [],
+    {"Management1": {"interfaceStatus": {"new_value": "connected", "old_value": "down"}}},
+)
+
+exact_match_test_issue_44_case_2 = (
+    "raw_novalue_exclude",
+    "result[0].interfaces.*.[$name$,interfaceStatus]",
+    [],
+    {"Management1": {"interfaceStatus": {"new_value": "connected", "old_value": "down"}}},
+)
+
+
 eval_tests = [
     exact_match_of_global_peers_via_napalm_getter,
     exact_match_of_bgp_peer_caps_via_api,
@@ -161,6 +177,8 @@
     exact_match_multi_nested_list,
     exact_match_textfsm_ospf_int_br_raw,
     exact_match_textfsm_ospf_int_br_normalized,
+    exact_match_test_issue_44_case_1,
+    exact_match_test_issue_44_case_2,
 ]