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

nautobot/extras/plugins/views.py

@@ -1,4 +1,5 @@
 from collections import OrderedDict
+import os
 
 from django.apps import apps
 from django.conf import settings
@@ -11,6 +12,7 @@ from rest_framework import permissions
 from rest_framework.response import Response
 from rest_framework.reverse import reverse
 from rest_framework.views import APIView
+import yaml
 
 from nautobot.core.api.views import AuthenticatedAPIRootView, NautobotAPIVersionMixin
 from nautobot.core.forms import TableConfigForm
@@ -19,6 +21,14 @@ from nautobot.core.views.paginator import EnhancedPaginator, get_paginate_count
 from nautobot.extras.plugins.tables import InstalledAppsTable
 
 
+def load_marketplace_data():
+    file_path = os.path.dirname(os.path.abspath(__file__)) + "/marketplace_manifest.yml"
+    with open(file_path, "r") as yamlfile:
+        marketplace_data = yaml.safe_load(yamlfile)
+
+    return marketplace_data
+
+
 class InstalledAppsView(GenericView):
     """
     View for listing all installed Apps.
@@ -69,13 +79,30 @@ class InstalledAppsView(GenericView):
         }
         RequestConfig(request, paginate).configure(table)
 
+        marketplace_data = load_marketplace_data()
+        app_icons = {app["package_name"]: app.get("icon") for app in marketplace_data["apps"]}
+
+        # Determine user's preferred display
+        if self.request.GET.get("display") in ["list", "tiles"]:
+            display = self.request.GET.get("display")
+            if self.request.user.is_authenticated:
+                self.request.user.set_config("extras.apps_list.display", display, commit=True)
+        elif self.request.user.is_authenticated:
+            display = self.request.user.get_config("extras.apps_list.display", "list")
+        else:
+            display = "list"
+
         return render(
             request,
             "extras/plugins_list.html",
             {
                 "table": table,
                 "table_config_form": TableConfigForm(table=table),
+                # Using `None` as `table_template` falls back to default `responsive_table.html`.
+                "table_template": "extras/plugins_tiles.html" if display == "tiles" else None,
                 "filter_form": None,
+                "app_icons": app_icons,
+                "display": display,
             },
         )
 
@@ -166,7 +193,7 @@ class AppsAPIRootView(AuthenticatedAPIRootView):
         return entry
 
     @extend_schema(exclude=True)
-    def get(self, request, *args, format=None, **kwargs):  # pylint: disable=redefined-builtin
+    def get(self, request, format=None):  # pylint: disable=redefined-builtin
         entries = []
         for app_name in settings.PLUGINS:
             app_config = apps.get_app_config(app_name)
@@ -198,3 +225,23 @@ class AppsAPIRootView(AuthenticatedAPIRootView):
                 )
             )
         )
+
+
+class MarketplaceView(GenericView):
+    """
+    View for listing all available Apps.
+    """
+
+    def get(self, request):
+        marketplace_data = load_marketplace_data()
+
+        installed_apps = [app for app in apps.get_app_configs() if app.name in settings.PLUGINS]
+
+        # Filter out already installed apps from apps marketplace listing.
+        visible_marketplace_apps = [
+            app
+            for app in marketplace_data["apps"]
+            if all(installed_app.name != app["package_name"] for installed_app in installed_apps)
+        ]
+
+        return render(request, "extras/marketplace.html", {"apps": visible_marketplace_apps})

nautobot/extras/signals.py

@@ -31,6 +31,8 @@ from nautobot.extras.models import (
     DynamicGroup,
     DynamicGroupMembership,
     GitRepository,
+    Job as JobModel,
+    JobQueue as JobQueueModel,
     JobResult,
     MetadataType,
     ObjectChange,
@@ -457,6 +459,35 @@ def job_result_delete_associated_files(instance, **kwargs):
             file_proxy.file.delete()
 
 
+@receiver(m2m_changed, sender=JobModel.job_queues.through)
+def add_default_job_queue_to_job_queues(instance, action, model, pk_set, **kwargs):
+    if action == "pre_remove":
+        if isinstance(instance, JobModel):  # job_model.job_queues.remove()
+            # Don't allow removing the default job queue
+            pk_set.discard(instance.default_job_queue.pk)
+        elif isinstance(instance, JobQueueModel):  # job_queue.jobs.remove()
+            # Don't allow removing jobs that this queue is default for
+            for job_model in instance.default_for_jobs.all():
+                pk_set.discard(job_model.pk)
+    elif action == "post_clear":
+        if isinstance(instance, JobModel):  # job_model.job_queues.clear()
+            # Re-add the default job queue
+            instance.job_queues.add(instance.default_job_queue)
+        elif isinstance(instance, JobQueueModel):  # job_queue.jobs.clear()
+            # Re-add the jobs this queue is default for
+            for job_model in instance.default_for_jobs.all():
+                job_model.job_queues.add(instance.pk)
+
+
+@receiver(post_save, sender=JobModel)
+def add_default_job_queue_to_job_queues_after_save(instance, raw=False, **kwargs):
+    if raw:
+        return
+    # Add specified default_job_queue to job.job_queues if it is not included.
+    default_job_queue = instance.default_job_queue
+    instance.job_queues.add(default_job_queue)
+
+
 def refresh_job_models(sender, *, apps, **kwargs):
     """
     Callback for the nautobot_database_ready signal; updates Jobs in the database based on Job source file availability.
