nautobot 2.3.15__py3-none-any.whl → 2.3.16__py3-none-any.whl

nautobot/extras/tests/test_views.py

@@ -1691,21 +1691,21 @@ class ScheduledJobTestCase(
         user = User.objects.create(username="user1", is_active=True)
         ScheduledJob.objects.create(
             name="test1",
-            task="pass.TestPass",
+            task="pass.TestPassJob",
             interval=JobExecutionType.TYPE_IMMEDIATELY,
             user=user,
             start_time=timezone.now(),
         )
         ScheduledJob.objects.create(
             name="test2",
-            task="pass.TestPass",
+            task="pass.TestPassJob",
             interval=JobExecutionType.TYPE_DAILY,
             user=user,
             start_time=timezone.now(),
         )
         ScheduledJob.objects.create(
             name="test3",
-            task="pass.TestPass",
+            task="pass.TestPassJob",
             interval=JobExecutionType.TYPE_CUSTOM,
             user=user,
             start_time=timezone.now(),
@@ -1719,7 +1719,7 @@ class ScheduledJobTestCase(
         ScheduledJob.objects.create(
             enabled=False,
             name="test4",
-            task="pass.TestPass",
+            task="pass.TestPassJob",
             interval=JobExecutionType.TYPE_IMMEDIATELY,
             user=self.user,
             start_time=timezone.now(),
@@ -1736,7 +1736,7 @@ class ScheduledJobTestCase(
             ScheduledJob.objects.create(
                 enabled=True,
                 name=name,
-                task="pass.TestPass",
+                task="pass.TestPassJob",
                 interval=JobExecutionType.TYPE_CUSTOM,
                 user=self.user,
                 start_time=timezone.now(),
@@ -1767,7 +1767,7 @@ class ScheduledJobTestCase(
         ScheduledJob.objects.create(
             enabled=True,
             name="test11",
-            task="pass.TestPass",
+            task="pass.TestPassJob",
             interval=JobExecutionType.TYPE_CUSTOM,
             user=self.user,
             start_time=timezone.now(),
@@ -1801,7 +1801,7 @@ class ApprovalQueueTestCase(
     def setUp(self):
         super().setUp()
         self.job_model = Job.objects.get_for_class_path("dry_run.TestDryRun")
-        self.job_model_2 = Job.objects.get_for_class_path("fail.TestFail")
+        self.job_model_2 = Job.objects.get_for_class_path("fail.TestFailJob")
 
         ScheduledJob.objects.create(
             name="test1",
@@ -1814,7 +1814,7 @@ class ApprovalQueueTestCase(
         )
         ScheduledJob.objects.create(
             name="test2",
-            task="fail.TestFail",
+            task="fail.TestFailJob",
             job_model=self.job_model_2,
             interval=JobExecutionType.TYPE_IMMEDIATELY,
             user=self.user,
@@ -1827,7 +1827,7 @@ class ApprovalQueueTestCase(
 
         ScheduledJob.objects.create(
             name="test4",
-            task="pass.TestPass",
+            task="pass.TestPassJob",
             job_model=self.job_model,
             interval=JobExecutionType.TYPE_IMMEDIATELY,
             user=self.user,
@@ -2159,8 +2159,8 @@ class JobResultTestCase(
 
     @classmethod
     def setUpTestData(cls):
-        JobResult.objects.create(name="pass.TestPass")
-        JobResult.objects.create(name="fail.TestFail")
+        JobResult.objects.create(name="pass.TestPassJob")
+        JobResult.objects.create(name="fail.TestFailJob")
         JobLogEntry.objects.create(
             log_level=LogLevelChoices.LOG_INFO,
             job_result=JobResult.objects.first(),
@@ -2214,7 +2214,7 @@ class JobTestCase(
         # Job model objects are automatically created during database migrations
 
         # But we do need to make sure the ones we're testing are flagged appropriately
-        cls.test_pass = Job.objects.get(job_class_name="TestPass")
+        cls.test_pass = Job.objects.get(job_class_name="TestPassJob")
         cls.test_pass.enabled = True
         cls.test_pass.save()
 
@@ -2433,7 +2433,7 @@ class JobTestCase(
         self.add_permissions("extras.run_job")
         for run_url in self.run_urls:
             response = self.client.get(run_url)
-            self.assertBodyContains(response, "TestPass")
+            self.assertBodyContains(response, "TestPassJob")
 
     @override_settings(EXEMPT_VIEW_PERMISSIONS=[])
     def test_get_run_with_constrained_permission(self):
@@ -2532,12 +2532,12 @@ class JobTestCase(
         self.add_permissions("extras.run_job")
 
         for run_url in (
-            reverse("extras:job_run_by_class_path", kwargs={"class_path": "fail.TestFail"}),
-            reverse("extras:job_run", kwargs={"pk": Job.objects.get(job_class_name="TestFail").pk}),
+            reverse("extras:job_run_by_class_path", kwargs={"class_path": "fail.TestFailJob"}),
+            reverse("extras:job_run", kwargs={"pk": Job.objects.get(job_class_name="TestFailJob").pk}),
         ):
             response = self.client.post(run_url, self.data_run_immediately)
             self.assertBodyContains(response, "Job is not enabled to be run")
-            self.assertFalse(JobResult.objects.filter(name="fail.TestFail").exists())
+            self.assertFalse(JobResult.objects.filter(name="fail.TestFailJob").exists())
 
     def test_run_now_missing_args(self):
         self.add_permissions("extras.run_job")

nautobot/extras/views.py

@@ -1060,10 +1060,10 @@ class GitRepositoryEditView(generic.ObjectEditView):
         obj.user = request.user
         return super().alter_obj(obj, request, url_args, url_kwargs)
 
-    def get_return_url(self, request, obj):
+    def get_return_url(self, request, obj=None, default_return_url=None):
         if request.method == "POST":
             return reverse("extras:gitrepository_result", kwargs={"pk": obj.pk})
-        return super().get_return_url(request, obj)
+        return super().get_return_url(request, obj=obj, default_return_url=default_return_url)
 
 
 class GitRepositoryDeleteView(generic.ObjectDeleteView):
@@ -1211,27 +1211,27 @@ class ImageAttachmentEditView(generic.ObjectEditView):
             return get_object_or_404(self.queryset, pk=kwargs["pk"])
         return self.queryset.model()
 
-    def alter_obj(self, imageattachment, request, args, kwargs):
-        if not imageattachment.present_in_database:
+    def alter_obj(self, obj, request, url_args, url_kwargs):
+        if not obj.present_in_database:
             # Assign the parent object based on URL kwargs
-            model = kwargs.get("model")
-            if "object_id" in kwargs:
-                imageattachment.parent = get_object_or_404(model, pk=kwargs["object_id"])
-            elif "slug" in kwargs:
-                imageattachment.parent = get_object_or_404(model, slug=kwargs["slug"])
+            model = url_kwargs.get("model")
+            if "object_id" in url_kwargs:
+                obj.parent = get_object_or_404(model, pk=url_kwargs["object_id"])
+            elif "slug" in url_kwargs:
+                obj.parent = get_object_or_404(model, slug=url_kwargs["slug"])
             else:
                 raise RuntimeError("Neither object_id nor slug were provided?")
-        return imageattachment
+        return obj
 
-    def get_return_url(self, request, imageattachment):
-        return imageattachment.parent.get_absolute_url()
+    def get_return_url(self, request, obj=None, default_return_url=None):
+        return obj.parent.get_absolute_url()
 
 
 class ImageAttachmentDeleteView(generic.ObjectDeleteView):
     queryset = ImageAttachment.objects.all()
 
-    def get_return_url(self, request, imageattachment):
-        return imageattachment.parent.get_absolute_url()
+    def get_return_url(self, request, obj=None, default_return_url=None):
+        return obj.parent.get_absolute_url()
 
 
 #
@@ -1337,7 +1337,9 @@ class JobRunView(ObjectPermissionRequiredMixin, View):
                     get_template(job_class.template_name)
                     template_name = job_class.template_name
                 except TemplateDoesNotExist as err:
-                    messages.error(request, f'Unable to render requested custom job template "{template_name}": {err}')
+                    messages.error(
+                        request, f'Unable to render requested custom job template "{job_class.template_name}": {err}'
+                    )
         except RuntimeError as err:
             messages.error(request, f"Unable to run or schedule '{job_model}': {err}")
             return redirect("extras:job_list")
@@ -1447,7 +1449,9 @@ class JobRunView(ObjectPermissionRequiredMixin, View):
                 get_template(job_class.template_name)
                 template_name = job_class.template_name
             except TemplateDoesNotExist as err:
-                messages.error(request, f'Unable to render requested custom job template "{template_name}": {err}')
+                messages.error(
+                    request, f'Unable to render requested custom job template "{job_class.template_name}": {err}'
+                )
 
         return render(
             request,

nautobot/ipam/api/fields.py

@@ -7,11 +7,11 @@ class IPFieldSerializer(serializers.CharField):
         """Convert internal (IPNetwork) representation to API (string) representation."""
         return str(value)
 
-    def to_internal_value(self, value):
+    def to_internal_value(self, data):
         """Convert API (string) representation to internal (IPNetwork) representation."""
         try:
-            return netaddr.IPNetwork(value)
+            return netaddr.IPNetwork(data)
         except netaddr.AddrFormatError:
-            raise serializers.ValidationError(f"Invalid IP address format: {value}")
+            raise serializers.ValidationError(f"Invalid IP address format: {data}")
         except (TypeError, ValueError) as e:
             raise serializers.ValidationError(e)

nautobot/ipam/api/serializers.py

@@ -64,16 +64,16 @@ class VRFDeviceAssignmentSerializer(ValidatedModelSerializer):
         fields = "__all__"
         validators = []
 
-    def validate(self, data):
-        if data.get("device"):
+    def validate(self, attrs):
+        if attrs.get("device"):
             validator = UniqueTogetherValidator(queryset=VRFDeviceAssignment.objects.all(), fields=("device", "vrf"))
-            validator(data, self)
-        if data.get("virtual_machine"):
+            validator(attrs, self)
+        if attrs.get("virtual_machine"):
             validator = UniqueTogetherValidator(
                 queryset=VRFDeviceAssignment.objects.all(), fields=("virtual_machine", "vrf")
             )
-            validator(data, self)
-        return super().validate(data)
+            validator(attrs, self)
+        return super().validate(attrs)
 
 
 class VRFPrefixAssignmentSerializer(ValidatedModelSerializer):
@@ -156,17 +156,17 @@ class VLANSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
         validators = []
         extra_kwargs = {"locations": {"read_only": True}}
 
-    def validate(self, data):
+    def validate(self, attrs):
         # Validate uniqueness of vid and name if a group has been assigned.
-        if data.get("vlan_group", None):
+        if attrs.get("vlan_group", None):
             for field in ["vid", "name"]:
                 validator = UniqueTogetherValidator(queryset=VLAN.objects.all(), fields=("vlan_group", field))
-                validator(data, self)
+                validator(attrs, self)
 
         # Enforce model validation
-        super().validate(data)
+        super().validate(attrs)
 
-        return data
+        return attrs
 
 
 class VLANLegacySerializer(VLANSerializer):
@@ -417,16 +417,16 @@ class IPAddressSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
             ],
         }
 
-    def validate(self, data):
-        namespace = data.get("namespace", None)
-        parent = data.get("parent", None)
+    def validate(self, attrs):
+        namespace = attrs.get("namespace", None)
+        parent = attrs.get("parent", None)
 
         # Only assert namespace/parent on create.
         if self.instance is None and not any([namespace, parent]):
             raise ValidationError({"__all__": "One of parent or namespace must be provided"})
 
-        super().validate(data)
-        return data
+        super().validate(attrs)
+        return attrs
 
     def get_field_names(self, declared_fields, info):
         """Add reverse relations to the automatically discovered fields."""
@@ -476,9 +476,9 @@ class IPAllocationSerializer(NautobotModelSerializer, TaggedModelSerializerMixin
             "custom_fields",
         )
 
-    def validate(self, data):
-        data["mask_length"] = self.context["prefix"].prefix_length
-        return super().validate(data)
+    def validate(self, attrs):
+        attrs["mask_length"] = self.context["prefix"].prefix_length
+        return super().validate(attrs)
 
 
 class VLANAllocationSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
@@ -488,11 +488,11 @@ class VLANAllocationSerializer(NautobotModelSerializer, TaggedModelSerializerMix
 
     vid = serializers.IntegerField(required=False, min_value=constants.VLAN_VID_MIN, max_value=constants.VLAN_VID_MAX)
 
-    def validate(self, data):
+    def validate(self, attrs):
         """Skip `ValidatedModel` validation.
         This allows to skip `vid` attribute of `VLAN` model, while validate name and status.
         """
-        return data
+        return attrs
 
     class Meta(VLANSerializer.Meta):
         model = VLAN
@@ -521,19 +521,19 @@ class IPAddressToInterfaceSerializer(ValidatedModelSerializer):
         fields = "__all__"
         validators = []
 
-    def validate(self, data):
+    def validate(self, attrs):
         # Validate uniqueness of (parent, name) since we omitted the automatically created validator from Meta.
-        if data.get("interface"):
+        if attrs.get("interface"):
             validator = UniqueTogetherValidator(
                 queryset=IPAddressToInterface.objects.all(), fields=("interface", "ip_address")
             )
-            validator(data, self)
-        if data.get("vm_interface"):
+            validator(attrs, self)
+        if attrs.get("vm_interface"):
             validator = UniqueTogetherValidator(
                 queryset=IPAddressToInterface.objects.all(), fields=("vm_interface", "ip_address")
             )
-            validator(data, self)
-        return super().validate(data)
+            validator(attrs, self)
+        return super().validate(attrs)
 
 
 #
@@ -565,11 +565,11 @@ class ServiceSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
         # list_display_fields = ["name", "parent", "protocol", "ports", "description"]
         list_display_fields = ["name", "device", "protocol", "ports", "description"]
 
-    def validate(self, data):
-        if data.get("device"):
+    def validate(self, attrs):
+        if attrs.get("device"):
             validator = UniqueTogetherValidator(queryset=Service.objects.all(), fields=("name", "device"))
-            validator(data, self)
-        if data.get("virtual_machine"):
+            validator(attrs, self)
+        if attrs.get("virtual_machine"):
             validator = UniqueTogetherValidator(queryset=Service.objects.all(), fields=("name", "virtual_machine"))
-            validator(data, self)
-        return super().validate(data)
+            validator(attrs, self)
+        return super().validate(attrs)

nautobot/ipam/api/views.py

@@ -139,15 +139,15 @@ class PrefixViewSet(NautobotModelViewSet):
         )
         default_code = "precondition_failed"
 
-    def retrieve(self, request, pk=None):
+    def retrieve(self, request, *args, pk=None, **kwargs):
         try:
-            return super().retrieve(request, pk)
+            return super().retrieve(request, *args, pk=pk, **kwargs)
         except Location.MultipleObjectsReturned as e:
             raise self.LocationIncompatibleLegacyBehavior from e
 
-    def list(self, request):
+    def list(self, request, *args, **kwargs):
         try:
-            return super().list(request)
+            return super().list(request, *args, **kwargs)
         except Location.MultipleObjectsReturned as e:
             raise self.LocationIncompatibleLegacyBehavior from e
 
@@ -185,20 +185,15 @@ class PrefixViewSet(NautobotModelViewSet):
                 available_prefixes = prefix.get_available_prefixes()
 
                 # Validate Requested Prefixes' length
-                serializer = serializers.PrefixLengthSerializer(
-                    data=request.data if isinstance(request.data, list) else [request.data],
-                    many=True,
-                    context={
-                        "request": request,
-                        "prefix": prefix,
-                    },
-                )
-                serializer.is_valid(raise_exception=True)
-
-                requested_prefixes = serializer.validated_data
-                # Allocate prefixes to the requested objects based on availability within the parent
+                requested_prefixes = request.data if isinstance(request.data, list) else [request.data]
                 for requested_prefix in requested_prefixes:
-                    # Find the first available prefix equal to or larger than the requested size
+                    # If the prefix_length is not an integer, return a 400 using the
+                    # serializer.is_valid(raise_exception=True) method call below
+                    if not isinstance(requested_prefix["prefix_length"], int):
+                        return Response(
+                            {"prefix_length": "This field must be an integer."},
+                            status=status.HTTP_400_BAD_REQUEST,
+                        )
                     for available_prefix in available_prefixes.iter_cidrs():
                         if requested_prefix["prefix_length"] >= available_prefix.prefixlen:
                             allocated_prefix = f"{available_prefix.network}/{requested_prefix['prefix_length']}"
@@ -210,11 +205,6 @@ class PrefixViewSet(NautobotModelViewSet):
                             {"detail": "Insufficient space is available to accommodate the requested prefix size(s)"},
                             status=status.HTTP_204_NO_CONTENT,
                         )
-
-                    # The serializer usage above has mapped "custom_fields" dict to "_custom_field_data".
-                    # We need to convert it back to "custom_fields" as we're going to deserialize it a second time below
-                    requested_prefix["custom_fields"] = requested_prefix.pop("_custom_field_data", {})
-
                     # Remove the allocated prefix from the list of available prefixes
                     available_prefixes.remove(allocated_prefix)
 
@@ -275,17 +265,7 @@ class PrefixViewSet(NautobotModelViewSet):
                 "nautobot.ipam.api.views.available_ips", blocking_timeout=5, timeout=settings.REDIS_LOCK_TIMEOUT
             ):
                 # Normalize to a list of objects
-                serializer = serializers.IPAllocationSerializer(
-                    data=request.data if isinstance(request.data, list) else [request.data],
-                    many=True,
-                    context={
-                        "request": request,
-                        "prefix": prefix,
-                    },
-                )
-                serializer.is_valid(raise_exception=True)
-
-                requested_ips = serializer.validated_data
+                requested_ips = request.data if isinstance(request.data, list) else [request.data]
 
                 # Determine if the requested number of IPs is available
                 available_ips = prefix.get_available_ips()
@@ -306,9 +286,6 @@ class PrefixViewSet(NautobotModelViewSet):
                 for requested_ip in requested_ips:
                     requested_ip["address"] = f"{next(available_ips)}/{prefix_length}"
                     requested_ip["namespace"] = prefix.namespace
-                    # The serializer usage above has mapped "custom_fields" dict to "_custom_field_data".
-                    # We need to convert it back to "custom_fields" as we're going to deserialize it a second time below
-                    requested_ip["custom_fields"] = requested_ip.pop("_custom_field_data", {})
 
                 # Initialize the serializer with a list or a single object depending on what was requested
                 context = {"request": request, "depth": 0}
@@ -442,16 +419,7 @@ class VLANGroupViewSet(NautobotModelViewSet):
                 "nautobot.ipam.api.views.available_vlans", blocking_timeout=5, timeout=settings.REDIS_LOCK_TIMEOUT
             ):
                 # Normalize to a list of objects
-                serializer = serializers.VLANAllocationSerializer(
-                    data=request.data if isinstance(request.data, list) else [request.data],
-                    many=True,
-                    context={
-                        "request": request,
-                        "vlan_group": vlan_group,
-                    },
-                )
-                serializer.is_valid(raise_exception=True)
-                requested_vlans = serializer.validated_data
+                requested_vlans = request.data if isinstance(request.data, list) else [request.data]
 
                 # Determine if the requested number of VLANs is available
                 available_vids = vlan_group.available_vids
@@ -487,20 +455,28 @@ class VLANGroupViewSet(NautobotModelViewSet):
                         requested_vlan["vid"] = next(_available_vids)
 
                     # Check requested `vlan_group`
-                    if "vlan_group" in requested_vlan and requested_vlan["vlan_group"] != vlan_group:
-                        return Response(
-                            {
-                                "detail": f"Invalid VLAN Group requested: {requested_vlan['vlan_group']}. "
-                                f"Only VLAN Group {vlan_group} is permitted."
-                            },
-                            status=status.HTTP_204_NO_CONTENT,
-                        )
+                    if "vlan_group" in requested_vlan:
+                        requested_vlan_group = None
+                        requested_vlan_group_pk = requested_vlan["vlan_group"]
+                        try:
+                            requested_vlan_group = VLANGroup.objects.get(pk=requested_vlan_group_pk)
+                        except VLANGroup.DoesNotExist:
+                            return Response(
+                                {"detail": f"VLAN Group with pk {requested_vlan_group_pk} does not exist."},
+                                status=status.HTTP_204_NO_CONTENT,
+                            )
+
+                        if requested_vlan_group != vlan_group:
+                            return Response(
+                                {
+                                    "detail": f"Invalid VLAN Group requested: {requested_vlan_group}. "
+                                    f"Only VLAN Group {vlan_group} is permitted."
+                                },
+                                status=status.HTTP_204_NO_CONTENT,
+                            )
                     else:
                         requested_vlan["vlan_group"] = vlan_group.pk
 
-                    # Rewrite custom field data
-                    requested_vlan["custom_fields"] = requested_vlan.pop("_custom_field_data", {})
-
                 # Initialize the serializer with a list or a single object depending on what was requested
                 context = {"request": request, "depth": 0}
 
@@ -604,15 +580,15 @@ class VLANViewSet(NautobotModelViewSet):
             return serializers.VLANLegacySerializer
         return super().get_serializer_class()
 
-    def retrieve(self, request, pk=None):
+    def retrieve(self, request, *args, pk=None, **kwargs):
         try:
-            return super().retrieve(request, pk)
+            return super().retrieve(request, *args, pk=pk, **kwargs)
         except Location.MultipleObjectsReturned as e:
             raise self.LocationIncompatibleLegacyBehavior from e
 
-    def list(self, request):
+    def list(self, request, *args, **kwargs):
         try:
-            return super().list(request)
+            return super().list(request, *args, **kwargs)
         except Location.MultipleObjectsReturned as e:
             raise self.LocationIncompatibleLegacyBehavior from e
 

nautobot/ipam/querysets.py

@@ -398,7 +398,7 @@ class IPAddressQuerySet(BaseNetworkQuerySet):
         """
         return super().order_by("host")
 
-    def get_or_create(self, **kwargs):
+    def get_or_create(self, defaults=None, **kwargs):
         from nautobot.ipam.models import get_default_namespace, Prefix
 
         parent = kwargs.get("parent")
@@ -421,7 +421,7 @@ class IPAddressQuerySet(BaseNetworkQuerySet):
                 raise ValidationError(f"{cidr} does not appear to be an IPv4 or IPv6 network.") from err
             parent = Prefix.objects.filter(namespace=namespace).get_closest_parent(cidr=cidr, include_self=True)
             kwargs["parent"] = parent
-        return super().get_or_create(**kwargs)
+        return super().get_or_create(defaults=defaults, **kwargs)
 
     def string_search(self, search):
         """

nautobot/ipam/tests/test_api.py

@@ -2,6 +2,7 @@ from concurrent.futures.thread import ThreadPoolExecutor
 import json
 from random import shuffle
 from unittest import skip
+import uuid
 
 from django.contrib.contenttypes.models import ContentType
 from django.db import connection
@@ -506,7 +507,8 @@ class PrefixTest(APIViewTestCases.APIViewTestCase):
             url, {"prefix_length": "hello", "status": self.status.pk}, format="json", **self.header
         )
         self.assertHttpStatus(response, status.HTTP_400_BAD_REQUEST)
-        self.assertIn("prefix_length", response.data[0])
+        self.assertIn("prefix_length", response.data)
+        self.assertEqual(response.data["prefix_length"], "This field must be an integer.")
 
     def test_create_multiple_available_prefixes(self):
         """
@@ -1482,6 +1484,15 @@ class VLANGroupTest(APIViewTestCases.APIViewTestCase):
             f"Invalid VLAN Group requested: {some_other_vlan_group}. Only VLAN Group {self.vlan_group} is permitted.",
             response.data["detail"],
         )
+        invalid_id = uuid.uuid4()
+        data[0]["vlan_group"] = invalid_id  # Invalid UUID
+        response = self.client.post(url, data, format="json", **self.header)
+        self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
+        self.assertIn("detail", response.data)
+        self.assertEqual(
+            f"VLAN Group with pk {invalid_id} does not exist.",
+            response.data["detail"],
+        )
 
     def test_create_available_vlans_with_permissions_constraint(self):
         url = reverse("ipam-api:vlangroup-available-vlans", kwargs={"pk": self.vlan_group.pk})