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

nautobot/extras/api/serializers.py

@@ -66,6 +66,8 @@ from nautobot.extras.models import (
     JobButton,
     JobHook,
     JobLogEntry,
+    JobQueue,
+    JobQueueAssignment,
     JobResult,
     MetadataChoice,
     MetadataType,
@@ -212,13 +214,13 @@ class ContactSerializer(NautobotModelSerializer):
             "phone": {"default": ""},
         }
 
-    def validate(self, attrs):
-        local_attrs = attrs.copy()
-        local_attrs.pop("teams", None)
+    def validate(self, data):
+        attrs = data.copy()
+        attrs.pop("teams", None)
         validator = UniqueTogetherValidator(queryset=Contact.objects.all(), fields=("name", "phone", "email"))
-        validator(local_attrs, self)
-        super().validate(local_attrs)
-        return attrs
+        validator(attrs, self)
+        super().validate(attrs)
+        return data
 
 
 class ContactAssociationSerializer(NautobotModelSerializer):
@@ -233,18 +235,18 @@ class ContactAssociationSerializer(NautobotModelSerializer):
             "team": {"required": False},
         }
 
-    def validate(self, attrs):
+    def validate(self, data):
         # Validate uniqueness of (associated object, associated object type, contact/team, role)
         unique_together_fields = None
 
-        if attrs.get("contact") and attrs.get("role"):
+        if data.get("contact") and data.get("role"):
             unique_together_fields = (
                 "associated_object_type",
                 "associated_object_id",
                 "contact",
                 "role",
             )
-        elif attrs.get("team") and attrs.get("role"):
+        elif data.get("team") and data.get("role"):
             unique_together_fields = (
                 "associated_object_type",
                 "associated_object_id",
@@ -257,11 +259,11 @@ class ContactAssociationSerializer(NautobotModelSerializer):
                 queryset=ContactAssociation.objects.all(),
                 fields=unique_together_fields,
             )
-            validator(attrs, self)
+            validator(data, self)
 
-        super().validate(attrs)
+        super().validate(data)
 
-        return attrs
+        return data
 
 
 #
@@ -270,7 +272,6 @@ class ContactAssociationSerializer(NautobotModelSerializer):
 
 
 class ContentTypeSerializer(BaseModelSerializer):
-    id = serializers.IntegerField(read_only=True)
     url = serializers.HyperlinkedIdentityField(view_name="extras-api:contenttype-detail")
     display = serializers.SerializerMethodField()
 
@@ -279,8 +280,8 @@ class ContentTypeSerializer(BaseModelSerializer):
         fields = "__all__"
 
     @extend_schema_field(serializers.CharField)
-    def get_display(self, instance):
-        return instance.app_labeled_name
+    def get_display(self, obj):
+        return obj.app_labeled_name
 
 
 #
@@ -501,17 +502,17 @@ class ImageAttachmentSerializer(ValidatedModelSerializer):
         model = ImageAttachment
         fields = "__all__"
 
-    def validate(self, attrs):
+    def validate(self, data):
         # Validate that the parent object exists
         try:
-            attrs["content_type"].get_object_for_this_type(id=attrs["object_id"])
+            data["content_type"].get_object_for_this_type(id=data["object_id"])
         except ObjectDoesNotExist:
-            raise serializers.ValidationError(f"Invalid parent object: {attrs['content_type']} ID {attrs['object_id']}")
+            raise serializers.ValidationError(f"Invalid parent object: {data['content_type']} ID {data['object_id']}")
 
         # Enforce model validation
-        super().validate(attrs)
+        super().validate(data)
 
