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

nautobot/core/tests/test_api.py

@@ -770,6 +770,7 @@ class APIOrderingTestCase(testing.APITestCase):
             "TextField": "admin_contact",
             "DateTimeField": "created",
         }
+        cls.maxDiff = None
 
     def _validate_sorted_response(self, response, queryset, field_name, is_fk_field=False):
         self.assertHttpStatus(response, 200)
@@ -794,18 +795,24 @@ class APIOrderingTestCase(testing.APITestCase):
         """Tests that results are returned in the expected ascending order."""
 
         for field_type, field_name in self.field_type_map.items():
-            with self.subTest(f"Testing {field_type}"):
-                response = self.client.get(f"{self.url}?sort={field_name}&limit=10", **self.header)
-                self._validate_sorted_response(response, Provider.objects.all().order_by(field_name), field_name)
+            with self.subTest(f"Testing {field_type} {field_name}"):
+                # Use `name` as a secondary sort as fields like `asn` and `admin_contact` may be null
+                response = self.client.get(f"{self.url}?sort={field_name},name&limit=10", **self.header)
+                self._validate_sorted_response(
+                    response, Provider.objects.all().order_by(field_name, "name"), field_name
+                )
 
     @override_settings(EXEMPT_VIEW_PERMISSIONS=["*"])
     def test_descending_sort(self):
         """Tests that results are returned in the expected descending order."""
 
         for field_type, field_name in self.field_type_map.items():
-            with self.subTest(f"Testing {field_type}"):
-                response = self.client.get(f"{self.url}?sort=-{field_name}&limit=10", **self.header)
-                self._validate_sorted_response(response, Provider.objects.all().order_by(f"-{field_name}"), field_name)
+            with self.subTest(f"Testing {field_type} {field_name}"):
+                # Use `name` as a secondary sort as fields like `asn` and `admin_contact` may be null
+                response = self.client.get(f"{self.url}?sort=-{field_name},name&limit=10", **self.header)
+                self._validate_sorted_response(
+                    response, Provider.objects.all().order_by(f"-{field_name}", "name"), field_name
+                )
 
     @override_settings(EXEMPT_VIEW_PERMISSIONS=["*"])
     def test_sorting_tree_node_models(self):

nautobot/core/tests/test_csv.py

@@ -4,7 +4,7 @@ from django.urls import reverse
 
 from nautobot.core.constants import CSV_NO_OBJECT, CSV_NULL_TYPE, VARBINARY_IP_FIELD_REPR_OF_CSV_NO_OBJECT
 from nautobot.dcim.api.serializers import DeviceSerializer
-from nautobot.dcim.models.devices import Device, DeviceType
+from nautobot.dcim.models.devices import Controller, Device, DeviceType
 from nautobot.dcim.models.locations import Location
 from nautobot.extras.models.roles import Role
 from nautobot.extras.models.statuses import Status
@@ -25,6 +25,7 @@ class CSVParsingRelatedTestCase(TestCase):
         devicerole = Role.objects.get_for_model(Device).first()
         device_status = Status.objects.get_for_model(Device).first()
         tags = Tag.objects.get_for_model(Device).all()[:3]
+        Controller.objects.filter(controller_device__isnull=False).delete()
         Device.objects.all().delete()
         self.device = Device.objects.create(
             device_type=devicetype,
@@ -92,7 +93,7 @@ class CSVParsingRelatedTestCase(TestCase):
                 "primary_ip6__host",
                 "cluster__name",
                 "virtual_chassis__name",
-                "controller_device_group__name",
+                "controller_managed_device_group__name",
                 "device_redundancy_group__name",
                 "software_version__platform__name",
                 "software_version__version",
@@ -119,7 +120,7 @@ class CSVParsingRelatedTestCase(TestCase):
                 "primary_ip6",
                 "cluster",
                 "virtual_chassis",
-                "controller_device_group",
+                "controller_managed_device_group",
                 "device_redundancy_group",
                 "secrets_group",
             ]
@@ -224,7 +225,7 @@ class CSVParsingRelatedTestCase(TestCase):
                 "primary_ip6__host": CSV_NO_OBJECT,
                 "cluster__name": CSV_NO_OBJECT,
                 "virtual_chassis__name": CSV_NO_OBJECT,
