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

nautobot/extras/datasources/registry.py

@@ -1,6 +1,7 @@
 """Registry-related APIs for datasources."""
 
 from nautobot.extras.choices import LogLevelChoices
+from nautobot.extras.models.jobs import JOB_LOGS
 from nautobot.extras.registry import registry
 
 
@@ -48,6 +49,8 @@ def refresh_datasource_content(model_name, record, user, job_result, delete=Fals
     # callbacks will result in this task "failing successfully" by raising an
     # exception.
     failure_logs = job_result.job_log_entries.filter(log_level=LogLevelChoices.LOG_ERROR)
+    if job_result.use_job_logs_db:
+        failure_logs = failure_logs.using(JOB_LOGS)
     if failure_logs.exists():
         msg = f"Failed to refresh data provided by {record}. Please see logs."
         job_result.log(msg, level_choice=LogLevelChoices.LOG_ERROR)

nautobot/extras/exceptions.py

@@ -0,0 +1,5 @@
+from django.core.exceptions import ValidationError
+
+
+class ApprovalRequiredScheduledJobsError(ValidationError):
+    """Raised when scheduled jobs requiring approval are found during migration."""

nautobot/extras/factory.py

@@ -3,6 +3,7 @@ import json
 
 from django.contrib.auth import get_user_model
 from django.contrib.contenttypes.models import ContentType
+from django.urls import NoReverseMatch, reverse
 import factory
 import faker
 
@@ -555,10 +556,19 @@ class SavedViewFactory(BaseModelFactory):
     name = factory.LazyAttributeSequence(lambda o, n: f"Sample {o.view} Saved View - {n + 1}")
     owner = random_instance(User, allow_null=False)
     ct = random_instance(lambda: ContentType.objects.filter(FeatureQuery("saved_views").get_query()), allow_null=False)
-    view = factory.LazyAttribute(lambda o: f"{o.ct.app_label}:{o.ct.model}_list")
     config = factory.Faker("pydict")
     is_shared = NautobotBoolIterator()
+
     # is_global_default currently just defaults to False for all randomly generated saved views
+    @factory.lazy_attribute
+    def view(self):
+        view_name = f"{self.ct.app_label}:{self.ct.model}_list"
+        try:
+            reverse(view_name)
+        except NoReverseMatch:
+            # It might be a model from a plugin. i.e. example_app
+            view_name = "plugins:" + view_name
+        return view_name
 
 
 class StaticGroupAssociationFactory(OrganizationalModelFactory):

nautobot/extras/{filters/mixins.py → filter_mixins.py}

@@ -12,6 +12,7 @@ from nautobot.core.constants import (
     FILTER_NUMERIC_BASED_LOOKUP_MAP,
 )
 from nautobot.core.filters import (
+    ModelMultipleChoiceFilter,
     MultiValueDateTimeFilter,
     NaturalKeyOrPKMultipleChoiceFilter,
 )
@@ -20,7 +21,7 @@ from nautobot.extras.choices import (
     CustomFieldTypeChoices,
     RelationshipSideChoices,
 )
-from nautobot.extras.filters.customfields import (
+from nautobot.extras.filter_mixins_customfields import (
     CustomFieldBooleanFilter,
     CustomFieldCharFilter,
     CustomFieldDateFilter,
@@ -166,7 +167,7 @@ class LocalContextModelFilterSetMixin(django_filters.FilterSet):
         method="_local_config_context_data",
         label="Has local config context data",
     )
-    local_config_context_schema_id = django_filters.ModelMultipleChoiceFilter(
+    local_config_context_schema_id = ModelMultipleChoiceFilter(
         queryset=ConfigContextSchema.objects.all(),
         label="Schema (ID) - Deprecated (use local_context_schema filter)",
     )
@@ -180,7 +181,7 @@ class LocalContextModelFilterSetMixin(django_filters.FilterSet):
         return queryset.exclude(local_config_context_data__isnull=value)
 
 
-class RelationshipFilter(django_filters.ModelMultipleChoiceFilter):
+class RelationshipFilter(ModelMultipleChoiceFilter):
     """
     Filter objects by the presence of associations on a given Relationship.
     """

nautobot/extras/{filters/__init__.py → filters.py}

@@ -15,13 +15,14 @@ from nautobot.core.filters import (
     BaseFilterSet,
     ContentTypeFilter,
     ContentTypeMultipleChoiceFilter,
+    ModelMultipleChoiceFilter,
+    MultiValueDateTimeFilter,
     MultiValueUUIDFilter,
     NameSearchFilterSet,
     NaturalKeyOrPKMultipleChoiceFilter,
     RelatedMembershipBooleanFilter,
     SearchFilter,
 )
-from nautobot.core.utils.deprecation import class_deprecated_in_favor_of
 from nautobot.dcim.models import DeviceRedundancyGroup, DeviceType, Location, Platform
 from nautobot.extras.choices import (
     JobQueueTypeChoices,
@@ -31,7 +32,18 @@ from nautobot.extras.choices import (
     SecretsGroupAccessTypeChoices,
     SecretsGroupSecretTypeChoices,
 )
-from nautobot.extras.filters.customfields import (
+from nautobot.extras.filter_mixins import (
+    ConfigContextRoleFilter,
+    CreatedUpdatedModelFilterSetMixin,
+    CustomFieldModelFilterSetMixin,
+    LocalContextModelFilterSetMixin,
+    RelationshipFilter,
+    RelationshipModelFilterSetMixin,
+    RoleModelFilterSetMixin,
+    StatusFilter,
+    StatusModelFilterSetMixin,
+)
+from nautobot.extras.filter_mixins_customfields import (
     CustomFieldBooleanFilter,
     CustomFieldCharFilter,
     CustomFieldDateFilter,
@@ -43,18 +55,12 @@ from nautobot.extras.filters.customfields import (
     CustomFieldMultiValueNumberFilter,
     CustomFieldNumberFilter,
 )
-from nautobot.extras.filters.mixins import (
-    ConfigContextRoleFilter,
-    CreatedUpdatedModelFilterSetMixin,
-    CustomFieldModelFilterSetMixin,
-    LocalContextModelFilterSetMixin,
-    RelationshipFilter,
-    RelationshipModelFilterSetMixin,
-    RoleModelFilterSetMixin,
-    StatusFilter,
-    StatusModelFilterSetMixin,
-)
 from nautobot.extras.models import (
+    ApprovalWorkflow,
+    ApprovalWorkflowDefinition,
+    ApprovalWorkflowStage,
+    ApprovalWorkflowStageDefinition,
+    ApprovalWorkflowStageResponse,
     ComputedField,
     ConfigContext,
     ConfigContextSchema,
@@ -101,6 +107,7 @@ from nautobot.extras.models import (
 from nautobot.extras.utils import (
     ChangeLoggedModelsQuery,
     FeatureQuery,
+    get_pending_approval_workflow_stages,
     RoleModelsQuery,
     TaggableClassesQuery,
 )
@@ -108,19 +115,22 @@ from nautobot.tenancy.models import Tenant, TenantGroup
 from nautobot.virtualization.models import Cluster, ClusterGroup
 
 __all__ = (
+    "ApprovalWorkflowDefinitionFilterSet",
+    "ApprovalWorkflowFilterSet",
+    "ApprovalWorkflowStageDefinitionFilterSet",
+    "ApprovalWorkflowStageFilterSet",
+    "ApprovalWorkflowStageResponseFilterSet",
     "ComputedFieldFilterSet",
     "ConfigContextFilterSet",
     "ContactFilterSet",
     "ContentTypeFilterSet",
     "ContentTypeMultipleChoiceFilter",
-    "CreatedUpdatedFilterSet",
     "CreatedUpdatedModelFilterSetMixin",
     "CustomFieldBooleanFilter",
     "CustomFieldCharFilter",
     "CustomFieldDateFilter",
     "CustomFieldFilterMixin",
     "CustomFieldJSONFilter",
-    "CustomFieldModelFilterSet",
     "CustomFieldModelFilterSetMixin",
     "CustomFieldMultiSelectFilter",
     "CustomFieldMultiValueCharFilter",
@@ -140,7 +150,6 @@ __all__ = (
     "JobQueueAssignmentFilterSet",
     "JobQueueFilterSet",
     "JobResultFilterSet",
-    "LocalContextFilterSet",
     "LocalContextModelFilterSetMixin",
     "MetadataChoiceFilterSet",
     "MetadataTypeFilterSet",
@@ -165,15 +174,143 @@ __all__ = (
 )
 
 
-# TODO: remove in 2.2
-@class_deprecated_in_favor_of(CreatedUpdatedModelFilterSetMixin)
-class CreatedUpdatedFilterSet(CreatedUpdatedModelFilterSetMixin):
-    pass
+#
+# Approval Workflows
+#
+
+
+class ApprovalWorkflowStageDefinitionFilterSet(BaseFilterSet):
+    """Filter for ApprovalWorkflowStageDefinition."""
+
+    q = SearchFilter(
+        filter_predicates={
+            "sequence": {
+                "lookup_expr": "exact",
+                "preprocessor": int,
+            },
+            "name": "icontains",
+            "min_approvers": {
+                "lookup_expr": "exact",
+                "preprocessor": int,
+            },
+            "denial_message": "icontains",
+        }
+    )
+    approval_workflow_definition = NaturalKeyOrPKMultipleChoiceFilter(
+        queryset=ApprovalWorkflowDefinition.objects.all(),
+        to_field_name="name",
+    )
+    approval_workflow = NaturalKeyOrPKMultipleChoiceFilter(
+        queryset=ApprovalWorkflow.objects.all(),
+        to_field_name="pk",
+        method="_approval_workflow",
+        label="Filter approval workflow stages by approval workflow",
+    )
+
+    def generate_query__approval_workflow(self, queryset, approval_workflows):
+        """Helper method used by _approval_workflow() method."""
+        query_params = Q()
+        for approval_workflow in approval_workflows:
+            approval_workflow_definition = approval_workflow.approval_workflow_definition
+            query_params |= Q(approval_workflow_definition=approval_workflow_definition)
+        return query_params
+
+    @extend_schema_field({"type": "string"})
+    def _approval_workflow(self, queryset, name, value):
+        """FilterSet method for getting approval workflow stages belong to an approval workflow instance"""
+        if value:
+            params = self.generate_query__approval_workflow(queryset, value)
+            if len(params) > 0:
+                return queryset.filter(params)
+            else:
+                return queryset.none()
+        return queryset
+
+    class Meta:
+        """Meta attributes for filter."""
+
+        model = ApprovalWorkflowStageDefinition
+        fields = "__all__"
+
+
+class ApprovalWorkflowFilterSet(BaseFilterSet):
+    """Filter for ApprovalWorkflow."""
+
+    q = SearchFilter(
+        filter_predicates={
+            "object_under_review_content_type__app_label": "icontains",
+            "object_under_review_content_type__model": "icontains",
+        }
+    )
+    approval_workflow_definition = NaturalKeyOrPKMultipleChoiceFilter(
+        queryset=ApprovalWorkflowDefinition.objects.all(),
+        to_field_name="name",
+    )
+    object_under_review_content_type = ContentTypeMultipleChoiceFilter(
+        choices=FeatureQuery("approval_workflows").get_choices,
+        label="Object types allowed to be associated with this Approval Workflow",
+    )
+
+    class Meta:
+        """Meta attributes for filter."""
+
+        model = ApprovalWorkflow
+        fields = "__all__"
+
+
+class ApprovalWorkflowStageFilterSet(BaseFilterSet):
+    """Filter for ApprovalWorkflowStage."""
+
+    q = SearchFilter(
+        filter_predicates={
+            "approval_workflow_stage_definition__name": "icontains",
+            "approval_workflow__approval_workflow_definition__name": "icontains",
+        }
+    )
+    decision_date = MultiValueDateTimeFilter()
+
+    pending_my_approvals = django_filters.BooleanFilter(
+        method="_pending_my_approvals", label="Filter by user's pending approvals (false returns completed approvals)"
+    )
+
+    class Meta:
+        """Meta attributes for filter."""
+
+        model = ApprovalWorkflowStage
+        fields = "__all__"
+
+    def _pending_my_approvals(self, queryset, name, value):
+        user = getattr(self.request, "user", None)
+        if not user:
+            return queryset
+        pending_qs = get_pending_approval_workflow_stages(user, queryset)
+        if value:
+            return pending_qs
+        else:
+            return queryset.filter(approval_workflow_stage_responses__user=user).exclude(
+                id__in=pending_qs.values_list("id", flat=True)
+            )
 
 
-@class_deprecated_in_favor_of(RelationshipModelFilterSetMixin)
-class RelationshipModelFilterSet(RelationshipModelFilterSetMixin):
-    pass
+class ApprovalWorkflowStageResponseFilterSet(BaseFilterSet):
+    """Filter for ApprovalWorkflowStageResponse."""
+
+    q = SearchFilter(
+        filter_predicates={
+            "comments": "icontains",
+            "state": "icontains",
+        }
+    )
+    user = NaturalKeyOrPKMultipleChoiceFilter(
+        queryset=get_user_model().objects.all(),
+        to_field_name="username",
+    )
+
+    class Meta:
+        """Meta attributes for filter."""
+
+        model = ApprovalWorkflowStageResponse
+        fields = "__all__"
 
 
 #
@@ -227,7 +364,7 @@ class ConfigContextFilterSet(BaseFilterSet):
         to_field_name="name",
         label="Schema (name or PK)",
     )
-    location_id = django_filters.ModelMultipleChoiceFilter(
+    location_id = ModelMultipleChoiceFilter(
         field_name="locations",
         queryset=Location.objects.all(),
         label="Location (ID) - Deprecated (use location filter)",
@@ -238,7 +375,7 @@ class ConfigContextFilterSet(BaseFilterSet):
         to_field_name="name",
         label="Location (name or ID)",
     )
-    device_type_id = django_filters.ModelMultipleChoiceFilter(
+    device_type_id = ModelMultipleChoiceFilter(
         field_name="device_types",
         queryset=DeviceType.objects.all(),
         label="Device Type (ID) - Deprecated (use device_type filter)",
@@ -249,7 +386,7 @@ class ConfigContextFilterSet(BaseFilterSet):
         to_field_name="model",
         label="Device Type (model or ID)",
     )
-    platform_id = django_filters.ModelMultipleChoiceFilter(
+    platform_id = ModelMultipleChoiceFilter(
         field_name="platforms",
         queryset=Platform.objects.all(),
         label="Platform (ID) - Deprecated (use platform filter)",
@@ -260,7 +397,7 @@ class ConfigContextFilterSet(BaseFilterSet):
         to_field_name="name",
         label="Platform (ID or name)",
     )
-    cluster_group_id = django_filters.ModelMultipleChoiceFilter(
+    cluster_group_id = ModelMultipleChoiceFilter(
         field_name="cluster_groups",
         queryset=ClusterGroup.objects.all(),
         label="Cluster group (ID) - Deprecated (use cluster_group filter)",
@@ -271,12 +408,12 @@ class ConfigContextFilterSet(BaseFilterSet):
         to_field_name="name",
         label="Cluster group (ID or name)",
     )
-    cluster_id = django_filters.ModelMultipleChoiceFilter(
+    cluster_id = ModelMultipleChoiceFilter(
         field_name="clusters",
         queryset=Cluster.objects.all(),
         label="Cluster (ID)",
     )
-    tenant_group_id = django_filters.ModelMultipleChoiceFilter(
+    tenant_group_id = ModelMultipleChoiceFilter(
         field_name="tenant_groups",
         queryset=TenantGroup.objects.all(),
         label="Tenant group (ID) - Deprecated (use tenant_group filter)",
@@ -287,7 +424,7 @@ class ConfigContextFilterSet(BaseFilterSet):
         label="Tenant group (ID or name)",
         to_field_name="name",
     )
-    tenant_id = django_filters.ModelMultipleChoiceFilter(
+    tenant_id = ModelMultipleChoiceFilter(
         field_name="tenants",
         queryset=Tenant.objects.all(),
         label="Tenant (ID) - Deprecated (use tenant filter)",
@@ -304,7 +441,7 @@ class ConfigContextFilterSet(BaseFilterSet):
         to_field_name="name",
         label="Device Redundancy Group (name or PK)",
     )
-    tag = django_filters.ModelMultipleChoiceFilter(
+    tag = ModelMultipleChoiceFilter(
         field_name="tags",
         queryset=Tag.objects.all(),
         to_field_name="name",
@@ -420,12 +557,6 @@ class ContentTypeFilterSet(BaseFilterSet):
         return queryset.filter(FeatureQuery(value).get_query())
 
 
-# TODO: remove in 2.2
-@class_deprecated_in_favor_of(CustomFieldModelFilterSetMixin)
-class CustomFieldModelFilterSet(CustomFieldModelFilterSetMixin):
-    pass
-
-
 class CustomFieldFilterSet(BaseFilterSet):
     q = SearchFilter(
         filter_predicates={
@@ -474,6 +605,33 @@ class NautobotFilterSet(
     """
 
 
+#
+# Approval Workflows
+#
+
+
+class ApprovalWorkflowDefinitionFilterSet(NautobotFilterSet):
+    """Filter for ApprovalWorkflowDefinition."""
+
+    q = SearchFilter(
+        filter_predicates={
+            "name": "icontains",
+            "model_content_type__app_label": "icontains",
+            "model_content_type__model": "icontains",
+        }
+    )
+    model_content_type = ContentTypeMultipleChoiceFilter(
+        choices=FeatureQuery("approval_workflows").get_choices,
+        label="Object types allowed to be associated with this Approval Workflow Definition",
+    )
+
+    class Meta:
+        """Meta attributes for filter."""
+
+        model = ApprovalWorkflowDefinition
+        fields = "__all__"
+
+
 #
 # Contacts
 #
@@ -608,7 +766,7 @@ class CustomLinkFilterSet(BaseFilterSet):
 #
 
 # Must be imported **after* NautobotFilterSet class is defined to avoid a circular import loop.
-from nautobot.tenancy.filters.mixins import TenancyModelFilterSetMixin  # noqa: E402
+from nautobot.tenancy.filter_mixins import TenancyModelFilterSetMixin  # noqa: E402
 
 
 class DynamicGroupFilterSet(TenancyModelFilterSetMixin, NautobotFilterSet):
@@ -784,7 +942,7 @@ class FileProxyFilterSet(BaseFilterSet):
         queryset=Job.objects.all(),
         label="Job (name or ID)",
     )
-    job_result_id = django_filters.ModelMultipleChoiceFilter(
+    job_result_id = ModelMultipleChoiceFilter(
         queryset=JobResult.objects.all(),
         label="Job Result (ID)",
     )
@@ -807,7 +965,7 @@ class GitRepositoryFilterSet(NautobotFilterSet):
             "branch": "icontains",
         },
     )
-    secrets_group_id = django_filters.ModelMultipleChoiceFilter(
+    secrets_group_id = ModelMultipleChoiceFilter(
         field_name="secrets_group",
         queryset=SecretsGroup.objects.all(),
         label="Secrets group (ID) - Deprecated (use secrets_group filter)",
@@ -885,7 +1043,6 @@ class JobFilterSet(BaseFilterSet, CustomFieldModelFilterSetMixin):
             "installed",
             "enabled",
             "has_sensitive_variables",
-            "approval_required",
             "dryrun_default",
             "hidden",
             "read_only",
@@ -896,7 +1053,6 @@ class JobFilterSet(BaseFilterSet, CustomFieldModelFilterSetMixin):
             "is_singleton",
             "grouping_override",
             "name_override",
-            "approval_required_override",
             "description_override",
             "dryrun_default_override",
             "hidden_override",
@@ -1000,7 +1156,7 @@ class JobResultFilterSet(BaseFilterSet, CustomFieldModelFilterSetMixin):
         queryset=Job.objects.all(),
         label="Job (name or ID)",
     )
-    job_model_id = django_filters.ModelMultipleChoiceFilter(
+    job_model_id = ModelMultipleChoiceFilter(
         queryset=Job.objects.all(),
         label="Job (ID) - Deprecated (use job_model filter)",
     )
@@ -1043,7 +1199,7 @@ class ScheduledJobFilterSet(BaseFilterSet):
         queryset=Job.objects.all(),
         label="Job (name or ID)",
     )
-    job_model_id = django_filters.ModelMultipleChoiceFilter(
+    job_model_id = ModelMultipleChoiceFilter(
         queryset=Job.objects.all(),
         label="Job (ID) - Deprecated (use job_model filter)",
     )
@@ -1093,17 +1249,6 @@ class JobButtonFilterSet(BaseFilterSet):
         )
 
 
-#
-# Filter for Local Config Context Data
-#
-
-
-# TODO: remove in 2.2
-@class_deprecated_in_favor_of(LocalContextModelFilterSetMixin)
-class LocalContextFilterSet(LocalContextModelFilterSetMixin):
-    pass
-
-
 #
 # Metadata
 #
@@ -1224,7 +1369,7 @@ class ObjectChangeFilterSet(BaseFilterSet):
         },
     )
     changed_object_type = ContentTypeFilter()
-    user_id = django_filters.ModelMultipleChoiceFilter(
+    user_id = ModelMultipleChoiceFilter(
         queryset=get_user_model().objects.all(),
         label="User (ID) - Deprecated (use user filter)",
     )
@@ -1280,7 +1425,7 @@ class RelationshipAssociationFilterSet(BaseFilterSet):
         }
     )
 
-    relationship = django_filters.ModelMultipleChoiceFilter(
+    relationship = ModelMultipleChoiceFilter(
         field_name="relationship__key",
         queryset=Relationship.objects.all(),
         to_field_name="key",
@@ -1373,7 +1518,7 @@ class SecretsGroupAssociationFilterSet(BaseFilterSet):
         label="Secrets Group (ID or name)",
         to_field_name="name",
     )
-    secret_id = django_filters.ModelMultipleChoiceFilter(
+    secret_id = ModelMultipleChoiceFilter(
         queryset=Secret.objects.all(),
         label="Secret (ID) - Deprecated (use secret filter)",
     )

nautobot/extras/forms/base.py

@@ -1,4 +1,5 @@
 from nautobot.core.forms import BootstrapMixin
+from nautobot.data_validation.form_mixin import DataValidationModelFormMixin
 
 from .mixins import (
     ContactTeamModelFilterFormMixin,
@@ -19,7 +20,6 @@ __all__ = (
     "NautobotModelForm",
 )
 
-
 #
 # Nautobot base forms for use in most new custom model forms.
 #
@@ -28,6 +28,7 @@ __all__ = (
 class NautobotModelForm(
     BootstrapMixin,
     # The below must be listed *after* BootstrapMixin so that BootstrapMixin applies to their dynamic form fields
+    DataValidationModelFormMixin,
     CustomFieldModelFormMixin,
     DynamicGroupModelFormMixin,
     NoteModelFormMixin,