-        return attrs
+        return data
 
     @extend_schema_field(
         PolymorphicProxySerializer(
@@ -535,28 +536,44 @@ class ImageAttachmentSerializer(ValidatedModelSerializer):
 
 
 class JobSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
+    # task_queues and task_queues_override are added to maintain backward compatibility with versions pre v2.4.
+    task_queues = serializers.JSONField(read_only=True, required=False)
+    task_queues_override = serializers.BooleanField(read_only=True, required=False)
+
     class Meta:
         model = Job
         fields = "__all__"
 
-    def validate(self, attrs):
+    def validate(self, data):
         # 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 = attrs.get("has_sensitive_variables", self.instance.has_sensitive_variables)
-            approval_required = attrs.get("approval_required", self.instance.approval_required)
+            has_sensitive_variables = data.get("has_sensitive_variables", self.instance.has_sensitive_variables)
+            approval_required = data.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 attrs:
+                if "approval_required" in data:
                     errors["approval_required"] = [error_message]
-                if "has_sensitive_variables" in attrs:
+                if "has_sensitive_variables" in data:
                     errors["has_sensitive_variables"] = [error_message]
 
                 raise serializers.ValidationError(errors)
 
-        return super().validate(attrs)
+        return super().validate(data)
+
+
+class JobQueueSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
+    class Meta:
+        model = JobQueue
+        fields = "__all__"
+
+
+class JobQueueAssignmentSerializer(ValidatedModelSerializer):
+    class Meta:
+        model = JobQueueAssignment
+        fields = "__all__"
 
 
 class JobVariableSerializer(serializers.Serializer):
@@ -583,6 +600,8 @@ class JobVariableSerializer(serializers.Serializer):
 
 class ScheduledJobSerializer(BaseModelSerializer):
     # start_time = serializers.DateTimeField(format=None, required=False)
+    # queue is added to maintain backward compatibility with versions pre v2.4.
+    queue = serializers.CharField(read_only=True, required=False)
     time_zone = TimeZoneSerializerField(required=False)
 
     class Meta:
@@ -668,22 +687,22 @@ class JobHookSerializer(NautobotModelSerializer):
         model = JobHook
         fields = "__all__"
 
-    def validate(self, attrs):
-        validated_attrs = super().validate(attrs)
+    def validate(self, data):
+        validated_data = super().validate(data)
 
         conflicts = JobHook.check_for_conflicts(
             instance=self.instance,
-            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"),
+            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"),
         )
 
         if conflicts:
             raise serializers.ValidationError(conflicts)
 
-        return validated_attrs
+        return validated_data
 
 
 class JobCreationSerializer(BaseModelSerializer):
@@ -702,15 +721,15 @@ class JobCreationSerializer(BaseModelSerializer):
         model = ScheduledJob
         fields = ["url", "name", "start_time", "interval", "crontab"]
 
-    def validate(self, attrs):
-        attrs = super().validate(attrs)
+    def validate(self, data):
+        data = super().validate(data)
 
-        if attrs["interval"] in choices.JobExecutionType.SCHEDULE_CHOICES:
-            if "name" not in attrs:
+        if data["interval"] in choices.JobExecutionType.SCHEDULE_CHOICES:
+            if "name" not in data:
                 raise serializers.ValidationError({"name": "Please provide a name for the job schedule."})
 
-            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()
+            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()
             ):
                 raise serializers.ValidationError(
                     {
@@ -718,21 +737,22 @@ class JobCreationSerializer(BaseModelSerializer):
                     }
                 )
 
-            if attrs["interval"] == choices.JobExecutionType.TYPE_CUSTOM:
-                if attrs.get("crontab") is None:
+            if data["interval"] == choices.JobExecutionType.TYPE_CUSTOM:
+                if data.get("crontab") is None:
                     raise serializers.ValidationError({"crontab": "Please enter a valid crontab."})
                 try:
-                    models.ScheduledJob.get_crontab(attrs["crontab"])
+                    models.ScheduledJob.get_crontab(data["crontab"])
                 except Exception as e:
                     raise serializers.ValidationError({"crontab": e})
 
-        return attrs
+        return data
 
 
 class JobInputSerializer(serializers.Serializer):
     data = serializers.JSONField(required=False, default=dict)
     schedule = JobCreationSerializer(required=False)
     task_queue = serializers.CharField(required=False, allow_blank=True)
+    job_queue = serializers.CharField(required=False, allow_blank=True)
 
 
 class JobMultiPartInputSerializer(serializers.Serializer):
@@ -743,19 +763,17 @@ class JobMultiPartInputSerializer(serializers.Serializer):
     _schedule_interval = ChoiceField(choices=JobExecutionType, required=False)
     _schedule_crontab = serializers.CharField(required=False, allow_blank=True)
     _task_queue = serializers.CharField(required=False, allow_blank=True)
+    _job_queue = serializers.CharField(required=False, allow_blank=True)
 
-    def validate(self, attrs):
-        attrs = super().validate(attrs)
+    def validate(self, data):
+        data = super().validate(data)
 
-        if "_schedule_interval" in attrs and attrs["_schedule_interval"] != JobExecutionType.TYPE_IMMEDIATELY:
-            if "_schedule_name" not in attrs:
+        if "_schedule_interval" in data and data["_schedule_interval"] != JobExecutionType.TYPE_IMMEDIATELY:
+            if "_schedule_name" not in data:
                 raise serializers.ValidationError({"_schedule_name": "Please provide a name for the job schedule."})
 
-            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()
+            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()
             ):
                 raise serializers.ValidationError(
                     {
@@ -763,15 +781,15 @@ class JobMultiPartInputSerializer(serializers.Serializer):
                     }
                 )
 
