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

nautobot/extras/plugins/tables.py

@@ -10,31 +10,31 @@ class InstalledAppsTable(tables.Table):
     """
 
     name = tables.Column(linkify=lambda record: reverse("apps:app_detail", kwargs={"app": record["app_label"]}))
-    package_name = tables.Column()
+    package = tables.Column(verbose_name="Package Name")
     author = tables.Column()
     author_email = tables.Column()
-    description = tables.Column()
+    headline = tables.Column()
     version = tables.Column()
     actions = tables.TemplateColumn(
         template_code="""
-            {% if record.actions.home %}
-            <a href="{% url record.actions.home %}" class="btn btn-success btn-xs" title="Home">
+            {% if record.home_url %}
+                <a href="{% url record.home_url %}" class="btn btn-primary btn-xs" title="Home">
             {% else %}
-            <a href="" class="btn btn-success btn-xs disabled" title="No home link provided">
+                <a href="" class="btn btn-primary btn-xs disabled" title="No home link provided">
             {% endif %}
                 <i class="mdi mdi-home"></i>
             </a>
-            {% if record.actions.configure %}
-            <a href="{% url record.actions.configure %}" class="btn btn-warning btn-xs" title="Configure">
+            {% if record.config_url %}
+                <a href="{% url record.config_url %}" class="btn btn-warning btn-xs" title="Configure">
             {% else %}
-            <a href="" class="btn btn-warning btn-xs disabled" title="No configuration link provided">
+                <a href="" class="btn btn-warning btn-xs disabled" title="No configuration link provided">
             {% endif %}
                 <i class="mdi mdi-cog"></i>
             </a>
-            {% if record.actions.docs %}
-            <a href="{% url record.actions.docs %}" class="btn btn-info btn-xs" title="Docs">
+            {% if record.docs_url %}
+                <a href="{% url record.docs_url %}" class="btn btn-info btn-xs" title="Docs">
             {% else %}
-            <a href="" class="btn btn-info btn-xs disabled" title="No docs provided">
+                <a href="" class="btn btn-info btn-xs disabled" title="No docs provided">
             {% endif %}
                 <i class="mdi mdi-book-open-page-variant"></i>
             </a>
@@ -47,7 +47,7 @@ class InstalledAppsTable(tables.Table):
         attrs = {
             "class": "table table-hover table-headings",
         }
-        default_columns = ("name", "description", "version", "actions")
+        default_columns = ("name", "headline", "version", "actions")
 
     def __init__(self, *args, user=None, **kwargs):
         super().__init__(*args, **kwargs)
