nautobot 2.2.0__py3-none-any.whl → 2.2.1__py3-none-any.whl

nautobot/__init__.py

@@ -1,4 +1,35 @@
 from importlib import metadata
+import logging
+import os
+
+import django
 
 # Primary package version
 __version__ = metadata.version(__name__)
+
+# Sentinel to make sure we only initialize once.
+__initialized = False
+
+logger = logging.getLogger(__name__)
+
+
+def setup(config_path=None):
+    """Similar to `django.setup()`, this configures Django with the appropriate Nautobot settings data."""
+    from nautobot.core.cli import get_config_path, load_settings
+
+    global __initialized
+
+    if __initialized:
+        return
+
+    if config_path is None:
+        config_path = get_config_path()
+
+    # Point Django to our 'nautobot_config' pseudo-module that we'll load from the provided config path
+    os.environ["DJANGO_SETTINGS_MODULE"] = "nautobot_config"
+
+    load_settings(config_path)
+    django.setup()
+
+    logger.info("Nautobot initialized!")
+    __initialized = True

nautobot/circuits/apps.py

@@ -5,8 +5,8 @@ class CircuitsConfig(NautobotConfig):
     name = "nautobot.circuits"
     verbose_name = "Circuits"
     searchable_models = [
-        "provider",
         "circuit",
+        "provider",
         "providernetwork",
     ]
 

nautobot/core/api/routers.py

@@ -27,6 +27,31 @@ class OrderedDefaultRouter(DefaultRouter):
             }
         )
 
