ipfabric_netbox 4.2.0b5__py3-none-any.whl → 4.2.0b6__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.0b5"
+    version = "4.2.0b6"
     base_url = "ipfabric"
     min_version = "4.2.4"
 

ipfabric_netbox/forms.py

@@ -493,6 +493,12 @@ class IPFabricSyncForm(NetBoxModelForm):
         ),
     )
 
+    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,6 +525,7 @@ class IPFabricSyncForm(NetBoxModelForm):
             "source",
             "snapshot_data",
             "auto_merge",
+            "update_custom_fields",
             "sites",
             "type",
             "tags",
@@ -550,7 +557,9 @@ class IPFabricSyncForm(NetBoxModelForm):
         fieldsets.append(
             FieldSet("scheduled", "interval", name=_("Ingestion Execution Parameters"))
         )
-        fieldsets.append(FieldSet("auto_merge", name=_("Extras")))
+        fieldsets.append(
+            FieldSet("auto_merge", "update_custom_fields", name=_("Extras"))
+        )
         fieldsets.append(FieldSet("tags", name=_("Tags")))
 
         return fieldsets

ipfabric_netbox/migrations/0017_ipfabricsync_update_custom_fields.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.2.5 on 2025-08-22 12:32
+from django.db import migrations
+from django.db import models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("ipfabric_netbox", "0016_tags_and_changelog_for_snapshots"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="ipfabricsync",
+            name="update_custom_fields",
+            field=models.BooleanField(default=True),
+        ),
+    ]

ipfabric_netbox/models.py

@@ -611,6 +611,7 @@ 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(

ipfabric_netbox/tests/test_models.py

@@ -8,6 +8,7 @@ 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
@@ -121,6 +122,7 @@ class IPFabricTransformMapModelTestCase(TestCase):
             type="dcim",
             status="new",
             snapshot_data=snapshot,
+            update_custom_fields=True,
             parameters={
                 "vrf": False,
                 "site": True,
@@ -138,6 +140,8 @@ class IPFabricTransformMapModelTestCase(TestCase):
             },
         )
 
+        ingestion = IPFabricIngestion.objects.create(sync=sync)
+
         runner = IPFabricSyncRunner(
             settings={
                 "site": True,
@@ -152,7 +156,11 @@ 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",
@@ -166,7 +174,9 @@ class IPFabricTransformMapModelTestCase(TestCase):
             "networksCount": 6,
         }
 
-        self.site = runner.get_model_or_update("dcim", "site", site_data)
+        self.site = runner.sync_item(
+            item=site_data, app_label="dcim", model="site", cf=sync.update_custom_fields
+        )
 
         device_data = {
             "id": "961251111",
@@ -204,14 +214,36 @@ class IPFabricTransformMapModelTestCase(TestCase):
             "slug": None,
         }
 
-        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)
+        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,
+        )
 
     def test_transform_map(self):
         site_transform_map = IPFabricTransformMap.objects.get(name="Site Transform Map")
@@ -383,5 +415,10 @@ class IPFabricTransformMapModelTestCase(TestCase):
         )
         transform_field.template = "{{ object.hostname }} - test"
         transform_field.save()
-        device_object = runner.get_model_or_update("dcim", "device", device_data)
+        device_object = runner.sync_item(
+            item=device_data,
+            app_label="dcim",
+            model="device",
+            cf=sync.update_custom_fields,
+        )
         self.assertEqual(device_object.name, "L21PE152 - test")

ipfabric_netbox/utilities/ipfutils.py

@@ -589,6 +589,35 @@ 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,
@@ -605,23 +634,7 @@ class IPFabricSyncRunner(object):
             return
 
         for item in items:
