nautobot 2.4.21__py3-none-any.whl → 3.0.0a3__py3-none-any.whl

nautobot/core/tests/test_navigations.py

@@ -1,9 +1,15 @@
+import os
+
+from django.apps import apps
 from django.test import tag, TestCase
 from django.urls import resolve
 
+from nautobot.core.apps import NavMenuTab
 from nautobot.core.choices import ButtonActionColorChoices, ButtonActionIconChoices
-from nautobot.core.templatetags.helpers import bettertitle
+from nautobot.core.testing.utils import get_expected_menu_item_name
+from nautobot.core.ui.choices import NavigationIconChoices, NavigationWeightChoices
 from nautobot.core.utils.lookup import get_route_for_model
+from nautobot.core.utils.module_loading import import_string_optional
 from nautobot.core.utils.permissions import get_permission_for_model
 from nautobot.extras.registry import registry
 
@@ -35,16 +41,9 @@ class NavMenuTestCase(TestCase):
                                 "Interface Connections",
                                 "Console Connections",
                                 "Power Connections",
-                                "Job Approval Queue",
                                 "Wireless Controllers",
                             }:
-                                expected_name = bettertitle(view_model._meta.verbose_name_plural)
-                                if expected_name == "VM Interfaces":
-                                    expected_name = "Interfaces"
-                                elif expected_name == "Object Changes":
-                                    expected_name = "Change Log"
-                                elif expected_name == "Controller Managed Device Groups":
-                                    expected_name = "Device Groups"
+                                expected_name = get_expected_menu_item_name(view_model)
                                 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.
@@ -52,7 +51,8 @@ class NavMenuTestCase(TestCase):
                         except AttributeError:
                             # Not a model view?
                             self.assertIn(
-                                item_details["name"], {"Apps Marketplace", "Installed Apps", "Interface Connections"}
+                                item_details["name"],
+                                {"Apps Marketplace", "Installed Apps", "Interface Connections", "Device Constraints"},
                             )
 
                     for button, button_details in item_details["buttons"].items():
@@ -88,3 +88,71 @@ class NavMenuTestCase(TestCase):
                 else:
                     expected_perms[tab_name] |= group_perms
             self.assertEqual(expected_perms[tab_name], tab_details["permissions"])
+
+    def test_nav_menu_tabs_have_icon_and_weight(self):
+        """Ensure each NavMenuTab in every navigation.py has an icon and weight set, and any duplicates by name match."""
+        tabs_by_name = {}
+        for app in apps.get_app_configs():
+            if not app.name.startswith("nautobot."):
+                continue
+            nav_path = f"{app.name}.navigation.menu_items"
+            menu_items = import_string_optional(nav_path)
+            if menu_items is None:
+                continue
+            for tab in menu_items:
+                if not isinstance(tab, NavMenuTab):
+                    raise TypeError(f"Expected NavMenuTab instance in {nav_path}, got {type(tab)}")
+                tab_name = tab.name
+                icon = tab.icon
+                weight = tab.weight
+                with self.subTest(tab_name=tab_name, nav_path=nav_path):
+                    self.assertIsNotNone(tab_name, f"Tab in {nav_path} missing 'name'")
+                    self.assertIsNotNone(icon, f"Tab '{tab_name}' in {nav_path} missing 'icon'")
+                    self.assertIsNotNone(weight, f"Tab '{tab_name}' in {nav_path} missing 'weight'")
+                    if tab_name in tabs_by_name:
+                        prev_icon, prev_weight, prev_path = tabs_by_name[tab_name]
+                        self.assertEqual(
+                            icon,
+                            prev_icon,
+                            f"Tab '{tab_name}' has inconsistent icons: '{icon}' in {nav_path} vs '{prev_icon}' in {prev_path}",
+                        )
+                        self.assertEqual(
+                            weight,
+                            prev_weight,
+                            f"Tab '{tab_name}' has inconsistent weights: '{weight}' in {nav_path} vs '{prev_weight}' in {prev_path}",
+                        )
+                    else:
+                        tabs_by_name[tab_name] = (icon, weight, nav_path)
+
+    def test_icon_and_weight_class_attributes_match(self):
+        """
+        Ensure every class attribute in NavigationIconChoices is also in NavigationWeightChoices and vice versa.
+        If not, print the missing/extra attributes for easier debugging.
+        """
+        icon_attrs = {attr for attr in dir(NavigationIconChoices) if attr.isupper()}
+        weight_attrs = {attr for attr in dir(NavigationWeightChoices) if attr.isupper()}
+
+        only_in_icons = sorted(icon_attrs - weight_attrs)
+        only_in_weights = sorted(weight_attrs - icon_attrs)
+
+        if only_in_icons or only_in_weights:
+            msg = []
+            if only_in_icons:
+                msg.append(f"Class attributes only in NavigationIconChoices: {only_in_icons}")
+            if only_in_weights:
+                msg.append(f"Class attributes only in NavigationWeightChoices: {only_in_weights}")
+            self.fail("\n".join(msg))
+
+    def test_navigation_icons_have_svg(self):
+        """Ensure every NavigationIconChoices icon has a corresponding SVG file."""
+        missing = []
+        svg_dir = os.path.abspath(
+            os.path.join(os.path.dirname(__file__), "..", "..", "project-static", "nautobot-icons")
+        )
+        icon_attrs = [attr for attr in dir(NavigationIconChoices) if attr.isupper() and not attr == "CHOICES"]
+        for icon_attr in icon_attrs:
+            icon_name = getattr(NavigationIconChoices, icon_attr)
+            svg_path = os.path.join(svg_dir, f"{icon_name}.svg")
+            if not os.path.isfile(svg_path):
+                missing.append(svg_path)
+        self.assertFalse(missing, f"Missing SVG files for NavigationIconChoices: {missing}")