-                "controller_device_group__name": CSV_NO_OBJECT,
+                "controller_managed_device_group__name": CSV_NO_OBJECT,
                 "device_redundancy_group__name": CSV_NO_OBJECT,
                 "software_version__platform__name": CSV_NO_OBJECT,
                 "software_version__version": CSV_NO_OBJECT,

nautobot/core/tests/test_filters.py

@@ -17,7 +17,7 @@ from nautobot.core.constants import CHARFIELD_MAX_LENGTH
 from nautobot.core.models import fields as core_fields
 from nautobot.core.utils import lookup
 from nautobot.dcim import choices as dcim_choices, filters as dcim_filters, models as dcim_models
-from nautobot.dcim.models import Device
+from nautobot.dcim.models import Controller, Device
 from nautobot.extras import models as extras_models
 from nautobot.extras.utils import FeatureQuery
 from nautobot.ipam import models as ipam_models
@@ -830,6 +830,7 @@ class DynamicFilterLookupExpressionTest(TestCase):
     @classmethod
     def setUpTestData(cls):
         manufacturers = dcim_models.Manufacturer.objects.all()[:3]
+        Controller.objects.filter(controller_device__isnull=False).delete()
         Device.objects.all().delete()
 
         device_types = (

nautobot/core/tests/test_graphql.py

@@ -43,6 +43,7 @@ from nautobot.dcim.models import (
     Cable,
     ConsolePort,
     ConsoleServerPort,
+    Controller,
     Device,
     DeviceType,
     FrontPort,
@@ -630,21 +631,9 @@ class GraphQLAPIPermissionTest(GraphQLTestCaseBase):
         self.assertEqual(names, ["Rack 1-1", "Rack 1-2", "Rack 2-1", "Rack 2-2"])
 
     def test_graphql_api_no_token(self):
-        """Validate unauthenticated users are not able to query anything by default."""
+        """Validate unauthenticated users are not able to query anything."""
         response = self.client.post(self.api_url, {"query": self.get_racks_query}, format="json")
-        self.assertEqual(response.status_code, status.HTTP_200_OK)
-        self.assertIsInstance(response.data["data"]["racks"], list)
-        names = [item["name"] for item in response.data["data"]["racks"]]
-        self.assertEqual(names, [])
-
-    @override_settings(EXEMPT_VIEW_PERMISSIONS=["*"])
-    def test_graphql_api_no_token_exempt(self):
-        """Validate unauthenticated users are able to query based on the exempt permissions."""
-        response = self.client.post(self.api_url, {"query": self.get_racks_query}, format="json")
-        self.assertEqual(response.status_code, status.HTTP_200_OK)
-        self.assertIsInstance(response.data["data"]["racks"], list)
-        names = [item["name"] for item in response.data["data"]["racks"]]
-        self.assertEqual(names, ["Rack 1-1", "Rack 1-2", "Rack 2-1", "Rack 2-2"])
+        self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
 
     def test_graphql_api_wrong_token(self):
         """Validate a wrong token return 403."""
@@ -721,6 +710,7 @@ class GraphQLQueryTest(GraphQLTestCaseBase):
 
         # Remove random IPAddress and Device fixtures for this custom test
         IPAddress.objects.all().delete()
+        Controller.objects.filter(controller_device__isnull=False).delete()
         Device.objects.all().delete()
 
         # Initialize fake request that will be required to execute GraphQL query

nautobot/core/tests/test_navigations.py

@@ -44,6 +44,8 @@ class NavMenuTestCase(TestCase):
                                     expected_name = "Interfaces"
                                 elif expected_name == "Object Changes":
                                     expected_name = "Change Log"
+                                elif expected_name == "Controller Managed Device Groups":
+                                    expected_name = "Managed Device Groups"
                                 self.assertEqual(item_details["name"], expected_name)
                             if item_url == get_route_for_model(view_model, "list"):
                                 # Not assertEqual as some menu items have additional permissions defined.
@@ -87,6 +89,7 @@ class NavMenuTestCase(TestCase):
             self.assertEqual(expected_perms[tab_name], tab_details["permissions"])
 
 
+@tag("unit")
 class NewUINavTest(TestCase):
     @patch.dict(registry, values={"new_ui_nav_menu": {}}, clear=True)
     def test_build_new_ui_nav_menu(self):

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)
@@ -305,25 +327,31 @@ class LoginUITestCase(TestCase):
         sso_login_search_result = self.make_request()
         self.assertIsNotNone(sso_login_search_result)
 
-    @override_settings(BANNER_TOP="Hello, Banner Top", BANNER_BOTTOM="Hello, Banner Bottom")
-    def test_routes_redirect_back_to_login_unauthenticated(self):
-        """Assert that api docs and graphql redirects to login page if user is unauthenticated."""
+    def test_graphql_redirects_back_to_login_unauthenticated(self):
+        """Assert that graphql redirects to login page if user is unauthenticated."""
         self.client.logout()
         headers = {"HTTP_ACCEPT": "text/html"}
-        urls = [reverse("api_docs"), reverse("graphql")]
+        url = reverse("graphql")
+        response = self.client.get(url, follow=True, **headers)
+        self.assertHttpStatus(response, 200)
+        self.assertRedirects(response, f"/login/?next={url}")
+        response_content = response.content.decode(response.charset).replace("\n", "")
+        for footer_text in self.footer_elements:
+            self.assertNotIn(footer_text, response_content)
+
+    def test_api_docs_403_unauthenticated(self):
+        """Assert that api docs return a 403 Forbidden if user is unauthenticated."""
+        self.client.logout()
+        urls = [
+            reverse("api_docs"),
+            reverse("api_redocs"),
+            reverse("schema"),
+            reverse("schema_json"),
+            reverse("schema_yaml"),
+        ]
         for url in urls:
-            response = self.client.get(url, follow=True, **headers)
-            self.assertHttpStatus(response, 200)
-            redirect_chain = [(f"/login/?next={url}", 302)]
-            self.assertEqual(response.redirect_chain, redirect_chain)
-            response_content = response.content.decode(response.charset).replace("\n", "")
-            # Assert Footer items(`self.footer_elements`), Banner and Banner Top is hidden
-            for footer_text in self.footer_elements:
-                self.assertNotIn(footer_text, response_content)
-            # Only API Docs implements BANNERS
-            if url == urls[0]:
-                self.assertNotIn("Hello, Banner Top", response_content)
-                self.assertNotIn("Hello, Banner Bottom", response_content)
+            response = self.client.get(url)
+            self.assertHttpStatus(response, 403)
 
 
 class MetricsViewTestCase(TestCase):

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

@@ -1,12 +1,14 @@
 """Utilities for looking up related classes and information."""
 
 import inspect
+import re
 
 from django.apps import apps
 from django.conf import settings
 from django.contrib.auth.models import Group
 from django.contrib.contenttypes.models import ContentType
 from django.db.models import Model
+from django.urls import get_resolver, URLPattern, URLResolver
 from django.utils.module_loading import import_string
 
 
@@ -232,3 +234,127 @@ def get_created_and_last_updated_usernames_for_model(instance):
         last_updated_by = last_updated_by_record.user_name
 
     return created_by, last_updated_by
+
+
+def get_url_patterns(urlconf=None, patterns_list=None, base_path="/"):
+    """
+    Recursively yield a list of registered URL patterns.
+
+    Args:
+        urlconf (URLConf): Python module such as `nautobot.core.urls`.
+            Default if unspecified is the value of `settings.ROOT_URLCONF`, i.e. the `nautobot.core.urls` module.
+        patterns_list (list): Used in recursion. Generally can be omitted on initial call.
+            Default if unspecified is the `url_patterns` attribute of the given `urlconf` module.
+        base_path (str): String to prepend to all URL patterns yielded.
+            Default if unspecified is the string `"/"`.
+
+    Yields:
+        (str): Each URL pattern defined in the given urlconf and its descendants
+
+    Examples:
+        >>> generator = get_url_patterns()
+        >>> next(generator)
+        '/'
+        >>> next(generator)
+        '/search/'
+        >>> next(generator)
+        '/login/'
+        >>> next(generator)
+        '/logout/'
+        >>> next(generator)
+        '/circuits/circuits/<uuid:pk>/terminations/swap/'
+
+        >>> import example_plugin.urls as example_urls
+        >>> for url_pattern in get_url_patterns(example_urls, base_path="/plugins/example-app/"):
+        ...     print(url_pattern)
+        ...
+        /plugins/example-app/
+        /plugins/example-app/config/
+        /plugins/example-app/models/<uuid:pk>/dynamic-groups/
+        /plugins/example-app/other-models/<uuid:pk>/dynamic-groups/
+        /plugins/example-app/docs/
+        /plugins/example-app/circuits/<uuid:pk>/example-app-tab/
+        /plugins/example-app/devices/<uuid:pk>/example-app-tab-1/
+        /plugins/example-app/devices/<uuid:pk>/example-app-tab-2/
+        /plugins/example-app/override-target/
+        /plugins/example-app/^models/$
+        /plugins/example-app/^models/add/$
+        /plugins/example-app/^models/import/$
+        /plugins/example-app/^models/edit/$
+        /plugins/example-app/^models/delete/$
+        /plugins/example-app/^models/all-names/$
+        /plugins/example-app/^models/(?P<pk>[^/.]+)/$
+        /plugins/example-app/^models/(?P<pk>[^/.]+)/delete/$
+        /plugins/example-app/^models/(?P<pk>[^/.]+)/edit/$
+        /plugins/example-app/^models/(?P<pk>[^/.]+)/changelog/$
+        /plugins/example-app/^models/(?P<pk>[^/.]+)/notes/$
+        /plugins/example-app/^other-models/$
+        /plugins/example-app/^other-models/add/$
+        /plugins/example-app/^other-models/edit/$
+        /plugins/example-app/^other-models/delete/$
+        /plugins/example-app/^other-models/(?P<pk>[^/.]+)/$
+        /plugins/example-app/^other-models/(?P<pk>[^/.]+)/delete/$
+        /plugins/example-app/^other-models/(?P<pk>[^/.]+)/edit/$
+        /plugins/example-app/^other-models/(?P<pk>[^/.]+)/changelog/$
+        /plugins/example-app/^other-models/(?P<pk>[^/.]+)/notes/$
+    """
+    if urlconf is None:
+        urlconf = settings.ROOT_URLCONF
+    if patterns_list is None:
+        patterns_list = get_resolver(urlconf).url_patterns
+
+    for item in patterns_list:
+        if isinstance(item, URLPattern):
+            yield base_path + str(item.pattern)
+        elif isinstance(item, URLResolver):
+            # Recurse!
+            yield from get_url_patterns(urlconf, item.url_patterns, base_path + str(item.pattern))
+
+
+def get_url_for_url_pattern(url_pattern):
+    """
+    Given a URL pattern, construct a URL string that would match that pattern.
+
+    Examples:
+        >>> get_url_for_url_pattern("/plugins/example-app/^models/(?P<pk>[^/.]+)/$")
+        '/plugins/example-app/models/00000000-0000-0000-0000-000000000000/'
+        >>> get_url_for_url_pattern("/circuits/circuit-terminations/<uuid:termination_a_id>/connect/<str:termination_b_type>/")
+        '/circuits/circuit-terminations/00000000-0000-0000-0000-000000000000/connect/string/'
+    """
+    url = url_pattern
+    # Fixup tokens in path-style "classic" view URLs:
+    # "/admin/users/user/<id>/password/"
+    url = re.sub(r"<id>", "00000000-0000-0000-0000-000000000000", url)
+    # "/silk/request/<uuid:request_id>/profile/<int:profile_id>/"
+    url = re.sub(r"<int:\w+>", "1", url)
+    # "/admin/admin/logentry/<path:object_id>/"
+    url = re.sub(r"<path:\w+>", "1", url)
+    # "/dcim/sites/<slug:slug>/"
+    url = re.sub(r"<slug:\w+>", "slug", url)
+    # "/apps/installed-apps/<str:app>/"
+    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>[^/.]+)/$"
+    # "/api/virtualization/^interfaces/(?P<pk>[^/.]+)\\.(?P<format>[a-z0-9]+)/?$"
+    url = re.sub(r"[$^]", "", url)
+    url = re.sub(r"/\?", "/", url)
+    url = re.sub(r"\(\?P<app_label>[^)]+\)", "users", url)
+    url = re.sub(r"\(\?P<class_path>[^)]+\)", "foo/bar/baz", url)
+    url = re.sub(r"\(\?P<format>[^)]+\)", "json", url)
+    url = re.sub(r"\(\?P<name>[^)]+\)", "string", url)
+    url = re.sub(r"\(\?P<pk>[^)]+\)", "00000000-0000-0000-0000-000000000000", url)
+    url = re.sub(r"\(\?P<slug>[^)]+\)", "string", url)
+    url = re.sub(r"\(\?P<url>[^)]+\)", "any", url)
+    # Fallthru for generic URL parameters
+    url = re.sub(r"\(\?P<\w+>[^)]+\)\??", "unknown", url)
+    url = re.sub(r"\\", "", url)
+
+    if any(char in url for char in "<>[]()?+^$"):
+        raise RuntimeError(f"Unhandled token in URL {url} derived from {url_pattern}")
+
+    return url

