nautobot 2.3.16__py3-none-any.whl → 2.4.0__py3-none-any.whl

nautobot/extras/templates/extras/secret.html

@@ -1,66 +1 @@
 {% extends 'generic/object_detail.html' %}
-{% load helpers %}
-
-{% block extra_buttons %}
-    <a onClick="checkSecret()" class="btn btn-default">
-        Check Secret
-    </a>
-{% endblock extra_buttons %}
-
-{% block content_left_page %}
-    <div class="panel panel-default">
-        <div class="panel-heading">
-            <strong>Secret</strong>
-        </div>
-        <table class="table table-hover panel-body attr-table">
-            <tr>
-                <td>Description</td>
-                <td>{{ object.description | placeholder }}</td>
-            </tr>
-            <tr>
-                <td>Provider</td>
-                <td>{{ provider_name }}</td>
-            </tr>
-        </table>
-    </div>
-    <div class="panel panel-default">
-        <div class="panel-heading">
-            <strong>Parameters</strong>
-        </div>
-        <table class="table table-hover panel-body attr-table">
-            {% for param, value in object.parameters.items %}
-                <tr>
-                    <td><code>{{ param }}</code></td>
-                    <td><code>{{ value }}</code></td>
-                </tr>
-            {% endfor %}
-        </table>
-    </div>
-{% endblock content_left_page %}
-
-{% block content_right_page %}
-    {% include 'utilities/obj_table.html' with table=groups_table table_template='panel_table.html' heading='Groups containing this secret' %}
-{% endblock content_right_page %}
-
-
-{% block javascript %}
-{{ block.super }}
-<script>
-    function checkSecret() {
-        $.ajax({
-            url: "{% url 'extras-api:secret-check' pk=object.pk %}",
-            dataType: 'json',
-            success: function(json) {
-                if(json.result) {
-                    alert("The secret was successfully retrieved.")
-                } else {
-                    alert("Error retrieving secret: \n\n" + json.message)
-                }
-            },
-            error: function(xhr) {
-                alert("Error checking secret: \n\n" + xhr.responseText);
-            }
-        });
-    }
-</script>
-{% endblock javascript %}

nautobot/extras/templates/extras/secret_check.js

@@ -0,0 +1,16 @@
+function checkSecret() {
+    $.ajax({
+        url: "{% url 'extras-api:secret-check' pk=object.pk %}",
+        dataType: 'json',
+        success: function(json) {
+            if(json.result) {
+                alert("The secret was successfully retrieved.")
+            } else {
+                alert("Error retrieving secret: \n\n" + json.message)
+            }
+        },
+        error: function(xhr) {
+            alert("Error checking secret: \n\n" + xhr.responseText);
+        }
+    });
+}

nautobot/extras/templates/extras/secret_create.html

@@ -0,0 +1,114 @@
+{% extends 'generic/object_create.html' %}
+{% load form_helpers %}
+
+{% block form %}
+    <div class="panel panel-default">
+        <div class="panel-heading"><strong>Secret</strong></div>
+        <div class="panel-body">
+            {% render_field form.name %}
+            {% render_field form.description %}
+            {% render_field form.provider %}
+        </div>
+    </div>
+    <div class="panel panel-default">
+        <div class="panel-heading"><strong>Parameters</strong></div>
+        <div class="panel-body">
+            <span class="help-block">
+                All parameter values can be entered as Jinja2 templates if desired.
+                The requesting object (device, Git repository, etc.), if any, will be provided
+                as context variable <code>obj</code>.
+            </span>
+            <ul class="nav nav-tabs" role="tablist">
+                <li role="presentation" class="active">
+                    <a href="#parameters_form" role="tab" data-toggle="tab">Form</a>
+                </li>
+                <li role="presentation">
+                    <a href="#parameters_json" role="tab" data-toggle="tab">JSON</a>
+                </li>
+            </ul>
+            <div class="tab-content">
+                <div class="tab-pane active" id="parameters_form">
+                    <!-- to be populated by jquery -->
+                </div>
+                <div class="tab-pane" id="parameters_json">
+                    {% render_field form.parameters %}
+                </div>
+            </div>
+        </div>
+    </div>
+    {% include 'inc/extras_features_edit_form_fields.html' %}
+{% endblock form %}
+
+{% block javascript %}
+{{ block.super }}
+<script type="text/javascript">
+    /* When changing any field in the parameters_form, re-render the JSON in parameters_json */
+    function changeProviderParameter() {
+        var parameters_value = {};
+
+        $("#parameters_form :input").each(function() {
+            var field_key = $(this).attr("id").slice(3);  /* "id_foobar" --> "foobar" */
+            parameters_value[field_key] = $(this).val();
+        });
+
+        $("#id_parameters").val(JSON.stringify(parameters_value, null, 4));
+    };
+
+    /* When changing the parameters_json, update all fields in the parameters_form accordingly */
+    function changeProviderJSON() {
+        var parameters_as_json = $(this).val();
+        var parameters_value;
+        try {
+            parameters_value = JSON.parse(parameters_as_json);
+        } catch (e) {
+            alert("JSON is invalid");
+            return;
+        }
+
+        for (const key of Object.keys(parameters_value)) {
+            $("#parameters_form #id_" + key).val(parameters_value[key]);
+        }
+    };
+
+    /* When changing the selected provider, retrieve and render the provider-specific content to parameters_form */
+    function changeProvider() {
+        var provider_slug = $("#id_provider").val();
+
+        var parameters_as_json = $("#id_parameters").val();
+        var parameters_value;
+        try {
+            parameters_value = JSON.parse(parameters_as_json);
+        } catch (e) {
+            parameters_value = {};
+        }
+
+        $.ajax({
+            url: "{% url 'extras:secret_list' %}" + "provider/" + provider_slug + "/form/",
+            method: "GET",
+            data: parameters_value,
+            context: this,
+            success: function(data) {
+                $("#parameters_form").html(data);
+                /*
+                 * Strip the "name" field from every field in the parameters_form.
+                 * These fields are for user convenience only and should not be included when the form is submitted;
+                 * removing their name causes them to be omitted as desired.
+                 * See also https://github.com/nautobot/nautobot/issues/1335
+                 */
+                $("#parameters_form :input").removeAttr("name");
+
+                $("#parameters_form :input").change(changeProviderParameter);
+            },
+            error: function() {
+                $("#parameters_form").html("No form available for this provider, use JSON instead");
+            },
+        });
+    };
+
+    $(document).ready(function() {
+        $("#id_provider").change(changeProvider);
+        changeProvider();
+        $("#id_parameters").change(changeProviderJSON);
+    });
+</script>
+{% endblock javascript %}

