updates

Author: jeffkala

.github/workflows/ci.yml

@@ -137,6 +137,24 @@ jobs:
           poetry-install-options: ""
       - name: "Run Tests"
         run: "poetry run invoke pytest"
+  changelog:
+    if: >
+      contains(fromJson('["develop"]'), github.base_ref) &&
+      (github.head_ref != 'main') && (!startsWith(github.head_ref, 'release'))
+    runs-on: "ubuntu-22.04"
+    steps:
+      - name: "Check out repository code"
+        uses: "actions/checkout@v4"
+        with:
+          fetch-depth: "0"
+      - name: "Setup environment"
+        uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
+      - name: "Check for changelog entry"
+        run: |
+          git fetch --no-tags origin +refs/heads/${{ github.base_ref }}:refs/remotes/origin/${{ github.base_ref }}
+          poetry run towncrier check --compare-with origin/${{ github.base_ref }}
   publish_gh:
     needs:
       - "pytest"

jdiff/utils/diff_helpers.py

@@ -64,12 +64,8 @@ def fix_deepdiff_key_names(obj: Mapping) -> Dict:
     result = {}  # type: Dict
     for key, value in obj.items():
         key_parts = re.findall(REGEX_PATTERN_RELEVANT_KEYS, key)
-        if (
-            not key_parts
-        ):  # If key parts can't be find, keep original key so data is not lost.
-            key_parts = [
-                key.replace("root", "index_element")
-            ]  # replace root from DeepDiff with more meaningful name.
+        if not key_parts:  # If key parts can't be find, keep original key so data is not lost.
+            key_parts = [key.replace("root", "index_element")]  # replace root from DeepDiff with more meaningful name.
         partial_res = group_value(key_parts, value)
         dict_merger(result, partial_res)
     return result
@@ -85,16 +81,10 @@ def group_value(tree_list: List, value: Dict) -> Dict:
 def dict_merger(original_dict: Dict, dict_to_merge: Dict):
     """Function to merge a dictionary (dict_to_merge) recursively into the original_dict."""
     for key in dict_to_merge.keys():
-        if (
-            key in original_dict
-            and isinstance(original_dict[key], dict)
-            and isinstance(dict_to_merge[key], dict)
-        ):
+        if key in original_dict and isinstance(original_dict[key], dict) and isinstance(dict_to_merge[key], dict):
             dict_merger(original_dict[key], dict_to_merge[key])
         elif key in original_dict.keys():
-            original_dict[key + "_dup!"] = dict_to_merge[
-                key
-            ]  # avoid overwriting existing keys.
+            original_dict[key + "_dup!"] = dict_to_merge[key]  # avoid overwriting existing keys.
         else:
             original_dict[key] = dict_to_merge[key]
 
@@ -132,24 +122,25 @@ def set_nested_value(data, keys, value):
         set_nested_value(data[keys[0]], keys[1:], value)
 
 
+# {'foo': {'bar-1': 'missing', 'bar-2': 'new'}}
 def parse_diff(jdiff_evaluate_response, actual, intended, match_config):
     """Parse jdiff evaluate result into missing and extra dictionaries."""
     extra = {}
     missing = {}
 
     def process_diff(_map, extra_map, missing_map, previous_key=None):
         for key, value in _map.items():
-            if (
-                isinstance(value, dict)
-                and "new_value" in value
-                and "old_value" in value
-            ):
+            print("value", value)
+            print("type(value)", type(value))
+            if isinstance(value, dict) and "new_value" in value and "old_value" in value:
                 extra_map[key] = value["old_value"]
                 missing_map[key] = value["new_value"]
             elif isinstance(value, str):
                 if "missing" in value:
+                    print("missing", value)
                     extra_map[key] = actual.get(match_config, {}).get(key)
                 if "new" in value:
+                    print("new", value)
                     key_chain, _ = _parse_index_element_string(key)
                     new_value = reduce(getitem, key_chain, intended)
                     set_nested_value(missing_map, key_chain[1::], new_value)

tests/test_diff_helpers.py

@@ -32,16 +32,12 @@ def test_group_value():
     """Tests that nested dict is recursively created."""
     tree_list = ["10.1.0.0", "is_enabled"]
     value = {"new_value": False, "old_value": True}
