ipfabric_netbox 4.2.0b9__py3-none-any.whl → 4.2.1__py3-none-any.whl

ipfabric_netbox/__init__.py

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

ipfabric_netbox/api/__init__.py

@@ -1 +1,2 @@
+from .nested_serializers import *  # noqa: F401, F403
 from .serializers import *  # noqa: F401, F403

ipfabric_netbox/api/nested_serializers.py

@@ -0,0 +1,78 @@
+from drf_spectacular.types import OpenApiTypes
+from drf_spectacular.utils import extend_schema_field
+from netbox.api.fields import ContentTypeField
+from netbox.api.serializers import NetBoxModelSerializer
+from netbox.api.serializers import WritableNestedSerializer
+from rest_framework import serializers
+
+from ipfabric_netbox.models import IPFabricSnapshot
+from ipfabric_netbox.models import IPFabricSource
+from ipfabric_netbox.models import IPFabricSync
+from ipfabric_netbox.models import IPFabricTransformMap
+
+
+__all__ = (
+    "NestedIPFabricSourceSerializer",
+    "NestedIPFabricSnapshotSerializer",
+    "NestedIPFabricTransformMapSerializer",
+    "NestedIPFabricSyncSerializer",
+)
+
+
+class NestedIPFabricSourceSerializer(WritableNestedSerializer):
+    url = serializers.URLField()
+
+    class Meta:
+        model = IPFabricSource
+        fields = ["id", "url", "display", "name", "type"]
+
+
+class NestedIPFabricSnapshotSerializer(NetBoxModelSerializer):
+    source = NestedIPFabricSourceSerializer(read_only=True)
+    display = serializers.SerializerMethodField(read_only=True)
+
+    class Meta:
+        model = IPFabricSnapshot
+        fields = [
+            "id",
+            "name",
+            "source",
+            "snapshot_id",
+            "status",
+            "date",
+            "display",
+            "sites",
+        ]
+
+    @extend_schema_field(OpenApiTypes.STR)
+    def get_display(self, obj):
+        return f"{obj.name} ({obj.snapshot_id})"
+
+
+class NestedIPFabricSyncSerializer(NetBoxModelSerializer):
+    snapshot_data = NestedIPFabricSnapshotSerializer(read_only=True)
+
+    class Meta:
+        model = IPFabricSync
+        fields = [
+            "id",
+            "name",
+            "display",
+            "snapshot_data",
+            "type",
+            "status",
+            "parameters",
+            "last_synced",
+        ]
+
+
+class NestedIPFabricTransformMapSerializer(NetBoxModelSerializer):
+    target_model = ContentTypeField(read_only=True)
+
+    class Meta:
+        model = IPFabricTransformMap
+        fields = [
+            "id",
+            "source_model",
+            "target_model",
+        ]

ipfabric_netbox/api/serializers.py

@@ -1,19 +1,19 @@
 from core.choices import DataSourceStatusChoices
-from django.contrib.contenttypes.models import ContentType
 from netbox.api.fields import ChoiceField
 from netbox.api.fields import ContentTypeField
-from netbox.api.fields import RelatedObjectCountField
-from netbox.api.serializers import NestedGroupModelSerializer
+from netbox.api.serializers import NetBoxModelSerializer
 from netbox_branching.api.serializers import BranchSerializer
 from rest_framework import serializers
 
+from .nested_serializers import NestedIPFabricSnapshotSerializer
+from .nested_serializers import NestedIPFabricSourceSerializer
+from .nested_serializers import NestedIPFabricSyncSerializer
+from .nested_serializers import NestedIPFabricTransformMapSerializer
 from ipfabric_netbox.models import IPFabricIngestion
 from ipfabric_netbox.models import IPFabricIngestionIssue
 from ipfabric_netbox.models import IPFabricRelationshipField
-from ipfabric_netbox.models import IPFabricRelationshipFieldSourceModels
 from ipfabric_netbox.models import IPFabricSnapshot
 from ipfabric_netbox.models import IPFabricSource
-from ipfabric_netbox.models import IPFabricSupportedSyncModels
 from ipfabric_netbox.models import IPFabricSync
 from ipfabric_netbox.models import IPFabricTransformField
 from ipfabric_netbox.models import IPFabricTransformMap
@@ -32,201 +32,129 @@ __all__ = (
 )
 
 
