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

nautobot/extras/models/mixins.py

@@ -3,11 +3,111 @@ Class-modifying mixins that need to be standalone to avoid circular imports.
 """
 
 from django.contrib.contenttypes.fields import GenericRelation
+from django.contrib.contenttypes.models import ContentType
 from django.db import models
 from django.urls import NoReverseMatch, reverse
 
 from nautobot.core.utils.deprecation import method_deprecated_in_favor_of
-from nautobot.core.utils.lookup import get_route_for_model
+from nautobot.core.utils.lookup import get_route_for_model, get_user_from_instance
+from nautobot.extras.choices import ApprovalWorkflowStateChoices
+
+
+class ApprovableModelMixin(models.Model):
+    """Abstract mixin for enabling Approval Flow functionality to a given model class."""
+
+    class Meta:
+        abstract = True
+
+    is_approval_workflow_model = True
+
+    # Reverse relation so that deleting a ApprovableModelMixin automatically deletes any approval workflows related to it.
+
+    associated_approval_workflows = GenericRelation(
+        "extras.ApprovalWorkflow",
+        content_type_field="object_under_review_content_type",
+        object_id_field="object_under_review_object_id",
+        related_query_name="associated_approval_workflows_%(app_label)s_%(class)s",  # e.g. 'associated_object_approval_workflows_dcim_device'
+    )
+
+    def get_approval_workflow_url(self):
+        """Return the approval workflow URL for this object."""
+        route = get_route_for_model(self, "approvalworkflow")
+
+        # Iterate the pk-like fields and try to get a URL, or return None.
+        fields = ["pk", "slug"]
+        for field in fields:
+            if not hasattr(self, field):
+                continue
+
+            try:
+                return reverse(route, kwargs={field: getattr(self, field)})
+            except NoReverseMatch:
+                continue
+
+        return None
+
+    def begin_approval_workflow(self):
+        """Find and start the appropriate approval workflow for this object."""
+        from nautobot.extras.models.approvals import (
+            ApprovalWorkflow,
+            ApprovalWorkflowDefinition,
+            ApprovalWorkflowStage,
+            ApprovalWorkflowStageDefinition,
+        )  # because of circular import
+
+        # First check if there's already a pending workflow instance
+        if self.associated_approval_workflows.filter(current_state=ApprovalWorkflowStateChoices.PENDING).exists():
+            return self.associated_approval_workflows.filter(current_state=ApprovalWorkflowStateChoices.PENDING).first()
+
+        # Check if there's a relevant workflow definition
+        workflow_definition = ApprovalWorkflowDefinition.objects.find_for_model(self)
+        if not workflow_definition:
+            return None
+
+        approval_workflow = ApprovalWorkflow.objects.create(
+            approval_workflow_definition=workflow_definition,
+            object_under_review_content_type=ContentType.objects.get_for_model(self),
+            object_under_review_object_id=self.pk,
+            current_state=ApprovalWorkflowStateChoices.PENDING,
+            user=get_user_from_instance(self),
+        )
+
+        # Create workflow stages if the definition has any
+        approval_workflow_stage_definitions = ApprovalWorkflowStageDefinition.objects.filter(
+            approval_workflow_definition=workflow_definition
+        )
+
+        ApprovalWorkflowStage.objects.bulk_create(
+            [
+                ApprovalWorkflowStage(
+                    approval_workflow=approval_workflow,
+                    approval_workflow_stage_definition=definition,
+                    state=ApprovalWorkflowStateChoices.PENDING,
+                )
+                for definition in approval_workflow_stage_definitions
+            ]
+        )
+
+        self.on_workflow_initiated(approval_workflow)
+
+        return approval_workflow
+
+    def on_workflow_initiated(self, approval_workflow):
+        """Called when an approval workflow is initiated."""
+        raise NotImplementedError("Subclasses must implement `on_workflow_initiated`.")
+
+    def on_workflow_approved(self, approval_workflow):
+        """Called when an approval workflow is approved."""
+        raise NotImplementedError("Subclasses must implement `on_workflow_approved`.")
+
+    def on_workflow_denied(self, approval_workflow):
+        """Called when an approval workflow is denied."""
+        raise NotImplementedError("Subclasses must implement `on_workflow_denied`.")
+
+    def has_approval_workflow_definition(self) -> bool:
+        from nautobot.extras.models.approvals import ApprovalWorkflowDefinition
+
+        return ApprovalWorkflowDefinition.objects.find_for_model(self) is not None
 
 
 class ContactMixin(models.Model):
@@ -151,3 +251,31 @@ class SavedViewMixin(models.Model):
         abstract = True
 
     is_saved_view_model = True
+
+
+class DataComplianceModelMixin:
+    """
+    Adds a `get_data_compliance_url` that can be applied to instances.
+    """
+
+    is_data_compliance_model = True
+
+    def get_data_compliance_url(self, api=False):
+        """Return the data compliance URL for a given instance."""
+        # If is_data_compliance_model overridden should allow to opt out
+        if not self.is_data_compliance_model:
+            return None
+        route = get_route_for_model(self, "data-compliance", api=api)
+
+        # Iterate the pk-like fields and try to get a URL, or return None.
+        fields = ["pk", "slug"]
+        for field in fields:
+            if not hasattr(self, field):
+                continue
+
+            try:
+                return reverse(route, kwargs={field: getattr(self, field)})
+            except NoReverseMatch:
+                continue
+
+        return None

nautobot/extras/models/models.py

@@ -13,10 +13,9 @@ from django.core.serializers.json import DjangoJSONEncoder
 from django.core.validators import MinValueValidator
 from django.db import models
 from django.http import HttpResponse
-from graphene_django.settings import graphene_settings
-from graphql import get_default_backend
+from graphql import IntValueNode, parse, StringValueNode
 from graphql.error import GraphQLSyntaxError
-from graphql.language.ast import OperationDefinition
+from graphql.language.ast import ExecutableDefinitionNode
 from jsonschema.exceptions import SchemaError, ValidationError as JSONSchemaValidationError
 from jsonschema.validators import Draft7Validator
 from rest_framework.utils.encoders import JSONEncoder
@@ -354,6 +353,14 @@ class CustomLink(
     )
     new_window = models.BooleanField(help_text="Force link to open in a new window")
 
+    is_data_compliance_model = False
+
+    @property
+    def button_class_css_class(self):
+        if self.button_class == ButtonClassChoices.CLASS_DEFAULT:
+            return "secondary"
+        return self.button_class
+
     class Meta:
         ordering = ["group_name", "weight", "name"]
 
@@ -578,6 +585,7 @@ class FileAttachment(BaseModel):
     mimetype = models.CharField(max_length=CHARFIELD_MAX_LENGTH)
 
     is_metadata_associable_model = False
+    is_data_compliance_model = False
 
     natural_key_field_names = ["pk"]
 
@@ -639,6 +647,8 @@ class FileProxy(BaseModel):
     uploaded_at = models.DateTimeField(auto_now_add=True)
     job_result = models.ForeignKey(to=JobResult, null=True, blank=True, on_delete=models.CASCADE, related_name="files")
 
+    is_data_compliance_model = False
+
     def __str__(self):
         return self.name
 
@@ -708,22 +718,20 @@ class GraphQLQuery(
 
     def save(self, *args, **kwargs):
         variables = {}
-        schema = graphene_settings.SCHEMA
-        backend = get_default_backend()
-        # Load query into GraphQL backend
-        document = backend.document_from_string(schema, self.query)
+        document = parse(self.query)
 
         # Inspect the parsed document tree (document.document_ast) to retrieve the query (operation) definition(s)
         # that define one or more variables. For each operation and variable definition, store the variable's
         # default value (if any) into our own "variables" dict.
         definitions = [
-            d
-            for d in document.document_ast.definitions
-            if isinstance(d, OperationDefinition) and d.variable_definitions
+            d for d in document.definitions if isinstance(d, ExecutableDefinitionNode) and d.variable_definitions
         ]
         for definition in definitions:
             for variable_definition in definition.variable_definitions:
-                default = variable_definition.default_value.value if variable_definition.default_value else ""
+                if isinstance(variable_definition.default_value, (StringValueNode, IntValueNode)):
+                    default = variable_definition.default_value.value
+                else:
+                    default = ""
                 variables[variable_definition.variable.name.value] = default
 
         self.variables = variables
@@ -731,10 +739,8 @@ class GraphQLQuery(
 
     def clean(self):
         super().clean()
-        schema = graphene_settings.SCHEMA
-        backend = get_default_backend()
         try:
-            backend.document_from_string(schema, self.query)
+            parse(self.query)
         except GraphQLSyntaxError as error:
             raise ValidationError({"query": error})
 
@@ -882,6 +888,7 @@ class SavedView(BaseModel, ChangeLoggedModel):
     is_shared = models.BooleanField(default=True)
 
     documentation_static_path = "docs/user-guide/platform-functionality/savedview.html"
+    is_data_compliance_model = False
 
     class Meta:
         ordering = ["owner", "view", "name"]
@@ -910,6 +917,7 @@ class UserSavedViewAssociation(BaseModel):
     user = models.ForeignKey("users.User", on_delete=models.CASCADE, related_name="saved_view_assignments")
     view_name = models.CharField(max_length=CHARFIELD_MAX_LENGTH)
     is_metadata_associable_model = False
+    is_data_compliance_model = False
 
     class Meta:
         unique_together = [["user", "view_name"]]

nautobot/extras/models/relationships.py

@@ -23,6 +23,7 @@ from nautobot.core.models import BaseManager, BaseModel
 from nautobot.core.models.fields import AutoSlugField, slugify_dashes_to_underscores
 from nautobot.core.models.querysets import RestrictedQuerySet
 from nautobot.core.templatetags.helpers import bettertitle
+from nautobot.core.utils.cache import construct_cache_key
 from nautobot.core.utils.lookup import get_filterset_for_model, get_route_for_model
 from nautobot.extras.choices import RelationshipRequiredSideChoices, RelationshipSideChoices, RelationshipTypeChoices
 from nautobot.extras.models import ChangeLoggedModel
@@ -449,8 +450,21 @@ class RelationshipManager(BaseManager.from_queryset(RestrictedQuerySet)):
             get_queryset (bool): Whether to return a queryset or an object list.
         """
         concrete_model = model._meta.concrete_model
