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

ipfabric_netbox/__init__.py

@@ -5,7 +5,7 @@ class NetboxIPFabricConfig(PluginConfig):
     name = "ipfabric_netbox"
     verbose_name = "NetBox IP Fabric SoT Plugin"
     description = "Sync IP Fabric into NetBox"
-    version = "3.2.4"
+    version = "3.2.4b2"
     base_url = "ipfabric"
     min_version = "4.2.4"
 

ipfabric_netbox/api/nested_serializers.py

@@ -4,9 +4,7 @@ from netbox.api.fields import ContentTypeField
 from netbox.api.serializers import NetBoxModelSerializer
 from netbox.api.serializers import WritableNestedSerializer
 from rest_framework import serializers
-from users.api.serializers_.nested import NestedUserSerializer
 
-from ipfabric_netbox.models import IPFabricBranch
 from ipfabric_netbox.models import IPFabricSnapshot
 from ipfabric_netbox.models import IPFabricSource
 from ipfabric_netbox.models import IPFabricSync
@@ -18,7 +16,6 @@ __all__ = (
     "NestedIPFabricSourceSerializer",
     "NestedIPFabricSnapshotSerializer",
     "NestedIPFabricTransformMapSerializer",
-    "NestedIPFabricBranchSerializer",
     "NestedIPFabricSyncSerializer",
 )
 
@@ -79,21 +76,4 @@ class NestedIPFabricTransformMapSerializer(NetBoxModelSerializer):
             "id",
             "source_model",
             "target_model",
-            "status",
-        ]
-
-
-class NestedIPFabricBranchSerializer(NetBoxModelSerializer):
-    user = NestedUserSerializer(read_only=True)
-    sync = NestedIPFabricSyncSerializer(read_only=True)
-
-    class Meta:
-        model = IPFabricBranch
-        fields = [
-            "id",
-            "name",
-            "display",
-            "sync",
-            "description",
-            "user",
         ]

ipfabric_netbox/api/serializers.py

@@ -2,14 +2,13 @@ from core.choices import DataSourceStatusChoices
 from netbox.api.fields import ChoiceField
 from netbox.api.fields import ContentTypeField
 from netbox.api.serializers import NetBoxModelSerializer
+from netbox_branching.api.serializers import BranchSerializer
 from rest_framework import serializers
-from users.api.serializers_.nested import NestedUserSerializer
 
-from .nested_serializers import NestedIPFabricBranchSerializer  # noqa: F401
 from .nested_serializers import NestedIPFabricSnapshotSerializer
 from .nested_serializers import NestedIPFabricSourceSerializer
 from .nested_serializers import NestedIPFabricTransformMapSerializer
-from ipfabric_netbox.models import IPFabricBranch
+from ipfabric_netbox.models import IPFabricIngestion
 from ipfabric_netbox.models import IPFabricRelationshipField
 from ipfabric_netbox.models import IPFabricSnapshot
 from ipfabric_netbox.models import IPFabricSource
@@ -23,7 +22,7 @@ __all__ = (
     "IPFabricRelationshipFieldSerializer",
     "IPFabricTransformFieldSerializer",
     "IPFabricTransformMapSerializer",
-    "IPFabricBranchSerializer",
+    "IPFabricIngestionSerializer",
     "IPFabricSourceSerializer",
 )
 
@@ -99,7 +98,6 @@ class IPFabricTransformMapSerializer(NetBoxModelSerializer):
             "id",
             "source_model",
             "target_model",
-            "status",
             "created",
             "last_updated",
         ]
@@ -120,21 +118,17 @@ class IPFabricTransformFieldSerializer(NetBoxModelSerializer):
         ]
 
 
-class IPFabricBranchSerializer(NetBoxModelSerializer):
-    user = NestedUserSerializer(read_only=True)
+class IPFabricIngestionSerializer(NetBoxModelSerializer):
+    branch = BranchSerializer(read_only=True)
     sync = IPFabricSyncSerializer(read_only=True)
 
     class Meta:
-        model = IPFabricBranch
+        model = IPFabricIngestion
         fields = [
             "id",
             "name",
-            "display",
+            "branch",
             "sync",
-            "description",
-            "user",
-            "created",
-            "last_updated",
         ]
 
 

ipfabric_netbox/api/urls.py

@@ -1,7 +1,7 @@
 # api/urls.py
 from netbox.api.routers import NetBoxRouter
 
