Bump CI to use Ansible-Core 2.14 (#998)

Author: ryanmerolle

.github/workflows/main.yml

@@ -30,7 +30,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10"]
+        python-version: ["3.9", "3.10", "3.11"]
 
     steps:
 
@@ -76,14 +76,13 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - VERSION: "v3.2"
-            NETBOX_DOCKER_VERSION: 1.6.1
           - VERSION: "v3.3"
             NETBOX_DOCKER_VERSION: 2.3.0
           - VERSION: "v3.4"
             NETBOX_DOCKER_VERSION: 2.5.3
           #- VERSION: "v3.5"
           #  NETBOX_DOCKER_VERSION: 2.6.1
+        # If we want to integration test wiht all supported Python:
         #python-version: ["3.9", "3.10", "3.11"]
 
     steps:

poetry.lock

@@ -7,14 +7,14 @@ license = "GPLv3"
 
 [tool.poetry.dependencies]
 python = "^3.9"
-ansible-core = "2.13.*"
+ansible-core = "2.14.3"
 black = "*"
 codecov = "*"
-coverage = "^4.0"
+coverage = "6.5.*"
+deepdiff = "*"
 cryptography = "*"
 jinja2 = "*"
 jmespath = "*"
-jsondiff = "*"
 pynetbox = "^7"
 pytest = "*"
 pytest-mock = "*"

pyproject.toml

@@ -6,6 +6,7 @@
 
 import os
 import sys
+
 import pynetbox
 from packaging import version
 

tests/integration/netbox-deploy.py

@@ -7,13 +7,13 @@
 
 __metaclass__ = type
 
-import sys
-import json
 import argparse
-from jsondiff import diff
-from typing import Iterable
+import json
+import sys
 from operator import itemgetter
 
+from deepdiff import DeepDiff
+
 # NetBox includes "created" and "last_updated" times on objects. These end up in the interfaces objects that are included verbatim from the NetBox API.
 # "url" may be different if local tests use a different host/port
 # Remove these from files saved in git as test data
@@ -33,15 +33,6 @@
 )
 
 
-def all_keys_to_ignore(netbox_version):
-    keys = KEYS_REMOVE.union(KEYS_IGNORE)
-
-    if netbox_version == "v2.7":
-        return keys.union(KEYS_IGNORE_27)
-    else:
-        return keys
-
-
 # Assume the object will not be recursive, as it originally came from JSON
 def remove_keys(obj, keys):
     if isinstance(obj, dict):
@@ -71,24 +62,22 @@ def sort_hostvar_arrays(obj):
     if not hostvars:
         return
 
-    for hostname, host in hostvars.items():
-        interfaces = host.get("interfaces")
-        if interfaces:
+    for _, host in hostvars.items():
+        if interfaces := host.get("interfaces"):
             host["interfaces"] = sorted(interfaces, key=itemgetter("id"))
 
-        services = host.get("services")
-        if services:
+        if services := host.get("services"):
             host["services"] = sorted(services, key=itemgetter("id"))
 
 
 def read_json(filename):
-    with open(filename, "r") as f:
-        return json.loads(f.read())
+    with open(filename, "r", encoding="utf-8") as file:
+        return json.loads(file.read())
 
 
 def write_json(filename, data):
-    with open(filename, "w") as f:
-        json.dump(data, f, indent=4)
+    with open(filename, "w", encoding="utf-8") as file:
+        json.dump(data, file, indent=4)
 
 
 def main():
@@ -140,17 +129,15 @@ def main():
         data_b = read_json(args.filename_b)
 
         # Ignore keys that we don't want to diff, in addition to the ones removed that change on every commit
-        keys = all_keys_to_ignore(args.netbox_version)
+        keys = KEYS_REMOVE.union(KEYS_IGNORE)
         remove_keys(data_a, keys)
         remove_keys(data_b, keys)
 
         sort_hostvar_arrays(data_a)
         sort_hostvar_arrays(data_b)
 
         # Perform the diff
-        # syntax='symmetric' will produce output that prints both the before and after as "$insert" and "$delete"
-        # marshal=True removes any special types, allowing to be dumped as json
-        result = diff(data_a, data_b, marshal=True, syntax="symmetric")
+        result = DeepDiff(data_a, data_b, ignore_order=True)
 
         if result:
             # Dictionary is not empty - print differences

tests/integration/targets/inventory-v3.3/compare_inventory_json.py

@@ -7,13 +7,13 @@
 
 __metaclass__ = type
 
-import sys
-import json
 import argparse
-from jsondiff import diff
-from typing import Iterable
+import json
+import sys
 from operator import itemgetter
 
+from deepdiff import DeepDiff
+
 # NetBox includes "created" and "last_updated" times on objects. These end up in the interfaces objects that are included verbatim from the NetBox API.
 # "url" may be different if local tests use a different host/port
 # Remove these from files saved in git as test data
@@ -33,15 +33,6 @@
 )
 
 
