nautobot 2.4.0b1__py3-none-any.whl → 2.4.1__py3-none-any.whl

nautobot/dcim/tests/test_views.py

@@ -116,6 +116,7 @@ from nautobot.extras.models import (
     CustomField,
     CustomFieldChoice,
     ExternalIntegration,
+    JobResult,
     Relationship,
     RelationshipAssociation,
     Role,
@@ -128,6 +129,7 @@ from nautobot.ipam.choices import IPAddressTypeChoices
 from nautobot.ipam.models import IPAddress, Namespace, Prefix, VLAN, VLANGroup, VRF
 from nautobot.tenancy.models import Tenant
 from nautobot.users.models import ObjectPermission
+from nautobot.virtualization.models import Cluster, ClusterType
 
 # Use the proper swappable User model
 User = get_user_model()
@@ -1150,9 +1152,15 @@ module-bays:
         }
 
         response = self.client.post(url, data)
+        job_result = JobResult.objects.filter(name="Bulk Edit Objects").first()
+        # Assert successfull redirect to Job Results; whcih means no form validation error was raised
+        self.assertRedirects(
+            response,
+            reverse("extras:jobresult", args=[job_result.pk]),
+            status_code=302,
+            target_status_code=200,
+        )
         self.assertHttpStatus(response, 302)
-        for instance in self._get_queryset().filter(pk__in=pk_list):
-            self.assertEqual(instance.u_height, data["u_height"])
 
     @override_settings(EXEMPT_VIEW_PERMISSIONS=["*"])
     def test_rack_height_bulk_edit_invalid(self):
@@ -1168,7 +1176,12 @@ module-bays:
         }
 
         response = self.client.post(url, data)