+    def register(self, prefix, viewset, basename=None):
+        """
+        Override DRF's BaseRouter.register() to bypass an unnecessary restriction added in version 3.15.0.
+
+        (Reference: https://github.com/encode/django-rest-framework/pull/8438)
+        """
+        if basename is None:
+            basename = self.get_default_basename(viewset)
+
+        # DRF:
+        # if self.is_already_registered(basename):
+        #     msg = (f'Router with basename "{basename}" is already registered. '
+        #            f'Please provide a unique basename for viewset "{viewset}"')
+        #     raise ImproperlyConfigured(msg)
+        #
+        # We bypass this because we have at least one use case (/api/extras/jobs/) where we are *intentionally*
+        # registering two viewsets with the same basename, but have carefully defined them so as not to conflict.
+
+        # resuming standard DRF code...
+        self.registry.append((prefix, viewset, basename))
+
+        # invalidate the urls cache
+        if hasattr(self, "_urls"):
+            del self._urls
+
     def get_api_root_view(self, api_urls=None):
         """
         Wrap DRF's DefaultRouter to return an alphabetized list of endpoints.

nautobot/core/cli/__init__.py

@@ -13,7 +13,6 @@ from django.core.management import CommandError, CommandParser, execute_from_com
 from django.core.management.utils import get_random_secret_key
 from jinja2 import BaseLoader, Environment
 
-from nautobot import __version__
 from nautobot.core.settings_funcs import is_truthy
 from nautobot.extras.plugins.utils import load_plugins
 
@@ -126,7 +125,7 @@ def _preprocess_settings(settings, config_path):
     load_plugins(settings)
 
 
-def _load_settings(config_path):
+def load_settings(config_path):
     """Load nautobot_config.py or its equivalent into memory as a `nautobot_config` pseudo-module."""
     if not os.path.exists(config_path):
         raise FileNotFoundError(
@@ -154,6 +153,8 @@ class _VersionAction(argparse.Action):
         super().__init__(*args, **kwargs)
 
     def __call__(self, parser, namespace, values, option_string):
+        from nautobot import __version__
+
         print(f"Nautobot version: {__version__}")
         print(f"Django version: {django.__version__}")
         print(f"Configuration file: {namespace.config_path}")
@@ -215,13 +216,9 @@ def _init_settings(args):
     print(f"Configuration file created at {config_path}")
 
 
-def main():
-    """Run administrative tasks."""
-    # Point Django to our 'nautobot_config' pseudo-module that we'll load from the provided config path
-    os.environ["DJANGO_SETTINGS_MODULE"] = "nautobot_config"
-
-    # Default config path based on NAUTOBOT_CONFIG or NAUTOBOT_ROOT environment variables
-    config_path = os.getenv(
+def get_config_path():
+    """Get the default Nautobot config file path based on the NAUTOBOT_CONFIG or NAUTOBOT_ROOT environment variables."""
+    return os.getenv(
         "NAUTOBOT_CONFIG",
         os.path.join(
             os.getenv("NAUTOBOT_ROOT", os.path.expanduser("~/.nautobot")),
@@ -229,13 +226,23 @@ def main():
         ),
     )
 
+
+def main():
+    """Run administrative tasks."""
+    # Point Django to our 'nautobot_config' pseudo-module that we'll load from the provided config path
+    os.environ["DJANGO_SETTINGS_MODULE"] = "nautobot_config"
+
+    default_config_path = get_config_path()
+
     # Intercept certain CLI parameters and arguments before they reach Django
     parser = CommandParser(
         description=DESCRIPTION,
         usage=USAGE,
         formatter_class=_VerboseHelpFormatter,
     )
-    parser.add_argument("-c", "--config-path", default=config_path, help="Path to the Nautobot configuration file")
+    parser.add_argument(
+        "-c", "--config-path", default=default_config_path, help="Path to the Nautobot configuration file"
+    )
     parser.add_argument("--version", action=_VersionAction, help="Show version numbers and exit")
 
     # Parse out the `--config` argument here and capture the rest of the CLI args
@@ -282,7 +289,7 @@ def main():
             raise
 
     # If we get here, it's a regular Django management command - so load in the nautobot_config.py then hand off
-    _load_settings(args.config_path)
+    load_settings(args.config_path)
     execute_from_command_line([sys.argv[0], *unparsed_args])
 
 

nautobot/core/constants.py

@@ -104,4 +104,89 @@ COMPOSITE_KEY_SEPARATOR = ";"
 # For the natural slug separator, it's much simpler and we can just go with "_".
 NATURAL_SLUG_SEPARATOR = "_"
 
+# For config settings that contain a list of things.
+# As environment variables only allow string types, these need to be split into the final list.
+CONFIG_SETTING_SEPARATOR = ","
+
 CHARFIELD_MAX_LENGTH = 255
+
+# Models excluded from the global search list
+GLOBAL_SEARCH_EXCLUDE_LIST = [
+    "anotherexamplemodel",
+    "cablepath",
+    "circuittermination",
+    "circuittype",
+    "clustergroup",
+    "clustertype",
+    "computedfield",
+    "configcontext",
+    "configcontextschema",
+    "consoleport",
+    "consoleporttemplate",
+    "consoleserverport",
+    "consoleserverporttemplate",
+    "contactassociation",
+    "controllermanageddevicegroup",
+    "customfield",
+    "customfieldchoice",
+    "customlink",
+    "devicebay",
+    "devicebaytemplate",
+    "devicetypetosoftwareimagefile",
+    "dynamicgroupmembership",
+    "exporttemplate",
+    "fileattachment",
+    "fileproxy",
+    "frontport",
+    "frontporttemplate",
+    "graphqlquery",
+    "healthchecktestmodel",
+    "imageattachment",
+    "interface",
+    "interfaceredundancygroup",
+    "interfaceredundancygroupassociation",
+    "interfacetemplate",
+    "inventoryitem",
+    "ipaddresstointerface",
+    "job",
+    "jobbutton",
+    "jobhook",
+    "joblogentry",
+    "jobresult",
+    "locationtype",
+    "manufacturer",
+    "note",
+    "objectchange",
+    "platform",
+    "poweroutlet",
+    "poweroutlettemplate",
+    "powerpanel",
+    "powerport",
+    "powerporttemplate",
+    "prefixlocationassignment",
+    "rackreservation",
+    "rearport",
+    "rearporttemplate",
+    "relationship",
+    "relationshipassociation",
+    "rir",
+    "role",
+    "routetarget",
+    "scheduledjob",
+    "scheduledjobs",
+    "secret",
+    "secretsgroup",
+    "secretsgroupassociation",
+    "service",
+    "softwareimagefile",
+    "status",
+    "tag",
+    "taggeditem",
+    "tenantgroup",
+    "vlangroup",
+    "vlanlocationassignment",
+    "vminterface",
+    "vrfdeviceassignment",
+    "vrfprefixassignment",
+    "webhook",
+]

nautobot/core/forms/widgets.py

@@ -182,8 +182,7 @@ class APISelect(SelectWithDisabled):
                     # ModelChoiceIterator.__iter__() yields a tuple of (value, label)
                     # using this approach first yield a tuple of (null(value), null_option(label))
                     yield "null", self.null_options
-                    for item in super().__iter__():
-                        yield item
+                    yield from super().__iter__()
 
             null_option = self.attrs.get("data-null-option")
             self.choices = ModelChoiceIteratorWithNullOption(field=self.choices.field, null_option=null_option)

nautobot/core/graphql/schema.py

@@ -1,4 +1,5 @@
 """Schema module for GraphQL."""
+
 from collections import OrderedDict
 import logging
 

nautobot/core/models/__init__.py

@@ -55,6 +55,7 @@ class BaseModel(models.Model):
     )
 
     objects = BaseManager.from_queryset(RestrictedQuerySet)()
+    is_contact_associable_model = True
 
     class Meta:
         abstract = True

nautobot/core/settings.py

@@ -10,6 +10,7 @@ import django.forms
 from django.utils.safestring import mark_safe
 
 from nautobot import __version__
+from nautobot.core.constants import CONFIG_SETTING_SEPARATOR as _CONFIG_SETTING_SEPARATOR
 from nautobot.core.settings_funcs import ConstanceConfigItem, is_truthy, parse_redis_connection
 
 #
@@ -152,6 +153,9 @@ if "NAUTOBOT_MAX_PAGE_SIZE" in os.environ and os.environ["NAUTOBOT_MAX_PAGE_SIZE
 # Metrics
 METRICS_ENABLED = is_truthy(os.getenv("NAUTOBOT_METRICS_ENABLED", "False"))
 METRICS_AUTHENTICATED = is_truthy(os.getenv("NAUTOBOT_METRICS_AUTHENTICATED", "False"))
+METRICS_DISABLED_APPS = []
+if "NAUTOBOT_METRICS_DISABLED_APPS" in os.environ and os.environ["NAUTOBOT_METRICS_DISABLED_APPS"] != "":
+    METRICS_DISABLED_APPS = os.getenv("NAUTOBOT_METRICS_DISABLED_APPS", "").split(_CONFIG_SETTING_SEPARATOR)
 
 # Napalm
 NAPALM_ARGS = {}
@@ -166,7 +170,7 @@ if "NAUTOBOT_PAGINATE_COUNT" in os.environ and os.environ["NAUTOBOT_PAGINATE_COU
 # The options displayed in the web interface dropdown to limit the number of objects per page.
 # Default is [25, 50, 100, 250, 500, 1000]
 if "NAUTOBOT_PER_PAGE_DEFAULTS" in os.environ and os.environ["NAUTOBOT_PER_PAGE_DEFAULTS"] != "":
-    PER_PAGE_DEFAULTS = [int(val) for val in os.environ["NAUTOBOT_PER_PAGE_DEFAULTS"].split(",")]
+    PER_PAGE_DEFAULTS = [int(val) for val in os.environ["NAUTOBOT_PER_PAGE_DEFAULTS"].split(_CONFIG_SETTING_SEPARATOR)]
 
 # Plugins
 PLUGINS = []
@@ -188,6 +192,13 @@ if (
 ):
     RACK_ELEVATION_DEFAULT_UNIT_WIDTH = int(os.environ["NAUTOBOT_RACK_ELEVATION_DEFAULT_UNIT_WIDTH"])
 
+# Enable two-digit format for the rack unit numbering in rack elevations.
+if (
+    "NAUTOBOT_RACK_ELEVATION_UNIT_TWO_DIGIT_FORMAT" in os.environ
+    and os.environ["NAUTOBOT_RACK_ELEVATION_UNIT_TWO_DIGIT_FORMAT"] != ""
+):
+    RACK_ELEVATION_UNIT_TWO_DIGIT_FORMAT = is_truthy(os.environ["NAUTOBOT_RACK_ELEVATION_UNIT_TWO_DIGIT_FORMAT"])
+
 # How frequently to check for a new Nautobot release on GitHub, and the URL to check for this information.
 # Defaults to disabled (no URL) and check every 24 hours when enabled
 if "NAUTOBOT_RELEASE_CHECK_TIMEOUT" in os.environ and os.environ["NAUTOBOT_RELEASE_CHECK_TIMEOUT"] != "":
@@ -769,6 +780,11 @@ CONSTANCE_CONFIG = {
     "RACK_ELEVATION_DEFAULT_UNIT_WIDTH": ConstanceConfigItem(
         default=230, help_text="Default width (in pixels) of a rack unit in a rack elevation diagram", field_type=int
     ),
+    "RACK_ELEVATION_UNIT_TWO_DIGIT_FORMAT": ConstanceConfigItem(
+        default=False,
+        help_text="Enables two-digit format for the rack unit numbering in a rack elevation diagram",
+        field_type=bool,
+    ),
     "RELEASE_CHECK_TIMEOUT": ConstanceConfigItem(
         default=24 * 3600,
         help_text="Number of seconds (must be at least 3600, or one hour) to cache the result of a release check "
@@ -800,7 +816,11 @@ CONSTANCE_CONFIG_FIELDSETS = {
     "Natural Keys": ["DEVICE_NAME_AS_NATURAL_KEY", "LOCATION_NAME_AS_NATURAL_KEY"],
     "Pagination": ["PAGINATE_COUNT", "MAX_PAGE_SIZE", "PER_PAGE_DEFAULTS"],
     "Performance": ["DYNAMIC_GROUPS_MEMBER_CACHE_TIMEOUT", "JOB_CREATE_FILE_MAX_SIZE"],
-    "Rack Elevation Rendering": ["RACK_ELEVATION_DEFAULT_UNIT_HEIGHT", "RACK_ELEVATION_DEFAULT_UNIT_WIDTH"],
+    "Rack Elevation Rendering": [
+        "RACK_ELEVATION_DEFAULT_UNIT_HEIGHT",
+        "RACK_ELEVATION_DEFAULT_UNIT_WIDTH",
+        "RACK_ELEVATION_UNIT_TWO_DIGIT_FORMAT",
+    ],
     "Release Checking": ["RELEASE_CHECK_URL", "RELEASE_CHECK_TIMEOUT"],
     "User Interface": ["SUPPORT_MESSAGE"],
     "Debugging": ["ALLOW_REQUEST_PROFILING"],
@@ -914,7 +934,7 @@ CELERY_TASK_TIME_LIMIT = int(os.getenv("NAUTOBOT_CELERY_TASK_TIME_LIMIT", str(10
 CELERY_WORKER_PROMETHEUS_PORTS = []
 if os.getenv("NAUTOBOT_CELERY_WORKER_PROMETHEUS_PORTS"):
     CELERY_WORKER_PROMETHEUS_PORTS = [
-        int(value) for value in os.getenv("NAUTOBOT_CELERY_WORKER_PROMETHEUS_PORTS").split(",")
+        int(value) for value in os.getenv("NAUTOBOT_CELERY_WORKER_PROMETHEUS_PORTS").split(_CONFIG_SETTING_SEPARATOR)
     ]
 
 # These settings define the custom nautobot serialization encoding as an accepted data encoding format

nautobot/core/settings.yaml

@@ -1171,6 +1171,19 @@ properties:
       "Guide to Nautobot Prometheus metrics": "../guides/prometheus-metrics.md"
     type: "boolean"
     version_added: "2.1.5"
+  METRICS_DISABLED_APPS:
+    default: []
+    description: >-
+      A list of app names for which Prometheus metrics should be disabled.
+      (If provided as an environment variable, it should be a comma-separated string, for example
+      `NAUTOBOT_METRICS_DISABLED_APPS="nautobot_ssot, nautobot_device_lifecycle_mgmt"`.)
+    environment_variable: "NAUTOBOT_METRICS_DISABLED_APPS"
+    items:
+      type: "string"
+    see_also:
+      "Guide to Nautobot Prometheus metrics": "../guides/prometheus-metrics.md"
+    type: "array"
+    version_added: "2.2.1"
   METRICS_ENABLED:
     default: false
     description: "Toggle the availability of Prometheus-compatible metrics at `/metrics`."
@@ -1376,6 +1389,13 @@ properties:
     environment_variable: "NAUTOBOT_RACK_ELEVATION_DEFAULT_UNIT_WIDTH"
     is_constance_config: true
     type: "integer"
+  RACK_ELEVATION_UNIT_TWO_DIGIT_FORMAT:
+    default: false
+    description: "Enables two-digit format for the rack unit numbering in a rack elevation diagram."
+    environment_variable: "NAUTOBOT_RACK_ELEVATION_UNIT_TWO_DIGIT_FORMAT"
+    is_constance_config: true
+    type: "boolean"
+    version_added: "2.2.1"
   REDIS_LOCK_TIMEOUT:
     default: 600
     description: >-

nautobot/core/signals.py

@@ -1,4 +1,5 @@
 """Custom signals and handlers for the core Nautobot application."""
+
 import contextlib
 from functools import wraps
 import inspect

nautobot/core/templates/generic/object_retrieve.html

@@ -87,7 +87,7 @@
                 Advanced
             </a>
         </li>
-        {% if is_contact_associatable_model %}
+        {% if object.is_contact_associable_model %}
             <li role="presentation"{% if request.GET.tab == 'contacts' %} class="active"{% endif %}>
                 <a href="{{ object.get_absolute_url }}#contacts" onclick="switch_tab(this.href)" aria-controls="contacts" role="tab" data-toggle="tab">
                     Contacts
@@ -159,7 +159,7 @@
                 </div>
             </div>
         </div>
-        {% if is_contact_associatable_model %}
+        {% if object.is_contact_associable_model %}
             <div id="contacts" role="tabpanel" class="tab-pane {% if request.GET.tab == 'contacts' %}active{% else %}fade{% endif %}">
                 <div class="row">
                     <div class="col-md-12">

nautobot/core/templates/inc/javascript.html

@@ -2,10 +2,10 @@
 {% load plugins %}
 {% load static %}
 
-<script src="{% static 'jquery/jquery-3.6.0.min.js' %}"
-        onerror="window.location='{% url 'media_failure' %}?filename=jquery/jquery-3.6.0.min.js'"></script>
-<script src="{% static 'jquery-ui-1.13.1/jquery-ui.min.js' %}"
-        onerror="window.location='{% url 'media_failure' %}?filename=jquery-ui-1.13.1/jquery-ui.min.js'"></script>
+<script src="{% static 'jquery/jquery-3.7.1.min.js' %}"
+        onerror="window.location='{% url 'media_failure' %}?filename=jquery/jquery-3.7.1.min.js'"></script>
+<script src="{% static 'jquery-ui-1.13.2/jquery-ui.min.js' %}"
+        onerror="window.location='{% url 'media_failure' %}?filename=jquery-ui-1.13.2/jquery-ui.min.js'"></script>
 <script src="{% static 'bootstrap-3.4.1-dist/js/bootstrap.min.js' %}"
         onerror="window.location='{% url 'media_failure' %}?filename=bootstrap-3.4.1-dist/js/bootstrap.min.js'"></script>
 <script src="{% static 'select2-4.0.13/select2.min.js' %}"

nautobot/core/templates/inc/media.html

@@ -11,8 +11,8 @@
           href="{% static 'materialdesignicons-6.5.95/css/materialdesignicons.min.css' %}"
           onerror="window.location='{% url 'media_failure' %}?filename=materialdesignicons-6.5.95/css/materialdesignicons.min.css'">
     <link rel="stylesheet"
-          href="{% static 'jquery-ui-1.13.1/jquery-ui.min.css' %}"
-          onerror="window.location='{% url 'media_failure' %}?filename=jquery-ui-1.13.1/jquery-ui.min.css'">
+          href="{% static 'jquery-ui-1.13.2/jquery-ui.min.css' %}"
+          onerror="window.location='{% url 'media_failure' %}?filename=jquery-ui-1.13.2/jquery-ui.min.css'">
     <link rel="stylesheet"
           href="{% static 'select2-4.0.13/select2.min.css' %}"
           onerror="window.location='{% url 'media_failure' %}?filename=select2-4.0.13/select2.min.css'">

nautobot/core/templates/nautobot_config.py.j2

@@ -415,6 +415,11 @@ INSTALLATION_METRICS_ENABLED = is_truthy(os.getenv("NAUTOBOT_INSTALLATION_METRIC
 #
 # METRICS_AUTHENTICATED = is_truthy(os.getenv("NAUTOBOT_METRICS_AUTHENTICATED", "False"))
 
+# Disable app metrics for specific apps
+#
+# if "NAUTOBOT_METRICS_DISABLED_APPS" in os.environ and os.environ["NAUTOBOT_METRICS_DISABLED_APPS"] != "":
+#     METRICS_DISABLED_APPS = os.getenv("NAUTOBOT_METRICS_DISABLED_APPS", "").split(",")
+
 # Credentials that Nautobot will uses to authenticate to devices when connecting via NAPALM.
 #
 # NAPALM_USERNAME = os.getenv("NAUTOBOT_NAPALM_USERNAME", "")
@@ -472,6 +477,14 @@ INSTALLATION_METRICS_ENABLED = is_truthy(os.getenv("NAUTOBOT_INSTALLATION_METRIC
 # ):
 #     RACK_ELEVATION_DEFAULT_UNIT_WIDTH = int(os.environ["NAUTOBOT_RACK_ELEVATION_DEFAULT_UNIT_WIDTH"])
 
+# Enable two-digit format for the rack unit numbering in rack elevations.
+#
+# if (
+#     "NAUTOBOT_RACK_ELEVATION_UNIT_TWO_DIGIT_FORMAT" in os.environ
+#      and os.environ["NAUTOBOT_RACK_ELEVATION_UNIT_TWO_DIGIT_FORMAT"] != ""
+# ):
+#     RACK_ELEVATION_UNIT_TWO_DIGIT_FORMAT = is_truthy(os.environ["NAUTOBOT_RACK_ELEVATION_UNIT_TWO_DIGIT_FORMAT"])
+
 # Sets an age out timer of redis lock. This is NOT implicitly applied to locks, must be added
 # to a lock creation as `timeout=settings.REDIS_LOCK_TIMEOUT`
 #
@@ -509,7 +522,7 @@ INSTALLATION_METRICS_ENABLED = is_truthy(os.getenv("NAUTOBOT_INSTALLATION_METRIC
 # class path of the storage driver in STORAGE_BACKEND and any configuration options in STORAGE_CONFIG.
 # These default to None and {} respectively.
 #
-# STORAGE_BACKEND = 'storages.backends.s3boto3.S3Boto3Storage'
+# STORAGE_BACKEND = 'storages.backends.s3.S3Storage'
 # STORAGE_CONFIG = {
 #     'AWS_ACCESS_KEY_ID': 'Key ID',
 #     'AWS_SECRET_ACCESS_KEY': 'Secret',

nautobot/core/testing/__init__.py

@@ -109,7 +109,7 @@ def get_job_class_and_model(module, name, source="local"):
 
 
 @tag("unit")
-class TransactionTestCase(_TransactionTestCase, NautobotTestCaseMixin):
+class TransactionTestCase(NautobotTestCaseMixin, _TransactionTestCase):
     """
     Base test case class using the TransactionTestCase for unit testing
     """

nautobot/core/testing/filters.py

@@ -44,7 +44,7 @@ class FilterTestCases:
                 # randomly break out of loop after 2 values have been selected
                 if len(test_values) > 1 and random.choice([True, False]):  # noqa: S311  # suspicious-non-cryptographic-random-usage
                     break
-                if value[field_name] and value["count"] <= qs_count:
+                if value[field_name] and value["count"] < qs_count:
                     qs_count -= value["count"]
                     test_values.append(str(value[field_name]))
 

nautobot/core/tests/integration/test_view_authentication.py

@@ -54,6 +54,7 @@ class AuthenticationEnforcedTestCase(TestCase):
                         url.startswith(path)
                         for path in [
                             "/complete/",  # social auth
+                            "/health/string/",  # health-check
                             "/login/",  # social auth
                             "/media/",  # MEDIA_ROOT
                             "/plugins/example-app/docs/",  # STATIC_ROOT

nautobot/core/tests/test_views.py

@@ -2,6 +2,7 @@ import re
 from unittest import mock
 import urllib.parse
 
+from django.apps import apps
 from django.contrib.contenttypes.models import ContentType
 from django.core.files.uploadedfile import SimpleUploadedFile
 from django.test import override_settings, RequestFactory
@@ -9,6 +10,7 @@ from django.test.utils import override_script_prefix
 from django.urls import get_script_prefix, reverse
 from prometheus_client.parser import text_string_to_metric_families
 
+from nautobot.core.constants import GLOBAL_SEARCH_EXCLUDE_LIST
 from nautobot.core.testing import TestCase
 from nautobot.core.testing.api import APITestCase
 from nautobot.core.utils.permissions import get_permission_for_model
@@ -71,6 +73,26 @@ class HomeViewTestCase(TestCase):
         response = self.client.get(f"{url}?{urllib.parse.urlencode(params)}")
         self.assertHttpStatus(response, 200)
 
+    def test_appropriate_models_included_in_global_search(self):
+        # Gather core app configs
+        existing_models = []
+        global_searchable_models = []
+        for app_name in ["circuits", "dcim", "extras", "ipam", "tenancy", "virtualization"]:
+            app_config = apps.get_app_config(app_name)
+            existing_models += [model._meta.model_name for model in app_config.get_models()]
+            global_searchable_models += app_config.searchable_models
+
+        # Remove those models that are not searchable
+        existing_models = [model for model in existing_models if model not in GLOBAL_SEARCH_EXCLUDE_LIST]
+        existing_models.sort()
+
+        # See if there are any models that are missing from global search
+        difference = [model for model in existing_models if model not in global_searchable_models]
+        if difference:
+            self.fail(
+                f'Existing model/models {",".join(difference)} are not included in the searchable_models attribute of the app config.\nIf you do not want the models to be searchable, please include them in the GLOBAL_SEARCH_EXCLUDE_LIST constant in nautobot.core.constants.'
+            )
+
     def make_request(self):
         url = reverse("home")
         response = self.client.get(url)

nautobot/core/utils/data.py

@@ -51,8 +51,7 @@ def flatten_iterable(iterable):
     """
     for i in iterable:
         if hasattr(i, "__iter__") and not isinstance(i, str):
