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

nautobot/extras/forms/forms.py

@@ -1,5 +1,7 @@
 import inspect
+import logging
 
+from celery import chain
 from django import forms
 from django.conf import settings
 from django.contrib.auth import get_user_model
@@ -7,8 +9,9 @@ from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ValidationError
 from django.core.validators import MinValueValidator
 from django.db.models.fields import TextField
-from django.forms import inlineformset_factory, ModelMultipleChoiceField
+from django.forms import inlineformset_factory, ModelMultipleChoiceField, MultipleHiddenInput
 from django.urls.base import reverse
+from django.utils.timezone import get_current_timezone_name
 
 from nautobot.core.constants import CHARFIELD_MAX_LENGTH
 from nautobot.core.forms import (
@@ -25,7 +28,6 @@ from nautobot.core.forms import (
     DateTimePicker,
     DynamicModelChoiceField,
     DynamicModelMultipleChoiceField,
-    JSONArrayFormField,
     JSONField,
     LaxURLField,
     MultipleContentTypeField,
@@ -35,11 +37,13 @@ from nautobot.core.forms import (
     TagFilterField,
 )
 from nautobot.core.forms.constants import BOOLEAN_WITH_BLANK_CHOICES
+from nautobot.core.forms.forms import ConfirmationForm
 from nautobot.core.utils.deprecation import class_deprecated_in_favor_of
 from nautobot.dcim.models import Device, DeviceRedundancyGroup, DeviceType, Location, Platform
 from nautobot.extras.choices import (
     DynamicGroupTypeChoices,
     JobExecutionType,
+    JobQueueTypeChoices,
     JobResultStatusChoices,
     ObjectChangeActionChoices,
     RelationshipTypeChoices,
@@ -65,6 +69,7 @@ from nautobot.extras.models import (
     Job,
     JobButton,
     JobHook,
+    JobQueue,
     JobResult,
     MetadataChoice,
     MetadataType,
@@ -86,9 +91,12 @@ from nautobot.extras.models import (
     Webhook,
 )
 from nautobot.extras.registry import registry
+from nautobot.extras.signals import change_context_state
+from nautobot.extras.tasks import delete_custom_field_data
 from nautobot.extras.utils import (
     ChangeLoggedModelsQuery,
     FeatureQuery,
+    get_worker_count,
     RoleModelsQuery,
     TaggableClassesQuery,
 )
@@ -106,86 +114,93 @@ from .mixins import (
     CustomFieldModelFormMixin,
     NoteModelBulkEditFormMixin,
     NoteModelFormMixin,
+    TagsBulkEditFormMixin,
 )
 
+logger = logging.getLogger(__name__)
+
 __all__ = (
     "BaseDynamicGroupMembershipFormSet",
-    "ComputedFieldForm",
     "ComputedFieldFilterForm",
-    "ConfigContextForm",
+    "ComputedFieldForm",
     "ConfigContextBulkEditForm",
     "ConfigContextFilterForm",
-    "ConfigContextSchemaForm",
+    "ConfigContextForm",
     "ConfigContextSchemaBulkEditForm",
     "ConfigContextSchemaFilterForm",
-    "CustomFieldForm",
-    "CustomFieldFilterForm",
-    "CustomFieldModelCSVForm",
+    "ConfigContextSchemaForm",
     "CustomFieldBulkCreateForm",  # 2.0 TODO remove this deprecated class
+    "CustomFieldBulkDeleteForm",
     "CustomFieldChoiceFormSet",
-    "CustomLinkForm",
+    "CustomFieldFilterForm",
+    "CustomFieldForm",
+    "CustomFieldModelCSVForm",
     "CustomLinkFilterForm",
+    "CustomLinkForm",
     "DynamicGroupBulkAssignForm",
-    "DynamicGroupForm",
     "DynamicGroupFilterForm",
+    "DynamicGroupForm",
     "DynamicGroupMembershipFormSet",
-    "ExportTemplateForm",
     "ExportTemplateFilterForm",
+    "ExportTemplateForm",
+    "ExternalIntegrationBulkEditForm",
     "ExternalIntegrationFilterForm",
     "ExternalIntegrationForm",
-    "ExternalIntegrationBulkEditForm",
-    "GitRepositoryForm",
     "GitRepositoryBulkEditForm",
     "GitRepositoryFilterForm",
-    "GraphQLQueryForm",
+    "GitRepositoryForm",
     "GraphQLQueryFilterForm",
+    "GraphQLQueryForm",
     "ImageAttachmentForm",
-    "JobForm",
     "JobBulkEditForm",
-    "JobButtonForm",
     "JobButtonBulkEditForm",
     "JobButtonFilterForm",
+    "JobButtonForm",
     "JobEditForm",
     "JobFilterForm",
-    "JobHookForm",
+    "JobForm",
     "JobHookFilterForm",
-    "JobScheduleForm",
+    "JobHookForm",
+    "JobQueueBulkEditForm",
+    "JobQueueFilterForm",
+    "JobQueueForm",
     "JobResultFilterForm",
+    "JobScheduleForm",
     "LocalContextFilterForm",
-    "LocalContextModelForm",
     "LocalContextModelBulkEditForm",
+    "LocalContextModelForm",
+    "MetadataChoiceFormSet",
     "MetadataTypeBulkEditForm",
-    "MetadataTypeForm",
     "MetadataTypeFilterForm",
-    "MetadataChoiceFormSet",
-    "NoteForm",
+    "MetadataTypeForm",
     "NoteFilterForm",
+    "NoteForm",
     "ObjectChangeFilterForm",
     "ObjectMetadataFilterForm",
     "PasswordInputWithPlaceholder",
-    "RelationshipForm",
-    "RelationshipFilterForm",
     "RelationshipAssociationFilterForm",
+    "RelationshipFilterForm",
+    "RelationshipForm",
     "RoleBulkEditForm",
     "RoleFilterForm",
     "RoleForm",
     "SavedViewForm",
     "SavedViewModalForm",
     "ScheduledJobFilterForm",
-    "SecretForm",
     "SecretFilterForm",
-    "SecretsGroupForm",
-    "SecretsGroupFilterForm",
+    "SecretForm",
     "SecretsGroupAssociationFormSet",
+    "SecretsGroupFilterForm",
+    "SecretsGroupForm",
     "StaticGroupAssociationFilterForm",
-    "StatusForm",
-    "StatusFilterForm",
     "StatusBulkEditForm",
-    "TagForm",
-    "TagFilterForm",
+    "StatusFilterForm",
+    "StatusForm",
     "TagBulkEditForm",
-    "WebhookForm",
+    "TagFilterForm",
+    "TagForm",
     "WebhookFilterForm",
+    "WebhookForm",
 )
 
 
@@ -485,6 +500,44 @@ class CustomFieldBulkCreateForm(CustomFieldModelBulkEditFormMixin):
     """No longer needed as a separate class - use CustomFieldModelBulkEditFormMixin instead."""
 
 
+class CustomFieldBulkDeleteForm(ConfirmationForm):
+    def __init__(self, *args, delete_all=False, **kwargs):
+        super().__init__(*args, **kwargs)
+        queryset = CustomField.objects.all()
+        self.fields["pk"] = ModelMultipleChoiceField(
+            queryset=queryset, widget=MultipleHiddenInput, required=not delete_all
+        )
+
+    def construct_custom_field_delete_tasks(self, queryset):
+        """
+        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)), context)
+            for obj in queryset
+        ]
+        return tasks
+
+    def perform_pre_delete(self, queryset):
+        """
+        Remove all Custom Field Keys/Values from _custom_field_data of the related ContentType in the background.
+        """
+        if not get_worker_count():
+            logger.error("Celery worker process not running. Object custom fields may fail to reflect this deletion.")
+            return
+        tasks = self.construct_custom_field_delete_tasks(queryset)
+        # Executing the tasks in the background sequentially using chain() aligns with how a single
+        # CustomField object is deleted.  We decided to not check the result because it needs at least one worker
+        # to be active and comes with extra performance penalty.
+        chain(*tasks).apply_async()
+
+
 #
 # Custom Links
 #
@@ -945,28 +998,19 @@ class JobForm(BootstrapMixin, forms.Form):
     controlled by the job definition. See `nautobot.extras.jobs.BaseJob.as_form`
     """
 
-    _profile = forms.BooleanField(
-        required=False,
-        initial=False,
-        label="Profile job execution",
-        help_text="Profiles the job execution using cProfile and outputs a report to /tmp/",
+
+class JobEditForm(NautobotModelForm):
+    job_queues = DynamicModelMultipleChoiceField(
+        label="Job Queues",
+        queryset=JobQueue.objects.all(),
     )
-    _task_queue = forms.ChoiceField(
+    default_job_queue = DynamicModelChoiceField(
+        label="Default Job Queue",
+        queryset=JobQueue.objects.all(),
+        help_text="The default job queue to route this job to",
         required=False,
-        help_text="The task queue to route this job to",
-        label="Task queue",
     )
 
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-
-        # Move special fields to the end of the form
-        for field in ["_task_queue", "_profile"]:
-            value = self.fields.pop(field)
-            self.fields[field] = value
-
-
-class JobEditForm(NautobotModelForm):
     class Meta:
         model = Job
         fields = [
@@ -989,8 +1033,12 @@ class JobEditForm(NautobotModelForm):
             "time_limit",
             "has_sensitive_variables_override",
             "has_sensitive_variables",
-            "task_queues_override",
-            "task_queues",
+            "job_queues_override",
+            "job_queues",
+            "default_job_queue_override",
+            "default_job_queue",
+            "is_singleton",
+            "is_singleton_override",
             "tags",
         ]
 
@@ -1006,8 +1054,28 @@ class JobEditForm(NautobotModelForm):
             for field_name in JOB_OVERRIDABLE_FIELDS:
                 if not cleaned_data.get(f"{field_name}_override", False):
                     cleaned_data[field_name] = getattr(job_class, field_name)
+            # Get default Job Queue first
+            if not cleaned_data.get("default_job_queue_override", False):
+                meta_task_queues = getattr(job_class, "task_queues", []) or [settings.CELERY_TASK_DEFAULT_QUEUE]
+                cleaned_data["default_job_queue"], _ = JobQueue.objects.get_or_create(
+                    name=meta_task_queues[0], defaults={"queue_type": JobQueueTypeChoices.TYPE_CELERY}
+                )
+            default_job_queue = cleaned_data["default_job_queue"]
+            # Include the default Job Queue in the Job Queues selection
+            if not cleaned_data.get("job_queues_override", False):
+                names = getattr(job_class, "task_queues", []) or [settings.CELERY_TASK_DEFAULT_QUEUE]
+            else:
+                names = list(cleaned_data["job_queues"].values_list("name", flat=True))
+            names += [default_job_queue]
+            cleaned_data["job_queues"] = JobQueue.objects.filter(name__in=names)
+
         return cleaned_data
 
+    def save(self, *args, **kwargs):
+        instance = super().save(*args, **kwargs)
+        instance.job_queues.set(self.cleaned_data["job_queues"])
+        return instance
+
 
 class JobBulkEditForm(NautobotBulkEditForm):
     """Bulk edit form for `Job` objects."""
@@ -1058,10 +1126,22 @@ class JobBulkEditForm(NautobotBulkEditForm):
         help_text="Maximum runtime in seconds before the job will be forcibly terminated."
         "<br>Set to 0 to use Nautobot system default",
     )
-    task_queues = JSONArrayFormField(
-        base_field=forms.CharField(max_length=CHARFIELD_MAX_LENGTH),
-        help_text="Comma separated list of task queues that this job can run on. A blank list will use the default queue",
+    job_queues = DynamicModelMultipleChoiceField(
+        label="Job Queues",
+        queryset=JobQueue.objects.all(),
+        required=False,
+        help_text="Job Queue instances that this job can run on",
+    )
+    default_job_queue = DynamicModelChoiceField(
+        label="Default Job Queue",
+        queryset=JobQueue.objects.all(),
         required=False,
+        help_text="Default Job Queue the job runs on if no Job Queue is specified",
+    )
+    is_singleton = forms.NullBooleanField(
+        required=False,
+        widget=BulkEditNullBooleanSelect,
+        help_text="Whether this job should fail to run if another instance of this job is already running",
     )
     # Flags to indicate whether the above properties are inherited from the source code or overridden by the database
     # Text field overrides
@@ -1081,9 +1161,13 @@ class JobBulkEditForm(NautobotBulkEditForm):
         required=False,
         help_text="If checked, time limits will be reverted to the default values defined in each Job's source code",
     )
-    clear_task_queues_override = forms.BooleanField(
+    clear_job_queues_override = forms.BooleanField(
+        required=False,
+        help_text="If checked, the selected job queues will be reverted to the default values defined in each Job's source code",
+    )
+    clear_default_job_queue_override = forms.BooleanField(
         required=False,
-        help_text="If checked, task queue overrides will be reverted to the default values defined in each Job's source code",
+        help_text="If checked, the default job queue will be reverted to the first value of task_queues defined in each Job's source code",
     )
     # Boolean overrides
     clear_approval_required_override = forms.BooleanField(
@@ -1102,10 +1186,62 @@ class JobBulkEditForm(NautobotBulkEditForm):
         required=False,
         help_text="If checked, the values of has sensitive variables will be reverted to the default values defined in each Job's source code",
     )
+    is_singleton_override = forms.BooleanField(
+        required=False,
+        help_text="If checked, the values of is singleton will be reverted to the default values defined in each Job's source code",
+    )
 
     class Meta:
         model = Job
 
+    def post_save(self, obj):
+        super().post_save(obj)
+
+        cleaned_data = self.cleaned_data
+
+        # Handle text related fields
+        for overridable_field in JOB_OVERRIDABLE_FIELDS:
+            override_field = overridable_field + "_override"
+            clear_override_field = "clear_" + overridable_field + "_override"
+            reset_override = cleaned_data.get(clear_override_field, False)
+            override_value = cleaned_data.get(overridable_field)
+            if reset_override:
+                setattr(obj, override_field, False)
+            elif not reset_override and override_value not in [None, ""]:
+                setattr(obj, override_field, True)
+                setattr(obj, overridable_field, override_value)
+
+        # Handle job queues
+        clear_override_field = "clear_job_queues_override"
+        reset_override = cleaned_data.get(clear_override_field, False)
+        if reset_override:
+            meta_task_queues = obj.job_class.task_queues
+            job_queues = []
+            for queue_name in meta_task_queues:
+                try:
+                    job_queues.append(JobQueue.objects.get(name=queue_name))
+                except JobQueue.DoesNotExist:
+                    # Do we want to create the Job Queue for the users here if we do not have it in the database?
+                    pass
+            obj.job_queues_override = False
+            obj.job_queues.set(job_queues)
+        elif cleaned_data["job_queues"]:
+            obj.job_queues_override = True
+
+        # Handle default job queue
+        clear_override_field = "clear_default_job_queue_override"
+        reset_override = cleaned_data.get(clear_override_field, False)
+        if reset_override:
+            meta_task_queues = obj.job_class.task_queues
+            obj.default_job_queue_override = False
+            obj.default_job_queue, _ = JobQueue.objects.get_or_create(
+                name=meta_task_queues[0] if meta_task_queues else settings.CELERY_TASK_DEFAULT_QUEUE
+            )
+        elif cleaned_data["default_job_queue"]:
+            obj.default_job_queue_override = True
+
+        obj.validated_save()
+
 
 class JobFilterForm(BootstrapMixin, forms.Form):
     model = Job
@@ -1201,6 +1337,64 @@ class JobHookFilterForm(BootstrapMixin, forms.Form):
     type_delete = forms.NullBooleanField(required=False, widget=StaticSelect2(choices=BOOLEAN_WITH_BLANK_CHOICES))
 
 
+class JobQueueBulkEditForm(TagsBulkEditFormMixin, NautobotBulkEditForm):
+    pk = forms.ModelMultipleChoiceField(
+        queryset=JobQueue.objects.all(),
+        widget=forms.MultipleHiddenInput(),
+    )
+    queue_type = forms.ChoiceField(
+        choices=JobQueueTypeChoices,
+        help_text="The job can either run immediately, once in the future, or on a recurring schedule.",
+        label="Type",
+        required=False,
+    )
+    tenant = DynamicModelChoiceField(
+        queryset=Tenant.objects.all(),
+        required=False,
+    )
+    description = forms.CharField(required=False, max_length=CHARFIELD_MAX_LENGTH)
+
+    class Meta:
+        model = JobQueue
+        nullable_fields = [
+            "secrets_group",
+            "description",
+            "tenant",
+        ]
+
+
+class JobQueueFilterForm(NautobotFilterForm):
+    model = JobQueue
+    q = forms.CharField(required=False, label="Search")
+    name = forms.CharField(required=False)
+    jobs = DynamicModelMultipleChoiceField(queryset=Job.objects.all(), required=False)
+    queue_type = forms.MultipleChoiceField(
+        choices=JobQueueTypeChoices,
+        required=False,
+        widget=StaticSelect2Multiple(),
+    )
+    tenant = DynamicModelMultipleChoiceField(queryset=Tenant.objects.all(), to_field_name="name", required=False)
+    tags = TagFilterField(model)
+
+
+class JobQueueForm(NautobotModelForm):
+    name = forms.CharField(required=True, max_length=CHARFIELD_MAX_LENGTH)
+    queue_type = forms.ChoiceField(
+        choices=JobQueueTypeChoices,
+        label="Queue Type",
+    )
+    tenant = DynamicModelChoiceField(
+        queryset=Tenant.objects.all(),
+        required=False,
+    )
+    description = forms.CharField(required=False, max_length=CHARFIELD_MAX_LENGTH)
+    tags = DynamicModelMultipleChoiceField(queryset=Tag.objects.all(), required=False)
+
+    class Meta:
+        model = JobQueue
+        fields = ("name", "queue_type", "description", "tenant", "tags")
+
+
 class JobScheduleForm(BootstrapMixin, forms.Form):
     """
     This form is rendered alongside the JobForm but deals specifically with the fields needed to either
@@ -1223,7 +1417,6 @@ class JobScheduleForm(BootstrapMixin, forms.Form):
         required=False,
         label="Starting date and time",
         widget=DateTimePicker(),
-        help_text=f"The scheduled time is relative to the Nautobot configured timezone: {settings.TIME_ZONE}.",
     )
     _recurrence_custom_time = forms.CharField(
         required=False,
@@ -1260,6 +1453,16 @@ class JobScheduleForm(BootstrapMixin, forms.Form):
                 except Exception as e:
                     raise ValidationError({"_recurrence_custom_time": e})
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        # setting the help_text for `_schedule_start_time` here instead of in the field definition
+        # because Django needs to be fully initialized before we can accurately retrieve the current timezone.
+        self.fields[
+            "_schedule_start_time"
+        ].help_text = (
+            f"The scheduled time is relative to the Nautobot configured timezone: {get_current_timezone_name()}."
+        )
+
 
 class JobResultFilterForm(BootstrapMixin, forms.Form):
     model = JobResult
@@ -1429,7 +1632,7 @@ class MetadataTypeFilterForm(NautobotFilterForm):
     tags = TagFilterField(model)
 
 
-class MetadataTypeBulkEditForm(NautobotBulkEditForm):
+class MetadataTypeBulkEditForm(TagsBulkEditFormMixin, NautobotBulkEditForm):
     pk = forms.ModelMultipleChoiceField(queryset=MetadataType.objects.all(), widget=forms.MultipleHiddenInput)
     description = forms.CharField(required=False, max_length=CHARFIELD_MAX_LENGTH)
 

nautobot/extras/forms/mixins.py

@@ -34,7 +34,7 @@ from nautobot.extras.utils import remove_prefix_from_cf_key
 logger = logging.getLogger(__name__)
 
 
-__all__ = (
+__all__ = (  # noqa:RUF022
     "ContactTeamModelFilterFormMixin",
     "CustomFieldModelBulkEditFormMixin",
     "CustomFieldModelFilterFormMixin",
@@ -673,7 +673,7 @@ class RelationshipModelFormMixin(forms.ModelForm):
             for peer_id in target_peer_ids:
                 relationship = self.fields[field_name].model
                 if not relationship.symmetric:
-                    association = RelationshipAssociation(
+                    association = RelationshipAssociation(  # pylint: disable=repeated-keyword
                         relationship=relationship,
                         **{
                             f"{side}_type": self.obj_type,
@@ -837,7 +837,7 @@ class StatusModelFilterFormMixin(forms.Form):
         self.order_fields(self.field_order)  # Reorder fields again
 
 
-class TagsBulkEditFormMixin(forms.Form):
+class TagsBulkEditFormMixin(BulkEditForm):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 

nautobot/extras/graphql/types.py

@@ -1,11 +1,15 @@
+import graphene
+
 from nautobot.core.graphql.types import OptimizedNautobotObjectType
 from nautobot.extras.filters import (
     ContactAssociationFilterSet,
     DynamicGroupFilterSet,
+    JobFilterSet,
+    ScheduledJobFilterSet,
     StatusFilterSet,
     TagFilterSet,
 )
-from nautobot.extras.models import ContactAssociation, DynamicGroup, Status, Tag
+from nautobot.extras.models import ContactAssociation, DynamicGroup, Job, ScheduledJob, Status, Tag
 
 
 class ContactAssociationType(OptimizedNautobotObjectType):
@@ -24,6 +28,26 @@ class DynamicGroupType(OptimizedNautobotObjectType):
         filterset_class = DynamicGroupFilterSet
 
 
+class JobType(OptimizedNautobotObjectType):
+    """Graphql Type Object for Job model."""
+
+    class Meta:
+        model = Job
+        filterset_class = JobFilterSet
+
+    task_queues = graphene.List(graphene.String)
+
+
+class ScheduledJobType(OptimizedNautobotObjectType):
+    """Graphql Type Object for Job model."""
+
+    class Meta:
+        model = ScheduledJob
+        filterset_class = ScheduledJobFilterSet
+
+    queue = graphene.String
+
+
 class StatusType(OptimizedNautobotObjectType):
     """Graphql Type object for `Status` model."""
 

nautobot/extras/health_checks.py

@@ -160,5 +160,4 @@ class RedisBackend(RedisHealthCheck):
         elif client_class == "django_redis.client.DefaultClient":
             self.check_redis(redis_url=location, **options.get("CONNECTION_POOL_KWARGS", {}))
         else:
-            if self.redis_url is None:
-                self.add_error(ServiceUnavailable(f"{client_class} is an unsupported CLIENT_CLASS!"))
+            self.add_error(ServiceUnavailable(f"{client_class} is an unsupported CLIENT_CLASS!"))