-        self.assertBodyContains(response, "failed validation")
+        response_content = response.content.decode(response.charset)
+        self.assertHttpStatus(response, 200)
+        self.assertInHTML(
+            '<strong class="panel-title">U height</strong>: <ul class="errorlist"><li>Ensure this value is greater than or equal to 0.</li></ul>',
+            response_content,
+        )
 
 
 class ModuleTypeTestCase(
@@ -2045,6 +2058,9 @@ class DeviceTestCase(ViewTestCases.PrimaryObjectViewTestCase):
 
         rack_group = RackGroup.objects.create(location=locations[0], name="Rack Group 1")
 
+        cluster_type = ClusterType.objects.create(name="Cluster Type 1")
+        cluster = Cluster.objects.create(name="Cluster 1", cluster_type=cluster_type)
+
         rack_status = Status.objects.get_for_model(Rack).first()
         racks = (
             Rack.objects.create(
@@ -2216,6 +2232,8 @@ class DeviceTestCase(ViewTestCases.PrimaryObjectViewTestCase):
             "status": statuses[2].pk,
             "location": locations[1].pk,
             "rack": racks[1].pk,
+            "cluster": cluster.pk,
+            "comments": "An older device",
             "position": None,
             "face": DeviceFaceChoices.FACE_FRONT,
             "secrets_group": secrets_groups[1].pk,
@@ -4574,46 +4592,6 @@ class SoftwareImageFileTestCase(ViewTestCases.PrimaryObjectViewTestCase):
             "download_url": "https://example.com/software_image_file_test_case.bin",
         }
 
-    @override_settings(EXEMPT_VIEW_PERMISSIONS=["*"])
-    def test_correct_handling_for_model_protected_error(self):
-        platform = Platform.objects.first()
-        software_version_status = Status.objects.get_for_model(SoftwareVersion).first()
-        software_image_file_status = Status.objects.get_for_model(SoftwareImageFile).first()
-        software_version = SoftwareVersion.objects.create(
-            platform=platform, version="Test version 1.0.0", status=software_version_status
-        )
-        software_image_file = SoftwareImageFile.objects.create(
-            software_version=software_version,
-            image_file_name="software_image_file_qs_test_1.bin",
-            status=software_image_file_status,
-        )
-        device_type = DeviceType.objects.first()
-        device_role = Role.objects.get_for_model(Device).first()
-        device_status = Status.objects.get_for_model(Device).first()
-        location = Location.objects.filter(location_type__name="Campus").first()
-        Device.objects.create(
-            device_type=device_type,
-            role=device_role,
-            name="Device 1",
-            location=location,
-            status=device_status,
-            software_version=software_version,
-        )
-        device_type_to_software_image_file = DeviceTypeToSoftwareImageFile.objects.create(
-            device_type=device_type, software_image_file=software_image_file
-        )
-
-        self.add_permissions("dcim.delete_softwareimagefile")
-        pk_list = [software_image_file.pk]
-        data = {
-            "pk": pk_list,
-            "confirm": True,
-            "_confirm": True,  # Form button
-        }
-        response = self.client.post(self._get_url("bulk_delete"), data, follow=True)
-        # Assert protected error message included in the response body
-        self.assertBodyContains(response, f"<span>{device_type_to_software_image_file}</span>", html=True)
-
 
 class SoftwareVersionTestCase(ViewTestCases.PrimaryObjectViewTestCase):
     model = SoftwareVersion
@@ -4652,46 +4630,6 @@ class SoftwareVersionTestCase(ViewTestCases.PrimaryObjectViewTestCase):
             "pre_release": True,
         }
 
-    @override_settings(EXEMPT_VIEW_PERMISSIONS=["*"])
-    def test_correct_handling_for_model_protected_error(self):
-        platform = Platform.objects.first()
-        software_version_status = Status.objects.get_for_model(SoftwareVersion).first()
-        software_image_file_status = Status.objects.get_for_model(SoftwareImageFile).first()
-        software_version = SoftwareVersion.objects.create(
-            platform=platform, version="Test version 1.0.0", status=software_version_status
-        )
-        software_image_file = SoftwareImageFile.objects.create(
-            software_version=software_version,
-            image_file_name="software_image_file_qs_test_1.bin",
-            status=software_image_file_status,
-        )
-        device_type = DeviceType.objects.first()
-        device_role = Role.objects.get_for_model(Device).first()
-        device_status = Status.objects.get_for_model(Device).first()
-        location = Location.objects.filter(location_type__name="Campus").first()
-        Device.objects.create(
-            device_type=device_type,
-            role=device_role,
-            name="Device 1",
-            location=location,
-            status=device_status,
-            software_version=software_version,
-        )
-        device_type_to_software_image_file = DeviceTypeToSoftwareImageFile.objects.create(
-            device_type=device_type, software_image_file=software_image_file
-        )
-
-        self.add_permissions("dcim.delete_softwareversion")
-        pk_list = [software_version.pk]
-        data = {
-            "pk": pk_list,
-            "confirm": True,
-            "_confirm": True,  # Form button
-        }
-        response = self.client.post(self._get_url("bulk_delete"), data, follow=True)
-        # Assert protected error message included in the response body
-        self.assertBodyContains(response, f"<span>{device_type_to_software_image_file}</span>", html=True)
-
 
 class ControllerTestCase(ViewTestCases.PrimaryObjectViewTestCase):
     model = Controller

nautobot/dcim/views.py

@@ -697,7 +697,7 @@ class RackReservationEditView(generic.ObjectEditView):
     model_form = forms.RackReservationForm
     template_name = "dcim/rackreservation_edit.html"
 
-    def alter_obj(self, obj, request, args, kwargs):
+    def alter_obj(self, obj, request, url_args, url_kwargs):
         if not obj.present_in_database:
             if "rack" in request.GET:
                 obj.rack = get_object_or_404(Rack, pk=request.GET.get("rack"))
@@ -4502,12 +4502,6 @@ class ControllerManagedDeviceGroupUIViewSet(NautobotUIViewSet):
 
         return obj
 
-    def extra_post_save_action(self, obj, form):
-        if form.cleaned_data.get("add_radio_profiles", None):
-            obj.radio_profiles.add(*form.cleaned_data["add_radio_profiles"])
-        if form.cleaned_data.get("remove_radio_profiles", None):
-            obj.radio_profiles.remove(*form.cleaned_data["remove_radio_profiles"])
-
 
 #
 # Virtual Device Context
@@ -4534,9 +4528,3 @@ class VirtualDeviceContextUIViewSet(NautobotUIViewSet):
                 **super().get_extra_context(request, instance),
             }
         return super().get_extra_context(request, instance)
