netbox-config-diff 2.3.0__tar.gz → 2.4.0__tar.gz

{netbox-config-diff-2.3.0/netbox_config_diff.egg-info → netbox_config_diff-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-config-diff
-Version: 2.3.0
+Version: 2.4.0
 Summary: Push rendered device configurations from NetBox to devices and apply them.
 Author: Artem Kotik
 Author-email: miaow2@yandex.ru
@@ -218,6 +218,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: hier-config==2.2.3
 Requires-Dist: netutils==1.5.0
 Requires-Dist: scrapli[asyncssh]==2023.07.30
 Requires-Dist: scrapli-cfg==2023.07.30

{netbox-config-diff-2.3.0 → netbox_config_diff-2.4.0}/netbox_config_diff/__init__.py

@@ -2,7 +2,7 @@ from extras.plugins import PluginConfig
 
 __author__ = "Artem Kotik"
 __email__ = "miaow2@yandex.ru"
-__version__ = "2.3.0"
+__version__ = "2.4.0"
 
 
 class ConfigDiffConfig(PluginConfig):

{netbox-config-diff-2.3.0 → netbox_config_diff-2.4.0}/netbox_config_diff/api/serializers.py

@@ -29,6 +29,7 @@ class ConfigComplianceSerializer(NetBoxModelSerializer):
             "diff",
             "rendered_config",
             "actual_config",
+            "patch",
             "missing",
             "extra",
             "created",

{netbox-config-diff-2.3.0 → netbox_config_diff-2.4.0}/netbox_config_diff/compliance/base.py

@@ -18,7 +18,7 @@ from utilities.utils import render_jinja2
 from netbox_config_diff.models import ConplianceDeviceDataClass
 
 from .secrets import SecretsMixin
-from .utils import PLATFORM_MAPPING, CustomChoiceVar, exclude_lines, get_unified_diff
+from .utils import PLATFORM_MAPPING, CustomChoiceVar, exclude_lines, get_remediation_commands, get_unified_diff
 
 
 class ConfigDiffBase(SecretsMixin):
@@ -204,3 +204,6 @@ class ConfigDiffBase(SecretsMixin):
                 device.extra = diff_network_config(
                     cleaned_config, device.rendered_config, PLATFORM_MAPPING[device.platform]
                 )
+            device.patch = get_remediation_commands(
+                device.name, device.platform, cleaned_config, device.rendered_config
+            )

{netbox-config-diff-2.3.0 → netbox_config_diff-2.4.0}/netbox_config_diff/compliance/utils.py

@@ -3,6 +3,7 @@ from difflib import unified_diff
 
 from django.forms import ChoiceField
 from extras.scripts import ScriptVariable
+from hier_config import Host
 
 PLATFORM_MAPPING = {
     "arista_eos": "arista_eos",
@@ -19,6 +20,15 @@ PLATFORM_MAPPING = {
     "ruckus_fastiron": "ruckus_fastiron",
 }
 
+REMEDIATION_MAPPING = {
+    "arista_eos": "eos",
+    "cisco_iosxe": "ios",
+    "cisco_iosxr": "iosxr",
+    "cisco_nxos": "nxos",
+    "juniper_junos": "junos",
+    "vyos_vyos": "vyos",
+}
+
 
 class CustomChoiceVar(ScriptVariable):
     form_field = ChoiceField
@@ -43,3 +53,10 @@ def exclude_lines(text: str, regexs: list) -> str:
     for item in regexs:
         text = re.sub(item, "", text, flags=re.I | re.M)
     return text.strip()
+
+
+def get_remediation_commands(name: str, platform: str, actual_config: str, rendered_config: str) -> str:
+    host = Host(hostname=name, os=REMEDIATION_MAPPING.get(platform, "ios"))
+    host.load_running_config(config_text=actual_config)
+    host.load_generated_config(config_text=rendered_config)
+    return host.remediation_config_filtered_text(include_tags={}, exclude_tags={})

{netbox-config-diff-2.3.0 → netbox_config_diff-2.4.0}/netbox_config_diff/configurator/base.py

@@ -14,7 +14,7 @@ from scrapli_cfg.response import ScrapliCfgResponse
 from utilities.utils import NetBoxFakeRequest
 
 from netbox_config_diff.compliance.secrets import SecretsMixin
-from netbox_config_diff.compliance.utils import PLATFORM_MAPPING, get_unified_diff
+from netbox_config_diff.compliance.utils import PLATFORM_MAPPING, get_remediation_commands, 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
@@ -137,6 +137,9 @@ class Configurator(SecretsMixin):
             device.extra = diff_network_config(
                 device.actual_config, device.rendered_config, PLATFORM_MAPPING[device.platform]
             )
+            device.patch = get_remediation_commands(
+                device.name, device.platform, device.actual_config, device.rendered_config
+            )
             self.logger.log_info(f"Got diff from {device.name}")
         except Exception:
             error = traceback.format_exc()

netbox_config_diff-2.4.0/netbox_config_diff/migrations/0009_configcompliance_patch.py

@@ -0,0 +1,16 @@
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("netbox_config_diff", "0008_alter_configcompliance_device"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="configcompliance",
+            name="patch",
+            field=models.TextField(blank=True),
+        ),
+    ]

{netbox-config-diff-2.3.0 → netbox_config_diff-2.4.0}/netbox_config_diff/models/data_models.py

@@ -23,6 +23,7 @@ class BaseDeviceDataClass:
     diff: str = ""
     missing: str | None = None
     extra: str | None = None
+    patch: str | None = None
     error: str = ""
     config_error: str | None = None
     auth_strict_key: bool = False
@@ -99,6 +100,7 @@ class BaseDeviceDataClass:
             "actual_config": self.actual_config or "",
             "missing": self.missing or "",
             "extra": self.extra or "",
+            "patch": self.patch or "",
         }
 
     def send_to_db(self) -> None:

