nautobot 2.0.0a3__py3-none-any.whl → 2.0.0b1__py3-none-any.whl

nautobot/core/templates/inc/nav_menu.html

@@ -19,48 +19,43 @@
         <div id="navbar" class="navbar-collapse collapse">
             {% if request.user.is_authenticated %}
                 <ul class="nav navbar-nav">
-                    {% for tab_name, tab_details in registry.nav_menu.tabs.items %}
+                    {% for tab_name, tab_details in registry.nav_menu.items %}
                         {% if request.user|has_one_or_more_perms:tab_details.permissions or not "HIDE_RESTRICTED_UI"|settings_or_config %}
                             <li class="dropdown">
-                                <a href="#" class="dropdown-toggle" data-tab-weight="{{ tab_details.weight }}" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">
+                                <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">
                                     {{ tab_name }} <span class="caret"></span>
                                 </a>
                                 <ul class="dropdown-menu">
                                     {% for group_name, group_details in tab_details.groups.items %}
                                         {% if request.user|has_one_or_more_perms:group_details.permissions or not "HIDE_RESTRICTED_UI"|settings_or_config %}
                                             <li class="dropdown-header" data-group-weight="{{ group_details.weight }}">{{ group_name }}</li>
-                                            {% for item_link, item_details in group_details.items.items %}
+                                            {% for item_name, item_details in group_details.items.items %}
                                                 {% if request.user|has_one_or_more_perms:item_details.permissions or not "HIDE_RESTRICTED_UI"|settings_or_config %}
-                                                    <li {% if not request.user|has_perms:item_details.permissions %} class="disabled"{% endif %}>
-                                                        <div class="buttons pull-right">
-                                                            {% for button_title, button_details in item_details.buttons.items %}
-                                                                {% if request.user|has_perms:button_details.permissions %}
-                                                                    {% comment %}
-                                                                        Use 'url xxx as variable' so that an invalid
-                                                                        link doesn't throw a NoReverseMatch exception.
-                                                                    {% endcomment %}
-                                                                    {% url button_details.link as button_url %}
-                                                                    {% if button_url %}
-                                                                        <a href="{{ button_url }}"
-                                                                           data-button-weight="{{ button_details.weight }}"
-                                                                           class="btn btn-xs btn-{{ button_details.button_class }}"
-                                                                           title="{{ button_title }}">
-                                                                            <i class="mdi {{ button_details.icon_class }}"></i>
-                                                                        </a>
-                                                                    {% else %}
-                                                                        <a class="btn btn-xs btn-danger"
-                                                                           title="ERROR: Invalid link!">
-                                                                            <i class="mdi mdi-alert"></i>
-                                                                        </a>
-                                                                    {% endif %}
-                                                                {% endif %}
-                                                            {% endfor %}
-                                                        </div>
-                                                        <a href="{{ item_link }}"
-                                                            data-item-weight="{{ item_details.weight }}">
-                                                            {{ item_details.name }}
-                                                        </a>
-                                                    </li>
+                                                    {% if item_details.link %}
+                                                        <li {% if not request.user|has_perms:item_details.permissions %} class="disabled"{% endif %}>
+                                                            <a href="{{ item_details.link }}"
+                                                                data-item-weight="{{ item_details.weight }}">
+                                                                {{ item_name }}
+                                                            </a>
+                                                        </li>
+                                                    {% else %}
+                                                        {% comment %}
+                                                            This UI doesn't have support for sub-groups in menus, so
+                                                            we render them at the same level as a workaround for now.
+                                                        {% endcomment %}
+                                                        <li class="divider"></li>
+                                                        <li class="dropdown-header" data-group-weight="{{ item_details.weight }}">{{ item_name }}</li>
+                                                        {% for subitem_name, subitem_details in item_details.items.items %}
+                                                            {% if request.user|has_one_or_more_perms:subitem_details.permissions or not "HIDE_RESTRICTED_UI"|settings_or_config %}
+                                                                <li {% if not request.user|has_perms:item_details.permissions %} class="disabled"{% endif %}>
+                                                                    <a href="{{ subitem_details.link }}"
+                                                                        data-item-weight="{{ subitem_details.weight }}">
+                                                                        {{ subitem_name }}
+                                                                    </a>
+                                                                </li>
+                                                            {% endif %}
+                                                        {% endfor %}
+                                                    {% endif %}
                                                 {% endif %}
                                             {% endfor %}
                                             {% if not forloop.last %}

