Fix netbox feature tests job failure in Netbox 4.3 (#115)

* Update feature-test.yml

* Implement this change from v4.3 The device and virtual_machine foreign keys on the Service model have been replaced with a generic parent relationship to support the assignment of services to FHRP groups as well.

* Fix optional association

* Fix object check hopefully

* Attempt to make services model type lookup more generic

* implement changelog: The group foreign key on the Contact model has been replaced with a many-to-many groups field.

* Fix contacts

* Cleanup services change get to filter test

* Change filter back to get

* More cleanup

* Revert feature test workflow change

* Remove quotes from services parent_type yaml

* Update netbox 4.2 references to 4.3

* Update readme

* Attempt to fix lint errors

* Enable lint workflow for test

* Disable lint check

* Enable manual run of tests

* Remove manual run of tests

* Reenable manual lint test run

* Final cleanup

* Fix pylint error

Author: sweickge

README.md

@@ -7,7 +7,7 @@ Load data from YAML files into Netbox
 First activate your virtual environment where Netbox is installed, the install the plugin version correspondig to your Netbox version.
 
 ```bash
-pip install "netbox-initializers==4.2.*"
+pip install "netbox-initializers==4.3.*"
 ```
 
 Then you need to add the plugin to the `PLUGINS` array in the Netbox configuration.
@@ -38,6 +38,6 @@ The initializers where a part of the Docker image and where then extracted into
 To use the new plugin in a the Netbox Docker image, it musst be installad into the image. To this, the following example can be used as a starting point:
 
 ```dockerfile
-FROM netboxcommunity/netbox:v4.2
-RUN /opt/netbox/venv/bin/pip install "netbox-initializers==4.2.*"
+FROM netboxcommunity/netbox:v4.3
+RUN /opt/netbox/venv/bin/pip install "netbox-initializers==4.3.*"
 ```

src/netbox_initializers/__init__.py

@@ -9,8 +9,8 @@ class NetBoxInitializersConfig(PluginConfig):
     description = "Load initial data into Netbox"
     version = VERSION
     base_url = "initializers"
-    min_version = "4.2.0"
-    max_version = "4.2.99"
+    min_version = "4.3.0"
+    max_version = "4.3.99"
 
 
 config = NetBoxInitializersConfig

src/netbox_initializers/initializers/contacts.py

@@ -2,8 +2,6 @@
 
 from netbox_initializers.initializers.base import BaseInitializer, register_initializer
 
-OPTIONAL_ASSOCS = {"group": (ContactGroup, "name")}
-
 
 class ContactInitializer(BaseInitializer):
     data_file_name = "contacts.yml"
@@ -16,19 +14,26 @@ def load_data(self):
             custom_field_data = self.pop_custom_fields(params)
             tags = params.pop("tags", None)
 
-            for assoc, details in OPTIONAL_ASSOCS.items():
-                if assoc in params:
-                    model, field = details
-                    query = {field: params.pop(assoc)}
-
-                    params[assoc] = model.objects.get(**query)
+            # Group foreign key on the Contact model is a now many-to-many groups field
+            groups = params.pop("groups", None)  # Extract the groups from params if they exist
+            group_objects = []
+            if groups:
+                for group_name in groups:  # Iterate through the group names
+                    try:
+                        group_objects.append(ContactGroup.objects.get(name=group_name))
+                    except ContactGroup.DoesNotExist:
+                        raise ValueError(f"ContactGroup with name '{group_name}' does not exist.")
 
             matching_params, defaults = self.split_params(params)
             contact, created = Contact.objects.get_or_create(**matching_params, defaults=defaults)
 
             if created:
                 print("👩‍💻 Created Contact", contact.name)
 
+            # Add the groups to the contact if any were found
+            if group_objects:
+                contact.groups.set(group_objects)
+
             self.set_custom_fields_values(contact, custom_field_data)
             self.set_tags(contact, tags)
 

src/netbox_initializers/initializers/services.py

@@ -1,14 +1,9 @@
-from dcim.models import Device
 from ipam.models import Service
-from virtualization.models import VirtualMachine
+from django.contrib.contenttypes.models import ContentType
 
 from netbox_initializers.initializers.base import BaseInitializer, register_initializer
 
-MATCH_PARAMS = ["name", "device", "virtual_machine"]
-OPTIONAL_ASSOCS = {
-    "device": (Device, "name"),
-    "virtual_machine": (VirtualMachine, "name"),
-}
+MATCH_PARAMS = ["name", "parent_object_type", "parent_object_id"]
 
 
 class ServiceInitializer(BaseInitializer):
@@ -21,11 +16,18 @@ def load_data(self):
         for params in services:
             tags = params.pop("tags", None)
 
-            for assoc, details in OPTIONAL_ASSOCS.items():
-                if assoc in params:
-                    model, field = details
-                    query = {field: params.pop(assoc)}
-                    params[assoc] = model.objects.get(**query)
+            # Get model from Contenttype
+            scope_type = params.pop("parent_type", None)
+            if not scope_type:
+                print(
+                    f"Services '{params['name']}': parent_type is missing from Services"
+                )
+            app_label, model = str(scope_type).split(".")
+            parent_model = ContentType.objects.get(app_label=app_label, model=model).model_class()
+            parent = parent_model.objects.get(name=params.pop("parent_name"))
+
+            params["parent_object_type"] = ContentType.objects.get_for_model(parent)
+            params["parent_object_id"] = parent.id
 
             matching_params, defaults = self.split_params(params, MATCH_PARAMS)
             service, created = Service.objects.get_or_create(**matching_params, defaults=defaults)

src/netbox_initializers/initializers/yaml/contacts.yml

@@ -5,14 +5,16 @@
 #   address: 1200 Nowhere Blvd, Scranton NJ, 555111
 #   comments: This is a very important contact
 # - name: Ali Gator
-#   group: Network-Team
+#   groups:
+#     - Network-Team
 #   title: Consultant for Widget Corp
 #   phone: 221-555-1213
 #   email: [email protected]
 #   address: 1200 Nowhere Blvd, Scranton NJ, 555111
 #   comments: This is a very important contact
 # - name: Karlchen Maier
-#   group: New Contact Group
+#   groups:
+#     - New Contact Group
 #   title: COO of Widget Corp
 #   phone: 221-555-1214
 #   email: [email protected]

src/netbox_initializers/initializers/yaml/services.yml

@@ -2,14 +2,17 @@
 #   protocol: TCP
 #   ports:
 #     - 53
-#   virtual_machine: virtual machine 1
+#   parent_type: virtualization.virtualmachine
+#   parent_name: virtual machine 1
 # - name: DNS
 #   protocol: UDP
 #   ports:
 #     - 53
-#   virtual_machine: virtual machine 1
+#   parent_type: virtualization.virtualmachine
+#   parent_name: virtual machine 1
 # - name: MISC
 #   protocol: UDP
 #   ports:
 #     - 4000
-#   device: server01
+#   parent_type: dcim.device
+#   parent_name: server01

src/netbox_initializers/version.py

@@ -1 +1 @@
-VERSION = "4.2.0"
+VERSION = "4.3.0"

test/Dockerfile

@@ -1,4 +1,4 @@
-FROM netboxcommunity/netbox:v4.2
+FROM netboxcommunity/netbox:v4.3
 
 COPY ../ /opt/netbox-initializers/
 COPY ./test/config/plugins.py /etc/netbox/config/