{netbox-config-diff-2.3.0 → netbox_config_diff-2.4.0}/netbox_config_diff/models/models.py

@@ -49,6 +49,9 @@ class ConfigCompliance(AbsoluteURLMixin, ChangeLoggingMixin, models.Model):
     extra = models.TextField(
         blank=True,
     )
+    patch = models.TextField(
+        blank=True,
+    )
 
     objects = RestrictedQuerySet.as_manager()
 

{netbox-config-diff-2.3.0 → netbox_config_diff-2.4.0}/netbox_config_diff/templates/netbox_config_diff/configcompliance/config.html

@@ -8,6 +8,7 @@
       <div class="card">
         <div class="card-header">
           <div class="float-end">
+            {% copy_content config_field %}
             <a href="?export=True" class="btn btn-sm btn-primary" role="button">
               <i class="mdi mdi-download" aria-hidden="true"></i> Download
             </a>
@@ -15,7 +16,7 @@
           <h5>{{ header }}</h5>
         </div>
         {% if config %}
-          <pre class="card-body">{{ config }}</pre>
+          <pre class="card-body" id="{{ config_field }}">{{ config }}</pre>
         {% else %}
           <div class="card-body text-muted">No configuration</div>
         {% endif %}

netbox_config_diff-2.4.0/netbox_config_diff/templates/netbox_config_diff/configcompliance/missing_extra.html

@@ -0,0 +1,14 @@
+{% extends "netbox_config_diff/configcompliance.html" %}
+
+{% block title %}{{ object }} - Missing/Extra{% endblock %}
+
+{% block content %}
+  <div class="row">
+    <div class="col col-md-6">
+      {% include 'netbox_config_diff/inc/commands_card.html' with data=object.missing header='Missing' pre_id='missing' %}
+    </div>
+    <div class="col col-md-6">
+      {% include 'netbox_config_diff/inc/commands_card.html' with data=object.extra header='Extra' pre_id='extra' %}
+    </div>
+  </div>
+{% endblock %}

