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

ipfabric_netbox/forms.py

@@ -488,18 +488,11 @@ class IPFabricSyncForm(NetBoxModelForm):
     sites = forms.MultipleChoiceField(
         required=False,
         label=_("Sites"),
-        help_text=_("Defaults to all sites if none selected."),
         widget=APISelectMultiple(
             api_url="/api/plugins/ipfabric/snapshot/{{snapshot_data}}/sites/",
         ),
     )
 
-    update_custom_fields = forms.BooleanField(
-        required=False,
-        label=_("Custom Fields Updating"),
-        help_text=_("Update object custom fields where applicable."),
-    )
-
     scheduled = forms.DateTimeField(
         required=False,
         widget=DateTimePicker(),
@@ -526,13 +519,16 @@ class IPFabricSyncForm(NetBoxModelForm):
             "source",
             "snapshot_data",
             "auto_merge",
-            "update_custom_fields",
             "sites",
+            "type",
             "tags",
             "scheduled",
             "interval",
         )
-        widgets = {"source": HTMXSelect()}
+        widgets = {
+            "source": HTMXSelect(),
+            "type": HTMXSelect(),
+        }
 
     @property
     def fieldsets(self):
@@ -547,15 +543,14 @@ class IPFabricSyncForm(NetBoxModelForm):
             fieldsets.append(
                 FieldSet("snapshot_data", name=_("Snapshot Information")),
             )
+        fieldsets.append(FieldSet("type", name=_("Ingestion Type")))
         if self.backend_fields:
             for k, v in self.backend_fields.items():
                 fieldsets.append(FieldSet(*v, name=f"{k.upper()} Parameters"))
         fieldsets.append(
             FieldSet("scheduled", "interval", name=_("Ingestion Execution Parameters"))
         )
-        fieldsets.append(
-            FieldSet("auto_merge", "update_custom_fields", name=_("Extras"))
-        )
+        fieldsets.append(FieldSet("auto_merge", name=_("Extras")))
         fieldsets.append(FieldSet("tags", name=_("Tags")))
 
         return fieldsets
@@ -590,7 +585,12 @@ class IPFabricSyncForm(NetBoxModelForm):
                 self.initial["sites"] = self.instance.parameters.get("sites", [])
                 self.initial["groups"] = self.instance.parameters.get("groups", [])
 
-        backend = sync_parameters
+        backend_type = get_field_value(self, "type")
+        backend = {}
+        if backend_type == "all":
+            backend = sync_parameters
+        else:
+            backend[backend_type] = sync_parameters.get(backend_type)
 
         now = local_now().strftime("%Y-%m-%d %H:%M:%S")
         self.fields["scheduled"].help_text += f" (current time: <strong>{now}</strong>)"

ipfabric_netbox/models.py

@@ -44,6 +44,7 @@ from utilities.request import NetBoxFakeRequest
 from .choices import IPFabricRawDataTypeChoices
 from .choices import IPFabricSnapshotStatusModelChoices
 from .choices import IPFabricSourceTypeChoices
+from .choices import IPFabricSyncTypeChoices
 from .choices import IPFabricTransformMapSourceModelChoices
 from .choices import required_transform_map_contenttypes
 from .signals import clear_other_primary_ip
@@ -544,7 +545,9 @@ class IPFabricSource(IPFabricClient, JobsMixin, PrimaryModel):
         # post_sync.send(sender=self.__class__, instance=self)
 
 
-class IPFabricSnapshot(TagsMixin, ChangeLoggedModel):
+class IPFabricSnapshot(models.Model):
+    created = models.DateTimeField(auto_now_add=True)
+    last_updated = models.DateTimeField(editable=False)
     source = models.ForeignKey(
         to=IPFabricSource,
         on_delete=models.CASCADE,
@@ -597,6 +600,11 @@ class IPFabricSync(IPFabricClient, JobsMixin, TagsMixin, ChangeLoggedModel):
         on_delete=models.CASCADE,
         related_name="snapshots",
     )
