nautobot 2.4.17__py3-none-any.whl → 2.4.19__py3-none-any.whl

nautobot/core/templates/utilities/worker_status.html

@@ -2,151 +2,151 @@
 {% load helpers %}
 
 {% block extra_styles %}
-<style>
-    .panel {
-        overflow: hidden  /* Fix for panel overflow issues */
-    }
-</style>
+    <style>
+        .panel {
+            overflow: hidden  /* Fix for panel overflow issues */
+        }
+    </style>
 {% endblock %}
 
 {% block header %}
-<h1>
-    {% block title %}Nautobot Worker Status{% endblock %}
-</h1>
+    <h1>
+        {% block title %}Nautobot Worker Status{% endblock %}
+    </h1>
 {% endblock %}
 
 {% block content %}
-<div class="row">
-    <div class="col-md-12">
-        <div class="panel panel-default">
-            <div class="panel-heading">
-                <strong>Worker Queues</strong>
-            </div>
-            <table class="table table-hover panel-body attr-table">
-                {% for queue_name, workers in worker_status.queue_worker_count.items %}
-                    <tr>
-                        <td><span class="label label-primary">{{ queue_name }}</span></td>
-                        <td>
-                            {% for worker in workers %}
-                                <span class="label label-default">{{ worker }}</span>
-                            {% empty %}
-                                No workers found.
-                            {% endfor %}
-                        </td>
-                    </tr>
-                {% endfor %}
-            </table>
-        </div>
-    </div>
-    {% for worker in worker_status.workers %}
-        <div class="col-md-6">
+    <div class="row">
+        <div class="col-md-12">
             <div class="panel panel-default">
                 <div class="panel-heading">
-                    <strong>{{ worker.hostname }}</strong>
+                    <strong>Worker Queues</strong>
                 </div>
-                <table id="accordion" class="table table-hover panel-body attr-table">
-                    <tbody>
-                        <tr>
-                            <td>Uptime</td>
-                            <td colspan="2">{{ worker.uptime|render_uptime }}</td>
-                        </tr>
+                <table class="table table-hover panel-body attr-table">
+                    {% for queue_name, workers in worker_status.queue_worker_count.items %}
                         <tr>
-                            <td>Queues</td>
-                            <td colspan="2">
-                                {% for queue in worker.queues %}
-                                    <span class="label label-primary">{{ queue }}</span>
+                            <td><span class="label label-primary">{{ queue_name }}</span></td>
+                            <td>
+                                {% for worker in workers %}
+                                    <span class="label label-default">{{ worker }}</span>
+                                {% empty %}
+                                    No workers found.
                                 {% endfor %}
                             </td>
                         </tr>
-                        <tr>
-                            <th colspan="{{ worker.running_tasks_table.columns|length }}">
-                                <button type="button" class="btn-link accordion-toggle mdi mdi-chevron-right"
-                                        name="running-tasks-{{ worker.hostname|slugify }}" data-toggle="collapse"
-                                        data-target=".collapseme-running-tasks-{{ worker.hostname|slugify }}">
-                                    Running Tasks {% badge worker.running_tasks_table.rows|length show_empty=True %}
-                                </button>
-                            </th>
-                        </tr>
-                    </tbody>
-                    <tbody class="collapseme-running-tasks-{{ worker.hostname|slugify }} collapse" data-parent="#accordion" aria-expanded="false">
-                        <tr>
-                            {% for column in worker.running_tasks_table.columns %}
-                                <th {{ column.attrs.th.as_html }}>{{ column.header }}</th>
-                            {% endfor %}
-                        </tr>
-                        {% for row in worker.running_tasks_table.page.object_list|default:worker.running_tasks_table.rows %}
-                            <tr {{ row.attrs.as_html }}>
-                                {% for column, cell in row.items %}
-                                    <td {{ column.attrs.td.as_html }}>{{ cell }}</td>
+                    {% endfor %}
+                </table>
+            </div>
+        </div>
+        {% for worker in worker_status.workers %}
+            <div class="col-md-6">
+                <div class="panel panel-default">
+                    <div class="panel-heading">
+                        <strong>{{ worker.hostname }}</strong>
+                    </div>
+                    <table id="accordion" class="table table-hover panel-body attr-table">
+                        <tbody>
+                            <tr>
+                                <td>Uptime</td>
+                                <td colspan="2">{{ worker.uptime|render_uptime }}</td>
+                            </tr>
+                            <tr>
+                                <td>Queues</td>
+                                <td colspan="2">
+                                    {% for queue in worker.queues %}
+                                        <span class="label label-primary">{{ queue }}</span>
+                                    {% endfor %}
+                                </td>
+                            </tr>
+                            <tr>
+                                <th colspan="{{ worker.running_tasks_table.columns|length }}">
+                                    <button type="button" class="btn-link accordion-toggle mdi mdi-chevron-right"
+                                            name="running-tasks-{{ worker.hostname|slugify }}" data-toggle="collapse"
+                                            data-target=".collapseme-running-tasks-{{ worker.hostname|slugify }}">
+                                        Running Tasks {% badge worker.running_tasks_table.rows|length show_empty=True %}
+                                    </button>
+                                </th>
+                            </tr>
+                        </tbody>
+                        <tbody class="collapseme-running-tasks-{{ worker.hostname|slugify }} collapse" data-parent="#accordion" aria-expanded="false">
+                            <tr>
+                                {% for column in worker.running_tasks_table.columns %}
+                                    <th {{ column.attrs.th.as_html }}>{{ column.header }}</th>
                                 {% endfor %}
                             </tr>
