nautobot 2.4.12__py3-none-any.whl → 2.4.14__py3-none-any.whl

nautobot/extras/templates/extras/graphqlquery.html

@@ -1,97 +1,2 @@
-{% extends 'generic/object_retrieve.html' %}
-{% load helpers %}
-
-{% block content_left_page %}
-        <div class="panel panel-default">
-            <div class="panel-heading">
-                <strong>Query</strong>
-            </div>
-            <table class="table table-hover panel-body attr-table">
-                <tr>
-                    <td>Name</td>
-                    <td><span>{{ object.name }}</span></td>
-                </tr>
-                <tr>
-                    <td>Query</td>
-                    <td><pre id="query"><code class="language-graphql">{{ object.query }}</code></pre></td>
-                </tr>
-                <tr>
-                    <td>Query Variables</td>
-                    <td><pre>{{ object.variables|render_json }}</pre></td>
-                </tr>
-            </table>
-        </div>
-{% endblock content_left_page %}
-
-{% block content_right_page %}
-        <div class="panel panel-default">
-            <div class="panel-heading">
-                <strong>Response</strong>
-                <button class="btn btn-primary btn-xs pull-right" onclick="test_query()">Execute</button>
-            </div>
-            {% if object.variables %}
-                <table class="table table-hover panel-body attr-table">
-                    <tr>
-                        <td>Variables:</td>
-                        <td><textarea id="query_variables" class="form-control">{{ object.variables|render_json:False }}</textarea></td>
-                    </tr>
-                </table>
-            {% endif %}
-            <div class="panel-footer">
-                <pre id="query_output">
-
-                </pre>
-            </div>
-        </div>
-{% endblock content_right_page %}
-
-{% block javascript %}
-{{ block.super }}
-<script>
-    function fillQueryOutput(data) {
-        const queryOutput = document.querySelector('#query_output');
-
-        [...queryOutput.childNodes].forEach(childNode => childNode.remove());
-
-        const code = document.createElement('code');
-        code.classList.add('language-json');
-        code.textContent = JSON.stringify(data, undefined, 2);
-
-        queryOutput.appendChild(code);
-
-        hljs.highlightElement(code);
-    }
-
-    function test_query() {
-        const variables = document.querySelector('#query_variables')?.value;
-
-        $.ajax({
-            url: "{% url 'graphql' %}",
-            method: "POST",
-            headers: {"X-CSRFTOKEN": "{{ csrf_token }}"},
-            dataType: "json",
-            data: {
-                "query": `{{ object.query | escapejs }}`,
-                "variables": variables,
-            },
-            success: function(data) {
-                fillQueryOutput(data);
-            },
-            error: function(error) {
-                console.log(error);
-                fillQueryOutput(error.responseJSON);
-            }
-        });
-    };
-
-    textarea = document.querySelector("#query_variables");
-    textarea.addEventListener('input', autoResize, false);
-    textarea.style.height = 'auto';
-    textarea.style.height = textarea.scrollHeight + 'px';
-
-    function autoResize() {
-        this.style.height = 'auto';
-        this.style.height = this.scrollHeight + 'px';
-    }
-</script>
-{% endblock javascript %}
+{% extends 'extras/graphqlquery_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/graphqlquery_list.html

@@ -0,0 +1 @@
+{% extends "generic/object_list.html" %}

nautobot/extras/templates/extras/graphqlquery_retrieve.html

@@ -0,0 +1,97 @@
+{% extends 'generic/object_retrieve.html' %}
+{% load helpers %}
+
+{% block content_left_page %}
+        <div class="panel panel-default">
+            <div class="panel-heading">
+                <strong>Query</strong>
+            </div>
+            <table class="table table-hover panel-body attr-table">
+                <tr>
+                    <td>Name</td>
+                    <td><span>{{ object.name }}</span></td>
+                </tr>
+                <tr>
+                    <td>Query</td>
+                    <td><pre id="query"><code class="language-graphql">{{ object.query }}</code></pre></td>
+                </tr>
+                <tr>
+                    <td>Query Variables</td>
+                    <td><pre>{{ object.variables|render_json }}</pre></td>
+                </tr>
+            </table>
+        </div>
+{% endblock content_left_page %}
+
+{% block content_right_page %}
+        <div class="panel panel-default">
+            <div class="panel-heading">
+                <strong>Response</strong>
+                <button class="btn btn-primary btn-xs pull-right" onclick="test_query()">Execute</button>
+            </div>
+            {% if object.variables %}
+                <table class="table table-hover panel-body attr-table">
+                    <tr>
+                        <td>Variables:</td>
+                        <td><textarea id="query_variables" class="form-control">{{ object.variables|render_json:False }}</textarea></td>
+                    </tr>
+                </table>
+            {% endif %}
+            <div class="panel-footer">
+                <pre id="query_output">
+
+                </pre>
+            </div>
+        </div>
+{% endblock content_right_page %}
+
+{% block javascript %}
+{{ block.super }}
+<script>
+    function fillQueryOutput(data) {
+        const queryOutput = document.querySelector('#query_output');
+
+        [...queryOutput.childNodes].forEach(childNode => childNode.remove());
+
+        const code = document.createElement('code');
+        code.classList.add('language-json');
+        code.textContent = JSON.stringify(data, undefined, 2);
+
+        queryOutput.appendChild(code);
+
+        hljs.highlightElement(code);
+    }
+
+    function test_query() {
+        const variables = document.querySelector('#query_variables')?.value;
+
+        $.ajax({
+            url: "{% url 'graphql' %}",
+            method: "POST",
+            headers: {"X-CSRFTOKEN": "{{ csrf_token }}"},
+            dataType: "json",
+            data: {
+                "query": `{{ object.query | escapejs }}`,
+                "variables": variables,
+            },
+            success: function(data) {
+                fillQueryOutput(data);
+            },
+            error: function(error) {
+                console.log(error);
+                fillQueryOutput(error.responseJSON);
+            }
+        });
+    };
+
+    textarea = document.querySelector("#query_variables");
+    textarea.addEventListener('input', autoResize, false);
+    textarea.style.height = 'auto';
+    textarea.style.height = textarea.scrollHeight + 'px';
+
+    function autoResize() {
+        this.style.height = 'auto';
+        this.style.height = this.scrollHeight + 'px';
+    }
+</script>
+{% endblock javascript %}

nautobot/extras/templates/extras/secretsgroup.html

@@ -1,29 +1,2 @@
-{% extends "generic/object_retrieve.html" %}
-{% load helpers %}
-
-{% block content_left_page %}
-    <div class="panel panel-default">
-        <div class="panel-heading">
-            <strong>Secrets Group</strong>
-        </div>
-        <table class="table table-hover panel-body attr-table">
-            <tr>
-                <td>Description</td>
-                <td colspan="3">{{ object.description | placeholder }}</td>
-            </tr>
-            <tr>
-                <td rowspan="{{ secrets_group_associations | length | add:'1'}}">Secrets</td>
-                <th>Access Type</th>
-                <th>Secret Type</th>
-                <th>Secret</th>
-            </tr>
-            {% for secret_association in secrets_group_associations %}
-                <tr>
-                    <td>{{ secret_association.access_type }}</td>
-                    <td>{{ secret_association.secret_type | bettertitle }}</td>
-                    <td>{{ secret_association.secret|hyperlinked_object }}</td>
-                </tr>
-            {% endfor %}
-        </table>
-    </div>
-{% endblock content_left_page %}
+{% extends "extras/secretsgroup_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/secretsgroup_edit.html

@@ -1,82 +1,2 @@
-{% extends 'generic/object_create.html' %}
-{% load static %}
-{% load form_helpers %}
-
-{% block form %}
-    <div class="panel panel-default">
-        <div class="panel-heading"><strong>Secrets Group</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>Secret Assignment</strong></div>
-        <div class="panel-body">
-            {% if secrets.errors %}
-                <div class="text-danger">
-                    Please correct the error(s) below:
-
-                    {% for secret in secrets.forms %}
-                        {% if secret.errors %}
-                            {% for error in secret.errors.values %}{{ error }}{% endfor %}
-                        {% endif %}
-                    {% endfor %}
-                </div>
-            {% endif %}
-            {{ secrets.non_field_errors }}
-            <table class="table" id="secrets">
-                {{ secrets.management_form }}
-                {% for secret_form in secrets.forms %}
-                    {% if forloop.first %}
-                        <thead>
-                            <tr>
-                                {% for field in secret_form.visible_fields %}
-                                    <th>{{ field.label|capfirst }}</th>
-                                {% endfor %}
-                            </tr>
-                        </thead>
-                    {% endif %}
-                    <tr class="formset_row-{{ secrets.prefix }}">
-                        {% for field in secret_form.visible_fields %}
-                            <td>
-                                {% if forloop.first %}
-                                    {% for hidden in secret_form.hidden_fields %}
-                                        {{ hidden }}
-                                    {% endfor %}
-                                {% endif %}
-                                {{ field }}
-                                {% if field.errors %}
-                                    <ul>
-                                        {% for error in field.errors %}
-                                            {# Embed an HTML comment indicating the error for extraction by tests #}
-                                            <!-- FORM-ERROR {{ field.name }}: {{ error }} -->
-                                            <li class="text-danger">{{ error }}</li>
-                                        {% endfor %}
-                                    </ul>
-                                {% endif %}
-                            </td>
-                        {% endfor %}
-                    </tr>
-                {% endfor %}
-            </table>
-        </div>
-    </div>
-    {% include "inc/extras_features_edit_form_fields.html" %}
-{% endblock form %}
-
-{% block javascript %}
-{{ block.super }}
-<script src="{% static 'jquery/jquery.formset.js' %}"></script>
-<script type="text/javascript">
-    $('.formset_row-{{ secrets.prefix }}').formset({
-        addText: '<span class="mdi mdi-plus-thick" aria-hidden="true"></span> Add another Secret',
-        addCssClass: 'btn btn-primary add-row',
-        deleteText: '<span class="mdi mdi-trash-can-outline" aria-hidden="true"></span>',
-        deleteCssClass: 'btn btn-danger delete-row',
-        prefix: '{{ secrets.prefix }}',
-        formCssClass: 'dynamic-formset-{{ secrets.prefix }}',
-        added: jsify_form
-    });
-</script>
-{% endblock javascript %}
+{% extends 'extras/secretsgroup_update.html' %}
+{% comment %}3.0 TODO: remove this template, which only exists for backward compatibility with 2.4 and earlier{% endcomment %}

nautobot/extras/templates/extras/secretsgroup_retrieve.html

@@ -0,0 +1,29 @@
+{% extends "generic/object_retrieve.html" %}
+{% load helpers %}
+
+{% block content_left_page %}
+    <div class="panel panel-default">
+        <div class="panel-heading">
+            <strong>Secrets Group</strong>
+        </div>
+        <table class="table table-hover panel-body attr-table">
+            <tr>
+                <td>Description</td>
+                <td colspan="3">{{ object.description | placeholder }}</td>
+            </tr>
+            <tr>
+                <td rowspan="{{ secrets_group_associations | length | add:'1'}}">Secrets</td>
+                <th>Access Type</th>
+                <th>Secret Type</th>
+                <th>Secret</th>
+            </tr>
+            {% for secret_association in secrets_group_associations %}
+                <tr>
+                    <td>{{ secret_association.access_type }}</td>
+                    <td>{{ secret_association.secret_type | bettertitle }}</td>
+                    <td>{{ secret_association.secret|hyperlinked_object }}</td>
+                </tr>
+            {% endfor %}
+        </table>
+    </div>
+{% endblock content_left_page %}

nautobot/extras/templates/extras/secretsgroup_update.html

@@ -0,0 +1,82 @@
+{% extends 'generic/object_create.html' %}
+{% load static %}
+{% load form_helpers %}
+
+{% block form %}
+    <div class="panel panel-default">
+        <div class="panel-heading"><strong>Secrets Group</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>Secret Assignment</strong></div>
+        <div class="panel-body">
+            {% if secrets.errors %}
+                <div class="text-danger">
+                    Please correct the error(s) below:
+
+                    {% for secret in secrets.forms %}
+                        {% if secret.errors %}
+                            {% for error in secret.errors.values %}{{ error }}{% endfor %}
+                        {% endif %}
+                    {% endfor %}
+                </div>
+            {% endif %}
+            {{ secrets.non_field_errors }}
+            <table class="table" id="secrets">
+                {{ secrets.management_form }}
+                {% for secret_form in secrets.forms %}
+                    {% if forloop.first %}
+                        <thead>
+                            <tr>
+                                {% for field in secret_form.visible_fields %}
+                                    <th>{{ field.label|capfirst }}</th>
+                                {% endfor %}
+                            </tr>
+                        </thead>
+                    {% endif %}
+                    <tr class="formset_row-{{ secrets.prefix }}">
+                        {% for field in secret_form.visible_fields %}
+                            <td>
+                                {% if forloop.first %}
+                                    {% for hidden in secret_form.hidden_fields %}
+                                        {{ hidden }}
+                                    {% endfor %}
+                                {% endif %}
+                                {{ field }}
+                                {% if field.errors %}
+                                    <ul>
+                                        {% for error in field.errors %}
+                                            {# Embed an HTML comment indicating the error for extraction by tests #}
+                                            <!-- FORM-ERROR {{ field.name }}: {{ error }} -->
+                                            <li class="text-danger">{{ error }}</li>
+                                        {% endfor %}
+                                    </ul>
+                                {% endif %}
+                            </td>
+                        {% endfor %}
+                    </tr>
+                {% endfor %}
+            </table>
+        </div>
+    </div>
+    {% include "inc/extras_features_edit_form_fields.html" %}
+{% endblock form %}
+
+{% block javascript %}
+{{ block.super }}
+<script src="{% static 'jquery/jquery.formset.js' %}"></script>
+<script type="text/javascript">
+    $('.formset_row-{{ secrets.prefix }}').formset({
+        addText: '<span class="mdi mdi-plus-thick" aria-hidden="true"></span> Add another Secret',
+        addCssClass: 'btn btn-primary add-row',
+        deleteText: '<span class="mdi mdi-trash-can-outline" aria-hidden="true"></span>',
+        deleteCssClass: 'btn btn-danger delete-row',
+        prefix: '{{ secrets.prefix }}',
+        formCssClass: 'dynamic-formset-{{ secrets.prefix }}',
+        added: jsify_form
+    });
+</script>
+{% endblock javascript %}

nautobot/extras/tests/test_customfields.py

@@ -4,7 +4,7 @@ import logging
 from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ValidationError
-from django.db.models import ProtectedError
+from django.db.models import ProtectedError, QuerySet
 from django.forms import ChoiceField, IntegerField, NumberInput
 from django.urls import reverse
 from rest_framework import status
@@ -400,28 +400,46 @@ class CustomFieldTest(ModelTestCases.BaseModelTestCase, TestCase):
 class CustomFieldManagerTest(TestCase):
     def setUp(self):
         self.content_type = ContentType.objects.get_for_model(Location)
-        custom_field = CustomField(type=CustomFieldTypeChoices.TYPE_TEXT, label="Text Field", default="foo")
+        custom_field = CustomField(
+            type=CustomFieldTypeChoices.TYPE_TEXT,
+            label="Text Field",
+            default="foo",
+            filter_logic=CustomFieldFilterLogicChoices.FILTER_DISABLED,
+        )
         custom_field.save()
         custom_field.content_types.set([self.content_type])
 
     def test_get_for_model(self):
         self.assertEqual(CustomField.objects.get_for_model(Location).count(), 2)
         self.assertEqual(CustomField.objects.get_for_model(VirtualMachine).count(), 0)
+        self.assertEqual(len(CustomField.objects.get_for_model(Location, get_queryset=False)), 2)
+        self.assertEqual(len(CustomField.objects.get_for_model(VirtualMachine, get_queryset=False)), 0)
 
     def test_get_for_model_caching_and_cache_invalidation(self):
         """Test that the cache is used and is properly invalidated when CustomFields are created or deleted."""
         # Assert that the cache is used when calling get_for_model a second time
         CustomField.objects.get_for_model(Location)
         with self.assertNumQueries(0):
-            CustomField.objects.get_for_model(Location)
+            qs = CustomField.objects.get_for_model(Location)
+        with self.assertNumQueries(0):
+            listing = CustomField.objects.get_for_model(Location, get_queryset=False)
+        self.assertIsInstance(qs, QuerySet)
+        self.assertIsInstance(listing, list)
+        self.assertQuerysetEqualAndNotEmpty(qs, listing)
 
         # Assert that different values of exclude_filter_disabled are cached separately
         with self.assertNumQueries(1):
             CustomField.objects.get_for_model(Location, exclude_filter_disabled=True)
         with self.assertNumQueries(0):
-            CustomField.objects.get_for_model(Location, exclude_filter_disabled=True)
+            qs = CustomField.objects.get_for_model(Location, exclude_filter_disabled=True)
+        with self.assertNumQueries(0):
+            listing = CustomField.objects.get_for_model(Location, exclude_filter_disabled=True, get_queryset=False)
         with self.assertNumQueries(0):
             CustomField.objects.get_for_model(Location)
+        self.assertIsInstance(qs, QuerySet)
+        self.assertIsInstance(listing, list)
+        self.assertEqual(1, len(listing))
+        self.assertQuerysetEqualAndNotEmpty(qs, listing)
 
         # Assert that different models are cached separately
         with self.assertNumQueries(1):
@@ -444,21 +462,111 @@ class CustomFieldManagerTest(TestCase):
         with self.assertNumQueries(1):
             CustomField.objects.get_for_model(Location)
         with self.assertNumQueries(0):
-            CustomField.objects.get_for_model(Location)
+            qs = CustomField.objects.get_for_model(Location)
+        with self.assertNumQueries(0):
+            listing = CustomField.objects.get_for_model(Location, get_queryset=False)
+        self.assertIsInstance(qs, QuerySet)
+        self.assertIsInstance(listing, list)
+        self.assertEqual(3, len(listing))
+        self.assertQuerysetEqualAndNotEmpty(qs, listing)
 
         # Assert that the cache is invalidated when removing a CustomField.content_types m2m relationship
         custom_field.content_types.set([])
         with self.assertNumQueries(1):
             CustomField.objects.get_for_model(Location)
         with self.assertNumQueries(0):
-            CustomField.objects.get_for_model(Location)
+            qs = CustomField.objects.get_for_model(Location)
+        with self.assertNumQueries(0):
+            listing = CustomField.objects.get_for_model(Location, get_queryset=False)
+        self.assertIsInstance(qs, QuerySet)
+        self.assertIsInstance(listing, list)
+        self.assertEqual(2, len(listing))
+        self.assertQuerysetEqualAndNotEmpty(qs, listing)
 
         # Assert that the cache is invalidated on object delete
         custom_field.delete()
         with self.assertNumQueries(1):
             CustomField.objects.get_for_model(Location)
         with self.assertNumQueries(0):
-            CustomField.objects.get_for_model(Location)
+            qs = CustomField.objects.get_for_model(Location)
+        with self.assertNumQueries(0):
+            listing = CustomField.objects.get_for_model(Location, get_queryset=False)
+        self.assertIsInstance(qs, QuerySet)
+        self.assertIsInstance(listing, list)
+        self.assertEqual(2, len(listing))
+        self.assertQuerysetEqualAndNotEmpty(qs, listing)
+
+
+class ComputedFieldManagerTestCase(TestCase):
+    def setUp(self):
+        self.content_type = ContentType.objects.get_for_model(Location)
+        ComputedField.objects.create(
+            content_type=ContentType.objects.get_for_model(Location),
+            key="computed_field_one",
+            label="Computed Field One",
+            template="{{ obj.name }} is the name of this location.",
+            fallback_value="An error occurred while rendering this template.",
+            weight=100,
+        )
+
+    def test_get_for_model(self):
+        self.assertEqual(ComputedField.objects.get_for_model(Location).count(), 1)
+        self.assertEqual(ComputedField.objects.get_for_model(VirtualMachine).count(), 0)
+        self.assertEqual(len(ComputedField.objects.get_for_model(Location, get_queryset=False)), 1)
+        self.assertEqual(len(ComputedField.objects.get_for_model(VirtualMachine, get_queryset=False)), 0)
+
+    def test_get_for_model_caching_and_cache_invalidation(self):
+        # Assert that the cache is used when calling get_for_model a second time
+        ComputedField.objects.get_for_model(Location)
+        with self.assertNumQueries(0):
+            qs = ComputedField.objects.get_for_model(Location)
+        with self.assertNumQueries(0):
+            listing = ComputedField.objects.get_for_model(Location, get_queryset=False)
+        self.assertIsInstance(qs, QuerySet)
+        self.assertIsInstance(listing, list)
+        self.assertEqual(1, len(listing))
+        self.assertQuerysetEqualAndNotEmpty(qs, listing)
+
+        # Assert that different models are cached separately
+        with self.assertNumQueries(1):
+            ComputedField.objects.get_for_model(VirtualMachine)
+        with self.assertNumQueries(0):
+            ComputedField.objects.get_for_model(VirtualMachine)
+        with self.assertNumQueries(0):
+            ComputedField.objects.get_for_model(Location)
+
+        # Assert that the cache is invalidated on object save
+        computed_field = ComputedField.objects.create(
+            content_type=ContentType.objects.get_for_model(Location),
+            key="computed_field_two",
+            label="Computed Field Two",
+            template="{{ obj.name }} is still jthe name of this location.",
+            fallback_value="An error occurred while rendering this template.",
+            weight=200,
+        )
+        with self.assertNumQueries(1):
+            ComputedField.objects.get_for_model(Location)
+        with self.assertNumQueries(0):
+            qs = ComputedField.objects.get_for_model(Location)
+        with self.assertNumQueries(0):
+            listing = ComputedField.objects.get_for_model(Location, get_queryset=False)
+        self.assertIsInstance(qs, QuerySet)
+        self.assertIsInstance(listing, list)
+        self.assertEqual(2, len(listing))
+        self.assertQuerysetEqualAndNotEmpty(qs, listing)
+
+        # Assert that the cache is invalided on object delete
+        computed_field.delete()
+        with self.assertNumQueries(1):
+            ComputedField.objects.get_for_model(Location)
+        with self.assertNumQueries(0):
+            qs = ComputedField.objects.get_for_model(Location)
+        with self.assertNumQueries(0):
+            listing = ComputedField.objects.get_for_model(Location, get_queryset=False)
+        self.assertIsInstance(qs, QuerySet)
+        self.assertIsInstance(listing, list)
+        self.assertEqual(1, len(listing))
+        self.assertQuerysetEqualAndNotEmpty(qs, listing)
 
 
 class CustomFieldDataAPITest(APITestCase):

nautobot/extras/tests/test_relationships.py

@@ -482,10 +482,12 @@ class RelationshipTest(RelationshipBaseTest, ModelTestCases.BaseModelTestCase):
                 # Assert that the cache is used when calling method a second time
                 with self.assertNumQueries(0):
                     manager_method(Location)
+                with self.assertNumQueries(0):
+                    manager_method(Location, get_queryset=False)
 
                 # Assert that different models are cached separately
                 with self.assertNumQueries(expected_queries):
-                    manager_method(Rack)
+                    manager_method(Rack, get_queryset=False)
                 with self.assertNumQueries(0):
                     manager_method(Rack)
                 with self.assertNumQueries(0):
@@ -507,6 +509,8 @@ class RelationshipTest(RelationshipBaseTest, ModelTestCases.BaseModelTestCase):
                         manager_method(Location)
                     with self.assertNumQueries(0):
                         manager_method(Location)
+                    with self.assertNumQueries(0):
+                        manager_method(Location, get_queryset=False)
                 finally:
                     # Assert that the cache is invalidated on object delete
                     relationship.delete()
@@ -514,6 +518,8 @@ class RelationshipTest(RelationshipBaseTest, ModelTestCases.BaseModelTestCase):
                     manager_method(Location)
                 with self.assertNumQueries(0):
                     manager_method(Location)
+                with self.assertNumQueries(0):
+                    manager_method(Location, get_queryset=False)
 
     def test_required_related_object_errors(self):
         """