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

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

@@ -409,11 +409,9 @@ class ContactTest(APIViewTestCases.APIViewTestCase):
             {
                 "name": "Contact 3",
                 "phone": "555-0123",
-                "email": "",
             },
             {
                 "name": "Contact 4",
-                "phone": "",
                 "email": "contact4@example.com",
             },
         ]
@@ -3613,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",
             },

nautobot/extras/tests/test_customfields.py

@@ -16,11 +16,13 @@ from nautobot.core.tables import CustomFieldColumn
 from nautobot.core.testing import APITestCase, TestCase, TransactionTestCase
 from nautobot.core.testing.models import ModelTestCases
 from nautobot.core.testing.utils import post_data
+from nautobot.core.utils.lookup import get_changes_for_model
 from nautobot.dcim.filters import LocationFilterSet
 from nautobot.dcim.forms import RackFilterForm
 from nautobot.dcim.models import Device, Location, LocationType, Rack
 from nautobot.dcim.tables import LocationTable
 from nautobot.extras.choices import CustomFieldFilterLogicChoices, CustomFieldTypeChoices
+from nautobot.extras.context_managers import web_request_context
 from nautobot.extras.models import ComputedField, CustomField, CustomFieldChoice, Status
 from nautobot.users.models import ObjectPermission
 from nautobot.virtualization.models import VirtualMachine
@@ -1537,8 +1539,10 @@ class CustomFieldFilterTest(TestCase):
         cf.save()
         cf.content_types.set([obj_type])
 
