ipfabric_netbox 4.0.1b0__py3-none-any.whl → 4.0.1b1__py3-none-any.whl

ipfabric_netbox/templates/ipfabric_netbox/ipfabricsync.html

@@ -3,6 +3,7 @@
 {% load helpers %}
 {% load plugins %}
 {% load render_table from django_tables2 %}
+{% load ipfabric_netbox_helpers %}
 
 {% block extra_controls %}
   {% if perms.ipfabric_netbox.start_sync %}
@@ -81,8 +82,22 @@
           {% for name, field in object.parameters.items %}
             <tr>
               <th scope="row">{{ name }}</th>
-              <td>{{ object.parameters|get_key:name|placeholder }}</td>
-            </tr>
+              <td>
+                {% if name == "groups" %}
+                {{"["}}
+                  {% for group_id in object.parameters|get_key:name %}
+                    {% with group=group_id|resolve_object:"ipfabric_netbox.IPFabricTransformMapGroup" %}
+                      <a href="{% url 'plugins:ipfabric_netbox:ipfabrictransformmapgroup' pk=group.pk %}">{{ group }}</a>{% if not forloop.last %}, {% endif %}
+                    {% endwith %}
+                  {% empty %}
+                    <span class="text-muted">No groups assigned</span>
+                  {% endfor %}
+                {{"]"}}
+                {% else %}
+                  {{ object.parameters|get_key:name|placeholder }}
+                {% endif %}
+              </td>
+              </tr>
           {% empty %}
             <tr>
               <td colspan="2" class="text-muted">

ipfabric_netbox/templates/ipfabric_netbox/ipfabrictransformmap.html

@@ -4,6 +4,18 @@
 {% load plugins %}
 {% load render_table from django_tables2 %}
 
+{% block extra_controls %}
+  <a href="#"
+  hx-get="{% url 'plugins:ipfabric_netbox:ipfabrictransformmap_clone' pk=object.pk %}"
+  hx-target="#htmx-modal-content"
+  class="btn btn-primary"
+  data-bs-toggle="modal"
+  data-bs-target="#htmx-modal" disabled
+  >
+  <span class="mdi mdi-content-copy" aria-hidden="true"></span>&nbsp;Clone
+  </a>
+{% endblock %}
+
 {% block content %}
 <div class="row mb-3">
   <div class="col col-md-6">
@@ -15,6 +27,10 @@
             <th scope="row">Name</th>
             <td>{{ object.name }}</td>
           </tr>
+          <tr>
+            <th scope="row">Group</th>
+            <td>{{ object.group | linkify | placeholder}}</td>
+          </tr>
           <tr>
             <th scope="row">Source Model</th>
             <td>ipfabric | {{ object.source_model }}</td>
@@ -23,7 +39,6 @@
             <th scope="row">Target Model</th>
             <td>{{ object.target_model }}</td>
           </tr>
-          </tr>
         </table>
       </div>
     </div>

ipfabric_netbox/templates/ipfabric_netbox/ipfabrictransformmapgroup.html

@@ -0,0 +1,35 @@
+{% extends 'generic/object.html' %}
+{% load static %}
+{% load helpers %}
+{% load plugins %}
+{% load render_table from django_tables2 %}
+
+{% block content %}
+<div class="row mb-3">
+  <div class="col col-md-6">
+    <div class="card">
+      <h5 class="card-header">Transform Map Group Information</h5>
+      <div class="card-body">
+        <table class="table table-hover attr-table">
+          <tr>
+            <th scope="row">Name</th>
+            <td>{{ object.name }}</td>
+          </tr>
+          <tr>
+            <th scope="row">Description</th>
+            <td>{{ object.description | placeholder }}</td>
+          </tr>
+          </tr>
+        </table>
+      </div>
+    </div>
+    {% plugin_left_page object %}
+  </div>
+  <div class="col col-12 col-md-6">
+    {% include 'inc/panels/related_objects.html' %}
+    {% include 'inc/panels/comments.html' %}
+    {% include 'inc/panels/custom_fields.html' %}
+    {% plugin_right_page object %}
+  </div>
+</div>
+{% endblock %}