@@ -83,7 +83,9 @@ class InstalledAppsTable(tables.Table):
     @property
     def configurable_columns(self):
         selected_columns = [
-            (name, self.columns[name].verbose_name) for name in self.sequence if name not in ["pk", "actions"]
+            (name, column.verbose_name)
+            for name, column in self.columns.items()
+            if name in self.sequence and name not in ["pk", "actions"]
         ]
         available_columns = [
             (name, column.verbose_name)
@@ -94,7 +96,7 @@ class InstalledAppsTable(tables.Table):
 
     @property
     def visible_columns(self):
-        return [name for name in self.sequence if self.columns[name].visible]
+        return [name for name, column in self.columns.items() if column.visible]
 
     def render_package_name(self, value):
         return format_html(f"<code>{value}</code>")

nautobot/extras/plugins/urls.py

@@ -11,6 +11,7 @@ from . import views
 apps_patterns = [
     path("installed-apps/", views.InstalledAppsView.as_view(), name="apps_list"),
     path("installed-apps/<str:app>/", views.InstalledAppDetailView.as_view(), name="app_detail"),
+    path("marketplace/", views.MarketplaceView.as_view(), name="apps_marketplace"),
 ]
 plugin_patterns = [  # 3.0 TODO: remove these
     path("installed-plugins/", views.InstalledAppsView.as_view(), name="plugins_list"),

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,63 @@ 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
+
+
+def override_app_data_with_marketplace_data(package_name, app_data, marketplace_data):
+    """If the given package_name is in the marketplace_data, update/replace the app_data with marketplace_data."""
+    for marketplace_app in marketplace_data["apps"]:
+        if marketplace_app["package_name"] != package_name:
+            continue
+        for key in "author", "description", "headline", "availability", "name":
+            if marketplace_app.get(key, None):
+                app_data[key] = marketplace_app[key]
+        break
+    return app_data
+
+
+def extract_app_data(app_config, marketplace_data):
+    if app_config.name not in settings.PLUGINS:
+        return None
+    try:
+        reverse(app_config.home_view_name)
+        home_url = app_config.home_view_name
+    except NoReverseMatch:
+        home_url = None
+    try:
+        reverse(app_config.config_view_name)
+        config_url = app_config.config_view_name
+    except NoReverseMatch:
+        config_url = None
+    try:
+        reverse(app_config.docs_view_name)
+        docs_url = app_config.docs_view_name
+    except NoReverseMatch:
+        docs_url = None
+    return override_app_data_with_marketplace_data(
+        app_config.name,
+        {
+            "name": app_config.verbose_name,
+            "package": app_config.name,
+            "app_label": app_config.label,
+            "author": app_config.author,
+            "author_email": app_config.author_email,
+            "description": app_config.description,
+            "headline": app_config.description,
+            "version": app_config.version,
+            "home_url": home_url,
+            "config_url": config_url,
+            "docs_url": docs_url,
+        },
+        marketplace_data,
+    )
+
+
 class InstalledAppsView(GenericView):
     """
     View for listing all installed Apps.
@@ -27,40 +86,12 @@ class InstalledAppsView(GenericView):
     table = InstalledAppsTable
 
     def get(self, request):
+        marketplace_data = load_marketplace_data()
+        app_configs = apps.get_app_configs()
         data = []
-        for app in apps.get_app_configs():
-            if app.name in settings.PLUGINS:
-                try:
-                    reverse(app.home_view_name)
-                    home_url = app.home_view_name
-                except NoReverseMatch:
-                    home_url = None
-                try:
-                    reverse(app.config_view_name)
-                    config_url = app.config_view_name
-                except NoReverseMatch:
-                    config_url = None
-                try:
-                    reverse(app.docs_view_name)
-                    docs_url = app.docs_view_name
-                except NoReverseMatch:
-                    docs_url = None
-                data.append(
-                    {
-                        "name": app.verbose_name,
-                        "package_name": app.name,
-                        "app_label": app.label,
-                        "author": app.author,
-                        "author_email": app.author_email,
-                        "description": app.description,
-                        "version": app.version,
-                        "actions": {
-                            "home": home_url,
-                            "configure": config_url,
-                            "docs": docs_url,
-                        },
-                    }
-                )
+        for app_config in app_configs:
+            if app_data := extract_app_data(app_config, marketplace_data):
+                data.append(app_data)
         table = self.table(data, user=request.user)
 
         paginate = {
@@ -69,13 +100,29 @@ class InstalledAppsView(GenericView):
         }
         RequestConfig(request, paginate).configure(table)
 
+        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,
             },
         )
 
@@ -96,6 +143,7 @@ class InstalledAppDetailView(GenericView):
             request,
             "extras/plugin_detail.html",
             {
+                "app_data": extract_app_data(app_config, load_marketplace_data()),
                 "object": app_config,
             },
         )
@@ -111,35 +159,10 @@ class InstalledAppsAPIView(NautobotAPIVersionMixin, APIView):
     def get_view_name(self):
         return "Installed Apps"
 
-    @staticmethod
-    def _get_app_data(app_config):
-        try:
-            home_url = reverse(app_config.home_view_name)
-        except NoReverseMatch:
-            home_url = None
-        try:
-            config_url = reverse(app_config.config_view_name)
-        except NoReverseMatch:
-            config_url = None
-        try:
-            docs_url = reverse(app_config.docs_view_name)
-        except NoReverseMatch:
-            docs_url = None
-        return {
-            "name": app_config.verbose_name,
-            "package": app_config.name,
-            "author": app_config.author,
-            "author_email": app_config.author_email,
-            "description": app_config.description,
-            "version": app_config.version,
-            "home_url": home_url,
-            "config_url": config_url,
-            "docs_url": docs_url,
-        }
-
     @extend_schema(exclude=True)
     def get(self, request, format=None):  # pylint: disable=redefined-builtin
-        return Response([self._get_app_data(apps.get_app_config(app)) for app in settings.PLUGINS])
+        marketplace_data = load_marketplace_data()
+        return Response([extract_app_data(apps.get_app_config(app), marketplace_data) for app in settings.PLUGINS])
 
 
 class AppsAPIRootView(AuthenticatedAPIRootView):
@@ -198,3 +221,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]
+
+        # Flag already installed apps
+        for installed_app in installed_apps:
+            for marketplace_app in marketplace_data["apps"]:
+                if installed_app.name == marketplace_app["package_name"]:
+                    marketplace_app["installed"] = True
+                    break
+
+        return render(request, "extras/marketplace.html", {"apps": marketplace_data["apps"]})

nautobot/extras/registry.py

@@ -41,7 +41,7 @@ class DatasourceContent:
       weight (int): Defines the order in which datasources will be loaded.
     """
 
-    __slots__ = ["name", "content_identifier", "icon", "callback", "weight"]
+    __slots__ = ["callback", "content_identifier", "icon", "name", "weight"]
 
     def __init__(self, name, content_identifier, icon, callback, weight=1000):
         """Ensure datasource properties."""

nautobot/extras/secrets/__init__.py

@@ -57,10 +57,10 @@ def register_secrets_provider(provider):
 
 
 __all__ = (
-    "register_secrets_provider",
     "SecretError",
     "SecretParametersError",
     "SecretProviderError",
-    "SecretsProvider",
     "SecretValueNotFoundError",
+    "SecretsProvider",
+    "register_secrets_provider",
 )

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,
@@ -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)
@@ -876,10 +910,12 @@ class JobResultTable(BaseTable):
         """
         return format_html(
             """<label class="label label-default">{}</label>
+            <label class="label label-success">{}</label>
             <label class="label label-info">{}</label>
             <label class="label label-warning">{}</label>
             <label class="label label-danger">{}</label>""",
             record.debug_log_count,
+            record.success_log_count,
             record.info_log_count,
             record.warning_log_count,
             record.error_log_count,

nautobot/extras/templates/extras/dynamicgroup.html

@@ -50,15 +50,7 @@
                 <td>Group Type</td>
                 <td><span>{{ object.get_group_type_display }}</span></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>
+            {% include 'inc/tenant_table_row.html' %}
         </table>
     </div>
 {% endblock content_left_page %}

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>
@@ -208,6 +206,22 @@
                     {% endif %}
                 </td>
             </tr>
+            <tr>
+                <td>Is Singleton</td>
+                <td>{{ object.is_singleton | render_boolean }}</td>
+                <td>
+                    {% if object.is_singleton_override %}
+                        <span class="text-muted">
+                            overridden; default is
+                            {% if object.installed %}
+                                {{ object.job_class.is_singleton | render_boolean }}
+                            {% else %}
+                                unknown (not currently installed)
+                            {% endif %}
+                        </span>
+                    {% endif %}
+                </td>
+            </tr>
             <tr>
                 <td>Execution Soft Time Limit</td>
                 <td>
@@ -261,10 +275,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 +300,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 %}