Merge pull request #934 from nautobot/release-v3.9.2

Release v3.9.2

Author: jdrew82

.gitignore

@@ -308,3 +308,5 @@ public
 /compose.yaml
 /dump.sql
 /nautobot_ssot/static/nautobot_ssot/docs
+# Avoid accidental commit of analytics template override generated via ./docs/insert-analytics.sh
+docs/assets/overrides/main.html

.readthedocs.yaml

@@ -11,6 +11,9 @@ build:
   os: "ubuntu-22.04"
   tools:
     python: "3.10"
+  jobs:
+    pre_build:
+      - "/bin/bash ./docs/insert-analytics.sh"
 
 mkdocs:
   configuration: "mkdocs.yml"

docs/admin/release_notes/version_3.9.md

@@ -68,3 +68,28 @@ Please note that the behavior in the SNOW integration now is to swallow and log
 - [#867](https://github.com/nautobot/nautobot-app-ssot/issues/867) - Gracefully swallow ServiceNow exceptions
 - [#867](https://github.com/nautobot/nautobot-app-ssot/issues/867) - Adds ServiceNow duplicate file reports
 - [#867](https://github.com/nautobot/nautobot-app-ssot/issues/867) - Fixes ServiceNow comparison filters to only compare against company names with Manufacturer set to True
+
+## [v3.9.2 (2025-08-08)](https://github.com/nautobot/nautobot-app-ssot/releases/tag/v3.9.2)
+
+### Added
+
+- [#860](https://github.com/nautobot/nautobot-app-ssot/issues/860) - Added `nautobot_ssot.utils.orm.get_custom_relationship_association_parameters` utility function.
+- [#860](https://github.com/nautobot/nautobot-app-ssot/issues/860) - Added `nautobot_ssot.utils.orm.get_custom_relationship_associations` utility function.
+- [#860](https://github.com/nautobot/nautobot-app-ssot/issues/860) - Added `nautobot_ssot.utils.typing.get_inner_type` utility function.
+
+### Changed
+
+- [#860](https://github.com/nautobot/nautobot-app-ssot/issues/860) - Changed `nautobot_ssot.contrib.adapter.NautobotAdapter` to use new `orm` and `typing` utility functions.
+
+### Fixed
+
+- [#596](https://github.com/nautobot/nautobot-app-ssot/issues/596) - Handles HTTP 404 exception case for expired A record and PTR reference, and logs as a warning instead of failing the job run.
+- [#881](https://github.com/nautobot/nautobot-app-ssot/issues/881) - Fixed exception caused by missing secret value when creating a SecretsGroup with Bootstrap.
+- [#904](https://github.com/nautobot/nautobot-app-ssot/issues/904) - Fixed exception caused by missing software version when creating ValidatedSoftware with Bootstrap.
+- [#916](https://github.com/nautobot/nautobot-app-ssot/issues/916) - Fixed bootstrap signal DLM checks.
+- [#921](https://github.com/nautobot/nautobot-app-ssot/issues/921) - Fixed missing Prefix bug in Meraki integration.
+- [#926](https://github.com/nautobot/nautobot-app-ssot/issues/926) - Fixed issue with metadata_type when contrib models are used without the contrib adapter.
+
+### Documentation
+
+- [#925](https://github.com/nautobot/nautobot-app-ssot/issues/925) - Added Analytics GTM template override only to the public ReadTheDocs build.

docs/insert-analytics.sh

@@ -0,0 +1,36 @@
+#! /bin/bash
+
+# !!! IMPORTANT - READ THIS FIRST !!!
+# This script is to be used ONLY when building PUBLIC documentation hosted
+# on ReadTheDocs! It's executed in the pipeline defined in .readthedocs.yaml
+# and inserts a Google Tag Manager tracking code for web analytics.
+# Do NOT reuse this to insert analytics code in your development environments
+# or into the release process (i.e. built packages).
+
+cat > ./docs/assets/overrides/main.html <<EOL
+{% extends "base.html" %}
+
+{% block analytics %}
+    <!-- Google Tag Manager -->
+    <script>(function (w, d, s, l, i) {
+            w[l] = w[l] || []; w[l].push({
+                'gtm.start':
+                    new Date().getTime(), event: 'gtm.js'
+            }); var f = d.getElementsByTagName(s)[0],
+                j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src =
+                    'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f);
+        })(window, document, 'script', 'dataLayer', 'GTM-K44D86GP');</script>
+    <!-- End Google Tag Manager -->
+
+{{ super() }}
+{% endblock %}
+
+{% block header %}
+    <!-- Google Tag Manager (noscript) -->
+    <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-K44D86GP" height="0" width="0"
+            style="display:none;visibility:hidden"></iframe></noscript>
+    <!-- End Google Tag Manager (noscript) -->
+
+{{ super() }}
+{% endblock %}
+EOL

nautobot_ssot/contrib/adapter.py

@@ -3,16 +3,16 @@
 # pylint: disable=protected-access
 # Diffsync relies on underscore-prefixed attributes quite heavily, which is why we disable this here.
 
-import warnings
-from typing import Dict, Type, get_args
+import re
+from typing import Dict, Type
 
 import pydantic
-from diffsync import DiffSync
+from diffsync import DiffSync, DiffSyncModel
 from diffsync.exceptions import ObjectCrudException
 from django.contrib.contenttypes.models import ContentType
 from django.db.models import Model
 from nautobot.extras.choices import RelationshipTypeChoices
-from nautobot.extras.models import Relationship, RelationshipAssociation
+from nautobot.extras.models import Relationship
 from nautobot.extras.models.metadata import MetadataType
 from typing_extensions import get_type_hints
 
@@ -22,7 +22,12 @@
     RelationshipSideEnum,
 )
 from nautobot_ssot.utils.cache import ORMCache
-from nautobot_ssot.utils.orm import load_typed_dict, orm_attribute_lookup
+from nautobot_ssot.utils.orm import (
+    get_custom_relationship_associations,
+    load_typed_dict,
+    orm_attribute_lookup,
+)
+from nautobot_ssot.utils.typing import get_inner_type
 
 
 class NautobotAdapter(DiffSync):
@@ -167,40 +172,28 @@ def _get_diffsync_class(self, model_name):
         return diffsync_model
 
     def _handle_custom_relationship_to_many_relationship(
-        self, database_object, diffsync_model, parameter_name, annotation
+        self,
+        database_object: Model,
+        diffsync_model: DiffSyncModel,
+        parameter_name: str,
+        annotation: CustomRelationshipAnnotation,
     ):
         # Introspect type annotations to deduce which fields are of interest
         # for this many-to-many relationship.
-        diffsync_field_type = get_type_hints(diffsync_model)[parameter_name]
-        inner_type = get_args(diffsync_field_type)[0]
-        related_objects_list = []
+        inner_type = get_inner_type(diffsync_model, parameter_name)
         # TODO: Allow for filtering, i.e. not taking into account all the objects behind the relationship.
-        relationship = self.get_from_orm_cache({"label": annotation.name}, Relationship)
-        relationship_association_parameters = self._construct_relationship_association_parameters(
-            annotation, database_object
-        )
-        relationship_associations = RelationshipAssociation.objects.filter(**relationship_association_parameters)
-
-        field_name = ""
-        field_name += "source" if annotation.side == RelationshipSideEnum.DESTINATION else "destination"
-        field_name += "_"
-        field_name += (
-            relationship.source_type.app_label.lower()
-            if annotation.side == RelationshipSideEnum.DESTINATION
-            else relationship.destination_type.app_label.lower()
-        )
-        field_name += "_"
-        field_name += (
-            relationship.source_type.model.lower()
-            if annotation.side == RelationshipSideEnum.DESTINATION
-            else relationship.destination_type.model.lower()
+        relationship: Relationship = self.get_from_orm_cache({"label": annotation.name}, Relationship)
+        relationship_associations, _ = get_custom_relationship_associations(
+            relationship=relationship,
+            db_obj=database_object,
+            relationship_side=annotation.side,
         )
 
+        related_objects_list = []
         for association in relationship_associations:
             related_object = getattr(
                 association, "source" if annotation.side == RelationshipSideEnum.DESTINATION else "destination"
             )
-            # dictionary_representation = self._handle_typed_dict(inner_type, related_object)
             dictionary_representation = load_typed_dict(inner_type, related_object)
             # Only use those where there is a single field defined, all 'None's will not help us.
             if any(dictionary_representation.values()):
@@ -223,33 +216,6 @@ def _handle_custom_relationship_to_many_relationship(
 
         return related_objects_list
 
-    @classmethod
-    def _handle_typed_dict(cls, inner_type, related_object):
-        """Handle a typed dict for many to many relationships.
-
-        TODO: Deprecated and to be removed in future version. Use `nautobot_ssot.utils.orm.load_typed_dict` instead.
-        """
-        warnings.warn(
-            "`_handle_typed_dict` is deprecated and will be removed in a future version. "
-            "Use `nautobot_ssot.utils.orm.load_typed_dict` instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return load_typed_dict(inner_type, related_object)
-
-    def _construct_relationship_association_parameters(self, annotation, database_object):
-        relationship = self.get_from_orm_cache({"label": annotation.name}, Relationship)
-        relationship_association_parameters = {
-            "relationship": relationship,
-            "source_type": relationship.source_type,
-            "destination_type": relationship.destination_type,
-        }
-        if annotation.side == RelationshipSideEnum.SOURCE:
-            relationship_association_parameters["source_id"] = database_object.id
-        else:
-            relationship_association_parameters["destination_id"] = database_object.id
-        return relationship_association_parameters
-
     def _handle_to_many_relationship(self, database_object, diffsync_model, parameter_name):
         """Handle a single one- or many-to-many relationship field.
 
@@ -301,11 +267,10 @@ class NautobotInterface(NautobotModel):
         """
         # Introspect type annotations to deduce which fields are of interest
         # for this many-to-many relationship.
-        inner_type = get_args(get_type_hints(diffsync_model)[parameter_name])[0]
+        inner_type = get_inner_type(diffsync_model, parameter_name)
         related_objects_list = []
         # TODO: Allow for filtering, i.e. not taking into account all the objects behind the relationship.
         for related_object in getattr(database_object, parameter_name).all():
-            # dictionary_representation = self._handle_typed_dict(inner_type, related_object)
             dictionary_representation = load_typed_dict(inner_type, related_object)
             # Only use those where there is a single field defined, all 'None's will not help us.
             if any(dictionary_representation.values()):
@@ -316,36 +281,28 @@ def _handle_custom_relationship_foreign_key(
         self, database_object, parameter_name: str, annotation: CustomRelationshipAnnotation
     ):
         """Handle a single custom relationship foreign key field."""
-        relationship_association_parameters = self._construct_relationship_association_parameters(
-            annotation, database_object
+        relationship_associations, association_count = get_custom_relationship_associations(
+            relationship=self.cache.get_from_orm(Relationship, {"label": annotation.name}),
+            db_obj=database_object,
+            relationship_side=annotation.side,
         )
 
-        relationship_association = RelationshipAssociation.objects.filter(**relationship_association_parameters)
-        amount_of_relationship_associations = relationship_association.count()
-        if amount_of_relationship_associations == 0:
+        if association_count == 0:
             return None
-        if amount_of_relationship_associations == 1:
-            association = relationship_association.first()
-            related_object = getattr(
-                association, "source" if annotation.side == RelationshipSideEnum.DESTINATION else "destination"
+        if association_count > 1:
+            self.job.logger.warning(
+                f"Foreign key ({database_object.__name__}.{parameter_name}) "
+                "custom relationship matched two associations - this shouldn't happen."
             )
-            # Discard the first part as there is no actual field on the model corresponding to that part.
-            _, *lookups = parameter_name.split("__")
-            for lookup in lookups[:-1]:
-                related_object = getattr(related_object, lookup)
-            return getattr(related_object, lookups[-1])
-        raise ValueError("Foreign key custom relationship matched two associations - this shouldn't happen.")
 
-    @staticmethod
-    def _handle_foreign_key(database_object, parameter_name):
-        """Handle a single foreign key field."""
-        warnings.warn(
-            "`_handle_foreign_key` is deprecated and will be removed in a future version. "
-            "Use `nautobot_ssot.utils.orm.orm_attribute_lookup` instead.",
-            DeprecationWarning,
-            stacklevel=2,
+        return orm_attribute_lookup(
+            getattr(
+                relationship_associations.first(),
+                "source" if annotation.side == RelationshipSideEnum.DESTINATION else "destination",
+            ),
+            # Discard the first part of the paramater name as it references the initial related object
+            re.sub("^(.*?)__", "", parameter_name),
         )
-        return orm_attribute_lookup(database_object, parameter_name)
 
     def get_or_create_metadatatype(self):
         """Retrieve or create a MetadataType object to track the last sync time of this SSoT job."""

nautobot_ssot/contrib/model.py

@@ -76,7 +76,7 @@ def update(self, attrs):
         try:
             obj = self.get_from_db()
             self._update_obj_with_parameters(obj, attrs, self.adapter)
-            if self.adapter.metadata_type:
+            if getattr(self.adapter, "metadata_type", None):
                 self._update_obj_metadata(obj, self.adapter)
         except ObjectCrudException as error:
             raise ObjectNotUpdated(error) from error
@@ -110,7 +110,7 @@ def create(cls, adapter, ids, attrs):
         except ObjectCrudException as error:
             raise ObjectNotCreated(error) from error
 
-        if adapter.metadata_type:
+        if getattr(adapter, "metadata_type", None):
             try:
                 cls._update_obj_metadata(obj, adapter)
             except ObjectCrudException as error: