netbox-config-diff 2.0.1__tar.gz → 2.2.0__tar.gz

{netbox-config-diff-2.0.1/netbox_config_diff.egg-info → netbox-config-diff-2.2.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: netbox-config-diff
-Version: 2.0.1
-Summary: Find diff between the intended device configuration and actual.
+Version: 2.2.0
+Summary: Push rendered device configurations from NetBox to devices and apply them.
 Author: Artem Kotik
 Author-email: miaow2@yandex.ru
 License:                                  Apache License
@@ -223,8 +223,7 @@ Requires-Dist: scrapli[asyncssh]==2023.07.30
 Requires-Dist: scrapli-cfg==2023.07.30
 Requires-Dist: scrapli-community==2023.07.30
 Provides-Extra: dev
-Requires-Dist: black==23.10.0; extra == "dev"
-Requires-Dist: ruff==0.1.0; extra == "dev"
+Requires-Dist: ruff==0.1.2; extra == "dev"
 Provides-Extra: test
 Requires-Dist: factory_boy==3.3.0; extra == "test"
 Requires-Dist: pytest==7.4.0; extra == "test"
@@ -233,7 +232,6 @@ Requires-Dist: pytest-django==4.5.2; extra == "test"
 [![NetBox version](https://img.shields.io/badge/NetBox-3.5|3.6-blue.svg)](https://github.com/netbox-community/netbox)
 [![Supported Versions](https://img.shields.io/pypi/pyversions/netbox-config-diff.svg)](https://pypi.org/project/netbox-config-diff/)
 [![PyPI version](https://badge.fury.io/py/netbox-config-diff.svg)](https://badge.fury.io/py/netbox-config-diff)
-[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![CI](https://github.com/miaow2/netbox-config-diff/actions/workflows/commit.yaml/badge.svg?branch=develop)](https://github.com/miaow2/netbox-config-diff/actions)
@@ -310,6 +308,7 @@ PLUGINS_CONFIG = {
     "netbox_config_diff": {
         "USERNAME": "foo",
         "PASSWORD": "bar",
+        "AUTH_SECONDARY": "foobar",  # define here password for accessing Privileged EXEC mode, this variable is optional
     },
 }
 ```
@@ -329,13 +328,19 @@ python manage.py collectstatic --noinput
 Restart NetBox service:
 
 ```bash
-systemctl restart netbox
+systemctl restart netbox netbox-rq
 ```
 <!--install-end-->
 <!--usage-start-->
 ## Usage
 
-Read this [doc](docs/colliecting-diffs.md) about collecting diffs, for configuration management read [this](docs/configuratiom-management.md)
+Read this [doc](https://miaow2.github.io/netbox-config-diff/colliecting-diffs/) about collecting diffs, for configuration management read [this](https://miaow2.github.io/netbox-config-diff/configuratiom-management/)
+
+## Video
+
+My presention about plugin at October NetBox community call (19.10.2023).
+
+[![October NetBox community call](https://img.youtube.com/vi/B4uhtYh278o/0.jpg)](https://youtu.be/B4uhtYh278o?t=425)
 <!--usage-end-->
 
 ## Screenshots
@@ -352,6 +357,14 @@ No diff
 
 ![Screenshot of the compliance ok](docs/media/screenshots/compliance-ok.png)
 
+Configuration request
+
+![Screenshot of the CR](docs/media/screenshots/cr-created.png)
+
+Completed Configuration request
+
+![Screenshot of the completed CR](docs/media/screenshots/cr-completed.png)
+
 ## Credits
 
 Based on the NetBox plugin tutorial:

{netbox-config-diff-2.0.1 → netbox-config-diff-2.2.0}/README.md

@@ -1,7 +1,6 @@
 [![NetBox version](https://img.shields.io/badge/NetBox-3.5|3.6-blue.svg)](https://github.com/netbox-community/netbox)
 [![Supported Versions](https://img.shields.io/pypi/pyversions/netbox-config-diff.svg)](https://pypi.org/project/netbox-config-diff/)
 [![PyPI version](https://badge.fury.io/py/netbox-config-diff.svg)](https://badge.fury.io/py/netbox-config-diff)
-[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![CI](https://github.com/miaow2/netbox-config-diff/actions/workflows/commit.yaml/badge.svg?branch=develop)](https://github.com/miaow2/netbox-config-diff/actions)
@@ -78,6 +77,7 @@ PLUGINS_CONFIG = {
     "netbox_config_diff": {
         "USERNAME": "foo",
         "PASSWORD": "bar",
+        "AUTH_SECONDARY": "foobar",  # define here password for accessing Privileged EXEC mode, this variable is optional
     },
 }
 ```
@@ -97,13 +97,19 @@ python manage.py collectstatic --noinput
 Restart NetBox service:
 
 ```bash
-systemctl restart netbox
+systemctl restart netbox netbox-rq
 ```
 <!--install-end-->
 <!--usage-start-->
 ## Usage
 
-Read this [doc](docs/colliecting-diffs.md) about collecting diffs, for configuration management read [this](docs/configuratiom-management.md)
+Read this [doc](https://miaow2.github.io/netbox-config-diff/colliecting-diffs/) about collecting diffs, for configuration management read [this](https://miaow2.github.io/netbox-config-diff/configuratiom-management/)
+
+## Video
+
+My presention about plugin at October NetBox community call (19.10.2023).
+
+[![October NetBox community call](https://img.youtube.com/vi/B4uhtYh278o/0.jpg)](https://youtu.be/B4uhtYh278o?t=425)
 <!--usage-end-->
 
 ## Screenshots
@@ -120,6 +126,14 @@ No diff
 
 ![Screenshot of the compliance ok](docs/media/screenshots/compliance-ok.png)
 
+Configuration request
+
+![Screenshot of the CR](docs/media/screenshots/cr-created.png)
+
+Completed Configuration request
+
+![Screenshot of the completed CR](docs/media/screenshots/cr-completed.png)
+
 ## Credits
 
 Based on the NetBox plugin tutorial:

{netbox-config-diff-2.0.1 → netbox-config-diff-2.2.0}/netbox_config_diff/__init__.py

@@ -2,7 +2,7 @@ from extras.plugins import PluginConfig
 
 __author__ = "Artem Kotik"
 __email__ = "miaow2@yandex.ru"
-__version__ = "2.0.1"
+__version__ = "2.2.0"
 
 
 class ConfigDiffConfig(PluginConfig):
@@ -18,6 +18,7 @@ class ConfigDiffConfig(PluginConfig):
     default_settings = {
         "USER_SECRET_ROLE": "Username",
         "PASSWORD_SECRET_ROLE": "Password",
+        "SECOND_AUTH_SECRET_ROLE": "Second Auth",
     }
 
 

{netbox-config-diff-2.0.1 → netbox-config-diff-2.2.0}/netbox_config_diff/api/serializers.py

@@ -116,6 +116,11 @@ class ConfigurationRequestSerializer(NetBoxModelSerializer):
             }:
                 raise ValidationError({"devices": f"Driver(s) not supported: {', '.join(drivers)}"})
 
+            if devices := list(filter(lambda x: x.get_config_template() is None, data["devices"])):
+                raise ValidationError(
+                    {"devices": f"Define config template for device(s): {', '.join(d.name for d in devices)}"}
+                )
+
         return super().validate(data)
 
 

{netbox-config-diff-2.0.1 → netbox-config-diff-2.2.0}/netbox_config_diff/compliance/base.py

@@ -6,38 +6,44 @@ from typing import Iterable, Iterator
 from core.choices import DataSourceStatusChoices
 from core.models import DataFile, DataSource
 from dcim.choices import DeviceStatusChoices
-from dcim.models import Device, Site
-from django.core.exceptions import ObjectDoesNotExist
+from dcim.models import Device, DeviceRole, Site
+from django.conf import settings
 from django.db.models import Q
-from extras.scripts import MultiObjectVar, ObjectVar
+from extras.scripts import MultiObjectVar, ObjectVar, TextVar
 from jinja2.exceptions import TemplateError
 from netutils.config.compliance import diff_network_config
 from utilities.exceptions import AbortScript
+from utilities.utils import render_jinja2
 
-from netbox_config_diff.models import ConfigCompliance
+from netbox_config_diff.models import ConplianceDeviceDataClass
 
-from .models import DeviceDataClass
 from .secrets import SecretsMixin
-from .utils import PLATFORM_MAPPING, exclude_lines, get_unified_diff
+from .utils import PLATFORM_MAPPING, CustomChoiceVar, exclude_lines, get_unified_diff
 
 
 class ConfigDiffBase(SecretsMixin):
     site = ObjectVar(
         model=Site,
         required=False,
-        description="Run compliance for devices (with status Active, "
-        "primary IP, platform and config template) in this site",
+        description="Run compliance for devices (with primary IP, platform) in this site",
+    )
+    role = ObjectVar(
+        model=DeviceRole,
+        required=False,
+        description="Run compliance for devices with this role",
     )
     devices = MultiObjectVar(
         model=Device,
         required=False,
         query_params={
-            "status": DeviceStatusChoices.STATUS_ACTIVE,
             "has_primary_ip": True,
             "platform_id__n": "null",
-            "config_template_id__n": "null",
         },
-        description="If you define devices in this field, the Site field will be ignored",
+        description="If you define devices in this field, Site, Role fields will be ignored",
+    )
+    status = CustomChoiceVar(
+        choices=DeviceStatusChoices,
+        default=DeviceStatusChoices.STATUS_ACTIVE,
     )
     data_source = ObjectVar(
         model=DataSource,
@@ -47,6 +53,11 @@ class ConfigDiffBase(SecretsMixin):
         },
         description="Define synced DataSource, if you want compare configs stored in it wihout connecting to devices",
     )
+    name_template = TextVar(
+        required=False,
+        description="Jinja2 template code for the device name in Data source. "
+        "Reference the object as <code>{{ object }}</code>.",
+    )
 
     def run_script(self, data: dict) -> None:
         devices = self.validate_data(data)
@@ -56,8 +67,8 @@ class ConfigDiffBase(SecretsMixin):
         self.update_in_db(devices)
 
     def validate_data(self, data: dict) -> Iterable[Device]:
-        if not data["site"] and not data["devices"]:
-            raise AbortScript("Define site or devices")
+        if not data["site"] and not data["role"] and not data["devices"]:
+            raise AbortScript("Define site, role or devices")
         if data.get("data_source") and data["data_source"].status != DataSourceStatusChoices.COMPLETED:
             raise AbortScript("Define synced DataSource")
 
@@ -66,23 +77,29 @@ class ConfigDiffBase(SecretsMixin):
             devices = (
                 data["devices"]
                 .filter(
-                    status=DeviceStatusChoices.STATUS_ACTIVE,
+                    status=data["status"],
                     platform__platform_setting__isnull=False,
-                    config_template__isnull=False,
                 )
                 .exclude(
                     Q(primary_ip4__isnull=True) & Q(primary_ip6__isnull=True),
                 )
             )
         else:
-            devices = Device.objects.filter(
-                site=data["site"],
-                status=DeviceStatusChoices.STATUS_ACTIVE,
-                platform__platform_setting__isnull=False,
-                config_template__isnull=False,
-            ).exclude(
+            filters = {
+                "status": data["status"],
+                "platform__platform_setting__isnull": False,
+            }
+            if data["site"]:
+                filters["site"] = data["site"]
+            elif data["role"]:
+                if settings.VERSION.split(".", 1)[1].startswith("5"):
+                    filters["device_role"] = data["role"]
+                else:
+                    filters["role"] = data["role"]
+            devices = Device.objects.filter(**filters).exclude(
                 Q(primary_ip4__isnull=True) & Q(primary_ip6__isnull=True),
             )
+
         if data.get("devices"):
             if qs_diff := data["devices"].difference(devices):
                 platforms = {d.platform.name for d in qs_diff}
@@ -90,24 +107,18 @@ class ConfigDiffBase(SecretsMixin):
 
         if not devices:
             self.log_warning(
-                "No matching devices found, devices must have status `Active`, primary IP, platform and platformsetting"
+                "No matching devices found, devices must have status primary IP, platform and platformsetting"
             )
         else:
             self.log_info(f"Working with device(s): {', '.join(d.name for d in devices)}")
         return devices
 
-    def update_in_db(self, devices: list[DeviceDataClass]) -> None:
+    def update_in_db(self, devices: list[ConplianceDeviceDataClass]) -> None:
         for device in devices:
             self.log_results(device)
-            try:
-                obj = ConfigCompliance.objects.get(device_id=device.pk)
-                obj.snapshot()
-                obj.update(**device.to_db())
-                obj.save()
-            except ObjectDoesNotExist:
-                ConfigCompliance.objects.create(**device.to_db())
-
-    def log_results(self, device: DeviceDataClass) -> None:
+            device.send_to_db()
+
+    def log_results(self, device: ConplianceDeviceDataClass) -> None:
         if device.error:
             self.log_failure(f"{device.name} errored")
         elif device.diff:
@@ -115,11 +126,11 @@ class ConfigDiffBase(SecretsMixin):
         else:
             self.log_success(f"{device.name} no diff")
 
-    def get_devices_with_rendered_configs(self, devices: Iterable[Device]) -> Iterator[DeviceDataClass]:
+    def get_devices_with_rendered_configs(self, devices: Iterable[Device]) -> Iterator[ConplianceDeviceDataClass]:
         self.check_netbox_secrets()
         self.substitutes = {}
         for device in devices:
-            username, password = self.get_credentials(device)
+            username, password, auth_secondary = self.get_credentials(device)
             rendered_config = None
             error = None
             context_data = device.get_config_context()
@@ -138,7 +149,7 @@ class ConfigDiffBase(SecretsMixin):
                 if substitutes := device.platform.platform_setting.substitutes.all():
                     self.substitutes[platform] = [s.regexp for s in substitutes]
 
-            yield DeviceDataClass(
+            yield ConplianceDeviceDataClass(
                 pk=device.pk,
                 name=device.name,
                 mgmt_ip=str(device.primary_ip.address.ip),
@@ -147,28 +158,38 @@ class ConfigDiffBase(SecretsMixin):
                 exclude_regex=device.platform.platform_setting.exclude_regex,
                 username=username,
                 password=password,
+                auth_secondary=auth_secondary,
                 rendered_config=rendered_config,
                 error=error,
+                device=device,
             )
 
-    def get_config_from_datasource(self, devices: list[DeviceDataClass]) -> None:
+    def get_config_from_datasource(self, devices: list[ConplianceDeviceDataClass]) -> None:
         for device in devices:
-            if df := DataFile.objects.filter(source=self.data["data_source"], path__icontains=device.name).first():
+            if self.data["name_template"]:
+                try:
+                    device_name = render_jinja2(self.data["name_template"], {"object": device.device}).strip()
+                except Exception as e:
+                    self.log_failure(f"Error in rendering data source name for {device.name}: {e}, using device name.")
+                    device_name = device.name
+            else:
+                device_name = device.name
+            if df := DataFile.objects.filter(source=self.data["data_source"], path__icontains=device_name).first():
                 if config := df.data_as_string:
                     device.actual_config = config
                 else:
                     device.error = f"Data in file {df} is broken, skiping device {device.name}"
             else:
-                device.error = f"Not found file in DataSource for device {device.name}"
+                device.error = f"Not found file in DataSource for name {device_name}"
 
-    def get_actual_configs(self, devices: list[DeviceDataClass]) -> None:
+    def get_actual_configs(self, devices: list[ConplianceDeviceDataClass]) -> None:
         if self.data["data_source"]:
             self.get_config_from_datasource(devices)
         else:
             loop = asyncio.get_event_loop()
             loop.run_until_complete(asyncio.gather(*(d.get_actual_config() for d in devices)))
 
-    def get_diff(self, devices: list[DeviceDataClass]) -> None:
+    def get_diff(self, devices: list[ConplianceDeviceDataClass]) -> None:
         for device in devices:
             if device.error is not None:
                 continue

{netbox-config-diff-2.0.1 → netbox-config-diff-2.2.0}/netbox_config_diff/compliance/secrets.py

@@ -15,9 +15,9 @@ class SecretsMixin:
 
     def get_session_key(self) -> None:
         if "netbox_secrets_sessionid" in self.request.COOKIES:
-            self.session_key = base64.b64decode(self.request.COOKIES['netbox_secrets_sessionid'])
+            self.session_key = base64.b64decode(self.request.COOKIES["netbox_secrets_sessionid"])
         elif "HTTP_X_SESSION_KEY" in self.request.META:
-            self.session_key = base64.b64decode(self.request.META['HTTP_X_SESSION_KEY'])
+            self.session_key = base64.b64decode(self.request.META["HTTP_X_SESSION_KEY"])
         else:
             self.session_key = None
 
@@ -45,24 +45,33 @@ class SecretsMixin:
             return None
         return secret.plaintext
 
-    def get_credentials(self, device: Device) -> tuple[str, str]:
-        if self.netbox_secrets_installed:
-            if secret := device.secrets.filter(role__name=self.user_role).first():
-                if value := self.get_secret(secret):
-                    username = value
-            if secret := device.secrets.filter(role__name=self.password_role).first():
-                if value := self.get_secret(secret):
-                    password = value
-            return username, password
+    def get_credentials(self, device: Device) -> tuple[str, str, str]:
+        if not self.netbox_secrets_installed:
+            return self.username, self.password, self.auth_secondary
 
-        return self.username, self.password
+        if secret := device.secrets.filter(role__name=self.user_role).first():
+            username = value if (value := self.get_secret(secret)) else self.username
+        else:
+            username = self.username
+        if secret := device.secrets.filter(role__name=self.password_role).first():
+            password = value if (value := self.get_secret(secret)) else self.password
+        else:
+            password = self.password
+        if secret := device.secrets.filter(role__name=self.auth_secondary_role).first():
+            auth_secondary = value if (value := self.get_secret(secret)) else self.auth_secondary
+        else:
+            auth_secondary = self.auth_secondary
+
+        return username, password, auth_secondary
 
     def check_netbox_secrets(self) -> None:
         if "netbox_secrets" in get_installed_plugins():
             self.get_master_key()
             self.user_role = get_plugin_config("netbox_config_diff", "USER_SECRET_ROLE")
             self.password_role = get_plugin_config("netbox_config_diff", "PASSWORD_SECRET_ROLE")
+            self.auth_secondary_role = get_plugin_config("netbox_config_diff", "SECOND_AUTH_SECRET_ROLE")
             self.netbox_secrets_installed = True
-        else:
-            self.username = get_plugin_config("netbox_config_diff", "USERNAME")
-            self.password = get_plugin_config("netbox_config_diff", "PASSWORD")
+
+        self.username = get_plugin_config("netbox_config_diff", "USERNAME")
+        self.password = get_plugin_config("netbox_config_diff", "PASSWORD")
+        self.auth_secondary = get_plugin_config("netbox_config_diff", "AUTH_SECONDARY")

{netbox-config-diff-2.0.1 → netbox-config-diff-2.2.0}/netbox_config_diff/compliance/utils.py

@@ -1,6 +1,9 @@
 import re
 from difflib import unified_diff
 
+from django.forms import ChoiceField
+from extras.scripts import ScriptVariable
+
 PLATFORM_MAPPING = {
     "arista_eos": "arista_eos",
     "cisco_aireos": "cisco_aireos",
@@ -17,6 +20,14 @@ PLATFORM_MAPPING = {
 }
 
 
+class CustomChoiceVar(ScriptVariable):
+    form_field = ChoiceField
+
+    def __init__(self, choices, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.field_attrs["choices"] = choices
+
+
 def get_unified_diff(rendered_config: str, actual_config: str, device: str) -> str:
     diff = unified_diff(
         rendered_config.strip().splitlines(),

{netbox-config-diff-2.0.1 → netbox-config-diff-2.2.0}/netbox_config_diff/configurator/base.py

@@ -13,13 +13,12 @@ from scrapli_cfg.platform.base.async_platform import AsyncScrapliCfgPlatform
 from scrapli_cfg.response import ScrapliCfgResponse
 from utilities.utils import NetBoxFakeRequest
 
-from netbox_config_diff.compliance.models import DeviceDataClass
 from netbox_config_diff.compliance.secrets import SecretsMixin
 from netbox_config_diff.compliance.utils import PLATFORM_MAPPING, get_unified_diff
 from netbox_config_diff.configurator.exceptions import DeviceConfigurationError, DeviceValidationError
 from netbox_config_diff.configurator.utils import CustomLogger
 from netbox_config_diff.constants import ACCEPTABLE_DRIVERS
-from netbox_config_diff.models import ConfigCompliance
+from netbox_config_diff.models import ConfiguratorDeviceDataClass
 
 from .factory import AsyncScrapliCfg
 
@@ -28,9 +27,9 @@ class Configurator(SecretsMixin):
     def __init__(self, devices: Iterable[Device], request: NetBoxFakeRequest) -> None:
         self.devices = devices
         self.request = request
-        self.unprocessed_devices = set()
-        self.processed_devices = set()
-        self.failed_devices = set()
+        self.unprocessed_devices: set[ConfiguratorDeviceDataClass] = set()
+        self.processed_devices: set[ConfiguratorDeviceDataClass] = set()
+        self.failed_devices: set[ConfiguratorDeviceDataClass] = set()
         self.substitutes: dict[str, list] = {}
         self.logger = CustomLogger()
         self.connections: dict[str, AsyncScrapliCfgPlatform] = {}
@@ -38,7 +37,7 @@ class Configurator(SecretsMixin):
     def validate_devices(self) -> None:
         self.check_netbox_secrets()
         for device in self.devices:
-            username, password = self.get_credentials(device)
+            username, password, auth_secondary = self.get_credentials(device)
             if device.platform.platform_setting is None:
                 self.logger.log_warning(f"Skipping {device}, add PlatformSetting for {device.platform} platform")
             elif device.platform.platform_setting.driver not in ACCEPTABLE_DRIVERS:
@@ -60,13 +59,14 @@ class Configurator(SecretsMixin):
                     error = "Define config template for device"
                     self.logger.log_failure(error)
 
-                d = DeviceDataClass(
+                d = ConfiguratorDeviceDataClass(
                     pk=device.pk,
                     name=device.name,
                     mgmt_ip=str(device.primary_ip.address.ip),
                     platform=device.platform.platform_setting.driver,
                     username=username,
                     password=password,
+                    auth_secondary=auth_secondary,
                     rendered_config=rendered_config,
                     error=error,
                 )
@@ -109,20 +109,14 @@ class Configurator(SecretsMixin):
     @sync_to_async
     def update_diffs(self) -> None:
         for device in self.unprocessed_devices:
-            try:
-                obj = ConfigCompliance.objects.get(device_id=device.pk)
-                obj.snapshot()
-                obj.update(**device.to_db())
-                obj.save()
-            except ConfigCompliance.DoesNotExist:
-                ConfigCompliance.objects.create(**device.to_db())
+            device.send_to_db()
 
     async def _collect_diffs(self) -> None:
         async with self.connection():
             await asyncio.gather(*(self._collect_one_diff(d) for d in self.unprocessed_devices))
         await self.update_diffs()
 
-    async def _collect_one_diff(self, device: DeviceDataClass) -> None:
+    async def _collect_one_diff(self, device: ConfiguratorDeviceDataClass) -> None:
         self.logger.log_info(f"Collecting diff on {device.name}")
         try:
             conn = self.connections[device.name]
@@ -168,7 +162,7 @@ class Configurator(SecretsMixin):
                 devices=", ".join(f"{d.name}: {d.config_error}" for d in self.failed_devices),
             )
 
-    async def _push_one_config(self, device: DeviceDataClass) -> None:
+    async def _push_one_config(self, device: ConfiguratorDeviceDataClass) -> None:
         self.logger.log_info(f"Push config to {device.name}")
         try:
             conn = self.connections[device.name]
@@ -191,7 +185,11 @@ class Configurator(SecretsMixin):
             self.failed_devices.add(device)
 
     async def abort_config(
-        self, operation: str, conn: AsyncScrapliCfgPlatform, response: ScrapliCfgResponse, device: DeviceDataClass
+        self,
+        operation: str,
+        conn: AsyncScrapliCfgPlatform,
+        response: ScrapliCfgResponse,
+        device: ConfiguratorDeviceDataClass,
     ) -> None:
         self.logger.log_failure(f"Failed to {operation} config on {device.name}: {response.result}")
         device.config_error = response.result
@@ -204,7 +202,7 @@ class Configurator(SecretsMixin):
         self.logger.log_info(f"Rollback config: {', '.join(d.name for d in self.processed_devices)}")
         await asyncio.gather(*(self._rollback_one(d) for d in self.processed_devices))
 
-    async def _rollback_one(self, device: DeviceDataClass) -> None:
+    async def _rollback_one(self, device: ConfiguratorDeviceDataClass) -> None:
         conn = self.connections[device.name]
         await conn.load_config(config=device.actual_config, replace=True)
         await conn.commit_config()

{netbox-config-diff-2.0.1 → netbox-config-diff-2.2.0}/netbox_config_diff/configurator/utils.py

@@ -15,7 +15,7 @@ class CustomLogger:
             raise Exception(f"Unknown logging level: {log_level}")
         if log_level is None:
             log_level = LogLevelChoices.LOG_DEFAULT
-        self.log_data.append((timezone.now().strftime('%Y-%m-%d %H:%M:%S'), log_level, message))
+        self.log_data.append((timezone.now().strftime("%Y-%m-%d %H:%M:%S"), log_level, message))
 
     def log(self, message: str) -> None:
         self._log(message, log_level=LogLevelChoices.LOG_DEFAULT)

{netbox-config-diff-2.0.1 → netbox-config-diff-2.2.0}/netbox_config_diff/forms.py

@@ -89,7 +89,6 @@ class ConfigurationRequestForm(NetBoxModelForm):
             "status": DeviceStatusChoices.STATUS_ACTIVE,
             "has_primary_ip": True,
             "platform_id__n": "null",
-            "config_template_id__n": "null",
         },
     )
     created_by = forms.ModelChoiceField(
@@ -122,6 +121,11 @@ class ConfigurationRequestForm(NetBoxModelForm):
         }:
             raise forms.ValidationError({"devices": f"Driver(s) not supported: {', '.join(drivers)}"})
 
+        if devices := list(filter(lambda x: x.get_config_template() is None, self.cleaned_data["devices"])):
+            raise forms.ValidationError(
+                {"devices": f"Define config template for device(s): {', '.join(d.name for d in devices)}"}
+            )
+
 
 class ConfigurationRequestFilterForm(NetBoxModelFilterSetForm):
     model = ConfigurationRequest

netbox-config-diff-2.2.0/netbox_config_diff/migrations/0008_alter_configcompliance_device.py

@@ -0,0 +1,21 @@
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("dcim", "0181_rename_device_role_device_role"),
+        ("netbox_config_diff", "0007_configurationrequest"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="configcompliance",
+            name="device",
+            field=models.OneToOneField(
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="config_compliance",
+                to="dcim.device",
+            ),
+        ),
+    ]

netbox-config-diff-2.2.0/netbox_config_diff/models/__init__.py

@@ -0,0 +1,11 @@
+from .data_models import ConfiguratorDeviceDataClass, ConplianceDeviceDataClass
+from .models import ConfigCompliance, ConfigurationRequest, PlatformSetting, Substitute
+
+__all__ = (
+    "ConfigCompliance",
+    "ConfigurationRequest",
+    "ConfiguratorDeviceDataClass",
+    "ConplianceDeviceDataClass",
+    "PlatformSetting",
+    "Substitute",
+)

netbox-config-diff-2.2.0/netbox_config_diff/models/base.py

@@ -0,0 +1,10 @@
+from django.db import models
+from django.urls import reverse
+
+
+class AbsoluteURLMixin(models.Model):
+    class Meta:
+        abstract = True
+
+    def get_absolute_url(self):
+        return reverse(f"plugins:netbox_config_diff:{self._meta.model_name}", args=[self.pk])