nautobot 2.4.4__py3-none-any.whl → 2.4.6__py3-none-any.whl

nautobot/extras/templates/extras/status.html

@@ -1,38 +1,2 @@
 {% extends 'generic/object_retrieve.html' %}
-{% load helpers %}
-
-{% block content_left_page %}
-            <div class="panel panel-default">
-                <div class="panel-heading">
-                    <strong>Status</strong>
-                </div>
-                <table class="table table-hover panel-body attr-table">
-                    <tr>
-                        <td>Name</td>
-                        <td>
-                            {{ object.name }}
-                        </td>
-                    </tr>
-                    <tr>
-                        <td>Content Type(s)</td>
-                        <td>
-                            {% for ct in content_types %}
-                                {{ ct }}<br>
-                            {% endfor %}
-                        </td>
-                    </tr>
-                    <tr>
-                        <td>Color</td>
-                        <td>
-                            <span class="label color-block" style="background-color: #{{ object.color }}">&nbsp;</span>
-                        </td>
-                    </tr>
-                    <tr>
-                        <td>Description</td>
-                        <td>
-                            {{ object.description|placeholder }}
-                        </td>
-                    </tr>
-                </table>
-            </div>
-{% endblock content_left_page %}
+{% comment %}3.0 TODO: remove this template, which only exists for backward compatibility with 2.4 and earlier{% endcomment %}

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/integration/test_notes.py

@@ -42,4 +42,4 @@ class NoteTestCase(SeleniumTestCase):
         self.browser.find_by_text("Create").click()
 
         # Verify form redirect and presence of content.
-        self.assertTrue(self.browser.is_text_present("Created Note"))
+        self.assertTrue(self.browser.is_text_present("Created note"))

nautobot/extras/tests/test_api.py

@@ -292,7 +292,7 @@ class ConfigContextTest(APIViewTestCases.APIViewTestCase):
         schema = ConfigContextSchema.objects.create(
             name="Schema 1", data_schema={"type": "object", "properties": {"foo": {"type": "string"}}}
         )
-        self.add_permissions("extras.add_configcontext")
+        self.add_permissions("extras.add_configcontext", "extras.view_configcontextschema")
 
         data = {
             "name": "Config Context with schema",
@@ -1917,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()
 
@@ -2248,7 +2248,7 @@ class JobHookTest(APIViewTestCases.APIViewTestCase):
             "type_delete": True,
         }
 
-        self.add_permissions("extras.add_jobhook")
+        self.add_permissions("extras.add_jobhook", "extras.view_job")
         response = self.client.post(self._get_list_url(), data, format="json", **self.header)
         self.assertContains(
             response,
@@ -2264,7 +2264,7 @@ class JobHookTest(APIViewTestCases.APIViewTestCase):
             "type_delete": True,
         }
 
-        self.add_permissions("extras.change_jobhook")
+        self.add_permissions("extras.change_jobhook", "extras.view_job")
         job_hook2 = JobHook.objects.get(name="JobHook2")
         response = self.client.patch(self._get_detail_url(job_hook2), data, format="json", **self.header)
         self.assertContains(
@@ -2553,7 +2553,7 @@ class UserSavedViewAssociationTest(APIViewTestCases.APIViewTestCase):
             "saved_view": saved_view.pk,
             "view_name": duplicate_view_name,
         }
-        self.add_permissions("extras.add_usersavedviewassociation")
+        self.add_permissions("extras.add_usersavedviewassociation", "users.view_user", "extras.view_savedview")
         response = self.client.post(
             self._get_list_url(), duplicate_user_to_savedview_create_data, format="json", **self.header
         )
@@ -3240,7 +3240,15 @@ class RelationshipTest(APIViewTestCases.APIViewTestCase, RequiredRelationshipTes
             location=existing_location_2,
         )
 