netbox_config_diff-2.4.0/netbox_config_diff/templates/netbox_config_diff/configcompliance/patch.html

@@ -0,0 +1,11 @@
+{% extends "netbox_config_diff/configcompliance.html" %}
+
+{% block title %}{{ object }} - Patch commands{% endblock %}
+
+{% block content %}
+  <div class="row">
+    <div class="col col-md-6">
+      {% include 'netbox_config_diff/inc/commands_card.html' with data=object.patch header='Patch commands' pre_id='patch' %}
+    </div>
+  </div>
+{% endblock %}

netbox_config_diff-2.4.0/netbox_config_diff/templates/netbox_config_diff/inc/commands_card.html

@@ -0,0 +1,16 @@
+<div class="card">
+  <div class="card-header">
+    <div class="float-end">
+      {% copy_content pre_id %}
+      <a href="?export_{{ pre_id }}=True" class="btn btn-sm btn-primary" role="button">
+        <i class="mdi mdi-download" aria-hidden="true"></i> Download
+      </a>
+    </div>
+    <h5>{{ header }}</h5>
+  </div>
+  {% if data %}
+    <pre class="card-body" id="{{ pre_id }}">{{ data }}</pre>
+  {% else %}
+    <div class="card-body text-muted">No commands</div>
+  {% endif %}
+</div>

netbox_config_diff-2.4.0/netbox_config_diff/views/base.py

@@ -0,0 +1,52 @@
+from django.http import HttpResponse
+from django.shortcuts import render
+from django.urls import reverse
+from netbox.views.generic import ObjectDeleteView, ObjectEditView, ObjectView
+
+
+class BaseObjectDeleteView(ObjectDeleteView):
+    def get_return_url(self, request, obj=None):
+        return reverse(f"plugins:netbox_config_diff:{self.queryset.model._meta.model_name}_list")
+
+
+class BaseObjectEditView(ObjectEditView):
+    @property
+    def default_return_url(self) -> str:
+        return f"plugins:netbox_config_diff:{self.queryset.model._meta.model_name}_list"
+
+
+class BaseExportView(ObjectView):
+    def export_parts(self, name, lines, suffix):
+        response = HttpResponse(lines, content_type="text")
+        filename = f"{name}_{suffix}.txt"
+        response["Content-Disposition"] = f'attachment; filename="{filename}"'
+        return response
+
+
+class BaseConfigComplianceConfigView(BaseExportView):
+    config_field = None
+    template_header = None
+
+    def get(self, request, **kwargs):
+        instance = self.get_object(**kwargs)
+        context = self.get_extra_context(request, instance)
+
+        if request.GET.get("export"):
+            return self.export_parts(instance.device.name, context["config"], self.config_field)
+
+        return render(
+            request,
+            self.get_template_name(),
+            {
+                "object": instance,
+                "tab": self.tab,
+                **context,
+            },
+        )
+
+    def get_extra_context(self, request, instance):
+        return {
+            "header": self.template_header,
+            "config": getattr(instance, self.config_field),
+            "config_field": self.config_field,
+        }

{netbox-config-diff-2.3.0 → netbox_config_diff-2.4.0}/netbox_config_diff/views/compliance.py

@@ -1,5 +1,4 @@
 from dcim.models import Device
-from django.http import HttpResponse
 from django.shortcuts import redirect, render
 from django.utils.translation import gettext as _
 from netbox.views import generic