nautobot/core/templates/inc/object_details_advanced_panel.html

@@ -16,6 +16,19 @@
                         </span>
                     </td>
                 </tr>
+                {% if object.natural_key_slug %}
+                    <tr>
+                        <td>Natural-key Slug</td>
+                        <td>
+                            <span class="hover_copy">
+                                <span id="natural_key_slug_copy">{{ object.natural_key_slug }}</span>
+                                <button class="btn btn-inline btn-default hover_copy_button" data-clipboard-target="#natural_key_slug_copy">
+                                    <span class="mdi mdi-content-copy"></span>
+                                </button>
+                            </span>
+                        </td>
+                    </tr>
+                {% endif %}
                 {% if object.slug %}
                     <tr>
                         <td>Slug</td>

nautobot/core/templates/inc/relationships_table_rows.html

@@ -4,14 +4,14 @@
         {% for side, relationships in relationships.items %}
             {% for relationship, value in relationships.items %}
                 <tr>
-                    <td><span title="{{ relationship.slug }}">{{ value.label }}</span></td>
+                    <td><span title="{{ relationship.key }}">{{ value.label }}</span></td>
                 {% if not value.has_many and value.value %}
                     <td>
                         <a href="{{ value.url }}">{{ value.value }}</a>
                     </td>
                 {% elif value.has_many and value.queryset.count %}
                     <td>
-                        <a href="{% url 'extras:relationshipassociation_list' %}?relationship={{relationship.slug}}&{{side}}_id={{object.id}}">
+                        <a href="{% url 'extras:relationshipassociation_list' %}?relationship={{relationship.key}}&{{side}}_id={{object.id}}">
                             {{ value.queryset.count }}
                             {% comment %}
                             If peer_type is a plugin model that has subsequently been uninstalled,

nautobot/core/templates/nautobot_config.py.j2

@@ -21,8 +21,11 @@ from nautobot.core.settings_funcs import is_truthy, parse_redis_connection
 #
 # CACHES = {
 #     "default": {
-#         "BACKEND": "django_redis.cache.RedisCache",
-#         "LOCATION": parse_redis_connection(redis_database=0),
+#         "BACKEND": os.getenv(
+#             "NAUTOBOT_CACHES_BACKEND",
+#             "django_prometheus.cache.backends.redis.RedisCache" if METRICS_ENABLED else "django_redis.cache.RedisCache",
+#         ),
+#         "LOCATION": parse_redis_connection(redis_database=1),
 #         "TIMEOUT": 300,
 #         "OPTIONS": {
 #             "CLIENT_CLASS": "django_redis.client.DefaultClient",
@@ -31,10 +34,6 @@ from nautobot.core.settings_funcs import is_truthy, parse_redis_connection
 #     }
 # }
 
-# Redis connection to use for caching.
-#
-# CACHEOPS_REDIS = os.getenv("NAUTOBOT_CACHEOPS_REDIS", parse_redis_connection(redis_database=1))
-
 # Celery broker URL used to tell workers where queues are located
 #
 # CELERY_BROKER_URL = os.getenv("NAUTOBOT_CELERY_BROKER_URL", parse_redis_connection(redis_database=0))
@@ -55,7 +54,8 @@ from nautobot.core.settings_funcs import is_truthy, parse_redis_connection
 #         "PORT": os.getenv("NAUTOBOT_DB_PORT", ""),  # Database port (leave blank for default)
 #         "CONN_MAX_AGE": int(os.getenv("NAUTOBOT_DB_TIMEOUT", "300")),  # Database timeout
 #         "ENGINE": os.getenv(