-class IPFabricTransformMapGroupSerializer(NestedGroupModelSerializer):
-    transform_maps_count = RelatedObjectCountField("transform_maps")
+class IPFabricSyncSerializer(NetBoxModelSerializer):
+    snapshot_data = NestedIPFabricSnapshotSerializer(read_only=True)
 
     class Meta:
-        model = IPFabricTransformMapGroup
-        fields = (
+        model = IPFabricSync
+        fields = [
             "id",
             "name",
-            "description",
-            "transform_maps_count",
+            "display",
+            "snapshot_data",
+            "type",
+            "status",
+            "parameters",
+            "last_synced",
             "created",
             "last_updated",
-        )
-        brief_fields = (
-            "id",
-            "name",
-            "description",
-        )
+        ]
 
 
-class IPFabricTransformMapSerializer(NestedGroupModelSerializer):
-    group = IPFabricTransformMapGroupSerializer(
-        nested=True, required=False, allow_null=True
-    )
-    target_model = ContentTypeField(
-        queryset=ContentType.objects.filter(IPFabricSupportedSyncModels)
-    )
+class IPFabricSnapshotSerializer(NetBoxModelSerializer):
+    source = NestedIPFabricSourceSerializer()
+    data = serializers.JSONField()
+    date = serializers.DateTimeField()
+    last_updated = serializers.DateTimeField()
 
     class Meta:
-        model = IPFabricTransformMap
-        fields = (
+        model = IPFabricSnapshot
+        fields = [
             "id",
             "name",
-            "group",
-            "source_model",
-            "target_model",
+            "source",
+            "snapshot_id",
+            "status",
+            "date",
+            "display",
+            "sites",
+            "data",
             "created",
             "last_updated",
-        )
-        brief_fields = (
-            "id",
-            "name",
-            "group",
-            "source_model",
-            "target_model",
-        )
+        ]
 
+        extra_kwargs = {
+            "raw_data": {"write_only": True},
+        }
 
-class IPFabricTransformFieldSerializer(NestedGroupModelSerializer):
-    transform_map = IPFabricTransformMapSerializer(nested=True)
-
-    class Meta:
-        model = IPFabricTransformField
-        fields = (
-            "id",
-            "transform_map",
-            "source_field",
-            "target_field",
-            "coalesce",
-            "template",
-        )
 
-
-class IPFabricRelationshipFieldSerializer(NestedGroupModelSerializer):
-    transform_map = IPFabricTransformMapSerializer(nested=True)
-    source_model = ContentTypeField(
-        queryset=ContentType.objects.filter(IPFabricRelationshipFieldSourceModels)
-    )
+class IPFabricRelationshipFieldSerializer(NetBoxModelSerializer):
+    transform_map = NestedIPFabricTransformMapSerializer(read_only=True)
+    source_model = ContentTypeField(read_only=True)
 
     class Meta:
         model = IPFabricRelationshipField
-        fields = (
+        fields = [
             "id",
             "transform_map",
             "source_model",
             "target_field",
             "coalesce",
             "template",
-        )
+        ]
 
 
-class IPFabricSourceSerializer(NestedGroupModelSerializer):
-    status = ChoiceField(choices=DataSourceStatusChoices, read_only=True)
-    url = serializers.URLField()
-
+class IPFabricTransformMapGroupSerializer(NetBoxModelSerializer):
     class Meta:
-        model = IPFabricSource
-        fields = (
-            "id",
-            "url",
-            "display",
+        model = IPFabricTransformMapGroup
+        fields = [
             "name",
-            "type",
-            "status",
-            "last_synced",
             "description",
-            "comments",
-            "parameters",
+            "transform_maps",
             "created",
             "last_updated",
-        )
-        brief_fields = (
-            "display",
-            "id",
-            "name",
-            "status",
-            "type",
-            "url",
-        )
+        ]
 
 
-class IPFabricSnapshotSerializer(NestedGroupModelSerializer):
-    source = IPFabricSourceSerializer(nested=True, read_only=True)
-    data = serializers.JSONField()
-    display = serializers.CharField(source="__str__", read_only=True)
+class IPFabricTransformMapSerializer(NetBoxModelSerializer):
+    target_model = ContentTypeField(read_only=True)
 
     class Meta:
-        model = IPFabricSnapshot
-        fields = (
+        model = IPFabricTransformMap
+        fields = [
             "id",
-            "display",
-            "name",
-            "source",
-            "snapshot_id",
-            "status",
-            "data",
-            "date",
+            "source_model",
+            "target_model",
             "created",
             "last_updated",
-        )
-        brief_fields = (
-            "display",
-            "id",
-            "name",
-            "source",
-            "snapshot_id",
-            "status",
-            "data",
-            "date",
-        )
+        ]
 
 
-class IPFabricSyncSerializer(NestedGroupModelSerializer):
-    snapshot_data = IPFabricSnapshotSerializer(nested=True)
+class IPFabricTransformFieldSerializer(NetBoxModelSerializer):
+    transform_map = NestedIPFabricTransformMapSerializer(read_only=True)
 
     class Meta:
-        model = IPFabricSync
-        fields = (
-            "id",
-            "name",
-            "snapshot_data",
-            "status",
-            "parameters",
-            "auto_merge",
-            "last_synced",
-            "scheduled",
-            "interval",
-            "user",
-        )
-        brief_fields = (
-            "auto_merge",
+        model = IPFabricTransformField
+        fields = [
             "id",
-            "last_synced",
-            "name",
-            "parameters",
-            "status",
-        )
+            "transform_map",
+            "source_field",
+            "target_field",
+            "coalesce",
+            "template",
+        ]
 
 
-class IPFabricIngestionSerializer(NestedGroupModelSerializer):
+class IPFabricIngestionSerializer(NetBoxModelSerializer):
     branch = BranchSerializer(read_only=True)
-    sync = IPFabricSyncSerializer(nested=True)
+    sync = NestedIPFabricSyncSerializer(read_only=True)
 
     class Meta:
         model = IPFabricIngestion
-        fields = (
-            "id",
-            "name",
-            "branch",
-            "sync",
-        )
-        brief_fields = (
+        fields = [
             "id",
             "name",
             "branch",
             "sync",
-        )
+        ]
 
 
-class IPFabricIngestionIssueSerializer(NestedGroupModelSerializer):
-    ingestion = IPFabricIngestionSerializer(nested=True)
+class IPFabricIngestionIssueSerializer(NetBoxModelSerializer):
+    ingestion = IPFabricIngestionSerializer(read_only=True)
 
     class Meta:
         model = IPFabricIngestionIssue
-        fields = (
+        fields = [
             "id",
             "ingestion",
             "timestamp",
@@ -236,11 +164,26 @@ class IPFabricIngestionIssueSerializer(NestedGroupModelSerializer):
             "coalesce_fields",
             "defaults",
             "exception",
-        )
-        brief_fields = (
-            "exception",
+        ]
+
+
+class IPFabricSourceSerializer(NetBoxModelSerializer):
+    status = ChoiceField(choices=DataSourceStatusChoices)
+    url = serializers.URLField()
+
+    class Meta:
+        model = IPFabricSource
+        fields = [
             "id",
-            "ingestion",
-            "message",
-            "model",
-        )
+            "url",
+            "display",
+            "name",
+            "type",
+            "status",
+            "last_synced",
+            "description",
+            "comments",
+            "parameters",
+            "created",
+            "last_updated",
+        ]

ipfabric_netbox/api/urls.py

@@ -3,11 +3,11 @@ from netbox.api.routers import NetBoxRouter
 
 from ipfabric_netbox.api.views import IPFabricIngestionIssueViewSet
 from ipfabric_netbox.api.views import IPFabricIngestionViewSet
-from ipfabric_netbox.api.views import IPFabricRelationshipFieldViewSet
+from ipfabric_netbox.api.views import IPFabricRelationshipFieldiewSet
 from ipfabric_netbox.api.views import IPFabricSnapshotViewSet
 from ipfabric_netbox.api.views import IPFabricSourceViewSet
 from ipfabric_netbox.api.views import IPFabricSyncViewSet
-from ipfabric_netbox.api.views import IPFabricTransformFieldViewSet
+from ipfabric_netbox.api.views import IPFabricTransformFieldiewSet
 from ipfabric_netbox.api.views import IPFabricTransformMapGroupViewSet
 from ipfabric_netbox.api.views import IPFabricTransformMapViewSet
 
