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

nautobot/extras/navigation.py

@@ -14,8 +14,50 @@ menu_items = (
         weight=100,
         groups=(
             NavMenuGroup(
-                name="Metadata",  # TODO: is there a better name for this grouping?
+                name="Contacts",
                 weight=400,
+                items=(
+                    NavMenuItem(
+                        link="extras:contact_list",
+                        name="Contacts",
+                        weight=100,
+                        permissions=["extras.view_contact"],
+                        buttons=[NavMenuAddButton(link="extras:contact_add", permissions=["extras.add_contact"])],
+                    ),
+                    NavMenuItem(
+                        link="extras:team_list",
+                        name="Teams",
+                        weight=200,
+                        permissions=["extras.view_team"],
+                        buttons=[NavMenuAddButton(link="extras:team_add", permissions=["extras.add_team"])],
+                    ),
+                ),
+            ),
+            NavMenuGroup(
+                name="Groups",
+                weight=500,
+                items=(
+                    NavMenuItem(
+                        link="extras:dynamicgroup_list",
+                        name="Dynamic Groups",
+                        weight=100,
+                        permissions=[
+                            "extras.view_dynamicgroup",
+                        ],
+                        buttons=(
+                            NavMenuAddButton(
+                                link="extras:dynamicgroup_add",
+                                permissions=[
+                                    "extras.add_dynamicgroup",
+                                ],
+                            ),
+                        ),
+                    ),
+                ),
+            ),
+            NavMenuGroup(
+                name="Metadata",  # TODO: is there a better name for this grouping?
+                weight=600,
                 items=(
                     NavMenuItem(
                         link="extras:tag_list",
@@ -65,42 +107,6 @@ menu_items = (
                             ),
                         ),
                     ),
-                    NavMenuItem(
-                        link="extras:contact_list",
-                        name="Contacts",
-                        weight=400,
-                        permissions=["extras.view_contact"],
-                        buttons=[NavMenuAddButton(link="extras:contact_add", permissions=["extras.add_contact"])],
-                    ),
-                    NavMenuItem(
-                        link="extras:team_list",
-                        name="Teams",
-                        weight=500,
-                        permissions=["extras.view_team"],
-                        buttons=[NavMenuAddButton(link="extras:team_add", permissions=["extras.add_team"])],
-                    ),
-                ),
-            ),
-            NavMenuGroup(
-                name="Dynamic Groups",
-                weight=500,
-                items=(
-                    NavMenuItem(
-                        link="extras:dynamicgroup_list",
-                        name="Dynamic Groups",
-                        weight=100,
-                        permissions=[
-                            "extras.view_dynamicgroup",
-                        ],
-                        buttons=(
-                            NavMenuAddButton(
-                                link="extras:dynamicgroup_add",
-                                permissions=[
-                                    "extras.add_dynamicgroup",
-                                ],
-                            ),
-                        ),
-                    ),
                 ),
             ),
         ),
@@ -276,22 +282,6 @@ menu_items = (
                             ),
                         ),
                     ),
