nautobot 2.4.16__py3-none-any.whl → 2.4.17__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/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/inc/job_table.html

@@ -1,4 +1,4 @@
-{% load django_tables2 %}
+{% load querystring from django_tables2 %}
 
 <table id="job_accordion" {% if table.attrs %} {{ table.attrs.as_html }}{% endif %}>
     {% if table.show_header %}

nautobot/extras/templates/extras/inc/object_contact_header.html

@@ -6,10 +6,10 @@
             <a href="{% url 'extras:object_contact_team_assign' %}{% querystring request %}">Assign Contact/Team</a>
         </li>
         <li role="presentation"{% if active_tab == 'contact' %} class="active"{% endif %}>
-            <a href="{% url 'extras:object_contact_add' %}{% querystring request %}">New Contact</a>
+            <a href="{% url 'extras:object_contact_add' %}{% legacy_querystring request %}">New Contact</a>
         </li>
         <li role="presentation"{% if active_tab == 'team' %} class="active"{% endif %}>
-            <a href="{% url 'extras:object_team_add' %}{% querystring request %}">New Team</a>
+            <a href="{% url 'extras:object_team_add' %}{% legacy_querystring request %}">New Team</a>
         </li>
     </ul>
 {% endblock %}

nautobot/extras/templates/extras/note_retrieve.html

@@ -1,53 +1,53 @@
-{% extends 'generic/object_retrieve.html' %}
-{% load buttons %}
-{% load plugins %}
-{% load perms %}
-{% load helpers %}
-
-{% block breadcrumbs %}
-    <li><a href="{% url 'extras:note_list' %}">Notes</a></li>
-    {% if object.assigned_object.get_absolute_url %}
-        <li><a href="{{ object.assigned_object.get_absolute_url }}notes/">{{ object.assigned_object }}</a></li>
-    {% endif %}
-    <li>{{ object }}</li>
-{% endblock breadcrumbs %}
-
-{% block content %}
-    <div class="row">
-        <div class="col-md-5">
-            <div class="panel panel-default">
-                <div class="panel-heading">
-                    <strong>Note</strong>
-                </div>
-                <table class="table table-hover panel-body attr-table">
-                    <tr>
-                        <td>User</td>
-                        <td>
-                            {{ object.user|default:object.user_name }}
-                        </td>
-                    </tr>
-                    <tr>
-                        <td>Object Type</td>
-                        <td>
-                            {{ object.assigned_object_type }}
-                        </td>
-                    </tr>
-                    <tr>
-                        <td>Object</td>
-                        <td>
-                            {{ object.assigned_object | hyperlinked_object }}
-                        </td>
-                    </tr>
-                </table>
-            </div>
-            <div class="panel panel-default">
-                <div class="panel-heading">
-                    <strong>Text</strong>
-                </div>
-                <div class="panel-body rendered-markdown">
-                    {{ object.note|render_markdown }}
-                </div>
-            </div>
-        </div>
-    </div>
-{% endblock %}
+{% extends 'generic/object_retrieve.html' %}
+{% load buttons %}
+{% load plugins %}
+{% load perms %}
+{% load helpers %}
+
+{% block breadcrumbs %}
+    <li><a href="{% url 'extras:note_list' %}">Notes</a></li>
+    {% if object.assigned_object.get_absolute_url %}
+        <li><a href="{{ object.assigned_object.get_absolute_url }}notes/">{{ object.assigned_object }}</a></li>
+    {% endif %}
+    <li>{{ object }}</li>
+{% endblock breadcrumbs %}
+
+{% block content %}
+    <div class="row">
+        <div class="col-md-5">
+            <div class="panel panel-default">
+                <div class="panel-heading">
+                    <strong>Note</strong>
+                </div>
+                <table class="table table-hover panel-body attr-table">
+                    <tr>
+                        <td>User</td>
+                        <td>
+                            {{ object.user|default:object.user_name }}
+                        </td>
+                    </tr>
+                    <tr>
+                        <td>Object Type</td>
+                        <td>
+                            {{ object.assigned_object_type }}
+                        </td>
+                    </tr>
+                    <tr>
+                        <td>Object</td>
+                        <td>
+                            {{ object.assigned_object | hyperlinked_object }}
+                        </td>
+                    </tr>
+                </table>
+            </div>
+            <div class="panel panel-default">
+                <div class="panel-heading">
+                    <strong>Text</strong>
+                </div>
+                <div class="panel-body rendered-markdown">
+                    {{ object.note|render_markdown }}
+                </div>
+            </div>
+        </div>
+    </div>
+{% endblock %}

nautobot/extras/templates/extras/tag_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/tag_update.html

@@ -1,15 +1,15 @@
-{% extends 'generic/object_create.html' %}
-{% load form_helpers %}
-
-{% block form %}
-    <div class="panel panel-default">
-        <div class="panel-heading"><strong>Tag</strong></div>
-        <div class="panel-body">
-            {% render_field form.name %}
-            {% render_field form.color %}
-            {% render_field form.description %}
-            {% render_field form.content_types %}
-        </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>Tag</strong></div>
+        <div class="panel-body">
+            {% render_field form.name %}
+            {% render_field form.color %}
+            {% render_field form.description %}
+            {% render_field form.content_types %}
+        </div>
+    </div>
+    {% include 'inc/extras_features_edit_form_fields.html' %}
 {% endblock %}

nautobot/extras/templates/extras/team_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 %}