nautobot 2.4.21__py3-none-any.whl → 3.0.0a3__py3-none-any.whl

nautobot/extras/forms/forms.py

@@ -5,6 +5,7 @@ from celery import chain
 from django import forms
 from django.conf import settings
 from django.contrib.auth import get_user_model
+from django.contrib.auth.models import Group
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ValidationError
 from django.core.validators import MinValueValidator
@@ -25,6 +26,7 @@ from nautobot.core.forms import (
     CommentField,
     CSVContentTypeField,
     CSVModelForm,
+    DatePicker,
     DateTimePicker,
     DynamicModelChoiceField,
     DynamicModelMultipleChoiceField,
@@ -37,11 +39,12 @@ from nautobot.core.forms import (
     TagFilterField,
 )
 from nautobot.core.forms.constants import BOOLEAN_WITH_BLANK_CHOICES
+from nautobot.core.forms.fields import MultiValueCharField
 from nautobot.core.forms.forms import ConfirmationForm
 from nautobot.core.forms.widgets import ClearableFileInput
-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 (
+    ApprovalWorkflowStateChoices,
     ButtonClassChoices,
     CustomFieldFilterLogicChoices,
     DynamicGroupTypeChoices,
@@ -55,6 +58,11 @@ from nautobot.extras.choices import (
 from nautobot.extras.constants import JOB_OVERRIDABLE_FIELDS
 from nautobot.extras.datasources import get_datasource_content_choices
 from nautobot.extras.models import (
+    ApprovalWorkflow,
+    ApprovalWorkflowDefinition,
+    ApprovalWorkflowStage,
+    ApprovalWorkflowStageDefinition,
+    ApprovalWorkflowStageResponse,
     ComputedField,
     ConfigContext,
     ConfigContextSchema,
@@ -117,12 +125,23 @@ from .mixins import (
     CustomFieldModelFormMixin,
     NoteModelBulkEditFormMixin,
     NoteModelFormMixin,
+    RelationshipModelFormMixin,
     TagsBulkEditFormMixin,
 )
 
 logger = logging.getLogger(__name__)
 
 __all__ = (
+    "ApprovalWorkflowDefinitionBulkEditForm",
+    "ApprovalWorkflowDefinitionFilterForm",
+    "ApprovalWorkflowDefinitionForm",
+    "ApprovalWorkflowFilterForm",
+    "ApprovalWorkflowStageDefinitionBulkEditForm",
+    "ApprovalWorkflowStageDefinitionFilterForm",
+    "ApprovalWorkflowStageDefinitionForm",
+    "ApprovalWorkflowStageDefinitionFormSet",
+    "ApprovalWorkflowStageFilterForm",
+    "ApprovalWorkflowStageResponseFilterForm",
     "BaseDynamicGroupMembershipFormSet",
     "ComputedFieldBulkEditForm",
     "ComputedFieldFilterForm",
@@ -133,7 +152,6 @@ __all__ = (
     "ConfigContextSchemaBulkEditForm",
     "ConfigContextSchemaFilterForm",
     "ConfigContextSchemaForm",
-    "CustomFieldBulkCreateForm",  # 2.0 TODO remove this deprecated class
     "CustomFieldBulkDeleteForm",
     "CustomFieldBulkEditForm",
     "CustomFieldChoiceFormSet",
@@ -215,6 +233,211 @@ __all__ = (
     "WebhookForm",
 )
 
+#
+# Approval Workflows
+#
+
+
+class ApprovalWorkflowDefinitionForm(
+    BootstrapMixin,
+    CustomFieldModelFormMixin,
+    NoteModelFormMixin,
+    RelationshipModelFormMixin,
+):
+    """Form for creating and updating ApprovalWorkflowDefinition."""
+
+    model_content_type = forms.ModelChoiceField(
+        queryset=ContentType.objects.filter(FeatureQuery("approval_workflows").get_query()).order_by(
+            "app_label", "model"
+        ),
+        required=True,
+        label="Model Content Type",
+    )
+    model_constraints = JSONField(
+        required=False,
+        label="Model Constraints",
+        help_text="Constraints for filtering selected model content type.<br>"
+        "Supports simple Django field lookups.<br>"
+        'Enter in <a href="https://json.org/">JSON</a> format.',
+    )
+
+    class Meta:
+        """Meta attributes."""
+
+        model = ApprovalWorkflowDefinition
+        fields = "__all__"
+
+
+class ApprovalWorkflowDefinitionBulkEditForm(TagsBulkEditFormMixin, NautobotBulkEditForm):
+    """ApprovalWorkflowDefinition bulk edit form."""
+
+    pk = forms.ModelMultipleChoiceField(
+        queryset=ApprovalWorkflowDefinition.objects.all(), widget=forms.MultipleHiddenInput
+    )
+    model_content_type = forms.ModelChoiceField(
+        queryset=ContentType.objects.filter(FeatureQuery("approval_workflows").get_query()).order_by(
+            "app_label", "model"
+        ),
+        required=True,
+        label="Model Content Type",
+    )
+
+    class Meta:
+        """Meta attributes."""
+
+        model = ApprovalWorkflowDefinition
+        nullable_fields = ["model_constraints"]
+
+
+class ApprovalWorkflowDefinitionFilterForm(NautobotFilterForm):
+    """Filter form for ApprovalWorkflowDefinition."""
+
+    model = ApprovalWorkflowDefinition
+    q = forms.CharField(required=False, label="Search")
+    name = MultiValueCharField(required=False)
+    model_content_type = MultipleContentTypeField(
+        queryset=ContentType.objects.filter(FeatureQuery("approval_workflows").get_query()).order_by(
+            "app_label", "model"
+        ),
+        required=False,
+    )
+    tags = TagFilterField(model)
+
+
+class ApprovalWorkflowStageDefinitionForm(NautobotModelForm):
+    """Form for creating and updating ApprovalWorkflowStageDefinition."""
+
+    approval_workflow_definition = DynamicModelChoiceField(
+        queryset=ApprovalWorkflowDefinition.objects.all(),
+        required=True,
+        label="Approval Workflow Definition",
+    )
+    approver_group = DynamicModelChoiceField(
+        queryset=Group.objects.all(),
+        required=True,
+        label="Approver Group",
+        help_text="User group that can approve this stage.",
+    )
+
+    class Meta:
+        """Meta attributes."""
+
+        model = ApprovalWorkflowStageDefinition
+        fields = "__all__"
+
+
+# ApprovalWorkFlow inline formset for use with providing dynamic rows when creating/editing choices
+# for `ApprovalWorkFlowInstance` objects in UI views. Fields/exclude must be set but since we're using all the
+# fields we're just setting `exclude=()` here.
+ApprovalWorkflowStageDefinitionFormSet = inlineformset_factory(
+    parent_model=ApprovalWorkflowDefinition,
+    model=ApprovalWorkflowStageDefinition,
+    exclude=("_custom_field_data",),
+    extra=5,
+    widgets={
+        "name": forms.TextInput(attrs={"class": "form-control"}),
+        "sequence": forms.NumberInput(attrs={"class": "form-control"}),
+        "min_approvers": forms.NumberInput(attrs={"class": "form-control"}),
+        "denial_message": forms.TextInput(attrs={"class": "form-control"}),
+        "approver_group": forms.Select(attrs={"class": "form-control"}),
+    },
+)
+
+
+class ApprovalWorkflowStageDefinitionBulkEditForm(TagsBulkEditFormMixin, NautobotBulkEditForm):
+    """ApprovalWorkflowStageDefinition bulk edit form."""
+
+    pk = forms.ModelMultipleChoiceField(
+        queryset=ApprovalWorkflowStageDefinition.objects.all(), widget=forms.MultipleHiddenInput
+    )
+    sequence = forms.IntegerField(required=False, label="Sequence")
+    min_approvers = forms.IntegerField(required=False, label="Minimum Approvers")
+    denial_message = forms.CharField(required=False, label="Denial Message")
+
+    class Meta:
+        """Meta attributes."""
+
+        model = ApprovalWorkflowStageDefinition
+        nullable_fields = ["denial_message"]
+
+
+class ApprovalWorkflowStageDefinitionFilterForm(NautobotFilterForm):
+    """Filter form for ApprovalWorkflowStageDefinition."""
+
+    model = ApprovalWorkflowStageDefinition
+    q = forms.CharField(required=False, label="Search")
+    name = MultiValueCharField(required=False)
+    approval_workflow_definition = DynamicModelChoiceField(
+        queryset=ApprovalWorkflowDefinition.objects.all(),
+        required=False,
+        label="Approval Workflow Definition",
+    )
+    sequence = forms.IntegerField(required=False, label="Sequence")
+    min_approvers = forms.IntegerField(required=False, label="Minimum Approvers")
+    approver_group = DynamicModelChoiceField(
+        queryset=Group.objects.all(),
+        required=False,
+        label="Approver Group",
+        help_text="User group that can approve this stage.",
+    )
+    tags = TagFilterField(model)
+
+
+class ApprovalWorkflowFilterForm(NautobotFilterForm):
+    """Filter form for ApprovalWorkflow."""
+
+    model = ApprovalWorkflow
+    q = forms.CharField(required=False, label="Search")
+    approval_workflow_definition = DynamicModelChoiceField(
+        queryset=ApprovalWorkflowDefinition.objects.all(),
+        required=False,
+        label="Approval Workflow Definition",
+    )
+    object_under_review_content_type = forms.ModelChoiceField(
+        queryset=ContentType.objects.filter(FeatureQuery("approval_workflows").get_query()).order_by(
+            "app_label", "model"
+        ),
+        required=False,
+        label="Object Under Review Content Type",
+    )
+    current_state = forms.ChoiceField(
+        required=False,
+        choices=add_blank_choice(ApprovalWorkflowStateChoices),
+        widget=StaticSelect2,
+        label="Current State",
+    )
+
+
+class ApprovalWorkflowStageFilterForm(NautobotFilterForm):
+    """Filter form for ApprovalWorkflowStage."""
+
+    model = ApprovalWorkflowStage
+    q = forms.CharField(required=False, label="Search")
+    approval_workflow = DynamicModelChoiceField(
+        queryset=ApprovalWorkflow.objects.all(),
+        required=False,
+        label="Approval Workflow",
+    )
+    approval_workflow_stage_definition = DynamicModelChoiceField(
+        queryset=ApprovalWorkflowStageDefinition.objects.all(),
+        required=False,
+        label="Approval Workflow Stage Definition",
+    )
+    state = forms.ChoiceField(
+        required=False,
+        choices=add_blank_choice(ApprovalWorkflowStateChoices),
+        widget=StaticSelect2,
+        label="State",
+    )
+    decision_date = forms.DateField(widget=DatePicker(), required=False, label="Decision Date")
+
+
+class ApprovalWorkflowStageResponseFilterForm(NautobotFilterForm):
+    """Filter form for ApprovalWorkflowStageResponse."""
+
+    model = ApprovalWorkflowStageResponse
+    q = forms.CharField(required=False, label="Search")
+
 
 #
 # Computed Fields
@@ -602,12 +825,6 @@ class CustomFieldModelCSVForm(CSVModelForm, CustomFieldModelFormMixin):
             self.custom_fields.append(field_name)
 
 
-# 2.0 TODO: remove this class
-@class_deprecated_in_favor_of(CustomFieldModelBulkEditFormMixin)
-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)
@@ -1196,8 +1413,6 @@ class JobEditForm(NautobotModelForm):
             "dryrun_default",
             "hidden_override",
             "hidden",
-            "approval_required_override",
-            "approval_required",
             "soft_time_limit_override",
             "soft_time_limit",
             "time_limit_override",
@@ -1270,11 +1485,6 @@ class JobBulkEditForm(NautobotBulkEditForm):
     has_sensitive_variables = forms.NullBooleanField(
         required=False, widget=BulkEditNullBooleanSelect, help_text="Whether this job contains sensitive variables"
     )
-    approval_required = forms.NullBooleanField(
-        required=False,
-        widget=BulkEditNullBooleanSelect,
-        help_text="Whether the job requires approval from another user before running",
-    )
     hidden = forms.NullBooleanField(
         required=False,
         widget=BulkEditNullBooleanSelect,
@@ -1341,10 +1551,6 @@ class JobBulkEditForm(NautobotBulkEditForm):
         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(
-        required=False,
-        help_text="If checked, the values of approval required will be reverted to the default values defined in each Job's source code",
-    )
     clear_dryrun_default_override = forms.BooleanField(
         required=False,
         help_text="If checked, the values of dryrun default will be reverted to the default values defined in each Job's source code",
@@ -1433,7 +1639,6 @@ class JobFilterForm(BootstrapMixin, forms.Form):
         widget=StaticSelect2(choices=BOOLEAN_WITH_BLANK_CHOICES),
     )
     read_only = forms.NullBooleanField(required=False, widget=StaticSelect2(choices=BOOLEAN_WITH_BLANK_CHOICES))
-    approval_required = forms.NullBooleanField(required=False, widget=StaticSelect2(choices=BOOLEAN_WITH_BLANK_CHOICES))
     is_job_hook_receiver = forms.NullBooleanField(
         initial=False,
         required=False,

nautobot/extras/forms/mixins.py

@@ -11,7 +11,6 @@ from nautobot.core.forms import (
     DynamicModelChoiceField,
     DynamicModelMultipleChoiceField,
 )
-from nautobot.core.utils.deprecation import class_deprecated_in_favor_of
 from nautobot.extras.choices import (
     DynamicGroupTypeChoices,
     RelationshipSideChoices,
@@ -48,17 +47,10 @@ __all__ = (  # noqa:RUF022
     "StatusModelBulkEditFormMixin",
     "StatusModelFilterFormMixin",
     "TagsBulkEditFormMixin",
-    # 2.0 TODO: remove the below deprecated aliases
-    "AddRemoveTagsForm",
-    "CustomFieldBulkEditForm",
-    "CustomFieldModelForm",
-    "RelationshipModelForm",
     "RoleModelBulkEditFormMixin",
     "RoleModelFilterFormMixin",
     "RoleNotRequiredModelFormMixin",
     "RoleRequiredModelFormMixin",
-    "StatusBulkEditFormMixin",
-    "StatusFilterFormMixin",
 )
 
 
@@ -854,36 +846,3 @@ class TagsBulkEditFormMixin(BulkEditForm):
             query_params={"content_types": self.model._meta.label_lower},
             required=False,
         )
-
-
-# 2.2 TODO: Names below are only for backward compatibility with Nautobot 1.3 and earlier. Remove in 2.2
-
-
-@class_deprecated_in_favor_of(TagsBulkEditFormMixin)
-class AddRemoveTagsForm(TagsBulkEditFormMixin):
-    pass
-
-
-@class_deprecated_in_favor_of(CustomFieldModelBulkEditFormMixin)
-class CustomFieldBulkEditForm(CustomFieldModelBulkEditFormMixin):
-    pass
-
-
-@class_deprecated_in_favor_of(CustomFieldModelFormMixin)
-class CustomFieldModelForm(CustomFieldModelFormMixin):
-    pass
-
-
-@class_deprecated_in_favor_of(RelationshipModelFormMixin)
-class RelationshipModelForm(RelationshipModelFormMixin):
-    pass
-
-
-@class_deprecated_in_favor_of(StatusModelBulkEditFormMixin)
-class StatusBulkEditFormMixin(StatusModelBulkEditFormMixin):
-    pass
-
-
-@class_deprecated_in_favor_of(StatusModelFilterFormMixin)
-class StatusFilterFormMixin(StatusModelFilterFormMixin):
-    pass

nautobot/extras/homepage.py

@@ -1,6 +1,18 @@
 from nautobot.core.apps import HomePageItem, HomePagePanel
-from nautobot.extras.choices import JobResultStatusChoices
-from nautobot.extras.models import DynamicGroup, GitRepository, JobResult, ObjectChange
+from nautobot.extras.choices import ApprovalWorkflowStateChoices, JobResultStatusChoices
+from nautobot.extras.models import ApprovalWorkflowStage, DynamicGroup, GitRepository, JobResult, ObjectChange
+
+
+def get_approval_workflow_stages(request):
+    """Callback function to collect pending approval workflow stage instances for panel."""
+    user = request.user
+    group_pks = user.groups.all().values_list("pk", flat=True)
+
+    return ApprovalWorkflowStage.objects.filter(
+        approval_workflow__current_state=ApprovalWorkflowStateChoices.PENDING,
+        state=ApprovalWorkflowStateChoices.PENDING,
+        approval_workflow_stage_definition__approver_group__pk__in=group_pks,
+    )[:15]
 
 
 def get_job_results(request):
@@ -41,6 +53,13 @@ layout = (
             ),
         ),
     ),
+    HomePagePanel(
+        name="Approval Workflow",
+        permissions=["extras.view_approvalworkflowstage"],
+        weight=600,
+        custom_data={"approval_workflow_stages": get_approval_workflow_stages},
+        custom_template="panel_approvalworkflowstage.html",
+    ),
     HomePagePanel(
         name="Data Sources",
         weight=700,

nautobot/extras/jobs.py

@@ -39,6 +39,7 @@ from nautobot.core.forms import (
     JSONField,
 )
 from nautobot.core.forms.widgets import ClearableFileInput
+from nautobot.core.utils.cache import construct_cache_key
 from nautobot.core.utils.config import get_settings_or_config
 from nautobot.core.utils.logging import sanitize
 from nautobot.core.utils.lookup import get_model_from_name
@@ -108,7 +109,6 @@ class BaseJob:
 
         - name (str)
         - description (str)
-        - approval_required (bool)
         - dryrun_default (bool)
         - field_order (list)
         - has_sensitive_variables (bool)
@@ -262,7 +262,7 @@ class BaseJob:
     @classproperty
     def singleton_cache_key(cls) -> str:  # pylint: disable=no-self-argument
         """Cache key for singleton jobs."""
-        return f"nautobot.extras.jobs.running.{cls.class_path}"
+        return construct_cache_key(cls, method_name="running", branch_aware=False, class_path=cls.class_path)
 
     @final
     @classproperty
@@ -353,11 +353,6 @@ class BaseJob:
     def read_only(cls) -> bool:  # pylint: disable=no-self-argument
         return cls._get_meta_attr_and_assert_type("read_only", False, expected_type=bool)
 
-    @final
-    @classproperty
-    def approval_required(cls) -> bool:  # pylint: disable=no-self-argument
-        return cls._get_meta_attr_and_assert_type("approval_required", False, expected_type=bool)
-
     @final
     @classproperty
     def soft_time_limit(cls) -> int:  # pylint: disable=no-self-argument
@@ -400,7 +395,6 @@ class BaseJob:
             "name": cls.name,
             "grouping": cls.grouping,
             "description": cls.description,
-            "approval_required": cls.approval_required,
             "hidden": cls.hidden,
             "soft_time_limit": cls.soft_time_limit,
             "time_limit": cls.time_limit,

nautobot/extras/jobs_ui.py

@@ -39,14 +39,14 @@ class JobKeyValueOverrideValueTablePanel(KeyValueTablePanel):
             value (str): The content to display.
             prefix (str): The label shown before the value (default: 'default is').
         """
-        return format_html('<span class="text-muted">overridden; default is {}</span>', mark_safe(text))  # noqa: S308
+        return format_html('<span class="text-secondary">overridden; default is {}</span>', mark_safe(text))  # noqa: S308
 
     def _render_overridden_block(self, content):
         """
         Render a more complex block of HTML content (like rendered markdown or JSON)
         in a div with a muted label indicating it's an overridden value.
         """
-        return format_html('<div class="text-muted">overridden; default is:<br>{}</div>', content)
+        return format_html('<div class="text-secondary">overridden; default is:<br>{}</div>', content)
 
     def render_description_default(self, default_value):
         """

nautobot/extras/management/__init__.py

@@ -11,6 +11,7 @@ from nautobot.dcim import choices as dcim_choices
 from nautobot.extras import choices as extras_choices
 from nautobot.ipam import choices as ipam_choices
 from nautobot.virtualization import choices as vm_choices
+from nautobot.vpn import choices as vpn_choices
 
 # List of 2-tuples of (model_path, choiceset)
 # Add new mappings here as other models are supported.
@@ -36,6 +37,7 @@ STATUS_CHOICESET_MAP = {
     "ipam.VRF": ipam_choices.VRFStatusChoices,
     "virtualization.VirtualMachine": vm_choices.VirtualMachineStatusChoices,
     "virtualization.VMInterface": vm_choices.VMInterfaceStatusChoices,
+    "vpn.VPNTunnel": vpn_choices.VPNTunnelStatusChoices,
 }
 
 
@@ -101,6 +103,7 @@ STATUS_DESCRIPTION_MAP = {
 # Add new mappings here as other models are supported.
 ROLE_CHOICESET_MAP = {
     "extras.ContactAssociation": extras_choices.ContactAssociationRoleChoices,
+    "vpn.VPNTunnelEndpoint": vpn_choices.VPNTunnelEndpointRoleChoices,
 }
 
 # Map of role name -> default hex_color used when importing color choices in `export_roles_from_choiceset()`.
@@ -110,6 +113,9 @@ ROLE_COLOR_MAP = {
     "Billing": ColorChoices.COLOR_GREEN,
     "Support": ColorChoices.COLOR_YELLOW,
     "On Site": ColorChoices.COLOR_BLACK,
+    "Hub": ColorChoices.COLOR_DARK_GREEN,
+    "Spoke": ColorChoices.COLOR_LIGHT_GREEN,
+    "Peer": ColorChoices.COLOR_ORANGE,
 }
 
 # Map of role name -> description used when importing role choices in `export_roles_from_choiceset()`.
@@ -118,6 +124,9 @@ ROLE_DESCRIPTION_MAP = {
     "Billing": "Unit plays a billing role",
     "Support": "Unit plays a support role",
     "On Site": "Unit plays an on site role",
+    "Hub": "Unit plays a Hub role",
+    "Spoke": "Unit plays a Spoke role",
+    "Peer": "Unit plays a Peer role",
 }
 
 

nautobot/extras/managers.py

@@ -1,7 +1,9 @@
 from celery import states
+from django.contrib.auth import get_user_model
 from django.utils import timezone
 from django_celery_results.managers import TaskResultManager, transaction_retry
 
+from nautobot.core.branching import BranchContext
 from nautobot.core.models import BaseManager
 from nautobot.core.models.querysets import RestrictedQuerySet
 
@@ -101,6 +103,8 @@ class JobResultManager(BaseManager.from_queryset(RestrictedQuerySet), TaskResult
         }
         from nautobot.extras.models.jobs import Job
 
+        User = get_user_model()
+
         # Need to have a try/except block here
         # because sometimes job_model_id will be None.
         try:
@@ -114,28 +118,33 @@ class JobResultManager(BaseManager.from_queryset(RestrictedQuerySet), TaskResult
         if "date_started" in kwargs:
             fields["date_started"] = kwargs["date_started"]
 
-        obj, created = self.using(using).get_or_create(id=task_id, defaults=fields)
-
-        if not created:
-            # Make sure `date_done` is allowed to stay null until the task reaches a ready state.
-            #
-            # Default behavior in `django-celery-results` has this field as a
-            # `DateField(auto_now=True)` which just automatically updates the `date_done` field on every
-            # state transition. This is different than Celery's default behavior (and the current
-            # behavior of Nautobot) to keep it null until there is a state transition to a ready state
-            # (e.g. `SUCCESS`, `REVOKED`, `FAILURE`).
-            if fields["status"] in states.READY_STATES:
-                fields["date_done"] = timezone.now()
-
-            # Always make sure the Job `name` is set.
-            if not obj.name and fields["task_name"]:
-                fields["name"] = fields["task_name"]
-
-            # Set the field values on the model instance.
-            for k, v in fields.items():
-                setattr(obj, k, v)
-
-            obj.save(using=using)
+        with BranchContext(
+            branch_name=celery_kwargs.get("nautobot_job_branch_name", None),
+            user=User.objects.get(id=user_id) if user_id else None,
+            using=using,
+        ):
+            obj, created = self.using(using).get_or_create(id=task_id, defaults=fields)
+
+            if not created:
+                # Make sure `date_done` is allowed to stay null until the task reacheas a ready state.
+                #
+                # Default behavior in `django-celery-results` has this field as a
+                # `DateField(auto_now=True)` which just automatically updates the `date_done` field on every
+                # state transition. This is different than Celery's default behavior (and the current
+                # behavior of Nautobot) to keep it null until there is a state transition to a ready state
+                # (e.g. `SUCCESS`, `REVOKED`, `FAILURE`).
+                if fields["status"] in states.READY_STATES:
+                    fields["date_done"] = timezone.now()
+
+                # Always make sure the Job `name` is set.
+                if not obj.name and fields["task_name"]:
+                    fields["name"] = fields["task_name"]
+
+                # Set the field values on the model instance.
+                for k, v in fields.items():
+                    setattr(obj, k, v)
+
+                obj.save(using=using)
 
         return obj
 

nautobot/extras/migrations/0126_approval_workflow_pre_check.py

@@ -0,0 +1,58 @@
+"""
+Migration pre-check for deprecating the `approval_required` flag on Job.
+
+This migration performs the following checks before proceeding:
+1. Aborts the migration if any ScheduledJob still has `approval_required=True`,
+   because the task approval queue must be cleared before the flag can be removed.
+2. Allows the migration to continue if any Job has `approval_required=True`,
+   but prints a warning to inform that this behavior is deprecated.
+   Users should define an approval workflow definition for such jobs going forward.
+
+Refer to documentation for migration to the new approval workflow system:
+https://docs.nautobot.com/projects/core/en/v3.0.0/user-guide/platform-functionality/approval-workflow/
+"""
+
+from django.db import migrations
+
+from nautobot.extras.exceptions import ApprovalRequiredScheduledJobsError
+
+
+def _migrate_data(apps, *_):
+    ScheduledJob = apps.get_model("extras", "ScheduledJob")
+    approval_required_scheduled_jobs = ScheduledJob.objects.filter(approval_required=True).values_list("id", "name")
+
+    if approval_required_scheduled_jobs:
+        message_lines = [
+            "Migration aborted: These need to be approved (and run) or denied before upgrading to Nautobot v3, as the introduction of the approval workflows feature means that future scheduled-job approvals will be handled differently.",
+            "Refer to the documentation: https://docs.nautobot.com/projects/core/en/v2.4.14/user-guide/platform-functionality/jobs/job-scheduling-and-approvals/#approval-via-the-ui",
+            "Below is a list of affected scheduled jobs:",
+        ]
+        for schedule_job_id, scheduled_job_name in approval_required_scheduled_jobs:
+            message_lines.append(f"    - ID: {schedule_job_id}, Name: {scheduled_job_name}")
+        raise ApprovalRequiredScheduledJobsError("\n".join(message_lines))
+
+    Job = apps.get_model("extras", "Job")
+    approval_required_jobs = Job.objects.filter(approval_required=True).values_list("name")
+    if approval_required_jobs:
+        message_lines = [
+            "Migration passed, but the following jobs still have `approval_required=True`.",
+            "These jobs will no longer trigger approval automatically.",
+            "After upgrading to Nautobot 3.x, you should add an approval workflow definition(s) covering these jobs.",
+            "Refer to the documentation: https://docs.nautobot.com/projects/core/en/v3.0.0/user-guide/platform-functionality/approval-workflow/",
+            "Affected jobs (Names):",
+        ]
+        for job_name in approval_required_jobs:
+            message_lines.append(f"    - {job_name}")
+        print("\n".join(message_lines))
+    else:
+        print("Migration passed: No approval_required jobs or scheduled jobs found.")
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0125_jobresult_date_started"),
+    ]
+
+    operations = [
+        migrations.RunPython(code=_migrate_data, reverse_code=migrations.RunPython.noop),
+    ]