nautobot/core/views/__init__.py

@@ -11,7 +11,7 @@ from django.contrib.auth.decorators import permission_required
 from django.contrib.auth.mixins import AccessMixin, LoginRequiredMixin
 from django.contrib.contenttypes.models import ContentType
 from django.http import HttpResponseForbidden, HttpResponseServerError, JsonResponse
-from django.shortcuts import get_object_or_404, redirect, render
+from django.shortcuts import get_object_or_404, render
 from django.template import loader, RequestContext, Template
 from django.template.exceptions import TemplateDoesNotExist
 from django.urls import resolve, reverse
@@ -210,7 +210,7 @@ class SearchView(AccessMixin, View):
         )
 
 
-class StaticMediaFailureView(View):
+class StaticMediaFailureView(View):  # NOT using LoginRequiredMixin here as this may happen even on the login page
     """
     Display a user-friendly error message with troubleshooting tips when a static media file fails to load.
     """
@@ -265,12 +265,8 @@ def csrf_failure(request, reason="", template_name="403_csrf_failure.html"):
     return HttpResponseForbidden(t.render(context), content_type="text/html")
 
 
-class CustomGraphQLView(GraphQLView):
+class CustomGraphQLView(LoginRequiredMixin, GraphQLView):
     def render_graphiql(self, request, **data):
