nautobot 2.4.17__py3-none-any.whl → 2.4.19__py3-none-any.whl

nautobot/core/tests/test_templatetags_ui_framework.py

@@ -0,0 +1,146 @@
+from django.template import Context
+
+from nautobot.core.templatetags import ui_framework
+from nautobot.core.testing import TestCase
+from nautobot.core.ui.breadcrumbs import Breadcrumbs
+from nautobot.core.ui.titles import Titles
+
+
+class NautobotTemplatetagsUIComponentsTest(TestCase):
+    """Tests template tags from ui_framework module."""
+
+    # ---------------------------
+    # render_title
+    # ---------------------------
+
+    def test_render_title_with_legacy_title_present(self):
+        context = Context(
+            {
+                "title": "Custom Title",
+                "view_titles": Titles(),
+                "verbose_name_plural": "Default Title",
+            }
+        )
+        output = ui_framework.render_title(context)
+
+        self.assertEqual(output, "Custom Title")
+
+    def test_render_title_with_view_titles_only(self):
+        context = Context(
+            {
+                "view_titles": Titles(),
+                "verbose_name_plural": "Default Title",
+            }
+        )
+        output = ui_framework.render_title(context)
+
+        self.assertEqual(output, "Default Title")
+
+    def test_render_title_with_invalid_view_titles(self):
+        class MyStuff:
+            pass
+
+        context = Context(
+            {
+                "view_titles": MyStuff(),
+                "verbose_name_plural": "Default Title",
+            }
+        )
+        output = ui_framework.render_title(context)
+
+        self.assertEqual(output, "")
+
+    def test_render_title_with_empty_context(self):
+        context = Context({})
+        output = ui_framework.render_title(context)
+
+        self.assertEqual(output, "")
+
+    # ---------------------------
+    # render_breadcrumbs
+    # ---------------------------
+
+    def test_render_breadcrumbs(self):
+        context = Context(
+            {
+                "list_url": "home",
+                "title": "New Home",
+                "view_action": "list",
+                "breadcrumbs": Breadcrumbs(),
+            }
+        )
+        output = ui_framework.render_breadcrumbs(context)
+
+        self.assertHTMLEqual(output, '<ol class="breadcrumb"><li><a href="/">New Home</a></li></ol>')
+
+    def test_render_breadcrumbs_empty_context(self):
+        context = Context({})
+        output = ui_framework.render_breadcrumbs(context)
+
+        self.assertHTMLEqual(output, '<ol class="breadcrumb"></ol>')
+
+    def test_render_breadcrumbs_with_legacy_breadcrumbs(self):
+        legacy_breadcrumbs = '<li><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>')
+
+    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>'
+        context = Context(
+            {
+                "list_url": "home",
+                "title": "New Home",
+                "view_action": "list",
+                "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>')
+
+    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>'
+        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>')
+
+    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>'
+        context = Context(
+            {
+                "list_url": "home",
+                "title": "New Home",
+                "view_action": "list",
+                "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>')
+
+    def test_render_breadcrumbs_strips_tags(self):
+        legacy_breadcrumbs = """
+        <li>
+            <a href="/">Home</a>
+        </li>"""
+
+        block_breadcrumbs = """<li>
+
+            <a href="/">Home</a></li>
+        """
+
+        context = Context(
+            {
+                "list_url": "home",
+                "title": "New Home",
+                "view_action": "list",
+                "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>')

nautobot/core/tests/test_titles.py

@@ -163,7 +163,7 @@ class TitlesTestCase(TestCase):
         """Test rendering when no view_action is provided."""
         context = Context({"verbose_name_plural": "devices"})
         result = self.titles.render(context)
-        self.assertEqual(result, "Devices")  # Should use list_action as default
+        self.assertEqual(result, "Devices")  # Should use * action as default
 
     def test_get_extra_context(self):
         """Test that get_extra_context returns empty dict by default."""
@@ -173,7 +173,7 @@ class TitlesTestCase(TestCase):
 
     def test_get_extra_context_is_used_during_render(self):
         """Test that get_extra_context is being used to extend the context."""
-        context = Context({})
+        context = Context({"view_action": "list"})
 
         class TitlesSubClass(Titles):
             def get_extra_context(self, context: Context) -> dict:

nautobot/core/tests/test_ui.py

@@ -4,10 +4,25 @@ from unittest.mock import patch
 
 from django.template import Context
 from django.test import RequestFactory
+from django.urls import reverse
 
+from nautobot.cloud.models import CloudNetwork, CloudResourceType, CloudService
+from nautobot.cloud.tables import CloudServiceTable
+from nautobot.cloud.views import CloudResourceTypeUIViewSet
 from nautobot.core.templatetags.helpers import HTML_NONE
 from nautobot.core.testing import TestCase
-from nautobot.core.ui.object_detail import BaseTextPanel, DataTablePanel, ObjectsTablePanel, Panel
+from nautobot.core.ui.object_detail import (
+    _ObjectDetailAdvancedTab,
+    _ObjectDetailMainTab,
+    BaseTextPanel,
+    DataTablePanel,
+    DistinctViewTab,
+    ObjectDetailContent,
+    ObjectFieldsPanel,
+    ObjectsTablePanel,
+    Panel,
+    SectionChoices,
+)
 from nautobot.dcim.models import DeviceRedundancyGroup
 from nautobot.dcim.tables.devices import DeviceTable
 
@@ -68,6 +83,19 @@ class DataTablePanelTest(TestCase):
         )
 
 
+class ObjectFieldsPanelTest(TestCase):
+    def test_get_data_ignore_nonexistent_fields(self):
+        panel = ObjectFieldsPanel(weight=100, fields=["name", "foo", "bar"], ignore_nonexistent_fields=True)
+        redundancy_group = DeviceRedundancyGroup.objects.first()
+        context = Context({"object": redundancy_group})
+        data = panel.get_data(context)
+        self.assertEqual(data, {"name": redundancy_group.name})  # no keys for nonexistent fields
+
+        panel = ObjectFieldsPanel(weight=100, fields=["name", "foo", "bar"], ignore_nonexistent_fields=False)
+        with self.assertRaises(AttributeError):
+            data = panel.get_data(context)
+
+
 class BaseTextPanelTest(TestCase):
     def test_init_set_object_params(self):
         # Test default settings
@@ -200,3 +228,162 @@ class ObjectsTablePanelTest(TestCase):
             panel.get_extra_context(context_data)
 
         self.assertIn("non-existent column `non_existent_column`", str(context.exception))
+
+
+class ObjectDetailContentExtraTabsTest(TestCase):
+    """
+    Test suite for verifying the behavior of ObjectDetailContent when rendering default and extra tabs.
+    """
+
+    user_permissions = ["cloud.view_cloudresourcetype", "cloud.view_cloudservice", "cloud.view_cloudnetwork"]
+
+    def setUp(self):
+        super().setUp()
+        self.factory = RequestFactory()
+        self.request = self.factory.get("/")
+        self.request.user = self.user
+        self.default_tabs_id = ["main", "advanced", "contacts", "dynamic_groups", "object_metadata"]
+
+    def test_default_extra_tabs_exist(self):
+        """
+        Test the default set of tabs (main, advanced, contacts, dynamic_groups, object_metadata) is present.
+        """
+        content = ObjectDetailContent(
+            panels=[],
+        )
+
+        self.assertEqual(len(content.tabs), len(self.default_tabs_id))
+        tab_ids = [t.tab_id for t in content.tabs]
+        self.assertListEqual(tab_ids, self.default_tabs_id)
+
+    def test_extra_tabs_exist(self):
+        """
+        Test that extra tabs (e.g. "services") can be injected via the `extra_tabs` argument.
+        Validating that tab IDs are correctly combined when extra tabs are provided.
+        """
+        content = ObjectDetailContent(
+            panels=[],
+            extra_tabs=[
+                DistinctViewTab(
+                    weight=1000,
+                    tab_id="services",
+                    label="Cloud Services",
+                    url_name="cloud:cloudresourcetype_services",
+                    related_object_attribute="cloud_services",
+                    panels=(
+                        ObjectsTablePanel(
+                            section=SectionChoices.FULL_WIDTH,
+                            weight=100,
+                            table_class=CloudServiceTable,
+                            table_filter="cloud_resource_type",
+                            tab_id="services",
+                        ),
+                    ),
+                ),
+            ],
+        )
+
+        self.assertEqual(len(content.tabs), len(self.default_tabs_id) + 1)
+        tab_ids = [t.tab_id for t in content.tabs]
+        self.default_tabs_id.append("services")
+        self.assertListEqual(tab_ids, self.default_tabs_id)
+
+    def test_extra_tab_panel_context(self):
+        """
+        Confirming that extra tab panels produce the correct context,
+        including `url` and `body_content_table` populated with the expected related objects.
+        """
+        cloud_resource_type = CloudResourceType.objects.get_for_model(CloudNetwork)[0]
+        cloud_services = CloudService.objects.filter(cloud_resource_type=cloud_resource_type)
+
+        tab = DistinctViewTab(
+            weight=1000,
+            tab_id="services",
+            label="Cloud Services",
+            url_name="cloud:cloudresourcetype_services",
+            related_object_attribute="cloud_services",
+            panels=(
+                ObjectsTablePanel(
+                    section=SectionChoices.FULL_WIDTH,
+                    weight=100,
+                    table_class=CloudServiceTable,
+                    table_filter="cloud_resource_type",
+                    tab_id="services",
+                ),
+            ),
+        )
+        context = {"request": self.request, "object": cloud_resource_type}
+        extra_context = tab.get_extra_context(context)
+        self.assertIn("url", extra_context)
+        self.assertTrue(extra_context["url"].endswith("/services/"))
+
+        panel = tab.panels[0]
+        panel_context = panel.get_extra_context(context)
+
+        self.assertIn("body_content_table", panel_context)
+        table = panel_context["body_content_table"]
+        self.assertQuerySetEqual(cloud_services, table.data)
+
+    def test_tab_conditional_rendering(self):
+        """
+        Assert default tabs render on the main detail view but not sub-views, while distinct-view-tabs do the reverse.
+        """
+        cloud_resource_type = CloudResourceType.objects.get_for_model(CloudNetwork)[0]
+        content = CloudResourceTypeUIViewSet.object_detail_content
+
+        # Main detail view renders all base tabs and no DistinctViewTabs
+        request = self.factory.get(cloud_resource_type.get_absolute_url())
+        request.user = self.user
+        context_data = {
+            "request": request,
+            "object": cloud_resource_type,
+            "settings": {},
+            "csrf_token": "",
+            "perms": [],
+            "created_by": self.request.user,
+            "last_updated_by": self.request.user,
+            "view_action": "retrieve",
+            "detail": True,
+        }
+        context = Context(context_data)
+        for tab in content.tabs:
+            if isinstance(tab, DistinctViewTab):
+                with patch.object(tab.panels[0], "render", wraps=tab.panels[0].render) as panel_render:
+                    self.assertEqual(tab.render(context), "")
+                    panel_render.assert_not_called()
+            elif isinstance(tab, (_ObjectDetailMainTab, _ObjectDetailAdvancedTab)):  # other base tabs might not render
+                with patch.object(tab.panels[0], "render", wraps=tab.panels[0].render) as panel_render:
+                    self.assertNotEqual(tab.render(context), "")
+                    panel_render.assert_called()
+
+        # Distinct tab view renders its tab *only*
+        request = self.factory.get(reverse("cloud:cloudresourcetype_networks", kwargs={"pk": cloud_resource_type.pk}))
+        request.user = self.user
+        context_data["request"] = request
+        context_data["view_action"] = "networks"
+        context = Context(context_data)
+        for tab in content.tabs:
+            if isinstance(tab, DistinctViewTab) and tab.url_name == "cloud:cloudresourcetype_networks":  # pylint: disable=no-member
+                with patch.object(tab.panels[0], "render", wraps=tab.panels[0].render) as panel_render:
+                    self.assertNotEqual(tab.render(context), "")
+                    panel_render.assert_called()
+            else:
+                with patch.object(tab.panels[0], "render", wraps=tab.panels[0].render) as panel_render:
+                    self.assertEqual(tab.render(context), "")
+                    panel_render.assert_not_called()
+
+        # Same, but for a different distinct view tab
+        request = self.factory.get(reverse("cloud:cloudresourcetype_services", kwargs={"pk": cloud_resource_type.pk}))
+        request.user = self.user
+        context_data["request"] = request
+        context_data["view_action"] = "services"
+        context = Context(context_data)
+        for tab in content.tabs:
+            if isinstance(tab, DistinctViewTab) and tab.url_name == "cloud:cloudresourcetype_services":  # pylint: disable=no-member
+                with patch.object(tab.panels[0], "render", wraps=tab.panels[0].render) as panel_render:
+                    self.assertNotEqual(tab.render(context), "")
+                    panel_render.assert_called()
+            else:
+                with patch.object(tab.panels[0], "render", wraps=tab.panels[0].render) as panel_render:
+                    self.assertEqual(tab.render(context), "")
+                    panel_render.assert_not_called()

nautobot/core/tests/test_utils.py

@@ -81,6 +81,41 @@ class NormalizeQueryDictTest(TestCase):
             {"name": ["Sample Status"], "content_types": ["dcim.device"]},
         )
 
+        self.assertDictEqual(
+            requests.normalize_querydict({"name": ["Sample Status"], "content_types": ["1"]}, form_class=StatusForm),
+            {"name": "Sample Status", "content_types": ["1"]},
+        )
+
+        self.assertDictEqual(
+            requests.normalize_querydict(
+                requests.convert_querydict_to_dict(QueryDict("name=Sample Status&content_types=1")),
+                form_class=StatusForm,
+            ),
+            {"name": "Sample Status", "content_types": ["1"]},
+        )
+
+
+class ConvertQueryDictToDictTest(TestCase):
+    """
+    Validate convert_querydict_to_dict() utility function.
+    """
+
+    def test_convert_querydict_to_dict(self):
+        self.assertDictEqual(
+            requests.convert_querydict_to_dict(QueryDict("foo=1&bar=2&bar=3&baz=")),
+            {"foo": ["1"], "bar": ["2", "3"], "baz": [""]},
+        )
+
+        self.assertDictEqual(
+            requests.convert_querydict_to_dict(QueryDict("name=Sample Status&content_types=1")),
+            {"name": ["Sample Status"], "content_types": ["1"]},
+        )
+
+        self.assertDictEqual(
+            requests.convert_querydict_to_dict(QueryDict("name=Sample Status&content_types=dcim.device")),
+            {"name": ["Sample Status"], "content_types": ["dcim.device"]},
+        )
+
 
 class DeepMergeTest(TestCase):
     """

nautobot/core/tests/test_views.py

@@ -8,6 +8,7 @@ import urllib.parse
 from django.apps import apps
 from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
+from django.core.cache import cache
 from django.core.files.uploadedfile import SimpleUploadedFile
 from django.test import override_settings, RequestFactory
 from django.test.utils import override_script_prefix
@@ -23,6 +24,7 @@ from nautobot.core.testing.utils import extract_page_body
 from nautobot.core.utils.permissions import get_permission_for_model
 from nautobot.core.views import NautobotMetricsView
 from nautobot.core.views.mixins import GetReturnURLMixin
+from nautobot.core.views.utils import METRICS_CACHE_KEY
 from nautobot.dcim.models.locations import Location
 from nautobot.extras.choices import CustomFieldTypeChoices
 from nautobot.extras.models import FileProxy, Status
@@ -566,6 +568,49 @@ class MetricsViewTestCase(TestCase):
         metric_names_with_app.remove(test_metric_name)
         self.assertSetEqual(metric_names_with_app, metric_names_without_app)
 
+    def test_enabled_metrics_cache_disabled(self):
+        """Assert that when cache is disabled the cache enabled function doesn't get called."""
+        with mock.patch("nautobot.core.views.utils.generate_latest_with_cache") as mock_generate_latest_with_cache:
+            self.query_and_parse_metrics()
+            self.assertTrue(mock_generate_latest_with_cache.call_count == 0)
+
+    @override_settings(METRICS_EXPERIMENTAL_CACHING_DURATION=30)
+    def test_enabled_metrics_cache_enabled(self):
+        """Assert that multiple calls to metrics with caching returns expected response."""
+        test_metric_name = "nautobot_example_metric_count"
+        metrics_with_app = self.query_and_parse_metrics()
+        metrics_with_app_cached = self.query_and_parse_metrics()
+        metric_names_with_app = {metric.name for metric in metrics_with_app}
+        metric_names_with_app_cached = {metric.name for metric in metrics_with_app_cached}
+        self.assertIn(test_metric_name, metric_names_with_app)
+        self.assertIn(test_metric_name, metric_names_with_app_cached)
+
+        # In some circumstances (e.g. if this test is run first) metrics_with_app may not have
+        # metrics from Django like total view counts. Since metrics_with_app_cached is called
+        # second, it should have everything that metrics_with_app has (plus potentially more).
+        # We at least want to ensure the cached version has everything the non-cached version has.
+        self.assertTrue(
+            metric_names_with_app.issubset(metric_names_with_app_cached),
+            msg="Cached metrics should be a superset of non-cached metrics.",
+        )
+        with mock.patch("nautobot.core.views.generate_latest_with_cache") as mock_generate_latest_with_cache:
+            self.query_and_parse_metrics()
+            self.query_and_parse_metrics()
+            self.assertEqual(mock_generate_latest_with_cache.call_count, 2)
+
+        from example_app.metrics import metric_example
+
+        cache.delete(METRICS_CACHE_KEY)  # Ensure we start with a clean cache for the next part of the test
+        # Assert that the metric function only gets called once even though we scrape metrics twice
+
+        mock_metric_function = mock.Mock(name="mock_metric_function", side_effect=metric_example)
+        with mock.patch.dict("nautobot.core.views.registry", app_metrics=[mock_metric_function]):
+            self.query_and_parse_metrics()
+            first_call_count = mock_metric_function.call_count
+            self.query_and_parse_metrics()
+            second_call_count = mock_metric_function.call_count
+            self.assertEqual(first_call_count, second_call_count)
+
 
 class AuthenticateMetricsTestCase(APITestCase):
     def test_metrics_authentication(self):

nautobot/core/tests/test_views_generic.py

@@ -0,0 +1,43 @@
+from itertools import combinations
+
+from nautobot.core.testing import TestCase
+from nautobot.core.views import generic
+from nautobot.dcim.models import Location
+
+
+class TestViewsGeneric(TestCase):
+    def test_mro_resolve_for_generic_views(self):
+        """
+        Test if all the generic views can be used extend view class.
+
+        Tries to detect if there is no MRO issues according to the #7829.
+        """
+        generic_views = [
+            generic.GenericView,
+            generic.ObjectListView,
+            generic.ObjectView,
+            generic.ObjectEditView,
+            generic.ObjectDeleteView,
+            generic.BulkCreateView,
+            generic.ObjectImportView,
+            generic.BulkImportView,
+            generic.BulkEditView,
+            generic.BulkRenameView,
+            generic.BulkDeleteView,
+            generic.ComponentCreateView,
+            generic.BulkComponentCreateView,
+        ]
+        generic_views_pairs = combinations(generic_views, 2)
+
+        for base_view, extension_view in generic_views_pairs:
+            with self.subTest("Test different class inheritance."):
+
+                class MyMixin(base_view):
+                    pass
+
+                # Defining this class will fail if there is MRO issue
+                # pylint: disable=unused-variable
+                class MyView(MyMixin, extension_view):
+                    queryset = Location.objects.all()
+
+                # pylint: enable=unused-variable