-                        {% empty %}
-                            {% if worker.running_tasks_table.empty_text %}
-                                <tr>
-                                    <td colspan="{{ worker.running_tasks_table.columns|length }}" class="text-center text-muted">
-                                        &mdash; {{ worker.running_tasks_table.empty_text }} &mdash;
-                                    </td>
+                            {% for row in worker.running_tasks_table.page.object_list|default:worker.running_tasks_table.rows %}
+                                <tr {{ row.attrs.as_html }}>
+                                    {% for column, cell in row.items %}
+                                        <td {{ column.attrs.td.as_html }}>{{ cell }}</td>
+                                    {% endfor %}
                                 </tr>
-                            {% endif %}
-                        {% endfor %}
-                    </tbody>
-                    <tbody>
-                        <tr>
-                            <th colspan="{{ worker.pending_tasks_table.columns|length }}">
-                                <button type="button" class="btn-link accordion-toggle mdi mdi-chevron-right"
-                                        name="pending-tasks-{{ worker.hostname|slugify }}" data-toggle="collapse"
-                                        data-target=".collapseme-pending-tasks-{{ worker.hostname|slugify }}">
-                                    Pending Tasks {% badge worker.pending_tasks_table.rows|length show_empty=True %}
-                                </button>
-                            </th>
-                        </tr>
-                    </tbody>
-                    <tbody class="collapseme-pending-tasks-{{ worker.hostname|slugify }} collapse" data-parent="#accordion" aria-expanded="false">
-                        <tr>
-                            {% for column in worker.pending_tasks_table.columns %}
-                                <th {{ column.attrs.th.as_html }}>{{ column.header }}</th>
+                            {% empty %}
+                                {% if worker.running_tasks_table.empty_text %}
+                                    <tr>
+                                        <td colspan="{{ worker.running_tasks_table.columns|length }}" class="text-center text-muted">
+                                            &mdash; {{ worker.running_tasks_table.empty_text }} &mdash;
+                                        </td>
+                                    </tr>
+                                {% endif %}
                             {% endfor %}
-                        </tr>
-                        {% for row in worker.pending_tasks_table.page.object_list|default:worker.pending_tasks_table.rows %}
-                            <tr {{ row.attrs.as_html }}>
-                                {% for column, cell in row.items %}
-                                    <td {{ column.attrs.td.as_html }}>{{ cell }}</td>
+                        </tbody>
+                        <tbody>
+                            <tr>
+                                <th colspan="{{ worker.pending_tasks_table.columns|length }}">
+                                    <button type="button" class="btn-link accordion-toggle mdi mdi-chevron-right"
+                                            name="pending-tasks-{{ worker.hostname|slugify }}" data-toggle="collapse"
+                                            data-target=".collapseme-pending-tasks-{{ worker.hostname|slugify }}">
+                                        Pending Tasks {% badge worker.pending_tasks_table.rows|length show_empty=True %}
+                                    </button>
+                                </th>
+                            </tr>
+                        </tbody>
+                        <tbody class="collapseme-pending-tasks-{{ worker.hostname|slugify }} collapse" data-parent="#accordion" aria-expanded="false">
+                            <tr>
+                                {% for column in worker.pending_tasks_table.columns %}
+                                    <th {{ column.attrs.th.as_html }}>{{ column.header }}</th>
                                 {% endfor %}
                             </tr>
