Create utils for library refactoring

.travis.yml

@@ -4,7 +4,7 @@ stages:
   - "lint"
   - "test"
 
-if: "type IN (pull_request)"  # Add in "branch" as an option if desired for branch testing as well
+if: "type IN (pull_request)" # Add in "branch" as an option if desired for branch testing as well
 language: "python"
 services:
   - "docker"
@@ -30,7 +30,7 @@ jobs:
         - "pip install invoke toml"
       script:
         - "invoke black"
-        - "invoke bandit"  # Bandit fails to function on > Py3.8 https://github.com/PyCQA/bandit/issues/639
+        - "invoke bandit" # Bandit fails to function on > Py3.8 https://github.com/PyCQA/bandit/issues/639
         # - "invoke pydocstyle"
         - "invoke flake8"
         - "invoke yamllint"

netcompare/__init__.py

@@ -1,5 +1,5 @@
 """Pre/Post Check library."""
-from .check_type import compare
+# from .check_type import compare
 
 
-__all__ = ["compare"]
+# __all__ = ["compare"]

netcompare/check_type.py

@@ -1,5 +1,5 @@
 """CheckType Implementation."""
-from typing import Mapping, Iterable, Tuple, Union, List
+from typing import Mapping, Tuple, Union, List
 from .evaluator import diff_generator
 from .runner import extract_values_from_output
 
@@ -9,7 +9,6 @@ class CheckType:
 
     def __init__(self, *args):
         """Check Type init method."""
-        pass
 
     @staticmethod
     def init(*args):
@@ -29,6 +28,7 @@ def extract_value_from_json_path(
         """Return the value contained into a Mapping for a defined path."""
         return extract_values_from_output(value, path, exclude)
 
+    # TODO: Refine this typing
     def evaluate(self, reference_value: Mapping, value_to_compare: Mapping) -> Tuple[Mapping, bool]:
         """Return the result of the evaluation and a boolean True if it passes it or False otherwise.
 

netcompare/evaluator.py

@@ -1,25 +1,22 @@
 """Diff evaluator."""
 import re
 import sys
-from deepdiff import DeepDiff
 from collections import defaultdict
-from collections.abc import Mapping as DictMapping
 from functools import partial
-from typing import Mapping, List
+from typing import Mapping, List, Dict
+from deepdiff import DeepDiff
 
-from .runner import extract_values_from_output
 
 sys.path.append(".")
 
 
-def diff_generator(pre_data: Mapping, post_data: Mapping, check_definition: Mapping) -> Mapping:
+def diff_generator(pre_result: Mapping, post_result: Mapping) -> Dict:
     """
     Generates diff between pre and post data based on check definition.
 
     Args:
-        pre_data: pre data result.
-        post_data: post data result.
-        check_definition: check definitions.
+        pre_result: pre data result.
+        post_result: post data result.
 
     Return:
         output: diff between pre and post data.
@@ -32,9 +29,6 @@ def diff_generator(pre_data: Mapping, post_data: Mapping, check_definition: Mapp
         >>> print(diff_generator(check_definition, post_data, check_definition))
         {'10.17.254.2': {'state': {'new_value': 'Up', 'old_value': 'Idle'}}}
     """
-    pre_result = extract_values_from_output(check_definition, pre_data)
-    post_result = extract_values_from_output(check_definition, post_data)
-
     diff_result = DeepDiff(pre_result, post_result)
 
     result = diff_result.get("values_changed", {})
@@ -144,7 +138,7 @@ def group_value(tree_list: List, value: Mapping) -> Mapping:
     return value
 
 
-def dict_merger(original_dict: List, merged_dict: Mapping):
+def dict_merger(original_dict: Mapping, merged_dict: Mapping):
     """
     Merge dictionaries to build final result.
 
@@ -158,7 +152,7 @@ def dict_merger(original_dict: List, merged_dict: Mapping):
         {'10.17.254.2': {'state': {'new_value': 'Up', 'old_value': 'Idle'}}}
     """
     for key in merged_dict.keys():
-        if key in original_dict and isinstance(original_dict[key], dict) and isinstance(merged_dict[key], DictMapping):
+        if key in original_dict and isinstance(original_dict[key], dict) and isinstance(merged_dict[key], dict):
             dict_merger(original_dict[key], merged_dict[key])
         else:
             original_dict[key] = merged_dict[key]