ipfabric_netbox 3.2.4__py3-none-any.whl → 3.2.4b3__py3-none-any.whl

ipfabric_netbox/views.py

@@ -1,8 +1,10 @@
+from core.choices import ObjectChangeActionChoices
 from dcim.models import Device
 from dcim.models import Site
 from django.contrib import messages
 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.shortcuts import get_object_or_404
 from django.shortcuts import redirect
@@ -11,28 +13,27 @@ from django.urls import reverse
 from django.utils import timezone
 from django.views.generic import View
 from django_tables2 import RequestConfig
-from extras.choices import ChangeActionChoices
 from ipfabric.diagrams import Network
 from ipfabric.diagrams import NetworkSettings
-from netbox.staging import StagedChange
 from netbox.views import generic
 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.paginator import EnhancedPaginator
 from utilities.paginator import get_paginate_count
 from utilities.query import count_related
-from utilities.serialization import serialize_object
 from utilities.views import get_viewname
 from utilities.views import register_model_view
 from utilities.views import ViewTab
 
-from .filtersets import IPFabricBranchFilterSet
 from .filtersets import IPFabricDataFilterSet
+from .filtersets import IPFabricIngestionChangeFilterSet
+from .filtersets import IPFabricIngestionFilterSet
 from .filtersets import IPFabricSnapshotFilterSet
 from .filtersets import IPFabricSourceFilterSet
-from .filtersets import IPFabricStagedChangeFilterSet
-from .forms import IPFabricBranchFilterForm
+from .forms import IPFabricIngestionFilterForm
+from .forms import IPFabricIngestionMergeForm
 from .forms import IPFabricRelationshipFieldForm
 from .forms import IPFabricSnapshotFilterForm
 from .forms import IPFabricSourceFilterForm
@@ -41,23 +42,23 @@ from .forms import IPFabricSyncForm
 from .forms import IPFabricTableForm
 from .forms import IPFabricTransformFieldForm
 from .forms import IPFabricTransformMapForm
-from .models import IPFabricBranch
 from .models import IPFabricData
+from .models import IPFabricIngestion
 from .models import IPFabricRelationshipField
 from .models import IPFabricSnapshot
 from .models import IPFabricSource
 from .models import IPFabricSync
 from .models import IPFabricTransformField
 from .models import IPFabricTransformMap
-from .tables import BranchTable
 from .tables import DeviceIPFTable
 from .tables import IPFabricDataTable
+from .tables import IPFabricIngestionChangesTable
+from .tables import IPFabricIngestionTable
 from .tables import IPFabricRelationshipFieldTable
 from .tables import IPFabricSnapshotTable
 from .tables import IPFabricSourceTable
 from .tables import IPFabricTransformFieldTable
 from .tables import IPFabricTransformMapTable
-from .tables import StagedChangesTable
 from .utilities.ipfutils import IPFabric
 from .utilities.transform_map import build_transform_maps
 from .utilities.transform_map import get_transform_map
@@ -361,14 +362,12 @@ class IPFabricSourceBulkDeleteView(generic.BulkDeleteView):
 
 
 # Sync
-
-
 class IPFabricSyncListView(View):
     def get(self, request):
         syncs = IPFabricSync.objects.prefetch_related("snapshot_data")
         return render(
             request,
-            "ipfabric_netbox/sync_list.html",
+            "ipfabric_netbox/ipfabricsync_list.html",
             {"model": IPFabricSync, "syncs": syncs},
         )
 
@@ -390,19 +389,19 @@ class IPFabricSyncView(generic.ObjectView):
 
     def get(self, request, **kwargs):
         instance = self.get_object(**kwargs)