nautobot/core/tests/test_tables.py

@@ -1,4 +1,4 @@
-from django.test import TestCase
+from django.test import tag, TestCase
 
 from nautobot.circuits.models import Circuit
 from nautobot.circuits.tables import CircuitTable
@@ -32,6 +32,7 @@ class TableTestCase(TestCase):
             )
             self.assertEqual(list(table_queryset_data), list(sorted_queryset))
 
+    @tag("example_app")
     def test_tree_model_table_orderable(self):
         """Assert TreeNode model table are orderable."""
         location_type = LocationType.objects.get(name="Campus")
@@ -107,6 +108,7 @@ class TableTestCase(TestCase):
         )
         self.assertEqual(list(table_queryset_data), list(sorted_queryset))
 
+    @tag("example_app")
     def test_base_table_apis(self):
         """
         Test BaseTable APIs, specifically visible_columns and configurable_columns.

nautobot/core/tests/test_templatetags_helpers.py

@@ -1,14 +1,16 @@
+from unittest import mock
+
 from constance.test import override_config
 from django.conf import settings
+from django.contrib.staticfiles.testing import StaticLiveServerTestCase
 from django.templatetags.static import static
-from django.test import override_settings, TestCase
+from django.test import override_settings, tag
 
 from nautobot.core.templatetags import helpers
+from nautobot.core.testing import TestCase
 from nautobot.dcim import models
 from nautobot.ipam.models import VLAN
 
-from example_app.models import AnotherExampleModel, ExampleModel
-
 
 class NautobotTemplatetagsHelperTest(TestCase):
     def test_hyperlinked_object(self):
@@ -46,19 +48,19 @@ class NautobotTemplatetagsHelperTest(TestCase):
         self.assertEqual(
             helpers.hyperlinked_email("admin@example.com"), '<a href="mailto:admin@example.com">admin@example.com</a>'
         )
-        self.assertEqual(helpers.hyperlinked_email(None), '<span class="text-muted">&mdash;</span>')
+        self.assertEqual(helpers.hyperlinked_email(None), '<span class="text-secondary">&mdash;</span>')
 
     def test_hyperlinked_phone_number(self):
         self.assertEqual(helpers.hyperlinked_phone_number("555-1234"), '<a href="tel:555-1234">555-1234</a>')
-        self.assertEqual(helpers.hyperlinked_phone_number(None), '<span class="text-muted">&mdash;</span>')
+        self.assertEqual(helpers.hyperlinked_phone_number(None), '<span class="text-secondary">&mdash;</span>')
 
     def test_placeholder(self):
-        self.assertEqual(helpers.placeholder(None), '<span class="text-muted">&mdash;</span>')
-        self.assertEqual(helpers.placeholder([]), '<span class="text-muted">&mdash;</span>')
+        self.assertEqual(helpers.placeholder(None), '<span class="text-secondary">&mdash;</span>')
+        self.assertEqual(helpers.placeholder([]), '<span class="text-secondary">&mdash;</span>')
         self.assertEqual(helpers.placeholder("something"), "something")
 
     def test_pre_tag(self):
-        self.assertEqual(helpers.pre_tag(None), '<span class="text-muted">&mdash;</span>')
+        self.assertEqual(helpers.pre_tag(None), '<span class="text-secondary">&mdash;</span>')
         self.assertEqual(helpers.pre_tag([]), "<pre>[]</pre>")
         self.assertEqual(helpers.pre_tag("something"), "<pre>something</pre>")
 
@@ -132,6 +134,7 @@ class NautobotTemplatetagsHelperTest(TestCase):
         )
         self.assertEqual("utf8:\n- 😀😀\n- 😀\n", helpers.render_yaml({"utf8": ["😀😀", "😀"]}, False))
 
+    @tag("example_app")
     def test_meta(self):
         location = models.Location.objects.first()
 
@@ -139,31 +142,42 @@ class NautobotTemplatetagsHelperTest(TestCase):
         self.assertEqual(helpers.meta(models.Location, "app_label"), "dcim")
         self.assertEqual(helpers.meta(location, "not_present"), "")
 
+        from example_app.models import ExampleModel
+
         self.assertEqual(helpers.meta(ExampleModel, "app_label"), "example_app")
 
+    @tag("example_app")
     def test_viewname(self):
         location = models.Location.objects.first()
 
         self.assertEqual(helpers.viewname(location, "edit"), "dcim:location_edit")
         self.assertEqual(helpers.viewname(models.Location, "test"), "dcim:location_test")
 
+        from example_app.models import ExampleModel
+
         self.assertEqual(helpers.viewname(ExampleModel, "edit"), "plugins:example_app:examplemodel_edit")
 
+    @tag("example_app")
     def test_validated_viewname(self):
         location = models.Location.objects.first()
 
         self.assertEqual(helpers.validated_viewname(location, "list"), "dcim:location_list")
         self.assertIsNone(helpers.validated_viewname(models.Location, "notvalid"))
 
+        from example_app.models import ExampleModel
+
         self.assertEqual(helpers.validated_viewname(ExampleModel, "list"), "plugins:example_app:examplemodel_list")
         self.assertIsNone(helpers.validated_viewname(ExampleModel, "notvalid"))
 
+    @tag("example_app")
     def test_validated_api_viewname(self):
         location = models.Location.objects.first()
 
         self.assertEqual(helpers.validated_api_viewname(location, "list"), "dcim-api:location-list")
         self.assertIsNone(helpers.validated_api_viewname(models.Location, "notvalid"))
 
+        from example_app.models import ExampleModel
+
         self.assertEqual(
             helpers.validated_api_viewname(ExampleModel, "list"), "plugins-api:example_app-api:examplemodel-list"
         )
@@ -201,16 +215,6 @@ class NautobotTemplatetagsHelperTest(TestCase):
         self.assertEqual(helpers.percentage(2, 10), 20)
         self.assertEqual(helpers.percentage(10, 3), 333)
 
-    def test_get_docs_url(self):
-        self.assertTrue(callable(helpers.get_docs_url))
-        location = models.Location.objects.first()
-        self.assertEqual(helpers.get_docs_url(location), static("docs/user-guide/core-data-model/dcim/location.html"))
-        example_model = ExampleModel.objects.create(name="test", number=1)
-        self.assertEqual(helpers.get_docs_url(example_model), static("example_app/docs/models/examplemodel.html"))
-        # AnotherExampleModel does not have documentation.
-        another_model = AnotherExampleModel.objects.create(name="test", number=1)
-        self.assertIsNone(helpers.get_docs_url(another_model))
-
     def test_has_perms(self):
         self.assertTrue(callable(helpers.has_perms))
         # TODO add unit tests for has_perms
@@ -250,7 +254,7 @@ class NautobotTemplatetagsHelperTest(TestCase):
                 helpers.render_boolean(value),
                 '<span class="text-danger"><i class="mdi mdi-close-thick" title="No"></i></span>',
             )
-        self.assertEqual(helpers.render_boolean(None), '<span class="text-muted">&mdash;</span>')
+        self.assertEqual(helpers.render_boolean(None), '<span class="text-secondary">&mdash;</span>')
 
     def test_hyperlinked_object_with_color(self):
         vlan_with_role = VLAN.objects.filter(role__isnull=False).first()
@@ -260,11 +264,12 @@ class NautobotTemplatetagsHelperTest(TestCase):
         display = helpers.hyperlinked_object(role)
         self.assertEqual(
             helpers.hyperlinked_object_with_color(obj=role),
-            f'<span class="label" style="color: {fbcolor}; background-color: #{color}">{display}</span>',
+            f'<span class="badge" style="color: {fbcolor}; background-color: #{color}">{display}</span>',
         )
         # Assert when obj is None
-        self.assertEqual(helpers.hyperlinked_object_with_color(obj=None), '<span class="text-muted">&mdash;</span>')
+        self.assertEqual(helpers.hyperlinked_object_with_color(obj=None), '<span class="text-secondary">&mdash;</span>')
 
+    @tag("example_app")
     @override_settings(BANNER_TOP="¡Hola, mundo!")
     @override_config(example_app__SAMPLE_VARIABLE="Testing")
     def test_settings_or_config(self):
@@ -338,3 +343,38 @@ class NautobotTemplatetagsHelperTest(TestCase):
             "-85 dBm",
         )
         self.assertEqual(helpers.dbm(None), helpers.placeholder(None))
+
+
+@tag("test")
+class NautobotStaticDocsTestCase(StaticLiveServerTestCase):
+    @tag("example_app")
+    def test_get_docs_url(self):
+        self.assertTrue(callable(helpers.get_docs_url))
+        location_type = models.LocationType.objects.create(name="Some Location Type")
+        self.assertEqual(
+            helpers.get_docs_url(location_type), static("docs/user-guide/core-data-model/dcim/locationtype.html")
+        )
+
+        from example_app.models import AnotherExampleModel, ExampleModel
+
+        example_model = ExampleModel.objects.create(name="test", number=1)
+        self.assertEqual(helpers.get_docs_url(example_model), "/docs/example-app/models/examplemodel.html")
+        # AnotherExampleModel does not have documentation.
+        another_model = AnotherExampleModel.objects.create(name="test", number=1)
+        self.assertIsNone(helpers.get_docs_url(another_model))
+
+    @tag("example_app")
+    @mock.patch("nautobot.core.templatetags.helpers.find", return_value=False)
+    @mock.patch("nautobot.core.templatetags.helpers.resources.files", side_effect=ModuleNotFoundError)
+    def test_get_docs_url_module_not_found_and_no_static_file(self, mock_files, mock_find):
+        # Force `resources.files()` to raise ModuleNotFoundError to simulate a plugin
+        # that is listed in settings.PLUGINS but doesn't actually exist on disk.
+        # This ensures the `except ModuleNotFoundError` branch is covered.
+        from example_app.models import ExampleModel
+
+        example_model = ExampleModel.objects.create(name="test", number=1)
+        result = helpers.get_docs_url(example_model)
+        self.assertIsNone(result)
+
+        mock_files.assert_called_once()
+        mock_find.assert_called_once()

nautobot/core/tests/test_templatetags_ui_framework.py

@@ -65,70 +65,85 @@ class NautobotTemplatetagsUIComponentsTest(TestCase):
             {
                 "list_url": "home",
                 "title": "New Home",
-                "view_action": "list",
+                "detail": True,
                 "breadcrumbs": Breadcrumbs(),
             }
         )
         output = ui_framework.render_breadcrumbs(context)
 
-        self.assertHTMLEqual(output, '<ol class="breadcrumb"><li><a href="/">New Home</a></li></ol>')
+        self.assertHTMLEqual(
+            output,
+            '<nav aria-label="Breadcrumbs" class="mt-1"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="/">New Home</a></li></ol></nav>',
+        )
 
     def test_render_breadcrumbs_empty_context(self):
         context = Context({})
         output = ui_framework.render_breadcrumbs(context)
 
-        self.assertHTMLEqual(output, '<ol class="breadcrumb"></ol>')
+        self.assertHTMLEqual(output, '<nav aria-label="Breadcrumbs" class="mt-1"><ol class="breadcrumb"></ol></nav>')
 
     def test_render_breadcrumbs_with_legacy_breadcrumbs(self):
-        legacy_breadcrumbs = '<li><a href="/">Home</a></li>'
+        legacy_breadcrumbs = '<li class="breadcrumb-item"><a href="/">Home</a></li>'
         context = Context({})
         output = ui_framework.render_breadcrumbs(context, legacy_breadcrumbs)
 
-        self.assertHTMLEqual(output, '<ol class="breadcrumb"><li><a href="/">Home</a></li></ol>')
+        self.assertHTMLEqual(
+            output,
+            '<nav aria-label="Breadcrumbs" class="mt-1"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="/">Home</a></li></ol></nav>',
+        )
 
     def test_render_breadcrumbs_with_legacy_and_block_breadcrumbs_the_same_with_breadcrumbs_class(self):
-        legacy_breadcrumbs = block_breadcrumbs = '<li><a href="/">Home</a></li>'
+        legacy_breadcrumbs = block_breadcrumbs = '<li class="breadcrumb-item"><a href="/">Home</a></li>'
         context = Context(
             {
                 "list_url": "home",
                 "title": "New Home",
-                "view_action": "list",
+                "detail": True,
                 "breadcrumbs": Breadcrumbs(),
             }
         )
         output = ui_framework.render_breadcrumbs(context, legacy_breadcrumbs, block_breadcrumbs)
 
-        self.assertHTMLEqual(output, '<ol class="breadcrumb"><li><a href="/">New Home</a></li></ol>')
+        self.assertHTMLEqual(
+            output,
+            '<nav aria-label="Breadcrumbs" class="mt-1"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="/">New Home</a></li></ol></nav>',
+        )
 
     def test_render_breadcrumbs_with_legacy_and_block_breadcrumbs_the_same_and_no_breadcrumbs_class(self):
-        legacy_breadcrumbs = block_breadcrumbs = '<li><a href="/">Home</a></li>'
+        legacy_breadcrumbs = block_breadcrumbs = '<li class="breadcrumb-item"><a href="/">Home</a></li>'
         context = Context({})
         output = ui_framework.render_breadcrumbs(context, legacy_breadcrumbs, block_breadcrumbs)
 
-        self.assertHTMLEqual(output, '<ol class="breadcrumb"><li><a href="/">Home</a></li></ol>')
+        self.assertHTMLEqual(
+            output,
+            '<nav aria-label="Breadcrumbs" class="mt-1"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="/">Home</a></li></ol></nav>',
+        )
 
     def test_render_breadcrumbs_with_legacy_breadcrumbs_override(self):
-        legacy_breadcrumbs = '<li><a href="/">Home</a></li>'
-        block_breadcrumbs = '<li><a href="/">Override</a></li>'
+        legacy_breadcrumbs = '<li class="breadcrumb-item"><a href="/">Home</a></li>'
+        block_breadcrumbs = '<li class="breadcrumb-item"><a href="/">Override</a></li>'
         context = Context(
             {
                 "list_url": "home",
                 "title": "New Home",
-                "view_action": "list",
+                "detail": True,
                 "breadcrumbs": Breadcrumbs(),
             }
         )
         output = ui_framework.render_breadcrumbs(context, legacy_breadcrumbs, block_breadcrumbs)
 
-        self.assertHTMLEqual(output, '<ol class="breadcrumb"><li><a href="/">Override</a></li></ol>')
+        self.assertHTMLEqual(
+            output,
+            '<nav aria-label="Breadcrumbs" class="mt-1"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="/">Override</a></li></ol></nav>',
+        )
 
     def test_render_breadcrumbs_strips_tags(self):
         legacy_breadcrumbs = """
-        <li>
+        <li class="breadcrumb-item">
             <a href="/">Home</a>
         </li>"""
 
-        block_breadcrumbs = """<li>
+        block_breadcrumbs = """<li class="breadcrumb-item">
 
             <a href="/">Home</a></li>
         """
@@ -137,10 +152,13 @@ class NautobotTemplatetagsUIComponentsTest(TestCase):
             {
                 "list_url": "home",
                 "title": "New Home",
-                "view_action": "list",
+                "detail": True,
                 "breadcrumbs": Breadcrumbs(),
             }
         )
         output = ui_framework.render_breadcrumbs(context, legacy_breadcrumbs, block_breadcrumbs)
 
-        self.assertHTMLEqual(output, '<ol class="breadcrumb"><li><a href="/">New Home</a></li></ol>')
+        self.assertHTMLEqual(
+            output,
+            '<nav aria-label="Breadcrumbs" class="mt-1"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="/">New Home</a></li></ol></nav>',
+        )