-        if not request.user.is_authenticated:
-            graphql_url = reverse("graphql")
-            login_url = reverse(settings.LOGIN_URL)
-            return redirect(f"{login_url}?next={graphql_url}")
         query_name = request.GET.get("name")
         if query_name:
             data["obj"] = GraphQLQuery.objects.get(name=query_name)

nautobot/core/views/generic.py

@@ -4,6 +4,7 @@ import re
 
 from django.conf import settings
 from django.contrib import messages
+from django.contrib.auth.mixins import LoginRequiredMixin
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import (
     FieldDoesNotExist,
@@ -58,6 +59,14 @@ from nautobot.extras.tables import AssociatedContactsTable
 from nautobot.extras.utils import remove_prefix_from_cf_key
 
 
+class GenericView(LoginRequiredMixin, View):
+    """
+    Base class for non-object-related views.
+
+    Enforces authentication, which Django's base View does not by default.
+    """
+
+
 class ObjectView(ObjectPermissionRequiredMixin, View):
     """
     Retrieve a single object for display.
@@ -68,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")
@@ -127,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,
@@ -135,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(
@@ -220,6 +227,7 @@ class ObjectListView(ObjectPermissionRequiredMixin, View):
         display_filter_params = []
         dynamic_filter_form = None
         filter_form = None
+        hide_hierarchy_ui = False
 
         if self.filterset:
             filter_params = self.get_filter_params(request)
@@ -232,6 +240,12 @@ class ObjectListView(ObjectPermissionRequiredMixin, View):
                 )
                 self.queryset = self.queryset.none()
 
+            # If a valid filterset is applied, we have to hide the hierarchy indentation in the UI for tables that support hierarchy indentation.
+            # NOTE: An empty filterset query-param is also valid filterset and we dont want to hide hierarchy indentation if no filter query-param is provided
+            #      hence `filterset.data`.
+            if filterset.is_valid() and filterset.data:
+                hide_hierarchy_ui = True
+
             display_filter_params = [
                 check_filter_for_display(filterset.filters, field_name, values)
                 for field_name, values in filter_params.items()
@@ -283,9 +297,9 @@ class ObjectListView(ObjectPermissionRequiredMixin, View):
         table_config_form = None
         if self.table:
             # Construct the objects table
-            # Order By is needed in the table `__init__` method
-            order_by = self.request.GET.getlist("sort")
-            table = self.table(self.queryset, user=request.user, order_by=order_by)
+            if self.request.GET.getlist("sort"):
+                hide_hierarchy_ui = True  # hide tree hierarchy if custom sort is used
+            table = self.table(self.queryset, user=request.user, hide_hierarchy_ui=hide_hierarchy_ui)
             if "pk" in table.base_columns and (permissions["change"] or permissions["delete"]):
                 table.columns.show("pk")
 

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
@@ -608,6 +607,7 @@ class ObjectListViewMixin(NautobotViewSetMixin, mixins.ListModelMixin):
     action_buttons = ("add", "import", "export")
     filterset_class = None
     filterset_form_class = None
+    hide_hierarchy_ui = False
     non_filter_params = (
         "export",  # trigger for CSV/export-template/YAML export # 3.0 TODO: remove, irrelevant after #4746
         "page",  # used by django-tables2.RequestConfig
@@ -629,6 +629,12 @@ class ObjectListViewMixin(NautobotViewSetMixin, mixins.ListModelMixin):
                     format_html("Invalid filters were specified: {}", self.filterset.errors),
                 )
                 queryset = queryset.none()
+
+            # If a valid filterset is applied, we have to hide the hierarchy indentation in the UI for tables that support hierarchy indentation.
+            # NOTE: An empty filterset query-param is also valid filterset and we dont want to hide hierarchy indentation if no filter query-param is provided
+            #      hence `filterset.data`.
+            if self.filterset.is_valid() and self.filterset.data:
+                self.hide_hierarchy_ui = True
         return queryset
 
     # 3.0 TODO: remove, irrelevant after #4746

nautobot/core/views/renderers.py

@@ -65,10 +65,13 @@ class NautobotHTMLRenderer(renderers.BrowsableAPIRenderer):
         table_class = view.get_table_class()
         request = kwargs.get("request", view.request)
         queryset = view.alter_queryset(request)
+
         if view.action in ["list", "notes", "changelog"]:
             if view.action == "list":
                 permissions = kwargs.get("permissions", {})
-                table = table_class(queryset, user=request.user)
+                if view.request.GET.getlist("sort"):
+                    view.hide_hierarchy_ui = True  # hide tree hierarchy if custom sort is used
+                table = table_class(queryset, user=request.user, hide_hierarchy_ui=view.hide_hierarchy_ui)
                 if "pk" in table.base_columns and (permissions["change"] or permissions["delete"]):
                     table.columns.show("pk")
             elif view.action == "notes":
@@ -142,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()
@@ -219,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),
@@ -241,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))

nautobot/dcim/api/serializers.py

@@ -55,7 +55,7 @@ from nautobot.dcim.models import (
     ConsoleServerPort,
     ConsoleServerPortTemplate,
     Controller,
-    ControllerDeviceGroup,
+    ControllerManagedDeviceGroup,
     Device,
     DeviceBay,
     DeviceBayTemplate,
@@ -598,7 +598,7 @@ class DeviceSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
                             "secrets_group",
                             "device_redundancy_group",
                             "device_redundancy_group_priority",
-                            "controller_device_group",
+                            "controller_managed_device_group",
                         ]
                     },
                 },
@@ -1049,7 +1049,7 @@ class ControllerSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
         fields = "__all__"
 
 
-class ControllerDeviceGroupSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
+class ControllerManagedDeviceGroupSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     class Meta:
-        model = ControllerDeviceGroup
+        model = ControllerManagedDeviceGroup
         fields = "__all__"

nautobot/dcim/api/urls.py

@@ -2,8 +2,7 @@ from nautobot.core.api.routers import OrderedDefaultRouter
 
 from . import views
 
-router = OrderedDefaultRouter()
-router.APIRootView = views.DCIMRootView
+router = OrderedDefaultRouter(view_name="DCIM")
 
 # Locations
 router.register("location-types", views.LocationTypeViewSet)
@@ -80,7 +79,7 @@ router.register("connected-device", views.ConnectedDeviceViewSet, basename="conn
 
 # Controllers
 router.register("controllers", views.ControllerViewSet)
-router.register("controller-device-groups", views.ControllerDeviceGroupViewSet)
+router.register("controller-managed-device-groups", views.ControllerManagedDeviceGroupViewSet)
 
 app_name = "dcim-api"
 urlpatterns = router.urls