nautobot 3.0.0a2__py3-none-any.whl → 3.0.0a3__py3-none-any.whl

nautobot/extras/models/approvals.py

@@ -28,8 +28,8 @@ class ApprovalWorkflowDefinitionManager(BaseManager.from_queryset(RestrictedQuer
         """
         content_type = ContentType.objects.get_for_model(model_instance)
 
-        # Get all workflow definitions for this content type, ordered by priority (lowest first = highest priority)
-        workflow_definitions = self.get_queryset().filter(model_content_type=content_type).order_by("priority")
+        # Get all workflow definitions for this content type, ordered by weight (highest wins)
+        workflow_definitions = self.get_queryset().filter(model_content_type=content_type).order_by("-weight")
 
         for workflow_definition in workflow_definitions:
             if not workflow_definition.model_constraints:
@@ -77,11 +77,12 @@ class ApprovalWorkflowDefinition(PrimaryModel):
         default=dict,
         help_text="Constraints to filter the objects that can be approved using this workflow.",
     )
-    priority = models.IntegerField(
-        default=0, help_text="Determines workflow relevance when multiple apply. Lower values indicate higher priority."
+    weight = models.IntegerField(
+        default=0, help_text="Determines workflow relevance when multiple apply. Higher weight wins."
     )
     documentation_static_path = "docs/user-guide/platform-functionality/approval-workflow.html"
     is_dynamic_group_associable = False
+    is_data_compliance_model = False
     objects = ApprovalWorkflowDefinitionManager()
     is_version_controlled = False
 
@@ -90,7 +91,7 @@ class ApprovalWorkflowDefinition(PrimaryModel):
 
         verbose_name = "Approval Workflow Definition"
         ordering = ["name"]
-        unique_together = [["model_content_type", "priority"]]
+        unique_together = [["model_content_type", "weight"]]
 
     def __str__(self):
         """Stringify instance."""
@@ -114,12 +115,13 @@ class ApprovalWorkflowStageDefinition(OrganizationalModel):
         on_delete=models.CASCADE,
         help_text="Approval workflow definition to which this stage belongs.",
     )
-    weight = models.PositiveIntegerField(
-        help_text="The weight dictates the order in which this stage will need to be approved. The lower the number, the earlier it will be.",
+    sequence = models.PositiveIntegerField(
+        help_text="The sequence dictates the order in which this stage will need to be approved. The lower the number, the earlier it will be.",
     )
     name = models.CharField(max_length=CHARFIELD_MAX_LENGTH)
     min_approvers = models.PositiveIntegerField(
-        help_text="Number of minimum approvers required to approve this stage.",
+        verbose_name="Minimum approvers",
+        help_text="Minimum number of approvers required to approve this stage.",
     )
     denial_message = models.CharField(
         max_length=CHARFIELD_MAX_LENGTH, blank=True, help_text="Message to show when the stage is denied."
@@ -128,18 +130,20 @@ class ApprovalWorkflowStageDefinition(OrganizationalModel):
         to=Group,
         related_name="approval_workflow_stage_definitions",
         verbose_name="Group",
-        help_text="Group of users who are eligible to approve this stage.",
+        help_text="Group of users who are eligible to approve this stage. Only admin users can create new groups.",
         on_delete=models.PROTECT,
     )
     documentation_static_path = "docs/user-guide/platform-functionality/approval-workflow.html"
     is_version_controlled = False
 
+    is_data_compliance_model = False
+
     class Meta:
         """Meta class for ApprovalWorkflowStage."""
 
         verbose_name = "Approval Workflow Stage Definition"
-        unique_together = [["approval_workflow_definition", "name"], ["approval_workflow_definition", "weight"]]
-        ordering = ["approval_workflow_definition", "weight"]
+        unique_together = [["approval_workflow_definition", "name"], ["approval_workflow_definition", "sequence"]]
+        ordering = ["approval_workflow_definition", "sequence"]
 
     def __str__(self):
         """Stringify instance."""
@@ -195,6 +199,7 @@ class ApprovalWorkflow(OrganizationalModel):
     user_name = models.CharField(max_length=150, editable=False, db_index=True)
     documentation_static_path = "docs/user-guide/platform-functionality/approval-workflow.html"
 
+    is_data_compliance_model = False
     is_version_controlled = False
 
     class Meta:
@@ -225,7 +230,7 @@ class ApprovalWorkflow(OrganizationalModel):
         """
         first_nonapproved_stage = (
             self.approval_workflow_stages.exclude(state=ApprovalWorkflowStateChoices.APPROVED)
-            .order_by("approval_workflow_stage_definition__weight")
+            .order_by("approval_workflow_stage_definition__sequence")
             .first()
         )
         return first_nonapproved_stage
@@ -317,12 +322,14 @@ class ApprovalWorkflowStage(OrganizationalModel):
     documentation_static_path = "docs/user-guide/platform-functionality/approval-workflow.html"
     is_version_controlled = False
 
+    is_data_compliance_model = False
+
     class Meta:
         """Meta class for ApprovalWorkflowStage."""
 
         verbose_name = "Approval Workflow Stage"
         unique_together = [["approval_workflow", "approval_workflow_stage_definition"]]
-        ordering = ["approval_workflow", "approval_workflow_stage_definition__weight"]
+        ordering = ["approval_workflow", "approval_workflow_stage_definition__sequence"]
 
     def __str__(self):
         """Stringify instance."""
@@ -506,6 +513,8 @@ class ApprovalWorkflowStageResponse(BaseModel):
     documentation_static_path = "docs/user-guide/platform-functionality/approval-workflow.html"
     is_version_controlled = False
 
+    is_data_compliance_model = False
+
     class Meta:
         """Meta class for ApprovalWorkflowStageResponse."""
 

nautobot/extras/models/contacts.py

@@ -20,6 +20,7 @@ class ContactTeamSharedBase(PrimaryModel):
 
     comments = models.TextField(blank=True)
     is_contact_associable_model = False
+    is_data_compliance_model = False
 
     class Meta:
         abstract = True
@@ -94,6 +95,7 @@ class ContactAssociation(OrganizationalModel):
     is_contact_associable_model = False
     is_dynamic_group_associable_model = False
     is_saved_view_model = False
+    is_data_compliance_model = False
 
     class Meta:
         unique_together = (

nautobot/extras/models/groups.py

@@ -76,6 +76,7 @@ class DynamicGroup(PrimaryModel):
 
     objects = BaseManager.from_queryset(DynamicGroupQuerySet)()
     is_dynamic_group_associable_model = False
+    is_data_compliance_model = False
 
     clone_fields = ["content_type", "group_type", "filter", "tenant"]
 
@@ -628,6 +629,10 @@ class DynamicGroup(PrimaryModel):
         else:
             # Validate against the filterset's internal form validation.
             filterset = self.filterset_class(self.filter)  # pylint: disable=not-callable
+            # TODO: the below is more generous than one might expect. For example, passing a list of strings ["foo"]
+            # to a (single-input) CharFilter will quietly normalize the list to a string '["foo"]' instead of reporting
+            # any failure of is_valid(). We've had cases of such "should be invalid but isn't caught" DynamicGroups causing
+            # exceptions when trying to evaluate their membership; it would be good to be stricter here instead!
             if not filterset.is_valid():
                 raise ValidationError(filterset.errors)
 
@@ -661,6 +666,22 @@ class DynamicGroup(PrimaryModel):
 
             # TODO limit most changes to self.group_type as well.
 
+    def save(self, *args, update_cached_members=True, **kwargs):
+        """
+        Save the DynamicGroup record.
+
+        Args:
+            update_cached_members (bool): If True, (re)calculate the cached members set of the related group(s) immediately.
+                Note that this is potentially quite expensive if there will be a large change in the members set!
+                If False (recommended), you can call `self.update_cached_members()` explicitly when ready.
+        """
+        super().save(*args, **kwargs)
+
+        if update_cached_members:
+            self.update_cached_members()
+            for ancestor in self.get_ancestors():
+                ancestor.update_cached_members()
+
     def _generate_query_for_filter(self, filter_field, value):
         """
         Return a `Q` object generated from a `filter_field` and `value`.
@@ -703,9 +724,12 @@ class DynamicGroup(PrimaryModel):
             # "ams02"]}`, the value being a list of location names (`["ams01", "ams02"]`).
             if value and isinstance(value, list) and isinstance(value[0], str) and not is_uuid(value[0]):
                 model_field = django_filters.utils.get_model_field(self._model, filter_field.field_name)
-                related_model = model_field.related_model
-                lookup_kwargs = {f"{to_field_name}__in": value}
-                gq_value = related_model.objects.filter(**lookup_kwargs)
+                if model_field is None:
+                    gq_value = value
+                else:
+                    related_model = model_field.related_model
+                    lookup_kwargs = {f"{to_field_name}__in": value}
+                    gq_value = related_model.objects.filter(**lookup_kwargs)
             else:
                 gq_value = value
             query |= filter_field.generate_query(gq_value)
@@ -1172,12 +1196,26 @@ class DynamicGroupMembership(BaseModel):
         if self.group in self.parent_group.get_ancestors():
             raise ValidationError({"group": "Cannot add ancestor as a child"})
 
-    def save(self, *args, **kwargs):
+    def save(self, *args, update_cached_members=True, **kwargs):
+        """
+        Save the DynamicGroupMembership record.
+
+        Args:
+            update_cached_members (bool): If True, (re)calculate the cached members set of the related group(s) immediately.
+                Note that this is potentially quite expensive if there will be a large change in the members set!
+                If False (recommended), you can call `self.parent_group.update_cached_members()` explicitly when ready.
+        """
         # For backwards compatibility
         if self.parent_group.group_type == DynamicGroupTypeChoices.TYPE_DYNAMIC_FILTER and not self.parent_group.filter:
             self.parent_group.group_type = DynamicGroupTypeChoices.TYPE_DYNAMIC_SET
             self.parent_group.save()
-        return super().save(*args, **kwargs)
+
+        super().save(*args, **kwargs)
+
+        if update_cached_members:
+            self.parent_group.update_cached_members()
+            for ancestor in self.parent_group.get_ancestors():
+                ancestor.update_cached_members()
 
 
 class StaticGroupAssociationManager(BaseManager.from_queryset(RestrictedQuerySet)):
@@ -1218,6 +1256,7 @@ class StaticGroupAssociation(OrganizationalModel):
     is_contact_associable_model = False
     is_dynamic_group_associable_model = False
     is_saved_view_model = False
+    is_data_compliance_model = False
 
     class Meta:
         unique_together = [["dynamic_group", "associated_object_type", "associated_object_id"]]

nautobot/extras/models/jobs.py

@@ -15,7 +15,7 @@ from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ValidationError
 from django.core.validators import MinValueValidator
 from django.db import models, transaction
-from django.db.models import ProtectedError, signals
+from django.db.models import Count, ProtectedError, Q, signals
 from django.utils import timezone
 from django.utils.functional import cached_property
 from django_celery_beat.clockedschedule import clocked
@@ -252,6 +252,7 @@ class Job(PrimaryModel):
         help_text="If set, the configured value will remain even if the underlying Job source code changes",
     )
     objects = BaseManager.from_queryset(JobQuerySet)()
+    is_data_compliance_model = False
 
     documentation_static_path = "docs/user-guide/platform-functionality/jobs/models.html"
 
@@ -439,6 +440,8 @@ class JobHook(OrganizationalModel):
     type_delete = models.BooleanField(default=False, help_text="Call this job hook when a matching object is deleted.")
     type_update = models.BooleanField(default=False, help_text="Call this job hook when a matching object is updated.")
 
+    is_data_compliance_model = False
+
     documentation_static_path = "docs/user-guide/platform-functionality/jobs/jobhook.html"
 
     class Meta:
@@ -529,6 +532,7 @@ class JobLogEntry(BaseModel):
     absolute_url = models.CharField(max_length=JOB_LOG_MAX_ABSOLUTE_URL_LENGTH, blank=True, default="")
 
     is_metadata_associable_model = False
+    is_data_compliance_model = False
 
     documentation_static_path = "docs/user-guide/platform-functionality/jobs/models.html"
     hide_in_diff_view = True
@@ -580,6 +584,7 @@ class JobQueue(PrimaryModel):
     )
 
     documentation_static_path = "docs/user-guide/platform-functionality/jobs/jobqueue.html"
+    is_data_compliance_model = False
 
     class Meta:
         ordering = ["name"]
@@ -610,6 +615,7 @@ class JobQueueAssignment(BaseModel):
     job = models.ForeignKey(Job, on_delete=models.CASCADE, related_name="job_queue_assignments")
     job_queue = models.ForeignKey(JobQueue, on_delete=models.CASCADE, related_name="job_assignments")
     is_metadata_associable_model = False
+    is_data_compliance_model = False
 
     class Meta:
         unique_together = ["job", "job_queue"]
@@ -678,11 +684,17 @@ class JobResult(SavedViewMixin, BaseModel, CustomFieldModel):
     traceback = models.TextField(blank=True, null=True)  # noqa: DJ001  # django-nullable-model-string-field -- TODO: can we remove null=True?
     meta = models.JSONField(null=True, default=None, editable=False)
     scheduled_job = models.ForeignKey(to="extras.ScheduledJob", on_delete=models.SET_NULL, null=True, blank=True)
+    debug_log_count = models.PositiveIntegerField(blank=True, null=True, editable=False)
+    success_log_count = models.PositiveIntegerField(blank=True, null=True, editable=False)
+    info_log_count = models.PositiveIntegerField(blank=True, null=True, editable=False)
+    warning_log_count = models.PositiveIntegerField(blank=True, null=True, editable=False)
+    error_log_count = models.PositiveIntegerField(blank=True, null=True, editable=False)
 
     objects = JobResultManager()
 
     documentation_static_path = "docs/user-guide/platform-functionality/jobs/models.html"
     hide_in_diff_view = True
+    is_data_compliance_model = False
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -762,6 +774,30 @@ class JobResult(SavedViewMixin, BaseModel, CustomFieldModel):
 
     set_status.alters_data = True
 
+    def count_logs_by_level(self):
+        """Helper method to count JobLogEntries after a Job is run, or update these values when missing or changed."""
+        db_log_counts = self.job_log_entries.aggregate(
+            debug_log_count=Count("pk", filter=Q(log_level=LogLevelChoices.LOG_DEBUG)),
+            success_log_count=Count("pk", filter=Q(log_level=LogLevelChoices.LOG_SUCCESS)),
+            info_log_count=Count("pk", filter=Q(log_level=LogLevelChoices.LOG_INFO)),
+            warning_log_count=Count("pk", filter=Q(log_level=LogLevelChoices.LOG_WARNING)),
+            error_log_count=Count(
+                "pk",
+                filter=Q(
+                    log_level__in=[
+                        LogLevelChoices.LOG_FAILURE,
+                        LogLevelChoices.LOG_ERROR,
+                        LogLevelChoices.LOG_CRITICAL,
+                    ]
+                ),
+            ),
+        )
+        self.debug_log_count = db_log_counts["debug_log_count"]
+        self.success_log_count = db_log_counts["success_log_count"]
+        self.info_log_count = db_log_counts["info_log_count"]
+        self.warning_log_count = db_log_counts["warning_log_count"]
+        self.error_log_count = db_log_counts["error_log_count"]
+
     @classmethod
     def execute_job(cls, *args, **kwargs):
         """
@@ -1006,6 +1042,18 @@ class JobResult(SavedViewMixin, BaseModel, CustomFieldModel):
 
     log.alters_data = True
 
+    def save(self, *args, **kwargs):
+        """When a JobResult is saved and in a terminal state, store missing log counts for summary."""
+        if self.status in JobResultStatusChoices.READY_STATES and None in [
+            self.debug_log_count,
+            self.info_log_count,
+            self.success_log_count,
+            self.warning_log_count,
+            self.error_log_count,
+        ]:
+            self.count_logs_by_level()
+        super().save(*args, **kwargs)
+
 
 #
 # Job Button
@@ -1055,10 +1103,18 @@ class JobButton(ContactMixin, ChangeLoggedModel, DynamicGroupsModelMixin, NotesM
     )
 
     documentation_static_path = "docs/user-guide/platform-functionality/jobs/jobbutton.html"
+    is_data_compliance_model = False
 
     class Meta:
         ordering = ["group_name", "weight", "name"]
 
+    @property
+    def button_class_css_class(self):
+        """Map self.button_class database value to the correct CSS class for buttons."""
+        if self.button_class == ButtonClassChoices.CLASS_DEFAULT:
+            return "secondary"
+        return self.button_class
+
     def __str__(self):
         return self.name
 
@@ -1081,6 +1137,7 @@ class ScheduledJobs(models.Model):
     last_update = models.DateTimeField(null=False)
 
     objects = ScheduledJobsManager()
+    is_data_compliance_model = False
 
     def __str__(self):
         return str(self.ident)
@@ -1218,6 +1275,7 @@ class ScheduledJob(ApprovableModelMixin, BaseModel):
     no_changes = False
 
     documentation_static_path = "docs/user-guide/platform-functionality/jobs/job-scheduling-and-approvals.html"
+    is_data_compliance_model = False
 
     def __str__(self):
         return f"{self.name}: {self.interval}"

nautobot/extras/models/mixins.py

@@ -251,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

@@ -353,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"]
 
@@ -577,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"]
 
@@ -638,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
 
@@ -877,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"]
@@ -905,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/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/navigation.py

@@ -4,11 +4,13 @@ from nautobot.core.apps import (
     NavMenuItem,
     NavMenuTab,
 )
+from nautobot.core.ui.choices import NavigationIconChoices, NavigationWeightChoices
 
 menu_items = (
     NavMenuTab(
         name="Approvals",
-        icon="checkbox-circle",
+        icon=NavigationIconChoices.APPROVAL_WORKFLOWS,
+        weight=NavigationWeightChoices.APPROVAL_WORKFLOWS,
         groups=(
             NavMenuGroup(
                 name="Approval Workflows",
@@ -38,7 +40,8 @@ menu_items = (
     ),
     NavMenuTab(
         name="Organization",
-        weight=100,
+        icon=NavigationIconChoices.ORGANIZATION,
+        weight=NavigationWeightChoices.ORGANIZATION,
         groups=(
             NavMenuGroup(
                 name="Contacts",
@@ -140,8 +143,8 @@ menu_items = (
     ),
     NavMenuTab(
         name="Secrets",
-        icon="secrets",
-        weight=700,
+        icon=NavigationIconChoices.SECRETS,
+        weight=NavigationWeightChoices.SECRETS,
         groups=(
             NavMenuGroup(
                 name="Secrets",
@@ -169,8 +172,8 @@ menu_items = (
     ),
     NavMenuTab(
         name="Jobs",
-        icon="share",
-        weight=800,
+        icon=NavigationIconChoices.JOBS,
+        weight=NavigationWeightChoices.JOBS,
         groups=(
             NavMenuGroup(
                 name="Jobs",
@@ -258,7 +261,8 @@ menu_items = (
     ),
     NavMenuTab(
         name="Extensibility",
-        weight=900,
+        icon=NavigationIconChoices.EXTENSIBILITY,
+        weight=NavigationWeightChoices.EXTENSIBILITY,
         groups=(
             NavMenuGroup(
                 name="Logging",
@@ -532,8 +536,8 @@ menu_items = (
     ),
     NavMenuTab(
         name="Apps",
-        icon="elements",
-        weight=5000,
+        icon=NavigationIconChoices.APPS,
+        weight=NavigationWeightChoices.APPS,
         groups=(
             NavMenuGroup(
                 name="General",