nautobot 2.4.21__py3-none-any.whl → 2.4.23__py3-none-any.whl

nautobot/core/tests/test_ui.py

@@ -23,8 +23,10 @@ from nautobot.core.ui.object_detail import (
     Panel,
     SectionChoices,
 )
-from nautobot.dcim.models import DeviceRedundancyGroup
+from nautobot.dcim.models import Device, DeviceRedundancyGroup
+from nautobot.dcim.tables import DeviceModuleInterfaceTable
 from nautobot.dcim.tables.devices import DeviceTable
+from nautobot.dcim.views import DeviceUIViewSet
 
 
 class DataTablePanelTest(TestCase):
@@ -288,6 +290,52 @@ class ObjectDetailContentExtraTabsTest(TestCase):
         self.default_tabs_id.append("services")
         self.assertListEqual(tab_ids, self.default_tabs_id)
 
+    def test_tab_id_url_as_action(self):
+        """
+        Test that when you create a panel with a tab_id that matches a viewset action,
+        the return_url is constructed correctly.
+        """
+        self.add_permissions("dcim.add_interface", "dcim.change_interface")
+        device_info = Device.objects.first()
+
+        panel = DeviceUIViewSet.DeviceInterfacesTablePanel(
+            weight=100,
+            section=SectionChoices.FULL_WIDTH,
+            table_title="Interfaces",
+            table_class=DeviceModuleInterfaceTable,
+            table_attribute="vc_interfaces",
+            related_field_name="device",
+            tab_id="interfaces",
+        )
+        context = {"request": self.request, "object": device_info}
+        panel_context = panel.get_extra_context(context)
+
+        return_url = f"/dcim/devices/{device_info.pk}/interfaces/"
+        self.assertTrue(panel_context["body_content_table_add_url"].endswith(return_url))
+
+    def test_tab_id_url_as_param(self):
+        """
+        Test that when you create a panel with a tab_id that does NOT matches a viewset action,
+        the return_url is constructed correctly.
+        """
+        self.add_permissions("dcim.add_interface", "dcim.change_interface")
+        device_info = Device.objects.first()
+
+        panel = DeviceUIViewSet.DeviceInterfacesTablePanel(
+            weight=100,
+            section=SectionChoices.FULL_WIDTH,
+            table_title="Interfaces",
+            table_class=DeviceModuleInterfaceTable,
+            table_attribute="vc_interfaces",
+            related_field_name="device",
+            tab_id="interfaces-not-exist",
+        )
+        context = {"request": self.request, "object": device_info}
+        panel_context = panel.get_extra_context(context)
+
+        return_url = f"&return_url=/dcim/devices/{device_info.pk}/?tab=interfaces-not-exist"
+        self.assertTrue(panel_context["body_content_table_add_url"].endswith(return_url))
+
     def test_extra_tab_panel_context(self):
         """
         Confirming that extra tab panels produce the correct context,

nautobot/core/tests/test_utils.py

@@ -18,7 +18,13 @@ from nautobot.core.testing import TestCase
 from nautobot.core.utils import data as data_utils, filtering, lookup, querysets, requests
 from nautobot.core.utils.migrations import update_object_change_ct_for_replaced_models
 from nautobot.core.utils.module_loading import check_name_safe_to_import_privately
-from nautobot.dcim import filters as dcim_filters, forms as dcim_forms, models as dcim_models, tables
+from nautobot.dcim import (
+    filters as dcim_filters,
+    forms as dcim_forms,
+    models as dcim_models,
+    tables,
+    views as dcim_views,
+)
 from nautobot.extras import models as extras_models, utils as extras_utils
 from nautobot.extras.choices import ObjectChangeActionChoices, RelationshipTypeChoices
 from nautobot.extras.filters import StatusFilterSet
@@ -213,6 +219,26 @@ class FlattenIterableTest(TestCase):
 class GetFooForModelTest(TestCase):
     """Tests for the various `get_foo_for_model()` functions."""
 
+    def test_get_breadcrumbs_for_model(self):
+        breadcrumbs = lookup.get_breadcrumbs_for_model(dcim_models.Device)
+        self.assertEqual(breadcrumbs.items, dcim_views.DeviceUIViewSet.get_breadcrumbs(dcim_models.Device).items)
+        breadcrumbs = lookup.get_breadcrumbs_for_model(dcim_models.Device, view_type="")
+        self.assertEqual(
+            breadcrumbs.items, dcim_views.DeviceUIViewSet.get_breadcrumbs(dcim_models.Device, view_type="").items
+        )
+
+    def test_get_detail_view_components_context_for_model(self):
+        context = lookup.get_detail_view_components_context_for_model(dcim_models.Device)
+        self.assertEqual(
+            context["breadcrumbs"].items, lookup.get_breadcrumbs_for_model(dcim_models.Device, view_type="").items
+        )
+        self.assertEqual(
+            context["object_detail_content"], lookup.get_object_detail_content_for_model(dcim_models.Device)
+        )
+        self.assertEqual(
+            context["view_titles"].titles, lookup.get_view_titles_for_model(dcim_models.Device, view_type="").titles
+        )
+
     def test_get_filterset_for_model(self):
         """
         Test that `get_filterset_for_model` returns the right FilterSet for various inputs.