@@ -15,38 +14,7 @@ from netbox_config_diff.forms import (
 from netbox_config_diff.models import ConfigCompliance, PlatformSetting
 from netbox_config_diff.tables import ConfigComplianceTable, PlatformSettingTable
 
-from .base import BaseObjectDeleteView, BaseObjectEditView
-
-
-class BaseConfigComplianceConfigView(generic.ObjectView):
-    config_field = None
-    template_header = None
-
-    def get(self, request, **kwargs):
-        instance = self.get_object(**kwargs)
-        context = self.get_extra_context(request, instance)
-
-        if request.GET.get("export"):
-            response = HttpResponse(context["config"], content_type="text")
-            filename = f"{instance.device.name}_{self.config_field}.txt"
-            response["Content-Disposition"] = f'attachment; filename="{filename}"'
-            return response
-
-        return render(
-            request,
-            self.get_template_name(),
-            {
-                "object": instance,
-                "tab": self.tab,
-                **context,
-            },
-        )
-
-    def get_extra_context(self, request, instance):
-        return {
-            "header": self.template_header,
-            "config": getattr(instance, self.config_field),
-        }
+from .base import BaseConfigComplianceConfigView, BaseExportView, BaseObjectDeleteView, BaseObjectEditView
 
 
 @register_model_view(ConfigCompliance)
@@ -87,7 +55,7 @@ class ConfigComplianceActualConfigView(BaseConfigComplianceConfigView):
 
 
 @register_model_view(ConfigCompliance, "missing-extra")
-class ConfigComplianceMissingExtraConfigView(generic.ObjectView):
+class ConfigComplianceMissingExtraConfigView(BaseExportView):
     queryset = ConfigCompliance.objects.all()
     template_name = "netbox_config_diff/configcompliance/missing_extra.html"
     tab = ViewTab(
@@ -95,12 +63,6 @@ class ConfigComplianceMissingExtraConfigView(generic.ObjectView):
         weight=520,
     )
 
-    def export_parts(self, name, lines, suffix):
-        response = HttpResponse(lines, content_type="text")
-        filename = f"{name}_{suffix}.txt"
-        response["Content-Disposition"] = f'attachment; filename="{filename}"'
-        return response
-
     def get(self, request, **kwargs):
         instance = self.get_object(**kwargs)
         context = self.get_extra_context(request, instance)
@@ -122,6 +84,33 @@ class ConfigComplianceMissingExtraConfigView(generic.ObjectView):
         )
 
 
+@register_model_view(ConfigCompliance, "patch")
+class ConfigCompliancePatchView(BaseExportView):
+    queryset = ConfigCompliance.objects.all()
+    template_name = "netbox_config_diff/configcompliance/patch.html"
+    tab = ViewTab(
+        label=_("Patch"),
+        weight=515,
+    )
+
+    def get(self, request, **kwargs):
+        instance = self.get_object(**kwargs)
+        context = self.get_extra_context(request, instance)
+
+        if request.GET.get("export_patch"):
+            return self.export_parts(instance.device.name, instance.patch, "patch")
+
+        return render(
+            request,
+            self.get_template_name(),
+            {
+                "object": instance,
+                "tab": self.tab,
+                **context,
+            },
+        )
+
+
 @register_model_view(Device, "config_compliance", "config-compliance")
 class ConfigComplianceDeviceView(generic.ObjectView):
     queryset = Device.objects.all()