-        last_branch = instance.ipfabricbranch_set.last()
+        last_ingestion = instance.ipfabricingestion_set.last()
 
         if request.htmx:
             response = render(
                 request,
-                "ipfabric_netbox/partials/sync_last_branch.html",
-                {"last_branch": last_branch},
+                "ipfabric_netbox/partials/sync_last_ingestion.html",
+                {"last_ingestion": last_ingestion},
             )
 
             if instance.status not in ["queued", "syncing"]:
                 messages.success(
                     request,
-                    f"Ingestion ({instance.name}) {instance.status}. Branch {last_branch.name} {last_branch.job.status}.",
+                    f"Ingestion ({instance.name}) {instance.status}. Ingestion {last_ingestion.name} {last_ingestion.job.status}.",
                 )
                 response["HX-Refresh"] = "true"
             return response
@@ -418,8 +417,6 @@ class IPFabricSyncView(generic.ObjectView):
         )
 
     def get_extra_context(self, request, instance):
-        last_branch = instance.ipfabricbranch_set.last()
-
         if request.GET.get("format") in ["json", "yaml"]:
             format = request.GET.get("format")
             if request.user.is_authenticated:
@@ -429,51 +426,17 @@ class IPFabricSyncView(generic.ObjectView):
         else:
             format = "json"
 
-        last_branch = instance.ipfabricbranch_set.last()
-
-        return {"format": format, "last_branch": last_branch}
-
-
-@register_model_view(IPFabricSync, "delete")
-class IPFabricSyncDeleteView(generic.ObjectDeleteView):
-    queryset = IPFabricSync.objects.all()
-    default_return_url = "plugins:ipfabric_netbox:ipfabricsync_list"
-
-    def get(self, request, pk):
-        obj = get_object_or_404(self.queryset, pk=pk)
-
-        if request.htmx:
-            viewname = get_viewname(self.queryset.model, action="delete")
-            form_url = reverse(viewname, kwargs={"pk": obj.pk})
-            form = ConfirmationForm(initial=request.GET)
-            return render(
-                request,
-                "ipfabric_netbox/inc/sync_delete.html",
-                {
-                    "object": obj,
-                    "object_type": self.queryset.model._meta.verbose_name,
-                    "form": form,
-                    "form_url": form_url,
-                    **self.get_extra_context(request, obj),
-                },
-            )
-
-
-class IPFabricSyncBulkDeleteView(generic.BulkDeleteView):
-    queryset = IPFabricSync.objects.all()
-    filterset = IPFabricSnapshotFilterSet
-    table = IPFabricSnapshotTable
-
+        last_ingestion = instance.ipfabricingestion_set.last()
 
-# Ingestion
+        return {"format": format, "last_ingestion": last_ingestion}
 
 
 @register_model_view(IPFabricSync, "sync")
-class IPFabricIngestSyncView(BaseObjectView):
+class IPFabricStartSyncView(BaseObjectView):
     queryset = IPFabricSync.objects.all()
 
     def get_required_permission(self):
-        return "ipfabric_netbox.sync_ingest"
+        return "ipfabric_netbox.start_sync"
 
     def get(self, request, pk):
         ipfabric = get_object_or_404(self.queryset, pk=pk)
@@ -487,61 +450,84 @@ class IPFabricIngestSyncView(BaseObjectView):
         return redirect(ipfabric.get_absolute_url())
 
 
-# Branch
+@register_model_view(IPFabricSync, "delete")
+class IPFabricSyncDeleteView(generic.ObjectDeleteView):
+    queryset = IPFabricSync.objects.all()
+    default_return_url = "plugins:ipfabric_netbox:ipfabricsync_list"
+
+
+class IPFabricSyncBulkDeleteView(generic.BulkDeleteView):
+    queryset = IPFabricSync.objects.all()
+    filterset = IPFabricSnapshotFilterSet
+    table = IPFabricSnapshotTable
 
 
-class IPFabricBranchListView(generic.ObjectListView):
-    queryset = IPFabricBranch.objects.all()
-    filterset = IPFabricBranchFilterSet
-    filterset_form = IPFabricBranchFilterForm
-    table = BranchTable
+# Ingestion
+class IPFabricIngestionListView(generic.ObjectListView):
+    queryset = IPFabricIngestion.objects.annotate(
+        description=models.F("branch__description"),
+        user=models.F("sync__user__username"),
+        staged_changes=models.Count(models.F("branch__changediff")),
+    )
+    filterset = IPFabricIngestionFilterSet
+    filterset_form = IPFabricIngestionFilterForm
+    table = IPFabricIngestionTable
 
 
 @register_model_view(
-    IPFabricBranch,
+    IPFabricIngestion,
     name="logs",
     path="logs",
 )
