nautobot 2.4.9__py3-none-any.whl → 2.4.11__py3-none-any.whl

nautobot/extras/api/views.py

@@ -512,12 +512,19 @@ class JobViewSetBase(
     serializer_class = serializers.JobSerializer
     filterset_class = filters.JobFilterSet
 
+    def get_object(self):
+        """Get the Job instance and reload the job class to ensure we have the latest version of the job code."""
+        obj = super().get_object()
+        get_job(obj.class_path, reload=True)
+
+        return obj
+
     @extend_schema(responses={"200": serializers.JobVariableSerializer(many=True)})
     @action(detail=True, filterset_class=None)
     def variables(self, request, *args, **kwargs):
         """Get details of the input variables that may/must be specified to run a particular Job."""
         job_model = self.get_object()
-        job_class = get_job(job_model.class_path, reload=True)
+        job_class = job_model.job_class
         if job_class is None:
             raise Http404
         variables_dict = job_class._get_vars()
@@ -599,7 +606,7 @@ class JobViewSetBase(
                     "One of these two flags must be removed before this job can be scheduled or run."
                 )
 
-        job_class = get_job(job_model.class_path, reload=True)
+        job_class = job_model.job_class
         if job_class is None:
             raise MethodNotAllowed(
                 request.method, detail="This job's source code could not be located and cannot be run"

nautobot/extras/context_managers.py

@@ -254,8 +254,8 @@ def web_request_context(
             # TODO: get_snapshots() currently requires a DB query per object change processed.
             # We need to develop a more efficient approach: https://github.com/nautobot/nautobot/issues/6303
             snapshots = oc.get_snapshots(
-                pre_object_data.get(str(oc.changed_object_id), None),
-                pre_object_data_v2.get(str(oc.changed_object_id), None),
+                pre_object_data.get(str(oc.changed_object_id), None) if pre_object_data else None,
+                pre_object_data_v2.get(str(oc.changed_object_id), None) if pre_object_data_v2 else None,
             )
             webhook_queryset = enqueue_webhooks(oc, snapshots=snapshots, webhook_queryset=webhook_queryset)
 

nautobot/extras/datasources/git.py

@@ -17,7 +17,7 @@ from git import InvalidGitRepositoryError, Repo
 import yaml
 
 from nautobot.core.utils.git import GitRepo
-from nautobot.core.utils.module_loading import import_modules_privately
+from nautobot.core.utils.module_loading import check_name_safe_to_import_privately, import_modules_privately
 from nautobot.dcim.models import Device, DeviceRedundancyGroup, DeviceType, Location, Platform
 from nautobot.extras.choices import (
     LogLevelChoices,
@@ -720,11 +720,19 @@ def refresh_job_code_from_repository(repository_slug, skip_reimport=False, ignor
     After cloning/updating/deleting a GitRepository on disk, call this function to reload and reregister its Python.
 
     Args:
-        repository_slug (str): Repository directory in GIT_ROOT that was updated or deleted.
-        skip_reimport (bool): If True, unload existing code from this repository but do not re-import it.
+        repository_slug (str): Repository slug (directory in GIT_ROOT) that was populated, updated, or deleted.
+        skip_reimport (bool): If True, unload existing jobs from this repository but do not re-import them.
         ignore_import_errors (bool): If True, any exceptions raised in the import will be caught and logged.
             If False, exceptions will be re-raised after logging.
     """
+    # Enforced during GitRepository.clean() but just in case someone created a bad record without cleaning:
+    permitted, reason = check_name_safe_to_import_privately(repository_slug)
+    if not permitted:
+        logger.error("The repository_slug %r is invalid as it is %s", repository_slug, reason)
+        if ignore_import_errors:
+            return
+        raise ValueError(f"The repository_slug {repository_slug!r} is invalid as it is {reason}")
+
     # Unload any previous version of this module and its submodules if present
     for job_class_path in list(registry["jobs"]):
         if job_class_path.startswith(f"{repository_slug}."):

nautobot/extras/forms/forms.py

@@ -914,13 +914,13 @@ class ExternalIntegrationBulkEditForm(NautobotBulkEditForm):
     secrets_group = DynamicModelChoiceField(required=False, queryset=SecretsGroup.objects.all())
     verify_ssl = forms.NullBooleanField(required=False, label="Verify SSL", widget=BulkEditNullBooleanSelect)
     timeout = forms.IntegerField(required=False, min_value=0)
-    extra_config = forms.JSONField(required=False)
+    extra_config = JSONField(required=False, widget=forms.Textarea, help_text="JSON data")
     http_method = forms.ChoiceField(
         required=False,
         label="HTTP Method",
         choices=add_blank_choice(WebhookHttpMethodChoices),
     )
-    headers = forms.JSONField(required=False, label="HTTP Request headers")
+    headers = JSONField(required=False, widget=forms.Textarea, help_text="Headers for the HTTP request")
 
     class Meta:
         model = ExternalIntegration
@@ -1487,7 +1487,6 @@ class JobQueueBulkEditForm(TagsBulkEditFormMixin, NautobotBulkEditForm):
     class Meta:
         model = JobQueue
         nullable_fields = [
-            "secrets_group",
             "description",
             "tenant",
         ]
@@ -1910,8 +1909,8 @@ class RelationshipBulkEditForm(BootstrapMixin, CustomFieldModelBulkEditFormMixin
     )
     source_hidden = forms.NullBooleanField(required=False, widget=BulkEditNullBooleanSelect)
     destination_hidden = forms.NullBooleanField(required=False, widget=BulkEditNullBooleanSelect)
-    source_filter = forms.JSONField(required=False, widget=forms.Textarea, help_text="Filter for the source")
-    destination_filter = forms.JSONField(required=False, widget=forms.Textarea, help_text="Filter for the destination")
+    source_filter = JSONField(required=False, widget=forms.Textarea, help_text="Filter for the source")
+    destination_filter = JSONField(required=False, widget=forms.Textarea, help_text="Filter for the destination")
     source_type = CSVContentTypeField(
         queryset=ContentType.objects.filter(FeatureQuery("relationships").get_query()), required=False
     )
@@ -2256,6 +2255,8 @@ class WebhookBulkEditForm(BootstrapMixin, NoteModelBulkEditFormMixin):
     secret = forms.CharField(required=False, max_length=CHARFIELD_MAX_LENGTH)
     ca_file_path = forms.CharField(required=False, max_length=4096)
     http_content_type = forms.CharField(required=False, max_length=CHARFIELD_MAX_LENGTH)
+    additional_headers = forms.CharField(required=False, widget=forms.Textarea)
+    body_template = forms.CharField(required=False, widget=forms.Textarea)
 
     # Choice field
     http_method = forms.ChoiceField(
@@ -2279,6 +2280,8 @@ class WebhookBulkEditForm(BootstrapMixin, NoteModelBulkEditFormMixin):
             "type_delete",
             "http_method",
             "http_content_type",
+            "additional_headers",
+            "body_template",
             "ssl_verification",
             "ca_file_path",
             "payload_url",
@@ -2286,6 +2289,7 @@ class WebhookBulkEditForm(BootstrapMixin, NoteModelBulkEditFormMixin):
             "add_content_types",
             "remove_content_types",
         )
+        nullable_fields = ("additional_headers",)
 
 
 class WebhookForm(BootstrapMixin, forms.ModelForm):

nautobot/extras/jobs.py

@@ -17,6 +17,7 @@ from celery.exceptions import Ignore, Reject
 from celery.utils.log import get_task_logger
 from db_file_storage.form_widgets import DBClearableFileInput
 from django import forms
+from django.apps import apps
 from django.conf import settings
 from django.contrib.auth import get_user_model
 from django.core.cache import cache
@@ -1142,8 +1143,9 @@ def get_job(class_path, reload=False):
             # System job - not reloadable
             reload = False
         if any(class_path.startswith(f"{app_name}.") for app_name in settings.PLUGINS):
-            # App provided job - not reloadable
-            reload = False
+            # App provided job - only reload if the app provides dynamic jobs
+            app_config = apps.get_app_config(class_path.split(".")[0])
+            reload = getattr(app_config, "provides_dynamic_jobs", False)
     jobs = get_jobs(reload=reload)
     return jobs.get(class_path, None)
 

nautobot/extras/models/customfields.py

@@ -269,6 +269,8 @@ class CustomFieldModel(models.Model):
                 elif cf.required:
                     raise ValidationError(f"Missing required custom field '{cf.key}'.")
 
+    clean.alters_data = True
+
     # Computed Field Methods
     def has_computed_fields(self, advanced_ui=None):
         """

nautobot/extras/models/datasources.py

@@ -1,7 +1,6 @@
 """Models for representing external data sources."""
 
 from contextlib import contextmanager
-from importlib.util import find_spec
 import logging
 import os
 import shutil
@@ -17,7 +16,8 @@ from nautobot.core.models.fields import AutoSlugField, LaxURLField, slugify_dash
 from nautobot.core.models.generics import PrimaryModel
 from nautobot.core.models.validators import EnhancedURLValidator
 from nautobot.core.utils.git import GitRepo
-from nautobot.extras.utils import check_if_key_is_graphql_safe, extras_features
+from nautobot.core.utils.module_loading import check_name_safe_to_import_privately
+from nautobot.extras.utils import extras_features
 
 logger = logging.getLogger(__name__)
 
@@ -105,12 +105,9 @@ class GitRepository(PrimaryModel):
             )
 
         if not self.present_in_database:
-            check_if_key_is_graphql_safe(self.__class__.__name__, self.slug, "slug")
-            # Check on create whether the proposed slug conflicts with a module name already in the Python environment.
-            if find_spec(self.slug) is not None:
-                raise ValidationError(
-                    f'Please choose a different slug, as "{self.slug}" is an installed Python package or module.'
-                )
+            permitted, reason = check_name_safe_to_import_privately(self.slug)
+            if not permitted:
+                raise ValidationError({"slug": f"Please choose a different slug; {self.slug!r} is {reason}"})
 
         if self.provided_contents:
             q = models.Q()
@@ -180,6 +177,8 @@ class GitRepository(PrimaryModel):
             return enqueue_git_repository_diff_origin_and_local(self, user)
         return enqueue_pull_git_repository_and_refresh_data(self, user)
 
+    sync.alters_data = True
+
     @contextmanager
     def clone_to_directory_context(self, path=None, branch=None, head=None, depth=0):
         """
@@ -207,6 +206,8 @@ class GitRepository(PrimaryModel):
             if path_name:
                 self.cleanup_cloned_directory(path_name)
 
+    clone_to_directory_context.alters_data = True
+
     def clone_to_directory(self, path=None, branch=None, head=None, depth=0):
         """
         Perform a (shallow or full) clone of the Git repository in a temporary directory.
@@ -246,6 +247,8 @@ class GitRepository(PrimaryModel):
         logger.info(f"Cloned repository {self.name} to {path_name}")
         return path_name
 
+    clone_to_directory.alters_data = True
+
     def cleanup_cloned_directory(self, path):
         """
         Cleanup the cloned directory.
@@ -259,3 +262,5 @@ class GitRepository(PrimaryModel):
         except OSError as os_error:
             # log error if the cleanup fails
             logger.error(f"Failed to cleanup temporary directory at {path}: {os_error}")
+
+    cleanup_cloned_directory.alters_data = True

nautobot/extras/models/groups.py

@@ -338,6 +338,8 @@ class DynamicGroup(PrimaryModel):
 
         return self.members
 
+    _set_members.alters_data = True
+
     def add_members(self, objects_to_add):
         """Add the given list or QuerySet of objects to this staticly defined group."""
         if self.group_type != DynamicGroupTypeChoices.TYPE_STATIC:
@@ -354,6 +356,8 @@ class DynamicGroup(PrimaryModel):
             objects_to_add = [obj for obj in objects_to_add if obj not in existing_members]
         return self._add_members(objects_to_add)
 
+    add_members.alters_data = True
+
     def _add_members(self, objects_to_add):
         """
         Internal API for adding the given list or QuerySet of objects to the cached/static members of this group.
@@ -377,6 +381,8 @@ class DynamicGroup(PrimaryModel):
             ]
             StaticGroupAssociation.all_objects.bulk_create(sgas, batch_size=1000)
 
+    _add_members.alters_data = True
+
     def remove_members(self, objects_to_remove):
         """Remove the given list or QuerySet of objects from this staticly defined group."""
         if self.group_type != DynamicGroupTypeChoices.TYPE_STATIC:
@@ -390,6 +396,8 @@ class DynamicGroup(PrimaryModel):
                     raise TypeError(f"{obj} is not a {self.model._meta.label_lower}")
         return self._remove_members(objects_to_remove)
 
+    remove_members.alters_data = True
+
     def _remove_members(self, objects_to_remove):
         """Internal API for removing the given list or QuerySet from the cached/static members of this Group."""
         from nautobot.extras.signals import _handle_deleted_object  # avoid circular import
@@ -418,6 +426,8 @@ class DynamicGroup(PrimaryModel):
                 logger.debug("Re-connecting the _handle_deleted_object signal")
                 pre_delete.connect(_handle_deleted_object)
 
+    _remove_members.alters_data = True
+
     @property
     @method_deprecated("Members are now cached in the database via StaticGroupAssociations rather than in Redis.")
     def members_cache_key(self):
@@ -451,6 +461,8 @@ class DynamicGroup(PrimaryModel):
 
         return members
 
+    update_cached_members.alters_data = True
+
     def has_member(self, obj, use_cache=False):
         """
         Return True if the given object is a member of this group.
@@ -560,6 +572,8 @@ class DynamicGroup(PrimaryModel):
 
         self.filter = new_filter
 
+    set_filter.alters_data = True
+
     def get_initial(self):
         """
         Return a form-friendly version of `self.filter` for initial form data.
@@ -815,6 +829,8 @@ class DynamicGroup(PrimaryModel):
         instance = self.children.through(parent_group=self, group=child, operator=operator, weight=weight)
         return instance.validated_save()
 
+    add_child.alters_data = True
+
     # TODO: unused in core
     def remove_child(self, child):
         """
@@ -829,6 +845,8 @@ class DynamicGroup(PrimaryModel):
         instance = self.children.through.objects.get(parent_group=self, group=child)
         return instance.delete()
 
+    remove_child.alters_data = True
+
     def get_descendants(self, group=None):
         """
         Recursively return a list of the children of all child groups.

nautobot/extras/models/jobs.py

@@ -753,6 +753,8 @@ class JobResult(BaseModel, CustomFieldModel):
                     duration.total_seconds()
                 )
 
+    set_status.alters_data = True
+
     @classmethod
     def execute_job(cls, *args, **kwargs):
         """
@@ -768,6 +770,8 @@ class JobResult(BaseModel, CustomFieldModel):
         """
         return cls.enqueue_job(*args, **kwargs, synchronous=True)
 
+    execute_job.__func__.alters_data = True
+
     @classmethod
     def enqueue_job(
         cls,
@@ -938,6 +942,8 @@ class JobResult(BaseModel, CustomFieldModel):
 
         return job_result
 
+    enqueue_job.__func__.alters_data = True
+
     def log(
         self,
         message,
@@ -989,6 +995,8 @@ class JobResult(BaseModel, CustomFieldModel):
         else:
             log.save(using=JOB_LOGS)
 
+    log.alters_data = True
+
 
 #
 # Job Button
@@ -1076,6 +1084,8 @@ class ScheduledJobs(models.Model):
         if not instance.no_changes:
             cls.update_changed()
 
+    changed.__func__.alters_data = True
+
     @classmethod
     def update_changed(cls, raw=False, **kwargs):
         """This function acts as a signal handler to track changes to the scheduled job that is triggered after a change"""
@@ -1083,6 +1093,8 @@ class ScheduledJobs(models.Model):
             return
         cls.objects.update_or_create(ident=1, defaults={"last_update": timezone.now()})
 
+    update_changed.__func__.alters_data = True
+
     @classmethod
     def last_change(cls):
         """This function acts as a getter for the last update on scheduled jobs"""
@@ -1371,6 +1383,11 @@ class ScheduledJob(BaseModel):
         if job_model.time_limit > 0:
             celery_kwargs["time_limit"] = job_model.time_limit
 
+        # We do this because when a job creates an approval workflow, a scheduled job is also created.
+        # If the scheduled job has an "immediate" interval, the scheduler will not send this task.
+        # since TYPE_IMMEDIATELY is not a valid value in JobExecutionType.SCHEDULE_CHOICES
+        if interval == JobExecutionType.TYPE_IMMEDIATELY:
+            interval = JobExecutionType.TYPE_FUTURE
         # 2.0 TODO: To revisit this as part of a larger Jobs cleanup in 2.0.
         #
         # We pass in task and job_model here partly for forward/backward compatibility logic, and
@@ -1397,6 +1414,8 @@ class ScheduledJob(BaseModel):
         scheduled_job.validated_save()
         return scheduled_job
 
+    create_schedule.__func__.alters_data = True
+
     def to_cron(self):
         tz = self.time_zone
         t = self.start_time.astimezone(tz)  # pylint: disable=no-member

nautobot/extras/models/metadata.py

@@ -251,6 +251,8 @@ class ObjectMetadata(ChangeLoggedModel, BaseModel):
         self.clean()
         return super().validated_save(*args, **kwargs)
 
+    validated_save.alters_data = True
+
     def clean(self):
         """
         Validate a value according to the field's type validation rules.

nautobot/extras/models/models.py

@@ -457,6 +457,8 @@ class ExportTemplate(
         if self.file_extension.startswith("."):
             self.file_extension = self.file_extension[1:]
 
+    clean.alters_data = True
+
 
 #
 # External integrations
@@ -919,6 +921,8 @@ class UserSavedViewAssociation(BaseModel):
         super().clean()
         self.view_name = self.saved_view.view
 
+    clean.alters_data = True
+
 
 #
 # Webhooks

nautobot/extras/models/secrets.py

@@ -4,6 +4,7 @@ from django.core.exceptions import ValidationError
 from django.core.serializers.json import DjangoJSONEncoder
 from django.db import models
 from jinja2.exceptions import TemplateSyntaxError, UndefinedError
+from jinja2.sandbox import unsafe
 
 from nautobot.core.constants import CHARFIELD_MAX_LENGTH
 from nautobot.core.models import BaseModel
@@ -58,6 +59,7 @@ class Secret(PrimaryModel):
         except (TemplateSyntaxError, UndefinedError) as exc:
             raise SecretParametersError(self, registry["secrets_providers"].get(self.provider), str(exc)) from exc
 
+    @unsafe
     def get_value(self, obj=None):
         """Retrieve the secret value that this Secret is a representation of.
 
@@ -77,6 +79,8 @@ class Secret(PrimaryModel):
         except Exception as exc:
             raise SecretError(self, provider, str(exc)) from exc
 
+    get_value.do_not_call_in_templates = True
+
     def clean(self):
         provider = registry["secrets_providers"].get(self.provider)
         if not provider:
@@ -108,6 +112,7 @@ class SecretsGroup(OrganizationalModel):
     def __str__(self):
         return self.name
 
+    @unsafe
     def get_secret_value(self, access_type, secret_type, obj=None, **kwargs):
         """Helper method to retrieve a specific secret from this group.
 
@@ -118,6 +123,8 @@ class SecretsGroup(OrganizationalModel):
         ).secret
         return secret.get_value(obj=obj, **kwargs)
 
+    get_secret_value.do_not_call_in_templates = True
+
 
 @extras_features(
     "graphql",

nautobot/extras/plugins/__init__.py

@@ -81,6 +81,9 @@ class NautobotAppConfig(NautobotConfig):
     config_view_name = None
     docs_view_name = None
 
+    # Dynamic jobs. Set to True if the app's job code should be reloaded at runtime
+    provides_dynamic_jobs = False
+
     # Default integration paths. Plugin authors can override these to customize the paths to
     # integrated components.
     banner_function = "banner.banner"

nautobot/extras/secrets/__init__.py

@@ -1,5 +1,7 @@
 from abc import ABC, abstractmethod
 
+from jinja2.sandbox import unsafe
+
 from nautobot.extras.registry import registry
 
 from .exceptions import SecretError, SecretParametersError, SecretProviderError, SecretValueNotFoundError
@@ -31,6 +33,7 @@ class SecretsProvider(ABC):
 
     @classmethod
     @abstractmethod
+    @unsafe
     def get_value_for_secret(cls, secret, obj=None, **kwargs):
         """Retrieve the stored value described by the given Secret record.
 
@@ -41,6 +44,17 @@ class SecretsProvider(ABC):
             obj (object): Django model instance or similar providing additional context for retrieving the secret.
         """
 
+    get_value_for_secret.__func__.do_not_call_in_templates = True
+
+    def __init_subclass__(cls, **kwargs):
+        # Automatically apply protection against Django and Jinja2 template execution to child classes.
+        if not getattr(cls.get_value_for_secret, "do_not_call_in_templates", False):  # Django
+            cls.get_value_for_secret.__func__.do_not_call_in_templates = True
+        if not getattr(cls.get_value_for_secret, "unsafe_callable", False):  # Jinja @unsafe decorator
+            cls.get_value_for_secret.__func__.unsafe_callable = True
+
+        super().__init_subclass__(**kwargs)
+
 
 def register_secrets_provider(provider):
     """

nautobot/extras/tables.py

@@ -1,9 +1,13 @@
 from django.conf import settings
+from django.db.models import QuerySet
 from django.utils.html import format_html, format_html_join
 import django_tables2 as tables
+from django_tables2.data import TableData
+from django_tables2.rows import BoundRows
 from django_tables2.utils import Accessor
 from jsonschema.exceptions import ValidationError as JSONSchemaValidationError
 
+from nautobot.core.models.querysets import count_related
 from nautobot.core.tables import (
     BaseTable,
     BooleanColumn,
@@ -19,7 +23,7 @@ from nautobot.core.tables import (
 from nautobot.core.templatetags.helpers import render_boolean, render_json, render_markdown
 from nautobot.tenancy.tables import TenantColumn
 
-from .choices import MetadataTypeDataTypeChoices
+from .choices import LogLevelChoices, MetadataTypeDataTypeChoices
 from .models import (
     ComputedField,
     ConfigContext,
@@ -891,7 +895,7 @@ class JobResultTable(BaseTable):
     )
     summary = tables.Column(
         empty_values=(),
-        verbose_name="Results",
+        verbose_name="Summary",
         orderable=False,
         attrs={"td": {"class": "text-nowrap report-stats"}},
     )
@@ -901,6 +905,40 @@ class JobResultTable(BaseTable):
     )
     actions = ButtonsColumn(JobResult, buttons=("delete",), prepend_template=JOB_RESULT_BUTTONS)
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        # Only calculate log counts for "summary" column if it's actually visible.
+        if self.columns["summary"].visible and isinstance(self.data.data, QuerySet):
+            self.data = TableData.from_data(
+                self.data.data.annotate(
+                    debug_log_count=count_related(
+                        JobLogEntry, "job_result", filter_dict={"log_level": LogLevelChoices.LOG_DEBUG}
+                    ),
+                    success_log_count=count_related(
+                        JobLogEntry, "job_result", filter_dict={"log_level": LogLevelChoices.LOG_SUCCESS}
+                    ),
+                    info_log_count=count_related(
+                        JobLogEntry, "job_result", filter_dict={"log_level": LogLevelChoices.LOG_INFO}
+                    ),
+                    warning_log_count=count_related(
+                        JobLogEntry, "job_result", filter_dict={"log_level": LogLevelChoices.LOG_WARNING}
+                    ),
+                    error_log_count=count_related(
+                        JobLogEntry,
+                        "job_result",
+                        filter_dict={
+                            "log_level__in": [
+                                LogLevelChoices.LOG_FAILURE,
+                                LogLevelChoices.LOG_ERROR,
+                                LogLevelChoices.LOG_CRITICAL,
+                            ],
+                        },
+                    ),
+                )
+            )
+            self.data.set_table(self)
+            self.rows = BoundRows(data=self.data, table=self, pinned_data=self.pinned_data)
+
     def render_summary(self, record):
         """
         Define custom rendering for the summary column.
@@ -940,7 +978,6 @@ class JobResultTable(BaseTable):
             "job_model",
             "user",
             "status",
-            "summary",
             "actions",
         )