-        CustomFieldChoice.objects.create(custom_field=cf, value="Foo")
-        CustomFieldChoice.objects.create(custom_field=cf, value="Bar")
+        cls.select_choices = (
+            CustomFieldChoice.objects.create(custom_field=cf, value="Foo"),
+            CustomFieldChoice.objects.create(custom_field=cf, value="Bar"),
+        )
 
         # Multi-select filtering
         cf = CustomField(
@@ -1548,8 +1552,11 @@ class CustomFieldFilterTest(TestCase):
         cf.save()
         cf.content_types.set([obj_type])
 
-        CustomFieldChoice.objects.create(custom_field=cf, value="Foo")
-        CustomFieldChoice.objects.create(custom_field=cf, value="Bar")
+        cls.multiselect_choices = (
+            CustomFieldChoice.objects.create(custom_field=cf, value="Foo"),
+            CustomFieldChoice.objects.create(custom_field=cf, value="Bar"),
+        )
+
         cls.location_type = LocationType.objects.get(name="Campus")
         location_status = Status.objects.get_for_model(Location).first()
         Location.objects.create(
@@ -1844,6 +1851,10 @@ class CustomFieldFilterTest(TestCase):
             self.filterset({"cf_cf8": ["Foo", "AR"]}, self.queryset).qs,
             self.queryset.filter(_custom_field_data__cf8__in=["Foo", "AR"]),
         )
+        self.assertQuerysetEqualAndNotEmpty(  # https://github.com/nautobot/nautobot/issues/5009
+            self.filterset({"cf_cf8": [str(choice.pk) for choice in self.select_choices]}, self.queryset).qs,
+            self.queryset.filter(_custom_field_data__cf8__in=[choice.value for choice in self.select_choices]),
+        )
         self.assertQuerysetEqual(
             self.filterset({"cf_cf8__n": ["Foo"]}, self.queryset).qs,
             self.queryset.exclude(_custom_field_data__cf8="Foo")
@@ -1913,6 +1924,10 @@ class CustomFieldFilterTest(TestCase):
             self.filterset({"cf_cf9": "Bar"}, self.queryset).qs,
             self.queryset.filter(_custom_field_data__cf9__contains="Bar"),
         )
+        self.assertQuerysetEqualAndNotEmpty(  # https://github.com/nautobot/nautobot/issues/5009
+            self.filterset({"cf_cf9": str(self.multiselect_choices[0].pk)}, self.queryset).qs,
+            self.queryset.filter(_custom_field_data__cf9__contains=self.multiselect_choices[0].value),
+        )
 
 
 class CustomFieldChoiceTest(ModelTestCases.BaseModelTestCase):
@@ -2016,30 +2031,64 @@ class CustomFieldBackgroundTasks(TransactionTestCase):
 
         self.assertEqual(location.cf["cf1"], "Foo")
 
+        with web_request_context(self.user):
+            cf = CustomField(label="CF2", type=CustomFieldTypeChoices.TYPE_TEXT, default="Bar")
+            cf.save()
+            cf.content_types.set([obj_type])
+
+            location.refresh_from_db()
+
+            self.assertEqual(location.cf["cf2"], "Bar")
+
+        oc_list = get_changes_for_model(location).order_by("pk")
+        self.assertEqual(len(oc_list), 1)
+        self.assertEqual(oc_list[0].changed_object, location)
+        self.assertEqual(oc_list[0].change_context_detail, "provision custom field data for new content types")
+        self.assertEqual(oc_list[0].user, self.user)
+
     def test_delete_custom_field_data_task(self):
         obj_type = ContentType.objects.get_for_model(Location)
-        cf = CustomField(
+        cf_1 = CustomField(
             label="CF1",
             type=CustomFieldTypeChoices.TYPE_TEXT,
         )
-        cf.save()
-        cf.content_types.set([obj_type])
+        cf_1.save()
+        cf_1.content_types.set([obj_type])
+        cf_2 = CustomField(
+            label="CF2",
+            type=CustomFieldTypeChoices.TYPE_TEXT,
+        )
+        cf_2.save()
+        cf_2.content_types.set([obj_type])
         location_type = LocationType.objects.create(name="Root Type 2")
         location_status = Status.objects.get_for_model(Location).first()
         location = Location(
             name="Location 1",
             location_type=location_type,
             status=location_status,
-            _custom_field_data={"cf1": "foo"},
+            _custom_field_data={"cf1": "foo", "cf2": "bar"},
         )
         location.save()
 
-        cf.delete()
+        cf_1.delete()
 
         location.refresh_from_db()
 
         self.assertTrue("cf1" not in location.cf)
 
+        with web_request_context(self.user):
+            cf_2.delete()
+
+            location.refresh_from_db()
+
+            self.assertTrue("cf2" not in location.cf)
+
+        oc_list = get_changes_for_model(location).order_by("pk")
+        self.assertEqual(len(oc_list), 1)
+        self.assertEqual(oc_list[0].changed_object, location)
+        self.assertEqual(oc_list[0].change_context_detail, "delete custom field data")
+        self.assertEqual(oc_list[0].user, self.user)
+
     def test_update_custom_field_choice_data_task(self):
         obj_type = ContentType.objects.get_for_model(Location)
         cf = CustomField(
@@ -2068,6 +2117,20 @@ class CustomFieldBackgroundTasks(TransactionTestCase):
 
         self.assertEqual(location.cf["cf1"], "Bar")
 
+        with web_request_context(self.user):
+            choice.value = "FizzBuzz"
+            choice.save()
+
+            location.refresh_from_db()
+
+            self.assertEqual(location.cf["cf1"], "FizzBuzz")
+
+        oc_list = get_changes_for_model(location).order_by("pk")
+        self.assertEqual(len(oc_list), 1)
+        self.assertEqual(oc_list[0].changed_object, location)
+        self.assertEqual(oc_list[0].change_context_detail, "update custom field choice data")
+        self.assertEqual(oc_list[0].user, self.user)
+
 
 class CustomFieldTableTest(TestCase):
     """

nautobot/extras/views.py

@@ -40,6 +40,7 @@ from nautobot.core.views.viewsets import NautobotUIViewSet
 from nautobot.dcim.models import Controller, Device, Interface, Location, Rack
 from nautobot.dcim.tables import ControllerTable, DeviceTable, RackTable
 from nautobot.extras.constants import JOB_OVERRIDABLE_FIELDS
+from nautobot.extras.signals import change_context_state
 from nautobot.extras.tasks import delete_custom_field_data
 from nautobot.extras.utils import get_base_template, get_worker_count
 from nautobot.ipam.models import IPAddress, Prefix, VLAN
@@ -369,7 +370,6 @@ class ContactUIViewSet(NautobotUIViewSet):
     queryset = Contact.objects.all()
     serializer_class = serializers.ContactSerializer
     table_class = tables.ContactTable
-    is_contact_associatable_model = False
 
     def get_extra_context(self, request, instance):
         context = super().get_extra_context(request, instance)
@@ -677,8 +677,14 @@ class CustomFieldBulkDeleteView(generic.BulkDeleteView):
         """
         Helper method to construct a list of celery tasks to execute when bulk deleting custom fields.
         """
+        change_context = change_context_state.get()
+        if change_context is None:
+            context = None
+        else:
+            context = change_context.as_dict(queryset)
+            context["context_detail"] = "bulk delete custom field data"
         tasks = [
-            delete_custom_field_data.si(obj.key, set(obj.content_types.values_list("pk", flat=True)))
+            delete_custom_field_data.si(obj.key, set(obj.content_types.values_list("pk", flat=True)), context)
             for obj in queryset
         ]
         return tasks
@@ -1939,8 +1945,6 @@ class ObjectChangeLogView(generic.GenericView):
                 "table": objectchanges_table,
                 "base_template": self.base_template,
                 "active_tab": "changelog",
-                # Currently only Contact and Team models are not contact_associatable.
-                "is_contact_associatable_model": type(obj) not in [Contact, Team],
             },
         )
 
@@ -2022,8 +2026,6 @@ class ObjectNotesView(generic.GenericView):
                 "base_template": self.base_template,
                 "active_tab": "notes",
                 "form": notes_form,
-                # Currently only Contact and Team models are not contact_associatable.
-                "is_contact_associatable_model": type(obj) not in [Contact, Team],
             },
         )
 
@@ -2532,7 +2534,6 @@ class TeamUIViewSet(NautobotUIViewSet):
     queryset = Team.objects.all()
     serializer_class = serializers.TeamSerializer
     table_class = tables.TeamTable
-    is_contact_associatable_model = False
 
     def get_extra_context(self, request, instance):
         context = super().get_extra_context(request, instance)

nautobot/ipam/api/serializers.py

@@ -495,6 +495,7 @@ class ServiceSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     class Meta:
         model = Service
         fields = "__all__"
+        validators = []
         extra_kwargs = {
             "device": {"help_text": "Required if no virtual_machine is specified"},
             "virtual_machine": {"help_text": "Required if no device is specified"},
@@ -504,3 +505,12 @@ class ServiceSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
         # `device`.
         # list_display_fields = ["name", "parent", "protocol", "ports", "description"]
         list_display_fields = ["name", "device", "protocol", "ports", "description"]
+
+    def validate(self, data):
+        if data.get("device"):
+            validator = UniqueTogetherValidator(queryset=Service.objects.all(), fields=("name", "device"))
+            validator(data, self)
+        if data.get("virtual_machine"):
+            validator = UniqueTogetherValidator(queryset=Service.objects.all(), fields=("name", "virtual_machine"))
+            validator(data, self)
+        return super().validate(data)

nautobot/ipam/apps.py

@@ -5,10 +5,11 @@ class IPAMConfig(NautobotConfig):
     name = "nautobot.ipam"
     verbose_name = "IPAM"
     searchable_models = [
-        "vrf",
-        "prefix",
         "ipaddress",
+        "namespace",
+        "prefix",
         "vlan",
+        "vrf",
     ]
 
     def ready(self):