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

nautobot/dcim/apps.py

@@ -5,14 +5,18 @@ class DCIMConfig(NautobotConfig):
     name = "nautobot.dcim"
     verbose_name = "DCIM"
     searchable_models = [
+        "cable",
+        "controller",
+        "device",
+        "devicefamily",
+        "deviceredundancygroup",
+        "devicetype",
         "location",
+        "powerfeed",
         "rack",
         "rackgroup",
-        "devicetype",
-        "device",
+        "softwareversion",
         "virtualchassis",
-        "cable",
-        "powerfeed",
     ]
 
     def ready(self):

nautobot/dcim/elevations.py

@@ -3,6 +3,8 @@ from django.urls import reverse
 from django.utils.http import urlencode
 import svgwrite
 
+from nautobot.core.utils.config import get_settings_or_config
+
 from .choices import DeviceFaceChoices
 from .constants import RACK_ELEVATION_BORDER_WIDTH
 
@@ -233,7 +235,9 @@ class RackElevationSVG:
                 start_y + unit_height / 2 + RACK_ELEVATION_BORDER_WIDTH,
             )
             unit = ru + 1 if self.rack.desc_units else self.rack.u_height - ru
-            drawing.add(drawing.text(str(unit), position_coordinates, class_="unit"))
+            unit_two_digit_format = get_settings_or_config("RACK_ELEVATION_UNIT_TWO_DIGIT_FORMAT")
+            unit_display = f"{unit:02d}" if unit_two_digit_format else str(unit)
+            drawing.add(drawing.text(unit_display, position_coordinates, class_="unit"))
 
         for unit in self.merge_elevations(face):
             # Loop through all units in the elevation

nautobot/dcim/tables/devices.py

@@ -919,7 +919,7 @@ class VirtualChassisTable(BaseTable):
     master = tables.Column(linkify=True)
     member_count = LinkedCountColumn(
         viewname="dcim:device_list",
-        url_params={"virtual_chassis_id": "pk"},
+        url_params={"virtual_chassis": "pk"},
         verbose_name="Members",
     )
     tags = TagColumn(url_name="dcim:virtualchassis_list")

nautobot/dcim/templates/dcim/device/lldp_neighbors.html

@@ -64,6 +64,13 @@ var ready = (callback) => {
     }
 };
 
