nautobot 2.4.16__py3-none-any.whl → 2.4.18__py3-none-any.whl

nautobot/extras/models/customfields.py

@@ -13,6 +13,7 @@ from django.core.validators import RegexValidator, ValidationError
 from django.db import models, transaction
 from django.forms.widgets import TextInput
 from django.utils.html import format_html
+from jinja2 import TemplateError, TemplateSyntaxError
 
 from nautobot.core.constants import CHARFIELD_MAX_LENGTH
 from nautobot.core.forms import (
@@ -35,7 +36,7 @@ from nautobot.core.models.querysets import RestrictedQuerySet
 from nautobot.core.models.validators import validate_regex
 from nautobot.core.settings_funcs import is_truthy
 from nautobot.core.templatetags.helpers import render_markdown
-from nautobot.core.utils.data import render_jinja2
+from nautobot.core.utils.data import render_jinja2, validate_jinja2
 from nautobot.extras.choices import CustomFieldFilterLogicChoices, CustomFieldTypeChoices
 from nautobot.extras.models import ChangeLoggedModel
 from nautobot.extras.models.mixins import ContactMixin, DynamicGroupsModelMixin, NotesMixin, SavedViewMixin
@@ -84,6 +85,31 @@ class ComputedFieldManager(BaseManager.from_queryset(RestrictedQuerySet)):
             label = f"{ct.app_label}.{ct.model}"
             cache.set(f"{self.get_for_model.cache_key_prefix}.{label}.list", listings[label])
 
+    def bulk_create(self, objs, *args, **kwargs):
+        """Validate templates before saving."""
+        self._validate_templates_bulk(objs)
+        return super().bulk_create(objs, *args, **kwargs)
+
+    def bulk_update(self, objs, fields, *args, **kwargs):
+        """Validate templates before updating if template field is being modified."""
+        if "template" in fields:
+            self._validate_templates_bulk(objs)
+
+        return super().bulk_update(objs, fields, *args, **kwargs)
+
+    def _validate_templates_bulk(self, objs):
+        """Helper method to validate templates for multiple objects."""
+        errors = []
+        for obj in objs:
+            try:
+                obj.validate_template()
+            except ValidationError as exc:
+                message_list = [f"'{obj.label}': {x}" for x in exc.messages]
+                errors.extend(message_list)
+
+        if errors:
+            raise ValidationError(f"Template validation failed - {'; '.join(errors)}")
+
 
 @extras_features("graphql")
 class ComputedField(
@@ -144,14 +170,7 @@ class ComputedField(
 
     def render(self, context):
         try:
-            rendered = render_jinja2(self.template, context)
-            # If there is an undefined variable within a template, it returns nothing
-            # Doesn't raise an exception either most likely due to using Undefined rather
-            # than StrictUndefined, but return fallback_value if None is returned
-            if rendered is None:
-                logger.warning("Failed to render computed field %s", self.key)
-                return self.fallback_value
-            return rendered
+            return render_jinja2(self.template, context)
         except Exception as exc:
             logger.warning("Failed to render computed field %s: %s", self.key, exc)
             return self.fallback_value
@@ -162,9 +181,26 @@ class ComputedField(
 
     def clean(self):
         super().clean()
+
+        self.validate_template()
+
         if self.key != "":
             check_if_key_is_graphql_safe(self.__class__.__name__, self.key)
 
+    def validate_template(self):
+        """
+        Validate that the template contains valid Jinja2 syntax.
+        """
+        try:
+            validate_jinja2(self.template)
+        except TemplateSyntaxError as exc:
+            raise ValidationError({"template": f"Template syntax error on line {exc.lineno}: {exc.message}"})
+        except TemplateError as exc:
+            raise ValidationError({"template": f"Template error: {exc}"})
+        except Exception as exc:
+            # System-level exceptions (very rare) - memory, recursion, encoding issues
+            raise ValidationError(f"Template validation failed: {exc}")
+
 
 class CustomFieldModel(models.Model):
     """

nautobot/extras/models/groups.py

@@ -806,7 +806,16 @@ class DynamicGroup(PrimaryModel):
     def _get_group_queryset(self):
         """Construct the queryset representing dynamic membership of this group."""
         query = self.generate_query()
-        return self.model.objects.filter(query)
+        # https://github.com/nautobot/nautobot/issues/7631
+        #     Some queries may result in duplicate records, hence the need for `.distinct()`.
+        #     Use of `.distinct()` in general is a code smell and a performance hit, but given the wide variety of
+        #     filters that can be applied, support for both MySQL and PostgreSQL, and limitations of the Django ORM,
+        #     I don't see a clear alternative at this time.
+        #
+        #     Additionally, due to the use of `.distinct()`, in combination with our use of `.only("id")`
+        #     on this queryset, e.g. in `_set_members()`, we also need to override any default model ordering on the
+        #     queryset in order to avoid SQL errors like "each EXCEPT query must have the same number of columns"
+        return self.model.objects.filter(query).order_by("id").distinct()
 
     # TODO: unused in core
     def add_child(self, child, operator, weight):

nautobot/extras/models/jobs.py

@@ -48,7 +48,7 @@ from nautobot.extras.constants import (
 )
 from nautobot.extras.managers import JobResultManager, ScheduledJobsManager
 from nautobot.extras.models import ChangeLoggedModel, GitRepository
-from nautobot.extras.models.mixins import ContactMixin, DynamicGroupsModelMixin, NotesMixin
+from nautobot.extras.models.mixins import ContactMixin, DynamicGroupsModelMixin, NotesMixin, SavedViewMixin
 from nautobot.extras.querysets import JobQuerySet, ScheduledJobExtendedQuerySet
 from nautobot.extras.utils import (
     ChangeLoggedModelsQuery,
@@ -631,7 +631,7 @@ class JobQueueAssignment(BaseModel):
     "custom_links",
     "graphql",
 )
-class JobResult(BaseModel, CustomFieldModel):
+class JobResult(SavedViewMixin, BaseModel, CustomFieldModel):
     """
     This model stores the results from running a Job.
     """

nautobot/extras/plugins/views.py

@@ -86,10 +86,8 @@ class InstalledAppsView(GenericView):
     """
 
     table = InstalledAppsTable
-    breadcrumbs = Breadcrumbs(
-        items={"generic": [ViewNameBreadcrumbItem(view_name="apps:apps_list", label="Installed Apps")]}
-    )
-    view_titles = Titles(titles={"generic": "Installed Apps"})
+    breadcrumbs = Breadcrumbs(items={"*": [ViewNameBreadcrumbItem(view_name="apps:apps_list", label="Installed Apps")]})
+    view_titles = Titles(titles={"*": "Installed Apps"})
 
     def get(self, request):
         marketplace_data = load_marketplace_data()
@@ -129,7 +127,6 @@ class InstalledAppsView(GenericView):
                 "filter_form": None,
                 "app_icons": app_icons,
                 "display": display,
-                "view_action": "generic",
                 "breadcrumbs": self.breadcrumbs,
                 "view_titles": self.view_titles,
             },
@@ -141,6 +138,20 @@ class InstalledAppDetailView(GenericView):
     View for showing details of an installed App.
     """
 
+    breadcrumbs = Breadcrumbs(
+        items={
+            "*": [
+                ViewNameBreadcrumbItem(view_name="apps:apps_list", label="Installed Apps"),
+                ViewNameBreadcrumbItem(
+                    view_name="apps:app_detail",
+                    reverse_kwargs=lambda context: {"app": context["app_data"]["package"]},
+                    label=lambda context: context["app_data"]["name"],
+                ),
+            ]
+        }
+    )
+    view_titles = Titles(titles={"*": "{{ app_data.name | bettertitle }}"})
+
     def get(self, request, app=None, plugin=None):
         if plugin and not app:
             app = plugin
@@ -154,6 +165,8 @@ class InstalledAppDetailView(GenericView):
             {
                 "app_data": extract_app_data(app_config, load_marketplace_data()),
                 "object": app_config,
+                "breadcrumbs": self.breadcrumbs,
+                "view_titles": self.view_titles,
             },
         )
 

nautobot/extras/tables.py

@@ -736,11 +736,12 @@ class JobTable(BaseTable):
         accessor="latest_result",
         template_code="""
             {% if value %}
-                {{ value.date_created|date:settings.SHORT_DATETIME_FORMAT }} by {{ value.user }}
+                {{ value.date_created|date:SHORT_DATETIME_FORMAT }} by {{ value.user }}
             {% else %}
                 <span class="text-muted">Never</span>
             {% endif %}
         """,
+        extra_context={"SHORT_DATETIME_FORMAT": settings.SHORT_DATETIME_FORMAT},
         linkify=lambda value: value.get_absolute_url() if value else None,
     )
     last_status = tables.TemplateColumn(
@@ -906,6 +907,7 @@ class JobResultTable(BaseTable):
         linkify=True,
         verbose_name="Scheduled Job",
     )
+    duration = tables.Column(orderable=False)
     actions = ButtonsColumn(JobResult, buttons=("delete",), prepend_template=JOB_RESULT_BUTTONS)
 
     def __init__(self, *args, **kwargs):
@@ -1069,7 +1071,7 @@ class ObjectMetadataTable(BaseTable):
     )
     # 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
-    value = tables.Column(empty_values=[])
+    value = tables.Column(empty_values=[], order_by=("_value",))
 
     class Meta(BaseTable.Meta):
         model = ObjectMetadata

nautobot/extras/templates/extras/configcontext_retrieve.html

@@ -1,2 +1,2 @@
-{% extends 'generic/object_retrieve.html' %}
+{% extends 'generic/object_retrieve.html' %}
 {% comment %}3.0 TODO: remove this template, which only exists for backward compatibility with 2.4 and earlier{% endcomment %}

nautobot/extras/templates/extras/configcontext_update.html

@@ -1,50 +1,50 @@
-{% extends 'generic/object_create.html' %}
-{% load form_helpers %}
-
-{% block form %}
-    <div class="panel panel-default">
-        <div class="panel-heading"><strong>Config Context</strong></div>
-        <div class="panel-body">
-            {% render_field form.name %}
-            {% render_field form.weight %}
-            {% render_field form.description %}
-            {% render_field form.config_context_schema %}
-            {% render_field form.is_active %}
-        </div>
-    </div>
-    <div class="panel panel-default">
-        <div class="panel-heading"><strong>Assignment</strong></div>
-        <div class="panel-body">
-            {% render_field form.locations %}
-            {% render_field form.roles %}
-            {% render_field form.device_types %}
-            {% render_field form.platforms %}
-            {% render_field form.cluster_groups %}
-            {% render_field form.clusters %}
-            {% render_field form.tenant_groups %}
-            {% render_field form.tenants %}
-            {% render_field form.device_redundancy_groups %}
-            {% render_field form.tags %}
-            {% if settings.CONFIG_CONTEXT_DYNAMIC_GROUPS_ENABLED %}
-            {% render_field form.dynamic_groups %}
-            {% endif %}
-        </div>
-    </div>
-    <div class="panel panel-default">
-        <div class="panel-heading"><strong>Data</strong></div>
-        <div class="panel-body">
-            {% render_field form.data %}
-        </div>
-    </div>
-    {% comment %}
-    We don't use 'inc/extras_features_edit_form_fields.html' because it would add a second,
-    and incorrect, "Tags" field to the form. Currently config-contexts don't support custom-fields or relationships,
-    but they do support notes.
-    {% endcomment %}
-    <div class="panel panel-default">
-        <div class="panel-heading"><strong>Notes</strong></div>
-        <div class="panel-body">
-            {% render_field form.object_note %}
-        </div>
-    </div>
+{% extends 'generic/object_create.html' %}
+{% load form_helpers %}
+
+{% block form %}
+    <div class="panel panel-default">
+        <div class="panel-heading"><strong>Config Context</strong></div>
+        <div class="panel-body">
+            {% render_field form.name %}
+            {% render_field form.weight %}
+            {% render_field form.description %}
+            {% render_field form.config_context_schema %}
+            {% render_field form.is_active %}
+        </div>
+    </div>
+    <div class="panel panel-default">
+        <div class="panel-heading"><strong>Assignment</strong></div>
+        <div class="panel-body">
+            {% render_field form.locations %}
+            {% render_field form.roles %}
+            {% render_field form.device_types %}
+            {% render_field form.platforms %}
+            {% render_field form.cluster_groups %}
+            {% render_field form.clusters %}
+            {% render_field form.tenant_groups %}
+            {% render_field form.tenants %}
+            {% render_field form.device_redundancy_groups %}
+            {% render_field form.tags %}
+            {% if settings.CONFIG_CONTEXT_DYNAMIC_GROUPS_ENABLED %}
+            {% render_field form.dynamic_groups %}
+            {% endif %}
+        </div>
+    </div>
+    <div class="panel panel-default">
+        <div class="panel-heading"><strong>Data</strong></div>
+        <div class="panel-body">
+            {% render_field form.data %}
+        </div>
+    </div>
+    {% comment %}
+    We don't use 'inc/extras_features_edit_form_fields.html' because it would add a second,
+    and incorrect, "Tags" field to the form. Currently config-contexts don't support custom-fields or relationships,
+    but they do support notes.
+    {% endcomment %}
+    <div class="panel panel-default">
+        <div class="panel-heading"><strong>Notes</strong></div>
+        <div class="panel-body">
+            {% render_field form.object_note %}
+        </div>
+    </div>
 {% endblock %}

nautobot/extras/templates/extras/configcontextschema_retrieve.html

@@ -1,48 +1,48 @@
-{% extends 'generic/object_retrieve.html' %}
-{% load buttons %}
-{% load plugins %}
-{% load helpers %}
-
-{% block extra_nav_tabs %}
-    <li role="presentation"{% if active_tab == 'validation' %} class="active"{% endif %}>
-        <a href="{% url 'extras:configcontextschema_object_validation' pk=object.pk %}">Validation</a>
-    </li>
-{% endblock extra_nav_tabs %}
-
-{% block content_left_page %}
-            <div class="panel panel-default">
-                <div class="panel-heading">
-                    <strong>Config Context Schema</strong>
-                </div>
-                <table class="table table-hover panel-body attr-table">
-                    <tr>
-                        <td>Name</td>
-                        <td>
-                            {{ object.name }}
-                        </td>
-                    </tr>
-                    {% if object.owner %}
-                        <tr>
-                            <td>Owner</td>
-                            <td>{{ object.owner|hyperlinked_object }}</td>
-                        </tr>
-                    {% endif %}
-                    <tr>
-                        <td>Description</td>
-                        <td>{{ object.description|placeholder }}</td>
-                    </tr>
-                </table>
-            </div>
-{% endblock content_left_page %}
-
-{% block content_right_page %}
-            <div class="panel panel-default">
-                <div class="panel-heading">
-                    <strong>Data Schema</strong>
-                    {% include 'extras/inc/configcontext_format.html' %}
-                </div>
-                <div class="panel-body">
-                    {% include 'extras/inc/json_data.html' with data=object.data_schema format=data_format %}
-                </div>
-            </div>
+{% extends 'generic/object_retrieve.html' %}
+{% load buttons %}
+{% load plugins %}
+{% load helpers %}
+
+{% block extra_nav_tabs %}
+    <li role="presentation"{% if active_tab == 'validation' %} class="active"{% endif %}>
+        <a href="{% url 'extras:configcontextschema_object_validation' pk=object.pk %}">Validation</a>
+    </li>
+{% endblock extra_nav_tabs %}
+
+{% block content_left_page %}
+            <div class="panel panel-default">
+                <div class="panel-heading">
+                    <strong>Config Context Schema</strong>
+                </div>
+                <table class="table table-hover panel-body attr-table">
+                    <tr>
+                        <td>Name</td>
+                        <td>
+                            {{ object.name }}
+                        </td>
+                    </tr>
+                    {% if object.owner %}
+                        <tr>
+                            <td>Owner</td>
+                            <td>{{ object.owner|hyperlinked_object }}</td>
+                        </tr>
+                    {% endif %}
+                    <tr>
+                        <td>Description</td>
+                        <td>{{ object.description|placeholder }}</td>
+                    </tr>
+                </table>
+            </div>
+{% endblock content_left_page %}
+
+{% block content_right_page %}
+            <div class="panel panel-default">
+                <div class="panel-heading">
+                    <strong>Data Schema</strong>
+                    {% include 'extras/inc/configcontext_format.html' %}
+                </div>
+                <div class="panel-body">
+                    {% include 'extras/inc/json_data.html' with data=object.data_schema format=data_format %}
+                </div>
+            </div>
 {% endblock content_right_page %}

nautobot/extras/templates/extras/configcontextschema_update.html

@@ -1,19 +1,19 @@
-{% extends 'generic/object_create.html' %}
-{% load form_helpers %}
-
-{% block form %}
-    <div class="panel panel-default">
-        <div class="panel-heading"><strong>Config Context Schema</strong></div>
-        <div class="panel-body">
-            {% render_field form.name %}
-            {% render_field form.description %}
-        </div>
-    </div>
-    <div class="panel panel-default">
-        <div class="panel-heading"><strong>Data Schema</strong></div>
-        <div class="panel-body">
-            {% render_field form.data_schema %}
-        </div>
-    </div>
-    {% include 'inc/extras_features_edit_form_fields.html' %}
+{% extends 'generic/object_create.html' %}
+{% load form_helpers %}
+
+{% block form %}
+    <div class="panel panel-default">
+        <div class="panel-heading"><strong>Config Context Schema</strong></div>
+        <div class="panel-body">
+            {% render_field form.name %}
+            {% render_field form.description %}
+        </div>
+    </div>
+    <div class="panel panel-default">
+        <div class="panel-heading"><strong>Data Schema</strong></div>
+        <div class="panel-body">
+            {% render_field form.data_schema %}
+        </div>
+    </div>
+    {% include 'inc/extras_features_edit_form_fields.html' %}
 {% endblock %}

nautobot/extras/templates/extras/customfield_retrieve.html

@@ -1,129 +1,2 @@
 {% extends 'generic/object_retrieve.html' %}
-{% load buttons %}
-{% load helpers %}
-
-{% block content_left_page %}
-            <div class="panel panel-default">
-                <div class="panel-heading">
-                    <strong>Custom Field</strong>
-                </div>
-                <table class="table table-hover panel-body attr-table">
-                    <tr>
-                        <td>Label</td>
-                        <td>{{ object.label }}</td>
-                    </tr>
-                    <tr>
-                        <td>Key</td>
-                        <td>{{ object.key }}</td>
-                    </tr>
-                    <tr>
-                        <td>Type</td>
-                        <td>{{ object.type | capfirst }}</td>
-                    </tr>
-                    <tr>
-                        <td>Weight</td>
-                        <td>{{ object.weight }}</td>
-                    </tr>
-                    <tr>
-                        <td>Grouping</td>
-                        <td>{{ object.grouping | placeholder }}</td>
-                    </tr>
-                    <tr>
-                        <td>Description</td>
-                        <td>{{ object.description | render_markdown | placeholder }}</td>
-                    </tr>
-                    <tr>
-                        <td>Required</td>
-                        <td>{{ object.required | render_boolean }}</td>
-                    </tr>
-                    <tr>
-                        <td>Default</td>
-                        <td>
-                            {% if object.type == "markdown" %}
-                                {{ object.default | render_markdown | placeholder }}
-                            {% elif object.type == "json" and object.default is not None %}
-                                <pre>{{ object.default | render_json }}</pre>
-                            {% else %}
-                                {{ object.default | placeholder }}
-                            {% endif %}
-                        </td>
-                    </tr>
-                    <tr>
-                        <td>Filter Logic</td>
-                        <td>{{ object.filter_logic | capfirst }}</td>
-                    </tr>
-                    <tr>
-                        <td>Move to Advanced Tab</td>
-                        <td>{{ object.advanced_ui | render_boolean }}</td>
-                    </tr>
-                </table>
-            </div>
-            {% if object.custom_field_choices.exists %}
-            <div class="panel panel-default">
-                <div class="panel-heading">
-                    <strong>Custom Field Choices</strong>
-                </div>
-                <table class="table table-hover panel-body attr-table">
-                    <thead>
-                        <tr>
-                            <th>Value</th>
-                            <th>Weight</th>
-                        </tr>
-                    </thead>
-                    <tbody>
-                    {% for choice in object.custom_field_choices.all %}
-                        <tr>
-                            <td>{{ choice.value }}</td>
-                            <td>{{ choice.weight }}</td>
-                        </tr>
-                    {% endfor %}
-                    </tbody>
-                </table>
-            </div>
-            {% endif %}
-{% endblock content_left_page %}
-
-{% block content_right_page %}
-            <div class="panel panel-default">
-                <div class="panel-heading">
-                    <strong>Assignment</strong>
-                </div>
-                <table class="table table-hover panel-body attr-table">
-                    <tr>
-                        <td>Content Types</td>
-                        <td>
-                            <ul>
-                                {% for ct in object.content_types.all %}
-                                    <li>{{ ct }}</li>
-                                {% endfor %}
-                            </ul>
-                        </td>
-                    </tr>
-                </table>
-            </div>
-            <div class="panel panel-default">
-                <div class="panel-heading">
-                    <strong>Validation Rules</strong>
-                </div>
-                <table class="table table-hover panel-body attr-table">
-                    <tr>
-                        <td>Minimum Value/Length</td>
-                        <td>{{ object.validation_minimum | placeholder }}</td>
-                    </tr>
-                    <tr>
-                        <td>Maximum Value/Length</td>
-                        <td>{{ object.validation_maximum | placeholder }}</td>
-                    </tr>
-                    <tr>
-                        <td>Validation Regex</td>
-                        <td>
-                            {% if object.validation_regex %}
-                                <code>{{ object.validation_regex | placeholder }}</code>
-                            {% else %}
-                                {{ object.validation_regex | placeholder }}
-                            {% endif %}
-                        </td>
-                    </tr>
-                </table>
-            </div>
-{% endblock content_right_page %}
+{% comment %}3.0 TODO: remove this template, which only exists for backward compatibility with 2.4 and earlier{% endcomment %}