ipfabric_netbox/templatetags/ipfabric_netbox_helpers.py

@@ -0,0 +1,17 @@
+from django import template
+from django.apps import apps
+
+register = template.Library()
+
+
+@register.filter()
+def resolve_object(pk, model_path):
+    """
+    Usage: {{ pk|resolve_object:"app_label.ModelName" }}
+    """
+    try:
+        app_label, model_name = model_path.split(".")
+        model = apps.get_model(app_label, model_name)
+        return model.objects.get(pk=pk)
+    except Exception:
+        return None

ipfabric_netbox/tests/test_models.py

@@ -139,7 +139,6 @@ class IPFabricTransformMapModelTestCase(TestCase):
         )
 
         runner = IPFabricSyncRunner(
-            transform_map=IPFabricTransformMap,
             settings={
                 "site": True,
                 "sites": [],
@@ -325,7 +324,6 @@ class IPFabricTransformMapModelTestCase(TestCase):
         sync = IPFabricSync.objects.get(name="ingest")
 
         runner = IPFabricSyncRunner(
-            transform_map=IPFabricTransformMap,
             settings={
                 "site": True,
                 "sites": [],

ipfabric_netbox/urls.py

@@ -78,6 +78,31 @@ urlpatterns = (
         "ingestion/<int:pk>/",
         include(get_model_urls("ipfabric_netbox", "ipfabricingestion")),
     ),
+    # Transform Map Group
+    path(
+        "transform-map-group/",
+        views.IPFabricTransformMapGroupListView.as_view(),
+        name="ipfabrictransformmapgroup_list",
+    ),
+    path(
+        "transform-map-group/add",
+        views.IPFabricTransformMapGroupEditView.as_view(),
+        name="ipfabrictransformmapgroup_add",
+    ),
+    path(
+        "transform-map-group/delete/",
+        views.IPFabricTransformMapGroupBulkDeleteView.as_view(),
+        name="ipfabrictransformmapgroup_bulk_delete",
+    ),
+    path(
+        "transform-map-group/<int:pk>/",
+        include(get_model_urls("ipfabric_netbox", "ipfabrictransformmapgroup")),
+    ),
+    path(
+        "transform-map-group/<int:pk>/delete/",
+        views.IPFabricTransformMapGroupDeleteView.as_view(),
+        name="ipfabrictransformmapgroup_delete",
+    ),
     # Transform Map
     path(
         "transform-map/",

ipfabric_netbox/utilities/ipfutils.py

@@ -60,7 +60,7 @@ def render_jinja2(template_code, context):
 
 
 class IPFabric(object):
-    def __init__(self, parameters=None, transform_map=None) -> None:
+    def __init__(self, parameters=None) -> None:
         if parameters:
             self.ipf = IPFClient(**parameters, unloaded=True)
         else:
@@ -70,7 +70,6 @@ class IPFabric(object):
         self.ipf._client.headers[
             "user-agent"
         ] += f'; ipfabric-netbox/{metadata.version("ipfabric-netbox")}'  # noqa: E702
-        self.transform_map = transform_map
 
     def get_snapshots(self) -> dict:
         formatted_snapshots = {}
@@ -129,8 +128,7 @@ class IPFabric(object):
 class IPFabricSyncRunner(object):
     def __init__(
         self,
-        transform_map,
-        sync=None,
+        sync,
         client: IPFabric = None,
         ingestion=None,
         settings: dict = None,
@@ -138,8 +136,8 @@ class IPFabricSyncRunner(object):
         self.client = client
         self.settings = settings
         self.ingestion = ingestion
-        self.transform_map = transform_map
         self.sync = sync
+        self.transform_maps = sync.get_transform_maps(sync.parameters.get("groups"))
         if hasattr(self.sync, "logger"):
             self.logger = self.sync.logger
 
@@ -185,9 +183,9 @@ class IPFabricSyncRunner(object):
         return connection_name
 
     def get_model_or_update(self, app, model, data):
-        transform_map = self.transform_map.objects.filter(
+        transform_map = self.transform_maps.get(
             target_model__app_label=app, target_model__model=model
-        ).first()
+        )
 
         if not transform_map:
             raise SystemError(f"No transform map available for {app}: {model}")
@@ -451,12 +449,10 @@ class IPFabricSyncRunner(object):
 
         interface_key = "nameOriginal"
         try:
-            int_transform_map = self.transform_map.objects.filter(
+            int_transform_map = self.transform_maps.get(
                 target_model__app_label="dcim", target_model__model="interface"
-            ).first()
-            int_name_field_map = int_transform_map.field_maps.filter(
-                target_field="name"
-            ).first()
+            )
+            int_name_field_map = int_transform_map.field_maps.get(target_field="name")
             interface_key = int_name_field_map.source_field
         except Exception as e:
             self.logger.log_failure(

ipfabric_netbox/utilities/transform_map.py

@@ -1,14 +1,14 @@
 import importlib.resources
 import json
 
-from django.apps import apps
+from django.apps import apps as django_apps
 
 # These functions are used in the migration file to prepare the transform maps
 # Because of this we have to use historical models
 # see https://docs.djangoproject.com/en/5.1/topics/migrations/#historical-models
 
 
-def build_fields(data):
+def build_fields(data, apps):
     ContentType = apps.get_model("contenttypes", "ContentType")
     if "target_model" in data:
         ct = ContentType.objects.get_for_model(
@@ -29,20 +29,21 @@ def build_fields(data):
     return data
 
 
-def build_transform_maps(data):
+def build_transform_maps(data, apps: django_apps = None):
+    apps = apps or django_apps
     IPFabricTransformMap = apps.get_model("ipfabric_netbox", "IPFabricTransformMap")
     IPFabricTransformField = apps.get_model("ipfabric_netbox", "IPFabricTransformField")
     IPFabricRelationshipField = apps.get_model(
         "ipfabric_netbox", "IPFabricRelationshipField"
     )
     for tm in data:
-        field_data = build_fields(tm["data"])
+        field_data = build_fields(tm["data"], apps)
         tm_obj = IPFabricTransformMap.objects.create(**field_data)
         for fm in tm["field_maps"]:
-            field_data = build_fields(fm)
+            field_data = build_fields(fm, apps)
             IPFabricTransformField.objects.create(transform_map=tm_obj, **field_data)
         for rm in tm["relationship_maps"]:
-            relationship_data = build_fields(rm)
+            relationship_data = build_fields(rm, apps)
             IPFabricRelationshipField.objects.create(
                 transform_map=tm_obj, **relationship_data
             )

ipfabric_netbox/views.py

@@ -6,6 +6,8 @@ from django.contrib.auth.mixins import LoginRequiredMixin
 from django.core.cache import cache
 from django.core.exceptions import ValidationError
 from django.db import models
+from django.db import transaction
+from django.http import HttpResponse
 from django.shortcuts import get_object_or_404
 from django.shortcuts import redirect
 from django.shortcuts import render
@@ -20,10 +22,12 @@ from netbox.views.generic.base import BaseObjectView
 from netbox_branching.models import ChangeDiff
 from utilities.data import shallow_compare_dict
 from utilities.forms import ConfirmationForm
+from utilities.forms import restrict_form_fields
 from utilities.paginator import EnhancedPaginator
 from utilities.paginator import get_paginate_count
 from utilities.query import count_related
 from utilities.views import get_viewname
+from utilities.views import GetRelatedModelsMixin
 from utilities.views import register_model_view
 from utilities.views import ViewTab
 
@@ -32,6 +36,8 @@ from .filtersets import IPFabricIngestionChangeFilterSet
 from .filtersets import IPFabricIngestionFilterSet
 from .filtersets import IPFabricSnapshotFilterSet
 from .filtersets import IPFabricSourceFilterSet
+from .filtersets import IPFabricTransformMapFilterSet
+from .filtersets import IPFabricTransformMapGroupFilterSet
 from .forms import IPFabricIngestionFilterForm
 from .forms import IPFabricIngestionMergeForm
 from .forms import IPFabricRelationshipFieldForm
@@ -41,7 +47,9 @@ from .forms import IPFabricSourceForm
 from .forms import IPFabricSyncForm
 from .forms import IPFabricTableForm
 from .forms import IPFabricTransformFieldForm
+from .forms import IPFabricTransformMapCloneForm
 from .forms import IPFabricTransformMapForm
+from .forms import IPFabricTransformMapGroupForm
 from .models import IPFabricData
 from .models import IPFabricIngestion
 from .models import IPFabricRelationshipField
@@ -50,6 +58,7 @@ from .models import IPFabricSource
 from .models import IPFabricSync
 from .models import IPFabricTransformField
 from .models import IPFabricTransformMap
+from .models import IPFabricTransformMapGroup
 from .tables import DeviceIPFTable
 from .tables import IPFabricDataTable
 from .tables import IPFabricIngestionChangesTable
@@ -58,6 +67,7 @@ from .tables import IPFabricRelationshipFieldTable
 from .tables import IPFabricSnapshotTable
 from .tables import IPFabricSourceTable
 from .tables import IPFabricTransformFieldTable
+from .tables import IPFabricTransformMapGroupTable
 from .tables import IPFabricTransformMapTable
 from .utilities.ipfutils import IPFabric
 from .utilities.transform_map import build_transform_maps
@@ -102,6 +112,44 @@ class IPFabricRelationshipFieldListView(generic.ObjectListView):
     table = IPFabricRelationshipFieldTable
 
 
+# Transform Map Group
+
+
+class IPFabricTransformMapGroupListView(generic.ObjectListView):
+    queryset = IPFabricTransformMapGroup.objects.annotate(
+        maps_count=models.Count("transform_maps")
+    )
+    table = IPFabricTransformMapGroupTable
+    filterset = IPFabricTransformMapGroupFilterSet
+
+
+@register_model_view(IPFabricTransformMapGroup, "edit")
+class IPFabricTransformMapGroupEditView(generic.ObjectEditView):
+    queryset = IPFabricTransformMapGroup.objects.all()
+    form = IPFabricTransformMapGroupForm
+    default_return_url = "plugins:ipfabric_netbox:ipfabrictransformmapgroup_list"
+
+
+class IPFabricTransformMapGroupDeleteView(generic.ObjectDeleteView):
+    queryset = IPFabricTransformMapGroup.objects.all()
+    default_return_url = "plugins:ipfabric_netbox:ipfabrictransformmapgroup_list"
+
+
+class IPFabricTransformMapGroupBulkDeleteView(generic.BulkDeleteView):
+    queryset = IPFabricTransformMapGroup.objects.all()
+    table = IPFabricTransformMapGroupTable
+
+
+@register_model_view(IPFabricTransformMapGroup)
+class IPFabricTransformMapGroupView(GetRelatedModelsMixin, generic.ObjectView):
+    queryset = IPFabricTransformMapGroup.objects.all()
+
+    def get_extra_context(self, request, instance):
+        return {
+            "related_models": self.get_related_models(request, instance, omit=[]),
+        }
+
+
 # Transform Map
 
 
@@ -109,6 +157,7 @@ class IPFabricTransformMapListView(generic.ObjectListView):
     queryset = IPFabricTransformMap.objects.all()
     table = IPFabricTransformMapTable
     template_name = "ipfabric_netbox/ipfabrictransformmap_list.html"
+    filterset = IPFabricTransformMapFilterSet
 
 
 class IPFabricTransformMapRestoreView(generic.ObjectListView):
@@ -124,11 +173,16 @@ class IPFabricTransformMapRestoreView(generic.ObjectListView):
             form_url = reverse(viewname)
             form = ConfirmationForm(initial=request.GET)
             dependent_objects = {
-                IPFabricTransformMap: IPFabricTransformMap.objects.all(),
-                IPFabricTransformField: IPFabricTransformField.objects.all(),
-                IPFabricRelationshipField: IPFabricRelationshipField.objects.all(),
+                IPFabricTransformMap: IPFabricTransformMap.objects.filter(
+                    group__isnull=True
+                ),
+                IPFabricTransformField: IPFabricTransformField.objects.filter(
+                    transform_map__group__isnull=True
+                ),
+                IPFabricRelationshipField: IPFabricRelationshipField.objects.filter(
+                    transform_map__group__isnull=True
+                ),
             }
-            print(dependent_objects)
             return render(
                 request,
                 "ipfabric_netbox/ipfabrictransformmap_restore.html",
@@ -140,7 +194,7 @@ class IPFabricTransformMapRestoreView(generic.ObjectListView):
             )
 
     def post(self, request):
-        IPFabricTransformMap.objects.all().delete()
+        IPFabricTransformMap.objects.filter(group__isnull=True).delete()
         build_transform_maps(data=get_transform_map())
         return redirect("plugins:ipfabric_netbox:ipfabrictransformmap_list")
 
@@ -152,6 +206,115 @@ class IPFabricTransformMapEditView(generic.ObjectEditView):
     default_return_url = "plugins:ipfabric_netbox:ipfabrictransformmap_list"
 
 
+@register_model_view(IPFabricTransformMap, "clone")
+class IPFabricTransformMapCloneView(BaseObjectView):
+    queryset = IPFabricTransformMap.objects.all()
+    template_name = "ipfabric_netbox/inc/clone_form.html"
+    form = IPFabricTransformMapCloneForm
+
+    def get_required_permission(self):
+        return "ipfabric_netbox.ipfabrictransformmap_add"
+
+    def get(self, request, pk):
+        obj = get_object_or_404(self.queryset, pk=pk)
+        if request.htmx:
+            viewname = get_viewname(self.queryset.model, action="clone")
+            form_url = reverse(viewname, kwargs={"pk": obj.pk})
+            initial = request.GET.copy()
+            initial["name"] = f"Clone of {obj.name}"
+            form = self.form(initial=initial)
+            restrict_form_fields(form, request.user)
+            return render(
+                request,
+                self.template_name,
+                {
+                    "object": obj,
+                    "form": form,
+                    "pk": pk,
+                    "form_url": form_url,
+                },
+            )
+        return redirect(obj.get_absolute_url())
+
+    def post(self, request, pk):
+        obj = get_object_or_404(self.queryset, pk=pk)
+        form = self.form(request.POST)
+        restrict_form_fields(form, request.user)
+        try:
+            if form.is_valid():
+                with transaction.atomic():
+                    fields = IPFabricTransformField.objects.filter(transform_map=obj)
+                    relationships = IPFabricRelationshipField.objects.filter(
+                        transform_map=obj
+                    )
+                    # Clone the transform map
+                    new_map = obj
+                    new_map.pk = None
+                    new_map.id = None
+                    new_map.name = form.cleaned_data["name"]
+                    new_map.group = form.cleaned_data["group"]
+                    new_map.full_clean()
+                    new_map.save()
+                    new_map.refresh_from_db()
+
+                    # Clone related transform fields
+                    if form.cleaned_data["clone_fields"]:
+                        for field in fields:
+                            field.pk = None
+                            field.id = None
+                            field.transform_map = new_map
+                            field.full_clean()
+                            field.save()
+
+                    # Clone related relationship fields
+                    if form.cleaned_data["clone_relationships"]:
+                        for rel in relationships:
+                            rel.pk = None
+                            rel.id = None
+                            rel.transform_map = new_map
+                            rel.full_clean()
+                            rel.save()
+
+                return_url = reverse(
+                    "plugins:ipfabric_netbox:ipfabrictransformmap", args=[obj.pk]
+                )
+                if request.htmx:
+                    response = HttpResponse()
+                    response["HX-Redirect"] = return_url
+                    return response
+                return redirect(return_url)
+        except ValidationError as err:
+            if not err.error_dict:
+                form.add_error(None, err)
+            else:
+                # This serves to show errors in the form directly
+                for field, error in err.error_dict.items():
+                    if field in form.fields:
+                        form.add_error(field, error)
+                    else:
+                        form.add_error(None, error)
+        if request.htmx:
+            response = render(
+                request,
+                "ipfabric_netbox/inc/clone_form.html",
+                {
+                    "form": form,
+                    "object": obj,
+                    "pk": pk,
+                },
+            )
+            response["X-Debug-HTMX-Partial"] = "true"
+            return response
+        return render(
+            request,
+            self.template_name,
+            {
+                "form": form,
+                "object": obj,
+            },
+        )
+
+
 class IPFabricTransformMapDeleteView(generic.ObjectDeleteView):
     queryset = IPFabricTransformMap.objects.all()
     default_return_url = "plugins:ipfabric_netbox:ipfabrictransformmap_list"
@@ -462,6 +625,26 @@ class IPFabricSyncBulkDeleteView(generic.BulkDeleteView):
     table = IPFabricSnapshotTable
 
 
+@register_model_view(IPFabricSync, "transformmaps")
+class IPFabricTransformMapTabView(generic.ObjectChildrenView):
+    queryset = IPFabricSync.objects.all()
+    child_model = IPFabricTransformMap
+    table = IPFabricTransformMapTable
+    template_name = "generic/object_children.html"
+    tab = ViewTab(
+        label="Transform Maps",
+        badge=lambda obj: obj.get_transform_maps(
+            obj.parameters.get("groups", []) if obj.parameters else []
+        ).count(),
+        permission="ipfabric_netbox.view_ipfabrictransformmap",
+    )
+
+    def get_children(self, request, parent):
+        return parent.get_transform_maps(
+            parent.parameters.get("groups", []) if parent.parameters else []
+        )
+
+
 # Ingestion
 class IPFabricIngestionListView(generic.ObjectListView):
     queryset = IPFabricIngestion.objects.annotate(
@@ -555,6 +738,7 @@ class IPFabricIngestionMergeView(BaseObjectView):
             viewname = get_viewname(self.queryset.model, action="merge")
             form_url = reverse(viewname, kwargs={"pk": obj.pk})
             form = self.form(initial=request.GET)
+            restrict_form_fields(form, request.user)
             return render(
                 request,
                 "ipfabric_netbox/inc/merge_form.html",
@@ -572,6 +756,7 @@ class IPFabricIngestionMergeView(BaseObjectView):
     def post(self, request, pk):
         ingestion = get_object_or_404(self.queryset, pk=pk)
         form = self.form(request.POST)
+        restrict_form_fields(form, request.user)
         if form.is_valid():
             job = ingestion.enqueue_merge_job(
                 user=request.user, remove_branch=form.cleaned_data["remove_branch"]
@@ -697,6 +882,7 @@ class IPFabricTable(View):
             if "table" in request.GET
             else IPFabricTableForm()
         )
+        restrict_form_fields(form, request.user)
         data = None
 
         if form.is_valid():

{ipfabric_netbox-4.0.1b0.dist-info → ipfabric_netbox-4.0.1b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ipfabric_netbox
-Version: 4.0.1b0
+Version: 4.0.1b1
 Summary: NetBox plugin to sync IP Fabric data into NetBox
 License: MIT
 Keywords: netbox,ipfabric,plugin,sync