-                        {% empty %}
-                            {% if worker.pending_tasks_table.empty_text %}
-                                <tr>
-                                    <td colspan="{{ worker.pending_tasks_table.columns|length }}" class="text-center text-muted">
-                                        &mdash; {{ worker.pending_tasks_table.empty_text }} &mdash;
-                                    </td>
+                            {% for row in worker.pending_tasks_table.page.object_list|default:worker.pending_tasks_table.rows %}
+                                <tr {{ row.attrs.as_html }}>
+                                    {% for column, cell in row.items %}
+                                        <td {{ column.attrs.td.as_html }}>{{ cell }}</td>
+                                    {% endfor %}
                                 </tr>
-                            {% endif %}
-                        {% endfor %}
-                    </tbody>
-                </table>
+                            {% empty %}
+                                {% if worker.pending_tasks_table.empty_text %}
+                                    <tr>
+                                        <td colspan="{{ worker.pending_tasks_table.columns|length }}" class="text-center text-muted">
+                                            &mdash; {{ worker.pending_tasks_table.empty_text }} &mdash;
+                                        </td>
+                                    </tr>
+                                {% endif %}
+                            {% endfor %}
+                        </tbody>
+                    </table>
+                </div>
             </div>
-        </div>
-    {% empty %}
-        </div>
-        <div class="alert alert-warning">
-            {% with increased_timeout=worker_status.timeout|add:5 %}
-                <strong>Warning:</strong> No workers responded within the {{ worker_status.timeout }} second timeout.
-                {% if increased_timeout <= worker_status.max_timeout %}
-                    <a href="{{ request.path }}?timeout={{ increased_timeout }}">Retry with a {{ increased_timeout }} second timeout</a>.
-                {% else %}
-                    <a href="{{ request.get_full_path }}">Retry</a>.
-                {% endif %}
-            {% endwith %}
-    {% endfor %}
-</div>
+        {% empty %}
+            </div>
+            <div class="alert alert-warning">
+                {% with increased_timeout=worker_status.timeout|add:5 %}
+                    <strong>Warning:</strong> No workers responded within the {{ worker_status.timeout }} second timeout.
+                    {% if increased_timeout <= worker_status.max_timeout %}
+                        <a href="{{ request.path }}?timeout={{ increased_timeout }}">Retry with a {{ increased_timeout }} second timeout</a>.
+                    {% else %}
+                        <a href="{{ request.get_full_path }}">Retry</a>.
+                    {% endif %}
+                {% endwith %}
+        {% endfor %}
+    </div>
 {% endblock %}
 
 {% block javascript %}
-{{ block.super }}
-<script>
+    {{ block.super }}
+    <script>
     // Toggle v -. >
-    $("#accordion .accordion-toggle").click(function() {
-        $(this).toggleClass("mdi-chevron-down mdi-chevron-right");
-    });
-</script>
+        $("#accordion .accordion-toggle").click(function() {
+            $(this).toggleClass("mdi-chevron-down mdi-chevron-right");
+        });
+    </script>
 {% endblock %}

nautobot/core/templates/widgets/clearable_file.html

@@ -1,5 +1,5 @@
 {% if widget.is_initial %}{{ widget.initial_text }}: <a href="{{ widget.value.url }}">{{ widget.value }}</a>{% if not widget.required %}
