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

{netbox-config-diff-2.1.0/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.1.0
-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
@@ -328,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

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

@@ -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

{netbox-config-diff-2.1.0 → 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.1.0"
+__version__ = "2.2.0"
 
 
 class ConfigDiffConfig(PluginConfig):

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

@@ -9,10 +9,11 @@ from dcim.choices import DeviceStatusChoices
 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 ConplianceDeviceDataClass
 
@@ -52,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)
@@ -155,17 +161,26 @@ class ConfigDiffBase(SecretsMixin):
                 auth_secondary=auth_secondary,
                 rendered_config=rendered_config,
                 error=error,
+                device=device,
             )
 
     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[ConplianceDeviceDataClass]) -> None:
         if self.data["data_source"]:

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.1.0 → netbox-config-diff-2.2.0}/netbox_config_diff/models/data_models.py

@@ -1,6 +1,7 @@
 import traceback
 from dataclasses import dataclass
 
+from dcim.models import Device
 from scrapli import AsyncScrapli
 
 from netbox_config_diff.choices import ConfigComplianceStatusChoices
@@ -113,10 +114,12 @@ class BaseDeviceDataClass:
 
 class ConplianceDeviceDataClass(BaseDeviceDataClass):
     command: str
+    device: Device | None = None
 
-    def __init__(self, command: str, **kwargs) -> None:
+    def __init__(self, command: str, device: Device, **kwargs) -> None:
         super().__init__(**kwargs)
         self.command = command
+        self.device = device
 
     async def get_actual_config(self) -> None:
         if self.error is not None:

{netbox-config-diff-2.1.0 → netbox-config-diff-2.2.0}/netbox_config_diff/models/models.py

@@ -24,7 +24,7 @@ class ConfigCompliance(AbsoluteURLMixin, ChangeLoggingMixin, models.Model):
     device = models.OneToOneField(
         to="dcim.Device",
         on_delete=models.CASCADE,
-        related_name="config_compliamce",
+        related_name="config_compliance",
     )
     status = models.CharField(
         max_length=50,

netbox-config-diff-2.2.0/netbox_config_diff/navigation.py

@@ -0,0 +1,47 @@
+from extras.plugins import PluginMenu, PluginMenuButton, PluginMenuItem
+from utilities.choices import ButtonColorChoices
+
+
+def get_add_button(model: str) -> PluginMenuButton:
+    return PluginMenuButton(
+        link=f"plugins:netbox_config_diff:{model}_add",
+        title="Add",
+        icon_class="mdi mdi-plus-thick",
+        color=ButtonColorChoices.GREEN,
+        permissions=[f"netbox_config_diff.add_{model}"],
+    )
+
+
+def get_menu_item(model: str, verbose_name: str, add_button: bool = True) -> PluginMenuItem:
+    return PluginMenuItem(
+        link=f"plugins:netbox_config_diff:{model}_list",
+        link_text=verbose_name,
+        buttons=[get_add_button(model)] if add_button else [],
+        permissions=[f"netbox_config_diff.view_{model}"],
+    )
+
+
+compliance_items = (
+    get_menu_item("platformsetting", "Platform Settings"),
+    get_menu_item("configcompliance", "Config Compliances", add_button=False),
+)
+
+config_items = (
+    get_menu_item("configurationrequest", "Configuration Requests"),
+    get_menu_item("substitute", "Substitutes"),
+    PluginMenuItem(
+        link="plugins:netbox_config_diff:configurationrequest_job_list",
+        link_text="Jobs",
+        buttons=[],
+        permissions=["core.view_job"],
+    ),
+)
+
+menu = PluginMenu(
+    label="Config Diff Plugin",
+    groups=(
+        ("Compliance", compliance_items),
+        ("Config Management", config_items),
+    ),
+    icon_class="mdi mdi-vector-difference",
+)

{netbox-config-diff-2.1.0 → netbox-config-diff-2.2.0}/netbox_config_diff/templates/netbox_config_diff/configcompliance/config.html

@@ -1,4 +1,4 @@
-{% extends "netbox_config_diff/configcompliance/base.html" %}
+{% extends "netbox_config_diff/configcompliance.html" %}
 
 {% block title %}{{ object }} - {{ header }}{% endblock %}
 

netbox-config-diff-2.1.0/netbox_config_diff/templates/netbox_config_diff/configcompliance.html → netbox-config-diff-2.2.0/netbox_config_diff/templates/netbox_config_diff/configcompliance/data.html

@@ -1,37 +1,37 @@
-{% extends "netbox_config_diff/configcompliance/base.html" %}
+{% extends base_template %}
 {% load static %}
 
 {% block content %}
   <div class="row mb-3">
     <div class="col col-md-6">
       <div class="card">
-        <h5 class="card-header">{{ object|meta:"verbose_name"|bettertitle }}</h5>
+        <h5 class="card-header">{{ instance|meta:"verbose_name"|bettertitle }}</h5>
         <div class="card-body">
           <table class="table table-hover attr-table">
             <tr>
               <th scope="row">Device</th>
-              <td>{{ object.device|linkify }}</td>
+              <td>{{ instance.device|linkify }}</td>
             </tr>
             <tr>
               <th scope="row">Status</th>
-              <td>{% badge object.get_status_display bg_color=object.get_status_color %}</td>
+              <td>{% badge instance.get_status_display bg_color=instance.get_status_color %}</td>
             </tr>
           </table>
         </div>
       </div>
     </div>
-    {% if object.error %}
+    {% if instance.error %}
       <div class="col col-md-6">
         <div class="card">
           <h5 class="card-header">Error</h5>
           <div class="card-body">
-            <pre class="block">{{ object.error }}</pre>
+            <pre class="block">{{ instance.error }}</pre>
           </div>
         </div>
       </div>
     {% endif %}
   </div>
-  {% if object.diff %}
+  {% if instance.diff %}
     <div class="row mb-3">
       <div class="col col-md-12">
         <div class="card">
@@ -70,7 +70,7 @@
           stickyFileHeaders: false,
           drawFileList: false,
       };
