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

nautobot/extras/templates/extras/plugin_detail.html

@@ -1,4 +1,4 @@
-{% extends 'generic/object_detail.html' %}
+{% extends 'generic/object_retrieve.html' %}
 {% load helpers %}
 
 {% block header %}
@@ -7,27 +7,32 @@
             <ol class="breadcrumb">
                 {% block breadcrumbs %}
                     <li><a href="{% url 'apps:apps_list' %}">Installed Apps</a></li>
-                    <li><a href="{% url 'apps:app_detail' app=object.name %}">{{ object.verbose_name | bettertitle }}</a></li>
+                    <li><a href="{% url 'apps:app_detail' app=app_data.package %}">{{ app_data.name | bettertitle }}</a></li>
                 {% endblock breadcrumbs %}
             </ol>
         </div>
     </div>
     <div class="pull-right noprint">
         {% block buttons %}
-            {% if object.home_view_name %}
-                <a href="{% url object.home_view_name %}" class="btn btn-success">
+            {% if app_data.home_url %}
+                <a href="{% url app_data.home_url %}" class="btn btn-primary">
                     <i class="mdi mdi-home"></i> App Home
                 </a>
             {% endif %}
-            {% if object.config_view_name %}
-                <a href="{% url object.config_view_name %}" class="btn btn-warning">
+            {% if app_data.config_url %}
+                <a href="{% url app_data.config_url %}" class="btn btn-warning">
                     <i class="mdi mdi-cog"></i> App Configuration
                 </a>
             {% endif %}
+            {% if app_data.docs_url %}
+                <a href="{% url app_data.docs_url %}" class="btn btn-info">
+                    <i class="mdi mdi-cog"></i> App Documentation
+                </a>
+            {% endif %}
         {% endblock buttons %}
     </div>
     {% block masthead %}
-        <h1>{% block title %}{{ object.verbose_name | bettertitle }}{% endblock %}</h1>
+        <h1>{% block title %}{{ app_data.name | bettertitle }}{% endblock %}</h1>
     {% endblock masthead %}
 {% endblock header %}
 
@@ -42,25 +47,37 @@
                     <table class="table table-hover panel-body attr-table">
                         <tr>
                             <td>Package Name</td>
-                            <td><code>{{ object.name }}</code></td>
+                            <td><code>{{ app_data.package }}</code></td>
+                        </tr>
+                        <tr>
+                            <td>Headline</td>
+                            <td>{{ app_data.headline }}</td>
                         </tr>
+                        {% if app_data.description and app_data.headline != app_data.description %}
                         <tr>
                             <td>Description</td>
-                            <td>{{ object.description }}</td>
+                            <td>{{ app_data.description }}</td>
                         </tr>
+                        {% endif %}
                         <tr>
                             <td>Version</td>
-                            <td>{{ object.version }}</td>
+                            <td>v{{ app_data.version }}</td>
                         </tr>
                         <tr>
-                            <td>Author</td>
+                            <td>By</td>
                             <td>
-                                {{ object.author | placeholder }}
-                                {% if object.author_email %}
-                                    (<a href="mailto:{{ object.author_email }}">{{ object.author_email }}</a>)
+                                {{ app_data.author | placeholder }}
+                                {% if app_data.author_email %}
+                                    (<a href="mailto:{{ app_data.author_email }}">{{ app_data.author_email }}</a>)
                                 {% endif %}
                             </td>
                         </tr>
+                        {% if app_data.availability %}
+                        <tr>
+                            <td>License</td>
+                            <td><label class="label label-transparent">{{ app_data.availability }}</label></td>
+                        </tr>
+                        {% endif %}
                     </table>
                 </div>
                 <div class="panel panel-default">
@@ -70,11 +87,11 @@
                     <table class="table table-hover panel-body attr-table">
                         <tr>
                             <td>Min Nautobot Version</td>