+function getAttribute(node, querySelector, attribute) {
+    if (node === null or node.querySelector(querySelector) === null) {
+        return "";
+    }
+    return node.querySelector(querySelector).getAttribute(attribute) || "";
+}
+
 ready(() => {
     fetch("{% url 'dcim-api:device-napalm' pk=object.pk %}?method=get_lldp_neighbors_detail")
     .then((response) => {
@@ -80,10 +87,10 @@ ready(() => {
             // var row = $('*[data-interface-name="' + iface.split(".")[0].replace(/([\/:])/g, "\\$1") + '"]');
 
             // Glean configured hostnames/interfaces from the DOM
-            const configured_device = row.querySelector('td.configured_device').getAttribute('data');
-            const configured_chassis = row.querySelector('td.configured_device').getAttribute('data-chassis');
-            const configured_interface = row.querySelector('td.configured_interface').getAttribute('data-interface-name').toLowerCase();
-            const configured_mac_address = row.querySelector('td.configured_mac').getAttribute('data-mac-address').toLowerCase();
+            const configured_device = getAttribute(row, 'td.configured_device', 'data');
+            const configured_chassis = getAttribute(row, 'td.configured_device', 'data-chassis');
+            const configured_interface = getAttribute(row, 'td.configured_interface', 'data-interface-name').toLowerCase();
+            const configured_mac_address = getAttribute(row, 'td.configured_mac', 'data-mac-address').toLowerCase();
             let configured_interface_short = null;
             if (configured_interface) {
                 // Match long-form IOS names against short ones (e.g. Gi0/1 == GigabitEthernet0/1).
@@ -122,5 +129,6 @@ ready(() => {
         }
     });
 });
+
 </script>
 {% endblock %}

nautobot/dcim/templates/dcim/device.html

@@ -360,7 +360,7 @@
         </div>
     </div>
   </div>
-{% if is_contact_associatable_model %}
+{% if object.is_contact_associable_model %}
     <div id="contacts" role="tabpanel" class="tab-pane {% if request.GET.tab == 'contacts' %}active{% else %}fade{% endif %}">
         <div class="row">
             <div class="col-md-12">

nautobot/dcim/templates/dcim/devicefamily_retrieve.html

@@ -18,6 +18,10 @@
                     <td>Device Types</td>
                     <td><a href="{% url 'dcim:devicetype_list' %}?device_family={{ object.name }}">{{ object.device_type_count }}</a></td>
                 </tr>
+                <tr>
+                    <td>Total Devices</td>
+                    <td>{{ total_devices }}</td>
+                </tr>
             </table>
         </div>
 {% endblock %}

nautobot/dcim/templates/dcim/softwareimagefile_retrieve.html

@@ -169,7 +169,7 @@
                 </div>
             </div>
         </div>
-        {% if is_contact_associatable_model %}
+        {% if object.is_contact_associable_model %}
             <div id="contacts" role="tabpanel" class="tab-pane {% if request.GET.tab == 'contacts' %}active{% else %}fade{% endif %}">
                 <div class="row">
                     <div class="col-md-12">

nautobot/dcim/tests/test_api.py

@@ -618,6 +618,42 @@ class RackTest(APIViewTestCases.APIViewTestCase):
         self.assertEqual(response.get("Content-Type"), "image/svg+xml")
         self.assertIn(b'class="slot" height="19" width="190"', response.content)
 
+    @override_settings(
+        RACK_ELEVATION_UNIT_TWO_DIGIT_FORMAT=False,
+        RACK_ELEVATION_DEFAULT_UNIT_HEIGHT=22,
+        RACK_ELEVATION_DEFAULT_UNIT_WIDTH=230,
+    )
+    @override_config(RACK_ELEVATION_UNIT_TWO_DIGIT_FORMAT=True)
+    def test_get_rack_elevation_unit_svg_settings_overridden(self):
+        """
+        GET a single rack elevation in SVG format, with Django settings specifying the default RU display format
+        """
+        rack = Rack.objects.first()
+        self.add_permissions("dcim.view_rack")
+        reverse_url = reverse("dcim-api:rack-elevation", kwargs={"pk": rack.pk})
+        url = f"{reverse_url}?render=svg"
+
+        response = self.client.get(url, **self.header)
+        self.assertHttpStatus(response, status.HTTP_200_OK)
+        self.assertEqual(response.get("Content-Type"), "image/svg+xml")
+        self.assertIn(b'<text class="unit" x="15.0" y="915.0">1</text>', response.content)
+
+    @override_settings(RACK_ELEVATION_DEFAULT_UNIT_HEIGHT=22, RACK_ELEVATION_DEFAULT_UNIT_WIDTH=230)
+    @override_config(RACK_ELEVATION_UNIT_TWO_DIGIT_FORMAT=True)
+    def test_get_rack_elevation_unit_svg_config_overridden(self):
+        """
+        GET a single rack elevation in SVG format, with Constance config specifying the 2-digit RU display format
+        """
+        rack = Rack.objects.first()
+        self.add_permissions("dcim.view_rack")
+        reverse_url = reverse("dcim-api:rack-elevation", kwargs={"pk": rack.pk})
+        url = f"{reverse_url}?render=svg"
+
+        response = self.client.get(url, **self.header)
+        self.assertHttpStatus(response, status.HTTP_200_OK)
+        self.assertEqual(response.get("Content-Type"), "image/svg+xml")
+        self.assertIn(b'<text class="unit" x="15.0" y="915.0">01</text>', response.content)
+
     def test_detail_view_schema(self):
         url = self._get_detail_url(self._get_queryset().first())
         response = self.client.options(url, **self.header)

nautobot/dcim/tests/test_signals.py

@@ -1,4 +1,4 @@
-"""Tests for DCIM Signals.py """
+"""Tests for DCIM Signals.py"""
 
 from django.test import TestCase
 

nautobot/dcim/views.py

@@ -2978,6 +2978,12 @@ class DeviceFamilyUIViewSet(NautobotUIViewSet):
             RequestConfig(request, paginate).configure(device_type_table)
 
             context["device_type_table"] = device_type_table
+
+            total_devices = 0
+            for device_type in device_types:
+                total_devices += device_type.device_count
+            context["total_devices"] = total_devices
+
         return context
 
 

nautobot/extras/api/serializers.py

@@ -193,10 +193,18 @@ class ContactSerializer(NautobotModelSerializer):
     class Meta:
         model = Contact
         fields = "__all__"
+        # https://www.django-rest-framework.org/api-guide/validators/#optional-fields
+        validators = []
+        extra_kwargs = {
+            "email": {"default": ""},
+            "phone": {"default": ""},
+        }
 
     def validate(self, data):
         attrs = data.copy()
         attrs.pop("teams", None)
+        validator = UniqueTogetherValidator(queryset=Contact.objects.all(), fields=("name", "phone", "email"))
+        validator(attrs, self)
         super().validate(attrs)
         return data
 
@@ -946,7 +954,18 @@ class TeamSerializer(NautobotModelSerializer):
     class Meta:
         model = Team
         fields = "__all__"
-        extra_kwargs = {"contacts": {"required": False}}
+        extra_kwargs = {
+            "contacts": {"required": False},
+            "email": {"default": ""},
+            "phone": {"default": ""},
+        }
+        # https://www.django-rest-framework.org/api-guide/validators/#optional-fields
+        validators = []
+
+    def validate(self, data):
+        validator = UniqueTogetherValidator(queryset=Team.objects.all(), fields=("name", "phone", "email"))
+        validator(data, self)
+        return super().validate(data)
 
 
 #

nautobot/extras/apps.py

@@ -12,6 +12,13 @@ logger = logging.getLogger(__name__)
 
 class ExtrasConfig(NautobotConfig):
     name = "nautobot.extras"
+    searchable_models = [
+        "contact",
+        "dynamicgroup",
+        "externalintegration",
+        "gitrepository",
+        "team",
+    ]
 
     def ready(self):
         super().ready()

nautobot/extras/context_managers.py

@@ -7,7 +7,7 @@ from django.test.client import RequestFactory
 
 from nautobot.extras.choices import ObjectChangeEventContextChoices
 from nautobot.extras.models import ObjectChange
-from nautobot.extras.signals import change_context_state
+from nautobot.extras.signals import change_context_state, get_user_if_authenticated
 from nautobot.extras.webhooks import enqueue_webhooks
 
 
@@ -46,11 +46,22 @@ class ChangeContext:
         if self.change_id is None:
             self.change_id = uuid.uuid4()
 
-    def get_user(self):
+    def get_user(self, instance=None):
         """Return self.user if set, otherwise return self.request.user"""
         if self.user is not None:
-            return self.user
-        return self.request.user
+            return get_user_if_authenticated(self.user, instance)
+        return get_user_if_authenticated(self.request.user, instance)
+
+    def as_dict(self, instance=None):
+        """
+        Return ChangeContext attributes in dictionary format
+        """
+        context = {
+            "user": self.get_user(instance),
+            "change_id": self.change_id,
+            "context": self.context,
+        }
+        return context
 
 
 class JobChangeContext(ChangeContext):

nautobot/extras/filters/customfields.py

@@ -8,8 +8,9 @@ from nautobot.core.filters import (
     MultiValueNumberFilter,
 )
 from nautobot.core.forms import NullableDateField
-from nautobot.core.forms.widgets import StaticSelect2Multiple
+from nautobot.core.utils.data import is_uuid
 from nautobot.extras.choices import CustomFieldFilterLogicChoices, CustomFieldTypeChoices
+from nautobot.extras.models import CustomFieldChoice
 
 EXACT_FILTER_TYPES = (
     CustomFieldTypeChoices.TYPE_BOOLEAN,
@@ -71,19 +72,23 @@ class CustomFieldJSONFilter(CustomFieldFilterMixin, django_filters.Filter):
     """Custom field single value filter for backwards compatibility"""
 
 
-class CustomFieldMultiSelectFilter(CustomFieldFilterMixin, MultiValueCharFilter):
-    """This provides functionality for filtering custom fields with multiple  select type"""
+class CustomFieldSelectFilter(CustomFieldFilterMixin, MultiValueCharFilter):
+    """Filter for custom fields of type TYPE_SELECT."""
 
-    def __init__(self, *args, **kwargs):
-        kwargs.setdefault("lookup_expr", "contains")
-        super().__init__(*args, **kwargs)
+    def get_filter_predicate(self, v):
+        if is_uuid(v):
+            try:
+                v = self.custom_field.custom_field_choices.get(pk=v).value
+            except CustomFieldChoice.DoesNotExist:
+                v = ""
+        return super().get_filter_predicate(v)
 
 
-class CustomFieldMultiValueSelectFilter(CustomFieldFilterMixin, django_filters.MultipleChoiceFilter):
-    """This provides functionality for filtering custom fields with select type"""
+class CustomFieldMultiSelectFilter(CustomFieldSelectFilter):
+    """Filter for custom fields of type TYPE_MULTISELECT."""
 
     def __init__(self, *args, **kwargs):
-        self.field_class.widget = StaticSelect2Multiple
+        kwargs.setdefault("lookup_expr", "contains")
         super().__init__(*args, **kwargs)
 
 

nautobot/extras/filters/mixins.py

@@ -27,6 +27,7 @@ from nautobot.extras.filters.customfields import (
     CustomFieldMultiValueDateFilter,
     CustomFieldMultiValueNumberFilter,
     CustomFieldNumberFilter,
+    CustomFieldSelectFilter,
 )
 from nautobot.extras.models import (
     ConfigContextSchema,
@@ -61,12 +62,16 @@ class CustomFieldModelFilterSetMixin(django_filters.FilterSet):
         super().__init__(*args, **kwargs)
 
         custom_field_filter_classes = {
+            # Here, for the "base" filters for each custom field, for backwards compatibility, use single-value filters.
+            # For the "extended" filters, see below, we use multi-value filters.
+            # 3.0 TODO: switch the "base" filters to multi-value filters as well.
             CustomFieldTypeChoices.TYPE_DATE: CustomFieldDateFilter,
             CustomFieldTypeChoices.TYPE_BOOLEAN: CustomFieldBooleanFilter,
             CustomFieldTypeChoices.TYPE_INTEGER: CustomFieldNumberFilter,
             CustomFieldTypeChoices.TYPE_JSON: CustomFieldJSONFilter,
+            # The below are multi-value filters already:
             CustomFieldTypeChoices.TYPE_MULTISELECT: CustomFieldMultiSelectFilter,
-            CustomFieldTypeChoices.TYPE_SELECT: CustomFieldMultiSelectFilter,
+            CustomFieldTypeChoices.TYPE_SELECT: CustomFieldSelectFilter,
         }
 
         custom_fields = CustomField.objects.get_for_model(self._meta.model, exclude_filter_disabled=True)

nautobot/extras/health_checks.py

@@ -1,4 +1,5 @@
 """Nautobot custom health checks."""
+
 from typing import Optional
 from urllib.parse import urlparse
 

nautobot/extras/jobs.py

@@ -1,4 +1,5 @@
 """Jobs functionality - consolidates and replaces legacy "custom scripts" and "reports" features."""
+
 from collections import OrderedDict
 import functools
 import inspect

nautobot/extras/managers.py

@@ -1,6 +1,5 @@
 from celery import states
 from django.utils import timezone
-from django_celery_beat.managers import ExtendedManager
 from django_celery_results.managers import TaskResultManager, transaction_retry
 
 from nautobot.core.models import BaseManager
@@ -136,5 +135,5 @@ class JobResultManager(BaseManager.from_queryset(RestrictedQuerySet), TaskResult
         return obj
 
 
-class ScheduledJobsManager(BaseManager.from_queryset(RestrictedQuerySet), ExtendedManager):
+class ScheduledJobsManager(BaseManager.from_queryset(RestrictedQuerySet)):
     pass

nautobot/extras/models/contacts.py

@@ -19,6 +19,7 @@ class ContactTeamSharedBase(PrimaryModel):
     address = models.TextField(blank=True)
 
     comments = models.TextField(blank=True)
+    is_contact_associable_model = False
 
     class Meta:
         abstract = True

nautobot/extras/models/customfields.py

@@ -724,7 +724,16 @@ class CustomField(BaseModel, ChangeLoggedModel, NotesMixin):
 
         super().delete(*args, **kwargs)
 
-        delete_custom_field_data.delay(self.key, content_types)
+        # Circular Import
+        from nautobot.extras.signals import change_context_state
+
+        change_context = change_context_state.get()
+        if change_context is None:
+            context = None
+        else:
+            context = change_context.as_dict(instance=self)
+            context["context_detail"] = "delete custom field data"
+        delete_custom_field_data.delay(self.key, content_types, context)
 
     def add_prefix_to_cf_key(self):
         return "cf_" + str(self.key)
@@ -783,8 +792,22 @@ class CustomFieldChoice(BaseModel, ChangeLoggedModel):
         super().save(*args, **kwargs)
 
         if self.value != database_object.value:
+            # Circular Import
+            from nautobot.extras.signals import change_context_state
+
+            change_context = change_context_state.get()
+            if change_context is None:
+                context = None
+            else:
+                context = change_context.as_dict(instance=self)
+                context["context_detail"] = "update custom field choice data"
             transaction.on_commit(
-                lambda: update_custom_field_choice_data.delay(self.custom_field.pk, database_object.value, self.value)
+                lambda: update_custom_field_choice_data.delay(
+                    self.custom_field.pk,
+                    database_object.value,
+                    self.value,
+                    context,
+                )
             )
 
     def delete(self, *args, **kwargs):

nautobot/extras/models/datasources.py

@@ -1,4 +1,5 @@
 """Models for representing external data sources."""
+
 from importlib.util import find_spec
 import os
 

nautobot/extras/models/mixins.py

@@ -1,6 +1,7 @@
 """
 Class-modifying mixins that need to be standalone to avoid circular imports.
 """
+
 from django.urls import NoReverseMatch, reverse
 
 from nautobot.core.utils.lookup import get_route_for_model

nautobot/extras/plugins/__init__.py

@@ -4,6 +4,7 @@ from importlib import import_module
 import inspect
 from logging import getLogger
 
+from django.conf import settings
 from django.core.exceptions import ValidationError
 from django.template.loader import get_template
 from django.urls import get_resolver, URLPattern
@@ -147,7 +148,7 @@ class NautobotAppConfig(NautobotConfig):
 
         # Import metrics (if present)
         metrics = import_object(f"{self.__module__}.{self.metrics}")
-        if metrics is not None:
+        if metrics is not None and self.name not in settings.METRICS_DISABLED_APPS:
             register_metrics(metrics)
             self.features["metrics"] = []  # Initialize as empty, to be filled by the signal handler
             # Inject the metrics to discover into the signal handler.

nautobot/extras/querysets.py

@@ -3,7 +3,6 @@ from django.contrib.contenttypes.models import ContentType
 from django.core.cache import cache
 from django.db.models import F, Model, OuterRef, Q, Subquery
 from django.db.models.functions import JSONObject
-from django_celery_beat.managers import ExtendedQuerySet
 
 from nautobot.core.models.query_functions import EmptyGroupByJSONBAgg
 from nautobot.core.models.querysets import RestrictedQuerySet
@@ -272,7 +271,7 @@ class JobQuerySet(RestrictedQuerySet):
         )
 
 
-class ScheduledJobExtendedQuerySet(RestrictedQuerySet, ExtendedQuerySet):
+class ScheduledJobExtendedQuerySet(RestrictedQuerySet):
     """
     Base queryset used for the ScheduledJob class
     """

nautobot/extras/secrets/providers.py

@@ -2,6 +2,7 @@
 
 Plugins may define and register additional providers in addition to these.
 """
+
 import os
 
 from django import forms

nautobot/extras/signals.py

@@ -52,7 +52,7 @@ logger = logging.getLogger(__name__)
 #
 
 
-def _get_user_if_authenticated(user, instance):
+def get_user_if_authenticated(user, instance):
     """Return the user object associated with the request if the user is defined.
 
     If the user is not defined, log a warning to indicate that the user couldn't be retrived from the request
@@ -119,7 +119,7 @@ def _handle_changed_object(sender, instance, raw=False, **kwargs):
 
     # Record an ObjectChange if applicable
     if hasattr(instance, "to_objectchange"):
-        user = _get_user_if_authenticated(change_context_state.get().get_user(), instance)
+        user = change_context_state.get().get_user(instance)
         # save a copy of this instance's field cache so it can be restored after serialization
         # to prevent unexpected behavior when chaining multiple signal handlers
         original_cache = instance._state.fields_cache.copy()
@@ -186,7 +186,7 @@ def _handle_deleted_object(sender, instance, **kwargs):
 
     # Record an ObjectChange if applicable
     if hasattr(instance, "to_objectchange"):
-        user = _get_user_if_authenticated(change_context_state.get().get_user(), instance)
+        user = change_context_state.get().get_user(instance)
 
         # save a copy of this instance's field cache so it can be restored after serialization
         # to prevent unexpected behavior when chaining multiple signal handlers
@@ -238,13 +238,23 @@ def handle_cf_removed_obj_types(instance, action, pk_set, **kwargs):
     """
     Handle the cleanup of old custom field data when a CustomField is removed from one or more ContentTypes.
     """
+
+    change_context = change_context_state.get()
+    if change_context is None:
+        context = None
+    else:
+        context = change_context.as_dict(instance=instance)
     if action == "post_remove":
         # Existing content types have been removed from the custom field, delete their data
-        transaction.on_commit(lambda: delete_custom_field_data.delay(instance.key, pk_set))
+        if context:
+            context["context_detail"] = "delete custom field data from existing content types"
+        transaction.on_commit(lambda: delete_custom_field_data.delay(instance.key, pk_set, context))
 
     elif action == "post_add":
         # New content types have been added to the custom field, provision them
-        transaction.on_commit(lambda: provision_field.delay(instance.pk, pk_set))
+        if context:
+            context["context_detail"] = "provision custom field data for new content types"
+        transaction.on_commit(lambda: provision_field.delay(instance.pk, pk_set, context))
 
 
 m2m_changed.connect(handle_cf_removed_obj_types, sender=CustomField.content_types.through)