@@ -235,6 +261,12 @@ class GetFooForModelTest(TestCase):
         self.assertEqual(lookup.get_form_for_model("dcim.location"), dcim_forms.LocationForm)
         self.assertEqual(lookup.get_form_for_model(dcim_models.Location), dcim_forms.LocationForm)
 
+    def test_get_object_detail_content_for_model(self):
+        self.assertEqual(
+            lookup.get_object_detail_content_for_model(dcim_models.Device),
+            dcim_views.DeviceUIViewSet.object_detail_content,
+        )
+
     def test_get_related_field_for_models(self):
         """
         Test that `get_related_field_for_models` returns the appropriate field for various inputs.
@@ -341,6 +373,14 @@ class GetFooForModelTest(TestCase):
         # Testing unconventional table name
         self.assertEqual(lookup.get_table_class_string_from_view_name("ipam:prefix_list"), "PrefixDetailTable")
 
+    def test_get_view_titles_for_model(self):
+        view_titles = lookup.get_view_titles_for_model(dcim_models.Device)
+        self.assertEqual(view_titles.titles, dcim_views.DeviceUIViewSet.get_view_titles(dcim_models.Device).titles)
+        view_titles = lookup.get_view_titles_for_model(dcim_models.Device, view_type="")
+        self.assertEqual(
+            view_titles.titles, dcim_views.DeviceUIViewSet.get_view_titles(dcim_models.Device, view_type="").titles
+        )
+
 
 class IsTaggableTest(TestCase):
     def test_is_taggable_true(self):

nautobot/core/ui/object_detail.py

@@ -39,7 +39,7 @@ from nautobot.core.templatetags.helpers import (
 )
 from nautobot.core.ui.choices import LayoutChoices, SectionChoices
 from nautobot.core.ui.utils import render_component_template
-from nautobot.core.utils.lookup import get_filterset_for_model, get_route_for_model
+from nautobot.core.utils.lookup import get_filterset_for_model, get_route_for_model, get_view_for_model
 from nautobot.core.utils.permissions import get_permission_for_model
 from nautobot.core.views.paginator import EnhancedPaginator, get_paginate_count
 from nautobot.core.views.utils import get_obj_from_context
@@ -879,7 +879,12 @@ class ObjectsTablePanel(Panel):
         related_field_name = self.related_field_name or self.table_filter or obj._meta.model_name
         return_url = context.get("return_url", obj.get_absolute_url())
         if self.tab_id:
-            return_url += f"?tab={self.tab_id}"
+            try:
+                # Check to see if the this is a NautobotUIViewset action
+                view = get_view_for_model(obj._meta.model)
+                return_url += getattr(view, self.tab_id).url_path + "/"
+            except AttributeError:
+                return_url += f"?tab={self.tab_id}"
 
         if self.add_button_route is not None:
             add_permissions = self.add_permissions

nautobot/core/urls.py

@@ -91,15 +91,14 @@ urlpatterns = [
 
 
 if settings.DEBUG:
-    try:
-        import debug_toolbar
+    urlpatterns += [path("theme-preview/", ThemePreviewView.as_view(), name="theme_preview")]
+
+
+if "debug_toolbar" in settings.INSTALLED_APPS:
+    from debug_toolbar.toolbar import debug_toolbar_urls
+
+    urlpatterns += debug_toolbar_urls()
 
-        urlpatterns += [
-            path("__debug__/", include(debug_toolbar.urls)),
-            path("theme-preview/", ThemePreviewView.as_view(), name="theme_preview"),
-        ]
-    except ImportError:
-        pass
 
 if settings.METRICS_ENABLED:
     if settings.METRICS_AUTHENTICATED:

nautobot/core/utils/filtering.py

@@ -101,6 +101,7 @@ def get_filterset_parameter_form_field(model, parameter, filterset=None):
         BOOLEAN_CHOICES,
         DynamicModelMultipleChoiceField,
         MultipleContentTypeField,
+        MultiValueCharInput,
         StaticSelect2,
         StaticSelect2Multiple,
     )
@@ -121,7 +122,16 @@ def get_filterset_parameter_form_field(model, parameter, filterset=None):
     elif isinstance(field, (MultiValueDecimalFilter, MultiValueFloatFilter)):
         form_field = forms.DecimalField()
     elif isinstance(field, NumberFilter):
-        form_field = forms.IntegerField()
+        # If "choices" are passed, then when 'exact' is used in an Advanced
+        # Filter, render a dropdown of choices instead of a free integer input
+        if field.lookup_expr == "exact" and getattr(field, "choices", None):
+            # Use a multi-value widget that allows both preset choices and free-form entries
+            form_field = forms.MultipleChoiceField(
+                choices=field.choices,
+                widget=MultiValueCharInput,
+            )
+        else:
+            form_field = forms.IntegerField()
     elif isinstance(field, ModelMultipleChoiceFilter):
         if getattr(field, "prefers_id", False):
             to_field_name = "id"

nautobot/core/utils/lookup.py

@@ -13,6 +13,14 @@ from django.utils.module_loading import import_string
 from django.views.generic.base import RedirectView
 
 
+def get_breadcrumbs_for_model(model, view_type: str = "List"):
+    """Get a UI Component Framework 'Breadcrumbs' instance for the given model's related UIViewSet or generic view."""
+    view = get_view_for_model(model)
+    if hasattr(view, "get_breadcrumbs"):
+        return view.get_breadcrumbs(model, view_type=view_type)
+    return None
+
+
 def get_changes_for_model(model):
     """
     Return a queryset of ObjectChanges for a model or instance. The queryset will be filtered
@@ -30,6 +38,30 @@ def get_changes_for_model(model):
     raise TypeError(f"{model!r} is not a Django Model class or instance")
 
 
+def get_detail_view_components_context_for_model(model) -> dict:
+    """Helper method for DistinctViewTabs etc. to retrieve the UI Component Framework context for the base detail view.
+
+    Functionally equivalent to calling `get_breadcrumbs_for_model()`, `get_object_detail_content_for_model()`, and
+    `get_view_titles_for_model()`, but marginally more efficient.
+    """
+    context = {
+        "breadcrumbs": None,
+        "object_detail_content": None,
+        "view_titles": None,
+    }
+
+    view = get_view_for_model(model, view_type="")
+    if view is not None:
+        if hasattr(view, "get_breadcrumbs"):
+            context["breadcrumbs"] = view.get_breadcrumbs(model, view_type="")
+        if hasattr(view, "get_view_titles"):
+            context["view_titles"] = view.get_view_titles(model, view_type="")
+        if hasattr(view, "object_detail_content"):
+            context["object_detail_content"] = view.object_detail_content
+
+    return context
+
+
 def get_model_from_name(model_name):
     """Given a full model name in dotted format (example: `dcim.model`), a model class is returned if valid.
 