-                            <td>{{ object.min_version | placeholder }}</td>
+                            <td>v{{ object.min_version | placeholder }}</td>
                         </tr>
                         <tr>
                             <td>Max Nautobot Version</td>
-                            <td>{{ object.max_version | placeholder }}</td>
+                            <td>v{{ object.max_version | placeholder }}</td>
                         </tr>
                     </table>
                 </div>

nautobot/extras/templates/extras/plugins_tiles.html

@@ -9,6 +9,7 @@
     }
 
     .tile-header h2 {
+        margin-bottom: 5px;
         margin-top: 0;
     }
 
@@ -17,6 +18,11 @@
         margin-left: 3px;
     }
 
+    .tile-description {
+        margin-top: 10px;
+        min-height: 72px;  /* allow room for three rows of text */
+    }
+
     .tile-actions {
         position: absolute;
         right: 21px;
@@ -36,7 +42,7 @@
                 <header class="tile-header">
                     <img
                         alt="{{ row.record.name }}"
-                        src="{% if app_icons|get_item:row.record.package_name != None %}{{ app_icons|get_item:row.record.package_name }}{% else %}{% static 'img/nautobot_icon_192x192.png' %}{% endif %}"
+                        src="{% if app_icons|get_item:row.record.package != None %}{{ app_icons|get_item:row.record.package }}{% else %}{% static 'img/nautobot_icon_192x192.png' %}{% endif %}"
                         height="64"
                         width="64"
                     />
@@ -45,20 +51,25 @@
                        Occupy `.tile-actions` dedicated space with `.tile-actions-placeholder`. See comment above
                        `.tile-actions` element for detailed explanation of this solution and why it is required here.
                     -->
-                    <div
-                        aria-hidden="true"
-                        class="tile-actions-placeholder pull-right"
-                        style="width: calc(32px * {{ row.record.actions|length }} + 3px * {{ row.record.actions|length|add:-1 }})">
-                    </div>
+                    {% with actions_count=3 %}
+                        <div
+                            aria-hidden="true"
+                            class="tile-actions-placeholder pull-right"
+                            style="width: calc(32px * {{ actions_count }} + 3px * {{ actions_count|add:-1 }})">
+                        </div>
+                    {% endwith %}
 
                     <h2>{{ row.record.name }}</h2>
-
-                    <p class="tile-description">{{ row.record.description }}</p>
                 </header>
 
+                <p class="tile-description">{{ row.record.headline }}</p>
+
                 <footer class="tile-footer">
-                    <div>Author: {{ row.record.author }}</div>
-                    <div>Version: {{ row.record.version }}</div>
+                    <div>By: {{ row.record.author }}</div>
+                    <div>
+                        <label class="label label-transparent">{{ row.record.availability }}</label>
+                        v{{ row.record.version }}
+                    </div>
                 </footer>
             </a>
 

nautobot/extras/templates/extras/relationship.html

@@ -1,63 +1 @@
-{% extends 'generic/object_detail.html' %}
-{% load buttons %}
-{% load plugins %}
-{% load perms %}
-{% load helpers %}
-
-{% block content_left_page %}
-    <div class="panel panel-default">
-        <div class="panel-heading">
-            <strong>Relationship</strong>
-        </div>
-        <table class="table table-hover panel-body attr-table">
-            <tr>
-                <td>Description</td>
-                <td>{{ object.description | placeholder }}</td>
-            </tr>
-            <tr>
-                <td>Type</td>
-                <td>{{ object.type }}</td>
-            </tr>
-            <tr>
-                <td>Required On</td>
-                <td>{{ object.get_required_on_display }}</td>
-            </tr>
-            <tr>
-                <td>On Advanced Tab</td>
-                <td>{{ object.advanced_ui | render_boolean }}</td>
-            </tr>
-            <tr>
-                <td>Source Content Type</td>
-                <td>{{ object.source_type }}</td>
-            </tr>
-            <tr>
-                <td>Source Label</td>
-                <td>{{ object.source_label | placeholder }}</td>
-            </tr>
-            <tr>
-                <td>Source Filter</td>
-                <td>{% if object.source_filter %}<pre>{{ object.source_filter | render_json }}</pre>{% else %}{{ None | placeholder }}{% endif %}</td>
-            </tr>
-            <tr>
-                <td>Hide on Source Object</td>
-                <td>{{ object.source_hidden | render_boolean }}</td>
-            </tr>
-            <tr>
-                <td>Destination Content Type</td>
-                <td>{{ object.destination_type }}</td>
-            </tr>
-            <tr>
-                <td>Destination Label</td>
-                <td>{{ object.destination_label | placeholder }}</td>
-            </tr>
-            <tr>
-                <td>Destination Filter</td>
-                <td>{% if object.destination_filter %}<pre>{{ object.destination_filter | render_json }}</pre>{% else %}{{ None | placeholder }}{% endif %}</td>
-            </tr>
-            <tr>
-                <td>Hide on Destination Object</td>
-                <td>{{ object.destination_hidden | render_boolean }}</td>
-            </tr>
-        </table>
-    </div>
-{% endblock content_left_page %}
+{% extends 'generic/object_retrieve.html' %}

nautobot/extras/templates/extras/role_retrieve.html

@@ -1,4 +1,4 @@
-{% extends 'generic/object_detail.html' %}
+{% extends 'generic/object_retrieve.html' %}
 {% load helpers %}
 
 {% block content_left_page %}

nautobot/extras/templates/extras/scheduledjob.html

@@ -1,4 +1,4 @@
-{% extends 'generic/object_detail.html' %}
+{% extends 'generic/object_retrieve.html' %}
 {% load buttons %}
 {% load custom_links %}
 {% load helpers %}

nautobot/extras/templates/extras/secret.html

@@ -1 +1 @@
-{% extends 'generic/object_detail.html' %}
+{% extends 'generic/object_retrieve.html' %}

nautobot/extras/templates/extras/secretsgroup.html

@@ -1,4 +1,4 @@
-{% extends "generic/object_detail.html" %}
+{% extends "generic/object_retrieve.html" %}
 {% load helpers %}
 
 {% block content_left_page %}

nautobot/extras/templates/extras/status.html

@@ -1,4 +1,4 @@
-{% extends 'generic/object_detail.html' %}
+{% extends 'generic/object_retrieve.html' %}
 {% load helpers %}
 
 {% block content_left_page %}

nautobot/extras/templates/extras/tag.html

@@ -1,4 +1,4 @@
-{% extends 'generic/object_detail.html' %}
+{% extends 'generic/object_retrieve.html' %}
 {% load helpers %}
 
 {% block content_left_page %}

nautobot/extras/templates/extras/webhook.html

@@ -1,4 +1,4 @@
-{% extends 'generic/object_detail.html' %}
+{% extends 'generic/object_retrieve.html' %}
 {% load helpers %}
 
 {% block content_left_page %}

nautobot/extras/templatetags/job_buttons.py

@@ -8,7 +8,7 @@ from django.utils.html import format_html
 from django.utils.safestring import mark_safe
 
 from nautobot.core.utils.data import render_jinja2
-from nautobot.extras.models import Job, JobButton
+from nautobot.extras.models import Job, JobButton, JobQueue
 
 register = template.Library()
 
@@ -108,17 +108,17 @@ def _render_job_button_for_obj(job_button, obj, context, content_type):
     # Disable buttons if the user doesn't have permission to run the underlying Job.
     has_run_perm = Job.objects.check_perms(context["user"], instance=job_button.job, action="run")
     try:
-        job_queues = list(job_button.job.job_queues.all().values_list("name", flat=True))
+        job_queues = job_button.job.job_queues.all()
         _job_queue = job_queues[0]
     except IndexError:
-        _job_queue = settings.CELERY_TASK_DEFAULT_QUEUE
+        _job_queue = JobQueue.objects.get(name=settings.CELERY_TASK_DEFAULT_QUEUE)
     hidden_inputs = format_html(
         HIDDEN_INPUTS,
         csrf_token=context["csrf_token"],
         object_pk=obj.pk,
         object_model_name=f"{content_type.app_label}.{content_type.model}",
         redirect_path=context["request"].path,
-        job_queue=_job_queue,
+        job_queue=_job_queue.pk,
     )
     template_args = {
         "button_id": job_button.pk,

nautobot/extras/test_jobs/api_test_job.py

@@ -18,7 +18,7 @@ class APITestJob(Job):
     var3 = BooleanVar()
     var4 = ObjectVar(model=Role)
 
-    def run(self, var1, var2, var3, var4):
+    def run(self, var1, var2, var3, var4):  # pylint:disable=arguments-differ
         logger.debug(var1)
         logger.info(var2)
         logger.warning(var3)

nautobot/extras/test_jobs/atomic_transaction.py

@@ -19,7 +19,7 @@ class TestAtomicDecorator(Job):
     fail = BooleanVar()
 
     @transaction.atomic
-    def run(self, fail=False):
+    def run(self, fail=False):  # pylint:disable=arguments-differ
         try:
             Status.objects.create(name="Test database atomic rollback 1")
             if fail:
@@ -37,7 +37,7 @@ class TestAtomicContextManager(Job):
 
     fail = BooleanVar()
 
-    def run(self, fail=False):
+    def run(self, fail=False):  # pylint:disable=arguments-differ
         try:
             with transaction.atomic():
                 Status.objects.create(name="Test database atomic rollback 2")

nautobot/extras/test_jobs/dry_run.py

@@ -13,7 +13,7 @@ class TestDryRun(Job):
     dryrun = DryRunVar()
     value = IntegerVar(required=False)
 
-    def run(self, dryrun, value=None):
+    def run(self, dryrun, value=None):  # pylint:disable=arguments-differ
         """
         Job function.
         """

nautobot/extras/test_jobs/fail.py

@@ -7,7 +7,7 @@ from nautobot.extras.jobs import get_task_logger, Job, RunJobTaskFailed
 logger = get_task_logger(__name__)
 
 
-class TestFail(Job):
+class TestFailJob(Job):
     """
     Job with fail result.
     """
@@ -15,7 +15,7 @@ class TestFail(Job):
     description = "Validate job import"
 
     def before_start(self, task_id, args, kwargs):
-        if task_id != self.request.id:
+        if task_id != self.request.id:  # pylint: disable=no-member
             raise RuntimeError(f"Expected task_id {task_id} to equal self.request.id {self.request.id}")
         if args:
             raise RuntimeError(f"Expected args to be empty, but it was {args!r}")
@@ -23,7 +23,7 @@ class TestFail(Job):
             raise RuntimeError(f"Expected kwargs to be empty, but it was {kwargs!r}")
         logger.info("before_start() was called as expected")
 
-    def run(self):
+    def run(self):  # pylint:disable=arguments-differ
         """
         Job function.
         """
@@ -71,7 +71,7 @@ class TestFailWithSanitization(Job):
 
     description = "Validate job failure sanitization"
 
-    def run(self):
+    def run(self):  # pylint:disable=arguments-differ
         logger.info("I'm a test job that fails and sanitizes the exception!")
         exc = RunJobTaskFailed(
             "fatal: could not read Password for 'https://abc123@github.com': terminal prompts disabled"
@@ -91,4 +91,4 @@ class TestFailWithSanitization(Job):
         raise exc
 
 
-register_jobs(TestFail, TestFailWithSanitization)
+register_jobs(TestFailJob, TestFailWithSanitization)

nautobot/extras/test_jobs/file_output.py

@@ -9,7 +9,7 @@ class FileOutputJob(Job):
         name = "File Output job"
         description = "Creates a text file as output."
 
-    def run(self, lines):
+    def run(self, lines):  # pylint:disable=arguments-differ
         self.create_file("output.txt", "Hello World!\n" * lines)
 
 

nautobot/extras/test_jobs/file_upload_fail.py

@@ -21,7 +21,7 @@ class TestFileUploadFail(Job):
         description="File to upload",
     )
 
-    def run(self, file):
+    def run(self, file):  # pylint:disable=arguments-differ
         contents = str(file.read())
         logger.warning("File contents: %s", contents)
 

nautobot/extras/test_jobs/file_upload_pass.py

@@ -13,7 +13,7 @@ class TestFileUploadPass(Job):
         description="File to upload",
     )
 
-    def run(self, file):
+    def run(self, file):  # pylint:disable=arguments-differ
         contents = str(file.read())
         logger.warning("File contents: %s", contents)
         logger.info("Job didn't crash!")

nautobot/extras/test_jobs/ipaddress_vars.py

@@ -39,7 +39,9 @@ class TestIPAddresses(Job):
             if kwargs[expected_kwarg] is None:
                 raise RuntimeError(f"kwargs[{expected_kwarg}] is unexpectedly None!")
 
-    def run(self, *, ipv4_address, ipv4_with_mask, ipv4_network, ipv6_address, ipv6_with_mask, ipv6_network):
+    def run(  # pylint:disable=arguments-differ
+        self, *, ipv4_address, ipv4_with_mask, ipv4_network, ipv6_address, ipv6_with_mask, ipv6_network
+    ):
         if not isinstance(ipv4_address, netaddr.IPAddress):
             raise RuntimeError(f"Expected ipv4_address to be a netaddr.IPAddress, but it was {ipv4_address!r}")
         if not isinstance(ipv4_with_mask, netaddr.IPNetwork):

nautobot/extras/test_jobs/jobs_module/jobs_submodule/jobs.py

@@ -2,5 +2,5 @@ from nautobot.apps.jobs import Job
 
 
 class ChildJob(Job):
-    def run(self):
+    def run(self):  # pylint:disable=arguments-differ
         pass

nautobot/extras/test_jobs/location_with_custom_field.py

@@ -15,7 +15,7 @@ class TestCreateLocationWithCustomField(Job):
         name = "Location and Custom Field Creation"
         description = "Location with a custom field"
 
-    def run(self):
+    def run(self):  # pylint: disable=arguments-differ
         with transaction.atomic():
             obj_type = ContentType.objects.get_for_model(Location)
             cf = CustomField(label="cf1", type=CustomFieldTypeChoices.TYPE_TEXT, default="-")

nautobot/extras/test_jobs/log_redaction.py

@@ -8,7 +8,7 @@ class TestLogRedaction(Job):
     class Meta:
         description = "Test redaction of logs"
 
-    def run(self):
+    def run(self):  # pylint: disable=arguments-differ
         logger.debug("The secret is supersecret123")
         logger.info("The secret is supersecret123")
         logger.warning("The secret is supersecret123")

nautobot/extras/test_jobs/log_skip_db_logging.py

@@ -8,7 +8,7 @@ class TestLogSkipDBLogging(Job):
     class Meta:
         description = "Test logs not being saved to the database"
 
-    def run(self):
+    def run(self):  # pylint: disable=arguments-differ
         logger.debug("I should NOT be logged to the database", extra={"skip_db_logging": True})
         logger.info("I should be logged to the database")
 

nautobot/extras/test_jobs/modify_db.py

@@ -10,7 +10,7 @@ class TestModifyDB(Job):
     Job that modifies the database.
     """
 
-    def run(self):
+    def run(self):  # pylint: disable=arguments-differ
         """
         Job function.
         """

nautobot/extras/test_jobs/object_var_optional.py

@@ -12,7 +12,7 @@ class TestOptionalObjectVar(Job):
         required=False,
     )
 
-    def run(self, location=None):
+    def run(self, location=None):  # pylint: disable=arguments-differ
         logger.info("The Location if any that the user provided.", extra={"object": location})
         return "Nice Location (or not)!"
 

nautobot/extras/test_jobs/object_var_required.py

@@ -12,7 +12,7 @@ class TestRequiredObjectVar(Job):
         required=True,
     )
 
-    def run(self, location):
+    def run(self, location):  # pylint: disable=arguments-differ
         logger.info("The Location that the user provided.", extra={"object": location})
         return "Nice Location!"
 

nautobot/extras/test_jobs/object_vars.py

@@ -13,7 +13,7 @@ class TestObjectVars(Job):
     role = ObjectVar(model=Role)
     roles = MultiObjectVar(model=Role)
 
-    def run(self, role, roles):
+    def run(self, role, roles):  # pylint: disable=arguments-differ
         logger.info("Role: %s", role)
         logger.warning("Roles: %s", roles)
 

nautobot/extras/test_jobs/pass.py

@@ -5,7 +5,7 @@ from nautobot.extras.jobs import get_task_logger, Job
 logger = get_task_logger(__name__)
 
 
-class TestPass(Job):
+class TestPassJob(Job):
     """
     Job with pass result.
     """
@@ -24,7 +24,7 @@ class TestPass(Job):
             raise RuntimeError(f"Expected kwargs to be empty, but it was {kwargs!r}")
         logger.info("before_start() was called as expected")
 
-    def run(self):
+    def run(self):  # pylint: disable=arguments-differ
         """
         Job function.
         """
@@ -61,4 +61,4 @@ class TestPass(Job):
         logger.info("after_return() was called as expected")
 
 
-register_jobs(TestPass)
+register_jobs(TestPassJob)

nautobot/extras/test_jobs/profiling.py

@@ -14,7 +14,7 @@ class TestProfilingJob(Job):
 
     description = "Test profiling"
 
-    def run(self):
+    def run(self):  # pylint: disable=arguments-differ
         """
         Job function.
         """

nautobot/extras/test_jobs/relative_import.py

@@ -1,10 +1,10 @@
-from fail import TestFail  # pylint: disable=import-error
+from fail import TestFailJob  # pylint: disable=import-error
 
 from nautobot.apps.jobs import register_jobs
 
 
-class TestReallyPass(TestFail):
-    def run(self):
+class TestReallyPass(TestFailJob):
+    def run(self):  # pylint: disable=arguments-differ
         pass
 
 

nautobot/extras/test_jobs/singleton.py

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

nautobot/extras/test_jobs/soft_time_limit_greater_than_time_limit.py

@@ -8,7 +8,7 @@ class TestSoftTimeLimitGreaterThanHardTimeLimit(Job):
         soft_time_limit = 10
         time_limit = 5
 
-    def run(self):
+    def run(self):  # pylint: disable=arguments-differ
         pass
 
 

nautobot/extras/test_jobs/task_queues.py

@@ -16,7 +16,7 @@ class TestWorkerQueues(Job):
             "nonexistent",  # This queue doesn't exist and should have zero workers
         ]
 
-    def run(self):
+    def run(self):  # pylint: disable=arguments-differ
         pass
 
 

nautobot/extras/tests/git_data/01-valid-files/graphql_queries/device_interfaces.gql

@@ -0,0 +1,8 @@
+query {
+  devices {
+    name
+    interfaces {
+      name
+    }
+  }
+}

nautobot/extras/tests/git_data/01-valid-files/graphql_queries/device_names.gql

@@ -0,0 +1,5 @@
+{
+    device {
+        name
+    }
+}

nautobot/extras/tests/git_data/02-invalid-files/graphql_queries/bad_device_names.gql

@@ -0,0 +1,5 @@
+{
+    device {
+
+    
+}