nautobot 2.4.3__py3-none-any.whl → 2.4.5__py3-none-any.whl

nautobot/extras/templates/extras/inc/jobresult.html

@@ -12,45 +12,43 @@
         <strong>Summary of Results</strong>
     </div>
     <table class="table table-hover panel-body">
-        {% if result.job_model is not None %}
             <tr>
                 <td>Job Description</td>
-                <td>{{ result.job_model.description | render_markdown }}</td>
+                <td>{{ result.job_model.description | render_markdown | placeholder }}</td>
             </tr>
-        {% endif %}
         <tr>
             <td>Status</td>
             <td><span id="pending-result-label">{% include 'extras/inc/job_label.html' with result=result %}</span></td>
         </tr>
         <tr>
             <td>Started at</td>
-            <td>{{ result.date_created }}</td>
+            <td>{{ result.date_created | placeholder }}</td>
         </tr>
         <tr>
             <td>User</td>
-            <td>{{ result.user }}</td>
+            <td>{{ result.user | placeholder }}</td>
         </tr>
         <tr>
             <td>Duration</td>
             <td>
-            {% if result.date_done %}
-                {{ result.duration }}
-            {% else %}
+            {% if result.date_created and not result.date_done %}
                 <img src="{% static 'img/ajax-loader.gif' %}">
+            {% else %}
+                {{ result.duration | placeholder}}
             {% endif %}
             </td>
         </tr>
         <tr>
             <td>Return Value</td>
             <td>
-            {% if result.date_done %}
+            {% if result.date_created and not result.date_done %}
+                <img src="{% static 'img/ajax-loader.gif' %}">
+            {% else %}
                 {% if result.result %}
                     <pre>{{ result.result | render_json }}</pre>
                 {% else %}
                     {{ result.result | placeholder }}
                 {% endif %}
-            {% else %}
-                <img src="{% static 'img/ajax-loader.gif' %}">
             {% endif %}
             </td>
         </tr>
@@ -89,6 +87,7 @@
             <input class="form-control" id="log-filter" type="text" placeholder="Filter log level or message" title="Filter log level or message" style="height: 23px" />
         </div>
     </div>
-    {% ajax_table "log_table" "extras:jobresult_log-table" pk=result.pk %}
+    {% if result and result.pk %}
+        {% ajax_table "log_table" "extras:jobresult_log-table" pk=result.pk %}
+    {% endif %}
 </div>
-

nautobot/extras/templates/extras/objectchange.html

@@ -1,5 +1,6 @@
 {% extends 'generic/object_retrieve.html' %}
 {% load helpers %}
+{% load static %}
 
 {% block title %}{{ object }}{% endblock %}
 
@@ -95,6 +96,20 @@
                     </tr>
                 </table>
             </div>
+            <div class="panel panel-default">
+                <div class="panel-heading">
+                    <strong>Object Data</strong>
+                </div>
+                <div class="panel-body">
+                    <div class="editor-container" 
+                         data-lang="json"
+                         data-value="{{ object.object_data|render_json:False }}"
+                         style="max-height: 300px">
+                    </div>
+                </div>
+            </div>
+        </div>
+        <div class="col-md-7">
             <div class="panel panel-default">
                 <div class="panel-heading">
                     <strong>Difference</strong>
@@ -119,22 +134,17 @@
                             {% endif %}
                         </span>
                     {% else %}
-                        <pre class="diff-removed">{{ diff_removed|render_json }}</pre>
-                        <pre class="diff-added">{{ diff_added|render_json }}</pre>
+                        <div class="editor-container" 
+                            data-mode="diff"
+                            data-original="{{ diff_removed | render_json:False }}"
+                            data-modified="{{ diff_added | render_json:False }}"
+                            data-lang="json"
+                            style="max-height: 730px">
+                        </div>
                     {% endif %}
                 </div>
             </div>
         </div>
-        <div class="col-md-7">
-            <div class="panel panel-default">
-                <div class="panel-heading">
-                    <strong>Object Data</strong>
-                </div>
-                <div class="panel-body">
-                    <pre>{{ object.object_data|render_json }}</pre>
-                </div>
-            </div>
-        </div>
     </div>
     <div class="row">
         <div class="col-md-12">