-            if attrs["_schedule_interval"] == JobExecutionType.TYPE_CUSTOM:
-                if attrs.get("_schedule_crontab") is None:
+            if data["_schedule_interval"] == JobExecutionType.TYPE_CUSTOM:
+                if data.get("_schedule_crontab") is None:
                     raise serializers.ValidationError({"_schedule_crontab": "Please enter a valid crontab."})
                 try:
-                    ScheduledJob.get_crontab(attrs["_schedule_crontab"])
+                    ScheduledJob.get_crontab(data["_schedule_crontab"])
                 except Exception as e:
                     raise serializers.ValidationError({"_schedule_crontab": e})
 
-        return attrs
+        return data
 
 
 class JobLogEntrySerializer(BaseModelSerializer):
@@ -862,7 +880,6 @@ class NoteSerializer(BaseModelSerializer):
     class Meta:
         model = Note
         fields = "__all__"
-        list_display_fields = ["note", "assigned_object_type", "assigned_object_id", "user"]
 
     @extend_schema_field(
         PolymorphicProxySerializer(
@@ -902,7 +919,6 @@ class ObjectChangeSerializer(BaseModelSerializer):
     class Meta:
         model = ObjectChange
         fields = "__all__"
-        list_display_fields = ["changed_object_id", "related_object_id", "related_object_type", "user"]
 
     @extend_schema_field(
         PolymorphicProxySerializer(
@@ -1057,18 +1073,18 @@ class TagSerializer(NautobotModelSerializer):
             "color": {"help_text": "RGB color in hexadecimal (e.g. 00ff00)"},
         }
 
-    def validate(self, attrs):
-        attrs = super().validate(attrs)
+    def validate(self, data):
+        data = super().validate(data)
 
         # 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 attrs:
-            content_types_id = [content_type.id for content_type in attrs["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"]]
             errors = self.instance.validate_content_types_removal(content_types_id)
 
             if errors:
                 raise serializers.ValidationError(errors)
 
-        return attrs
+        return data
 
 
 #
@@ -1090,10 +1106,10 @@ class TeamSerializer(NautobotModelSerializer):
         # https://www.django-rest-framework.org/api-guide/validators/#optional-fields
         validators = []
 
-    def validate(self, attrs):
+    def validate(self, data):
         validator = UniqueTogetherValidator(queryset=Team.objects.all(), fields=("name", "phone", "email"))
-        validator(attrs, self)
-        return super().validate(attrs)
+        validator(data, self)
+        return super().validate(data)
 
 
 #
@@ -1111,19 +1127,19 @@ class WebhookSerializer(ValidatedModelSerializer, NotesSerializerMixin):
         model = Webhook
         fields = "__all__"
 
-    def validate(self, attrs):
-        validated_attrs = super().validate(attrs)
+    def validate(self, data):
+        validated_data = super().validate(data)
 
         conflicts = Webhook.check_for_conflicts(
             instance=self.instance,
-            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"),
+            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"),
         )
 
         if conflicts:
             raise serializers.ValidationError(conflicts)
 
-        return validated_attrs
+        return validated_data

nautobot/extras/api/urls.py

@@ -69,6 +69,10 @@ router.register("job-hooks", views.JobHooksViewSet)
 # Job Log Entries
 router.register("job-logs", views.JobLogEntryViewSet)
 
+# Job Queues
+router.register("job-queues", views.JobQueueViewSet)
+router.register("job-queue-assignments", views.JobQueueAssignmentViewSet)
+
 # Job Results
 router.register("job-results", views.JobResultViewSet)
 

nautobot/extras/api/views.py

@@ -17,7 +17,6 @@ from rest_framework.permissions import IsAuthenticated
 from rest_framework.response import Response
 
 from nautobot.core.api.authentication import TokenPermissions
-from nautobot.core.api.parsers import NautobotCSVParser
 from nautobot.core.api.utils import get_serializer_for_model
 from nautobot.core.api.views import (
     BulkDestroyModelMixin,
@@ -27,11 +26,13 @@ from nautobot.core.api.views import (
     NautobotAPIVersionMixin,
     ReadOnlyModelViewSet,
 )
+from nautobot.core.events import publish_event
 from nautobot.core.exceptions import CeleryWorkerNotRunningException
 from nautobot.core.graphql import execute_saved_query
 from nautobot.core.models.querysets import count_related
+from nautobot.core.models.utils import serialize_object_v2
 from nautobot.extras import filters
-from nautobot.extras.choices import JobExecutionType
+from nautobot.extras.choices import JobExecutionType, JobQueueTypeChoices
 from nautobot.extras.filters import RoleFilterSet
 from nautobot.extras.jobs import get_job
 from nautobot.extras.models import (
@@ -55,6 +56,8 @@ from nautobot.extras.models import (
     JobButton,
     JobHook,
     JobLogEntry,
+    JobQueue,
+    JobQueueAssignment,
     JobResult,
     MetadataChoice,
     MetadataType,
@@ -78,7 +81,7 @@ from nautobot.extras.models import (
     Webhook,
 )
 from nautobot.extras.secrets.exceptions import SecretError
-from nautobot.extras.utils import get_worker_count
+from nautobot.extras.utils import get_job_queue, get_worker_count
 
 from . import serializers
 
@@ -485,7 +488,6 @@ class ImageAttachmentViewSet(ModelViewSet):
     queryset = ImageAttachment.objects.all()
     serializer_class = serializers.ImageAttachmentSerializer
     filterset_class = filters.ImageAttachmentFilterSet
-    parser_classes = [JSONParser, NautobotCSVParser, MultiPartParser]
 
 
 #
@@ -601,9 +603,8 @@ class JobViewSetBase(
             )
 
         valid_queues = job_model.task_queues if job_model.task_queues else [settings.CELERY_TASK_DEFAULT_QUEUE]
-        # Get a default queue from either the job model's specified task queue or
-        # the system default to fall back on if request doesn't provide one
-        default_valid_queue = valid_queues[0]
+        # default queue should be specified on the default_job_queue.
+        default_valid_queue = job_model.default_job_queue.name
 
         # We need to call request.data for both cases as this is what pulls and caches the request data
         data = request.data
@@ -624,7 +625,23 @@ class JobViewSetBase(
             input_serializer = serializers.JobMultiPartInputSerializer(data=data, context={"request": request})
             input_serializer.is_valid(raise_exception=True)
 
-            task_queue = input_serializer.validated_data.get("_task_queue", default_valid_queue)
+            # TODO remove _task_queue related code in 3.0
+            # _task_queue and _job_queue are both valid arguments in v2.4
+            task_queue = input_serializer.validated_data.get(
+                "_task_queue", None
+            ) or input_serializer.validated_data.get("_job_queue", None)
+            if not task_queue:
+                task_queue = default_valid_queue
+
+            # Log a warning if _task_queue and _job_queue fields are both specified out
+            if input_serializer.validated_data.get("_task_queue", None) and input_serializer.validated_data.get(
+                "_job_queue", None
+            ):
+                raise ValidationError(
+                    {
+                        "_task_queue": "_task_queue and _job_queue are both specified. Please specifiy only one or another."
+                    }
+                )
 
             # JobMultiPartInputSerializer only has keys for executing job (task_queue, etc),
             # everything else is a candidate for the job form's data.
@@ -652,7 +669,21 @@ class JobViewSetBase(
             input_serializer.is_valid(raise_exception=True)
 
             data = input_serializer.validated_data.get("data", {})
-            task_queue = input_serializer.validated_data.get("task_queue", default_valid_queue)
+            # TODO remove _task_queue related code in 3.0
+            # _task_queue and _job_queue are both valid arguments in v2.4
+            task_queue = input_serializer.validated_data.get("task_queue", None) or input_serializer.validated_data.get(
+                "job_queue", None
+            )
+            if not task_queue:
+                task_queue = default_valid_queue
+
+            # Log a warning if _task_queue and _job_queue fields are both specified out
+            if input_serializer.validated_data.get("task_queue", None) and input_serializer.validated_data.get(
+                "job_queue", None
+            ):
+                raise ValidationError(
+                    {"task_queue": "task_queue and job_queue are both specified. Please specifiy only one or another."}
+                )
             schedule_data = input_serializer.validated_data.get("schedule", None)
 
         if task_queue not in valid_queues:
@@ -669,7 +700,10 @@ class JobViewSetBase(
             # of errors under messages
             return Response({"errors": e.message_dict if hasattr(e, "error_dict") else e.messages}, status=400)
 
-        if not get_worker_count(queue=task_queue):
+        queue = get_job_queue(task_queue)
+        if queue is None:
+            queue = job_model.default_job_queue
+        if queue.queue_type == JobQueueTypeChoices.TYPE_CELERY and not get_worker_count(queue=task_queue):
             raise CeleryWorkerNotRunningException(queue=task_queue)
 
         # Default to a null JobResult.
@@ -700,7 +734,7 @@ class JobViewSetBase(
                 interval=schedule_data.get("interval"),
                 crontab=schedule_data.get("crontab", ""),
                 approval_required=approval_required,
-                task_queue=input_serializer.validated_data.get("task_queue", None),
+                task_queue=task_queue,
                 **job_class.serialize_data(cleaned_data),
             )
         else:
@@ -732,13 +766,13 @@ class JobViewSet(
 ):
     lookup_value_regex = r"[-0-9a-fA-F]+"
 
-    def perform_destroy(self, instance):
-        if instance.module_name.startswith("nautobot."):
+    def perform_destroy(self, obj):
+        if obj.module_name.startswith("nautobot."):
             raise ProtectedError(
-                f"Unable to delete Job {instance}. System Job cannot be deleted",
+                f"Unable to delete Job {obj}. System Job cannot be deleted",
                 [],
             )
-        super().perform_destroy(instance)
+        super().perform_destroy(obj)
 
 
 @extend_schema_view(
@@ -784,6 +818,31 @@ class JobHooksViewSet(NautobotModelViewSet):
     filterset_class = filters.JobHookFilterSet
 
 
+#
+# Job Queues
+#
+
+
+class JobQueueViewSet(NautobotModelViewSet):
+    """
+    Manage job queues through DELETE, GET, POST, PUT, and PATCH requests.
+    """
+
+    queryset = JobQueue.objects.all()
+    serializer_class = serializers.JobQueueSerializer
+    filterset_class = filters.JobQueueFilterSet
+
+
+class JobQueueAssignmentViewSet(NautobotModelViewSet):
+    """
+    Manage job queue assignments through DELETE, GET, POST, PUT, and PATCH requests.
+    """
+
+    queryset = JobQueueAssignment.objects.select_related("job", "job_queue")
+    serializer_class = serializers.JobQueueAssignmentSerializer
+    filterset_class = filters.JobQueueAssignmentFilterSet
+
+
 #
 # Job Results
 #
@@ -912,6 +971,8 @@ class ScheduledJobViewSet(ReadOnlyModelViewSet):
         scheduled_job.approved_by_user = request.user
         scheduled_job.approved_at = timezone.now()
         scheduled_job.save()
+        publish_event_payload = {"data": serialize_object_v2(scheduled_job)}
+        publish_event(topic="nautobot.jobs.approval.approved", payload=publish_event_payload)
         serializer = serializers.ScheduledJobSerializer(scheduled_job, context={"request": request})
 
         return Response(serializer.data)
@@ -936,6 +997,8 @@ class ScheduledJobViewSet(ReadOnlyModelViewSet):
         if not Job.objects.check_perms(request.user, instance=scheduled_job.job_model, action="approve"):
             raise PermissionDenied("You do not have permission to deny this request.")
 
+        publish_event_payload = {"data": serialize_object_v2(scheduled_job)}
+        publish_event(topic="nautobot.jobs.approval.denied", payload=publish_event_payload)
         scheduled_job.delete()
 
         return Response(None)

nautobot/extras/choices.py

@@ -229,6 +229,16 @@ class JobExecutionType(ChoiceSet):
     }
 
 
+class JobQueueTypeChoices(ChoiceSet):
+    TYPE_CELERY = "celery"
+    TYPE_KUBERNETES = "kubernetes"
+
+    CHOICES = (
+        (TYPE_CELERY, "Celery"),
+        (TYPE_KUBERNETES, "Kubernetes"),
+    )
+
+
 #
 # Job results
 #
@@ -295,6 +305,7 @@ class LogLevelChoices(ChoiceSet):
     LOG_WARNING = "warning"
     LOG_ERROR = "error"
     LOG_CRITICAL = "critical"
+    LOG_SUCCESS = "success"
 
     CHOICES = (
         (LOG_DEBUG, "Debug"),
@@ -302,6 +313,7 @@ class LogLevelChoices(ChoiceSet):
         (LOG_WARNING, "Warning"),
         (LOG_ERROR, "Error"),
         (LOG_CRITICAL, "Critical"),
+        (LOG_SUCCESS, "Success"),
     )
 
     CSS_CLASSES = {
@@ -310,6 +322,7 @@ class LogLevelChoices(ChoiceSet):
         LOG_WARNING: "warning",
         LOG_ERROR: "error",
         LOG_CRITICAL: "critical",
+        LOG_SUCCESS: "success",
     }
 
 

nautobot/extras/constants.py

@@ -30,7 +30,6 @@ JOB_OVERRIDABLE_FIELDS = (
     "soft_time_limit",
     "time_limit",
     "has_sensitive_variables",
-    "task_queues",
 )