ipfabric_netbox 4.3.2__py3-none-any.whl → 4.3.2b2__py3-none-any.whl

ipfabric_netbox/utilities/transform_map.py

@@ -3,6 +3,8 @@ import json
 
 from django.apps import apps as django_apps
 
+# region Transform Map Creation
+
 # These functions are used in the migration file to prepare the transform maps
 # Because of this we have to use historical models
 # see https://docs.djangoproject.com/en/5.1/topics/migrations/#historical-models
@@ -58,3 +60,174 @@ def get_transform_map() -> dict:
         with open(data_file, "rb") as data_file:
             return json.load(data_file)
     raise FileNotFoundError("'transform_map.json' not found in installed package")
+
+
+# endregion
+# region Transform Map Updating
+
+
+class Record:
+    """Base class for field and relationship records."""
+
+    def __init__(
+        self,
+        coalesce: bool | None = None,
+        old_template: str = None,
+        new_template: str = None,
+    ):
+        self.coalesce = coalesce
+        # Keep the original template here rather than loading it from transform_map.json
+        # so our revert won’t break if that template ever changes.
+        self.old_template = old_template
+        self.new_template = new_template
+
+
+class FieldRecord(Record):
+    def __init__(
+        self,
+        source_field: str,
+        target_field: str,
+        new_source_field: str | None = None,
+        new_target_field: str | None = None,
+        **kwargs,
+    ):
+        super().__init__(**kwargs)
+        self.source_field = source_field
+        self.target_field = target_field
+        self.new_source_field = new_source_field
+        self.new_target_field = new_target_field
+
+
+class RelationshipRecord(Record):
+    def __init__(self, source_model: str, target_field: str, **kwargs):
+        super().__init__(**kwargs)
+        self.source_model = source_model
+        self.target_field = target_field
+
+
+class TransformMapRecord:
+    def __init__(
+        self,
+        source_model: str,
+        target_model: str,
+        fields: tuple[FieldRecord, ...] = tuple(),
+        relationships: tuple[RelationshipRecord, ...] = tuple(),
+    ):
+        self.source_model = source_model
+        self.target_model = target_model
+        self.fields = fields
+        self.relationships = relationships
+
+
+def do_change(
+    apps, schema_editor, changes: tuple[TransformMapRecord, ...], forward: bool = True
+):
+    """Apply the changes, `forward` determines direction."""
+
+    ContentType = apps.get_model("contenttypes", "ContentType")
+    IPFabricTransformMap = apps.get_model("ipfabric_netbox", "IPFabricTransformMap")
+    IPFabricTransformField = apps.get_model("ipfabric_netbox", "IPFabricTransformField")
+    IPFabricRelationshipField = apps.get_model(
+        "ipfabric_netbox", "IPFabricRelationshipField"
+    )
+
+    try:
+        for change in changes:
+            app, model = change.target_model.split(".")
+            try:
+                transform_map = IPFabricTransformMap.objects.get(
+                    source_model=change.source_model,
+                    target_model=ContentType.objects.get(app_label=app, model=model),
+                )
+            except IPFabricTransformMap.DoesNotExist:
+                continue
+
+            for field in change.fields:
+                # Find the correct transform field.
+                # Only 1 should be found if it exists, but keep it as queryset so we can filter and update.
+                transform_field_qs = IPFabricTransformField.objects.filter(
+                    transform_map=transform_map,
+                    source_field=field.source_field
+                    if forward
+                    else field.new_source_field or field.source_field,
+                    target_field=field.target_field
+                    if forward
+                    else field.new_target_field or field.target_field,
+                )
+                if not transform_field_qs.exists():
+                    continue
+
+                if field.old_template is not None and field.new_template is not None:
+                    # First update the template if needed
+                    transform_field_qs.filter(
+                        template=field.old_template if forward else field.new_template
+                    ).update(
+                        template=field.new_template if forward else field.old_template
+                    )
+
+                if field.coalesce is not None:
+                    # Next update coalesce if needed
+                    transform_field_qs.filter(
+                        coalesce=not field.coalesce if forward else field.coalesce
+                    ).update(coalesce=field.coalesce if forward else not field.coalesce)
+
+                if (
+                    field.new_target_field is not None
+                    or field.new_source_field is not None
+                ):
+                    # And at the end update source_field/target_field if needed
+                    transform_field_qs.update(
+                        source_field=field.new_source_field or field.source_field
+                        if forward
+                        else field.source_field,
+                        target_field=field.new_target_field or field.target_field
+                        if forward
+                        else field.target_field,
+                    )
+
+            for relationship in change.relationships:
+                s_app, s_model = relationship.source_model.split(".")
+                source_model = ContentType.objects.get(app_label=s_app, model=s_model)
+
+                # Find the correct relationship field.
+                # Only 1 should be found if it exists, but keep it as queryset so we can filter and update.
+                relationship_qs = IPFabricRelationshipField.objects.filter(
+                    transform_map=transform_map,
+                    source_model=source_model,
+                    target_field=relationship.target_field,
+                )
+                if not relationship_qs.exists():
+                    continue
+
+                if (
+                    relationship.old_template is not None
+                    and relationship.new_template is not None
+                ):
+                    # First update the template if needed
+                    relationship_qs.filter(
+                        template=relationship.old_template
+                        if forward
+                        else relationship.new_template,
+                    ).update(
+                        template=relationship.new_template
+                        if forward
+                        else relationship.old_template
+                    ),
+
+                if relationship.coalesce is not None:
+                    # Next update coalesce if needed
+                    relationship_qs.filter(
+                        coalesce=not relationship.coalesce
+                        if forward
+                        else relationship.coalesce,
+                    ).update(
+                        coalesce=relationship.coalesce
+                        if forward
+                        else not relationship.coalesce
+                    ),
+
+    except Exception as e:
+        print(f"Error applying Transform map updates: {e}")
+
+
+# endregion