-from ipfabric_netbox.api.views import IPFabricBranchViewSet
+from ipfabric_netbox.api.views import IPFabricIngestionViewSet
 from ipfabric_netbox.api.views import IPFabricRelationshipFieldiewSet
 from ipfabric_netbox.api.views import IPFabricSnapshotViewSet
 from ipfabric_netbox.api.views import IPFabricSourceViewSet
@@ -15,7 +15,7 @@ router.register("source", IPFabricSourceViewSet)
 router.register("snapshot", IPFabricSnapshotViewSet)
 router.register("transform-map", IPFabricTransformMapViewSet)
 router.register("sync", IPFabricSyncViewSet)
-router.register("branch", IPFabricBranchViewSet)
+router.register("ingestion", IPFabricIngestionViewSet)
 router.register("transform-field", IPFabricTransformFieldiewSet)
 router.register("relationship-field", IPFabricRelationshipFieldiewSet)
 urlpatterns = router.urls

ipfabric_netbox/api/views.py

@@ -5,7 +5,7 @@ from rest_framework.decorators import action
 from rest_framework.response import Response
 from utilities.query import count_related
 
-from .serializers import IPFabricBranchSerializer
+from .serializers import IPFabricIngestionSerializer
 from .serializers import IPFabricRelationshipFieldSerializer
 from .serializers import IPFabricSnapshotSerializer
 from .serializers import IPFabricSourceSerializer
@@ -15,8 +15,8 @@ from .serializers import IPFabricTransformMapSerializer
 from ipfabric_netbox.filtersets import IPFabricSnapshotFilterSet
 from ipfabric_netbox.filtersets import IPFabricSourceFilterSet
 from ipfabric_netbox.filtersets import IPFabricTransformFieldFilterSet
-from ipfabric_netbox.models import IPFabricBranch
 from ipfabric_netbox.models import IPFabricData
+from ipfabric_netbox.models import IPFabricIngestion
 from ipfabric_netbox.models import IPFabricRelationshipField
 from ipfabric_netbox.models import IPFabricSnapshot
 from ipfabric_netbox.models import IPFabricSource
@@ -47,9 +47,9 @@ class IPFabricSyncViewSet(NetBoxReadOnlyModelViewSet):
     serializer_class = IPFabricSyncSerializer
 
 
-class IPFabricBranchViewSet(NetBoxReadOnlyModelViewSet):
-    queryset = IPFabricBranch.objects.all()
-    serializer_class = IPFabricBranchSerializer
+class IPFabricIngestionViewSet(NetBoxReadOnlyModelViewSet):
+    queryset = IPFabricIngestion.objects.all()
+    serializer_class = IPFabricIngestionSerializer
 
 
 class IPFabricSnapshotViewSet(NetBoxModelViewSet):

ipfabric_netbox/data/transform_map.json

@@ -9,8 +9,7 @@
             "target_model": {
                 "app_label": "ipam",
                 "model": "ipaddress"
-            },
-            "status": "active"
+            }
         },
         "field_maps": [
             {
@@ -57,8 +56,7 @@
             "target_model": {
                 "app_label": "dcim",
                 "model": "platform"
-            },
-            "status": ""
+            }
         },
         "field_maps": [
             {
@@ -96,8 +94,7 @@
             "target_model": {
                 "app_label": "dcim",
                 "model": "site"
-            },
-            "status": "active"
+            }
         },
         "field_maps": [
             {
@@ -125,8 +122,7 @@
             "target_model": {
                 "app_label": "dcim",
                 "model": "manufacturer"
-            },
-            "status": ""
+            }
         },
         "field_maps": [
             {
@@ -139,7 +135,7 @@
                 "source_field": "vendor",
                 "target_field": "name",
                 "coalesce": false,
-                "template": null
+                "template": ""
             }
         ],
         "relationship_maps": []