@@ -20,6 +20,6 @@ router.register("transform-map", IPFabricTransformMapViewSet)
 router.register("sync", IPFabricSyncViewSet)
 router.register("ingestion", IPFabricIngestionViewSet)
 router.register("ingestion-issues", IPFabricIngestionIssueViewSet)
-router.register("transform-field", IPFabricTransformFieldViewSet)
-router.register("relationship-field", IPFabricRelationshipFieldViewSet)
+router.register("transform-field", IPFabricTransformFieldiewSet)
+router.register("relationship-field", IPFabricRelationshipFieldiewSet)
 urlpatterns = router.urls

ipfabric_netbox/api/views.py

@@ -14,7 +14,6 @@ from .serializers import IPFabricSyncSerializer
 from .serializers import IPFabricTransformFieldSerializer
 from .serializers import IPFabricTransformMapGroupSerializer
 from .serializers import IPFabricTransformMapSerializer
-from ipfabric_netbox.filtersets import IPFabricRelationshipFieldFilterSet
 from ipfabric_netbox.filtersets import IPFabricSnapshotFilterSet
 from ipfabric_netbox.filtersets import IPFabricSourceFilterSet
 from ipfabric_netbox.filtersets import IPFabricTransformFieldFilterSet
@@ -30,29 +29,29 @@ from ipfabric_netbox.models import IPFabricTransformMap
 from ipfabric_netbox.models import IPFabricTransformMapGroup
 
 
-class IPFabricTransformMapGroupViewSet(NetBoxModelViewSet):
+class IPFabricTransformMapGroupViewSet(NetBoxReadOnlyModelViewSet):
     queryset = IPFabricTransformMapGroup.objects.all()
     serializer_class = IPFabricTransformMapGroupSerializer
 
 
-class IPFabricTransformMapViewSet(NetBoxModelViewSet):
+class IPFabricTransformMapViewSet(NetBoxReadOnlyModelViewSet):
     queryset = IPFabricTransformMap.objects.all()
     serializer_class = IPFabricTransformMapSerializer
 
 
-class IPFabricTransformFieldViewSet(NetBoxModelViewSet):
+class IPFabricTransformFieldiewSet(NetBoxReadOnlyModelViewSet):
     queryset = IPFabricTransformField.objects.all()
     serializer_class = IPFabricTransformFieldSerializer
     filterset_class = IPFabricTransformFieldFilterSet
 
 
-class IPFabricRelationshipFieldViewSet(NetBoxModelViewSet):
+class IPFabricRelationshipFieldiewSet(NetBoxReadOnlyModelViewSet):
     queryset = IPFabricRelationshipField.objects.all()
     serializer_class = IPFabricRelationshipFieldSerializer
-    filterset_class = IPFabricRelationshipFieldFilterSet
+    filterset_class = IPFabricTransformFieldFilterSet
 
 
-class IPFabricSyncViewSet(NetBoxModelViewSet):
+class IPFabricSyncViewSet(NetBoxReadOnlyModelViewSet):
     queryset = IPFabricSync.objects.all()
     serializer_class = IPFabricSyncSerializer
 
@@ -67,7 +66,7 @@ class IPFabricIngestionIssueViewSet(NetBoxReadOnlyModelViewSet):
     serializer_class = IPFabricIngestionIssueSerializer
 
 
-class IPFabricSnapshotViewSet(NetBoxReadOnlyModelViewSet):
+class IPFabricSnapshotViewSet(NetBoxModelViewSet):
     queryset = IPFabricSnapshot.objects.all()
     serializer_class = IPFabricSnapshotSerializer
     filterset_class = IPFabricSnapshotFilterSet
@@ -80,21 +79,24 @@ class IPFabricSnapshotViewSet(NetBoxReadOnlyModelViewSet):
             raw_data._raw_delete(raw_data.db)
             return Response({"status": "success"})
         elif request.method == "PATCH":
-            with transaction.atomic():
-                IPFabricData.objects.bulk_create(
-                    [
-                        IPFabricData(snapshot_data=snapshot, data=item["data"])
-                        for item in request.data["data"]
-                    ],
-                    batch_size=5000,
-                )
+            transaction.set_autocommit(False)
+            IPFabricData.objects.bulk_create(
+                [
+                    IPFabricData(
+                        snapshot_data=snapshot, data=item["data"], type=item["type"]
+                    )
+                    for item in request.data["data"]
+                ],
+                batch_size=5000,
+            )
+            transaction.commit()
             return Response({"status": "success"})
 
     @action(detail=True, methods=["get"], url_path="sites")
     def sites(self, request, pk):
         q = request.GET.get("q", None)
         snapshot = IPFabricSnapshot.objects.get(pk=pk)