{ipfabric_netbox-4.3.2.dist-info → ipfabric_netbox-4.3.2b2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ipfabric_netbox
-Version: 4.3.2
+Version: 4.3.2b2
 Summary: NetBox plugin to sync IP Fabric data into NetBox
 License: MIT
 Keywords: netbox,ipfabric,plugin,sync
@@ -19,6 +19,7 @@ Provides-Extra: ipfabric-6-10
 Provides-Extra: ipfabric-7-0
 Provides-Extra: ipfabric-7-2
 Provides-Extra: ipfabric-7-3
+Requires-Dist: httpx (>0.26,<0.29)
 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"

{ipfabric_netbox-4.3.2.dist-info → ipfabric_netbox-4.3.2b2.dist-info}/RECORD

@@ -1,11 +1,11 @@
-ipfabric_netbox/__init__.py,sha256=-WcCwls7dVwHp7FX8M2ffSgbQEDjqE4snzKJkB8Uz7Y,672
+ipfabric_netbox/__init__.py,sha256=pEVJZiXGhR0CBOp0KyoC8ufk1zjiu4iwim4aiM4aq1A,674
 ipfabric_netbox/api/__init__.py,sha256=XRclTGWVR0ZhAAwgYul5Wm_loug5_hUjEumbLQEwKYM,47
 ipfabric_netbox/api/serializers.py,sha256=92Cwhnqsm1l1oZfdHH5aJI1VFX0eO5JS4BsdXE6Ur18,6738
 ipfabric_netbox/api/urls.py,sha256=1fXXVTxNY5E64Nfz6b7zXD9bZI3FcefuxAWKMe0w_QU,1240
 ipfabric_netbox/api/views.py,sha256=qOBTIzPtOBY75tTjirsTBbiRXrQQid478Tp15-WKbmQ,6859
 ipfabric_netbox/choices.py,sha256=r1A7zasYw92fdB6MxnvcLkzz4mA61_wSUmbfuDbmg0M,6017
-ipfabric_netbox/data/transform_map.json,sha256=4PsucgMHcLW3SPoKEptQCd0gA5tCF4hjrR4bGQFCWy8,21744
-ipfabric_netbox/exceptions.py,sha256=DT4dpbakvqoROtBR_F0LzvQCMNWpGhufFcUbZTx0OLY,2655
+ipfabric_netbox/data/transform_map.json,sha256=dYPXiaLJFuO9vabGgkuywn7XFCe7xdgPrfvOvP206TM,22016
+ipfabric_netbox/exceptions.py,sha256=5nyAVoaPEGDHcrUXNpsCr_Nhq1vz1VbAmq54fU03iRg,1453
 ipfabric_netbox/filtersets.py,sha256=4I_ogO0Wqexf4e4gy_CirdGmA6vSCybyCadFcjI2LM8,8011
 ipfabric_netbox/forms.py,sha256=s9jYgK75CJzCrhnEeB3WxxZ9bF2YfNDA4N-sO9xTqgc,50068
 ipfabric_netbox/graphql/__init__.py,sha256=-a5w_VY7pc-RVt8MvThkTzeAqCC3xCan4Ue6iMefmjI,754
@@ -35,10 +35,11 @@ ipfabric_netbox/migrations/0017_ipfabricsync_update_custom_fields.py,sha256=IVbA
 ipfabric_netbox/migrations/0018_remove_type_field.py,sha256=ffxW6IS3BLCbvM5M9DbDb_x6spMmRxnV1iq8IuXxMGw,385
 ipfabric_netbox/migrations/0019_alter_ipfabrictransformmap_options_and_more.py,sha256=ieDVedt9KpJBicAiC3kdZXzHeos12N0L9EdRXKmIVgY,501
 ipfabric_netbox/migrations/0020_clean_scheduled_jobs.py,sha256=zjCVKnCWTKYYkpVRwHjqRIRR2j6ALSKXYMfraRjNu7Y,2652
+ipfabric_netbox/migrations/0021_update_transform_maps.py,sha256=W9GSgMQNmEdxnRI1c13at3XG1F_hyo9oZWsTZ0TLN9c,5464
 ipfabric_netbox/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ipfabric_netbox/models.py,sha256=3etGCInD1FH1uyOlNh-Lx8iCd1SqdqoN583XK6yhBsw,38402
+ipfabric_netbox/models.py,sha256=5bgQzfGfCUWQdRL3j6CNFXVDW3oDfxpQ0Y6JCKRJz-M,39250
 ipfabric_netbox/navigation.py,sha256=g2PyyaMqjgYwO3VIKza8vMS-dhbkvxscsHwVfWBj_dk,2287
-ipfabric_netbox/signals.py,sha256=cGa5PVD2i24pGXiVNfbu6ruIDqPVdwKQHTSWe9Ura84,1838
+ipfabric_netbox/signals.py,sha256=y3x2jKT8yTjOfC4B3h4YZPRsYQkBal4cFdHJFkbPoS8,1411
 ipfabric_netbox/tables.py,sha256=jXiHcRrR4XwkvyUnnU92JW290nZg-85IdpKjsQOsFcc,9052
 ipfabric_netbox/template_content.py,sha256=lxZ02BFVihbSgjXCETGsWmhdElQUUO3uUGd0WfhlRmw,1120
 ipfabric_netbox/templates/ipfabric_netbox/inc/clone_form.html,sha256=f6O5ugjQg7u37QWxUpKvE38jNslwb3rCMghlAUqjWBk,1127
@@ -52,7 +53,7 @@ ipfabric_netbox/templates/ipfabric_netbox/inc/snapshotdata.html,sha256=1ItOCPjjp
 ipfabric_netbox/templates/ipfabric_netbox/inc/transform_map_field_map.html,sha256=MSpU2mQnrGg_jA1-eqQgaSK9DXCeo3w6j33tV_GFNJ4,535
 ipfabric_netbox/templates/ipfabric_netbox/inc/transform_map_relationship_map.html,sha256=tmIV0gDhfVxBse4xDeE5atMi4KEMkvxB_WRx94gu44U,539
 ipfabric_netbox/templates/ipfabric_netbox/ipfabric_table.html,sha256=HsxENF0KaaGT8w0_K6251LVH0W_mg60W8ktApxAG59U,1689
-ipfabric_netbox/templates/ipfabric_netbox/ipfabricingestion.html,sha256=EohTqqCwafb3ZfX0MJko4sdKaKNQmNZ7Cc7f0vTo-K8,4760
+ipfabric_netbox/templates/ipfabric_netbox/ipfabricingestion.html,sha256=4cUP5KxCEtH4j5RFT68-7UJUCnJcOCxA0iBzrxwua4I,4760
 ipfabric_netbox/templates/ipfabric_netbox/ipfabricsnapshot.html,sha256=HWCGi1e0O_jL-5XnIYfCC5EQh5oSw-1-ZUpjH6-cGV0,3690
 ipfabric_netbox/templates/ipfabric_netbox/ipfabricsource.html,sha256=I9K7Eob-jjNAy6lryq2QKpp-5JyR1DEJSPF3D6JKR_w,4063
 ipfabric_netbox/templates/ipfabric_netbox/ipfabricsync.html,sha256=M7tig8Y42ndsipBHKVVfSFb9tSGvm7Cf4fj-B54xizs,4852
@@ -74,15 +75,14 @@ ipfabric_netbox/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3h
 ipfabric_netbox/tests/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ipfabric_netbox/tests/api/test_api.py,sha256=rnpGj3_cuh-QGQgOoARWuvtipDNCjcICn_Qbv2kUMQA,35304
 ipfabric_netbox/tests/test_forms.py,sha256=ZZezIMjf5UiFGzpIlfIdnmXK5Urk8SdapF5c2MMOYoA,61693
-ipfabric_netbox/tests/test_models.py,sha256=FFrIT5xxv_yvujKpxGjRJPNPBDF2Pqi8zbY0vxuJeQs,16043
+ipfabric_netbox/tests/test_models.py,sha256=gagJKoxD-BnEMWwZ2d5uImrWJOqYgfXe23JRikcoruo,16420
 ipfabric_netbox/tests/test_views.py,sha256=KKHKA4ejTEwdy6Ce5StJxjxWVWbQ54Y1puyPeBRw1vM,87923
 ipfabric_netbox/urls.py,sha256=qF2BzZEDnPRd3opFaRfiMdaarYKFfv69iMaAbU2rsBU,2702
 ipfabric_netbox/utilities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ipfabric_netbox/utilities/ipfutils.py,sha256=I5okghNJV8M82eWACz1-px46AChcSWsoOu5_DpEXojo,31886
+ipfabric_netbox/utilities/ipfutils.py,sha256=wc6wVBEHKJ8RoCOrp6Fm3w08nf1xiHGGMsMYrypOcpA,38852
 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=GpM_7Mm6FE0qV2qbyj4YfDn0l-JkeeEHQOZkNVSSHk4,2391
+ipfabric_netbox/utilities/transform_map.py,sha256=nJhEdi2DqqowrtfowNgg-FZiE3_lN0MhQvaNwHS4yXw,8979
 ipfabric_netbox/views.py,sha256=CPVtPvHcKCeCAusxjC0WvnOUKn6p5m3lgd57wOp29dI,44829
-ipfabric_netbox-4.3.2.dist-info/METADATA,sha256=0YCejyxTmY3t01oFOFcJ4EpbjI_YQF8Nuf9N_Qt9aKQ,4752
-ipfabric_netbox-4.3.2.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-ipfabric_netbox-4.3.2.dist-info/RECORD,,
+ipfabric_netbox-4.3.2b2.dist-info/METADATA,sha256=klFh0MZzp-7HtCQ-hZtJvqtg7cnZxMwIn8NztNE4JlA,4789
+ipfabric_netbox-4.3.2b2.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+ipfabric_netbox-4.3.2b2.dist-info/RECORD,,

ipfabric_netbox/utilities/nbutils.py

@@ -1,79 +0,0 @@
-from collections import Counter
-from copy import deepcopy
-
-from dcim.models import Device
-from dcim.models import InventoryItem
-from dcim.models import Manufacturer
-
-DEFAULT_DEVICE_ROLE = "Network Device"
-device_serial_max_length = Device._meta.get_field("serial").max_length
-
-
-def order_members(members):
-    devices = {}
-
-    for member in members:
-        master_serial = member.get("sn")
-        if master_serial and member.get("memberSn"):
-            if master_serial in devices:
-                devices[master_serial].append(member)
-            else:
-                devices[master_serial] = [member]
-
-    return devices
-
-
-def order_devices(devices, members):
-    hostnames = [d["hostname"] for d in devices]
-    counter = Counter(hostnames)
-
-    new_devices = []
-
-    for device in devices:
-        if counter[device["hostname"]] > 1:
-            device["hostname"] = f"{device['hostname']} - ({device['sn']})"
-        if child_members := members.get(device.get("sn")):
-            for child_member in child_members:
-                if device.get("sn") != child_member.get("memberSn"):
-                    new_device = deepcopy(device)
-                    new_device[
-                        "hostname"
-                    ] = f"{device['hostname']}/{child_member.get('member')}"
-                    new_device["model"] = child_member.get("pn")
-                    new_device["sn"] = child_member.get("memberSn")
-                    new_device["virtual_chassis"] = child_member
-                    new_devices.append(new_device)
-                else:
-                    device["virtual_chassis"] = child_member
-            hostnames = [d["hostname"] for d in devices]
-            counter = Counter(hostnames)
-
-    devices.extend(new_devices)
-
-    return devices
-
-
-def create_inventory_items(device: Device, parts: list, manufacturer: Manufacturer):
-    for part in parts:
-        name = part.get("name", "")
-        if len(name) > InventoryItem._meta.get_field("name").max_length:
-            if part.get("dscr"):
-                name = part.get("dscr")
-            else:
-                name = part.get("sn")
-
-        defaults = {
-            "name": name,
-            "manufacturer": manufacturer,
-            "serial": part.get("sn", ""),
-            # "description": part.get('dscr', "123"),
-            "part_id": part.get("pid", ""),
-            "device": device,
-            "lft": device.pk,
-        }
-        if part.get("dscr"):
-            defaults["description"] = part.get("dscr")
-
-        inventory_object, _ = InventoryItem.objects.update_or_create(
-            serial=part.get("sn", ""), defaults=defaults
-        )