-<input type="checkbox" name="{{ widget.checkbox_name }}" id="{{ widget.checkbox_id }}"{% if widget.attrs.disabled %} disabled{% endif %}{% if widget.attrs.checked %} checked{% endif %}>
-<label for="{{ widget.checkbox_id }}">{{ widget.clear_checkbox_label }}</label>{% endif %}<br>
-{{ widget.input_text }}:{% endif %}
+    <input type="checkbox" name="{{ widget.checkbox_name }}" id="{{ widget.checkbox_id }}"{% if widget.attrs.disabled %} disabled{% endif %}{% if widget.attrs.checked %} checked{% endif %}>
+    <label for="{{ widget.checkbox_id }}">{{ widget.clear_checkbox_label }}</label>{% endif %}<br>
+    {{ widget.input_text }}:{% endif %}
 <input type="{{ widget.type }}" name="{{ widget.name }}" class="filestyle" data-placeholder="No file selected" {% include "django/forms/widgets/attrs.html" %}>

nautobot/core/templates/widgets/sluginput.html

@@ -3,7 +3,7 @@
     <span class="input-group-btn">
         <button class="btn btn-default reslugify"
                 type="button"
-                title="{% if widget.custom_title %}{{ widget.custom_title }}{%  else  %}Regenerate slug{% endif %}"
+                title="{% if widget.custom_title %}{{ widget.custom_title }}{% else %}Regenerate slug{% endif %}"
                 data-regenerate="{{ widget.attrs.id }}"
         >
             <i class="mdi mdi-refresh"></i>

nautobot/core/templatetags/buttons.py

@@ -194,6 +194,9 @@ def consolidate_bulk_action_buttons(context):
         static_group_icon += " text-muted"
 
     if render_edit_button:
+        query_string = ""
+        if hasattr(context["request"], "GET") and context["request"].GET:
+            query_string = "?" + context["request"].GET.urlencode()
         bulk_action_buttons.append(
             format_html(
                 primary_button_fragment,
@@ -201,7 +204,7 @@ def consolidate_bulk_action_buttons(context):
                 attrs=render_tag_attrs(
                     {
                         "class": edit_button_classes,
-                        "formaction": reverse(context["bulk_edit_url"]),
+                        "formaction": reverse(context["bulk_edit_url"]) + query_string,
                         "type": "submit",
                     }
                 ),
@@ -231,6 +234,9 @@ def consolidate_bulk_action_buttons(context):
         )
 
     if render_delete_button:
+        query_string = ""
+        if hasattr(context["request"], "GET") and context["request"].GET:
+            query_string = "?" + context["request"].GET.urlencode()
         bulk_action_buttons.append(
             format_html(
                 child_button_fragment,
@@ -240,7 +246,7 @@ def consolidate_bulk_action_buttons(context):
                         "class": delete_button_classes,
                         "type": "submit",
                         "name": "_delete",
-                        "formaction": reverse(context["bulk_delete_url"]),
+                        "formaction": reverse(context["bulk_delete_url"]) + query_string,
                     }
                 ),
                 icon="mdi mdi-trash-can-outline",

nautobot/core/templatetags/helpers.py

@@ -1352,3 +1352,27 @@ def saved_view_title(context, mode: Literal["html", "plain"] = "html"):
         return strip_tags(title)
 
     return title
+
+
+# https://www.djangosnippets.org/snippets/545/
+@register.tag(name="captureas")
+def do_captureas(parser, token):
+    try:
+        _, args = token.contents.split(None, 1)
+    except ValueError:
+        raise template.TemplateSyntaxError("'captureas' node requires a variable name.")
+    nodelist = parser.parse(("endcaptureas",))
+    parser.delete_first_token()
+    return CaptureasNode(nodelist, args)
+
+
+class CaptureasNode(template.Node):
+    def __init__(self, nodelist, varname):
+        self.nodelist = nodelist
+        self.varname = varname
+
+    def render(self, context):
+        output = self.nodelist.render(context)
+        output = output.strip()
+        context[self.varname] = mark_safe(output)  # noqa: S308  # we already rendered it, so it's 'safe' now?
+        return ""

nautobot/core/templatetags/ui_framework.py

@@ -1,10 +1,12 @@
+from functools import partial
 import logging
 
 from django import template
-from django.utils.html import format_html_join
+from django.utils.html import format_html_join, strip_spaces_between_tags
 
 from nautobot.core.ui.breadcrumbs import Breadcrumbs
 from nautobot.core.ui.titles import Titles
+from nautobot.core.ui.utils import render_component_template
 from nautobot.core.utils.lookup import get_view_for_model
 from nautobot.core.views.utils import get_obj_from_context
 
@@ -31,21 +33,54 @@ def render_components(context, components):
 
 @register.simple_tag(takes_context=True)
 def render_title(context, mode="plain"):
+    """
+    Render the title passed in the context. Due to backwards compatibility in most of the Generic views,
+    we're either passing `title` to the template or render `title` defined in `view_titles`.
+
+    But in some newer views we want to have simple way to render title, only by defining `view_titles` within a view class.
+    """
+    if title := context.get("title"):
+        return title
+
     title_obj = context.get("view_titles")
     if title_obj is not None and isinstance(title_obj, Titles):
         return title_obj.render(context, mode=mode)
 
-    if fallback_title := context.get("title"):
-        return fallback_title
     return ""
 
 
 @register.simple_tag(takes_context=True)
-def render_breadcrumbs(context):
+def render_breadcrumbs(context, legacy_default_breadcrumbs=None, legacy_block_breadcrumbs=None):
+    """
+    Renders the breadcrumbs using the UI Component Framework or legacy template-defined breadcrumbs.
+
+    Function checks if breadcrumbs from UI Component Framework are available and render them but only
+    when there is no other changes coming from legacy template-defined breadcrumbs.
+
+    Examples:
+    - UI Component Framework breadcrumbs are defined in the view. But in the template, {% block breadcrumbs %} is being used,
+    to override breadcrumbs or `{% block extra_breadcrumbs %}`. Output: template breadcrumbs will be rendered.
+    - There is no UI Component Framework breadcrumbs and no other block overrides. Output: default breadcrumbs will be rendered.
+    - UI Component Framework breadcrumbs are defined in the view. No breadcrumbs block overrides. Output: UI Component Framework breadcrumbs will be rendered.
+    """
+    render_template = partial(
+        render_component_template,
+        "components/breadcrumbs.html",
+        context,
+    )
+
+    if (
+        legacy_block_breadcrumbs
+        and strip_spaces_between_tags(legacy_default_breadcrumbs).strip()
+        != strip_spaces_between_tags(legacy_block_breadcrumbs).strip()
+    ):
+        return render_template(legacy_breadcrumbs=legacy_block_breadcrumbs)
+
     breadcrumbs_obj = context.get("breadcrumbs")
     if breadcrumbs_obj is not None and isinstance(breadcrumbs_obj, Breadcrumbs):
         return breadcrumbs_obj.render(context)
-    return ""
+
+    return render_template(legacy_breadcrumbs=legacy_default_breadcrumbs)
 
 
 @register.simple_tag(takes_context=True)

nautobot/core/testing/filters.py

@@ -99,6 +99,17 @@ class FilterTestCases:
             self.assertIsNotNone(self.filterset)
             return self.filterset.declared_filters["q"].filter_predicates
 
+        def test_no_distinct_on_empty_filter_params(self):
+            """Verify that an empty filterset doesn't cause a `SELECT DISTINCT`."""
+            self.assertIsNotNone(self.filterset)
+            filterset = self.filterset({}, self.queryset)  # pylint: disable=not-callable  # see assertion above
+            self.assertTrue(filterset.is_valid())
+            self.assertNotIn(
+                "SELECT DISTINCT",
+                str(filterset.qs.query),
+                "Filter set with empty parameter added `DISTINCT` to select query. This needs to be avoided because it incurs heavy performance penalties.",
+            )
+
         def test_id(self):
             """Verify that the filterset supports filtering by id with only lookup `__n`."""
             self.assertIsNotNone(self.filterset)
@@ -326,29 +337,34 @@ class FilterTestCases:
             if not isinstance(obj_field, (CharField, TextField)):
                 self.skipTest("Not a CharField or TextField")
 
+            original_value = getattr(obj, obj_field_name)
             # Create random lowercase string to use for icontains lookup
             max_length = obj_field.max_length or CHARFIELD_MAX_LENGTH
             randomized_attr_value = "".join(random.choices(string.ascii_lowercase, k=max_length))  # noqa: S311 # pseudo-random generator
-            setattr(obj, obj_field_name, randomized_attr_value)
-            obj.save()
-
-            # if lookup_method is iexact use the full updated attr
-            if lookup_method == "iexact":
-                lookup = randomized_attr_value.upper()
-                model_queryset = self.queryset.filter(**{f"{filter_field_name}__iexact": lookup})
-            else:
-                lookup = randomized_attr_value[1:].upper()
-                model_queryset = self.queryset.filter(**{f"{filter_field_name}__icontains": lookup})
-            params = {"q": lookup}
-            filterset_result = self.filterset(params, self.queryset)  # pylint: disable=not-callable
-
-            self.assertTrue(filterset_result.is_valid())
-            self.assertQuerysetEqualAndNotEmpty(
-                filterset_result.qs,
-                model_queryset,
-                ordered=False,
-                msg=lookup,
-            )
+            try:
+                setattr(obj, obj_field_name, randomized_attr_value)
+                obj.save()
+
+                # if lookup_method is iexact use the full updated attr
+                if lookup_method == "iexact":
+                    lookup = randomized_attr_value.upper()
+                    model_queryset = self.queryset.filter(**{f"{filter_field_name}__iexact": lookup})
+                else:
+                    lookup = randomized_attr_value[1:].upper()
+                    model_queryset = self.queryset.filter(**{f"{filter_field_name}__icontains": lookup})
+                params = {"q": lookup}
+                filterset_result = self.filterset(params, self.queryset)  # pylint: disable=not-callable
+
+                self.assertTrue(filterset_result.is_valid())
+                self.assertQuerysetEqualAndNotEmpty(
+                    filterset_result.qs,
+                    model_queryset,
+                    ordered=False,
+                    msg=lookup,
+                )
+            finally:
+                setattr(obj, obj_field_name, original_value)
+                obj.save()
 
         def _get_relevant_filterset_queryset(self, queryset, *filter_params):
             """Gets the relevant queryset based on filter parameters."""
@@ -454,7 +470,7 @@ class FilterTestCases:
             tenant_groups = list(
                 models.TenantGroup.objects.filter(
                     tenants__isnull=False, **{f"tenants__{self.tenancy_related_name}__isnull": False}
-                )
+                ).distinct()
             )[:2]
             tenant_groups_including_children = []
             for tenant_group in tenant_groups:

nautobot/core/testing/integration.py

@@ -65,12 +65,12 @@ class ObjectsListMixin:
         Click bulk delete from dropdown menu on bottom of the items table list.
         """
         self.browser.execute_script(
-            "document.querySelector('#object_list_form button[type=\"submit\"]').scrollIntoView()"
+            "document.querySelector('#bulk-action-buttons button[type=\"submit\"]').scrollIntoView()"
         )
         self.browser.find_by_xpath(
-            '//*[@id="object_list_form"]//button[@type="submit"]/following-sibling::button[1]'
+            '//*[@id="bulk-action-buttons"]//button[@type="submit"]/following-sibling::button[1]'
         ).click()
-        self.browser.find_by_css('#object_list_form button[name="_delete"]').click()
+        self.browser.find_by_css('#bulk-action-buttons button[name="_delete"]').click()
 
     def click_bulk_delete_all(self):
         """
@@ -82,7 +82,7 @@ class ObjectsListMixin:
         """
         Click bulk edit button on bottom of the items table list.
         """
-        self.click_button('#object_list_form button[type="submit"]')
+        self.click_button('#bulk-action-buttons button[type="submit"]')
 
     def click_bulk_edit_all(self):
         """
@@ -312,6 +312,7 @@ class SeleniumTestCase(StaticLiveServerTestCase, testing.NautobotTestCaseMixin):
             search_box_class = "select2-search select2-search--dropdown"
 
         self.browser.find_by_xpath(f"//select[@id='id_{field_name}']//following-sibling::span").click()
+        self.browser.execute_script(f"""document.querySelector('#id_{field_name}').scrollIntoView()""")
         search_box = self.browser.find_by_xpath(f"//*[@class='{search_box_class}']//input", wait_time=5)
         for _ in search_box.first.type(value, slowly=True):
             pass
@@ -630,6 +631,8 @@ class BulkOperationsTestCases:
             self.assertJobStatusIsCompleted()
 
             self.go_to_model_list_page()
+            # We set page size to large number to avoid pagination issues
+            self.set_per_page(1000)
             rest_items_count = self.model_expected_counts["all"] - self.model_expected_counts["filtered"]
             self.assertEqual(self.objects_list_visible_items, rest_items_count)