-        new_sites = {"count": 0, "results": []}
+        new_sites = {"results": []}
         if snapshot.data:
             sites = snapshot.data.get("sites", None)
             num = 0
@@ -110,7 +112,6 @@ class IPFabricSnapshotViewSet(NetBoxReadOnlyModelViewSet):
                             {"display": site, "name": site, "id": site}
                         )
                     num += 1
-                new_sites["count"] = num
                 return Response(new_sites)
         else:
             return Response([])

ipfabric_netbox/choices.py

@@ -198,6 +198,18 @@ class IPFabricSnapshotStatusModelChoices(ChoiceSet):
     ]
 
 
+class IPFabricSyncTypeChoices(ChoiceSet):
+    ALL = "all"
+    DCIM = "dcim"
+    IPAM = "ipam"
+
+    CHOICES = (
+        (ALL, _("All"), "gray"),
+        (DCIM, _("DCIM"), "blue"),
+        (IPAM, _("IPAM"), "blue"),
+    )
+
+
 class IPFabricSourceTypeChoices(ChoiceSet):
     LOCAL = "local"
     REMOTE = "remote"

ipfabric_netbox/filtersets.py

@@ -11,11 +11,9 @@ from netbox_branching.models import ChangeDiff
 from .models import IPFabricData
 from .models import IPFabricIngestion
 from .models import IPFabricIngestionIssue
-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 .models import IPFabricTransformMapGroup
 
@@ -74,12 +72,14 @@ class IPFabricDataFilterSet(BaseFilterSet):
 
     class Meta:
         model = IPFabricData
-        fields = ["snapshot_data"]
+        fields = ["snapshot_data", "type"]
 
     def search(self, queryset, name, value):
         if not value.strip():
             return queryset
-        return queryset.filter(Q(snapshot_data__icontains=value))
+        return queryset.filter(
+            Q(snapshot_data__icontains=value) | Q(type__icontains=value)
+        )
 
 
 class IPFabricSnapshotFilterSet(ChangeLoggedModelFilterSet):
@@ -193,66 +193,3 @@ class IPFabricTransformFieldFilterSet(BaseFilterSet):
     transform_map = django_filters.ModelMultipleChoiceFilter(
         queryset=IPFabricTransformMap.objects.all(), label=_("Transform Map")
     )
-
-    class Meta:
-        model = IPFabricTransformField
-        fields = (
-            "id",
-            "transform_map",
-            "source_field",
-            "target_field",
-            "coalesce",
-            "template",
-        )
-
-
-class IPFabricRelationshipFieldFilterSet(BaseFilterSet):
-    transform_map = django_filters.ModelMultipleChoiceFilter(
-        queryset=IPFabricTransformMap.objects.all(), label=_("Transform Map")
-    )
-
-    class Meta:
-        model = IPFabricRelationshipField
-        fields = (
-            "id",
-            "transform_map",
-            "source_model",
-            "target_field",
-            "coalesce",
-            "template",
-        )
-
-
-class IPFabricSyncFilterSet(ChangeLoggedModelFilterSet):
-    q = django_filters.CharFilter(method="search")
-    snapshot_data_id = django_filters.ModelMultipleChoiceFilter(
-        queryset=IPFabricSnapshot.objects.all(),
-        label=_("Snapshot (ID)"),
-    )
-    snapshot_data = django_filters.ModelMultipleChoiceFilter(
-        field_name="snapshot_data__name",
-        queryset=IPFabricSnapshot.objects.all(),
-        to_field_name="name",
-        label=_("Snapshot (name)"),
-    )
-
-    class Meta:
-        model = IPFabricSync
-        fields = (
-            "id",
-            "name",
-            "snapshot_data",
-            "snapshot_data_id",
-            "status",
-            "auto_merge",
-            "last_synced",
-            "scheduled",
-            "interval",
-        )
-
-    def search(self, queryset, name, value):
-        if not value.strip():
-            return queryset
-        return queryset.filter(
-            Q(name__icontains=value) | Q(snapshot_data__name__icontains=value)
-        )