ipfabric_netbox 4.3.2b7__tar.gz → 4.3.2b9__tar.gz

{ipfabric_netbox-4.3.2b7 → ipfabric_netbox-4.3.2b9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ipfabric_netbox
-Version: 4.3.2b7
+Version: 4.3.2b9
 Summary: NetBox plugin to sync IP Fabric data into NetBox
 License: MIT
 Keywords: netbox,ipfabric,plugin,sync

{ipfabric_netbox-4.3.2b7 → ipfabric_netbox-4.3.2b9}/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.3.2b7"
+    version = "4.3.2b9"
     base_url = "ipfabric"
     min_version = "4.4.0"
 

{ipfabric_netbox-4.3.2b7 → ipfabric_netbox-4.3.2b9}/ipfabric_netbox/exceptions.py

@@ -46,5 +46,10 @@ class IPAddressPrimaryRemovalError(IngestionIssue, SyncError):
         return "Error removing primary IP from other device."
 
 
+class IPAddressPrimaryAssignmentError(IngestionIssue, SyncError):
+    def __str__(self):
+        return "Error assigning primary IP to device."
+
+
 class RequiredDependencyFailedSkip(SearchError):
     """Raised when a required dependency failed, causing this item to be skipped."""

{ipfabric_netbox-4.3.2b7 → ipfabric_netbox-4.3.2b9}/ipfabric_netbox/jobs.py

@@ -3,6 +3,9 @@ from datetime import timedelta
 
 from core.choices import JobStatusChoices
 from core.exceptions import SyncError
+from dcim.models import VirtualChassis
+from dcim.signals import assign_virtualchassis_master
+from django.db.models import signals
 from netbox.context_managers import event_tracking
 from rq.timeouts import JobTimeoutException
 from utilities.datetime import local_now
@@ -116,7 +119,17 @@ def merge_ipfabric_ingestion(job, remove_branch=False, *args, **kwargs):
 
         job.start()
         with event_tracking(request):
-            ingestion.sync_merge()
+            try:
+                # This signal is disabled on sync, we need to disable it here too
+                signals.post_save.disconnect(
+                    assign_virtualchassis_master, sender=VirtualChassis
+                )
+                ingestion.sync_merge()
+            finally:
+                # Re-enable the disabled signal
+                signals.post_save.connect(
+                    assign_virtualchassis_master, sender=VirtualChassis
+                )
         if remove_branch:
             branching_branch = ingestion.branch
             ingestion.branch = None

{ipfabric_netbox-4.3.2b7 → ipfabric_netbox-4.3.2b9}/ipfabric_netbox/utilities/ipfutils.py

@@ -14,10 +14,13 @@ from typing import TypeVar
 from core.exceptions import SyncError
 from core.signals import clear_events
 from dcim.models import Device
+from dcim.models import VirtualChassis
+from dcim.signals import assign_virtualchassis_master
 from django.conf import settings
 from django.core.exceptions import MultipleObjectsReturned
 from django.core.exceptions import ObjectDoesNotExist
 from django.db.models import Model
+from django.db.models import signals
 from django.utils.text import slugify
 from django_tables2 import Column
 from extras.events import flush_events
@@ -30,6 +33,7 @@ from netutils.utils import jinja2_convenience_function
 from ..choices import IPFabricSourceTypeChoices
 from ..choices import IPFabricSyncStatusChoices
 from ..exceptions import IPAddressDuplicateError
+from ..exceptions import IPAddressPrimaryAssignmentError
 from ..exceptions import IPAddressPrimaryRemovalError
 from ..exceptions import RequiredDependencyFailedSkip
 from ..exceptions import SearchError
@@ -997,84 +1001,99 @@ class IPFabricSyncRunner(object):
             self.events_clearer.increment()
 
     @handle_errors
-    def sync_ip_addresses(self, ip_addresses: set[DataRecord]) -> None:
-        """
-        We cannot assign primary IP in signals since IPAddress does not
-        contain information whether it is primary or not. And it must be done
-        on Device object, so cannot be done via Transform Maps yet since that
-        would require another Transform Map for Device.
-        So we need to do it manually here.
+    def sync_ipaddress(self, ip_address: DataRecord) -> "IPAddress | None":
+        """Sync a single IP Address to NetBox, separated to use @handle_errors."""
+        connection_name = self.get_db_connection_name()
 
-        Cleaning events queue happens during each cycle to make sure all required
-        operations (primary IP assignment) happen during the same batch.
-        """
-        if not self.settings.get("ipaddress"):
-            self.logger.log_info(
-                "Did not ask to sync ipaddresses, skipping.", obj=self.sync
+        # First remove primary IP from the target object.
+        # It cannot be done using hooks since there is no pre_clean at it fails on full_clean()
+        try:
+            ipv4_address = render_jinja2(
+                ip_address.transform_map.field_maps.get(
+                    target_field="address"
+                ).template,
+                {"object": ip_address.data},
             )
+            other_device = (
+                Device.objects.using(connection_name)
+                .exclude(serial=serial(ip_address.data))
+                .get(primary_ip4__address=ipv4_address)
+            )
+            other_device.snapshot()
+            other_device.primary_ip4 = None
+            other_device.save(using=connection_name)
+        except Device.DoesNotExist:
+            # There is no other device with this IP as primary, all good
+            pass
+        except Exception as err:
+            # The transform maps might be changed, and we fail to resolve the template
+            # Make sure this does not crash the sync and is handled gracefully
+            _, issue = self.create_or_get_sync_issue(
+                exception=err,
+                ingestion=self.ingestion,
+                message="Error removing primary IP from other device.",
+                model=ip_address.model,
+                data=ip_address.data,
+            )
+            self.events_clearer.increment()
+            raise IPAddressPrimaryRemovalError(
+                data=ip_address.data,
+                model=ip_address.model,
+                issue_id=issue.pk,
+            ) from err
+
+        ip_address_obj: "IPAddress | None" = self.sync_item(record=ip_address)
+        if ip_address_obj is None or ip_address_obj.assigned_object is None:
+            self.events_clearer.increment()
             return
 
-        for ip_address in ip_addresses:
-            connection_name = self.get_db_connection_name()
+        parent_device = ip_address_obj.assigned_object.parent_object
 
-            # First remove primary IP from the target object.
-            # It cannot be done using hooks since there is no pre_clean at it fails on full_clean()
+        # Now assign this IP as primary to the parent device, if not assigned yet or assigned to different IP
+        if ip_address.data.get("is_primary") and (
+            not parent_device.primary_ip4
+            or parent_device.primary_ip4.pk != ip_address_obj.pk
+        ):
             try:
-                ipv4_address = render_jinja2(
-                    ip_address.transform_map.field_maps.get(
-                        target_field="address"
-                    ).template,
-                    {"object": ip_address.data},
-                )
-                other_device = (
-                    Device.objects.using(connection_name)
-                    .exclude(serial=serial(ip_address.data))
-                    .get(primary_ip4__address=ipv4_address)
-                )
-                other_device.snapshot()
-                other_device.primary_ip4 = None
-                other_device.save(using=connection_name)
-            except Device.DoesNotExist:
-                # There is no other device with this IP as primary, all good
-                pass
+                parent_device.snapshot()
+                parent_device.primary_ip4 = ip_address_obj
+                parent_device.save(using=connection_name)
             except Exception as err:
-                # The transform maps might be changed, and we fail to resolve the template
-                # Make sure this does not crash the sync and is handled gracefully
                 _, issue = self.create_or_get_sync_issue(
                     exception=err,
                     ingestion=self.ingestion,
-                    message="Error removing primary IP from other device.",
+                    message="Error assigning primary IP to device.",
                     model=ip_address.model,
                     data=ip_address.data,
                 )
                 self.events_clearer.increment()
-                raise IPAddressPrimaryRemovalError(
+                raise IPAddressPrimaryAssignmentError(
                     data=ip_address.data,
                     model=ip_address.model,
                     issue_id=issue.pk,
                 ) from err
+        self.events_clearer.increment()
 
-            ip_address_obj: "IPAddress | None" = self.sync_item(record=ip_address)
-            if ip_address_obj is None or ip_address_obj.assigned_object is None:
-                self.events_clearer.increment()
-                continue
+    @handle_errors
+    def sync_ip_addresses(self, ip_addresses: set[DataRecord]) -> None:
+        """
+        We cannot assign primary IP in signals since IPAddress does not
+        contain information whether it is primary or not. And it must be done
+        on Device object, so cannot be done via Transform Maps yet since that
+        would require another Transform Map for Device.
+        So we need to do it manually here.
 
-            parent_device = ip_address_obj.assigned_object.parent_object
+        Cleaning events queue happens during each cycle to make sure all required
+        operations (primary IP assignment) happen during the same batch.
+        """
+        if not self.settings.get("ipaddress"):
+            self.logger.log_info(
+                "Did not ask to sync ipaddresses, skipping.", obj=self.sync
+            )
+            return
 
-            # Now assign this IP as primary to the parent device, if not assigned yet or assigned to different IP
-            if ip_address.data.get("is_primary") and (
-                not parent_device.primary_ip4
-                or parent_device.primary_ip4.pk != ip_address_obj.pk
-            ):
-                try:
-                    parent_device.snapshot()
-                    parent_device.primary_ip4 = ip_address_obj
-                    parent_device.save(using=connection_name)
-                except (ValueError, AttributeError) as err:
-                    self.logger.log_failure(
-                        f"Error assigning primary IP to device: {err}", obj=self.sync
-                    )
-            self.events_clearer.increment()
+        for ip_address in ip_addresses:
+            self.sync_ipaddress(ip_address)
 
     def collect_and_sync(self, ingestion=None) -> None:
         self.logger.log_info("Starting data collection.", obj=self.sync)
@@ -1092,15 +1111,24 @@ class IPFabricSyncRunner(object):
         self.sync_items(items=records["devicetype"])
         self.sync_items(items=records["platform"])
         self.sync_items(items=records["devicerole"])
-        self.sync_items(items=records["virtualchassis"])
-        self.sync_devices(
-            devices=records["device"],
-            cf=self.sync.update_custom_fields,
-            ingestion=ingestion,
-        )
-        # The Device exists now, so we can update the master of the VC.
-        # The logic is handled in transform maps.
-        self.sync_items(items=records["virtualchassis"], stats=False)
+        try:
+            # This signal does not call for snapshot(), causing issue with branching plugin
+            signals.post_save.disconnect(
+                assign_virtualchassis_master, sender=VirtualChassis
+            )
+            self.sync_items(items=records["virtualchassis"])
+            self.sync_devices(
+                devices=records["device"],
+                cf=self.sync.update_custom_fields,
+                ingestion=ingestion,
+            )
+            # The Device exists now, so we can update the master of the VC.
+            # The logic is handled in transform maps.
+            self.sync_items(items=records["virtualchassis"], stats=False)
+        finally:
+            signals.post_save.connect(
+                assign_virtualchassis_master, sender=VirtualChassis
+            )
         self.sync_items(items=records["interface"])
         self.sync_items(items=records["macaddress"])
         self.sync_items(items=records["inventoryitem"])

{ipfabric_netbox-4.3.2b7 → ipfabric_netbox-4.3.2b9}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ipfabric_netbox"
-version = "4.3.2b7"
+version = "4.3.2b9"
 description = "NetBox plugin to sync IP Fabric data into NetBox"
 authors = ["Solution Architecture <solution.architecture@ipfabric.io>"]
 license = "MIT"