+    type = models.CharField(
+        max_length=50,
+        choices=IPFabricSyncTypeChoices,
+        default=IPFabricSyncTypeChoices.DCIM,
+    )
     status = models.CharField(
         max_length=50,
         choices=DataSourceStatusChoices,
@@ -605,7 +613,6 @@ class IPFabricSync(IPFabricClient, JobsMixin, TagsMixin, ChangeLoggedModel):
     )
     parameters = models.JSONField(blank=True, null=True)
     auto_merge = models.BooleanField(default=False)
-    update_custom_fields = models.BooleanField(default=True)
     last_synced = models.DateTimeField(blank=True, null=True, editable=False)
     scheduled = models.DateTimeField(null=True, blank=True)
     interval = models.PositiveIntegerField(
@@ -661,10 +668,6 @@ class IPFabricSync(IPFabricClient, JobsMixin, TagsMixin, ChangeLoggedModel):
         else:
             return False
 
-    @property
-    def last_ingestion(self):
-        return self.ipfabricingestion_set.last()
-
     @staticmethod
     def get_transform_maps(group_ids=None):
         """
@@ -886,10 +889,7 @@ class IPFabricIngestion(JobsMixin, models.Model):
     def name(self):
         if self.branch:
             return self.branch.name
-        try:
-            return f"{self.sync.name} (Ingestion {self.pk})"
-        except IPFabricIngestion.sync.RelatedObjectDoesNotExist:
-            return f"Ingestion {self.pk} (No Sync)"
+        return f"{self.sync.name} (Ingestion {self.pk})"
 
     def get_absolute_url(self):
         return reverse("plugins:ipfabric_netbox:ipfabricingestion", args=[self.pk])

ipfabric_netbox/tables.py

@@ -142,41 +142,20 @@ class IPFabricSourceTable(NetBoxTable):
         default_columns = ("pk", "name", "status", "description", "snapshot_count")
 
 
-class IPFabricSyncTable(NetBoxTable):
-    name = tables.Column(linkify=True)
+class SyncTable(NetBoxTable):
+    actions = None
     status = columns.ChoiceFieldColumn()
     snapshot_name = tables.Column(
-        verbose_name="Snapshot Name",
-        accessor="snapshot_data",
-        linkify=True,
-    )
-    last_ingestion = tables.Column(
-        accessor="last_ingestion",
-        verbose_name="Last Ingestion",
-        linkify=True,
+        verbose_name="Snapshot Name", accessor="snapshot_data"
     )
 
-    def render_last_ingestion(self, value: IPFabricIngestion):
-        return getattr(value, "name", "---") if value else "---"
-
-    def render_snapshot_name(self, value: IPFabricSnapshot):
-        return getattr(value, "name", "---") if value else "---"
+    def render_snapshot_name(self, value):
+        return value.get("name", "---")
 
     class Meta(NetBoxTable.Meta):
         model = IPFabricSync
-        fields = (
-            "auto_merge",
-            "id",
-            "interval",
-            "last_synced",
-            "last_ingestion",
-            "name",
-            "scheduled",
-            "status",
-            "snapshot_name",
-            "user",
-        )
-        default_columns = ("name", "status", "last_ingestion", "snapshot_name")
+        fields = ("id", "status", "snapshot_name")
+        default_columns = ("id", "status", "snapshot_name")
 
 
 class IPFabricIngestionChangesTable(NetBoxTable):
@@ -262,5 +241,5 @@ class IPFabricDataTable(NetBoxTable):
 
     class Meta(NetBoxTable.Meta):
         model = IPFabricData
-        fields = ("snapshot_data", "JSON")
-        default_columns = ("snapshot_data", "JSON")
+        fields = ("snapshot_data", "type", "JSON")
+        default_columns = ("snapshot_data", "type", "JSON")

ipfabric_netbox/template_content.py

@@ -1,13 +1,30 @@
+import logging
+
 from netbox.plugins import PluginTemplateExtension
 
+from ipfabric_netbox.models import IPFabricSnapshot
+
+logger = logging.getLogger("ipfabric_netbox.template_content")
+
 
 class SiteTopologyButtons(PluginTemplateExtension):
     model = "dcim.site"
 
     def buttons(self):
-        return self.render(
-            "ipfabric_netbox/inc/site_topology_button.html", extra_context={}
-        )
+        try:
+            site = self.context.get("object")
+            source = None
+            for snapshot in IPFabricSnapshot.objects.all():
+                # `Site.name` is unique in DB, so we can use it to match against IPF snapshots
+                if site.name in snapshot.sites:
+                    source = snapshot.source
+            return self.render(
+                "ipfabric_netbox/inc/site_topology_button.html",
+                extra_context={"source": source},
+            )
+        except Exception as e:
+            logger.error(f"Could not render topology button: {e}.")
+            return "render error"
 
 
 template_extensions = [SiteTopologyButtons]

ipfabric_netbox/templates/ipfabric_netbox/inc/site_topology_button.html

@@ -6,19 +6,26 @@
       IP Fabric Topology
     </button>
     <ul class="dropdown-menu" aria-labelledby="btnGroupDrop1">
+      {% if source is not None %}
       <li><a href="#"
-          hx-get="{% url 'plugins:ipfabric_netbox:ipfabricsource_topology' pk=object.pk site=object.site.pk %}?snapshot=$last&source={{ object.custom_field_data.ipfabric_source }}"
+          hx-get="{% url 'plugins:ipfabric_netbox:ipfabricsource_topology' pk=source.pk site=object.pk %}?snapshot=$last&source={{ source.id }}"
           hx-target="#topology-modal-content" data-bs-toggle="modal" data-bs-target="#topology-modal"
           class="dropdown-item">
           Last Snapshot
         </a>
       </li>
       <li><a href="#"
-          hx-get="{% url 'plugins:ipfabric_netbox:ipfabricsource_topology' pk=object.pk site=object.site.pk %}?snapshot=$prev&source={{ object.custom_field_data.ipfabric_source }}"
+          hx-get="{% url 'plugins:ipfabric_netbox:ipfabricsource_topology' pk=source.pk site=object.pk %}?snapshot=$prev&source={{ source.id }}"
           hx-target="#topology-modal-content" data-bs-toggle="modal" data-bs-target="#topology-modal"
           class="dropdown-item">
           Previous Snapshot
-        </a></li>
+        </a>
+      </li>
+      {% else %}
+      <li>
+        <span class="dropdown-item text-danger">No IP Fabric Source Found for this Site</span>
+      </li>
+      {% endif %}
     </ul>
   </div>
 </div>

ipfabric_netbox/templates/ipfabric_netbox/ipfabricsync_list.html

@@ -0,0 +1,71 @@
+{% extends 'base/layout.html' %}
+{% load buttons %}
+{% load helpers %}
+{% load perms %}
+
+{% block title %}Ingestion{% endblock %}
+
+{% block tabs %}
+  <ul class="nav nav-tabs px-3">
+    <li class="nav-item" role="presentation">
+      <a class="nav-link active" role="tab">Ingestion</a>
+    </li>
+  </ul>
+{% endblock tabs %}
+
+{% block controls %}
+  <div class="controls">
+    <div class="control-group">
+      {% block extra_controls %}{% endblock %}
+      {% add_button model %}
+    </div>
+  </div>
+{% endblock controls %}
+
+{% block content %}
+  <div class="tab-content">
+    {% for sync in syncs %}
+      <div class="card">
+        <h5 class="card-header d-flex justify-content-between" id="module{{ module.pk }}">
+          <div>
+          <i class="mdi mdi-cloud-sync"></i><i class="mdi mdi-sync"></i> <a href="{% url 'plugins:ipfabric_netbox:ipfabricsync' pk=sync.pk %}">{{ sync.name}}</a>
+          </div>
+          {% if perms.ipfabric_netbox.delete_ipfabricsync %}
+              <a href="{% url 'plugins:ipfabric_netbox:ipfabricsync_delete' pk=sync.pk %}" class="btn btn-danger btn-sm">
+                <i class="mdi mdi-trash-can-outline" aria-hidden="true"></i> Delete
+              </a>
+          {% endif %}
+
+        </h5>
+        <div class="card-body">
+          {% include 'inc/sync_warning.html' with object=module %}
+          <table class="table table-hover table-headings reports">
+            <thead>
+              <tr>
+                <th width="200">Source</th>
+                <th width="400">Snapshot</th>
+                <th>Status</th>
+                <th>Last Run</th>
+              </tr>
+            </thead>
+            <tbody>
+              <tr>
+                <td><a href="{% url 'plugins:ipfabric_netbox:ipfabricsource' pk=sync.snapshot_data.source.pk %}">{{ sync.snapshot_data.source.name }}</a></td>
+                <td><a href="{% url 'plugins:ipfabric_netbox:ipfabricsnapshot' pk=sync.snapshot_data.pk %}">{{ sync.snapshot_data.name}}</a></td>
+                <td>{% badge sync.get_status_display last_job.get_status_color %}</td>
+                <td>{{sync.last_synced}}</td>
+              </tr>
+            </tbody>
+          </table>
+        </div>
+      </div>
+    {% empty %}
+      <div class="alert alert-info" role="alert">
+        <h4 class="alert-heading">Sync Jobs Settings Found</h4>
+        {% if perms.extras.add_reportmodule %}
+          Get started by <a href="{% url 'plugins:ipfabric_netbox:ipfabricsync_add' %}">creating a sync</a> from an IP Fabric source.
+        {% endif %}
+      </div>
+    {% endfor %}
+  </div>
+{% endblock content %}

ipfabric_netbox/tests/test_models.py

@@ -8,7 +8,6 @@ from django.test import TestCase
 from django.utils import timezone
 
 from ipfabric_netbox.choices import IPFabricSnapshotStatusModelChoices
-from ipfabric_netbox.models import IPFabricIngestion
 from ipfabric_netbox.models import IPFabricSnapshot
 from ipfabric_netbox.models import IPFabricSource
 from ipfabric_netbox.models import IPFabricSync
@@ -119,9 +118,9 @@ class IPFabricTransformMapModelTestCase(TestCase):
         )
         sync = IPFabricSync.objects.create(
             name="ingest",
+            type="dcim",
             status="new",
             snapshot_data=snapshot,
-            update_custom_fields=True,
             parameters={
                 "vrf": False,
                 "site": True,
@@ -139,8 +138,6 @@ class IPFabricTransformMapModelTestCase(TestCase):
             },
         )
 
-        ingestion = IPFabricIngestion.objects.create(sync=sync)
-
         runner = IPFabricSyncRunner(
             settings={
                 "site": True,
@@ -155,11 +152,7 @@ class IPFabricTransformMapModelTestCase(TestCase):
                 "snapshot_id": "12dd8c61-129c-431a-b98b-4c9211571f89",
             },
             sync=sync,
-            ingestion=ingestion,
         )
-        # Need to monkeypatch since we are not in active Branch (different schema)
-        # Using default schema "default" here since we are in "test_netbox" DB
-        runner.get_db_connection_name = lambda: "default"
 
         site_data = {
             "siteName": "MPLS",
@@ -173,9 +166,7 @@ class IPFabricTransformMapModelTestCase(TestCase):
             "networksCount": 6,
         }
 
-        self.site = runner.sync_item(
-            item=site_data, app_label="dcim", model="site", cf=sync.update_custom_fields
-        )
+        self.site = runner.get_model_or_update("dcim", "site", site_data)
 
         device_data = {
             "id": "961251111",
@@ -213,36 +204,14 @@ class IPFabricTransformMapModelTestCase(TestCase):
             "slug": None,
         }
 
-        self.mf_obj = runner.sync_item(
-            item=device_data,
-            app_label="dcim",
-            model="manufacturer",
-            cf=sync.update_custom_fields,
-        )
-        self.dt_obj = runner.sync_item(
-            item=device_data,
-            app_label="dcim",
-            model="devicetype",
-            cf=sync.update_custom_fields,
-        )
-        self.platform = runner.sync_item(
-            item=device_data,
-            app_label="dcim",
-            model="platform",
-            cf=sync.update_custom_fields,
-        )
-        self.role = runner.sync_item(
-            item=device_data,
-            app_label="dcim",
-            model="devicerole",
-            cf=sync.update_custom_fields,
-        )
-        self.device_object = runner.sync_item(
-            item=device_data,
-            app_label="dcim",
-            model="device",
-            cf=sync.update_custom_fields,
-        )
+        self.mf_obj = runner.get_model_or_update("dcim", "manufacturer", device_data)
+        self.dt_obj = runner.get_model_or_update("dcim", "devicetype", device_data)
+
+        self.platform = runner.get_model_or_update("dcim", "platform", device_data)
+
+        self.role = runner.get_model_or_update("dcim", "devicerole", device_data)
+
+        self.device_object = runner.get_model_or_update("dcim", "device", device_data)
 
     def test_transform_map(self):
         site_transform_map = IPFabricTransformMap.objects.get(name="Site Transform Map")
@@ -414,10 +383,5 @@ class IPFabricTransformMapModelTestCase(TestCase):
         )
         transform_field.template = "{{ object.hostname }} - test"
         transform_field.save()
-        device_object = runner.sync_item(
-            item=device_data,
-            app_label="dcim",
-            model="device",
-            cf=sync.update_custom_fields,
-        )
+        device_object = runner.get_model_or_update("dcim", "device", device_data)
         self.assertEqual(device_object.name, "L21PE152 - test")

ipfabric_netbox/utilities/ipfutils.py

@@ -589,35 +589,6 @@ class IPFabricSyncRunner(object):
 
         return instance
 
-    def sync_item(
-        self,
-        item,
-        app_label: str,
-        model: str,
-        cf: bool = False,
-        ingestion: "IPFabricIngestion" = None,
-    ) -> ModelTypeVar | None:
-        """Sync a single item to NetBox."""
-        synced_object = self.sync_model(
-            app_label=app_label,
-            model=model,
-            data=item,
-            sync=self.settings.get(model),
-        )
-        if synced_object is None:
-            return None
-
-        if cf:
-            synced_object.snapshot()
-            synced_object.custom_field_data[
-                "ipfabric_source"
-            ] = self.sync.snapshot_data.source.pk
-            if ingestion:
-                synced_object.custom_field_data["ipfabric_ingestion"] = ingestion.pk
-            synced_object.save()
-
-        return synced_object
-
     def sync_items(
         self,
         items,
@@ -634,7 +605,23 @@ class IPFabricSyncRunner(object):
             return
 
         for item in items:
-            self.sync_item(item, app_label, model, cf, ingestion)
+            synced_object = self.sync_model(
+                app_label=app_label,
+                model=model,
+                data=item,
+                sync=self.settings.get(model),
+            )
+            if synced_object is None:
+                continue
+
+            if cf:
+                synced_object.snapshot()
+                synced_object.custom_field_data[
+                    "ipfabric_source"
+                ] = self.sync.snapshot_data.source.pk
+                if ingestion:
+                    synced_object.custom_field_data["ipfabric_ingestion"] = ingestion.pk
+                synced_object.save()
 
     @handle_errors
     def sync_devices(
@@ -697,14 +684,11 @@ class IPFabricSyncRunner(object):
 
             if device_object and self.settings.get("device"):
                 device_object.snapshot()
-                if self.sync.update_custom_fields:
-                    device_object.custom_field_data[
-                        "ipfabric_source"
-                    ] = self.sync.snapshot_data.source.pk
-                    if ingestion:
-                        device_object.custom_field_data[
-                            "ipfabric_ingestion"
-                        ] = ingestion.pk
+                device_object.custom_field_data[
+                    "ipfabric_source"
+                ] = self.sync.snapshot_data.source.pk
+                if ingestion:
+                    device_object.custom_field_data["ipfabric_ingestion"] = ingestion.pk
                 device_object.save()
 
                 self.logger.increment_statistics(model="device")
@@ -845,11 +829,7 @@ class IPFabricSyncRunner(object):
         ) = self.collect_data()
 
         self.sync_items(
-            app_label="dcim",
-            model="site",
-            items=sites,
-            cf=self.sync.update_custom_fields,
-            ingestion=ingestion,
+            app_label="dcim", model="site", items=sites, cf=True, ingestion=ingestion
         )
         self.sync_devices(
             ingestion,

ipfabric_netbox/views.py

@@ -37,7 +37,6 @@ from .filtersets import IPFabricIngestionFilterSet
 from .filtersets import IPFabricIngestionIssueFilterSet
 from .filtersets import IPFabricSnapshotFilterSet
 from .filtersets import IPFabricSourceFilterSet
-from .filtersets import IPFabricSyncFilterSet
 from .filtersets import IPFabricTransformMapFilterSet
 from .filtersets import IPFabricTransformMapGroupFilterSet
 from .forms import IPFabricIngestionFilterForm
@@ -70,7 +69,6 @@ from .tables import IPFabricIngestionTable
 from .tables import IPFabricRelationshipFieldTable
 from .tables import IPFabricSnapshotTable
 from .tables import IPFabricSourceTable
-from .tables import IPFabricSyncTable
 from .tables import IPFabricTransformFieldTable
 from .tables import IPFabricTransformMapGroupTable
 from .tables import IPFabricTransformMapTable
@@ -530,10 +528,14 @@ class IPFabricSourceBulkDeleteView(generic.BulkDeleteView):
 
 
 # Sync
-class IPFabricSyncListView(generic.ObjectListView):
-    queryset = IPFabricSync.objects.all()
-    table = IPFabricSyncTable
-    filterset = IPFabricSyncFilterSet
+class IPFabricSyncListView(View):
+    def get(self, request):
+        syncs = IPFabricSync.objects.prefetch_related("snapshot_data")
+        return render(
+            request,
+            "ipfabric_netbox/ipfabricsync_list.html",
+            {"model": IPFabricSync, "syncs": syncs},
+        )
 
 
 @register_model_view(IPFabricSync, "edit")

{ipfabric_netbox-4.2.0b8.dist-info → ipfabric_netbox-4.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ipfabric_netbox
-Version: 4.2.0b8
+Version: 4.2.1
 Summary: NetBox plugin to sync IP Fabric data into NetBox
 License: MIT
 Keywords: netbox,ipfabric,plugin,sync
@@ -18,11 +18,11 @@ Provides-Extra: ipfabric-6-10
 Provides-Extra: ipfabric-7-0
 Provides-Extra: ipfabric-7-2
 Provides-Extra: ipfabric-7-3
-Requires-Dist: ipfabric (>=6.10.0,<6.11.0) ; extra == "ipfabric_6_10" and extra != "ipfabric_7_0" and extra != "ipfabric_7_2" and extra != "ipfabric_7_3"
-Requires-Dist: ipfabric (>=6.6.4) ; extra != "ipfabric_6_10" and extra != "ipfabric_7_0" and extra != "ipfabric_7_2" and extra != "ipfabric_7_3"
-Requires-Dist: ipfabric (>=7.0.0,<7.1.0) ; extra != "ipfabric_6_10" and extra == "ipfabric_7_0" and extra != "ipfabric_7_2" and extra != "ipfabric_7_3"
-Requires-Dist: ipfabric (>=7.2.0,<7.3.0) ; extra != "ipfabric_6_10" and extra != "ipfabric_7_0" and extra == "ipfabric_7_2" and extra != "ipfabric_7_3"
-Requires-Dist: ipfabric (>=7.3.0,<7.4.0) ; extra != "ipfabric_6_10" and extra != "ipfabric_7_0" and extra != "ipfabric_7_2" and extra == "ipfabric_7_3"
+Requires-Dist: ipfabric (>=6.10.0,<6.11.0) ; extra == "ipfabric_6_10" and extra != "ipfabric_7_0" and extra != "ipfabric_7_2"
+Requires-Dist: ipfabric (>=6.6.4) ; extra != "ipfabric_6_10" and extra != "ipfabric_7_0" and extra != "ipfabric_7_2"
+Requires-Dist: ipfabric (>=7.0.0,<7.1.0) ; extra != "ipfabric_6_10" and extra == "ipfabric_7_0" and extra != "ipfabric_7_2"
+Requires-Dist: ipfabric (>=7.2.0,<7.3.0) ; extra == "ipfabric-6-10" or extra == "ipfabric-7-0" or extra == "ipfabric-7-2" or extra == "ipfabric-7-3"
+Requires-Dist: ipfabric (>=7.3.0,<7.4.0) ; extra == "ipfabric-6-10" or extra == "ipfabric-7-0" or extra == "ipfabric-7-2" or extra == "ipfabric-7-3"
 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