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

ipfabric_netbox/forms.py

@@ -46,6 +46,22 @@ exclude_fields = [
     "status",
 ]
 
+
+class IPFSiteChoiceField(forms.MultipleChoiceField):
+    def valid_value(self, value):
+        """Check to see if the provided value is a valid choice."""
+        text_value = str(value)
+        for k, v in self.choices:
+            if isinstance(v, (list, tuple)):
+                for k2, v2 in v:
+                    if value == k2 or text_value == str(k2):
+                        return True
+            else:
+                if value == k or text_value == str(k):
+                    return True
+        return False
+
+
 dcim_parameters = {
     "site": forms.BooleanField(required=False, label=_("Sites"), initial=True),
     "manufacturer": forms.BooleanField(
@@ -62,45 +78,43 @@ dcim_parameters = {
     "virtualchassis": forms.BooleanField(
         required=False, label=_("Virtual Chassis"), initial=True
     ),
-    "interface": forms.BooleanField(
-        required=False, label=_("Interfaces"), initial=False
-    ),
-    "macaddress": forms.BooleanField(
-        required=False, label=_("MAC Addresses"), initial=False
-    ),
-    "inventoryitem": forms.BooleanField(
-        required=False, label=_("Part Numbers"), initial=False
-    ),
+    "interface": forms.BooleanField(required=False, label=_("Interfaces")),
+    "macaddress": forms.BooleanField(required=False, label=_("MAC Addresses")),
+    "inventoryitem": forms.BooleanField(required=False, label=_("Part Numbers")),
 }
 ipam_parameters = {
-    "vlan": forms.BooleanField(required=False, label=_("VLANs"), initial=False),
-    "vrf": forms.BooleanField(required=False, label=_("VRFs"), initial=False),
-    "prefix": forms.BooleanField(required=False, label=_("Prefixes"), initial=False),
-    "ipaddress": forms.BooleanField(
-        required=False, label=_("IP Addresses"), initial=False
-    ),
+    "vlan": forms.BooleanField(required=False, label=_("VLANs")),
+    "vrf": forms.BooleanField(required=False, label=_("VRFs")),
+    "prefix": forms.BooleanField(required=False, label=_("Prefixes")),
+    "ipaddress": forms.BooleanField(required=False, label=_("IP Addresses")),
 }
 sync_parameters = {"dcim": dcim_parameters, "ipam": ipam_parameters}
 
 
-def source_column_choices(model: str) -> list[tuple[str, str]]:
+def source_column_choices(model):
     columns = transform_field_source_columns.get(model, None)
     if columns:
         choices = [(f, f) for f in transform_field_source_columns.get(model)]
     else:
-        # This should never happen, but better be safe than sorry
-        choices = []  # pragma: no cover
+        choices = []
     return choices
 
 
-def str_to_list(_str: str | list) -> list[str]:
-    if not isinstance(_str, list):
-        return [_str]
+def add_all_sites(choices):
+    """
+    Add a blank choice to the beginning of a choices list.
+    """
+    return ((None, "All Sites"),) + tuple(choices)
+
+
+def str_to_list(str):
+    if not isinstance(str, list):
+        return [str]
     else:
-        return _str
+        return str
 
 
-def list_to_choices(choices: list[str]) -> tuple[tuple[str, str], ...]:
+def list_to_choices(choices):
     new_choices = ()
     for choice in choices:
         new_choices = new_choices + ((choice, choice),)
@@ -162,7 +176,7 @@ class IPFabricRelationshipFieldForm(NetBoxModelForm):
                 )
                 self.fields["target_field"].widget.initial = self.instance.target_field
             else:
-                if kwargs.get("initial", {}).get("transform_map", None):
+                if kwargs["initial"].get("transform_map", None):
                     transform_map_id = kwargs["initial"]["transform_map"]
                     transform_map = IPFabricTransformMap.objects.get(
                         pk=transform_map_id
@@ -244,7 +258,7 @@ class IPFabricTransformFieldForm(NetBoxModelForm):
                     source_column_choices(source_fields)
                 )
             else:
-                if kwargs.get("initial", {}).get("transform_map", None):
+                if kwargs["initial"].get("transform_map", None):
                     transform_map_id = kwargs["initial"]["transform_map"]
                     transform_map = IPFabricTransformMap.objects.get(
                         pk=transform_map_id
@@ -361,22 +375,22 @@ class IPFabricSourceForm(NetBoxModelForm):
             "type": HTMXSelect(),
         }
 
+    @property
+    def fieldsets(self):
+        fieldsets = [
+            FieldSet("name", "type", "url", name=_("Source")),
+            FieldSet("timeout", name=_("Parameters")),
+        ]
+
+        if self.source_type == "local":
+            fieldsets[1] = FieldSet("auth", "verify", "timeout", name=_("Parameters"))
+
+        return fieldsets
+
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.source_type = get_field_value(self, "type")
 
-        # Set fieldsets dynamically based on source_type
-        if self.source_type == "local":
-            self.fieldsets = [
-                FieldSet("name", "type", "url", name=_("Source")),
-                FieldSet("auth", "verify", "timeout", name=_("Parameters")),
-            ]
-        else:
-            self.fieldsets = [
-                FieldSet("name", "type", "url", name=_("Source")),
-                FieldSet("timeout", name=_("Parameters")),
-            ]
-
         self.fields["timeout"] = forms.IntegerField(
             required=False,
             label=_("Timeout"),
@@ -437,9 +451,6 @@ class OrderedModelMultipleChoiceField(forms.ModelMultipleChoiceField):
 
     def clean(self, value):
         qs = super().clean(value)
-        # Handle None or empty values
-        if not value:
-            return qs
         clauses = " ".join(
             ["WHEN id=%s THEN %s" % (pk, i) for i, pk in enumerate(value)]
         )
@@ -477,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(),
@@ -515,13 +519,41 @@ 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):
+        fieldsets = [
+            FieldSet("name", "source", "groups", name=_("IP Fabric Source")),
+        ]
+        if self.source_type == "local":
+            fieldsets.append(
+                FieldSet("snapshot_data", "sites", name=_("Snapshot Information")),
+            )
+        else:
+            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", name=_("Extras")))
+        fieldsets.append(FieldSet("tags", name=_("Tags")))
+
+        return fieldsets
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -553,13 +585,20 @@ class IPFabricSyncForm(NetBoxModelForm):
                 self.initial["sites"] = self.instance.parameters.get("sites", [])
                 self.initial["groups"] = self.instance.parameters.get("groups", [])
 
+        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>)"
 
         # Add backend-specific form fields
         self.backend_fields = {}
 