-def all_keys_to_ignore(netbox_version):
-    keys = KEYS_REMOVE.union(KEYS_IGNORE)
-
-    if netbox_version == "v2.7":
-        return keys.union(KEYS_IGNORE_27)
-    else:
-        return keys
-
-
 # Assume the object will not be recursive, as it originally came from JSON
 def remove_keys(obj, keys):
     if isinstance(obj, dict):
@@ -71,24 +62,22 @@ def sort_hostvar_arrays(obj):
     if not hostvars:
         return
 
-    for hostname, host in hostvars.items():
-        interfaces = host.get("interfaces")
-        if interfaces:
+    for _, host in hostvars.items():
+        if interfaces := host.get("interfaces"):
             host["interfaces"] = sorted(interfaces, key=itemgetter("id"))
 
-        services = host.get("services")
-        if services:
+        if services := host.get("services"):
             host["services"] = sorted(services, key=itemgetter("id"))
 
 
 def read_json(filename):
-    with open(filename, "r") as f:
-        return json.loads(f.read())
+    with open(filename, "r", encoding="utf-8") as file:
+        return json.loads(file.read())
 
 
 def write_json(filename, data):
-    with open(filename, "w") as f:
-        json.dump(data, f, indent=4)
+    with open(filename, "w", encoding="utf-8") as file:
+        json.dump(data, file, indent=4)
 
 
 def main():
@@ -140,17 +129,15 @@ def main():
         data_b = read_json(args.filename_b)
 
         # Ignore keys that we don't want to diff, in addition to the ones removed that change on every commit
-        keys = all_keys_to_ignore(args.netbox_version)
+        keys = KEYS_REMOVE.union(KEYS_IGNORE)
         remove_keys(data_a, keys)
         remove_keys(data_b, keys)
 
         sort_hostvar_arrays(data_a)
         sort_hostvar_arrays(data_b)
 
         # Perform the diff
-        # syntax='symmetric' will produce output that prints both the before and after as "$insert" and "$delete"
-        # marshal=True removes any special types, allowing to be dumped as json
-        result = diff(data_a, data_b, marshal=True, syntax="symmetric")
+        result = DeepDiff(data_a, data_b, ignore_order=True)
 
         if result:
             # Dictionary is not empty - print differences

tests/integration/targets/inventory-v3.4/compare_inventory_json.py

@@ -7,13 +7,13 @@
 
 __metaclass__ = type
 
-import sys
-import json
 import argparse
-from jsondiff import diff
-from typing import Iterable
+import json
+import sys
 from operator import itemgetter
 
+from deepdiff import DeepDiff
+
 # NetBox includes "created" and "last_updated" times on objects. These end up in the interfaces objects that are included verbatim from the NetBox API.
 # "url" may be different if local tests use a different host/port
 # Remove these from files saved in git as test data
@@ -33,15 +33,6 @@
 )
 
 
-def all_keys_to_ignore(netbox_version):
-    keys = KEYS_REMOVE.union(KEYS_IGNORE)
-
-    if netbox_version == "v2.7":
-        return keys.union(KEYS_IGNORE_27)
-    else:
-        return keys
-
-
 # Assume the object will not be recursive, as it originally came from JSON
 def remove_keys(obj, keys):
     if isinstance(obj, dict):
@@ -71,24 +62,22 @@ def sort_hostvar_arrays(obj):
     if not hostvars:
         return
 
-    for hostname, host in hostvars.items():
-        interfaces = host.get("interfaces")
-        if interfaces:
+    for _, host in hostvars.items():
+        if interfaces := host.get("interfaces"):
             host["interfaces"] = sorted(interfaces, key=itemgetter("id"))
 
-        services = host.get("services")
-        if services:
+        if services := host.get("services"):
             host["services"] = sorted(services, key=itemgetter("id"))
 
 
 def read_json(filename):
-    with open(filename, "r") as f:
-        return json.loads(f.read())
+    with open(filename, "r", encoding="utf-8") as file:
+        return json.loads(file.read())
 
 
 def write_json(filename, data):
-    with open(filename, "w") as f:
-        json.dump(data, f, indent=4)
+    with open(filename, "w", encoding="utf-8") as file:
+        json.dump(data, file, indent=4)
 
 
 def main():
@@ -140,17 +129,15 @@ def main():
         data_b = read_json(args.filename_b)
 
         # Ignore keys that we don't want to diff, in addition to the ones removed that change on every commit
-        keys = all_keys_to_ignore(args.netbox_version)
+        keys = KEYS_REMOVE.union(KEYS_IGNORE)
         remove_keys(data_a, keys)
         remove_keys(data_b, keys)
 
         sort_hostvar_arrays(data_a)
         sort_hostvar_arrays(data_b)
 
         # Perform the diff
-        # syntax='symmetric' will produce output that prints both the before and after as "$insert" and "$delete"
-        # marshal=True removes any special types, allowing to be dumped as json
-        result = diff(data_a, data_b, marshal=True, syntax="symmetric")
+        result = DeepDiff(data_a, data_b, ignore_order=True)
 
         if result:
             # Dictionary is not empty - print differences