-            for j in flatten_iterable(i):
-                yield j
+            yield from flatten_iterable(i)
         else:
             yield i
 

nautobot/core/utils/lookup.py

@@ -335,6 +335,8 @@ def get_url_for_url_pattern(url_pattern):
     url = re.sub(r"<str:\w+>", "string", url)
     # "/dcim/locations/<uuid:pk>/"
     url = re.sub(r"<uuid:\w+>", "00000000-0000-0000-0000-000000000000", url)
+    # "/api/circuits/<drf_format_suffix:format>"
+    url = re.sub(r"<drf_format_suffix:\w+>", ".json", url)
     # tokens in regexp-style router urls, including REST and NautobotUIViewSet:
     # "/extras/^external-integrations/(?P<pk>[^/.]+)/$"
     # "/api/virtualization/^interfaces/(?P<pk>[^/.]+)/$"

nautobot/core/views/generic.py

@@ -77,7 +77,6 @@ class ObjectView(ObjectPermissionRequiredMixin, View):
 
     queryset = None
     template_name = None
-    is_contact_associatable_model = True
 
     def get_required_permission(self):
         return get_permission_for_model(self.queryset.model, "view")
@@ -136,7 +135,6 @@ class ObjectView(ObjectPermissionRequiredMixin, View):
             content_type = ContentType.objects.get_for_model(self.queryset.model)
             context = {
                 "object": instance,
-                "is_contact_associatable_model": self.is_contact_associatable_model,
                 "content_type": content_type,
                 "verbose_name": self.queryset.model._meta.verbose_name,
                 "verbose_name_plural": self.queryset.model._meta.verbose_name_plural,
@@ -144,7 +142,7 @@ class ObjectView(ObjectPermissionRequiredMixin, View):
                 "last_updated_by": last_updated_by,
                 **self.get_extra_context(request, instance),
             }
