Import Improvements (#197)

* chore: Cleanup and docs

* chore: Build test fixtures

* fix: Test NetBox v4

* chore: NetBox 4.2 fixtures

* fix: Add changelo fragment

Author: snaselj

changes/197.added

@@ -0,0 +1 @@
+Added NetBox v4.2 tests.

docs/dev/generator.md

@@ -63,16 +63,16 @@ The first data iteration constructs the wrapping structure, which includes:
 
 - `SourceAdapter` with all source model `adapter.wrappers`.
     - The `SourceAdapter` manages `SourceModelWrapper` and `NautobotModelWrapper` instances.
-- A `SourceModelWrapper` for each source content type, with `source_wrapper.fields` detailing how to import the source data.
+- A `SourceModelWrapper` for each source content type, with `fields` detailing how to import the source data.
     - Each `SourceModelWrapper` instance corresponds to a single `NautobotModelWrapper` instance.
 - A `NautobotModelWrapper` for each Nautobot content type, detailing `nautobot_wrapper.fields` and types, aiding in constructing the `DiffSyncModel` instances.
     - A single `NautobotModelWrapper` instance can be referenced by multiple `SourceModelWrapper` instances.
 
-During this phase, all non-defined but present source fields are appended to the `source_wrapper.fields`, focusing on field names, not values.
+During this phase, all non-defined but present source fields are appended to the `SourceModelWrapper.fields`, focusing on field names, not values.
 
 ### Creating Source Importers
 
-Convert each `source_wrapper.fields` item into a callable based on previously-established field definitions. The callables convert the source data into the `DiffSyncModel` constructor's expected structure.
+Convert each `SourceModelWrapper.fields` item into a callable based on previously-established field definitions. The callables convert the source data into the `DiffSyncModel` constructor's expected structure.
 
 In this stage, the structure described in the previous section is enhanced.
 

nautobot_netbox_importer/diffsync/__init__.py

@@ -1 +1,4 @@
-"""DiffSync adapter and model implementation for nautobot-netbox-importer."""
+"""DiffSync adapter and model implementation for nautobot-netbox-importer.
+
+This folder is an importer implementation specific to NetBox, in opposite to `generator` folder, that is a generic Source => Nautobot importer.
+"""

nautobot_netbox_importer/diffsync/models/base.py

@@ -2,17 +2,20 @@
 
 from packaging.version import Version
 
+from nautobot_netbox_importer.diffsync.adapters.netbox import NetBoxAdapter
 from nautobot_netbox_importer.diffsync.models.locations import define_locations
-from nautobot_netbox_importer.generator import SourceAdapter, fields
+from nautobot_netbox_importer.generator import fields
 
 
-def setup(adapter: SourceAdapter) -> None:
+def setup(adapter: NetBoxAdapter) -> None:
     """Map NetBox base models to Nautobot."""
-    adapter.disable_model("sessions.session", "Nautobot has own sessions, sessions should never cross apps.")
-    netbox_version = adapter.options.netbox_version  # type: ignore[no-member]
+    netbox_version = adapter.options.netbox_version
+
     adapter.disable_model("admin.logentry", "Not directly used in Nautobot.")
-    adapter.disable_model("users.userconfig", "May not have a 1 to 1 translation to Nautobot.")
     adapter.disable_model("auth.permission", "Handled via a Nautobot model and may not be a 1 to 1.")
+    adapter.disable_model("extras.imageattachment", "Images are not imported yet.")
+    adapter.disable_model("sessions.session", "Nautobot has own sessions, sessions should never cross apps.")
+    adapter.disable_model("users.userconfig", "May not have a 1 to 1 translation to Nautobot.")
 
     adapter.configure_model(
         "extras.Status",

nautobot_netbox_importer/diffsync/models/locations.py

@@ -175,9 +175,11 @@ def forward_references(wrapper: SourceModelWrapper, references: SourceReferences
         "dcim.SiteGroup",
         nautobot_content_type="dcim.LocationType",
         fields={
-            "parent": fields.constant(region_type_uid, reference=location_type_wrapper)
-            if sitegroup_parent_always_region
-            else "parent",
+            "parent": (
+                fields.constant(region_type_uid, reference=location_type_wrapper)
+                if sitegroup_parent_always_region
+                else "parent"
+            ),
             "nestable": fields.constant(True),
         },
     )

nautobot_netbox_importer/generator/nautobot.py

@@ -310,6 +310,14 @@ def diffsync_class(self) -> Type["DiffSyncBaseModel"]:
 
         return result
 
+    @property
+    def content_type_id(self) -> Optional[int]:
+        """Get the Nautobot content type ID."""
+        if self.disabled:
+            return None
+
+        return self.content_type_instance.pk  # type: ignore
+
     def get_summary(self) -> NautobotModelSummary:
         """Get the summary."""
         issues = sorted(self.get_importer_issues())
@@ -318,7 +326,7 @@ def get_summary(self) -> NautobotModelSummary:
 
         return NautobotModelSummary(
             content_type=self.content_type,
-            content_type_id=None if self.disabled else self.content_type_instance.pk,
+            content_type_id=self.content_type_id,
             stats=self.stats,
             issues=issues,
             flags=str(self.flags),