@@ -147,3 +157,9 @@
         </div>
     </div>
 {% endblock %}
+
+{% block javascript %}
+    {{ block.super }}
+    <script src="{% static 'js/editor.js' %}"></script>
+{% endblock %}
+

nautobot/extras/test_jobs/atomic_transaction.py

@@ -16,13 +16,13 @@ class TestAtomicDecorator(Job):
     Job that uses @transaction.atomic decorator to roll back changes.
     """
 
-    fail = BooleanVar()
+    should_fail = BooleanVar()
 
     @transaction.atomic
-    def run(self, fail=False):  # pylint:disable=arguments-differ
+    def run(self, should_fail=False):  # pylint:disable=arguments-differ
         try:
             Status.objects.create(name="Test database atomic rollback 1")
-            if fail:
+            if should_fail:
                 raise SimulatedError("simulated failure")
         except Exception:
             logger.error("Job failed, all database changes have been rolled back.")
@@ -35,13 +35,13 @@ class TestAtomicContextManager(Job):
     Job that uses `with transaction.atomic()` context manager to roll back changes.
     """
 
-    fail = BooleanVar()
+    should_fail = BooleanVar()
 
-    def run(self, fail=False):  # pylint:disable=arguments-differ
+    def run(self, should_fail=False):  # pylint:disable=arguments-differ
         try:
             with transaction.atomic():
                 Status.objects.create(name="Test database atomic rollback 2")
-                if fail:
+                if should_fail:
                     raise SimulatedError("simulated failure")
         except Exception as err:
             logger.error("Job failed, all database changes have been rolled back.")

nautobot/extras/test_jobs/fail.py

@@ -62,6 +62,20 @@ class TestFailJob(Job):
         logger.info("after_return() was called as expected")
 
 