-        cache_key = f"{self.get_for_model_source.cache_key_prefix}.{concrete_model._meta.label_lower}.{hidden}"
-        list_cache_key = f"{cache_key}.list"
+        cache_key = construct_cache_key(
+            self,
+            method_name="get_for_model_source",
+            branch_aware=True,
+            model=concrete_model._meta.label_lower,
+            hidden=hidden,
+        )
+        list_cache_key = construct_cache_key(
+            self,
+            method_name="get_for_model_source",
+            branch_aware=True,
+            model=concrete_model._meta.label_lower,
+            hidden=hidden,
+            listing=True,
+        )
         if not get_queryset:
             listing = cache.get(list_cache_key)
             if listing is not None:
@@ -470,8 +484,6 @@ class RelationshipManager(BaseManager.from_queryset(RestrictedQuerySet)):
             return listing
         return queryset
 
-    get_for_model_source.cache_key_prefix = "nautobot.extras.relationship.get_for_model_source"
-
     def get_for_model_destination(self, model, hidden=None, get_queryset=True):
         """
         Return all Relationships assigned to the given model for the destination side only.
@@ -482,8 +494,21 @@ class RelationshipManager(BaseManager.from_queryset(RestrictedQuerySet)):
             get_queryset (bool): Whether to return a queryset or an object list.
         """
         concrete_model = model._meta.concrete_model