@@ -154,8 +150,7 @@
             "target_model": {
                 "app_label": "dcim",
                 "model": "device"
-            },
-            "status": "active"
+            }
         },
         "field_maps": [
             {
@@ -212,7 +207,7 @@
                 },
                 "target_field": "device_type",
                 "coalesce": false,
-                "template": "{% if object.model != none %}{% set SLUG = object.model | string | slugify %}{% else %}{% set SLUG = object.vendor | slugify ~ \"-\" ~ object.family | slugify ~ \"-\" ~ object.platform %}{% endif %}{{ dcim.DeviceType.objects.get(slug=SLUG).pk }}"
+                "template": "{% if object.model %}{% set SLUG = object.model | string | slugify %}{% else %}{% set SLUG = object.vendor | slugify ~ \"-\" ~ object.family | slugify ~ \"-\" ~ object.platform | slugify %}{% endif %}{{ dcim.DeviceType.objects.get(slug=SLUG).pk }}"
             },
             {
                 "source_model": {
@@ -235,8 +230,7 @@
             "target_model": {
                 "app_label": "dcim",
                 "model": "devicerole"
-            },
-            "status": ""
+            }
         },
         "field_maps": [
             {
@@ -270,21 +264,20 @@
             "target_model": {
                 "app_label": "dcim",
                 "model": "devicetype"
-            },
-            "status": ""
+            }
         },
         "field_maps": [
             {
                 "source_field": "model",
                 "target_field": "slug",
                 "coalesce": true,
-                "template": "{% if object.model != none %}{{ object.model | string | slugify }}{% else %}{{ object.vendor | slugify }}-{{ object.family | slugify}}-{{ object.platform }}{% endif %}"
+                "template": "{% if object.model %}{{ object.model | string | slugify }}{% else %}{{ object.vendor | slugify }}-{{ object.family | slugify}}-{{ object.platform | slugify }}{% endif %}"
             },
             {
                 "source_field": "model",
                 "target_field": "model",
                 "coalesce": false,
-                "template": "{% if object.model != none %}{{ object.model | string }}{% else %}{{ object.vendor }} - {{ object.family }} - {{ object.platform }}{% endif %}"
+                "template": "{% if object.model %}{{ object.model | string }}{% else %}{{ object.vendor }} - {{ object.family }} - {{ object.platform }}{% endif %}"
             }
         ],
         "relationship_maps": [
@@ -309,8 +302,7 @@
             "target_model": {
                 "app_label": "dcim",
                 "model": "interface"
-            },
-            "status": ""
+            }
         },
         "field_maps": [
             {
@@ -353,13 +345,13 @@
                 "source_field": "speedValue",
                 "target_field": "speed",
                 "coalesce": false,
-                "template": "{% if not object.speedValue %}None{% else %}{{ object.speedValue|int // 1000 }}{% endif %}"
+                "template": "{% if not object.speedValue or object.speedValue==\"unknown\" %}None{% else %}{{ object.speedValue|int // 1000 }}{% endif %}"
             },
             {
                 "source_field": "duplex",
                 "target_field": "duplex",
                 "coalesce": false,
-                "template": null
+                "template": "{% if not object.duplex or object.duplex==\"unknown\" %}None{% else %}{{ object.duplex }}{% endif %}"
             }
         ],
         "relationship_maps": [
@@ -384,8 +376,7 @@
             "target_model": {
                 "app_label": "dcim",
                 "model": "macaddress"
-            },
-            "status": ""
+            }
         },
         "field_maps": [
         {
@@ -423,8 +414,7 @@
             "target_model": {
                 "app_label": "dcim",
                 "model": "inventoryitem"
-            },
-            "status": ""
+            }
         },
         "field_maps": [
             {
@@ -443,7 +433,7 @@
                 "source_field": "name",
                 "target_field": "name",
                 "coalesce": false,
-                "template": "{% if object.name is not none %}{{ object.name }}{% elif object.dscr is not none %}{{ object.dscr}}{% else %}Default Name{% endif %}"
+                "template": "{% if object.name is not none %}{{ object.name | string | truncate(64, True) }}{% elif object.dscr is not none %}{{ object.dscr | string | truncate(64, True) }}{% else %}Default Name{% endif %}"
             }
         ],
         "relationship_maps": [
@@ -477,8 +467,7 @@
             "target_model": {
                 "app_label": "ipam",
                 "model": "vlan"
-            },
-            "status": "active"
+            }
         },
         "field_maps": [
             {
@@ -522,8 +511,7 @@
             "target_model": {
                 "app_label": "ipam",
                 "model": "vrf"
-            },
-            "status": ""
+            }
         },
         "field_maps": [
             {
@@ -551,8 +539,7 @@
             "target_model": {
                 "app_label": "ipam",
                 "model": "prefix"
-            },
-            "status": "active"
+            }
         },
         "field_maps": [
             {
@@ -599,8 +586,7 @@
             "target_model": {
                 "app_label": "dcim",
                 "model": "virtualchassis"
-            },
-            "status": ""
+            }
         },
         "field_maps": [
             {

ipfabric_netbox/filtersets.py

@@ -1,34 +1,36 @@
 import django_filters
 from core.choices import DataSourceStatusChoices
+from core.choices import ObjectChangeActionChoices
 from django.db.models import Q
 from django.utils.translation import gettext as _
-from extras.choices import ChangeActionChoices
 from netbox.filtersets import BaseFilterSet
 from netbox.filtersets import ChangeLoggedModelFilterSet
 from netbox.filtersets import NetBoxModelFilterSet
-from netbox.staging import StagedChange
+from netbox_branching.models import ChangeDiff
 
-from .models import IPFabricBranch
 from .models import IPFabricData
+from .models import IPFabricIngestion
 from .models import IPFabricSnapshot
 from .models import IPFabricSource
 from .models import IPFabricSync
 from .models import IPFabricTransformMap
 
 
-class IPFabricStagedChangeFilterSet(BaseFilterSet):
+class IPFabricIngestionChangeFilterSet(BaseFilterSet):
     q = django_filters.CharFilter(method="search")
-    action = django_filters.MultipleChoiceFilter(choices=ChangeActionChoices)
+    action = django_filters.MultipleChoiceFilter(choices=ObjectChangeActionChoices)
 
     class Meta:
-        model = StagedChange
+        model = ChangeDiff
         fields = ["branch", "action", "object_type"]
 
     def search(self, queryset, name, value):
         if not value.strip():
             return queryset
         return queryset.filter(
-            Q(data__values__contains=value)
+            Q(current__icontains=value)
+            | Q(modified__icontains=value)
+            | Q(original__icontains=value)
             | Q(action__icontains=value)
             | Q(object_type__model__icontains=value)
         )
@@ -94,7 +96,7 @@ class IPFabricSourceFilterSet(NetBoxModelFilterSet):
         )
 
 
-class IPFabricBranchFilterSet(BaseFilterSet):
+class IPFabricIngestionFilterSet(BaseFilterSet):
     q = django_filters.CharFilter(method="search")
     sync_id = django_filters.ModelMultipleChoiceFilter(
         queryset=IPFabricSync.objects.all(),
@@ -103,19 +105,19 @@ class IPFabricBranchFilterSet(BaseFilterSet):
     sync = django_filters.ModelMultipleChoiceFilter(
         field_name="sync__name",
         queryset=IPFabricSync.objects.all(),
-        to_field_name="name",
+        to_field_name="branch__name",
         label=_("Sync (name)"),
     )
 
     class Meta:
-        model = IPFabricBranch
-        fields = ("id", "name", "sync")
+        model = IPFabricIngestion
+        fields = ("id", "branch", "sync")
 
-    def search(self, queryset, name, value):
+    def search(self, queryset, branch, value):
         if not value.strip():
             return queryset
         return queryset.filter(
-            Q(name__icontains=value) | Q(sync__name__icontains=value)
+            Q(branch__name__icontains=value) | Q(sync__name__icontains=value)
         )
 
 

ipfabric_netbox/forms.py

@@ -3,7 +3,6 @@ import copy
 from core.choices import DataSourceStatusChoices
 from core.choices import JobIntervalChoices
 from django import forms
-from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ValidationError
 from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
@@ -12,6 +11,7 @@ from netbox.forms import NetBoxModelForm
 from netbox.forms.mixins import SavedFiltersMixin
 from utilities.datetime import local_now
 from utilities.forms import add_blank_choice
+from utilities.forms import ConfirmationForm
 from utilities.forms import FilterForm
 from utilities.forms import get_field_value
 from utilities.forms.fields import CommentField
@@ -25,7 +25,7 @@ from utilities.forms.widgets import NumberWithOptions
 
 from .choices import IPFabricSnapshotStatusModelChoices
 from .choices import transform_field_source_columns
-from .models import IPFabricBranch
+from .models import IPFabricIngestion
 from .models import IPFabricRelationshipField
 from .models import IPFabricSnapshot
 from .models import IPFabricSource
@@ -275,50 +275,13 @@ class IPFabricTransformFieldForm(NetBoxModelForm):
 
 
 class IPFabricTransformMapForm(forms.ModelForm):
-    status = forms.CharField(
-        required=False,
-        label=_("Status"),
-        widget=forms.Select(),
-    )
-
     class Meta:
         model = IPFabricTransformMap
-        fields = ("name", "source_model", "target_model", "status")
+        fields = ("name", "source_model", "target_model")
         widgets = {
             "target_model": HTMXSelect(hx_url="/plugins/ipfabric/transform-map/add"),
         }
 
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        if not self.data:
-            if kwargs["initial"].get("target_model"):
-                target_model = ContentType.objects.get(
-                    pk=kwargs["initial"].get("target_model")
-                )
-                try:
-                    status = target_model.model_class()._meta.get_field("status")
-                    self.fields["status"].widget.choices = add_blank_choice(
-                        status.choices
-                    )
-                    self.fields["status"].widget.initial = get_field_value(
-                        self, "status"
-                    )
-                except Exception as e:  # noqa: F841
-                    self.fields["status"].widget.attrs["disabled"] = "disabled"
-            else:
-                if self.instance and self.instance.pk is not None:
-                    transform_map = self.instance.target_model.model_class()
-                    try:
-                        status = transform_map._meta.get_field("status")
-                        self.fields["status"].widget.choices = add_blank_choice(
-                            status.choices
-                        )
-                        self.fields["status"].widget.initial = get_field_value(
-                            self, "status"
-                        )
-                    except Exception as e:  # noqa: F841
-                        self.fields["status"].widget.attrs["disabled"] = "disabled"
-
 
 class IPFabricSnapshotFilterForm(NetBoxModelFilterSetForm):
     model = IPFabricSnapshot
@@ -343,17 +306,26 @@ class IPFabricSourceFilterForm(NetBoxModelFilterSetForm):
     status = forms.MultipleChoiceField(choices=DataSourceStatusChoices, required=False)
 
 
-class IPFabricBranchFilterForm(SavedFiltersMixin, FilterForm):
+class IPFabricIngestionFilterForm(SavedFiltersMixin, FilterForm):
     fieldsets = (
         FieldSet("q", "filter_id"),
         FieldSet("sync_id", name=_("Source")),
     )
-    model = IPFabricBranch
+    model = IPFabricIngestion
     sync_id = DynamicModelMultipleChoiceField(
         queryset=IPFabricSync.objects.all(), required=False, label=_("Sync")
     )
 
 
+class IPFabricIngestionMergeForm(ConfirmationForm):
+    remove_branch = forms.BooleanField(
+        initial=True,
+        required=False,
+        label=_("Remove branch"),
+        help_text=_("Leave unchecked to keep Branch for possible revert."),
+    )
+
+
 class IPFabricSourceForm(NetBoxModelForm):
     comments = CommentField()
 

ipfabric_netbox/jobs.py

@@ -10,7 +10,7 @@ from rq.timeouts import JobTimeoutException
 from utilities.datetime import local_now
 from utilities.request import NetBoxFakeRequest
 
-from .models import IPFabricBranch
+from .models import IPFabricIngestion
 from .models import IPFabricSource
 from .models import IPFabricSync
 
@@ -64,16 +64,16 @@ def sync_ipfabric(job, *args, **kwargs):
             )
 
 
-def merge_ipfabric_branch(job, *args, **kwargs):
-    branch = IPFabricBranch.objects.get(pk=job.object_id)
+def merge_ipfabric_ingestion(job, remove_branch=False, *args, **kwargs):
+    ingestion = IPFabricIngestion.objects.get(pk=job.object_id)
     try:
         request = NetBoxFakeRequest(
             {
                 "META": {},
-                "POST": branch.sync.parameters,
+                "POST": ingestion.sync.parameters,
                 "GET": {},
                 "FILES": {},
-                "user": branch.user,
+                "user": ingestion.sync.user,
                 "path": "",
                 "id": job.job_id,
             }
@@ -81,12 +81,17 @@ def merge_ipfabric_branch(job, *args, **kwargs):
 
         job.start()
         with event_tracking(request):
-            branch.sync_merge()
+            ingestion.sync_merge()
+        if remove_branch:
+            branching_branch = ingestion.branch
+            ingestion.branch = None
+            ingestion.save()
+            branching_branch.delete()
         job.terminate()
     except Exception as e:
         print(e)
         job.terminate(status=JobStatusChoices.STATUS_ERRORED)
-        IPFabricSync.objects.filter(pk=branch.sync.pk).update(
+        IPFabricSync.objects.filter(pk=ingestion.sync.pk).update(
             status=DataSourceStatusChoices.FAILED
         )
         if type(e) in (SyncError, JobTimeoutException):

ipfabric_netbox/migrations/0001_initial.py

@@ -62,7 +62,7 @@ class Migration(migrations.Migration):
                 ),
                 ("name", models.CharField(max_length=100, unique=True)),
                 ("source_model", models.CharField(max_length=50)),
-                ("status", models.CharField(max_length=50)),
+                ("status", models.CharField(max_length=50, null=True)),
                 (
                     "tags",
                     taggit.managers.TaggableManager(