+class TestFailInBeforeStart(TestFailJob):
+    """
+    Job that raises an exception in before_start().
+    """
+
+    def before_start(self, task_id, args, kwargs):
+        super().before_start(task_id, args, kwargs)
+        logger.info("I'm a test job that fails!")
+        raise RunJobTaskFailed("Setup failure")
+
+    def run(self):
+        raise RuntimeError("run() was unexpectedly called after a failure in before_start()")
+
+
 class TestFailWithSanitization(Job):
     """
     Job with fail result that should be sanitized.
@@ -91,4 +105,64 @@ class TestFailWithSanitization(Job):
         raise exc
 
 
-register_jobs(TestFailJob, TestFailWithSanitization)
+class TestFailCleanly(TestFailJob):
+    """
+    Job that fails "cleanly" through self.fail() instead of raising an exception.
+    """
+
+    def run(self):  # pylint: disable=arguments-differ
+        logger.info("I'm a test job that fails!")
+        self.fail("Failure")
+        return "We failed"
+
+    def on_failure(self, exc, task_id, args, kwargs, einfo):
+        if exc != "We failed":
+            raise RuntimeError(f"Expected exc to be the message returned from run(), but it was {exc!r}")
+        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}")  # pylint: disable=no-member
+        if args:
+            raise RuntimeError(f"Expected args to be empty, but it was {args!r}")
+        if kwargs:
+            raise RuntimeError(f"Expected kwargs to be empty, but it was {kwargs!r}")
+        if einfo is not None:
+            raise RuntimeError(f"Expected einfo to be None, but it was {einfo!r}")
+        logger.info("on_failure() was called as expected")
+
+    def after_return(self, status, retval, task_id, args, kwargs, einfo):
+        if status is not JobResultStatusChoices.STATUS_FAILURE:
+            raise RuntimeError(f"Expected status to be {JobResultStatusChoices.STATUS_FAILURE}, but it was {status!r}")
+        if retval != "We failed":
+            raise RuntimeError(f"Expected retval to be the message returned from run(), but it was {retval!r}")
+        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}")  # pylint: disable=no-member
+        if args:
+            raise RuntimeError(f"Expected args to be empty, but it was {args!r}")
+        if kwargs:
+            raise RuntimeError(f"Expected kwargs to be empty, but it was {kwargs!r}")
+        if einfo is not None:
+            raise RuntimeError(f"Expected einfo to be None, but it was {einfo!r}")
+        logger.info("after_return() was called as expected")
+
+
+class TestFailCleanlyInBeforeStart(TestFailCleanly):
+    """
+    Job that fails "cleanly" during before_start() through self.fail() instead of raising an exception.
+    """
+
+    def before_start(self, task_id, args, kwargs):
+        super().before_start(task_id, args, kwargs)
+        logger.info("I'm a test job that fails!")
+        self.fail("We failed")
+        return "We failed"
+
+    def run(self):
+        raise RuntimeError("run() was unexpectedly called after a failure in before_start()")
+
+
+register_jobs(
+    TestFailJob,
+    TestFailInBeforeStart,
+    TestFailWithSanitization,
+    TestFailCleanly,
+    TestFailCleanlyInBeforeStart,
+)

nautobot/extras/tests/test_api.py

@@ -196,20 +196,6 @@ class ComputedFieldTest(APIViewTestCases.APIViewTestCase):
 
 class ConfigContextTest(APIViewTestCases.APIViewTestCase):
     model = ConfigContext
-    create_data = [
-        {
-            "name": "Config Context 4",
-            "data": {"more_foo": True},
-        },
-        {
-            "name": "Config Context 5",
-            "data": {"more_bar": False},
-        },
-        {
-            "name": "Config Context 6",
-            "data": {"more_baz": None},
-        },
-    ]
     bulk_update_data = {
         "description": "New description",
     }
@@ -220,6 +206,21 @@ class ConfigContextTest(APIViewTestCases.APIViewTestCase):
         ConfigContext.objects.create(name="Config Context 1", weight=100, data={"foo": 123})
         ConfigContext.objects.create(name="Config Context 2", weight=200, data={"bar": 456})
         ConfigContext.objects.create(name="Config Context 3", weight=300, data={"baz": 789})
+        cls.create_data = [
+            {
+                "name": "Config Context 4",
+                "data": {"more_foo": True},
+                "tags": [tag.pk for tag in Tag.objects.get_for_model(Device)],
+            },
+            {
+                "name": "Config Context 5",
+                "data": {"more_bar": False},
+            },
+            {
+                "name": "Config Context 6",
+                "data": {"more_baz": None},
+            },
+        ]
 
     def test_render_configcontext_for_object(self):
         """
@@ -1797,7 +1798,7 @@ class JobTest(
         )
         self.assertHttpStatus(response, status.HTTP_400_BAD_REQUEST)
         self.assertIn(
-            "task_queue and job_queue are both specified. Please specifiy only one or another.", str(response.content)
+            "task_queue and job_queue are both specified. Please specify only one or another.", str(response.content)
         )
 
     @override_settings(EXEMPT_VIEW_PERMISSIONS=["*"])
@@ -1916,7 +1917,7 @@ class JobTest(
         mock_get_worker_count.return_value = 1
         self.add_permissions("extras.run_job")
 
-        job_model = Job.objects.get(job_class_name="ExampleJob")
+        job_model = Job.objects.get(job_class_name="TestHasSensitiveVariables")
         job_model.enabled = True
         job_model.validated_save()
 

nautobot/extras/tests/test_datasources.py

@@ -238,11 +238,7 @@ class GitTest(TransactionTestCase):
                     repository=self.repo.pk,
                 )
 
-                self.assertEqual(
-                    job_result.status,
-                    JobResultStatusChoices.STATUS_FAILURE,
-                    (job_result.result, list(job_result.job_log_entries.values_list("message", "log_object"))),
-                )
+                self.assertJobResultStatus(job_result, JobResultStatusChoices.STATUS_FAILURE)
                 self.repo.refresh_from_db()
 
                 log_entries = JobLogEntry.objects.filter(job_result=job_result)
@@ -308,11 +304,7 @@ class GitTest(TransactionTestCase):
                     repository=self.repo.pk,
                 )
 