-                    NavMenuItem(
-                        link="extras:relationship_list",
-                        name="Relationships",
-                        weight=200,
-                        permissions=[
-                            "extras.view_relationship",
-                        ],
-                        buttons=(
-                            NavMenuAddButton(
-                                link="extras:relationship_add",
-                                permissions=[
-                                    "extras.add_relationship",
-                                ],
-                            ),
-                        ),
-                    ),
                     NavMenuItem(
                         link="extras:note_list",
                         name="Notes",
@@ -389,37 +379,53 @@ menu_items = (
                 ),
             ),
             NavMenuGroup(
-                name="Miscellaneous",
+                name="Data Model",
                 weight=600,
                 items=(
                     NavMenuItem(
-                        link="extras:computedfield_list",
-                        name="Computed Fields",
+                        link="extras:customfield_list",
+                        name="Custom Fields",
                         weight=100,
                         permissions=[
-                            "extras.view_computedfield",
+                            "extras.view_customfield",
                         ],
                         buttons=(
                             NavMenuAddButton(
-                                link="extras:computedfield_add",
+                                link="extras:customfield_add",
                                 permissions=[
-                                    "extras.add_computedfield",
+                                    "extras.add_customfield",
                                 ],
                             ),
                         ),
                     ),
                     NavMenuItem(
-                        link="extras:customfield_list",
-                        name="Custom Fields",
+                        link="extras:relationship_list",
+                        name="Relationships",
                         weight=200,
                         permissions=[
-                            "extras.view_customfield",
+                            "extras.view_relationship",
                         ],
                         buttons=(
                             NavMenuAddButton(
-                                link="extras:customfield_add",
+                                link="extras:relationship_add",
                                 permissions=[
-                                    "extras.add_customfield",
+                                    "extras.add_relationship",
+                                ],
+                            ),
+                        ),
+                    ),
+                    NavMenuItem(
+                        link="extras:computedfield_list",
+                        name="Computed Fields",
+                        weight=300,
+                        permissions=[
+                            "extras.view_computedfield",
+                        ],
+                        buttons=(
+                            NavMenuAddButton(
+                                link="extras:computedfield_add",
+                                permissions=[
+                                    "extras.add_computedfield",
                                 ],
                             ),
                         ),
@@ -427,7 +433,7 @@ menu_items = (
                     NavMenuItem(
                         link="extras:customlink_list",
                         name="Custom Links",
-                        weight=300,
+                        weight=400,
                         permissions=[
                             "extras.view_customlink",
                         ],

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/plugins/views.py

@@ -2,11 +2,9 @@ from collections import OrderedDict
 
 from django.apps import apps
 from django.conf import settings
-from django.contrib.auth.mixins import LoginRequiredMixin
 from django.http import Http404
 from django.shortcuts import render
 from django.urls.exceptions import NoReverseMatch
-from django.views.generic import View
 from django_tables2 import RequestConfig
 from drf_spectacular.utils import extend_schema
 from rest_framework import permissions
@@ -14,13 +12,14 @@ from rest_framework.response import Response
 from rest_framework.reverse import reverse
 from rest_framework.views import APIView
 
-from nautobot.core.api.views import NautobotAPIVersionMixin
+from nautobot.core.api.views import AuthenticatedAPIRootView, NautobotAPIVersionMixin
 from nautobot.core.forms import TableConfigForm
+from nautobot.core.views.generic import GenericView
 from nautobot.core.views.paginator import EnhancedPaginator, get_paginate_count
 from nautobot.extras.plugins.tables import InstalledAppsTable
 
 
-class InstalledAppsView(LoginRequiredMixin, View):
+class InstalledAppsView(GenericView):
     """
     View for listing all installed Apps.
     """
@@ -66,7 +65,7 @@ class InstalledAppsView(LoginRequiredMixin, View):
         )
 
 
-class InstalledAppDetailView(LoginRequiredMixin, View):
+class InstalledAppDetailView(GenericView):
     """
     View for showing details of an installed App.
     """
@@ -93,7 +92,6 @@ class InstalledAppsAPIView(NautobotAPIVersionMixin, APIView):
     """
 
     permission_classes = [permissions.IsAdminUser]
-    _ignore_model_permissions = True
 
     def get_view_name(self):
         return "Installed Apps"
@@ -129,11 +127,9 @@ class InstalledAppsAPIView(NautobotAPIVersionMixin, APIView):
         return Response([self._get_app_data(apps.get_app_config(app)) for app in settings.PLUGINS])
 
 
-class AppsAPIRootView(NautobotAPIVersionMixin, APIView):
-    _ignore_model_permissions = True
-
-    def get_view_name(self):
-        return "Apps"
+class AppsAPIRootView(AuthenticatedAPIRootView):
+    name = "Apps"
+    description = "API extension point for installed Nautobot Apps"
 
     @staticmethod
     def _get_app_entry(app_config, request, format_):

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)

nautobot/extras/tasks.py

@@ -14,7 +14,7 @@ logger = getLogger("nautobot.extras.tasks")
 
 
 @nautobot_task
-def update_custom_field_choice_data(field_id, old_value, new_value):
+def update_custom_field_choice_data(field_id, old_value, new_value, change_context=None):
     """
     Update the values for a custom field choice used in objects' _custom_field_data for the given field.
 
@@ -23,6 +23,8 @@ def update_custom_field_choice_data(field_id, old_value, new_value):
         old_value (str): The existing value of the choice
         new_value (str): The value which will be used as replacement
     """
+    # Circular Import
+    from nautobot.extras.context_managers import web_request_context
     from nautobot.extras.models import CustomField
 
     try:
@@ -35,19 +37,43 @@ def update_custom_field_choice_data(field_id, old_value, new_value):
         # Loop through all field content types and search for values to update
         for ct in field.content_types.all():
             model = ct.model_class()
-            for obj in model.objects.filter(**{f"_custom_field_data__{field.key}": old_value}):
-                obj._custom_field_data[field.key] = new_value
-                obj.save()
+            if change_context is not None:
+                with web_request_context(
+                    user=change_context.get("user"),
+                    change_id=change_context.get("change_id"),
+                    context_detail=change_context.get("context_detail"),
+                    context=change_context.get("context"),
+                ):
+                    for obj in model.objects.filter(**{f"_custom_field_data__{field.key}": old_value}):
+                        obj._custom_field_data[field.key] = new_value
+                        obj.save()
+            else:
+                for obj in model.objects.filter(**{f"_custom_field_data__{field.key}": old_value}):
+                    obj._custom_field_data[field.key] = new_value
+                    obj.save()
 
     elif field.type == CustomFieldTypeChoices.TYPE_MULTISELECT:
         # Loop through all field content types and search for values to update
         for ct in field.content_types.all():
             model = ct.model_class()
-            for obj in model.objects.filter(**{f"_custom_field_data__{field.key}__contains": old_value}):
-                old_list = obj._custom_field_data[field.key]
-                new_list = [new_value if e == old_value else e for e in old_list]
-                obj._custom_field_data[field.key] = new_list
-                obj.save()
+            if change_context is not None:
+                with web_request_context(
+                    user=change_context.get("user"),
+                    change_id=change_context.get("change_id"),
+                    context_detail=change_context.get("context_detail"),
+                    context=change_context.get("context"),
+                ):
+                    for obj in model.objects.filter(**{f"_custom_field_data__{field.key}__contains": old_value}):
+                        old_list = obj._custom_field_data[field.key]
+                        new_list = [new_value if e == old_value else e for e in old_list]
+                        obj._custom_field_data[field.key] = new_list
+                        obj.save()
+            else:
+                for obj in model.objects.filter(**{f"_custom_field_data__{field.key}__contains": old_value}):
+                    old_list = obj._custom_field_data[field.key]
+                    new_list = [new_value if e == old_value else e for e in old_list]
+                    obj._custom_field_data[field.key] = new_list
+                    obj.save()
 
     else:
         logger.error(f"Unknown field type, failing to act on choice data for this field {field.key}.")
@@ -57,7 +83,7 @@ def update_custom_field_choice_data(field_id, old_value, new_value):
 
 
 @nautobot_task
-def delete_custom_field_data(field_key, content_type_pk_set):
+def delete_custom_field_data(field_key, content_type_pk_set, change_context=None):
     """
     Delete the values for a custom field
 
@@ -65,16 +91,30 @@ def delete_custom_field_data(field_key, content_type_pk_set):
         field_key (str): The key of the custom field which is being deleted
         content_type_pk_set (list): List of PKs for content types to act upon
     """
+    # Circular Import
+    from nautobot.extras.context_managers import web_request_context
+
     with transaction.atomic():
         for ct in ContentType.objects.filter(pk__in=content_type_pk_set):
             model = ct.model_class()
-            for obj in model.objects.filter(**{f"_custom_field_data__{field_key}__isnull": False}):
-                del obj._custom_field_data[field_key]
-                obj.save()
+            if change_context is not None:
+                with web_request_context(
+                    user=change_context.get("user"),
+                    change_id=change_context.get("change_id"),
+                    context_detail=change_context.get("context_detail"),
+                    context=change_context.get("context"),
+                ):
+                    for obj in model.objects.filter(**{f"_custom_field_data__{field_key}__isnull": False}):
+                        del obj._custom_field_data[field_key]
+                        obj.save()
+            else:
+                for obj in model.objects.filter(**{f"_custom_field_data__{field_key}__isnull": False}):
+                    del obj._custom_field_data[field_key]
+                    obj.save()
 
 
 @nautobot_task
-def provision_field(field_id, content_type_pk_set):
+def provision_field(field_id, content_type_pk_set, change_context=None):
     """
     Provision a new custom field on all relevant content type object instances.
 
@@ -82,6 +122,8 @@ def provision_field(field_id, content_type_pk_set):
         field_id (uuid4): The PK of the custom field being provisioned
         content_type_pk_set (list): List of PKs for content types to act upon
     """
+    # Circular Import
+    from nautobot.extras.context_managers import web_request_context
     from nautobot.extras.models import CustomField
 
     try:
@@ -93,9 +135,20 @@ def provision_field(field_id, content_type_pk_set):
     with transaction.atomic():
         for ct in ContentType.objects.filter(pk__in=content_type_pk_set):
             model = ct.model_class()
-            for obj in model.objects.all():
-                obj._custom_field_data.setdefault(field.key, field.default)
-                obj.save()
+            if change_context is not None:
+                with web_request_context(
+                    user=change_context.get("user"),
+                    change_id=change_context.get("change_id"),
+                    context_detail=change_context.get("context_detail"),
+                    context=change_context.get("context"),
+                ):
+                    for obj in model.objects.all():
+                        obj._custom_field_data.setdefault(field.key, field.default)
+                        obj.save()
+            else:
+                for obj in model.objects.all():
+                    obj._custom_field_data.setdefault(field.key, field.default)
+                    obj.save()
 
     return True
 

nautobot/extras/tests/test_api.py

@@ -18,6 +18,7 @@ from nautobot.core.testing import APITestCase, APIViewTestCases
 from nautobot.core.testing.utils import disable_warnings
 from nautobot.core.utils.lookup import get_route_for_model
 from nautobot.dcim.models import (
+    Controller,
     Device,
     DeviceType,
     Location,
@@ -408,11 +409,9 @@ class ContactTest(APIViewTestCases.APIViewTestCase):
             {
                 "name": "Contact 3",
                 "phone": "555-0123",
-                "email": "",
             },
             {
                 "name": "Contact 4",
-                "phone": "",
                 "email": "contact4@example.com",
             },
         ]
@@ -2851,6 +2850,7 @@ class RelationshipTest(APIViewTestCases.APIViewTestCase, RequiredRelationshipTes
         vlan_groups = VLANGroup.objects.all()[:2]
 
         # Try deleting all devices and then creating 2 VLANs (fails):
+        Controller.objects.filter(controller_device__isnull=False).delete()
         Device.objects.all().delete()
         response = send_bulk_data(
             "post",
@@ -3611,11 +3611,9 @@ class TeamTest(APIViewTestCases.APIViewTestCase):
             {
                 "name": "Team 3",
                 "phone": "555-0123",
-                "email": "",
             },
             {
                 "name": "Team 4",
-                "phone": "",
                 "email": "team4@example.com",
                 "address": "Rainbow Bridge, Central NJ",
             },