nautobot/extras/templates/extras/secret_edit.html

@@ -1,114 +1 @@
-{% extends 'generic/object_create.html' %}
-{% load form_helpers %}
-
-{% block form %}
-    <div class="panel panel-default">
-        <div class="panel-heading"><strong>Secret</strong></div>
-        <div class="panel-body">
-            {% render_field form.name %}
-            {% render_field form.description %}
-            {% render_field form.provider %}
-        </div>
-    </div>
-    <div class="panel panel-default">
-        <div class="panel-heading"><strong>Parameters</strong></div>
-        <div class="panel-body">
-            <span class="help-block">
-                All parameter values can be entered as Jinja2 templates if desired.
-                The requesting object (device, Git repository, etc.), if any, will be provided
-                as context variable <code>obj</code>.
-            </span>
-            <ul class="nav nav-tabs" role="tablist">
-                <li role="presentation" class="active">
-                    <a href="#parameters_form" role="tab" data-toggle="tab">Form</a>
-                </li>
-                <li role="presentation">
-                    <a href="#parameters_json" role="tab" data-toggle="tab">JSON</a>
-                </li>
-            </ul>
-            <div class="tab-content">
-                <div class="tab-pane active" id="parameters_form">
-                    <!-- to be populated by jquery -->
-                </div>
-                <div class="tab-pane" id="parameters_json">
-                    {% render_field form.parameters %}
-                </div>
-            </div>
-        </div>
-    </div>
-    {% include 'inc/extras_features_edit_form_fields.html' %}
-{% endblock form %}
-
-{% block javascript %}
-{{ block.super }}
-<script type="text/javascript">
-    /* When changing any field in the parameters_form, re-render the JSON in parameters_json */
-    function changeProviderParameter() {
-        var parameters_value = {};
-
-        $("#parameters_form :input").each(function() {
-            var field_key = $(this).attr("id").slice(3);  /* "id_foobar" --> "foobar" */
-            parameters_value[field_key] = $(this).val();
-        });
-
-        $("#id_parameters").val(JSON.stringify(parameters_value, null, 4));
-    };
-
-    /* When changing the parameters_json, update all fields in the parameters_form accordingly */
-    function changeProviderJSON() {
-        var parameters_as_json = $(this).val();
-        var parameters_value;
-        try {
-            parameters_value = JSON.parse(parameters_as_json);
-        } catch (e) {
-            alert("JSON is invalid");
-            return;
-        }
-
-        for (const key of Object.keys(parameters_value)) {
-            $("#parameters_form #id_" + key).val(parameters_value[key]);
-        }
-    };
-
-    /* When changing the selected provider, retrieve and render the provider-specific content to parameters_form */
-    function changeProvider() {
-        var provider_slug = $("#id_provider").val();
-
-        var parameters_as_json = $("#id_parameters").val();
-        var parameters_value;
-        try {
-            parameters_value = JSON.parse(parameters_as_json);
-        } catch (e) {
-            parameters_value = {};
-        }
-
-        $.ajax({
-            url: "{% url 'extras:secret_list' %}" + "provider/" + provider_slug + "/form/",
-            method: "GET",
-            data: parameters_value,
-            context: this,
-            success: function(data) {
-                $("#parameters_form").html(data);
-                /*
-                 * Strip the "name" field from every field in the parameters_form.
-                 * These fields are for user convenience only and should not be included when the form is submitted;
-                 * removing their name causes them to be omitted as desired.
-                 * See also https://github.com/nautobot/nautobot/issues/1335
-                 */
-                $("#parameters_form :input").removeAttr("name");
-
-                $("#parameters_form :input").change(changeProviderParameter);
-            },
-            error: function() {
-                $("#parameters_form").html("No form available for this provider, use JSON instead");
-            },
-        });
-    };
-
-    $(document).ready(function() {
-        $("#id_provider").change(changeProvider);
-        changeProvider();
-        $("#id_parameters").change(changeProviderJSON);
-    });
-</script>
-{% endblock javascript %}
+{% extends 'extras/secret_create.html' %}