-class IPFabricBranchLogView(LoginRequiredMixin, View):
-    template_name = "ipfabric_netbox/partials/branch_all.html"
+class IPFabricIngestionLogView(LoginRequiredMixin, View):
+    template_name = "ipfabric_netbox/partials/ingestion_all.html"
 
     def get(self, request, **kwargs):
-        branch_id = kwargs.get("pk")
+        ingestion_id = kwargs.get("pk")
         if request.htmx:
-            branch = IPFabricBranch.objects.get(pk=branch_id)
-            data = branch.get_statistics()
-            data["object"] = branch
-            data["job"] = branch.job
+            ingestion = IPFabricIngestion.objects.get(pk=ingestion_id)
+            data = ingestion.get_statistics()
+            data["object"] = ingestion
+            data["job"] = ingestion.jobs.first()
             response = render(
                 request,
                 self.template_name,
                 data,
             )
-            if branch.job.completed:
+            if ingestion.job.completed:
                 response["HX-Refresh"] = "true"
                 return response
             else:
                 return response
 
 
-@register_model_view(IPFabricBranch)
-class IPFabricBranchView(generic.ObjectView):
-    queryset = IPFabricBranch.objects.annotate(
+@register_model_view(IPFabricIngestion)
+class IPFabricIngestionView(generic.ObjectView):
+    queryset = IPFabricIngestion.objects.annotate(
         num_created=models.Count(
-            "staged_changes",
-            filter=models.Q(staged_changes__action=ChangeActionChoices.ACTION_CREATE)
-            & ~models.Q(staged_changes__object_type__model="objectchange"),
+            "branch__changediff",
+            filter=models.Q(
+                branch__changediff__action=ObjectChangeActionChoices.ACTION_CREATE
+            )
+            & ~models.Q(branch__changediff__object_type__model="objectchange"),
         ),
         num_updated=models.Count(
-            "staged_changes",
-            filter=models.Q(staged_changes__action=ChangeActionChoices.ACTION_UPDATE)
-            & ~models.Q(staged_changes__object_type__model="objectchange"),
+            "branch__changediff",
+            filter=models.Q(
+                branch__changediff__action=ObjectChangeActionChoices.ACTION_UPDATE
+            )
+            & ~models.Q(branch__changediff__object_type__model="objectchange"),
         ),
         num_deleted=models.Count(
-            "staged_changes",
-            filter=models.Q(staged_changes__action=ChangeActionChoices.ACTION_DELETE)
-            & ~models.Q(staged_changes__object_type__model="objectchange"),
+            "branch__changediff",
+            filter=models.Q(
+                branch__changediff__action=ObjectChangeActionChoices.ACTION_DELETE
+            )
+            & ~models.Q(branch__changediff__object_type__model="objectchange"),
         ),
+        description=models.F("branch__description"),
+        user=models.F("sync__user__username"),
+        staged_changes=models.Count(models.F("branch__changediff")),
     )
 
     def get_extra_context(self, request, instance):
@@ -549,13 +535,18 @@ class IPFabricBranchView(generic.ObjectView):
         return data
 
 
-@register_model_view(IPFabricBranch, "merge")
-class IPFabricBranchMergeView(BaseObjectView):
-    queryset = IPFabricBranch.objects.all()
+@register_model_view(IPFabricIngestion, "merge")
+class IPFabricIngestionMergeView(BaseObjectView):
+    queryset = IPFabricIngestion.objects.annotate(
+        description=models.F("branch__description"),
+        user=models.F("sync__user__username"),
+        staged_changes=models.Count(models.F("branch__changediff")),
+    )
     template_name = "ipfabric_netbox/inc/merge_form.html"
+    form = IPFabricIngestionMergeForm
 
     def get_required_permission(self):
-        return "ipfabric_netbox.merge_branch"
+        return "ipfabric_netbox.merge_ingestion"
 
     def get(self, request, pk):
         obj = get_object_or_404(self.queryset, pk=pk)
@@ -563,7 +554,7 @@ class IPFabricBranchMergeView(BaseObjectView):
         if request.htmx:
             viewname = get_viewname(self.queryset.model, action="merge")
             form_url = reverse(viewname, kwargs={"pk": obj.pk})
-            form = ConfirmationForm(initial=request.GET)
+            form = self.form(initial=request.GET)
             return render(
                 request,
                 "ipfabric_netbox/inc/merge_form.html",
@@ -579,103 +570,119 @@ class IPFabricBranchMergeView(BaseObjectView):
         return redirect(obj.get_absolute_url())
 
     def post(self, request, pk):
-        ipfabric = get_object_or_404(self.queryset, pk=pk)
-        job = ipfabric.enqueue_merge_job(user=request.user)
-
-        messages.success(request, f"Queued job #{job.pk} to sync {ipfabric}")
-        return redirect(ipfabric.get_absolute_url())
+        ingestion = get_object_or_404(self.queryset, pk=pk)
+        form = self.form(request.POST)
+        if form.is_valid():
+            job = ingestion.enqueue_merge_job(
+                user=request.user, remove_branch=form.cleaned_data["remove_branch"]
+            )
+            messages.success(request, f"Queued job #{job.pk} to sync {ingestion}")
+            return redirect(ingestion.get_absolute_url())
+        raise ValidationError("Form is not valid.")
 
 
 @register_model_view(
-    IPFabricBranch,
+    IPFabricIngestion,
     name="change_diff",
     path="change/<int:change_pk>",
-    kwargs={"model": IPFabricBranch},
+    kwargs={"model": IPFabricIngestion},
 )
-class IPFabricBranchChangesDiffView(LoginRequiredMixin, View):
+class IPFabricIngestionChangesDiffView(LoginRequiredMixin, View):
     template_name = "ipfabric_netbox/inc/diff.html"
 
     def get(self, request, model, **kwargs):
+        def _return_empty():
+            return render(
+                request,
+                self.template_name,
+                {
+                    "change": None,
+                    "prechange_data": None,
+                    "postchange_data": None,
+                    "diff_added": None,
+                    "diff_removed": None,
+                    "size": "lg",
+                },
+            )
+
         change_id = kwargs.get("change_pk", None)
 
-        if request.htmx:
-            if change_id:
-                change = StagedChange.objects.get(pk=change_id)
-                if hasattr(change.object, "pk"):
-                    prechange_data = serialize_object(change.object, resolve_tags=False)
-                    prechange_data = dict(sorted(prechange_data.items()))
-                else:
-                    prechange_data = None
-
-                if hasattr(change, "data"):
-                    postchange_data = dict(sorted(change.data.items()))
-
-                if prechange_data and postchange_data:
-                    diff_added = shallow_compare_dict(
-                        prechange_data or dict(),
-                        postchange_data or dict(),
-                        exclude=["last_updated"],
-                    )
-                    diff_removed = (
-                        {x: prechange_data.get(x) for x in diff_added}
-                        if prechange_data
-                        else {}
-                    )
-                else:
-                    diff_added = None
-                    diff_removed = None
+        if not request.htmx:
+            return _return_empty()
+        if not change_id:
+            return _return_empty()
+
+        change = ChangeDiff.objects.get(pk=change_id)
+        if change.original and change.modified:
+            diff_added = shallow_compare_dict(
+                change.original or dict(),
+                change.modified or dict(),
+                exclude=["last_updated"],
+            )
+            diff_removed = (
+                {x: change.original.get(x) for x in diff_added}
+                if change.modified
+                else {}
+            )
+        else:
+            diff_added = None
+            diff_removed = None
 
-                return render(
-                    request,
-                    self.template_name,
-                    {
-                        "change": change,
-                        "prechange_data": prechange_data,
-                        "postchange_data": postchange_data,
-                        "diff_added": diff_added,
-                        "diff_removed": diff_removed,
-                        "size": "lg",
-                    },
-                )
+        return render(
+            request,
+            self.template_name,
+            {
+                "change": change,
+                "prechange_data": change.original,
+                "postchange_data": change.modified,
+                "diff_added": diff_added,
+                "diff_removed": diff_removed,
+                "size": "lg",
+            },
+        )
 
 
-@register_model_view(IPFabricBranch, "change")
-class IPFabricBranchChangesView(generic.ObjectChildrenView):
-    queryset = IPFabricBranch.objects.all()
-    child_model = StagedChange
-    table = StagedChangesTable
-    filterset = IPFabricStagedChangeFilterSet
+@register_model_view(IPFabricIngestion, "change")
+class IPFabricIngestionChangesView(generic.ObjectChildrenView):
+    queryset = IPFabricIngestion.objects.all()
+    child_model = ChangeDiff
+    table = IPFabricIngestionChangesTable
+    filterset = IPFabricIngestionChangeFilterSet
     template_name = "generic/object_children.html"
     tab = ViewTab(
         label="Changes",
-        badge=lambda obj: StagedChange.objects.filter(branch=obj).count(),
-        permission="ipfabric_netbox.view_ipfabricbranch",
+        badge=lambda obj: ChangeDiff.objects.filter(branch=obj.branch).count(),
+        permission="ipfabric_netbox.view_ipfabricingestion",
     )
 
     def get_children(self, request, parent):
-        return self.child_model.objects.filter(branch=parent)
+        return self.child_model.objects.filter(branch=parent.branch)
 
 
-@register_model_view(IPFabricBranch, "delete")
-class IPFabricBranchDeleteView(generic.ObjectDeleteView):
-    queryset = IPFabricBranch.objects.all()
+@register_model_view(IPFabricIngestion, "delete")
+class IPFabricIngestionDeleteView(generic.ObjectDeleteView):
+    queryset = IPFabricIngestion.objects.all()
 
 
-@register_model_view(IPFabricSync, "branch")
-class IPFabricBranchTabView(generic.ObjectChildrenView):
+@register_model_view(IPFabricSync, "ingestion")
+class IPFabricIngestionTabView(generic.ObjectChildrenView):
     queryset = IPFabricSync.objects.all()
-    child_model = IPFabricBranch
-    table = BranchTable
-    filterset = IPFabricBranchFilterSet
+    child_model = IPFabricIngestion
+    table = IPFabricIngestionTable
+    filterset = IPFabricIngestionFilterSet
     template_name = "generic/object_children.html"
     tab = ViewTab(
-        label="Branches",
-        badge=lambda obj: IPFabricBranch.objects.filter(sync=obj).count(),
-        permission="ipfabric_netbox.view_ipfabricbranch",
+        label="Ingestions",
+        badge=lambda obj: IPFabricIngestion.objects.filter(sync=obj).count(),
+        permission="ipfabric_netbox.view_ipfabricingestion",
     )
 
     def get_children(self, request, parent):
-        return self.child_model.objects.filter(sync=parent)
+        return self.child_model.objects.filter(sync=parent).annotate(
+            description=models.F("branch__description"),
+            user=models.F("sync__user__username"),
+            staged_changes=models.Count(models.F("branch__changediff")),
+        )
 
 
 @register_model_view(Device, "ipfabric")

{ipfabric_netbox-3.2.4.dist-info → ipfabric_netbox-3.2.4b3.dist-info}/METADATA

@@ -1,15 +1,19 @@
 Metadata-Version: 2.3
 Name: ipfabric_netbox
-Version: 3.2.4
+Version: 3.2.4b3
 Summary: NetBox plugin to sync IP Fabric data into NetBox
 License: MIT
 Keywords: netbox,ipfabric,plugin,sync
 Author: Solution Architecture
 Author-email: solution.architecture@ipfabric.io
 Requires-Python: >=3.10,<4.0
-Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Provides-Extra: ipfabric-6-10
 Provides-Extra: ipfabric-6-6
 Provides-Extra: ipfabric-6-7
@@ -23,8 +27,11 @@ Requires-Dist: ipfabric (>=6.7.0,<6.8.0) ; extra != "ipfabric_6_6" and extra ==
 Requires-Dist: ipfabric (>=6.8.0,<6.9.0) ; extra != "ipfabric_6_6" and extra != "ipfabric_6_7" and extra == "ipfabric_6_8" and extra != "ipfabric_6_9" and extra != "ipfabric_6_10" and extra != "ipfabric_7_0"
 Requires-Dist: ipfabric (>=6.9.0,<6.10.0) ; extra != "ipfabric_6_6" and extra != "ipfabric_6_7" and extra != "ipfabric_6_8" and extra == "ipfabric_6_9" and extra != "ipfabric_6_10" and extra != "ipfabric_7_0"
 Requires-Dist: ipfabric (>=7.0.0,<7.1.0) ; extra != "ipfabric_6_6" and extra != "ipfabric_6_7" and extra != "ipfabric_6_8" and extra != "ipfabric_6_9" and extra != "ipfabric_6_10" and extra == "ipfabric_7_0"
+Requires-Dist: netboxlabs-netbox-branching (>=0.5.5,<0.6.0)
 Requires-Dist: netutils
 Project-URL: Bug Tracker, https://gitlab.com/ip-fabric/integrations/ipfabric-netbox-sync/-/issues
+Project-URL: Homepage, https://gitlab.com/ip-fabric/integrations/ipfabric-netbox-sync
+Project-URL: Repository, https://gitlab.com/ip-fabric/integrations/ipfabric-netbox-sync
 Description-Content-Type: text/markdown
 
 # IP Fabric Netbox Plugin
@@ -49,7 +56,7 @@ or autoboss account may cause irreversible, detrimental changes to the product a
 
 This plugin allows the integration and data synchronization between IP Fabric and NetBox.
 
-The plugin uses IP Fabric collect network data utilizing the [IP Fabric Python SDK](https://gitlab.com/ip-fabric/integrations/python-ipfabric). This plugin relies on helpful features in NetBox like [Staged Changes](https://netboxlabs.com/docs/netbox/en/stable/plugins/development/staged-changes/) and [Background Tasks](https://netboxlabs.com/docs/netbox/en/stable/plugins/development/background-tasks/) to make the job of bringing in data to NetBox easier.
+The plugin uses IP Fabric collect network data utilizing the [IP Fabric Python SDK](https://gitlab.com/ip-fabric/integrations/python-ipfabric). This plugin relies on helpful features in NetBox like [Branches](https://docs.netboxlabs.com/netbox-extensions/branching/) and [Background Tasks](https://netboxlabs.com/docs/netbox/en/stable/plugins/development/background-tasks/) to make the job of bringing in data to NetBox easier.
 
 - Multiple IP Fabric Sources
 - Transform Maps
@@ -61,7 +68,8 @@ These are the required NetBox versions for corresponding plugin version. Any oth
 
 | Netbox Version | Plugin Version |
 |----------------|----------------|
-| 4.2.4 and up   | 3.2.2 and up   |
+| 4.3.0 and up   | 4.0.0 and up   |
+| 4.2.4 - 4.2.9  | 3.2.2 - 3.2.4  |
 | 4.2.0 - 4.2.3  | 3.2.0          |
 | 4.1.5 - 4.1.11 | 3.1.1 - 3.1.3  |
 | 4.1.0 - 4.1.4  | 3.1.0          |