@@ -178,6 +210,12 @@ def get_form_for_model(model, form_prefix=""):
     return get_related_class_for_model(model, module_name="forms", object_suffix=object_suffix)
 
 
+def get_object_detail_content_for_model(model):
+    """Get the UI Component Framework 'object_detail_content' for the given model's related UIViewSet or ObjectView."""
+    view = get_view_for_model(model)
+    return getattr(view, "object_detail_content", None)
+
+
 def get_related_field_for_models(from_model, to_model):
     """
     Find the field on `from_model` that is a relation to `to_model`.
@@ -245,6 +283,14 @@ def get_view_for_model(model, view_type=""):
     return result
 
 
+def get_view_titles_for_model(model, view_type: str = "List"):
+    """Get a UI Component Framework 'Titles' instance for the given model's related UIViewSet or generic view."""
+    view = get_view_for_model(model)
+    if hasattr(view, "get_view_titles"):
+        return view.get_view_titles(model, view_type=view_type)
+    return None
+
+
 def get_model_for_view_name(view_name):
     """
     Return the model class associated with the given view_name e.g. "circuits:circuit_detail", "dcim:device_list" and etc.

nautobot/core/views/mixins.py

@@ -260,52 +260,57 @@ class UIComponentsMixin:
     breadcrumbs: ClassVar[Optional[Breadcrumbs]] = None
     view_titles: ClassVar[Optional[Titles]] = None
 
-    def get_view_titles(self, model: Union[None, str, Type[Model], Model] = None, view_type: str = "List") -> Titles:
+    @classmethod
+    def get_view_titles(cls, model: Union[None, str, Type[Model], Model] = None, view_type: str = "List") -> Titles:
         """
         Resolve and return the `Titles` component instance.
 
         Resolution order:
-          1) If `self.view_titles` is set on the current view, use it.
-          2) Else, if `model` is provided, copy the `view_titles` from the view
-             class associated with that model via `lookup.get_view_for_model(model, action)`.
+          1) If `.view_titles` is set on the current view, use it.
+          2) Else, if `model` is provided, copy the `view_titles` from the view class associated with that model
+             via `lookup.get_view_for_model(model, action)`.
           3) Else, instantiate and return the default `Titles()`.
 
         Args:
             model: A Django model **class**, **instance**, dotted name string, or `None`.
                 Passed to `lookup.get_view_for_model()` to find the related view class.
                 If `None`, only local/default resolution is used.
-            view_type: Logical view type used by `lookup.get_view_for_model()` (e.g., `"List"` or empty to construct `"DeviceView"` string).
+            view_type: Logical view type used by `lookup.get_view_for_model()`
+                (e.g., `"List"` or empty to construct `"DeviceView"` string).
 
         Returns:
             Titles: A concrete `Titles` component instance ready to use.
         """
-        return self._resolve_component("view_titles", Titles, model, view_type)
+        return cls._resolve_component("view_titles", Titles, model, view_type)
 
+    @classmethod
     def get_breadcrumbs(
-        self, model: Union[None, str, Type[Model], Model] = None, view_type: str = "List"
+        cls, model: Union[None, str, Type[Model], Model] = None, view_type: str = "List"
     ) -> Breadcrumbs:
         """
         Resolve and return the `Breadcrumbs` component instance.
 
         Resolution order mirrors `get_view_titles()`:
-         1) Use `self.breadcrumbs` if set locally.
-         2) Else, if `model` is provided, copy the `breadcrumbs` from the view
-             class associated with that model via `lookup.get_view_for_model(model, action)`.
+         1) Use `.breadcrumbs` if set locally.
+         2) Else, if `model` is provided, copy the `breadcrumbs` from the view class associated with that model
+            via `lookup.get_view_for_model(model, action)`.
          3) Else return a new default `Breadcrumbs()`.
 
         Args:
            model: A Django model **class**, **instance**, dotted name string, or `None`.
                 Passed to `lookup.get_view_for_model()` to find the related view class.
                 If `None`, only local/default resolution is used.