@@ -466,6 +497,11 @@ def refresh_job_models(sender, *, apps, **kwargs):
     Job = apps.get_model("extras", "Job")
 
     # To make reverse migrations safe
+    try:
+        JobQueue = apps.get_model("extras", "JobQueue")
+    except LookupError:
+        JobQueue = None
+
     if not hasattr(Job, "job_class_name"):
         logger.info("Skipping refresh_job_models() as it appears Job model has not yet been migrated to latest.")
         return
@@ -475,7 +511,9 @@ def refresh_job_models(sender, *, apps, **kwargs):
     job_models = []
 
     for job_class in get_jobs().values():
-        job_model, _ = refresh_job_model_from_job_class(Job, job_class)
+        job_model, _ = refresh_job_model_from_job_class(
+            job_model_class=Job, job_class=job_class, job_queue_class=JobQueue
+        )
         if job_model is not None:
             job_models.append(job_model)
 

nautobot/extras/tables.py

@@ -12,6 +12,7 @@ from nautobot.core.tables import (
     ColorColumn,
     ColoredLabelColumn,
     ContentTypesColumn,
+    LinkedCountColumn,
     TagColumn,
     ToggleColumn,
 )
@@ -37,6 +38,7 @@ from .models import (
     JobButton,
     JobHook,
     JobLogEntry,
+    JobQueue,
     JobResult,
     MetadataType,
     Note,
@@ -242,7 +244,7 @@ class ConfigContextSchemaValidationStateColumn(tables.Column):
         self.validator = validator
         self.data_field = data_field
 
-    def render(self, *, record):  # pylint: disable=arguments-differ  # tables2 varies its kwargs
+    def render(self, record):
         data = getattr(record, self.data_field)
         try:
             self.validator.validate(data)
@@ -626,13 +628,13 @@ class GitRepositoryTable(BaseTable):
         )
 
     def render_last_sync_time(self, record):
-        if record.name in self.context["job_results"]:  # pylint: disable=no-member
-            return self.context["job_results"][record.name].date_done  # pylint: disable=no-member
+        if record.name in self.context["job_results"]:
+            return self.context["job_results"][record.name].date_done
         return self.default
 
     def render_last_sync_user(self, record):
-        if record.name in self.context["job_results"]:  # pylint: disable=no-member
-            user = self.context["job_results"][record.name].user  # pylint: disable=no-member
+        if record.name in self.context["job_results"]:
+            user = self.context["job_results"][record.name].user
             return user
         return self.default
 
@@ -699,7 +701,10 @@ class JobTable(BaseTable):
     supports_dryrun = BooleanColumn()
     soft_time_limit = tables.Column()
     time_limit = tables.Column()
