Merge pull request #107 from tobiasge/netbox-4.2

Prepare for Netbox 4.2

Author: tobiasge

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.1.*"
+pip install "netbox-initializers==4.2.*"
 ```
 
 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.1
-RUN /opt/netbox/venv/bin/pip install "netbox-initializers==4.1.*"
+FROM netboxcommunity/netbox:v4.2
+RUN /opt/netbox/venv/bin/pip install "netbox-initializers==4.2.*"
 ```

pyproject.toml

@@ -14,7 +14,7 @@ license = "Apache-2.0"
 dynamic = ["version"]
 
 requires-python = ">=3.10"
-dependencies = ["ruamel-yaml>=0.18.6"]
+dependencies = ["ruamel-yaml>=0.18.10"]
 
 [build-system]
 requires = ["hatchling"]
@@ -24,7 +24,7 @@ build-backend = "hatchling.build"
 path = "src/netbox_initializers/version.py"
 
 [tool.uv]
-dev-dependencies = ["ruff==0.6.3"]
+dev-dependencies = ["ruff==0.9.1"]
 
 [tool.ruff]
 line-length = 100

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.1-beta1"
-    max_version = "4.1.99"
+    min_version = "4.2.0"
+    max_version = "4.2.99"
 
 
 config = NetBoxInitializersConfig

src/netbox_initializers/initializers/__init__.py

@@ -22,6 +22,7 @@
 from .interfaces import InterfaceInitializer
 from .ip_addresses import IPAddressInitializer
 from .locations import LocationInitializer
+from .macs import MACAddressInitializer
 from .manufacturers import ManufacturerInitializer
 from .object_permissions import ObjectPermissionInitializer
 from .platforms import PlatformInitializer

src/netbox_initializers/initializers/base.py

@@ -2,6 +2,7 @@
 from typing import Tuple
 
 from core.models import ObjectType
+from dcim.models import MACAddress
 from django.core.exceptions import ObjectDoesNotExist
 from extras.models import CustomField, Tag
 from ruamel.yaml import YAML
@@ -90,6 +91,22 @@ def set_tags(self, entity, tags):
         if save:
             entity.save()
 
+    def set_mac_addresses(self, entity, mac_addresses):
+        if not mac_addresses:
+            return
+
+        if not hasattr(entity, "mac_addresses"):
+            raise Exception(f"⚠️ MAC Address cannot be applied to {entity}'s model")
+
+        save = False
+        for mac_address in MACAddress.objects.filter(mac_address__in=mac_addresses):
+
+            entity.mac_addresses.add(mac_address)
+            save = True
+
+        if save:
+            entity.save()
+
     def split_params(self, params: dict, unique_params: list = None) -> Tuple[dict, dict]:
         """Split params dict into dict with matching params and a dict with default values"""
 
@@ -140,6 +157,7 @@ class InitializationError(Exception):
     "prefix_vlan_roles",
     "vlan_groups",
     "vlans",
+    "macs",
     "devices",
     "interfaces",
     "route_targets",

src/netbox_initializers/initializers/cables.py

@@ -1,6 +1,6 @@
 from typing import Tuple
-
-from circuits.models import Circuit, CircuitTermination, ProviderNetwork
+from circuits.constants import CIRCUIT_TERMINATION_TERMINATION_TYPES
+from circuits.models import Circuit, CircuitTermination
 from dcim.models import (
     Cable,
     CableTermination,
@@ -13,12 +13,12 @@
     PowerPanel,
     PowerPort,
     RearPort,
-    Site,
 )
 from django.contrib.contenttypes.models import ContentType
 from django.db.models import Q
 
 from netbox_initializers.initializers.base import BaseInitializer, register_initializer
+from netbox_initializers.initializers.utils import get_scope_details
 
 CONSOLE_PORT_TERMINATION = ContentType.objects.get_for_model(ConsolePort)
 CONSOLE_SERVER_PORT_TERMINATION = ContentType.objects.get_for_model(ConsoleServerPort)