-#             "NAUTOBOT_DB_ENGINE", "django.db.backends.postgresql"
+#             "NAUTOBOT_DB_ENGINE",
+#             "django_prometheus.db.backends.postgresql" if METRICS_ENABLED else "django.db.backends.postgresql",
 #         ),  # Database driver ("mysql" or "postgresql")
 #     }
 # }
@@ -244,18 +244,6 @@ SECRET_KEY = os.getenv("NAUTOBOT_SECRET_KEY", "{{ secret_key }}")
 #     "help": os.getenv("NAUTOBOT_BRANDING_URLS_HELP", "https://github.com/nautobot/nautobot/wiki"),
 # }
 
-# Cache timeout in seconds. Cannot be 0. Defaults to 900 (15 minutes). To disable caching, set CACHEOPS_ENABLED to False
-#
-# CACHEOPS_DEFAULTS = {"timeout": int(os.getenv("NAUTOBOT_CACHEOPS_TIMEOUT", "900"))}
-
-# Set to True to enable caching with cacheops. (Default: False)
-#
-# CACHEOPS_ENABLED = is_truthy(os.getenv("NAUTOBOT_CACHEOPS_ENABLED", "False"))
-
-# Set to True to enable periodic health checks for the Redis server connection used by cacheops.
-#
-# CACHEOPS_HEALTH_CHECK_ENABLED = False
-
 # Options to pass to the Celery broker transport, for example when using Celery with Redis Sentinel.
 #
 # CELERY_BROKER_TRANSPORT_OPTIONS = {}
@@ -437,7 +425,7 @@ SECRET_KEY = os.getenv("NAUTOBOT_SECRET_KEY", "{{ secret_key }}")
 # SANITIZER_PATTERNS = [
 #     # General removal of username-like and password-like tokens
 #     (re.compile(r"(https?://)?\S+\s*@", re.IGNORECASE), r"\1{replacement}@"),
-#     (re.compile(r"(username|password|passwd|pwd)(\s*i?s?\s*:?\s*)?\S+", re.IGNORECASE), r"\1\2{replacement}"),
+#     (re.compile(r"(username|password|passwd|pwd)((?:\s+is.?|:)?\s+)\S+", re.IGNORECASE), r"\1\2{replacement}"),
 # ]
 
 # Configure SSO, for more information see docs/configuration/authentication/sso.md

nautobot/core/templates/plugin_template/__init__.py-tpl

@@ -13,7 +13,6 @@ class {{ camel_case_app_name }}Config(PluginConfig):
     min_version = "1.0.0"  # Minimum version of Nautobot with which the plugin is compatible.
     max_version = "1.999"  # Maximum version of Nautobot with which the plugin is compatible.
     default_settings = {}  # A dictionary of configuration parameters and their default values.
-    caching_config = {}  # Plugin-specific cache configuration.
 
 
-config = {{ camel_case_app_name }}Config
+config = {{ camel_case_app_name }}Config

nautobot/core/templates/rest_framework/api.html

@@ -18,4 +18,12 @@
 
 {% block script %}
     {% include 'inc/javascript.html' %}
+    <script src="{% static "rest_framework/js/prettify-min.js" %}"></script>
+    <script src="{% static "rest_framework/js/ajax-form.js" %}"></script>
+    <script src="{% static "rest_framework/js/default.js" %}"></script>
+    <script>
+    $(document).ready(function() {
+        $('form').ajaxForm();
+    });
+    </script>
 {% endblock script %}

nautobot/core/templatetags/buttons.py

@@ -37,25 +37,24 @@ def edit_button(instance, use_pk=False, key="slug"):
 
     Args:
         instance: Model record.
