nautobot 2.3.0b1__py3-none-any.whl → 2.3.2__py3-none-any.whl

nautobot/extras/models/jobs.py

@@ -4,7 +4,6 @@ import contextlib
 from datetime import timedelta
 import logging
 
-from celery import schedules
 from celery.exceptions import NotRegistered
 from celery.utils.log import get_logger, LoggingProxy
 from django.conf import settings
@@ -16,7 +15,9 @@ from django.db.models import signals
 from django.utils import timezone
 from django.utils.functional import cached_property
 from django_celery_beat.clockedschedule import clocked
+from django_celery_beat.tzcrontab import TzAwareCrontab
 from prometheus_client import Histogram
+from timezone_field import TimeZoneField
 
 from nautobot.core.celery import (
     app,
@@ -456,6 +457,8 @@ class JobLogEntry(BaseModel):
     log_object = models.CharField(max_length=JOB_LOG_MAX_LOG_OBJECT_LENGTH, blank=True, default="")
     absolute_url = models.CharField(max_length=JOB_LOG_MAX_ABSOLUTE_URL_LENGTH, blank=True, default="")
 
+    is_metadata_associable_model = False
+
     documentation_static_path = "docs/user-guide/platform-functionality/jobs/models.html"
 
     def __str__(self):
@@ -933,6 +936,9 @@ class ScheduledJob(BaseModel):
         verbose_name="Start Datetime",
         help_text="Datetime when the schedule should begin triggering the task to run",
     )