-    actions = ButtonsColumn(JobModel, prepend_template=JOB_BUTTONS)
+    default_job_queue = tables.Column(linkify=True)
+    job_queues_count = LinkedCountColumn(
+        viewname="extras:jobqueue_list", url_params={"jobs": "pk"}, verbose_name="Job Queues"
+    )
     last_run = tables.TemplateColumn(
         accessor="latest_result",
         template_code="""
@@ -715,6 +720,7 @@ class JobTable(BaseTable):
         template_code="{% include 'extras/inc/job_label.html' with result=record.latest_result %}",
     )
     tags = TagColumn(url_name="extras:job_list")
+    actions = ButtonsColumn(JobModel, prepend_template=JOB_BUTTONS)
 
     def render_description(self, value):
         return render_markdown(value)
@@ -745,6 +751,8 @@ class JobTable(BaseTable):
             "supports_dryrun",
             "soft_time_limit",
             "time_limit",
+            "default_job_queue",
+            "job_queues_count",
             "last_run",
             "last_status",
             "tags",
@@ -826,6 +834,32 @@ class JobLogEntryTable(BaseTable):
         }
 
 
+class JobQueueTable(BaseTable):
+    pk = ToggleColumn()
+    name = tables.Column(linkify=True)
+    tenant = TenantColumn()
+    jobs_count = LinkedCountColumn(viewname="extras:job_list", url_params={"job_queues": "pk"}, verbose_name="Jobs")
+
+    class Meta(BaseTable.Meta):
+        model = JobQueue
+        fields = (
+            "pk",
+            "name",
+            "queue_type",
+            "tenant",
+            "jobs_count",
+            "description",
+        )
+        default_columns = (
+            "pk",
+            "name",
+            "queue_type",
+            "tenant",
+            "jobs_count",
+            "description",
+        )
+
+
 class JobResultTable(BaseTable):
     pk = ToggleColumn()
     job_model = tables.Column(linkify=True)

nautobot/extras/templates/extras/externalintegration_retrieve.html

@@ -1,49 +1,2 @@
 {% extends 'generic/object_retrieve.html' %}
 {% load helpers %}
-
-{% block content_left_page %}
-        <div class="panel panel-default">
-            <div class="panel-heading">
-                <strong>External Integration</strong>
-            </div>
-
-            <table class="table table-hover panel-body attr-table">
-                <tr>
-                    <td>Name</td>
-                    <td>{{ object.name }}</td>
-                </tr>
-                <tr>
-                    <td>Remote URL</td>
-                    <td>{{ object.remote_url }}</td>
-                </tr>
-                <tr>
-                    <td>HTTP Method</td>
-                    <td>{{ object.http_method }}</td>
-                </tr>
-                <tr>
-                    <td>Headers</td>
-                    <td><pre>{{ object.headers | render_json }}</pre></td>
-                </tr>
-                <tr>
-                    <td>Verify SSL</td>
-                    <td>{{ object.verify_ssl | render_boolean }}</td>
-                </tr>
-                <tr>
-                    <td>CA File Path</td>
-                    <td>{{ object.ca_file_path }}</td>
-                </tr>
-                <tr>
-                    <td>Secrets Group</td>
-                    <td>{{ object.secrets_group | hyperlinked_object }}</td>
-                </tr>
-                <tr>
-                    <td>Timeout</td>
-                    <td>{{ object.timeout }}</td>
-                </tr>
-                <tr>
-                    <td>Extra Config</td>
-                    <td><pre>{{ object.extra_config | render_json }}</pre></td>
-                </tr>
-            </table>
-        </div>
-{% endblock content_left_page %}

nautobot/extras/templates/extras/inc/tags_panel.html

@@ -6,11 +6,7 @@
         <strong>Tags</strong>
     </div>
     <div class="panel-body">
-        {% for tag in tags.all %}
-            {% tag tag url %}
-        {% empty %}
-            <span class="text-muted">No tags assigned</span>
-        {% endfor %}
+        {% include "components/panel/body_content_tags.html" with tags=tags.all list_url_name=url %}
     </div>
 </div>
 {% endif %}

nautobot/extras/templates/extras/job_bulk_edit.html

@@ -11,7 +11,8 @@
     {% include "extras/inc/bulk_edit_overridable_field.html" with field=form.soft_time_limit override_field=form.clear_soft_time_limit_override %}
     {% include "extras/inc/bulk_edit_overridable_field.html" with field=form.time_limit override_field=form.clear_time_limit_override %}
     {% include "extras/inc/bulk_edit_overridable_field.html" with field=form.has_sensitive_variables override_field=form.clear_has_sensitive_variables_override %}
-    {% include "extras/inc/bulk_edit_overridable_field.html" with field=form.task_queues override_field=form.clear_task_queues_override %}
+    {% include "extras/inc/bulk_edit_overridable_field.html" with field=form.job_queues override_field=form.clear_job_queues_override %}
+    {% include "extras/inc/bulk_edit_overridable_field.html" with field=form.default_job_queue override_field=form.clear_default_job_queue_override %}
 {% endblock %}
 {% block javascript %}
 <script>

nautobot/extras/templates/extras/job_detail.html

@@ -48,12 +48,10 @@
             <tr>
                 <td>Is Job Hook Receiver</td>
                 <td>{{ object.is_job_hook_receiver | render_boolean }}</td>
-                <td></td>
             </tr>
             <tr>
                 <td>Is Job Button Receiver</td>
                 <td>{{ object.is_job_button_receiver | render_boolean }}</td>
-                <td></td>
             </tr>
         </table>
     </div>
@@ -261,10 +259,20 @@
                 </td>
             </tr>
             <tr>
-                <td>Task Queues</td>
-                <td colspan="2">
-                    {% include 'extras/inc/json_data.html' with data=object.task_queues format="json" %}
-                    {% if object.task_queues_override %}
+                <td>Job Queues</td>
+                <td>
+                    {% if object.job_queues.exists %}
+                        <ul>
+                            {% for queue in object.job_queues.all %}
+                                <li>{{ queue|hyperlinked_object }}</li>
+                            {% endfor %}
+                        </ul>
+                    {% else %}
+                        {{ None|placeholder }}
+                    {% endif %}
+                </td>
+                <td>
+                    {% if object.job_queues_override %}
                         <span class="text-muted">
                             overridden; default is:<br>
                             {% if object.installed %}
@@ -276,6 +284,28 @@
                     {% endif %}
                 </td>
             </tr>
+            <tr>
+                <td>Default Job Queue</td>
+                <td>
+                    {{ object.default_job_queue|hyperlinked_object }}
+                </td>
+                <td>
+                    {% if object.default_job_queue_override %}
+                        <span class="text-muted">
+                            overridden; default is:
+                            {% if object.installed %}
+                                {% if object.job_class.task_queues|length > 1 %}
+                                    {{ object.job_class.task_queues.0 }}
+                                {% else %}
+                                    {{ None|placeholder }}
+                                {% endif %}
+                            {% else %}
+                                unknown (not currently installed)
+                            {% endif %}
+                        </span>
+                    {% endif %}
+                </td>
+            </tr>
         </table>
     </div>
 {% endblock content_right_page %}

nautobot/extras/templates/extras/job_edit.html

@@ -92,7 +92,8 @@
             {% include "extras/inc/overridable_field.html" with field=form.soft_time_limit override_field=form.soft_time_limit_override %}
             {% include "extras/inc/overridable_field.html" with field=form.time_limit override_field=form.time_limit_override %}
             {% include "extras/inc/overridable_field.html" with field=form.has_sensitive_variables override_field=form.has_sensitive_variables_override %}
-            {% include "extras/inc/overridable_field.html" with field=form.task_queues override_field=form.task_queues_override %}
+            {% include "extras/inc/overridable_field.html" with field=form.job_queues override_field=form.job_queues_override %}
+            {% include "extras/inc/overridable_field.html" with field=form.default_job_queue override_field=form.default_job_queue_override %}
         </div>
     </div>
     {% include 'inc/extras_features_edit_form_fields.html' %}
@@ -133,7 +134,9 @@
             } else {
                 /* Do we have a job class object to derive properties from? */
                 if (job_class_properties != "") {
-                    field.val(job_class_properties[field_name]);
+                    if (field_name != "job_queues") {
+                        field.val(job_class_properties[field_name]);
+                    }
                 } else if (field_name != "description") {
                     /* No, we don't - it's probably not installed */
                     field.val(field.attr("value"));

nautobot/extras/templates/extras/job_list.html

@@ -3,11 +3,6 @@
 
 {% block extra_styles %}
     <style>
-        .accordion-toggle {
-            font-size: 14px;
-            font-weight: 700;
-        }
-
         tr a.job_run .btn {
             margin: -4px 10px 0 0;
         }
@@ -37,7 +32,7 @@
         </a>
     </div>
 
-    <button type="button" class="btn btn-default" id="accordion-toggle-all"{% if display == "tiles" %} disabled="disabled"{% endif %}>Collapse All</button>
+    <button type="button" class="btn btn-default accordion-toggle-all"{% if display == "tiles" %} disabled="disabled"{% endif %}>Collapse All</button>
 {% endblock %}
 
 {% block table_config_button %}
@@ -55,7 +50,7 @@
             $(this).toggleClass("mdi-chevron-down mdi-chevron-right");
         });
         // Dynamically collapse/expand all when clicking the "Collapse All" button, and then update the button text.
-        $('#accordion-toggle-all').on('click', function () {
+        $('.accordion-toggle-all').on('click', function () {
 
            if ($(this).data("lastState") === null || $(this).data("lastState") === 1) {
                 $('.collapse').collapse('show');

nautobot/extras/templates/extras/jobqueue_retrieve.html

@@ -0,0 +1,44 @@
+{% extends 'generic/object_retrieve.html' %}
+{% load helpers %}
+
+{% block content_left_page %}
+        <div class="panel panel-default">
+            <div class="panel-heading">
+                <strong>Job Queue</strong>
+            </div>
+
+            <table class="table table-hover panel-body attr-table">
+                <tr>
+                    <td>Name</td>
+                    <td>
+                        {{ object.name }}
+                    </td>
+                </tr>
+                <tr>
+                    <td>Queue Type</td>
+                    <td>
+                        {{ object.get_queue_type_display }}
+                    </td>
+                </tr>
+                <tr>
+                    <td>Description</td>
+                    <td>
+                        {{ object.description|placeholder }}
+                    </td>
+                </tr>
+                <tr>
+                    <td>Tenant</td>
+                    <td>
+                        {% if object.tenant and object.tenant.tenant_group %}
+	                    {{ object.tenant.tenant_group|hyperlinked_object }} /
+	                {% endif %}
+	                {{ object.tenant|hyperlinked_object }}
+                    </td>
+                </tr>
+            </table>
+        </div>
+{% endblock %}
+
+{% block content_full_width_page %}
+    {% include 'panel_table.html' with table=jobs_table heading='Assigned Jobs' %}
+{% endblock %}