-                self.assertEqual(
-                    job_result.status,
-                    JobResultStatusChoices.STATUS_SUCCESS,
-                    (job_result.traceback, list(job_result.job_log_entries.values_list("message", flat=True))),
-                )
+                self.assertJobResultStatus(job_result)
                 self.repo.refresh_from_db()
                 MockGitRepo.assert_called_with(
                     os.path.join(tempdir, self.repo.slug),
@@ -331,11 +323,7 @@ class GitTest(TransactionTestCase):
                 job_model = GitRepositorySync().job_model
                 job_result = run_job_for_testing(job=job_model, repository=self.repo.pk)
                 job_result.refresh_from_db()
-                self.assertEqual(
-                    job_result.status,
-                    JobResultStatusChoices.STATUS_SUCCESS,
-                    (job_result.traceback, list(job_result.job_log_entries.values_list("message", flat=True))),
-                )
+                self.assertJobResultStatus(job_result)
 
                 # Make sure explicit ConfigContext was successfully loaded from file
                 self.assert_explicit_config_context_exists("Frobozz 1000 NTP servers")
@@ -383,11 +371,7 @@ class GitTest(TransactionTestCase):
                 # Run the Git operation and refresh the object from the DB
                 job_result = run_job_for_testing(job=job_model, repository=self.repo.pk)
                 job_result.refresh_from_db()
-                self.assertEqual(
-                    job_result.status,
-                    JobResultStatusChoices.STATUS_SUCCESS,
-                    (job_result.traceback, list(job_result.job_log_entries.values_list("message", flat=True))),
-                )
+                self.assertJobResultStatus(job_result)
 
                 # Verify that objects have been removed from the database
                 self.assertEqual(
@@ -442,11 +426,7 @@ class GitTest(TransactionTestCase):
                 )
                 job_result.refresh_from_db()
 
-                self.assertEqual(
-                    job_result.status,
-                    JobResultStatusChoices.STATUS_FAILURE,
-                    job_result.result,
-                )
+                self.assertJobResultStatus(job_result, JobResultStatusChoices.STATUS_FAILURE)
 
                 # Due to transaction rollback on failure, the database should still/again match the pre-sync state, of
                 # no records owned by the repository.
@@ -547,11 +527,7 @@ class GitTest(TransactionTestCase):
                 )
                 job_result.refresh_from_db()
 
-                self.assertEqual(
-                    job_result.status,
-                    JobResultStatusChoices.STATUS_SUCCESS,
-                    (job_result.traceback, list(job_result.job_log_entries.values_list("message", flat=True))),
-                )
+                self.assertJobResultStatus(job_result)
 
                 # Make sure ConfigContext was successfully loaded from file
                 config_context = ConfigContext.objects.get(
@@ -591,15 +567,7 @@ class GitTest(TransactionTestCase):
                     delete_job_result = JobResult.objects.filter(name=repo_name).first()
                     # Make sure we didn't get the wrong JobResult
                     self.assertNotEqual(job_result, delete_job_result)
-                    self.assertEqual(
-                        delete_job_result.status,
-                        JobResultStatusChoices.STATUS_SUCCESS,
-                        (
-                            delete_job_result,
-                            delete_job_result.traceback,
-                            list(delete_job_result.job_log_entries.values_list("message", flat=True)),
-                        ),
-                    )
+                    self.assertJobResultStatus(delete_job_result)
 
                 with self.assertRaises(ConfigContext.DoesNotExist):
                     ConfigContext.objects.get(
@@ -637,11 +605,7 @@ class GitTest(TransactionTestCase):
                 job_model = GitRepositorySync().job_model
                 job_result = run_job_for_testing(job=job_model, repository=self.repo.pk)
                 job_result.refresh_from_db()
-                self.assertEqual(
-                    job_result.status,
-                    JobResultStatusChoices.STATUS_SUCCESS,
-                    (job_result.traceback, list(job_result.job_log_entries.values_list("message", flat=True))),
-                )
+                self.assertJobResultStatus(job_result)
 
                 self.assert_explicit_config_context_exists("Frobozz 1000 NTP servers")
                 self.assert_implicit_config_context_exists("Location context")
@@ -673,11 +637,7 @@ class GitTest(TransactionTestCase):
                 # Resync, attempting and failing to update to the new commit
                 job_result = run_job_for_testing(job=job_model, repository=self.repo.pk)
                 job_result.refresh_from_db()
-                self.assertEqual(
-                    job_result.status,
-                    JobResultStatusChoices.STATUS_FAILURE,
-                    job_result.result,
-                )
+                self.assertJobResultStatus(job_result, JobResultStatusChoices.STATUS_FAILURE)
                 log_entries = JobLogEntry.objects.filter(job_result=job_result)
 
                 # Assert database changes were rolled back
@@ -718,11 +678,7 @@ class GitTest(TransactionTestCase):
                 )
                 job_result.refresh_from_db()
 
-                self.assertEqual(
-                    job_result.status,
-                    JobResultStatusChoices.STATUS_SUCCESS,
-                    (job_result.traceback, list(job_result.job_log_entries.values_list("message", flat=True))),
-                )
+                self.assertJobResultStatus(job_result)
 
                 log_entries = JobLogEntry.objects.filter(job_result=job_result)
 
@@ -798,3 +754,57 @@ class GitTest(TransactionTestCase):
             "provides contents overlapping with this repository.",
             str(cm.exception),
         )