nautobot/extras/templates/extras/secretsgroup_edit.html

@@ -51,7 +51,7 @@
                                         {% for error in field.errors %}
                                             {# Embed an HTML comment indicating the error for extraction by tests #}
                                             <!-- FORM-ERROR {{ field.name }}: {{ error }} -->
-                                            <li clas="text-danger">{{ error }}</li>
+                                            <li class="text-danger">{{ error }}</li>
                                         {% endfor %}
                                     </ul>
                                 {% endif %}

nautobot/extras/templates/extras/templatetags/plugin_object_detail_tabs.html

@@ -1,3 +1,5 @@
+{% load ui_framework %}
+{% render_tabs_labels ui_component_tabs %}
 {% for tabs in plugin_object_detail_tabs %}
     {% for tab_id, tab in tabs.items %}
     <li role="presentation"{% if active_tab == tab_id %} class="active"{% endif %}>

nautobot/extras/templatetags/job_buttons.py

@@ -28,7 +28,7 @@ HIDDEN_INPUTS = """
 <input type="hidden" name="object_pk" value="{object_pk}">
 <input type="hidden" name="object_model_name" value="{object_model_name}">
 <input type="hidden" name="_schedule_type" value="immediately">
-<input type="hidden" name="_task_queue" value="{task_queue}">
+<input type="hidden" name="_job_queue" value="{job_queue}">
 <input type="hidden" name="_return_url" value="{redirect_path}">
 """
 
@@ -108,16 +108,17 @@ def _render_job_button_for_obj(job_button, obj, context, content_type):
     # Disable buttons if the user doesn't have permission to run the underlying Job.
     has_run_perm = Job.objects.check_perms(context["user"], instance=job_button.job, action="run")
     try:
-        _task_queue = job_button.job.task_queues[0]
+        job_queues = list(job_button.job.job_queues.all().values_list("name", flat=True))
+        _job_queue = job_queues[0]
     except IndexError:
-        _task_queue = settings.CELERY_TASK_DEFAULT_QUEUE
+        _job_queue = settings.CELERY_TASK_DEFAULT_QUEUE
     hidden_inputs = format_html(
         HIDDEN_INPUTS,
         csrf_token=context["csrf_token"],
         object_pk=obj.pk,
         object_model_name=f"{content_type.app_label}.{content_type.model}",
         redirect_path=context["request"].path,
-        task_queue=_task_queue,
+        job_queue=_job_queue,
     )
     template_args = {
         "button_id": job_button.pk,

nautobot/extras/templatetags/plugins.py

@@ -2,8 +2,10 @@ import logging
 
 from django import template as template_
 from django.conf import settings
+from django.utils.html import format_html_join
 from django.utils.safestring import mark_safe
 
+from nautobot.core.ui.choices import SectionChoices
 from nautobot.extras.plugins import Banner, TemplateExtension
 from nautobot.extras.registry import registry
 
@@ -15,8 +17,11 @@ logger = logging.getLogger(__name__)
 
 def _get_registered_content(obj, method, template_context, return_html=True):
     """
-    Given an object and a TemplateExtension method name and the template context, return all the
-    registered content for the object's model.
+    Given an object, TemplateExtension method name, and template context, return all relevant extensions' content.
+
+    Returns:
+        html (str): if return_html is True, a combined, rendered HTML string
+        objects (list): else, a list of dicts indexed by app name and an incrementing counter
     """
     context = {
         "object": obj,
@@ -55,6 +60,27 @@ def _get_registered_content(obj, method, template_context, return_html=True):
     return mark_safe(html)  # noqa: S308  # suspicious-mark-safe-usage -- we have to trust plugins to provide safe HTML
 
 
+def _get_registered_ui_content(obj, attr) -> list:
+    """Given an object and TemplateExtension attribute name, return all relevant extensions' content.
+
+    Example:
+        >>> _get_registered_ui_content(device, "object_detail_tabs")
+        [<nautobot.core.ui.object_detail.DistinctViewTab object at 0x7f0369419ac0>]
+
+    Returns:
+        objects (list): List of Tabs, Panels, etc. depending on the given attribute, sorted by weight.
+    """
+    model_name = obj._meta.label_lower
+    template_extensions = registry["plugin_template_extensions"].get(model_name, [])
+    objects = []
+    for template_extension in template_extensions:
+        content = getattr(template_extension, attr)
+        if content is not None:
+            objects.extend(content)
+
+    return sorted(objects, key=lambda item: item.weight)
+
+
 @register.simple_tag(takes_context=True)
 def plugin_buttons(context, obj, view="detail"):
     """
@@ -64,7 +90,12 @@ def plugin_buttons(context, obj, view="detail"):
         # The object_list.html template passes content_type.model_class as obj
         # This is a bit of a hack however, _get_registered_content() only really needs the model in its own logic
         return _get_registered_content(obj, "list_buttons", context)
-    return _get_registered_content(obj, "buttons", context)
+
+    html = format_html_join(
+        " ", "{}", ([button.render(context)] for button in _get_registered_ui_content(obj, "object_detail_buttons"))
+    )
+    html += _get_registered_content(obj, "buttons", context)
+    return html
 
 
 @register.simple_tag(takes_context=True)
@@ -72,7 +103,14 @@ def plugin_left_page(context, obj):
     """
     Render all left page content registered by plugins
     """
-    return _get_registered_content(obj, "left_page", context)
+    panels = [
+        panel
+        for panel in _get_registered_ui_content(obj, "object_detail_panels")
+        if panel.section == SectionChoices.LEFT_HALF
+    ]
+    html = format_html_join("\n", "{}", ([panel.render(context)] for panel in panels))
+    html += _get_registered_content(obj, "left_page", context)
+    return html
 
 
 @register.simple_tag(takes_context=True)
@@ -80,7 +118,14 @@ def plugin_right_page(context, obj):
     """
     Render all right page content registered by plugins
     """
-    return _get_registered_content(obj, "right_page", context)
+    panels = [
+        panel
+        for panel in _get_registered_ui_content(obj, "object_detail_panels")
+        if panel.section == SectionChoices.RIGHT_HALF
+    ]
+    html = format_html_join("\n", "{}", ([panel.render(context)] for panel in panels))
+    html += _get_registered_content(obj, "right_page", context)
+    return html
 
 
 @register.simple_tag(takes_context=True)
@@ -88,7 +133,14 @@ def plugin_full_width_page(context, obj):
     """
     Render all full width page content registered by plugins
     """
-    return _get_registered_content(obj, "full_width_page", context)
+    panels = [
+        panel
+        for panel in _get_registered_ui_content(obj, "object_detail_panels")
+        if panel.section == SectionChoices.FULL_WIDTH
+    ]
+    html = format_html_join("\n", "{}", ([panel.render(context)] for panel in panels))
+    html += _get_registered_content(obj, "full_width_page", context)
+    return html
 
 
 @register.inclusion_tag("extras/templatetags/plugin_object_detail_tabs.html", takes_context=True)
@@ -96,10 +148,21 @@ def plugin_object_detail_tabs(context, obj):
     """
     Render all custom tabs registered by plugins for the object detail view
     """
+    context["ui_component_tabs"] = _get_registered_ui_content(obj, "object_detail_tabs")
     context["plugin_object_detail_tabs"] = _get_registered_content(obj, "detail_tabs", context, return_html=False)
     return context
 
 
+@register.simple_tag(takes_context=True)
+def plugin_object_detail_tab_content(context, obj):
+    """
+    Render the contents of UI Component Framework Tabs for the object detail view.
+    """
+    return format_html_join(
+        "\n", "{}", ([tab.render(context)] for tab in _get_registered_ui_content(obj, "object_detail_tabs"))
+    )
+
+
 @register.inclusion_tag("extras/templatetags/plugin_banners.html", takes_context=True)
 def plugin_banners(context):
     """

nautobot/extras/test_jobs/singleton.py

@@ -0,0 +1,16 @@
+import time
+
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import Job
+
+
+class TestSingletonJob(Job):
+    class Meta:
+        name = "Example Singleton Job"
+        is_singleton = True
+
+    def run(self, *args, **kwargs):
+        time.sleep(1)
+
+
+register_jobs(TestSingletonJob)