{netbox-config-diff-2.3.0 → netbox_config_diff-2.4.0/netbox_config_diff.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-config-diff
-Version: 2.3.0
+Version: 2.4.0
 Summary: Push rendered device configurations from NetBox to devices and apply them.
 Author: Artem Kotik
 Author-email: miaow2@yandex.ru
@@ -218,6 +218,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: hier-config==2.2.3
 Requires-Dist: netutils==1.5.0
 Requires-Dist: scrapli[asyncssh]==2023.07.30
 Requires-Dist: scrapli-cfg==2023.07.30

{netbox-config-diff-2.3.0 → netbox_config_diff-2.4.0}/netbox_config_diff.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ docs/media/screenshots/compliance-error.png
 docs/media/screenshots/compliance-list.png
 docs/media/screenshots/compliance-missing-extra.png
 docs/media/screenshots/compliance-ok.png
+docs/media/screenshots/compliance-patch.png
 docs/media/screenshots/config-temp-substitute.png
 docs/media/screenshots/cr-approve-button.png
 docs/media/screenshots/cr-approved.png
@@ -64,6 +65,7 @@ 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/0009_configcompliance_patch.py
 netbox_config_diff/migrations/__init__.py
 netbox_config_diff/models/__init__.py
 netbox_config_diff/models/base.py
@@ -80,8 +82,10 @@ netbox_config_diff/templates/netbox_config_diff/substitute.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/configcompliance/patch.html
 netbox_config_diff/templates/netbox_config_diff/configurationrequest/base.html
 netbox_config_diff/templates/netbox_config_diff/configurationrequest/diffs.html
+netbox_config_diff/templates/netbox_config_diff/inc/commands_card.html
 netbox_config_diff/templates/netbox_config_diff/inc/diff.html
 netbox_config_diff/templates/netbox_config_diff/inc/job_log.html
 netbox_config_diff/views/__init__.py

{netbox-config-diff-2.3.0 → netbox_config_diff-2.4.0}/netbox_config_diff.egg-info/requires.txt

@@ -1,3 +1,4 @@
+hier-config==2.2.3
 netutils==1.5.0
 scrapli[asyncssh]==2023.07.30
 scrapli-cfg==2023.07.30

{netbox-config-diff-2.3.0 → netbox_config_diff-2.4.0}/requirements/base.txt

@@ -1,3 +1,4 @@
+hier-config==2.2.3
 netutils==1.5.0
 scrapli[asyncssh]==2023.07.30
 scrapli-cfg==2023.07.30

{netbox-config-diff-2.3.0 → netbox_config_diff-2.4.0}/tests/test_compliance.py

@@ -155,4 +155,5 @@ def test_devicedataclass_to_db(
         "actual_config": "",
         "missing": "",
         "extra": "",
+        "patch": "",
     }

netbox-config-diff-2.3.0/netbox_config_diff/templates/netbox_config_diff/configcompliance/missing_extra.html

@@ -1,42 +0,0 @@
-{% extends "netbox_config_diff/configcompliance.html" %}
-
-{% block title %}{{ object }} - Missing/Extra{% endblock %}
-
-{% block content %}
-  <div class="row">
-    <div class="col col-md-6">
-      <div class="card">
-        <div class="card-header">
-          <div class="float-end">
-            <a href="?export_missing=True" class="btn btn-sm btn-primary" role="button">
-              <i class="mdi mdi-download" aria-hidden="true"></i> Download
-            </a>
-          </div>
-          <h5>Missing</h5>
-        </div>
-        {% if object.missing %}
-          <pre class="card-body">{{ object.missing }}</pre>
-        {% else %}
-          <div class="card-body text-muted">No lines</div>
-        {% endif %}
-      </div>
-    </div>
-    <div class="col col-md-6">
-      <div class="card">
-        <div class="card-header">
-          <div class="float-end">
-            <a href="?export_extra=True" class="btn btn-sm btn-primary" role="button">
-              <i class="mdi mdi-download" aria-hidden="true"></i> Download
-            </a>
-          </div>
-          <h5>Extra</h5>
-        </div>
-        {% if object.extra %}
-          <pre class="card-body">{{ object.extra }}</pre>
-        {% else %}
-          <div class="card-body text-muted">No lines</div>
-        {% endif %}
-      </div>
-    </div>
-  </div>
-{% endblock %}

netbox-config-diff-2.3.0/netbox_config_diff/views/base.py

@@ -1,13 +0,0 @@
-from django.urls import reverse
-from netbox.views.generic import ObjectDeleteView, ObjectEditView
-
-
-class BaseObjectDeleteView(ObjectDeleteView):
-    def get_return_url(self, request, obj=None):
-        return reverse(f"plugins:netbox_config_diff:{self.queryset.model._meta.model_name}_list")
-
-
-class BaseObjectEditView(ObjectEditView):
-    @property
-    def default_return_url(self) -> str:
-        return f"plugins:netbox_config_diff:{self.queryset.model._meta.model_name}_list"