-            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()
+            self.sync_item(item, app_label, model, cf, ingestion)
 
     @handle_errors
     def sync_devices(
@@ -684,11 +697,14 @@ class IPFabricSyncRunner(object):
 
             if device_object and self.settings.get("device"):
                 device_object.snapshot()
-                device_object.custom_field_data[
-                    "ipfabric_source"
-                ] = self.sync.snapshot_data.source.pk
-                if ingestion:
-                    device_object.custom_field_data["ipfabric_ingestion"] = ingestion.pk
+                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.save()
 
                 self.logger.increment_statistics(model="device")
@@ -829,7 +845,11 @@ class IPFabricSyncRunner(object):
         ) = self.collect_data()
 
         self.sync_items(
-            app_label="dcim", model="site", items=sites, cf=True, ingestion=ingestion
+            app_label="dcim",
+            model="site",
+            items=sites,
+            cf=self.sync.update_custom_fields,
+            ingestion=ingestion,
         )
         self.sync_devices(
             ingestion,

{ipfabric_netbox-4.2.0b5.dist-info → ipfabric_netbox-4.2.0b6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ipfabric_netbox
-Version: 4.2.0b5
+Version: 4.2.0b6
 Summary: NetBox plugin to sync IP Fabric data into NetBox
 License: MIT
 Keywords: netbox,ipfabric,plugin,sync

{ipfabric_netbox-4.2.0b5.dist-info → ipfabric_netbox-4.2.0b6.dist-info}/RECORD

@@ -1,4 +1,4 @@
-ipfabric_netbox/__init__.py,sha256=OFgZPAmWWR0o_36-A9EqYoMQpPdN9rgXRP8PVW7VAPA,674
+ipfabric_netbox/__init__.py,sha256=E5BKH5-wfz4YUPlNookiC6kVSmlN7ZR5mc7rN9YeHCY,674
 ipfabric_netbox/api/__init__.py,sha256=XRclTGWVR0ZhAAwgYul5Wm_loug5_hUjEumbLQEwKYM,47
 ipfabric_netbox/api/serializers.py,sha256=RV1tmkbRF_Est3x1w_bfk63qwgEQc97Bm4mk89tv2FU,6502
 ipfabric_netbox/api/urls.py,sha256=1fXXVTxNY5E64Nfz6b7zXD9bZI3FcefuxAWKMe0w_QU,1240
@@ -7,7 +7,7 @@ ipfabric_netbox/choices.py,sha256=tQ5RHwmuArQ7dCLcE3A_Bnw2ctGHgw67z--AawyyPPg,52
 ipfabric_netbox/data/transform_map.json,sha256=4PsucgMHcLW3SPoKEptQCd0gA5tCF4hjrR4bGQFCWy8,21744
 ipfabric_netbox/exceptions.py,sha256=DT4dpbakvqoROtBR_F0LzvQCMNWpGhufFcUbZTx0OLY,2655
 ipfabric_netbox/filtersets.py,sha256=FrlHkLWf_mNMTaT_Zm2wl1wYkHXMX7hXxMLYAkC6_Gg,7922
-ipfabric_netbox/forms.py,sha256=07p_vngzsnHG0aev83JqBhb8fSBts0w-MTKu4BuoNLw,44494
+ipfabric_netbox/forms.py,sha256=PLAoSJGqwHWPVO5F8Sf2iJv-L5xjYzv-wseiasaxdlg,44767
 ipfabric_netbox/graphql/__init__.py,sha256=-a5w_VY7pc-RVt8MvThkTzeAqCC3xCan4Ue6iMefmjI,754
 ipfabric_netbox/graphql/enums.py,sha256=4jtB2gKsmPXu9is5jd38hUbfrt1V5Wm1Ff-2JCDI3EU,1518
 ipfabric_netbox/graphql/filters.py,sha256=NGIxHIQhmya-aEsgzQgkRjwMxV1jaGOPxLzRzlrJPPg,12587
@@ -31,8 +31,9 @@ ipfabric_netbox/migrations/0013_switch_to_branching_plugin.py,sha256=JfdTNerjuFy
 ipfabric_netbox/migrations/0014_ipfabrictransformmapgroup_ipfabrictransformmap_group.py,sha256=RCfgKyqQhTkfSPhf0IukI3fjeAEBUs5pKWIpsLxgzp0,2272
 ipfabric_netbox/migrations/0015_ipfabricingestionissue.py,sha256=AjAkyboa4BSXsN53BqzO1k_U6QHu4rlA2IhzhubocJw,1732
 ipfabric_netbox/migrations/0016_tags_and_changelog_for_snapshots.py,sha256=XqftTQ4GFnoCoGSHPa2WL_bjSVCGxdP2MFXCUa6LN1k,929
+ipfabric_netbox/migrations/0017_ipfabricsync_update_custom_fields.py,sha256=IVbAL2WdigYT40sXN0A8K3HweJ_O4QqyzjB06TbkG5E,447
 ipfabric_netbox/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ipfabric_netbox/models.py,sha256=qvpeoufUHznDe8M4Zf-VDtqQlFPOFYtl3EFAKjRrclI,36107
+ipfabric_netbox/models.py,sha256=U9_ooh8juhtXwwcj0ay_6KZ-FlBt2SYrR7YCScAYa9k,36168
 ipfabric_netbox/navigation.py,sha256=2dEJ_wKHb52Tl0FOV1TH3JbxRe8YZ56ewrTsBFGKpCg,2210
 ipfabric_netbox/signals.py,sha256=cGa5PVD2i24pGXiVNfbu6ruIDqPVdwKQHTSWe9Ura84,1838
 ipfabric_netbox/tables.py,sha256=pHKv6Bosjnc-7aApak3nLhzxqBiA30olPdaMO8F1PQg,8262
@@ -70,14 +71,14 @@ ipfabric_netbox/templatetags/ipfabric_netbox_helpers.py,sha256=STw4pAd2qG7hgf-O6
 ipfabric_netbox/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ipfabric_netbox/tests/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ipfabric_netbox/tests/api/test_api.py,sha256=DVMnhtleWJdpmVHafqCh9fgN6PZhWMEBXBL_rfm3ly8,30615
-ipfabric_netbox/tests/test_models.py,sha256=4SGMX0LZ_fThkc-F1AMZIQbpmJvQNVFnS6QYZpIZkNA,14998
+ipfabric_netbox/tests/test_models.py,sha256=rPwdVs127vU78yOcmlC44f7dZw12oLVzTSJf1nH0jus,16068
 ipfabric_netbox/urls.py,sha256=ok66LP09rYi01qJmwdGGlBzV9wrGWVwVAIngPcreJxg,5449
 ipfabric_netbox/utilities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ipfabric_netbox/utilities/ipfutils.py,sha256=4W6fYuguvVdhNlWok-dTUhI0M4CK7hrBiMcLAtPuKIQ,31411
+ipfabric_netbox/utilities/ipfutils.py,sha256=wFmL5oriuF-is1ZlrIcLmoeYUY5ih-CA9weRQrx5AiA,31885
 ipfabric_netbox/utilities/logging.py,sha256=GYknjocMN6LQ2873_az3y0RKm29TCXaWviUIIneH-x0,3445
 ipfabric_netbox/utilities/nbutils.py,sha256=kFBEiJOGvr_49hJWCS2duXojx2-A9kVk0Xp_vj0ohfs,2641
 ipfabric_netbox/utilities/transform_map.py,sha256=QotbGc2TksINJrb62STgAigpC5Nsgi5umYHu_0rZd8k,2204
 ipfabric_netbox/views.py,sha256=nGWO-PlTyKviBzGEdmE3C_1I-xFjZMldqOWGx12wdbg,36855
-ipfabric_netbox-4.2.0b5.dist-info/METADATA,sha256=A8aUgRhs6Z7yZtjdw8l83gbxistnKYeqTrIXkiejA-E,4638
-ipfabric_netbox-4.2.0b5.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-ipfabric_netbox-4.2.0b5.dist-info/RECORD,,
+ipfabric_netbox-4.2.0b6.dist-info/METADATA,sha256=UKZI463uPse64h8bR0yCQQvkYUbqTuWwZlDMtG5fpFY,4638
+ipfabric_netbox-4.2.0b6.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+ipfabric_netbox-4.2.0b6.dist-info/RECORD,,