nautobot 2.4.16__py3-none-any.whl → 2.4.18__py3-none-any.whl

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/ui/breadcrumbs.py

@@ -192,9 +192,14 @@ class ViewNameBreadcrumbItem(BaseBreadcrumbItem):
 
     def get_label(self, context: Context) -> str:
         if self.label_from_view_name:
-            model = get_model_for_view_name(self.get_view_name(context))
-            if model is not None:
-                return model._meta.verbose_name_plural
+            try:
+                model = get_model_for_view_name(self.get_view_name(context))
+                if model is not None:
+                    return model._meta.verbose_name_plural
+            except ValueError:
+                # `get_model_for_view_name` is not working properly with some proper paths like "home"
+                # and because by default we're trying to resolve label by using `list_url` this error may occur in some apps
+                pass
         return super().get_label(context)
 
     def get_view_name(self, context: Context) -> Optional[str]:
@@ -401,6 +406,7 @@ class Breadcrumbs:
         # Default breadcrumb if view defines `list_url` in the Context
         ViewNameBreadcrumbItem(
             view_name_key="list_url",
+            label_key="title",
             label_from_view_name=True,
             should_render=lambda context: context.get("list_url") is not None,
         ),
@@ -411,7 +417,7 @@ class Breadcrumbs:
     def __init__(
         self,
         items: BreadcrumbItemsType = None,
-        template: str = "inc/breadcrumbs.html",
+        template: str = "components/breadcrumbs.html",
     ):
         """
         Initialize the Breadcrumbs configuration.
@@ -447,7 +453,7 @@ class Breadcrumbs:
         Returns:
             (list[tuple[str, str]]): A list of (url, label) tuples representing breadcrumb entries.
         """
-        action = context.get("view_action", "list")
+        action = context.get("view_action", "")
         detail = context.get("detail", False)
         items = self.get_items_for_action(self.items, action, detail)
         return [item.as_pair(context) for item in items if item.should_render(context)]
@@ -457,7 +463,7 @@ class Breadcrumbs:
         Filters out all items that both label and url are None or empty str.
 
         Args:
-            items (list[tuple[str, str]]): breadcrumb items pair.s
+            items (list[tuple[str, str]]): breadcrumb items pairs.
             context (Context): The view or template context.
 
         Returns:
@@ -481,8 +487,7 @@ class Breadcrumbs:
     @staticmethod
     def get_items_for_action(items: BreadcrumbItemsType, action: str, detail: bool) -> list[BaseBreadcrumbItem]:
         """
-        Get the breadcrumb items for a specific action, with fallback to 'detail' if not found
-        and to asterisk (*) if present.
+        Get the breadcrumb items for a specific action, 'detail' or to asterisk (*) if present.
 
         Args:
             items (BreadcrumbItemsType): Dictionary mapping action names to breadcrumb item lists.

nautobot/core/ui/bulk_buttons.py

@@ -1,53 +1,53 @@
-from nautobot.core.choices import ButtonActionColorChoices
-from nautobot.core.ui import object_detail
-
-
-class BaseBulkButton(object_detail.FormButton):
-    """Base class for bulk action buttons."""
-
-    action = None
-    color = None
-    icon = None
-    label = None
-    weight = None
-
-    def __init__(self, *, form_id: str, model, **kwargs):
-        model_name = model.__name__.lower()
-        app_label = model._meta.app_label
-        link_name = f"{app_label}:{model_name}_bulk_{self.action}"
-
-        super().__init__(
-            link_name=link_name,
-            link_includes_pk=False,
-            label=self.label,
-            color=self.color,
-            icon=self.icon,
-            size="xs",
-            form_id=form_id,
-            weight=self.weight,
-            **kwargs,
-        )
-
-
-class BulkRenameButton(BaseBulkButton):
-    action = "rename"
-    color = ButtonActionColorChoices.RENAME
-    icon = "mdi-pencil"
-    label = "Rename"
-    weight = 200
-
-
-class BulkEditButton(BaseBulkButton):
-    action = "edit"
-    color = ButtonActionColorChoices.EDIT
-    icon = "mdi-pencil"
-    label = "Edit"
-    weight = 300
-
-
-class BulkDeleteButton(BaseBulkButton):
-    action = "delete"
-    color = ButtonActionColorChoices.DELETE
-    icon = "mdi-trash-can-outline"
-    label = "Delete"
-    weight = 400
+from nautobot.core.choices import ButtonActionColorChoices
+from nautobot.core.ui import object_detail
+
+
+class BaseBulkButton(object_detail.FormButton):
+    """Base class for bulk action buttons."""
+
+    action = None
+    color = None
+    icon = None
+    label = None
+    weight = None
+
+    def __init__(self, *, form_id: str, model, **kwargs):
+        model_name = model.__name__.lower()
+        app_label = model._meta.app_label
+        link_name = f"{app_label}:{model_name}_bulk_{self.action}"
+
+        super().__init__(
+            link_name=link_name,
+            link_includes_pk=False,
+            label=self.label,
+            color=self.color,
+            icon=self.icon,
+            size="xs",
+            form_id=form_id,
+            weight=self.weight,
+            **kwargs,
+        )
+
+
+class BulkRenameButton(BaseBulkButton):
+    action = "rename"
+    color = ButtonActionColorChoices.RENAME
+    icon = "mdi-pencil"
+    label = "Rename"
+    weight = 200
+
+
+class BulkEditButton(BaseBulkButton):
+    action = "edit"
+    color = ButtonActionColorChoices.EDIT
+    icon = "mdi-pencil"
+    label = "Edit"
+    weight = 300
+
+
+class BulkDeleteButton(BaseBulkButton):
+    action = "delete"
+    color = ButtonActionColorChoices.DELETE
+    icon = "mdi-trash-can-outline"
+    label = "Delete"
+    weight = 400

nautobot/core/ui/object_detail.py

@@ -9,6 +9,7 @@ from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import FieldDoesNotExist, ObjectDoesNotExist
 from django.db import models
 from django.db.models import CharField, JSONField, Q, URLField
+from django.db.models.constants import LOOKUP_SEP
 from django.db.models.fields.related import ManyToManyField
 from django.template import Context
 from django.template.defaultfilters import truncatechars
@@ -459,7 +460,7 @@ class DistinctViewTab(Tab):
             return format_html(
                 "{} {}",
                 self.label,
-                render_to_string("utilities/templatetags/badge.html", badge(related_obj_count)),
+                render_to_string("utilities/templatetags/badge.html", badge(related_obj_count, True)),
             )
         except AttributeError:
             logger.warning(
@@ -704,6 +705,7 @@ class ObjectsTablePanel(Panel):
         footer_content_template_path="components/panel/footer_content_table.html",
         footer_buttons=None,
         form_id=None,
+        include_paginator=False,
         **kwargs,
     ):
         """Instantiate an ObjectsTable panel.
@@ -752,6 +754,7 @@ class ObjectsTablePanel(Panel):
             footer_buttons (list, optional): A list of Button or FormButton components to render in the panel footer.
                 These buttons typically perform actions like bulk delete, edit, or custom form submission.
             form_id (str, optional): A unique ID for this table's form; used to set the `data-form-id` attribute on each `FormButton`.
+            include_paginator (bool, optional): If True, renders a paginator in the panel footer.
         """
         if context_table_key and any(
             [
@@ -796,6 +799,7 @@ class ObjectsTablePanel(Panel):
         self.tab_id = tab_id
         self.footer_buttons = footer_buttons
         self.form_id = form_id
+        self.include_paginator = include_paginator
 
         super().__init__(
             body_wrapper_template_path=body_wrapper_template_path,
@@ -953,6 +957,7 @@ class ObjectsTablePanel(Panel):
             "footer_buttons": self.footer_buttons,
             "form_id": self.form_id,
             "more_queryset_count": more_queryset_count,
+            "include_paginator": self.include_paginator,
             "show_table_config_button": self.show_table_config_button,
         }
 
@@ -967,6 +972,7 @@ class KeyValueTablePanel(Panel):
         context_data_key=None,
         hide_if_unset=(),
         value_transforms=None,
+        key_transforms=None,
         body_wrapper_template_path="components/panel/body_wrapper_key_value_table.html",
         **kwargs,
     ):
@@ -985,6 +991,8 @@ class KeyValueTablePanel(Panel):
 
                 - `[render_markdown, placeholder]` - render the given text as Markdown, or render a placeholder if blank
                 - `[humanize_speed, placeholder]` - convert the given kbps value to Mbps or Gbps for display
+            key_transforms (dict, optional): A mapping of original field names to custom display names to be used when rendering keys
+                For example: {'content_types': 'Content Type'}.
         """
         if data and context_data_key:
             raise ValueError("The data and context_data_key parameters are mutually exclusive")
@@ -992,6 +1000,7 @@ class KeyValueTablePanel(Panel):
         self.context_data_key = context_data_key or "data"
         self.hide_if_unset = hide_if_unset
         self.value_transforms = value_transforms or {}
+        self.key_transforms = key_transforms or {}
         super().__init__(body_wrapper_template_path=body_wrapper_template_path, **kwargs)
 
     def should_render(self, context: Context):
@@ -1172,6 +1181,7 @@ class ObjectFieldsPanel(KeyValueTablePanel):
         self,
         *,
         fields="__all__",
+        additional_fields=(),
         exclude_fields=(),
         context_object_key=None,
         ignore_nonexistent_fields=False,
@@ -1185,6 +1195,11 @@ class ObjectFieldsPanel(KeyValueTablePanel):
             fields (str, list): The ordered list of fields to display, or `"__all__"` to display fields automatically.
                 Note that ManyToMany fields and reverse relations are **not** included in `"__all__"` at this time, nor
                 are any hidden fields, nor the specially handled `id`, `created`, `last_updated` fields on most models.
+                When a list is specified, it may include model `@property` attributes and nested lookups (if desired) in
+                addition to concrete model fields; when using `fields="__all__"`, such additional attributes and lookups
+                may be specified with the `additional_fields` parameter.
+            additional_fields (list): Only relevant if `fields == "__all__"`, in which case it can specify additional
+                non-default fields to include such as reverse relations, `@property` attributes, nested lookups, etc.
             exclude_fields (list): Only relevant if `fields == "__all__"`, in which case it excludes the given fields.
             context_object_key (str): The key in the render context that will contain the object to derive fields from.
             ignore_nonexistent_fields (bool): If True, `fields` is permitted to include field names that don't actually
@@ -1193,6 +1208,11 @@ class ObjectFieldsPanel(KeyValueTablePanel):
                 (see `render_label()`).
         """
         self.fields = fields
+        if additional_fields and fields != "__all__":
+            raise ValueError("additional_fields may only be used in combination with fields='__all__'")
+        self.additional_fields = additional_fields
+        if exclude_fields and fields != "__all__":
+            raise ValueError("exclude_fields may only be used in combination with fields='__all__'")
         self.exclude_fields = exclude_fields
         self.context_object_key = context_object_key
         self.ignore_nonexistent_fields = ignore_nonexistent_fields
@@ -1206,6 +1226,7 @@ class ObjectFieldsPanel(KeyValueTablePanel):
 
     def render_value(self, key, value, context: Context):
         obj = get_obj_from_context(context, self.context_object_key)
+        # TODO: handle nested keys, e.g. device_type__device_family
         try:
             field_instance = obj._meta.get_field(key)
         except FieldDoesNotExist:
@@ -1226,8 +1247,18 @@ class ObjectFieldsPanel(KeyValueTablePanel):
         if isinstance(field_instance, JSONField):
             return format_html("<pre>{}</pre>", render_json(value))
 
-        if isinstance(field_instance, ManyToManyField) and field_instance.related_model == ContentType:
-            return render_content_types(value)
+        if isinstance(field_instance, ManyToManyField):
+            if field_instance.related_model == ContentType:
+                return render_content_types(value)
+            # TODO: this would be nice but it's probably too error-prone in general:
+            # return render_m2m(
+            #     value.all(),
+            #     (
+            #         reverse(get_route_for_model(field_instance.related_model, "list")) + "?" +
+            #         obj._meta.verbose_name_plural.lower().replace(" ", "_") + "=" + str(obj.pk)
+            #     ),
+            #     key,
+            # )
 
         if isinstance(field_instance, CharField) and hasattr(obj, f"get_{key}_display"):
             # For example, Secret.provider -> Secret.get_provider_display()
@@ -1269,6 +1300,8 @@ class ObjectFieldsPanel(KeyValueTablePanel):
             # TODO: apply a default ordering "smarter" than declaration order? Alphabetical? By field type?
             # TODO: allow model to specify an alternative field ordering?
 
+        fields += self.additional_fields
+
         data = {}
 
         if isinstance(instance, TreeModel) and (self.fields == "__all__" or "_hierarchy" in self.fields):
@@ -1279,9 +1312,14 @@ class ObjectFieldsPanel(KeyValueTablePanel):
             if field_name in self.exclude_fields:
                 continue
             try:
-                field_value = getattr(instance, field_name)
-            except ObjectDoesNotExist:
-                field_value = None
+                field_value = instance
+                # Handle nested lookups, e.g. device_type__device_family
+                for token in field_name.split(LOOKUP_SEP):
+                    try:
+                        field_value = getattr(field_value, token)
+                    except ObjectDoesNotExist:
+                        field_value = None
+                        break
             except AttributeError:
                 if self.ignore_nonexistent_fields:
                     continue
@@ -1297,6 +1335,10 @@ class ObjectFieldsPanel(KeyValueTablePanel):
 
     def render_key(self, key, value, context: Context):
         """Render the `verbose_name` of the model field whose name corresponds to the given key, if applicable."""
+
+        if key in self.key_transforms:
+            return self.key_transforms[key]
+
         instance = get_obj_from_context(context, self.context_object_key)
 
         if instance is not None:
@@ -1912,7 +1954,8 @@ class _ObjectDetailContactsTab(Tab):
             "{} {}",
             self.label,
             render_to_string(
-                "utilities/templatetags/badge.html", badge(get_obj_from_context(context).associated_contacts.count())
+                "utilities/templatetags/badge.html",
+                badge(get_obj_from_context(context).associated_contacts.count(), True),
             ),
         )
 
@@ -1956,7 +1999,7 @@ class _ObjectDetailGroupsTab(Tab):
             "{} {}",
             self.label,
             render_to_string(
-                "utilities/templatetags/badge.html", badge(get_obj_from_context(context).dynamic_groups.count())
+                "utilities/templatetags/badge.html", badge(get_obj_from_context(context).dynamic_groups.count(), True)
             ),
         )
 
@@ -2003,6 +2046,6 @@ class _ObjectDetailMetadataTab(Tab):
             self.label,
             render_to_string(
                 "utilities/templatetags/badge.html",
-                badge(get_obj_from_context(context).associated_object_metadata.count()),
+                badge(get_obj_from_context(context).associated_object_metadata.count(), True),
             ),
         )

nautobot/core/ui/titles.py

@@ -1,9 +1,10 @@
-from typing import Literal, Optional
+from typing import Literal, Optional, Union
 
 from django.template import Context, Template
 from django.utils.html import strip_tags
 
 DEFAULT_TITLES: dict[str, str] = {
+    "*": "{{ verbose_name_plural|bettertitle }}",
     "list": "{{ verbose_name_plural|bettertitle }}",
     "detail": "{{ object.display|default:object }}",
     "retrieve": "{{ object.display|default:object }}",
@@ -59,7 +60,7 @@ class Titles:
         if template_plugins:
             self.template_plugins.extend(template_plugins)
 
-    def render(self, context: Context, mode: ModeType = "html") -> str:
+    def render(self, context: Union[dict, Context], mode: ModeType = "html") -> str:
         """
         Renders the title based on given context and current action.
 
@@ -68,12 +69,15 @@ class Titles:
         Make sure that needed context variables are in context and needed plugins are loaded.
 
         Args:
-            context (Context): Render context.
+            context (Union[dict, Context]): Render context.
             mode (ModeType): Rendering mode: "html" or "plain".
 
         Returns:
             (str): HTML fragment or plain text, depending on `mode`.
         """
+        if isinstance(context, dict):
+            context = Context(context)
+
         with context.update(self.get_extra_context(context)):
             template_str = self.get_template_str(context)
             template = Template(self.template_plugins_str + template_str)
@@ -92,7 +96,7 @@ class Titles:
         Returns:
             str: The template string for the current action, or an empty string if not found.
         """
-        action = context.get("view_action", "list")
+        action = context.get("view_action", "")
 
         template_str = self.titles.get(action)
         if template_str:
@@ -102,7 +106,7 @@ class Titles:
         if detail:
             return self.titles.get("detail", "")
 
-        return ""
+        return self.titles.get("*", "")
 
     @property
     def template_plugins_str(self) -> str:

nautobot/core/utils/data.py

@@ -92,6 +92,19 @@ def merge_dicts_without_collision(d1, d2):
     return {**d1, **d2}
 
 
+def validate_jinja2(template_code):
+    """
+    Parse a Jinja2 template to validate its syntax. Returns True if the template is valid.
+
+    Raises:
+        jinja2.TemplateSyntaxError: If the template is syntactically invalid.
+    """
+    rendering_engine = engines["jinja"]
+    rendering_engine.env.parse(template_code)
+
+    return True
+
+
 def render_jinja2(template_code, context):
     """
     Render a Jinja2 template with the provided context. Return the rendered content.

nautobot/core/utils/deprecation.py

@@ -1,5 +1,6 @@
 """Utilities for handling deprecation of code and features."""
 
+from functools import wraps
 import logging
 import traceback
 import warnings
@@ -51,6 +52,7 @@ def method_deprecated(message):
     """Decorator to mark a method as deprecated with a custom message about what to call instead."""
 
     def decorate(method):
+        @wraps(method)
         def decorated_method(*args, **kwargs):
             warnings.warn(
                 f"Method `{method.__name__}` is deprecated, and will be removed in a future Nautobot release. "

nautobot/core/views/__init__.py

@@ -15,6 +15,7 @@ from django.contrib import messages
 from django.contrib.auth.decorators import permission_required
 from django.contrib.auth.mixins import AccessMixin, LoginRequiredMixin, UserPassesTestMixin
 from django.contrib.contenttypes.models import ContentType
+from django.core.cache import cache
 from django.http import HttpResponseForbidden, HttpResponseServerError, JsonResponse
 from django.shortcuts import get_object_or_404, render
 from django.template import loader, RequestContext, Template
@@ -51,6 +52,11 @@ from nautobot.core.releases import get_latest_release
 from nautobot.core.utils.config import get_settings_or_config
 from nautobot.core.utils.lookup import get_route_for_model
 from nautobot.core.utils.permissions import get_permission_for_model
+from nautobot.core.views.utils import (
+    generate_latest_with_cache,
+    is_metrics_experimental_caching_enabled,
+    METRICS_CACHE_KEY,
+)
 from nautobot.extras.forms import GraphQLQueryForm
 from nautobot.extras.models import FileProxy, GraphQLQuery, Status
 from nautobot.extras.registry import registry
@@ -435,8 +441,17 @@ class NautobotAppMetricsCollector(Collector):
     def collect(self):
         """Collect metrics from plugins."""
         start = time.time()
-        for metric_generator in registry["app_metrics"]:
-            yield from metric_generator()
+        cached_lines = cache.get(METRICS_CACHE_KEY)
+        if not is_metrics_experimental_caching_enabled() or not cached_lines:
+            # If caching is disabled or no cache is found, generate metrics
+            for metric_generator in registry["app_metrics"]:
+                yield from metric_generator()
+        else:
+            # We stash the cached lines on the instance of the collector so that we can
+            # avoid a potential race condition where the cache expires between
+            # the time we check for it and the time we go to use it
+            # in generate_latest_with_cache()
+            self.local_cache = cached_lines
         gauge = GaugeMetricFamily("nautobot_app_metrics_processing_ms", "Time in ms to generate the app metrics")
         duration = time.time() - start
         gauge.add_metric([], format(duration * 1000, ".5f"))
@@ -485,7 +500,13 @@ class NautobotMetricsView(APIView):
         except ValueError:
             # Collector already registered, we are running without multiprocessing
             pass
-        metrics_page = generate_latest(prometheus_registry)
+
+        if is_metrics_experimental_caching_enabled():
+            # Use the vendored version of generate_latest with Caching support
+            metrics_page = generate_latest_with_cache(prometheus_registry)
+        else:
+            # Use the original version of generate_latest to generate the metrics
+            metrics_page = generate_latest(prometheus_registry)
         return Response(metrics_page, content_type=CONTENT_TYPE_LATEST)