-        use_pk: If True, use the primary key instead of any specified "key" field. (Deprecated, use `key="pk"` instead)
-        key: The attribute on the model to use for reverse URL lookup.
+        use_pk: Used for backwards compatibility, no-op in this function.
+        key: Used for backwards compatibility, no-op in this function.
     """
     viewname = lookup.get_route_for_model(instance, "edit")
 
-    # Assign kwargs
-    if hasattr(instance, key) and not use_pk:
-        kwargs = {key: getattr(instance, key)}
-    else:
-        kwargs = {"pk": instance.pk}
+    # We try different lookups to get a valid reverse url
+    lookup_keys = ["pk", "slug", "key"]
 
-    try:
-        url = reverse(viewname, kwargs=kwargs)
-    except NoReverseMatch:
-        return {"url": None}
+    for lookup_key in lookup_keys:
+        if hasattr(instance, lookup_key):
+            kwargs = {lookup_key: getattr(instance, lookup_key)}
+            try:
+                url = reverse(viewname, kwargs=kwargs)
+                return {"url": url}
+            except NoReverseMatch:
+                continue
 
-    return {
-        "url": url,
-    }
+    return {"url": None}
 
 
 @register.inclusion_tag("buttons/delete.html")
@@ -65,25 +64,24 @@ def delete_button(instance, use_pk=False, key="slug"):
 
     Args:
         instance: Model record.
-        use_pk: If True, use the primary key instead of any specified "key" field. (Deprecated, use `key="pk"` instead)
-        key: The attribute on the model to use for reverse URL lookup.
+        use_pk: Used for backwards compatibility, no-op in this function.
+        key: Used for backwards compatibility, no-op in this function.
     """
     viewname = lookup.get_route_for_model(instance, "delete")
 
-    # Assign kwargs
-    if hasattr(instance, key) and not use_pk:
-        kwargs = {key: getattr(instance, key)}
-    else:
-        kwargs = {"pk": instance.pk}
+    # We try different lookups to get a valid reverse url
+    lookup_keys = ["pk", "slug", "key"]
 
-    try:
-        url = reverse(viewname, kwargs=kwargs)
-    except NoReverseMatch:
-        return {"url": None}
+    for lookup_key in lookup_keys:
+        if hasattr(instance, lookup_key):
+            kwargs = {lookup_key: getattr(instance, lookup_key)}
+            try:
+                url = reverse(viewname, kwargs=kwargs)
+                return {"url": url}
+            except NoReverseMatch:
+                continue
 
-    return {
-        "url": url,
-    }
+    return {"url": None}
 
 
 #
@@ -115,10 +113,16 @@ def export_button(context, content_type=None):
     if content_type is not None:
         user = context["request"].user
         export_templates = models.ExportTemplate.objects.restrict(user, "view").filter(content_type=content_type)
+        try:
+            export_url = reverse(lookup.get_route_for_model(content_type.model_class(), "list", api=True))
+        except NoReverseMatch:
+            export_url = None
     else:
         export_templates = []
+        export_url = None
 
     return {
+        "export_url": export_url,
         "url_params": context["request"].GET,
         "export_templates": export_templates,
     }

nautobot/core/testing/__init__.py

@@ -1,7 +1,7 @@
-import uuid
+import collections
 
 from django.contrib.auth import get_user_model
-from django.test import RequestFactory, TransactionTestCase as _TransactionTestCase
+from django.test import TransactionTestCase as _TransactionTestCase
 from django.test import tag
 
 from nautobot.core.testing.api import APITestCase, APIViewTestCases
@@ -16,20 +16,21 @@ from nautobot.core.testing.utils import (
     post_data,
 )
 from nautobot.core.testing.views import ModelTestCase, ModelViewTestCase, TestCase, ViewTestCases