-      const jsonDiff = `{{ object.diff|safe }}`;
+      const jsonDiff = `{{ instance.diff|safe }}`;
       var targetElement = document.getElementById('diffElement');
       var diff2htmlUi = new Diff2HtmlUI(targetElement, jsonDiff, configuration);
       diff2htmlUi.draw();

{netbox-config-diff-2.1.0 → netbox-config-diff-2.2.0}/netbox_config_diff/templates/netbox_config_diff/configcompliance/missing_extra.html

@@ -1,4 +1,4 @@
-{% extends "netbox_config_diff/configcompliance/base.html" %}
+{% extends "netbox_config_diff/configcompliance.html" %}
 
 {% block title %}{{ object }} - Missing/Extra{% endblock %}
 

netbox-config-diff-2.1.0/netbox_config_diff/templates/netbox_config_diff/configcompliance/base.html → netbox-config-diff-2.2.0/netbox_config_diff/templates/netbox_config_diff/configcompliance.html

@@ -10,4 +10,4 @@
       {% endif %}
     </div>
   </div>
-{% endblock controls %}
+{% endblock controls %}

{netbox-config-diff-2.1.0 → netbox-config-diff-2.2.0}/netbox_config_diff/views/compliance.py

@@ -1,5 +1,6 @@
+from dcim.models import Device
 from django.http import HttpResponse
-from django.shortcuts import render
+from django.shortcuts import redirect, render
 from django.utils.translation import gettext as _
 from netbox.views import generic
 from utilities.views import ViewTab, register_model_view
@@ -51,6 +52,14 @@ class BaseConfigComplianceConfigView(generic.ObjectView):
 @register_model_view(ConfigCompliance)
 class ConfigComplianceView(generic.ObjectView):
     queryset = ConfigCompliance.objects.all()
+    base_template = "netbox_config_diff/configcompliance.html"
+    template_name = "netbox_config_diff/configcompliance/data.html"
+
+    def get_extra_context(self, request, instance):
+        return {
+            "instance": instance,
+            "base_template": self.base_template,
+        }
 
 
 @register_model_view(ConfigCompliance, "rendered-config")
@@ -113,6 +122,37 @@ class ConfigComplianceMissingExtraConfigView(generic.ObjectView):
         )
 
 
+@register_model_view(Device, "config_compliance", "config-compliance")
+class ConfigComplianceDeviceView(generic.ObjectView):
+    queryset = Device.objects.all()
+    base_template = "dcim/device/base.html"
+    template_name = "netbox_config_diff/configcompliance/data.html"
+    tab = ViewTab(
+        label=_("Config Compliance"),
+        weight=2110,
+        badge=lambda obj: 1 if hasattr(obj, "config_compliance") else 0,
+        hide_if_empty=True,
+    )
+
+    def get(self, request, **kwargs):
+        instance = self.get_object(**kwargs)
+
+        if not hasattr(instance, "config_compliance"):
+            return redirect("dcim:device", pk=instance.pk)
+
+        return render(
+            request,
+            self.get_template_name(),
+            {
+                "object": instance,
+                "instance": instance.config_compliance,
+                "tab": self.tab,
+                "base_template": self.base_template,
+                **self.get_extra_context(request, instance),
+            },
+        )
+
+
 class ConfigComplianceListView(generic.ObjectListView):
     queryset = ConfigCompliance.objects.prefetch_related("device")
     filterset = ConfigComplianceFilterSet

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

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: netbox-config-diff
-Version: 2.1.0
-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
@@ -328,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