-        cache_key = f"{self.get_for_model_destination.cache_key_prefix}.{concrete_model._meta.label_lower}.{hidden}"
-        list_cache_key = f"{cache_key}.list"
+        cache_key = construct_cache_key(
+            self,
+            method_name="get_for_model_destination",
+            branch_aware=True,
+            model=concrete_model._meta.label_lower,
+            hidden=hidden,
+        )
+        list_cache_key = construct_cache_key(
+            self,
+            method_name="get_for_model_destination",
+            branch_aware=True,
+            model=concrete_model._meta.label_lower,
+            hidden=hidden,
+            listing=True,
+        )
         if not get_queryset:
             listing = cache.get(list_cache_key)
             if listing is not None:
@@ -505,8 +530,6 @@ class RelationshipManager(BaseManager.from_queryset(RestrictedQuerySet)):
             return listing
         return queryset
 
-    get_for_model_destination.cache_key_prefix = "nautobot.extras.relationship.get_for_model_destination"
-
     def get_required_for_model(self, model):
         """
         Return a queryset with all required Relationships on the given model.
@@ -536,11 +559,25 @@ class RelationshipManager(BaseManager.from_queryset(RestrictedQuerySet)):
             label = f"{ct.app_label}.{ct.model}"
             for hidden in ["None", "True", "False"]:
                 cache.set(
-                    f"{self.get_for_model_source.cache_key_prefix}.{label}.{hidden}.list",
+                    construct_cache_key(
+                        self,
+                        method_name="get_for_model_source",
+                        branch_aware=True,
+                        model=label,
+                        hidden=hidden,
+                        listing=True,
+                    ),
                     listings["source"][label][hidden],
                 )
                 cache.set(
-                    f"{self.get_for_model_destination.cache_key_prefix}.{label}.{hidden}.list",
+                    construct_cache_key(
+                        self,
+                        method_name="get_for_model_destination",
+                        branch_aware=True,
+                        model=label,
+                        hidden=hidden,
+                        listing=True,
+                    ),
                     listings["destination"][label][hidden],
                 )
 

nautobot/extras/models/secrets.py

@@ -141,6 +141,7 @@ class SecretsGroupAssociation(BaseModel):
     natural_key_field_names = ["secrets_group", "access_type", "secret_type", "secret"]
 
     documentation_static_path = "docs/user-guide/platform-functionality/secret.html"
+    is_data_compliance_model = False
 
     class Meta:
         unique_together = (

nautobot/extras/models/statuses.py

@@ -7,7 +7,6 @@ from django.utils.hashable import make_hashable
 
 from nautobot.core.models.fields import ForeignKeyLimitedByContentTypes
 from nautobot.core.models.name_color_content_types import NameColorContentTypesModel
-from nautobot.core.utils.deprecation import class_deprecated
 from nautobot.extras.utils import extras_features, FeatureQuery
 
 
@@ -98,17 +97,3 @@ class StatusField(ForeignKeyLimitedByContentTypes):
                 f"get_{self.name}_color",
                 partialmethod(_get_FIELD_color, field=self),
             )
-
-
-@class_deprecated(message="please directly declare `status = StatusField(...)` on your model instead")
-class StatusModel(models.Model):
-    """
-    Deprecated abstract base class for any model which may have statuses.
-
-    Just directly include a StatusField instead for any new models.
-    """
-
-    status = StatusField(null=True)  # for backward compatibility
-
-    class Meta:
-        abstract = True

nautobot/extras/models/tags.py

@@ -67,7 +67,7 @@ class Tag(
         ordering = ["name"]
 
     def get_color_display(self):
-        return format_html('<span class="label color-block" style="background-color: #{}">&nbsp;</span>', self.color)
+        return format_html('<span class="label nb-color-block" style="background-color: #{}">&nbsp;</span>', self.color)
 
     def validate_content_types_removal(self, content_types_id):
         """Validate content_types to be removed are not tagged to a model"""

nautobot/extras/navigation.py

@@ -4,11 +4,44 @@ from nautobot.core.apps import (
     NavMenuItem,
     NavMenuTab,
 )
+from nautobot.core.ui.choices import NavigationIconChoices, NavigationWeightChoices
 
 menu_items = (
+    NavMenuTab(
+        name="Approvals",
+        icon=NavigationIconChoices.APPROVAL_WORKFLOWS,
+        weight=NavigationWeightChoices.APPROVAL_WORKFLOWS,
+        groups=(
+            NavMenuGroup(
+                name="Approval Workflows",
+                weight=50,
+                items=(
+                    NavMenuItem(
+                        link="extras:approvalworkflowdefinition_list",
+                        name="Workflow Definitions",
+                        weight=100,
+                        permissions=["extras.view_approvalworkflowdefinition"],
+                        buttons=(
+                            NavMenuAddButton(
+                                link="extras:approvalworkflowdefinition_add",
+                                permissions=["extras.add_approvalworkflowdefinition"],
+                            ),
+                        ),
+                    ),
+                    NavMenuItem(
+                        link="extras:approver_dashboard",
+                        name="Approval Dashboard",
+                        weight=200,
+                        permissions=["extras.view_approvalworkflow"],
+                    ),
+                ),
+            ),
+        ),
+    ),
     NavMenuTab(
         name="Organization",
-        weight=100,
+        icon=NavigationIconChoices.ORGANIZATION,
+        weight=NavigationWeightChoices.ORGANIZATION,
         groups=(
             NavMenuGroup(
                 name="Contacts",
@@ -110,7 +143,8 @@ menu_items = (
     ),
     NavMenuTab(
         name="Secrets",
-        weight=700,
+        icon=NavigationIconChoices.SECRETS,
+        weight=NavigationWeightChoices.SECRETS,
         groups=(
             NavMenuGroup(
                 name="Secrets",
@@ -138,7 +172,8 @@ menu_items = (
     ),
     NavMenuTab(
         name="Jobs",
-        weight=800,
+        icon=NavigationIconChoices.JOBS,
+        weight=NavigationWeightChoices.JOBS,
         groups=(
             NavMenuGroup(
                 name="Jobs",
@@ -153,16 +188,6 @@ menu_items = (
                         ],
                         buttons=(),
                     ),
-                    NavMenuItem(
-                        link="extras:scheduledjob_approval_queue_list",
-                        name="Job Approval Queue",
-                        weight=200,
-                        permissions=[
-                            "extras.view_job",
-                            "extras.view_scheduledjob",
-                        ],
-                        buttons=(),
-                    ),
                     NavMenuItem(
                         link="extras:scheduledjob_list",
                         name="Scheduled Jobs",
@@ -236,7 +261,8 @@ menu_items = (
     ),
     NavMenuTab(
         name="Extensibility",
-        weight=900,
+        icon=NavigationIconChoices.EXTENSIBILITY,
+        weight=NavigationWeightChoices.EXTENSIBILITY,
         groups=(
             NavMenuGroup(
                 name="Logging",
@@ -510,7 +536,8 @@ menu_items = (
     ),
     NavMenuTab(
         name="Apps",
-        weight=5000,
+        icon=NavigationIconChoices.APPS,
+        weight=NavigationWeightChoices.APPS,
         groups=(
             NavMenuGroup(
                 name="General",