ipfabric_netbox 4.2.2__py3-none-any.whl → 4.2.2b1__py3-none-any.whl

ipfabric_netbox/forms.py

@@ -46,22 +46,6 @@ 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(
@@ -78,43 +62,45 @@ dcim_parameters = {
     "virtualchassis": forms.BooleanField(
         required=False, label=_("Virtual Chassis"), initial=True
     ),
-    "interface": forms.BooleanField(required=False, label=_("Interfaces")),
-    "macaddress": forms.BooleanField(required=False, label=_("MAC Addresses")),
-    "inventoryitem": forms.BooleanField(required=False, label=_("Part Numbers")),
+    "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
+    ),
 }
 ipam_parameters = {
-    "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")),
+    "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
+    ),
 }
 sync_parameters = {"dcim": dcim_parameters, "ipam": ipam_parameters}
 
 
-def source_column_choices(model):
+def source_column_choices(model: str) -> list[tuple[str, str]]:
     columns = transform_field_source_columns.get(model, None)
     if columns:
         choices = [(f, f) for f in transform_field_source_columns.get(model)]
     else:
-        choices = []
+        # This should never happen, but better be safe than sorry
+        choices = []  # pragma: no cover
     return choices
 
 
-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]
+def str_to_list(_str: str | list) -> list[str]:
+    if not isinstance(_str, list):
+        return [_str]
     else:
-        return str
+        return _str
 
 
-def list_to_choices(choices):
+def list_to_choices(choices: list[str]) -> tuple[tuple[str, str], ...]:
     new_choices = ()
     for choice in choices:
         new_choices = new_choices + ((choice, choice),)
@@ -176,7 +162,7 @@ class IPFabricRelationshipFieldForm(NetBoxModelForm):
                 )
                 self.fields["target_field"].widget.initial = self.instance.target_field
             else:
-                if kwargs["initial"].get("transform_map", None):
+                if kwargs.get("initial", {}).get("transform_map", None):
                     transform_map_id = kwargs["initial"]["transform_map"]
                     transform_map = IPFabricTransformMap.objects.get(
                         pk=transform_map_id
@@ -258,7 +244,7 @@ class IPFabricTransformFieldForm(NetBoxModelForm):
                     source_column_choices(source_fields)
                 )
             else:
-                if kwargs["initial"].get("transform_map", None):
+                if kwargs.get("initial", {}).get("transform_map", None):
                     transform_map_id = kwargs["initial"]["transform_map"]
                     transform_map = IPFabricTransformMap.objects.get(
                         pk=transform_map_id
@@ -375,22 +361,29 @@ 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
+        self.fieldsets: list[FieldSet] = []
+        self.fieldsets.append(FieldSet("name", "type", "url", name=_("Source")))
+        if self.source_type == "local":
+            self.fieldsets.append(
+                FieldSet("auth", "verify", "timeout", name=_("Parameters"))
+            )
+        else:
+            self.fieldsets.append(FieldSet("timeout", name=_("Parameters")))
+
+        self.fields["url"] = forms.URLField(
+            required=True,
+            label=_("Base URL"),
+            widget=forms.TextInput(attrs={"class": "form-control"}),
+            help_text=_(
+                "for example https://myinstance.com or https://192.168.0.1 etc."
+            ),
+        )
+
         self.fields["timeout"] = forms.IntegerField(
             required=False,
             label=_("Timeout"),
@@ -451,6 +444,9 @@ 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)]
         )
@@ -488,11 +484,18 @@ 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(),
@@ -519,41 +522,13 @@ class IPFabricSyncForm(NetBoxModelForm):
             "source",
             "snapshot_data",
             "auto_merge",
+            "update_custom_fields",
             "sites",
-            "type",
             "tags",
             "scheduled",
             "interval",
         )
-        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
+        widgets = {"source": HTMXSelect()}
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -585,20 +560,13 @@ 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 backend.items():
+        for k, v in sync_parameters.items():
             self.backend_fields[k] = []
             for name, form_field in v.items():
                 field_name = f"ipf_{name}"
@@ -607,17 +575,52 @@ 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")
-        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."})
+        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."}
+                )
 
         scheduled_time = self.cleaned_data.get("scheduled")
         if scheduled_time and scheduled_time < local_now():
@@ -665,50 +668,6 @@ 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/graphql/__init__.py

@@ -0,0 +1,23 @@
+from .schema import IPFabricDataQuery
+from .schema import IPFabricIngestionIssueQuery
+from .schema import IPFabricIngestionQuery
+from .schema import IPFabricRelationshipFieldQuery
+from .schema import IPFabricSnapshotQuery
+from .schema import IPFabricSourceQuery
+from .schema import IPFabricSyncQuery
+from .schema import IPFabricTransformFieldQuery
+from .schema import IPFabricTransformMapGroupQuery
+from .schema import IPFabricTransformMapQuery
+
+schema = [
+    IPFabricTransformMapGroupQuery,
+    IPFabricTransformMapQuery,
+    IPFabricTransformFieldQuery,
+    IPFabricRelationshipFieldQuery,
+    IPFabricSourceQuery,
+    IPFabricSnapshotQuery,
+    IPFabricSyncQuery,
+    IPFabricIngestionQuery,
+    IPFabricIngestionIssueQuery,
+    IPFabricDataQuery,
+]

ipfabric_netbox/graphql/enums.py

@@ -0,0 +1,35 @@
+import strawberry
+from core.choices import DataSourceStatusChoices
+from core.choices import JobStatusChoices
+from netbox_branching.choices import BranchStatusChoices
+
+from ipfabric_netbox.choices import IPFabricRawDataTypeChoices
+from ipfabric_netbox.choices import IPFabricSnapshotStatusModelChoices
+from ipfabric_netbox.choices import IPFabricSourceTypeChoices
+from ipfabric_netbox.choices import IPFabricTransformMapSourceModelChoices
+
+__all__ = (
+    "DataSourceStatusEnum",
+    "IPFabricTransformMapSourceModelEnum",
+    "IPFabricSourceTypeEnum",
+    "IPFabricSnapshotStatusModelEnum",
+    "IPFabricRawDataTypeEnum",
+    "BranchStatusEnum",
+    "JobStatusEnum",
+)
+
+DataSourceStatusEnum = strawberry.enum(DataSourceStatusChoices.as_enum(prefix="type"))
+IPFabricTransformMapSourceModelEnum = strawberry.enum(
+    IPFabricTransformMapSourceModelChoices.as_enum(prefix="type")
+)
+IPFabricSourceTypeEnum = strawberry.enum(
+    IPFabricSourceTypeChoices.as_enum(prefix="type")
+)
+IPFabricSnapshotStatusModelEnum = strawberry.enum(
+    IPFabricSnapshotStatusModelChoices.as_enum(prefix="type")
+)
+IPFabricRawDataTypeEnum = strawberry.enum(
+    IPFabricRawDataTypeChoices.as_enum(prefix="type")
+)
+BranchStatusEnum = strawberry.enum(BranchStatusChoices.as_enum(prefix="type"))
+JobStatusEnum = strawberry.enum(JobStatusChoices.as_enum(prefix="type"))