@@ -55,16 +55,13 @@ def get_termination_object(params: dict, side: str):
         circuit = Circuit.objects.get(cid=circuit_params.pop("cid"))
         term_side = circuit_params.pop("term_side").upper()
 
-        site_name = circuit_params.pop("site", None)
-        provider_network = circuit_params.pop("provider_network", None)
-
-        if site_name:
-            circuit_params["site"] = Site.objects.get(name=site_name)
-        elif provider_network:
-            circuit_params["provider_network"] = ProviderNetwork.objects.get(name=provider_network)
+        if scope := circuit_params.pop("scope", None):
+            scope_type, scope_id = get_scope_details(scope, CIRCUIT_TERMINATION_TERMINATION_TYPES)
+            circuit_params["termination_type"] = scope_type
+            circuit_params["termination_id"] = scope_id
         else:
             raise ValueError(
-                f"⚠️ Missing one of required parameters: 'site' or 'provider_network' "
+                f"⚠️ Missing required parameter: 'scope'"
                 f"for side {term_side} of circuit {circuit}"
             )
 

src/netbox_initializers/initializers/clusters.py

@@ -7,7 +7,7 @@
 MATCH_PARAMS = ["name", "type"]
 REQUIRED_ASSOCS = {"type": (ClusterType, "name")}
 OPTIONAL_ASSOCS = {
-    "site": (Site, "name"),
+    "scope": (Site, "name"),
     "group": (ClusterGroup, "name"),
     "tenant": (Tenant, "name"),
 }

src/netbox_initializers/initializers/macs.py

@@ -0,0 +1,24 @@
+from dcim.models import MACAddress
+
+from netbox_initializers.initializers.base import BaseInitializer, register_initializer
+
+
+class MACAddressInitializer(BaseInitializer):
+    data_file_name = "macs.yml"
+
+    def load_data(self):
+        macs = self.load_yaml()
+        if macs is None:
+            return
+
+        for mac in macs:
+            tags = mac.pop("tags", None)
+            macaddress, created = MACAddress.objects.get_or_create(**mac)
+
+            if created:
+                print("🗺️ Created MAC Address", macaddress.mac_address)
+
+            self.set_tags(macaddress, tags)
+
+
+register_initializer("macs", MACAddressInitializer)

src/netbox_initializers/initializers/prefixes.py

@@ -1,13 +1,13 @@
-from dcim.models import Site
+from dcim.constants import LOCATION_SCOPE_TYPES
 from ipam.models import VLAN, VRF, Prefix, Role
 from netaddr import IPNetwork
 from tenancy.models import Tenant, TenantGroup
 
 from netbox_initializers.initializers.base import BaseInitializer, register_initializer
+from netbox_initializers.initializers.utils import get_scope_details
 
-MATCH_PARAMS = ["prefix", "site", "vrf", "vlan"]
+MATCH_PARAMS = ["prefix", "scope", "vrf", "vlan"]
 OPTIONAL_ASSOCS = {
-    "site": (Site, "name"),
     "tenant": (Tenant, "name"),
     "tenant_group": (TenantGroup, "name"),
     "vlan": (VLAN, "name"),
@@ -29,6 +29,9 @@ def load_data(self):
 
             params["prefix"] = IPNetwork(params["prefix"])
 
+            if scope := params.pop("scope"):
+                params["scope_type"], params["scope_id"] = get_scope_details(scope, LOCATION_SCOPE_TYPES)
+
             for assoc, details in OPTIONAL_ASSOCS.items():
                 if assoc in params:
                     model, field = details

src/netbox_initializers/initializers/users.py

@@ -1,3 +1,4 @@
+from django.utils.crypto import get_random_string
 from users.models import Token, User
 
 from netbox_initializers.initializers.base import BaseInitializer, register_initializer
@@ -13,7 +14,7 @@ def load_data(self):
 
         for username, user_details in users.items():
             api_token = user_details.pop("api_token", Token.generate_key())
-            password = user_details.pop("password", User.objects.make_random_password())
+            password = user_details.pop("password", get_random_string(length=25))
             user, created = User.objects.get_or_create(username=username, defaults=user_details)
             if created:
                 user.set_password(password)