{netbox-config-diff-2.1.0 → netbox-config-diff-2.2.0}/netbox_config_diff.egg-info/SOURCES.txt

@@ -63,6 +63,7 @@ netbox_config_diff/migrations/0004_update_script.py
 netbox_config_diff/migrations/0005_configcompliance_extra_missing.py
 netbox_config_diff/migrations/0006_substitute.py
 netbox_config_diff/migrations/0007_configurationrequest.py
+netbox_config_diff/migrations/0008_alter_configcompliance_device.py
 netbox_config_diff/migrations/__init__.py
 netbox_config_diff/models/__init__.py
 netbox_config_diff/models/base.py
@@ -76,8 +77,8 @@ netbox_config_diff/templates/netbox_config_diff/configcompliance.html
 netbox_config_diff/templates/netbox_config_diff/configurationrequest.html
 netbox_config_diff/templates/netbox_config_diff/platformsetting.html
 netbox_config_diff/templates/netbox_config_diff/substitute.html
-netbox_config_diff/templates/netbox_config_diff/configcompliance/base.html
 netbox_config_diff/templates/netbox_config_diff/configcompliance/config.html
+netbox_config_diff/templates/netbox_config_diff/configcompliance/data.html
 netbox_config_diff/templates/netbox_config_diff/configcompliance/missing_extra.html
 netbox_config_diff/templates/netbox_config_diff/configurationrequest/base.html
 netbox_config_diff/templates/netbox_config_diff/configurationrequest/diffs.html

{netbox-config-diff-2.1.0 → netbox-config-diff-2.2.0}/pyproject.toml

@@ -7,7 +7,7 @@ requires = [
 
 [project]
 name = "netbox-config-diff"
-description = "Find diff between the intended device configuration and actual."
+description = "Push rendered device configurations from NetBox to devices and apply them."
 readme = "README.md"
 keywords = [
   "netbox",

{netbox-config-diff-2.1.0 → netbox-config-diff-2.2.0}/tests/conftest.py

@@ -90,6 +90,7 @@ def devicedataclass_factory() -> "DeviceDataClassDataFactory":
             "password": faker.password(),
             "auth_strict_key": False,
             "transport": "asyncssh",
+            "device": None,
         }
         return data | fields
 

netbox-config-diff-2.1.0/netbox_config_diff/navigation.py

@@ -1,46 +0,0 @@
-from extras.plugins import PluginMenuButton, PluginMenuItem
-from utilities.choices import ButtonColorChoices
-
-
-def get_add_button(model: str) -> PluginMenuButton:
-    return PluginMenuButton(
-        link=f"plugins:netbox_config_diff:{model}_add",
-        title="Add",
-        icon_class="mdi mdi-plus-thick",
-        color=ButtonColorChoices.GREEN,
-        permissions=[f"netbox_config_diff.add_{model}"],
-    )
-
-
-menu_items = (
-    PluginMenuItem(
-        link="plugins:netbox_config_diff:platformsetting_list",
-        link_text="Platform Settings",
-        buttons=[get_add_button("platformsetting")],
-        permissions=["netbox_config_diff.view_platformsetting"],
-    ),
-    PluginMenuItem(
-        link="plugins:netbox_config_diff:configcompliance_list",
-        link_text="Config Compliances",
-        buttons=[],
-        permissions=["netbox_config_diff.view_configcompliance"],
-    ),
-    PluginMenuItem(
-        link="plugins:netbox_config_diff:configurationrequest_list",
-        link_text="Configuration Requests",
-        buttons=[get_add_button("configurationrequest")],
-        permissions=["netbox_config_diff.view_configurationrequest"],
-    ),
-    PluginMenuItem(
-        link="plugins:netbox_config_diff:configurationrequest_job_list",
-        link_text="Jobs",
-        buttons=[],
-        permissions=["core.view_job"],
-    ),
-    PluginMenuItem(
-        link="plugins:netbox_config_diff:substitute_list",
-        link_text="Substitutes",
-        buttons=[get_add_button("substitute")],
-        permissions=["netbox_config_diff.view_substitute"],
-    ),
-)