-
-    def extra_post_save_action(self, obj, form):
-        if form.cleaned_data.get("add_interfaces", None):
-            obj.prefixes.add(*form.cleaned_data["add_interfaces"])
-        if form.cleaned_data.get("remove_interfaces", None):
-            obj.prefixes.remove(*form.cleaned_data["remove_interfaces"])

nautobot/extras/api/customfields.py

@@ -42,8 +42,8 @@ class CustomFieldsDataField(Field):
     def custom_field_keys(self):
         return CustomField.objects.keys_for_model(self.parent.Meta.model)
 
-    def to_representation(self, obj):
-        return {key: obj.get(key) for key in self.custom_field_keys}
+    def to_representation(self, value):
+        return {key: value.get(key) for key in self.custom_field_keys}
 
     def to_internal_value(self, data):
         """Support updates to individual fields on an existing instance without needing to provide the entire dict."""

nautobot/extras/api/serializers.py

@@ -19,7 +19,6 @@ from nautobot.core.api import (
     ValidatedModelSerializer,
 )
 from nautobot.core.api.exceptions import SerializerNotFound
-from nautobot.core.api.fields import NautobotHyperlinkedRelatedField
 from nautobot.core.api.serializers import PolymorphicProxySerializer
 from nautobot.core.api.utils import (
     get_nested_serializer_depth,
@@ -136,12 +135,12 @@ class ConfigContextSerializer(ValidatedModelSerializer, TaggedModelSerializerMix
     owner = serializers.SerializerMethodField(read_only=True)
 
     # Conditional enablement of dynamic groups filtering
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-
+    @property
+    def fields(self):
+        fields = super().fields
         if not settings.CONFIG_CONTEXT_DYNAMIC_GROUPS_ENABLED:
-            # In the case of a nested serializer, we won't have a `dynamic_groups` field at all.
-            self.fields.pop("dynamic_groups", None)
+            fields.pop("dynamic_groups", None)
+        return fields
 
     class Meta:
         model = ConfigContext
@@ -200,10 +199,7 @@ class ConfigContextSchemaSerializer(NautobotModelSerializer):
 #
 
 
-class ContactSerializer(NautobotModelSerializer):
-    # needed since this is the reverse side of the M2M field.
-    teams = NautobotHyperlinkedRelatedField(queryset=Team.objects.all(), many=True, required=False)
-
+class ContactSerializer(TaggedModelSerializerMixin, NautobotModelSerializer):
     class Meta:
         model = Contact
         fields = "__all__"
@@ -212,15 +208,22 @@ class ContactSerializer(NautobotModelSerializer):
         extra_kwargs = {
             "email": {"default": ""},
             "phone": {"default": ""},
+            "teams": {"required": False},
         }
 
-    def validate(self, data):
-        attrs = data.copy()
-        attrs.pop("teams", None)
+    def get_field_names(self, declared_fields, info):
+        """Add reverse M2M for teams to the fields for this serializer."""
+        field_names = list(super().get_field_names(declared_fields, info))
+        self.extend_field_names(field_names, "teams")
+        return field_names
+
+    def validate(self, attrs):
+        local_attrs = attrs.copy()
+        local_attrs.pop("teams", None)
         validator = UniqueTogetherValidator(queryset=Contact.objects.all(), fields=("name", "phone", "email"))
-        validator(attrs, self)
-        super().validate(attrs)
-        return data
+        validator(local_attrs, self)
+        super().validate(local_attrs)
+        return attrs
 
 
 class ContactAssociationSerializer(NautobotModelSerializer):
@@ -235,18 +238,18 @@ class ContactAssociationSerializer(NautobotModelSerializer):
             "team": {"required": False},
         }
 
-    def validate(self, data):
+    def validate(self, attrs):
         # Validate uniqueness of (associated object, associated object type, contact/team, role)
         unique_together_fields = None
 
-        if data.get("contact") and data.get("role"):
+        if attrs.get("contact") and attrs.get("role"):
             unique_together_fields = (
                 "associated_object_type",
                 "associated_object_id",
                 "contact",
                 "role",
             )
-        elif data.get("team") and data.get("role"):
+        elif attrs.get("team") and attrs.get("role"):
             unique_together_fields = (
                 "associated_object_type",
                 "associated_object_id",
@@ -259,11 +262,11 @@ class ContactAssociationSerializer(NautobotModelSerializer):
                 queryset=ContactAssociation.objects.all(),
                 fields=unique_together_fields,
             )
-            validator(data, self)
+            validator(attrs, self)
 
-        super().validate(data)
+        super().validate(attrs)
 
-        return data
+        return attrs
 
 
 #
@@ -272,6 +275,7 @@ class ContactAssociationSerializer(NautobotModelSerializer):
 
 
 class ContentTypeSerializer(BaseModelSerializer):
+    id = serializers.IntegerField(read_only=True)
     url = serializers.HyperlinkedIdentityField(view_name="extras-api:contenttype-detail")
     display = serializers.SerializerMethodField()
 
@@ -280,8 +284,8 @@ class ContentTypeSerializer(BaseModelSerializer):
         fields = "__all__"
 
     @extend_schema_field(serializers.CharField)
-    def get_display(self, obj):
-        return obj.app_labeled_name
+    def get_display(self, instance):
+        return instance.app_labeled_name
 
 
 #
@@ -433,7 +437,7 @@ class ExportTemplateSerializer(RelationshipModelSerializerMixin, ValidatedModelS
 #
 
 
-class ExternalIntegrationSerializer(NautobotModelSerializer):
+class ExternalIntegrationSerializer(TaggedModelSerializerMixin, NautobotModelSerializer):
     class Meta:
         model = ExternalIntegration
         fields = "__all__"
@@ -455,7 +459,7 @@ class FileProxySerializer(BaseModelSerializer):
 #
 
 
-class GitRepositorySerializer(NautobotModelSerializer):
+class GitRepositorySerializer(TaggedModelSerializerMixin, NautobotModelSerializer):
     """Git repositories defined as a data source."""
 
     provided_contents = MultipleChoiceJSONField(
@@ -502,17 +506,17 @@ class ImageAttachmentSerializer(ValidatedModelSerializer):
         model = ImageAttachment
         fields = "__all__"
 
-    def validate(self, data):
+    def validate(self, attrs):
         # Validate that the parent object exists
         try:
-            data["content_type"].get_object_for_this_type(id=data["object_id"])
+            attrs["content_type"].get_object_for_this_type(id=attrs["object_id"])
         except ObjectDoesNotExist:
-            raise serializers.ValidationError(f"Invalid parent object: {data['content_type']} ID {data['object_id']}")
+            raise serializers.ValidationError(f"Invalid parent object: {attrs['content_type']} ID {attrs['object_id']}")
 
         # Enforce model validation
-        super().validate(data)
+        super().validate(attrs)
 
-        return data
+        return attrs
 
     @extend_schema_field(
         PolymorphicProxySerializer(
@@ -544,24 +548,24 @@ class JobSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
         model = Job
         fields = "__all__"
 
-    def validate(self, data):
+    def validate(self, attrs):
         # note no validation for on creation of jobs because we do not support user creation of Job records via API
         if self.instance:
-            has_sensitive_variables = data.get("has_sensitive_variables", self.instance.has_sensitive_variables)
-            approval_required = data.get("approval_required", self.instance.approval_required)
+            has_sensitive_variables = attrs.get("has_sensitive_variables", self.instance.has_sensitive_variables)
+            approval_required = attrs.get("approval_required", self.instance.approval_required)
 
             if approval_required and has_sensitive_variables:
                 error_message = "A job with sensitive variables cannot also be marked as requiring approval"
                 errors = {}
 
-                if "approval_required" in data:
+                if "approval_required" in attrs:
                     errors["approval_required"] = [error_message]
-                if "has_sensitive_variables" in data:
+                if "has_sensitive_variables" in attrs:
                     errors["has_sensitive_variables"] = [error_message]
 
                 raise serializers.ValidationError(errors)
 
-        return super().validate(data)
+        return super().validate(attrs)
 
 
 class JobQueueSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
@@ -687,22 +691,22 @@ class JobHookSerializer(NautobotModelSerializer):
         model = JobHook
         fields = "__all__"
 
-    def validate(self, data):
-        validated_data = super().validate(data)
+    def validate(self, attrs):
+        validated_attrs = super().validate(attrs)
 
         conflicts = JobHook.check_for_conflicts(
             instance=self.instance,
-            content_types=data.get("content_types"),
-            job=data.get("job"),
-            type_create=data.get("type_create"),
-            type_update=data.get("type_update"),
-            type_delete=data.get("type_delete"),
+            content_types=attrs.get("content_types"),
+            job=attrs.get("job"),
+            type_create=attrs.get("type_create"),
+            type_update=attrs.get("type_update"),
+            type_delete=attrs.get("type_delete"),
         )
 
         if conflicts:
             raise serializers.ValidationError(conflicts)
 
-        return validated_data
+        return validated_attrs
 
 
 class JobCreationSerializer(BaseModelSerializer):
@@ -721,15 +725,15 @@ class JobCreationSerializer(BaseModelSerializer):
         model = ScheduledJob
         fields = ["url", "name", "start_time", "interval", "crontab"]
 
-    def validate(self, data):
-        data = super().validate(data)
+    def validate(self, attrs):
+        attrs = super().validate(attrs)
 
-        if data["interval"] in choices.JobExecutionType.SCHEDULE_CHOICES:
-            if "name" not in data:
+        if attrs["interval"] in choices.JobExecutionType.SCHEDULE_CHOICES:
+            if "name" not in attrs:
                 raise serializers.ValidationError({"name": "Please provide a name for the job schedule."})
 
-            if ("start_time" not in data and data["interval"] != choices.JobExecutionType.TYPE_CUSTOM) or (
-                "start_time" in data and data["start_time"] < models.ScheduledJob.earliest_possible_time()
+            if ("start_time" not in attrs and attrs["interval"] != choices.JobExecutionType.TYPE_CUSTOM) or (
+                "start_time" in attrs and attrs["start_time"] < models.ScheduledJob.earliest_possible_time()
             ):
                 raise serializers.ValidationError(
                     {
@@ -737,15 +741,15 @@ class JobCreationSerializer(BaseModelSerializer):
                     }
                 )
 
-            if data["interval"] == choices.JobExecutionType.TYPE_CUSTOM:
-                if data.get("crontab") is None:
+            if attrs["interval"] == choices.JobExecutionType.TYPE_CUSTOM:
+                if attrs.get("crontab") is None:
                     raise serializers.ValidationError({"crontab": "Please enter a valid crontab."})
                 try:
-                    models.ScheduledJob.get_crontab(data["crontab"])
+                    models.ScheduledJob.get_crontab(attrs["crontab"])
                 except Exception as e:
                     raise serializers.ValidationError({"crontab": e})
 
-        return data
+        return attrs
 
 
 class JobInputSerializer(serializers.Serializer):
@@ -765,15 +769,18 @@ class JobMultiPartInputSerializer(serializers.Serializer):
     _task_queue = serializers.CharField(required=False, allow_blank=True)
     _job_queue = serializers.CharField(required=False, allow_blank=True)
 
-    def validate(self, data):
-        data = super().validate(data)
+    def validate(self, attrs):
+        attrs = super().validate(attrs)
 
-        if "_schedule_interval" in data and data["_schedule_interval"] != JobExecutionType.TYPE_IMMEDIATELY:
-            if "_schedule_name" not in data:
+        if "_schedule_interval" in attrs and attrs["_schedule_interval"] != JobExecutionType.TYPE_IMMEDIATELY:
+            if "_schedule_name" not in attrs:
                 raise serializers.ValidationError({"_schedule_name": "Please provide a name for the job schedule."})
 
-            if ("_schedule_start_time" not in data and data["_schedule_interval"] != JobExecutionType.TYPE_CUSTOM) or (
-                "_schedule_start_time" in data and data["_schedule_start_time"] < ScheduledJob.earliest_possible_time()
+            if (
+                "_schedule_start_time" not in attrs and attrs["_schedule_interval"] != JobExecutionType.TYPE_CUSTOM
+            ) or (
+                "_schedule_start_time" in attrs
+                and attrs["_schedule_start_time"] < ScheduledJob.earliest_possible_time()
             ):
                 raise serializers.ValidationError(
                     {
@@ -781,15 +788,15 @@ class JobMultiPartInputSerializer(serializers.Serializer):
                     }
                 )
 
-            if data["_schedule_interval"] == JobExecutionType.TYPE_CUSTOM:
-                if data.get("_schedule_crontab") is None:
+            if attrs["_schedule_interval"] == JobExecutionType.TYPE_CUSTOM:
+                if attrs.get("_schedule_crontab") is None:
                     raise serializers.ValidationError({"_schedule_crontab": "Please enter a valid crontab."})
                 try:
-                    ScheduledJob.get_crontab(data["_schedule_crontab"])
+                    ScheduledJob.get_crontab(attrs["_schedule_crontab"])
                 except Exception as e:
                     raise serializers.ValidationError({"_schedule_crontab": e})
 
-        return data
+        return attrs
 
 
 class JobLogEntrySerializer(BaseModelSerializer):
@@ -816,7 +823,7 @@ class JobButtonSerializer(ValidatedModelSerializer, NotesSerializerMixin):
 #
 
 
-class MetadataTypeSerializer(NautobotModelSerializer):
+class MetadataTypeSerializer(TaggedModelSerializerMixin, NautobotModelSerializer):
     content_types = ContentTypeField(
         queryset=ContentType.objects.filter(FeatureQuery("metadata").get_query()),
         many=True,
@@ -1073,18 +1080,18 @@ class TagSerializer(NautobotModelSerializer):
             "color": {"help_text": "RGB color in hexadecimal (e.g. 00ff00)"},
         }
 
-    def validate(self, data):
-        data = super().validate(data)
+    def validate(self, attrs):
+        attrs = super().validate(attrs)
 
         # check if tag is assigned to any of the removed content_types
-        if self.instance is not None and self.instance.present_in_database and "content_types" in data:
-            content_types_id = [content_type.id for content_type in data["content_types"]]
+        if self.instance is not None and self.instance.present_in_database and "content_types" in attrs:
+            content_types_id = [content_type.id for content_type in attrs["content_types"]]
             errors = self.instance.validate_content_types_removal(content_types_id)
 
             if errors:
                 raise serializers.ValidationError(errors)
 
-        return data
+        return attrs
 
 
 #
@@ -1092,9 +1099,7 @@ class TagSerializer(NautobotModelSerializer):
 #
 
 
-class TeamSerializer(NautobotModelSerializer):
-    contacts = NautobotHyperlinkedRelatedField(queryset=Contact.objects.all(), many=True, required=False)
-
+class TeamSerializer(TaggedModelSerializerMixin, NautobotModelSerializer):
     class Meta:
         model = Team
         fields = "__all__"
@@ -1106,10 +1111,10 @@ class TeamSerializer(NautobotModelSerializer):
         # https://www.django-rest-framework.org/api-guide/validators/#optional-fields
         validators = []
 
-    def validate(self, data):
+    def validate(self, attrs):
         validator = UniqueTogetherValidator(queryset=Team.objects.all(), fields=("name", "phone", "email"))
-        validator(data, self)
-        return super().validate(data)
+        validator(attrs, self)
+        return super().validate(attrs)
 
 
 #
@@ -1127,19 +1132,19 @@ class WebhookSerializer(ValidatedModelSerializer, NotesSerializerMixin):
         model = Webhook
         fields = "__all__"
 
-    def validate(self, data):
-        validated_data = super().validate(data)
+    def validate(self, attrs):
+        validated_attrs = super().validate(attrs)
 
         conflicts = Webhook.check_for_conflicts(
             instance=self.instance,
-            content_types=data.get("content_types"),
-            payload_url=data.get("payload_url"),
-            type_create=data.get("type_create"),
-            type_update=data.get("type_update"),
-            type_delete=data.get("type_delete"),
+            content_types=attrs.get("content_types"),
+            payload_url=attrs.get("payload_url"),
+            type_create=attrs.get("type_create"),
+            type_update=attrs.get("type_update"),
+            type_delete=attrs.get("type_delete"),
         )
 
         if conflicts:
             raise serializers.ValidationError(conflicts)
 
-        return validated_data
+        return validated_attrs