+    # Django always stores DateTimeField as UTC internally, but we want scheduled jobs to respect DST and similar,
+    # so we need to store the time zone the job was scheduled under as well.
+    time_zone = TimeZoneField(default=timezone.get_default_timezone_name)
     # todoindex:
     enabled = models.BooleanField(
         default=True,
@@ -1003,12 +1009,15 @@ class ScheduledJob(BaseModel):
     def __str__(self):
         return f"{self.name}: {self.interval}"
 
+    class Meta:
+        ordering = ["name"]
+
     def save(self, *args, **kwargs):
         self.queue = self.queue or ""
         # make sure non-valid crontab doesn't get saved
         if self.interval == JobExecutionType.TYPE_CUSTOM:
             try:
-                self.get_crontab(self.crontab)
+                self.get_crontab(self.crontab, tz=self.time_zone)
             except Exception as e:
                 raise ValidationError({"crontab": e})
         if not self.enabled:
@@ -1053,7 +1062,7 @@ class ScheduledJob(BaseModel):
         return timezone.now() + timedelta(seconds=15)
 
     @classmethod
-    def get_crontab(cls, crontab):
+    def get_crontab(cls, crontab, tz=None):
         """
         Wrapper method translates crontab syntax to Celery crontab.
 
@@ -1066,25 +1075,112 @@ class ScheduledJob(BaseModel):
 
         No support for Last (L), Weekday (W), Number symbol (#), Question mark (?), and special @ strings.
         """
+        if not tz:
+            tz = timezone.get_default_timezone()
         minute, hour, day_of_month, month_of_year, day_of_week = crontab.split(" ")
-        return schedules.crontab(
+
+        return TzAwareCrontab(
             minute=minute,
             hour=hour,
             day_of_month=day_of_month,
             month_of_year=month_of_year,
             day_of_week=day_of_week,
+            tz=tz,
+        )
+
+    @classmethod
+    def create_schedule(
+        cls,
+        job_model,
+        user,
+        name=None,
+        start_time=None,
+        interval=JobExecutionType.TYPE_IMMEDIATELY,
+        crontab="",
+        profile=False,
+        approval_required=False,
+        task_queue=None,
+        **job_kwargs,
+    ):
+        """
+        Schedule a job with the specified parameters.
+
+        This method creates a schedule for a job to be executed at a specific time
+        or interval. It handles immediate execution, custom start times, and
+        crontab-based scheduling.
+
+        Parameters:
+            job_model (JobModel): The job model instance.
+            user (User): The user who is scheduling the job.
+            name (str, optional): The name of the scheduled job. Defaults to None.
+            start_time (datetime, optional): The start time for the job. Defaults to None.
+            interval (JobExecutionType, optional): The interval type for the job execution.
+                Defaults to JobExecutionType.TYPE_IMMEDIATELY.
+            crontab (str, optional): The crontab string for the schedule. Defaults to "".
+            profile (bool, optional): Flag indicating whether to profile the job. Defaults to False.
+            approval_required (bool, optional): Flag indicating if approval is required. Defaults to False.
+            task_queue (str, optional): The task queue for the job. Defaults to None, which will use the configured default celery queue.
+            **job_kwargs: Additional keyword arguments to pass to the job.
+
+        Returns:
+            ScheduledJob instance
+        """
+
+        if interval == JobExecutionType.TYPE_IMMEDIATELY:
+            start_time = timezone.localtime()
+            name = name or f"{job_model.name} - {start_time}"
+        elif interval == JobExecutionType.TYPE_CUSTOM:
+            if start_time is None:
+                # "start_time" is checked against models.ScheduledJob.earliest_possible_time()
+                # which returns timezone.now() + timedelta(seconds=15)
+                start_time = timezone.localtime() + timedelta(seconds=20)
+
+        celery_kwargs = {
+            "nautobot_job_profile": profile,
+            "queue": task_queue,
+        }
+        if job_model.soft_time_limit > 0:
+            celery_kwargs["soft_time_limit"] = job_model.soft_time_limit
+        if job_model.time_limit > 0:
+            celery_kwargs["time_limit"] = job_model.time_limit
+
+        # 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
+        # part fallback safety. It's mildly useful to store both the task module/class name and the JobModel
+        # FK on the ScheduledJob, as in the case where the JobModel gets deleted (and the FK becomes
+        # null) you still have a bit of context on the ScheduledJob as to what it was originally
+        # scheduled for.
+        scheduled_job = cls(
+            name=name,
+            task=job_model.class_path,
+            job_model=job_model,
+            start_time=start_time,
+            time_zone=start_time.tzinfo,
+            description=f"Nautobot job {name} scheduled by {user} for {start_time}",
+            kwargs=job_kwargs,
+            celery_kwargs=celery_kwargs,
+            interval=interval,
+            one_off=(interval == JobExecutionType.TYPE_FUTURE),
+            user=user,
+            approval_required=approval_required,
+            crontab=crontab,
+            queue=task_queue,
         )
+        scheduled_job.validated_save()
+        return scheduled_job
 
     def to_cron(self):
-        t = self.start_time
+        tz = self.time_zone
+        t = self.start_time.astimezone(tz)
         if self.interval == JobExecutionType.TYPE_HOURLY:
-            return schedules.crontab(minute=t.minute)
+            return TzAwareCrontab(minute=t.minute, tz=tz)
         elif self.interval == JobExecutionType.TYPE_DAILY:
-            return schedules.crontab(minute=t.minute, hour=t.hour)
+            return TzAwareCrontab(minute=t.minute, hour=t.hour, tz=tz)
         elif self.interval == JobExecutionType.TYPE_WEEKLY:
-            return schedules.crontab(minute=t.minute, hour=t.hour, day_of_week=t.strftime("%w"))
+            return TzAwareCrontab(minute=t.minute, hour=t.hour, day_of_week=t.strftime("%w"), tz=tz)
         elif self.interval == JobExecutionType.TYPE_CUSTOM:
-            return self.get_crontab(self.crontab)
+            return self.get_crontab(self.crontab, tz=tz)
         raise ValueError(f"I do not know to convert {self.interval} to a Cronjob!")
 
 

nautobot/extras/models/metadata.py

@@ -61,7 +61,7 @@ class MetadataType(PrimaryModel):
 
     objects = MetadataTypeManager()
     clone_fields = ["data_type"]
-    documentation_static_path = "docs/user-guide/platform-functionality/metadata.html"
+    documentation_static_path = "docs/user-guide/platform-functionality/objectmetadata.html"
 
     class Meta:
         ordering = ["name"]
@@ -106,7 +106,7 @@ class MetadataChoice(ChangeLoggedModel, BaseModel):
     weight = models.PositiveSmallIntegerField(default=100, help_text="Higher weights appear later in the list")
     is_metadata_associable_model = False
 
-    documentation_static_path = "docs/user-guide/platform-functionality/metadata.html"
+    documentation_static_path = "docs/user-guide/platform-functionality/objectmetadata.html"
 
     class Meta:
         ordering = ["metadata_type", "weight", "value"]
@@ -166,19 +166,19 @@ class ObjectMetadata(ChangeLoggedModel, BaseModel):
     metadata_type = models.ForeignKey(
         to=MetadataType,
         on_delete=models.PROTECT,
-        related_name="object_metadatas",
+        related_name="object_metadata",
     )
     contact = models.ForeignKey(
         to=Contact,
         on_delete=models.PROTECT,
-        related_name="object_metadatas",
+        related_name="object_metadata",
         blank=True,
         null=True,
     )
     team = models.ForeignKey(
         to=Team,
         on_delete=models.PROTECT,
-        related_name="object_metadatas",
+        related_name="object_metadata",
         blank=True,
         null=True,
     )
@@ -186,6 +186,7 @@ class ObjectMetadata(ChangeLoggedModel, BaseModel):
         base_field=models.CharField(
             max_length=CHARFIELD_MAX_LENGTH,
         ),
+        blank=True,
         help_text="List of scoped fields, only direct fields on the model",
     )
     _value = models.JSONField(
@@ -199,7 +200,7 @@ class ObjectMetadata(ChangeLoggedModel, BaseModel):
 
     objects = ObjectMetadataManager()
     natural_key_field_names = ["pk"]
-    documentation_static_path = "docs/user-guide/platform-functionality/metadata.html"
+    documentation_static_path = "docs/user-guide/platform-functionality/objectmetadata.html"
 
     class Meta:
         ordering = ["metadata_type"]
@@ -361,12 +362,17 @@ class ObjectMetadata(ChangeLoggedModel, BaseModel):
                         raise ValidationError("Date values must be in the format YYYY-MM-DD.")
             # Validate datetime
             elif metadata_type_data_type == MetadataTypeDataTypeChoices.TYPE_DATETIME:
-                acceptable_datetime_formats = [
-                    "YYYY-MM-DDTHH:MM:SS",
-                    "YYYY-MM-DDTHH:MM:SS(+,-)zzzz",
-                    "YYYY-MM-DDTHH:MM:SS(+,-)zz:zz",
-                ]
-                if not isinstance(value, datetime):
+                if isinstance(value, datetime):
+                    # check if datetime object has tzinfo
+                    if value.tzinfo is None:
+                        value = value.replace(tzinfo=timezone.utc)  # pylint: disable=unexpected-keyword-arg,no-value-for-parameter
+                    value = value.replace(microsecond=0).isoformat()  # pylint: disable=unexpected-keyword-arg,no-value-for-parameter
+                else:
+                    acceptable_datetime_formats = [
+                        "YYYY-MM-DDTHH:MM:SS",
+                        "YYYY-MM-DDTHH:MM:SS(+,-)zzzz",
+                        "YYYY-MM-DDTHH:MM:SS(+,-)zz:zz",
+                    ]
                     try:
                         datetime.strptime(value, "%Y-%m-%dT%H:%M:%S%z")
                     except ValueError:
@@ -380,12 +386,6 @@ class ObjectMetadata(ChangeLoggedModel, BaseModel):
                             )
                     except TypeError:
                         raise ValidationError("Value must be a datetime or str object.")
-                else:
-                    # if value is a datetime object
-                    # check if datetime object has tzinfo
-                    if value.tzinfo is None:
-                        value = value.replace(tzinfo=timezone.utc)
-                    value = value.replace(microsecond=0).isoformat()
             # Validate selected choice
             elif metadata_type_data_type == MetadataTypeDataTypeChoices.TYPE_SELECT:
                 if value not in self.metadata_type.choices.values_list("value", flat=True):

nautobot/extras/models/models.py

@@ -822,6 +822,8 @@ class Note(ChangeLoggedModel, BaseModel):
     note = models.TextField()
     objects = BaseManager.from_queryset(NotesQuerySet)()
 
+    is_metadata_associable_model = False
+
     class Meta:
         ordering = ["created"]
         unique_together = [["assigned_object_type", "assigned_object_id", "user_name", "created"]]

nautobot/extras/signals.py

@@ -13,7 +13,7 @@ from django.core.cache import cache
 from django.core.exceptions import ValidationError
 from django.core.files.storage import get_storage_class
 from django.db import transaction
-from django.db.models.signals import m2m_changed, post_delete, post_save, pre_delete, pre_save
+from django.db.models.signals import m2m_changed, post_delete, post_migrate, post_save, pre_delete, pre_save
 from django.dispatch import receiver
 from django.utils import timezone
 from django_prometheus.models import model_deletes, model_inserts, model_updates
@@ -289,6 +289,19 @@ def _handle_deleted_object(sender, instance, **kwargs):
     model_deletes.labels(instance._meta.model_name).inc()
 
 
+#
+# Content types
+#
+
+
+@receiver(post_migrate)
+def post_migrate_clear_content_type_caches(sender, app_config, signal, **kwargs):
+    """Clear various content-type caches after a migration."""
+    with contextlib.suppress(redis.exceptions.ConnectionError):
+        cache.delete("nautobot.extras.utils.change_logged_models_queryset")
+        cache.delete_pattern("nautobot.extras.utils.FeatureQuery.*")
+
+
 #
 # Custom fields
 #

nautobot/extras/tables.py

@@ -1,5 +1,5 @@
 from django.conf import settings
-from django.utils.html import format_html
+from django.utils.html import format_html, format_html_join
 import django_tables2 as tables
 from django_tables2.utils import Accessor
 from jsonschema.exceptions import ValidationError as JSONSchemaValidationError
@@ -107,6 +107,11 @@ GITREPOSITORY_BUTTONS = """
 
 JOB_BUTTONS = """
 <a href="{% url 'extras:job' pk=record.pk %}" class="btn btn-default btn-xs" title="Details"><i class="mdi mdi-information-outline" aria-hidden="true"></i></a>
+<a href="{% url 'extras:jobresult_list' %}?job_model={{ record.name | urlencode }}" class="btn btn-default btn-xs" title="Job Results"><i class="mdi mdi-format-list-bulleted" aria-hidden="true"></i></a>
+"""
+
+SCHEDULED_JOB_BUTTONS = """
+<a href="{% url 'extras:jobresult_list' %}?scheduled_job={{ record.name | urlencode }}" class="btn btn-default btn-xs" title="Job Results"><i class="mdi mdi-format-list-bulleted" aria-hidden="true"></i></a>
 """
 
 OBJECTCHANGE_OBJECT = """
@@ -715,7 +720,10 @@ class JobTable(BaseTable):
         return render_markdown(value)
 
     def render_name(self, value):
-        return format_html('<span class="btn btn-primary btn-xs"><i class="mdi mdi-play"></i></span>{}', value)
+        return format_html(
+            '<span class="btn btn-primary btn-xs"><i class="mdi mdi-play"></i></span>{}',
+            value,
+        )
 
     class Meta(BaseTable.Meta):
         model = JobModel
@@ -831,6 +839,10 @@ class JobResultTable(BaseTable):
         orderable=False,
         attrs={"td": {"class": "text-nowrap report-stats"}},
     )