-    assert group_value(tree_list, value) == {
-        "10.1.0.0": {"is_enabled": {"new_value": False, "old_value": True}}
-    }
+    assert group_value(tree_list, value) == {"10.1.0.0": {"is_enabled": {"new_value": False, "old_value": True}}}
 
 
 def test_fix_deepdiff_key_names():
     """Tests that deepdiff return is parsed properly."""
-    deepdiff_object = {
-        "root[0]['10.1.0.0']['is_enabled']": {"new_value": False, "old_value": True}
-    }
+    deepdiff_object = {"root[0]['10.1.0.0']['is_enabled']": {"new_value": False, "old_value": True}}
     assert fix_deepdiff_key_names(deepdiff_object) == {
         "10.1.0.0": {"is_enabled": {"new_value": False, "old_value": True}}
     }
@@ -50,9 +46,7 @@ def test_fix_deepdiff_key_names():
 def test_get_diff_iterables_items():
     """Tests that deepdiff return is parsed properly."""
     diff_result = {
-        "values_changed": {
-            "root['Ethernet1'][0]['port']": {"new_value": "518", "old_value": "519"}
-        },
+        "values_changed": {"root['Ethernet1'][0]['port']": {"new_value": "518", "old_value": "519"}},
         "iterable_item_added": {
             "root['Ethernet3'][1]": {
                 "hostname": "ios-xrv-unittest",
@@ -63,9 +57,7 @@ def test_get_diff_iterables_items():
     result = get_diff_iterables_items(diff_result)
 
     assert list(dict(result).keys())[0] == "['Ethernet3']"
-    assert list(list(dict(result).values())[0].values())[0] == [
-        {"hostname": "ios-xrv-unittest", "port": "Gi0/0/0/0"}
-    ]
+    assert list(list(dict(result).values())[0].values())[0] == [{"hostname": "ios-xrv-unittest", "port": "Gi0/0/0/0"}]
 
 
 index_element_case_1 = (
@@ -93,8 +85,8 @@ def test__parse_index_element_string(index_element, result):
     {"foo": {"bar-1": "baz1"}},  # actual
     {"foo": {"bar-2": "baz2"}},  # intended
     "foo",  # match_config
-    {"bar-1": "baz1"},  # extra
-    {"bar-2": "baz2"},  # missing
+    {"foo": {"bar-1": "baz1"}},  # extra
+    {"foo": {"bar-2": "baz2"}},  # missing
 )
 
 parse_diff_case_1 = (
@@ -190,14 +182,12 @@ def test_parse_diff(actual, intended, match_config, extra, missing):  # pylint:
     """Test that index_element can be unpacked."""
     jdiff_param_match = CheckType.create("exact_match")
     jdiff_evaluate_response, _ = jdiff_param_match.evaluate(actual, intended)
-    print(jdiff_evaluate_response)
 
     parsed_extra, parsed_missing = parse_diff(
         jdiff_evaluate_response,
         actual,
         intended,
         match_config,
     )
-    print(parsed_extra, parsed_missing)
     assert parsed_extra == extra
     assert parsed_missing == missing

towncrier_templates.j2

@@ -0,0 +1,42 @@
+
+# v{{ versiondata.version.split(".")[:2] | join(".") }} Release Notes
+
+This document describes all new features and changes in the release. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Release Overview
+
+- Major features or milestones
+- Changes to compatibility with Nautobot and/or other apps, libraries etc.
+
+{% if render_title %}
+## [v{{ versiondata.version }} ({{ versiondata.date }})](https://github.com/networktocode/{{ cookiecutter.project_slug }}/releases/tag/v{{ versiondata.version}})
+
+{% endif %}
+{% for section, _ in sections.items() %}
+{% if sections[section] %}
+{% for category, val in definitions.items() if category in sections[section] %}
+{% if sections[section][category]|length != 0 %}
+### {{ definitions[category]['name'] }}
+
+{% if definitions[category]['showcontent'] %}
+{% for text, values in sections[section][category].items() %}
+{% for item in text.split('\n') %}
+{% if values %}
+- {{ values|join(', ') }} - {{ item.strip() }}
+{% else %}
+- {{ item.strip() }}
+{% endif %}
+{% endfor %}
+{% endfor %}
+
+{% else %}
+- {{ sections[section][category]['']|join(', ') }}
+
+{% endif %}
+{% endif %}
+{% endfor %}
+{% else %}
+No significant changes.
+
+{% endif %}
+{% endfor %}