-            if self.is_contact_associatable_model:
+            if instance.is_contact_associable_model:
                 paginate = {"paginator_class": EnhancedPaginator, "per_page": get_paginate_count(request)}
                 associations = (
                     ContactAssociation.objects.filter(

nautobot/core/views/mixins.py

@@ -226,7 +226,6 @@ class NautobotViewSetMixin(GenericViewSet, AccessMixin, GetReturnURLMixin, FormV
     create_form_class = None
     update_form_class = None
     parser_classes = [FormParser, MultiPartParser]
-    is_contact_associatable_model = True
     queryset = None
     # serializer_class has to be specified to eliminate the need to override retrieve() in the RetrieveModelMixin for now.
     serializer_class = None

nautobot/core/views/renderers.py

@@ -145,7 +145,6 @@ class NautobotHTMLRenderer(renderers.BrowsableAPIRenderer):
         view = renderer_context["view"]
         request = renderer_context["request"]
         # Check if queryset attribute is set before doing anything
-        is_contact_associatable_model = view.is_contact_associatable_model
         queryset = view.alter_queryset(request)
         model = queryset.model
         form_class = view.get_form_class()
@@ -222,7 +221,6 @@ class NautobotHTMLRenderer(renderers.BrowsableAPIRenderer):
 
         context = {
             "content_type": content_type,
-            "is_contact_associatable_model": is_contact_associatable_model,
             "form": form,
             "filter_form": filter_form,
             "dynamic_filter_form": self.get_dynamic_filter_form(view, request, filterset_class=view.filterset_class),
@@ -244,9 +242,13 @@ class NautobotHTMLRenderer(renderers.BrowsableAPIRenderer):
 
             context["created_by"] = created_by
             context["last_updated_by"] = last_updated_by
-            associated_contacts = instance.associated_contacts.restrict(request.user, "view").order_by("role__name")
-            if is_contact_associatable_model:
-                context["associated_contacts_table"] = AssociatedContactsTable(data=associated_contacts)
+            if instance.is_contact_associable_model:
+                paginate = {"paginator_class": EnhancedPaginator, "per_page": get_paginate_count(request)}
+                associations = instance.associated_contacts.restrict(request.user, "view").order_by("role__name")
+                associations_table = AssociatedContactsTable(associations, orderable=False)
+                RequestConfig(request, paginate).configure(associations_table)
+                associations_table.columns.show("pk")
+                context["associated_contacts_table"] = associations_table
             else:
                 context["associated_contacts_table"] = None
             context.update(view.get_extra_context(request, instance))