-           view_type: Logical view type used by `lookup.get_view_for_model()` (e.g., `"List"` or empty to construct `"DeviceView"` string).
+           view_type: Logical view type used by `lookup.get_view_for_model()`
+                (e.g., `"List"` or empty to construct `"DeviceView"` string).
 
         Returns:
            Breadcrumbs: A concrete `Breadcrumbs` component instance.
         """
-        return self._resolve_component("breadcrumbs", Breadcrumbs, model, view_type)
+        return cls._resolve_component("breadcrumbs", Breadcrumbs, model, view_type)
 
+    @classmethod
     def _resolve_component(
-        self,
+        cls,
         attr_name: str,
         default_cls: Type[Union[Breadcrumbs, Titles]],
         model: Union[None, str, Type[Model], Model] = None,
@@ -326,14 +331,14 @@ class UIComponentsMixin:
         Returns:
             Breadcrumbs/Title instance.
         """
-        local = getattr(self, attr_name, None)
+        local = getattr(cls, attr_name, None)
         if local is not None:
-            return self._instantiate_if_needed(local, default_cls)
+            return cls._instantiate_if_needed(local, default_cls)
 
         if model is not None:
             view_class = lookup.get_view_for_model(model, view_type)
             view_component = getattr(view_class, attr_name, None)
-            return self._instantiate_if_needed(view_component, default_cls)
+            return cls._instantiate_if_needed(view_component, default_cls)
 
         return default_cls()
 