-        for k, v in sync_parameters.items():
+        for k, v in backend.items():
             self.backend_fields[k] = []
             for name, form_field in v.items():
                 field_name = f"ipf_{name}"
@@ -568,52 +607,17 @@ class IPFabricSyncForm(NetBoxModelForm):
                 if self.instance and self.instance.parameters:
                     self.fields[field_name].initial = self.instance.parameters.get(name)
 
-        # Set fieldsets dynamically based and backend_fields
-        fieldsets = [
-            FieldSet("name", "source", "groups", name=_("IP Fabric Source")),
-        ]
-        if self.source_type == "local":
-            fieldsets.append(
-                FieldSet("snapshot_data", "sites", name=_("Snapshot Information")),
-            )
-        else:
-            fieldsets.append(
-                FieldSet("snapshot_data", name=_("Snapshot Information")),
-            )
-        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("tags", name=_("Tags")))
-
-        self.fieldsets = fieldsets
-
     def clean(self):
         super().clean()
+        snapshot = self.cleaned_data["snapshot_data"]
 
         sites = self.data.get("sites")
-        self.fields["sites"].choices = list_to_choices(str_to_list(sites))
-        if sites and "snapshot_data" in self.cleaned_data:
-            snapshot = self.cleaned_data["snapshot_data"]
-            # Check if all sites are valid - fail if any site is not found in snapshot.sites
-            if not all(
-                any(site in snapshot_site for snapshot_site in snapshot.sites)
-                for site in sites
-            ):
-                invalid_sites = [
-                    site
-                    for site in sites
-                    if not any(
-                        site in snapshot_site for snapshot_site in snapshot.sites
-                    )
-                ]
-                raise ValidationError(
-                    {"sites": f"Sites {invalid_sites} not part of the snapshot."}
-                )
+        choices = list_to_choices(str_to_list(sites))
+        self.fields["sites"].choices = choices
+
+        if sites:
+            if not any(y in x for x in snapshot.sites for y in sites):
+                raise ValidationError({"sites": f"{sites} not part of the snapshot."})
 
         scheduled_time = self.cleaned_data.get("scheduled")
         if scheduled_time and scheduled_time < local_now():
@@ -661,6 +665,50 @@ class IPFabricSyncForm(NetBoxModelForm):
         return object
 
 
+# class SyncForm(forms.Form):
+#     def __init__(self, *args, **kwargs):
+#         self.snapshots = kwargs.pop("snapshot_choices", None)
+#         self.sites = kwargs.pop("site_choices", None)
+#         super(SyncForm, self).__init__(*args, **kwargs)
+#         if self.snapshots:
+#             snapshot_choices = [
+#                 (snapshot_id, snapshot_name)
+#                 for snapshot_name, snapshot_id in self.snapshots.values()
+#             ]
+#             self.fields["snapshot"] = forms.ChoiceField(
+#                 label="Snapshot",
+#                 required=True,
+#                 choices=snapshot_choices,
+#                 help_text="IPFabric snapshot to sync from. Defaults to $last",
+#                 widget=forms.Select(
+#                     attrs={
+#                         "hx-get": reverse("plugins:ipfabric_netbox:ipfabricsync_add"),
+#                         "hx-trigger": "change",
+#                         "hx-target": "#modules",
+#                         "class": "form-control",
+#                     }
+#                 ),
+#             )
+#         if self.sites:
+#             site_choices = [(site, site) for site in self.sites]
+#             self.fields["site"] = forms.ChoiceField(
+#                 label="Site",
+#                 required=False,
+#                 choices=add_blank_choice(site_choices),
+#                 help_text="Sites available within snapshot",
+#                 widget=forms.Select(attrs={"class": "form-control"}),
+#             )
+#         else:
+#             self.fields["site"] = forms.ChoiceField(
+#                 label="Site",
+#                 required=False,
+#                 choices=add_blank_choice([]),
+#                 help_text="Sites available within snapshot",
+#                 widget=forms.Select(
+#                     attrs={"class": "form-control", "disabled": "disabled"}
+#                 ),
+#             )
+
 tableChoices = [
     ("eol_details", "Inventory - EOL_DETAILS"),
     ("fans", "Inventory - FANS"),

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 %}