+    scheduled_job = tables.Column(
+        linkify=True,
+        verbose_name="Scheduled Job",
+    )
     actions = tables.TemplateColumn(
         template_code="""
             {% load helpers %}
@@ -880,6 +892,7 @@ class JobResultTable(BaseTable):
             "date_created",
             "name",
             "job_model",
+            "scheduled_job",
             "duration",
             "date_done",
             "user",
@@ -887,7 +900,16 @@ class JobResultTable(BaseTable):
             "summary",
             "actions",
         )
-        default_columns = ("pk", "date_created", "name", "job_model", "user", "status", "summary", "actions")
+        default_columns = (
+            "pk",
+            "date_created",
+            "name",
+            "job_model",
+            "user",
+            "status",
+            "summary",
+            "actions",
+        )
 
 
 class JobButtonTable(BaseTable):
@@ -957,10 +979,8 @@ class MetadataTypeTable(BaseTable):
 class ObjectMetadataTable(BaseTable):
     pk = ToggleColumn()
     metadata_type = tables.Column(linkify=True)
-    assigned_object = tables.TemplateColumn(template_code=ASSIGNED_OBJECT, orderable=False)
-    actions = ButtonsColumn(
-        ObjectMetadata,
-        buttons=("delete"),
+    assigned_object = tables.TemplateColumn(
+        template_code=ASSIGNED_OBJECT, verbose_name="Assigned object", orderable=False
     )
     # This is needed so that render_value method below does not skip itself
     # when metadata_type.data_type is TYPE_CONTACT_TEAM and we need it to display either contact or team
@@ -974,7 +994,6 @@ class ObjectMetadataTable(BaseTable):
             "metadata_type",
             "scoped_fields",
             "value",
-            "actions",
         )
         default_columns = (
             "pk",
@@ -982,11 +1001,12 @@ class ObjectMetadataTable(BaseTable):
             "scoped_fields",
             "value",
             "metadata_type",
-            "actions",
         )
 
-    def render_scoped_fields(self, record):
-        return render_json(record.scoped_fields, pretty_print=True)
+    def render_scoped_fields(self, value):
+        if not value:
+            return "(all fields)"
+        return format_html_join(", ", "<code>{}</code>", ([v] for v in sorted(value)))
 
     def render_value(self, record):
         if record.value is not None and record.metadata_type.data_type == MetadataTypeDataTypeChoices.TYPE_JSON:
@@ -1027,16 +1047,37 @@ class NoteTable(BaseTable):
 
 class ScheduledJobTable(BaseTable):
     pk = ToggleColumn()
-    name = tables.LinkColumn()
+    name = tables.Column(linkify=True)
     job_model = tables.Column(verbose_name="Job", linkify=True)
     interval = tables.Column(verbose_name="Execution Type")
-    start_time = tables.Column(verbose_name="First Run")
-    last_run_at = tables.Column(verbose_name="Most Recent Run")
+    start_time = tables.DateTimeColumn(verbose_name="First Run", format=settings.SHORT_DATETIME_FORMAT)
+    last_run_at = tables.DateTimeColumn(verbose_name="Most Recent Run", format=settings.SHORT_DATETIME_FORMAT)
+    crontab = tables.Column()
     total_run_count = tables.Column(verbose_name="Total Run Count")
+    actions = ButtonsColumn(ScheduledJob, buttons=("delete"), prepend_template=SCHEDULED_JOB_BUTTONS)
 
     class Meta(BaseTable.Meta):
         model = ScheduledJob
-        fields = ("pk", "name", "job_model", "interval", "start_time", "last_run_at")
+        fields = (
+            "pk",
+            "name",
+            "total_run_count",
+            "job_model",
+            "interval",
+            "start_time",
+            "last_run_at",
+            "crontab",
+            "time_zone",
+            "actions",
+        )
+        default_columns = (
+            "pk",
+            "name",
+            "job_model",
+            "interval",
+            "last_run_at",
+            "actions",
+        )
 
 
 class ScheduledJobApprovalQueueTable(BaseTable):
@@ -1108,7 +1149,15 @@ class RelationshipAssociationTable(BaseTable):
 
     class Meta(BaseTable.Meta):
         model = RelationshipAssociation
-        fields = ("pk", "relationship", "source_type", "source", "destination_type", "destination", "actions")
+        fields = (
+            "pk",
+            "relationship",
+            "source_type",
+            "source",
+            "destination_type",
+            "destination",
+            "actions",
+        )
         default_columns = ("pk", "relationship", "source", "destination", "actions")
 
 
@@ -1224,7 +1273,15 @@ class TagTable(BaseTable):
 
     class Meta(BaseTable.Meta):
         model = Tag
-        fields = ("pk", "name", "items", "color", "content_types", "description", "actions")
+        fields = (
+            "pk",
+            "name",
+            "items",
+            "color",
+            "content_types",
+            "description",
+            "actions",
+        )
 
 
 class TaggedItemTable(BaseTable):
@@ -1304,7 +1361,9 @@ class WebhookTable(BaseTable):
 class AssociatedContactsTable(StatusTableMixin, RoleTableMixin, BaseTable):
     pk = ToggleColumn()
     contact_type = tables.TemplateColumn(
-        CONTACT_OR_TEAM_ICON, verbose_name="Type", attrs={"td": {"style": "width:20px;"}}
+        CONTACT_OR_TEAM_ICON,
+        verbose_name="Type",
+        attrs={"td": {"style": "width:20px;"}},
     )
     name = tables.TemplateColumn(CONTACT_OR_TEAM, verbose_name="Name")
     contact_or_team_phone = tables.TemplateColumn(PHONE, accessor="contact_or_team.phone", verbose_name="Phone")

nautobot/extras/templates/extras/computedfield.html

@@ -20,6 +20,10 @@
                         <td>Key</td>
                         <td><span>{{ object.key }}</span></td>
                     </tr>
+                    <tr>
+                        <td>Grouping</td>
+                        <td>{{ object.grouping | placeholder }}</td>
+                    </tr>
                     <tr>
                         <td>Description</td>
                         <td><span>{{ object.description|placeholder }}</span></td>

nautobot/extras/templates/extras/job_detail.html

@@ -115,6 +115,17 @@
                 <td>{{ object.enabled | render_boolean }}</td>
                 <td></td>
             </tr>
+            <tr>
+                <td>Job Results</td>
+                <td>
+                    {% if object.job_results.exists %}
+                        <a href="{% url 'extras:jobresult_list' %}?job_model={{ object.name | urlencode }}">{{ object.job_results.count }}</a>
+                    {% else %}
+                        {{ None|placeholder }}
+                    {% endif %}
+                </td>
+                <td></td>
+            </tr>
         </table>
     </div>
 {% endblock content_left_page %}

nautobot/extras/templates/extras/scheduledjob.html

@@ -4,6 +4,7 @@
 {% load helpers %}
 {% load perms %}
 {% load plugins %}
+{% load tz %}
 
 {% block buttons %}
     {% plugin_buttons object %}
@@ -94,13 +95,23 @@
               <tr>
                   <td>Start Time</td>
                   <td>
-                      {{ object.start_time }}
+                      {{ object.start_time|timezone:object.time_zone|date:'Y-m-d H:i:s T' }}
+                      {% if default_time_zone != object.time_zone %}
+                          <br>{{ object.start_time|timezone:default_time_zone|date:'Y-m-d H:i:s T' }}
+                      {% endif %}
                   </td>
               </tr>
               <tr>
                   <td>Last Run At</td>
                   <td>
-                      {{ object.last_run_at|placeholder }}
+                      {% if object.last_run_at %}
+                          {{ object.last_run_at|timezone:object.time_zone|date:'Y-m-d H:i:s T' }}
+                          {% if default_time_zone != object.time_zone %}
+                              <br>{{ object.last_run_at|timezone:default_time_zone|date:'Y-m-d H:i:s T' }}
+                          {% endif %}
+                      {% else %}
+                          {{ object.last_run_at|placeholder }}
+                      {% endif %}
                   </td>
               </tr>
               <tr>