@@ -1044,7 +1049,8 @@ class ObjectEditViewMixin(NautobotViewSetMixin, mixins.CreateModelMixin, mixins.
                 if hasattr(obj, "clone_fields"):
                     url = f"{request.path}?{prepare_cloned_fields(obj)}"
                     self.success_url = url
-                self.success_url = request.get_full_path()
+                else:
+                    self.success_url = request.get_full_path()
             else:
                 return_url = form.cleaned_data.get("return_url")
                 if url_has_allowed_host_and_scheme(url=return_url, allowed_hosts=request.get_host()):

nautobot/core/views/utils.py

@@ -586,9 +586,9 @@ def get_bulk_queryset_from_view(
 
     queryset = view_class.queryset.restrict(user, action)
 
-    # The filterset_class is determined from model on purpose, as filterset_class the view as a param, will not work
-    # with a job. It is better to be consistent with each with sending the same params that will
-    # always be available from to the confirmation page and to the job.
+    # The filterset_class is determined from model on purpose versus getting it from the view itself. This is
+    # because the filterset_class on the view as a param, will not work with a job. It is better to be consistent
+    # with each with sending the same params that will always be available from to the confirmation page and to the job.
     filterset_class = get_filterset_for_model(model)
 
     if not filterset_class:

nautobot/dcim/api/serializers.py

@@ -31,6 +31,7 @@ from nautobot.dcim.choices import (
     ControllerCapabilitiesChoices,
     DeviceFaceChoices,
     DeviceRedundancyGroupFailoverStrategyChoices,
+    InterfaceDuplexChoices,
     InterfaceModeChoices,
     InterfaceRedundancyGroupProtocolChoices,
     InterfaceTypeChoices,
@@ -704,6 +705,8 @@ class InterfaceSerializer(
     mode = ChoiceField(choices=InterfaceModeChoices, allow_blank=True, required=False)
     mac_address = serializers.CharField(allow_blank=True, allow_null=True, required=False)
     ip_address_count = serializers.IntegerField(read_only=True, source="_ip_address_count")
+    speed = serializers.IntegerField(required=False, allow_null=True)
+    duplex = ChoiceField(choices=InterfaceDuplexChoices, allow_blank=True, required=False)
 
     class Meta:
         model = Interface

nautobot/dcim/choices.py

@@ -1138,6 +1138,55 @@ class InterfaceModeChoices(ChoiceSet):
     )
 
 
+class InterfaceDuplexChoices(ChoiceSet):
+    DUPLEX_AUTO = "auto"
+    DUPLEX_FULL = "full"
+    DUPLEX_HALF = "half"
+
+    CHOICES = (
+        (DUPLEX_AUTO, "Auto"),
+        (DUPLEX_FULL, "Full"),
+        (DUPLEX_HALF, "Half"),
+    )
+
+
+class InterfaceSpeedChoices(ChoiceSet):
+    # Stored in Kbps (for compatibility with circuits and humanize_speed filter)
+    SPEED_1M = 1_000
+    SPEED_10M = 10_000
+    SPEED_100M = 100_000
+    SPEED_1G = 1_000_000
+    SPEED_2_5G = 2_500_000
+    SPEED_5G = 5_000_000
+    SPEED_10G = 10_000_000
+    SPEED_25G = 25_000_000
+    SPEED_40G = 40_000_000
+    SPEED_50G = 50_000_000
+    SPEED_100G = 100_000_000
+    SPEED_200G = 200_000_000
+    SPEED_400G = 400_000_000
+    SPEED_800G = 800_000_000
+    SPEED_1_6T = 1_600_000_000
+
+    CHOICES = (
+        (SPEED_1M, "1 Mbps"),
+        (SPEED_10M, "10 Mbps"),
+        (SPEED_100M, "100 Mbps"),
+        (SPEED_1G, "1 Gbps"),
+        (SPEED_2_5G, "2.5 Gbps"),
+        (SPEED_5G, "5 Gbps"),
+        (SPEED_10G, "10 Gbps"),
+        (SPEED_25G, "25 Gbps"),
+        (SPEED_40G, "40 Gbps"),
+        (SPEED_50G, "50 Gbps"),
+        (SPEED_100G, "100 Gbps"),
+        (SPEED_200G, "200 Gbps"),
+        (SPEED_400G, "400 Gbps"),
+        (SPEED_800G, "800 Gbps"),
+        (SPEED_1_6T, "1.6 Tbps"),
+    )
+
+
 class InterfaceStatusChoices(ChoiceSet):
     STATUS_PLANNED = "planned"
     STATUS_ACTIVE = "active"

nautobot/dcim/constants.py

@@ -37,6 +37,13 @@ VIRTUAL_IFACE_TYPES = interface_type_by_category["Virtual interfaces"]
 
 NONCONNECTABLE_IFACE_TYPES = VIRTUAL_IFACE_TYPES + WIRELESS_IFACE_TYPES
 
+COPPER_TWISTED_PAIR_IFACE_TYPES = [
+    InterfaceTypeChoices.TYPE_100ME_FIXED,
+    InterfaceTypeChoices.TYPE_1GE_FIXED,
+    InterfaceTypeChoices.TYPE_2GE_FIXED,
+    InterfaceTypeChoices.TYPE_5GE_FIXED,
+    InterfaceTypeChoices.TYPE_10GE_FIXED,
+]
 
 #
 # PowerFeeds

nautobot/dcim/filters/__init__.py

@@ -9,6 +9,7 @@ from nautobot.core.filters import (
     ContentTypeMultipleChoiceFilter,
     MultiValueCharFilter,
     MultiValueMACAddressFilter,
+    MultiValueNumberFilter,
     MultiValueUUIDFilter,
     NameSearchFilterSet,
     NaturalKeyOrPKMultipleChoiceFilter,
@@ -22,6 +23,8 @@ from nautobot.dcim.choices import (
     CableTypeChoices,
     ConsolePortTypeChoices,
     ControllerCapabilitiesChoices,
+    InterfaceDuplexChoices,
+    InterfaceSpeedChoices,
     InterfaceTypeChoices,
     PowerOutletTypeChoices,
     PowerPortTypeChoices,
@@ -1197,6 +1200,8 @@ class InterfaceFilterSet(
     vlan_id = django_filters.CharFilter(method="filter_vlan_id", label="Assigned VLAN")
     vlan = django_filters.NumberFilter(method="filter_vlan", label="Assigned VID")
     type = django_filters.MultipleChoiceFilter(choices=InterfaceTypeChoices, null_value=None)
+    duplex = django_filters.MultipleChoiceFilter(choices=InterfaceDuplexChoices, null_value=None)
+    speed = MultiValueNumberFilter(lookup_expr="exact", choices=InterfaceSpeedChoices)
     interface_redundancy_groups = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=InterfaceRedundancyGroup.objects.all(),
         to_field_name="name",
@@ -1230,6 +1235,8 @@ class InterfaceFilterSet(
             "id",
             "name",
             "type",
+            "duplex",
+            "speed",
             "enabled",
             "mtu",
             "mgmt_only",