-from nautobot.core.utils.requests import copy_safe_request
-from nautobot.extras.jobs import run_job
-from nautobot.extras.models import JobResult
-from nautobot.extras.utils import get_job_content_type
+from nautobot.extras.jobs import get_job
+from nautobot.extras.models import Job, JobResult
 
 __all__ = (
     "APITestCase",
     "APIViewTestCases",
+    "create_job_result_and_run_job",
     "create_test_user",
     "disable_warnings",
     "extract_form_failures",
     "extract_page_body",
     "FilterTestCases",
     "get_deletable_objects",
+    "get_job_class_and_model",
+    "JobClassInfo",
     "ModelTestCase",
     "ModelViewTestCase",
     "NautobotTestCaseMixin",
@@ -44,66 +45,68 @@ __all__ = (
 User = get_user_model()
 
 
-def run_job_for_testing(job, data=None, commit=True, username="test-user", request=None):
+def run_job_for_testing(job, username="test-user", profile=False, **kwargs):
     """
     Provide a common interface to run Nautobot jobs as part of unit tests.
 
-    The Celery task result will be stored at the `JobResult.celery_result` attribute.
-
     Args:
       job (Job): Job model instance (not Job class) to run
-      data (dict): Input data values for any Job variables.
-      commit (bool): Whether to commit changes to the database or rollback when done.
-      username (str): Username of existing or to-be-created User account to own the JobResult. Ignored if `request.user`
-        exists.
-      request (HttpRequest): Existing request (if any) to own the JobResult.
+      username (str): Username of existing or to-be-created User account to own the JobResult.
+      profile (bool): Whether to profile the job execution.
+      **kwargs: Input keyword arguments for Job run method.
 
     Returns:
       JobResult: representing the executed job
     """
-    if data is None:
-        data = {}
-
     # Enable the job if it wasn't enabled before
     if not job.enabled:
         job.enabled = True
         job.validated_save()
 
-    # If the request has a user, ignore the username argument and use that user.
-    if request and request.user:
-        user_instance = request.user
-    else:
-        user_instance, _ = User.objects.get_or_create(
-            username=username, defaults={"is_superuser": True, "password": "password"}
-        )
-    job_result = JobResult.objects.create(
-        name=job.class_path,
-        task_kwargs={"data": data, "commit": commit},
-        obj_type=get_job_content_type(),
-        user=user_instance,
+    user_instance, _ = User.objects.get_or_create(
+        username=username, defaults={"is_superuser": True, "password": "password"}
+    )
+    # Run the job synchronously in the current thread as if it were being executed by a worker
+    job_result = JobResult.execute_job(
         job_model=job,
-        task_id=uuid.uuid4(),
+        user=user_instance,
+        profile=profile,
+        **kwargs,
     )
+    return job_result
 
-    if request is None:
-        factory = RequestFactory()
-        request = factory.request()
-        request.user = user_instance
-
-    # Instead of a context manager, we're just explicitly creating a `NautobotFakeRequest`.
-    wrapped_request = copy_safe_request(request)
 
-    # This runs the job synchronously in the current thread as if it were being executed by a
-    # worker, therefore resulting in updating the `JobResult` as expected.
-    celery_result = run_job.apply(
-        kwargs={"data": data, "request": wrapped_request, "commit": commit, "job_result_pk": job_result.pk},
-        task_id=job_result.task_id,
-    )
-    job_result.celery_result = celery_result
+def create_job_result_and_run_job(module, name, source="local", *args, **kwargs):
+    """Test helper function to call get_job_class_and_model() then call run_job_for_testing()."""
+    _job_class, job_model = get_job_class_and_model(module, name, source)
+    job_result = run_job_for_testing(job=job_model, **kwargs)
     job_result.refresh_from_db()
     return job_result
 
 
+#: Return value of `get_job_class_and_model()`.
+JobClassInfo = collections.namedtuple("JobClassInfo", "job_class job_model")
+
+
+def get_job_class_and_model(module, name, source="local"):
+    """
+    Test helper function to look up a job class and job model and ensure the latter is enabled.
+
+    Args:
+        module (str): Job module name
+        name (str): Job class name
+        source (str): Job grouping (default: "local")
+
+    Returns:
+        JobClassInfo: Named 2-tuple of (job_class, job_model)
+    """
+    job_class = get_job(f"{module}.{name}")
+    job_model = Job.objects.get(module_name=module, job_class_name=name)
+    job_model.enabled = True
+    job_model.validated_save()
+    return JobClassInfo(job_class, job_model)
+
+
 @tag("unit")
 class TransactionTestCase(_TransactionTestCase, NautobotTestCaseMixin):
     """