-        self.add_permissions("dcim.view_location", "dcim.add_location", "extras.add_relationshipassociation")
+        self.add_permissions(
+            "dcim.view_location",
+            "dcim.view_locationtype",
+            "dcim.view_device",
+            "dcim.add_location",
+            "extras.view_relationship",
+            "extras.add_relationshipassociation",
+            "extras.view_status",
+        )
         response = self.client.post(
             reverse("dcim-api:location-list"),
             data={
@@ -3564,7 +3572,9 @@ class RelationshipAssociationTest(APIViewTestCases.APIViewTestCase):
             ),
         ]
 
-        self.add_permissions("extras.add_relationshipassociation")
+        self.add_permissions(
+            "extras.add_relationshipassociation", "dcim.view_device", "dcim.view_location", "extras.view_relationship"
+        )
 
         for side, field_error_name, data in associations:
             response = self.client.post(self._get_list_url(), data, format="json", **self.header)
@@ -3585,7 +3595,9 @@ class RelationshipAssociationTest(APIViewTestCases.APIViewTestCase):
             "destination_id": self.devices[2].pk,
         }
 
-        self.add_permissions("extras.add_relationshipassociation")
+        self.add_permissions(
+            "extras.add_relationshipassociation", "extras.view_relationship", "dcim.view_device", "dcim.view_location"
+        )
 
         response = self.client.post(self._get_list_url(), data, format="json", **self.header)
         self.assertHttpStatus(response, status.HTTP_400_BAD_REQUEST)
@@ -3636,8 +3648,11 @@ class RelationshipAssociationTest(APIViewTestCases.APIViewTestCase):
         Check that relationship-associations can be updated via the 'relationships' field.
         """
         self.add_permissions(
+            "dcim.view_device",
             "dcim.view_location",
             "dcim.change_location",
+            "extras.view_relationship",
+            "extras.view_relationshipassociation",
             "extras.add_relationshipassociation",
             "extras.delete_relationshipassociation",
         )

nautobot/extras/tests/test_changelog.py

@@ -277,7 +277,7 @@ class ChangeLogAPITest(APITestCase):
             ],
         }
         url = reverse("dcim-api:location-list")
-        self.add_permissions("dcim.add_location", "extras.view_status")
+        self.add_permissions("dcim.add_location", "dcim.view_locationtype", "extras.view_tag", "extras.view_status")
 
         response = self.client.post(url, data, format="json", **self.header)
         self.assertHttpStatus(response, status.HTTP_201_CREATED)
@@ -310,7 +310,7 @@ class ChangeLogAPITest(APITestCase):
             },
             "tags": [{"name": self.tags[2].name}],
         }
-        self.add_permissions("dcim.change_location", "extras.view_status")
+        self.add_permissions("dcim.change_location", "extras.view_status", "dcim.view_locationtype", "extras.view_tag")
         url = reverse("dcim-api:location-detail", kwargs={"pk": location.pk})
 
         response = self.client.put(url, data, format="json", **self.header)
@@ -457,7 +457,7 @@ class ChangeLogAPITest(APITestCase):
             "status": self.statuses[0].pk,
             "location_type": location_type.pk,
         }
-        self.add_permissions("dcim.add_location")
+        self.add_permissions("dcim.add_location", "dcim.view_locationtype", "extras.view_status")
         url = reverse("dcim-api:location-list")
 
         response = self.client.post(url, location_payload, format="json", **self.header)
@@ -492,7 +492,7 @@ class ChangeLogAPITest(APITestCase):
         )
 
         payload = {"tagged_vlans": [str(tagged_vlan.pk)], "description": "test vm interface m2m change"}
-        self.add_permissions("virtualization.change_vminterface", "ipam.change_vlan")
+        self.add_permissions("virtualization.change_vminterface", "ipam.change_vlan", "ipam.view_vlan")
         url = reverse("virtualization-api:vminterface-detail", kwargs={"pk": vm_interface.pk})
         response = self.client.patch(url, payload, format="json", **self.header)
         vm_interface.refresh_from_db()

nautobot/extras/tests/test_customfields.py

@@ -472,6 +472,9 @@ class CustomFieldDataAPITest(APITestCase):
         "dcim.add_location",
         "dcim.change_location",
         "dcim.view_location",
+        "dcim.view_locationtype",
+        "extras.view_status",
+        "extras.view_customfield",
     )
 
     def setUp(self):

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")