+
+    @mock.patch("nautobot.extras.models.datasources.GitRepo")
+    def test_clone_to_directory_with_secrets(self, MockGitRepo):
+        """
+        The clone_to_directory method should correctly make use of secrets.
+        """
+        with tempfile.TemporaryDirectory() as tempdir:
+            # Prepare secrets values
+            with open(os.path.join(tempdir, "username.txt"), "wt") as handle:
+                handle.write("núñez")
+
+            with open(os.path.join(tempdir, "token.txt"), "wt") as handle:
+                handle.write("1:3@/?=ab@")
+
+            # Create secrets and assign
+            username_secret = Secret.objects.create(
+                name="Git Username",
+                provider="text-file",
+                parameters={"path": os.path.join(tempdir, "username.txt")},
+            )
+            token_secret = Secret.objects.create(
+                name="Git Token",
+                provider="text-file",
+                parameters={"path": os.path.join(tempdir, "token.txt")},
+            )
+            secrets_group = SecretsGroup.objects.create(name="Git Credentials")
+            SecretsGroupAssociation.objects.create(
+                secret=username_secret,
+                secrets_group=secrets_group,
+                access_type=SecretsGroupAccessTypeChoices.TYPE_HTTP,
+                secret_type=SecretsGroupSecretTypeChoices.TYPE_USERNAME,
+            )
+            SecretsGroupAssociation.objects.create(
+                secret=token_secret,
+                secrets_group=secrets_group,
+                access_type=SecretsGroupAccessTypeChoices.TYPE_HTTP,
+                secret_type=SecretsGroupSecretTypeChoices.TYPE_TOKEN,
+            )
+
+            # Configure GitRepository model
+            self.repo.secrets_group = secrets_group
+            self.repo.remote_url = "http://localhost/git.git"
+            self.repo.save()
+
+            # Try to clone it
+            self.repo.clone_to_directory(tempdir, "main")
+
+            # Assert that GitRepo was called with proper args
+            args, kwargs = MockGitRepo.call_args
+            path, from_url = args
+            self.assertTrue(path.startswith(os.path.join(tempdir, self.repo.slug)))
+            self.assertEqual(from_url, "http://n%C3%BA%C3%B1ez:1%3A3%40%2F%3F%3Dab%40@localhost/git.git")
+            self.assertEqual(kwargs["depth"], 0)
+            self.assertEqual(kwargs["branch"], "main")

nautobot/extras/tests/test_filters.py

@@ -880,6 +880,8 @@ class JobFilterSetTestCase(FilterTestCases.FilterTestCase):
     generic_filter_tests = (
         ("grouping",),
         ("job_class_name",),
+        ("job_queues", "job_queues__id"),
+        ("job_queues", "job_queues__name"),
         ("module_name",),
         ("name",),
     )