nautobot 2.2.2__py3-none-any.whl → 2.2.4__py3-none-any.whl

nautobot/extras/tests/test_datasources.py

@@ -80,9 +80,10 @@ class GitTest(TransactionTestCase):
             status=status,
         )
 
+        self.repo_slug = "test_git_repo"
         self.repo = GitRepository(
             name="Test Git Repository",
-            slug="test_git_repo",
+            slug=self.repo_slug,
             remote_url="http://localhost/git.git",
             # Provide everything we know we can provide
             provided_contents=[entry.content_identifier for entry in get_datasource_contents("extras.gitrepository")],
@@ -118,22 +119,24 @@ class GitTest(TransactionTestCase):
         }
 
     def tearDown(self):
-        if f"{self.repo.slug}.jobs" in sys.modules:
-            del sys.modules[f"{self.repo.slug}.jobs"]
-        if f"{self.repo.slug}" in sys.modules:
-            del sys.modules[f"{self.repo.slug}"]
+        if f"{self.repo_slug}.jobs" in sys.modules:
+            del sys.modules[f"{self.repo_slug}.jobs"]
+        if f"{self.repo_slug}" in sys.modules:
+            del sys.modules[f"{self.repo_slug}"]
+        if self.repo is not None:
+            self.repo.delete()
         super().tearDown()
 
     def populate_repo(self, path, url, *args, **kwargs):
-        os.makedirs(path)
+        os.makedirs(path, exist_ok=True)
 
-        os.makedirs(os.path.join(path, "config_contexts"))
-        os.makedirs(os.path.join(path, "config_contexts", "devices"))
-        os.makedirs(os.path.join(path, "config_contexts", "locations"))
-        os.makedirs(os.path.join(path, "config_context_schemas"))
-        os.makedirs(os.path.join(path, "export_templates", "dcim", "device"))
-        os.makedirs(os.path.join(path, "export_templates", "ipam", "vlan"))
-        os.makedirs(os.path.join(path, "jobs"))
+        os.makedirs(os.path.join(path, "config_contexts"), exist_ok=True)
+        os.makedirs(os.path.join(path, "config_contexts", "devices"), exist_ok=True)
+        os.makedirs(os.path.join(path, "config_contexts", "locations"), exist_ok=True)
+        os.makedirs(os.path.join(path, "config_context_schemas"), exist_ok=True)
+        os.makedirs(os.path.join(path, "export_templates", "dcim", "device"), exist_ok=True)
+        os.makedirs(os.path.join(path, "export_templates", "ipam", "vlan"), exist_ok=True)
+        os.makedirs(os.path.join(path, "jobs"), exist_ok=True)
 
         with open(os.path.join(path, "__init__.py"), "w") as fd:
             # Required for job importing
@@ -188,16 +191,19 @@ class GitTest(TransactionTestCase):
         return mock.DEFAULT
 
     def empty_repo(self, path, url, *args, **kwargs):
-        os.remove(os.path.join(path, "__init__.py"))
-        os.remove(os.path.join(path, "config_contexts", "context.yaml"))
-        os.remove(os.path.join(path, "config_contexts", "locations", f"{self.location.name}.json"))
-        os.remove(os.path.join(path, "config_contexts", "devices", f"{self.device.name}.json"))
-        os.remove(os.path.join(path, "config_context_schemas", "schema-1.yaml"))
-        os.remove(os.path.join(path, "export_templates", "dcim", "device", "template.j2"))
-        os.remove(os.path.join(path, "export_templates", "dcim", "device", "template2.html"))
-        os.remove(os.path.join(path, "export_templates", "ipam", "vlan", "template.j2"))
-        os.remove(os.path.join(path, "jobs", "__init__.py"))
-        os.remove(os.path.join(path, "jobs", "my_job.py"))
+        try:
+            os.remove(os.path.join(path, "__init__.py"))
+            os.remove(os.path.join(path, "config_contexts", "context.yaml"))
+            os.remove(os.path.join(path, "config_contexts", "locations", f"{self.location.name}.json"))
+            os.remove(os.path.join(path, "config_contexts", "devices", f"{self.device.name}.json"))
+            os.remove(os.path.join(path, "config_context_schemas", "schema-1.yaml"))
+            os.remove(os.path.join(path, "export_templates", "dcim", "device", "template.j2"))
+            os.remove(os.path.join(path, "export_templates", "dcim", "device", "template2.html"))
+            os.remove(os.path.join(path, "export_templates", "ipam", "vlan", "template.j2"))
+            os.remove(os.path.join(path, "jobs", "__init__.py"))
+            os.remove(os.path.join(path, "jobs", "my_job.py"))
+        except FileNotFoundError:
+            pass
         return mock.DEFAULT
 
     def assert_repo_slug_valid_python_package_name(self):
@@ -291,15 +297,14 @@ class GitTest(TransactionTestCase):
         self.assertIsNotNone(export_template_vlan)
 
     def assert_job_exists(self, installed=True):
-        """Helper function to assert JobModel and registerd Job exist."""
+        """Helper function to assert JobModel and registered Job exist."""
         # Is it registered correctly in the database?
-        job_model = Job.objects.get(name="MyJob", module_name=f"{self.repo.slug}.jobs.my_job", job_class_name="MyJob")
+        job_model = Job.objects.get(name="MyJob", module_name=f"{self.repo_slug}.jobs.my_job", job_class_name="MyJob")
         self.assertIsNotNone(job_model)
         if installed:
             self.assertTrue(job_model.installed)
             # Is the in-memory code accessible?
             self.assertIsNotNone(job_model.job_class)
-            # Is it registered properly with Celery?
             self.assertIsNotNone(job_model.job_task)
         else:
             self.assertFalse(job_model.installed)
@@ -333,10 +338,7 @@ class GitTest(TransactionTestCase):
                 self.assertEqual(
                     job_result.status,
                     JobResultStatusChoices.STATUS_FAILURE,
-                    (
-                        job_result.result,
-                        list(job_result.job_log_entries.filter(log_level="error").values_list("message", flat=True)),
-                    ),
+                    (job_result.result, list(job_result.job_log_entries.values_list("message", "log_object"))),
                 )
                 self.repo.refresh_from_db()
                 self.assertEqual(self.repo.current_head, self.COMMIT_HEXSHA, job_result.result)
@@ -344,7 +346,13 @@ class GitTest(TransactionTestCase):
 
                 log_entries = JobLogEntry.objects.filter(job_result=job_result)
                 failure_logs = log_entries.filter(log_level=LogLevelChoices.LOG_ERROR)
-                failure_logs.get(grouping="jobs", message__contains="Error in loading Jobs from Git repository: ")
+                try:
+                    failure_logs.get(grouping="jobs", message__contains="No `jobs` submodule found")
+                except JobLogEntry.DoesNotExist:
+                    for log in log_entries:
+                        print(log.message)
+                    print(job_result.traceback)
+                    raise
 
     def test_pull_git_repository_and_refresh_data_with_secrets(self, MockGitRepo):
         """
@@ -406,10 +414,7 @@ class GitTest(TransactionTestCase):
                 self.assertEqual(
                     job_result.status,
                     JobResultStatusChoices.STATUS_SUCCESS,
-                    (
-                        job_result.result,
-                        list(job_result.job_log_entries.filter(log_level="error").values_list("message", flat=True)),
-                    ),
+                    (job_result.traceback, list(job_result.job_log_entries.values_list("message", flat=True))),
                 )
                 self.repo.refresh_from_db()
                 MockGitRepo.assert_called_with(
@@ -433,10 +438,7 @@ class GitTest(TransactionTestCase):
                 self.assertEqual(
                     job_result.status,
                     JobResultStatusChoices.STATUS_SUCCESS,
-                    (
-                        job_result.result,
-                        list(job_result.job_log_entries.filter(log_level="error").values_list("message", flat=True)),
-                    ),
+                    (job_result.traceback, list(job_result.job_log_entries.values_list("message", flat=True))),
                 )
 
                 # Make sure explicit ConfigContext was successfully loaded from file
@@ -475,10 +477,7 @@ class GitTest(TransactionTestCase):
                 self.assertEqual(
                     job_result.status,
                     JobResultStatusChoices.STATUS_SUCCESS,
-                    (
-                        job_result.result,
-                        list(job_result.job_log_entries.filter(log_level="error").values_list("message", flat=True)),
-                    ),
+                    (job_result.traceback, list(job_result.job_log_entries.values_list("message", flat=True))),
                 )
 
                 # Verify that objects have been removed from the database
@@ -515,16 +514,16 @@ class GitTest(TransactionTestCase):
             with self.settings(GIT_ROOT=tempdir):
 
                 def populate_repo(path, url):
-                    os.makedirs(path)
-                    os.makedirs(os.path.join(path, "config_contexts"))
-                    os.makedirs(os.path.join(path, "config_contexts", "devices"))
-                    os.makedirs(os.path.join(path, "config_context_schemas"))
-                    os.makedirs(os.path.join(path, "export_templates", "nosuchapp", "device"))
-                    os.makedirs(os.path.join(path, "export_templates", "dcim", "nosuchmodel"))
-                    os.makedirs(os.path.join(path, "jobs"))
+                    os.makedirs(path, exist_ok=True)
+                    os.makedirs(os.path.join(path, "config_contexts"), exist_ok=True)
+                    os.makedirs(os.path.join(path, "config_contexts", "devices"), exist_ok=True)
+                    os.makedirs(os.path.join(path, "config_context_schemas"), exist_ok=True)
+                    os.makedirs(os.path.join(path, "export_templates", "nosuchapp", "device"), exist_ok=True)
+                    os.makedirs(os.path.join(path, "export_templates", "dcim", "nosuchmodel"), exist_ok=True)
+                    os.makedirs(os.path.join(path, "jobs"), exist_ok=True)
                     # Incorrect directories
-                    os.makedirs(os.path.join(path, "devices"))
-                    os.makedirs(os.path.join(path, "dcim"))
+                    os.makedirs(os.path.join(path, "devices"), exist_ok=True)
+                    os.makedirs(os.path.join(path, "dcim"), exist_ok=True)
                     with open(os.path.join(path, "__init__.py"), "w") as fd:
                         pass
                     # Malformed JSON
@@ -563,6 +562,7 @@ class GitTest(TransactionTestCase):
 
                 # Run the Git operation and refresh the object from the DB
                 job_model = GitRepositorySync().job_model
+                self.assertIsNotNone(job_model)
                 job_result = run_job_for_testing(
                     job=job_model,
                     repository=self.repo.pk,
@@ -580,54 +580,65 @@ class GitTest(TransactionTestCase):
                 warning_logs = log_entries.filter(log_level=LogLevelChoices.LOG_WARNING)
                 failure_logs = log_entries.filter(log_level=LogLevelChoices.LOG_ERROR)
 
-                warning_logs.get(
-                    grouping="config contexts", message__contains='Found "devices" directory in the repository root'
-                )
-                warning_logs.get(
-                    grouping="export templates", message__contains='Found "dcim" directory in the repository root'
-                )
-                warning_logs.get(
-                    grouping="export templates",
-                    message__contains="Skipping `dcim.nosuchmodel` as it isn't a known content type",
-                )
-                warning_logs.get(
-                    grouping="export templates",
-                    message__contains="Skipping `nosuchapp.device` as it isn't a known content type",
-                )
-
-                failure_logs.get(
-                    grouping="config context schemas",
-                    message__contains="Error in loading config context schema data from `schema-1.yaml`",
-                )
-                failure_logs.get(
-                    grouping="config context schemas",
-                    message__contains="Error in loading config context schema data from `schema-2.yaml`: "
-                    "data is missing the required `_metadata` key",
-                )
-                failure_logs.get(
-                    grouping="config contexts",
-                    message__contains="Error in loading config context data from `context.json`",
-                )
-                failure_logs.get(
-                    grouping="config contexts",
-                    message__contains="Error in loading config context data from `context2.json`: "
-                    "data is missing the required `_metadata` key",
-                )
-                failure_logs.get(
-                    grouping="config contexts",
-                    message__contains="Error in loading config context data from `context3.json`: "
-                    "data `_metadata` is missing the required `name` key",
-                )
-                failure_logs.get(
-                    grouping="local config contexts",
-                    message__contains="Error in loading local config context from `devices/nosuchdevice.json`: "
-                    "record not found",
-                )
-                failure_logs.get(
-                    grouping="jobs",
-                    # The specific exception message differs between Python versions
-                    message__contains="Error in loading Jobs from Git repository: ",
-                )
+                try:
+                    warning_logs.get(
+                        grouping="config contexts", message__contains='Found "devices" directory in the repository root'
+                    )
+                    warning_logs.get(
+                        grouping="export templates", message__contains='Found "dcim" directory in the repository root'
+                    )
+                    warning_logs.get(
+                        grouping="export templates",
+                        message__contains="Skipping `dcim.nosuchmodel` as it isn't a known content type",
+                    )
+                    warning_logs.get(
+                        grouping="export templates",
+                        message__contains="Skipping `nosuchapp.device` as it isn't a known content type",
+                    )
+                except JobLogEntry.DoesNotExist:
+                    for log in log_entries:
+                        print(log.message)
+                    print(job_result.traceback)
+                    raise
+
+                try:
+                    failure_logs.get(
+                        grouping="config context schemas",
+                        message__contains="Error in loading config context schema data from `schema-1.yaml`",
+                    )
+                    failure_logs.get(
+                        grouping="config context schemas",
+                        message__contains="Error in loading config context schema data from `schema-2.yaml`: "
+                        "data is missing the required `_metadata` key",
+                    )
+                    failure_logs.get(
+                        grouping="config contexts",
+                        message__contains="Error in loading config context data from `context.json`",
+                    )
+                    failure_logs.get(
+                        grouping="config contexts",
+                        message__contains="Error in loading config context data from `context2.json`: "
+                        "data is missing the required `_metadata` key",
+                    )
+                    failure_logs.get(
+                        grouping="config contexts",
+                        message__contains="Error in loading config context data from `context3.json`: "
+                        "data `_metadata` is missing the required `name` key",
+                    )
+                    failure_logs.get(
+                        grouping="local config contexts",
+                        message__contains="Error in loading local config context from `devices/nosuchdevice.json`: "
+                        "record not found",
+                    )
+                    failure_logs.get(
+                        grouping="jobs",
+                        message__contains="Error in loading Jobs from Git repository: ",
+                    )
+                except (AssertionError, JobLogEntry.DoesNotExist):
+                    for log in log_entries:
+                        print(log.message)
+                    print(job_result.traceback)
+                    raise
 
     def test_delete_git_repository_cleanup(self, MockGitRepo):
         """
@@ -637,12 +648,12 @@ class GitTest(TransactionTestCase):
             with self.settings(GIT_ROOT=tempdir):
 
                 def populate_repo(path, url):
-                    os.makedirs(path)
-                    os.makedirs(os.path.join(path, "config_contexts"))
-                    os.makedirs(os.path.join(path, "config_contexts", "devices"))
-                    os.makedirs(os.path.join(path, "config_context_schemas"))
-                    os.makedirs(os.path.join(path, "export_templates", "dcim", "device"))
-                    os.makedirs(os.path.join(path, "jobs"))
+                    os.makedirs(path, exist_ok=True)
+                    os.makedirs(os.path.join(path, "config_contexts"), exist_ok=True)
+                    os.makedirs(os.path.join(path, "config_contexts", "devices"), exist_ok=True)
+                    os.makedirs(os.path.join(path, "config_context_schemas"), exist_ok=True)
+                    os.makedirs(os.path.join(path, "export_templates", "dcim", "device"), exist_ok=True)
+                    os.makedirs(os.path.join(path, "jobs"), exist_ok=True)
                     with open(os.path.join(path, "__init__.py"), "w") as fd:
                         pass
                     with open(os.path.join(path, "config_contexts", "context.yaml"), "w") as fd:
@@ -701,10 +712,7 @@ class GitTest(TransactionTestCase):
                 self.assertEqual(
                     job_result.status,
                     JobResultStatusChoices.STATUS_SUCCESS,
-                    (
-                        job_result.result,
-                        list(job_result.job_log_entries.filter(log_level="error").values_list("message", flat=True)),
-                    ),
+                    (job_result.traceback, list(job_result.job_log_entries.values_list("message", flat=True))),
                 )
 
                 # Make sure ConfigContext was successfully loaded from file
@@ -735,7 +743,9 @@ class GitTest(TransactionTestCase):
                 self.assert_job_exists()
 
                 # Now delete the GitRepository
+                repo_pk = self.repo.pk
                 self.repo.delete()
+                self.repo = None
 
                 with self.subTest("Assert Deleted GitRepo do not create a never ending JobResult record"):
                     # Bug fix test for https://github.com/nautobot/nautobot/issues/5121
@@ -743,19 +753,19 @@ class GitTest(TransactionTestCase):
 
                 with self.assertRaises(ConfigContext.DoesNotExist):
                     ConfigContext.objects.get(
-                        owner_object_id=self.repo.pk,
+                        owner_object_id=repo_pk,
                         owner_content_type=ContentType.objects.get_for_model(GitRepository),
                     )
 
                 with self.assertRaises(ConfigContextSchema.DoesNotExist):
                     ConfigContextSchema.objects.get(
-                        owner_object_id=self.repo.pk,
+                        owner_object_id=repo_pk,
                         owner_content_type=ContentType.objects.get_for_model(GitRepository),
                     )
 
                 with self.assertRaises(ExportTemplate.DoesNotExist):
                     ExportTemplate.objects.get(
-                        owner_object_id=self.repo.pk,
+                        owner_object_id=repo_pk,
                         owner_content_type=ContentType.objects.get_for_model(GitRepository),
                     )
 
@@ -774,6 +784,7 @@ class GitTest(TransactionTestCase):
                     return mock.DEFAULT
 
                 MockGitRepo.side_effect = create_empty_repo
+                MockGitRepo.return_value.checkout.return_value = (self.COMMIT_HEXSHA, False)
 
                 self.mock_request.id = uuid.uuid4()
 
@@ -787,13 +798,9 @@ class GitTest(TransactionTestCase):
                 self.assertEqual(
                     job_result.status,
                     JobResultStatusChoices.STATUS_SUCCESS,
-                    (
-                        job_result.result,
-                        list(job_result.job_log_entries.filter(log_level="error").values_list("message", flat=True)),
-                    ),
+                    (job_result.traceback, list(job_result.job_log_entries.values_list("message", flat=True))),
                 )
 
-                MockGitRepo.return_value.checkout.assert_not_called()
                 MockGitRepo.assert_called_with(
                     os.path.join(tempdir, self.repo.slug),
                     self.repo.remote_url,

nautobot/extras/tests/test_job_variables.py

@@ -3,26 +3,32 @@ from django.test import TestCase
 from netaddr import IPAddress, IPNetwork
 
 from nautobot.dcim.models import Device
-from nautobot.extras.models import Role
-from nautobot.extras.test_jobs.job_variables import (
-    BooleanVarJob,
-    ChoiceVarJob,
-    FileVarJob,
-    IntegerVarJob,
-    IPAddressVarJob,
-    IPAddressWithMaskVarJob,
-    IPNetworkVarJob,
-    JSONVarJob,
-    MultiChoiceVarJob,
-    MultiObjectVarJob,
-    ObjectVarJob,
-    StringVarJob,
-    TextVarJob,
+from nautobot.extras.jobs import (
+    BooleanVar,
+    ChoiceVar,
+    FileVar,
+    IntegerVar,
+    IPAddressVar,
+    IPAddressWithMaskVar,
+    IPNetworkVar,
+    Job,
+    JSONVar,
+    MultiChoiceVar,
+    MultiObjectVar,
+    ObjectVar,
+    StringVar,
+    TextVar,
 )
+from nautobot.extras.models import Role
+
+CHOICES = (("ff0000", "Red"), ("00ff00", "Green"), ("0000ff", "Blue"))
 
 
 class JobVariablesTest(TestCase):
     def test_stringvar(self):
+        class StringVarJob(Job):
+            var1 = StringVar(min_length=3, max_length=3, regex=r"[a-z]+")
+
         # Validate min_length enforcement
         data = {"var1": "xx"}
         form = StringVarJob().as_form(data)
@@ -48,6 +54,9 @@ class JobVariablesTest(TestCase):
         self.assertEqual(form.cleaned_data["var1"], data["var1"])
 
     def test_textvar(self):
+        class TextVarJob(Job):
+            var1 = TextVar()
+
         # Validate valid data
         data = {"var1": "This is a test string"}
         form = TextVarJob().as_form(data)
@@ -55,6 +64,9 @@ class JobVariablesTest(TestCase):
         self.assertEqual(form.cleaned_data["var1"], data["var1"])
 
     def test_integervar(self):
+        class IntegerVarJob(Job):
+            var1 = IntegerVar(min_value=5, max_value=10)
+
         # Validate min_value enforcement
         data = {"var1": 4}
         form = IntegerVarJob().as_form(data)
@@ -74,6 +86,9 @@ class JobVariablesTest(TestCase):
         self.assertEqual(form.cleaned_data["var1"], data["var1"])
 
     def test_booleanvar(self):
+        class BooleanVarJob(Job):
+            var1 = BooleanVar()
+
         # Validate True
         data = {"var1": True}
         form = BooleanVarJob().as_form(data)
@@ -87,6 +102,9 @@ class JobVariablesTest(TestCase):
         self.assertEqual(form.cleaned_data["var1"], False)
 
     def test_choicevar(self):
+        class ChoiceVarJob(Job):
+            var1 = ChoiceVar(choices=CHOICES)
+
         # Validate valid choice
         data = {"var1": "ff0000"}
         form = ChoiceVarJob().as_form(data)
@@ -100,6 +118,9 @@ class JobVariablesTest(TestCase):
         self.assertIn("var1", form.errors)
 
     def test_multichoicevar(self):
+        class MultiChoiceVarJob(Job):
+            var1 = MultiChoiceVar(choices=CHOICES)
+
         # Validate single choice
         data = {"var1": ["ff0000"]}
         form = MultiChoiceVarJob().as_form(data)
@@ -119,6 +140,9 @@ class JobVariablesTest(TestCase):
         self.assertIn("var1", form.errors)
 
     def test_objectvar(self):
+        class ObjectVarJob(Job):
+            var1 = ObjectVar(model=Role)
+
         # Validate valid data
         data = {"var1": Role.objects.get_for_model(Device).first().pk}
         form = ObjectVarJob().as_form(data)
@@ -126,6 +150,9 @@ class JobVariablesTest(TestCase):
         self.assertEqual(form.cleaned_data["var1"].pk, data["var1"])
 
     def test_multiobjectvar(self):
+        class MultiObjectVarJob(Job):
+            var1 = MultiObjectVar(model=Role)
+
         # Validate valid data
         data = {"var1": [role.pk for role in Role.objects.all()[:3]]}
         form = MultiObjectVarJob().as_form(data)
@@ -135,6 +162,9 @@ class JobVariablesTest(TestCase):
         self.assertEqual(form.cleaned_data["var1"][2].pk, data["var1"][2])
 
     def test_filevar(self):
+        class FileVarJob(Job):
+            var1 = FileVar()
+
         # Test file
         testfile = SimpleUploadedFile(name="test_file.txt", content=b"This is an test file for testing")
 
@@ -145,6 +175,9 @@ class JobVariablesTest(TestCase):
         self.assertEqual(form.cleaned_data["var1"], testfile)
 
     def test_ipaddressvar(self):
+        class IPAddressVarJob(Job):
+            var1 = IPAddressVar()
+
         # Validate IP network enforcement
         data = {"var1": "1.2.3"}
         form = IPAddressVarJob().as_form(data)
@@ -164,6 +197,9 @@ class JobVariablesTest(TestCase):
         self.assertEqual(form.cleaned_data["var1"], IPAddress(data["var1"]))
 
     def test_ipaddresswithmaskvar(self):
+        class IPAddressWithMaskVarJob(Job):
+            var1 = IPAddressWithMaskVar()
+
         # Validate IP network enforcement
         data = {"var1": "1.2.3"}
         form = IPAddressWithMaskVarJob().as_form(data)
@@ -183,6 +219,9 @@ class JobVariablesTest(TestCase):
         self.assertEqual(form.cleaned_data["var1"], IPNetwork(data["var1"]))
 
     def test_ipnetworkvar(self):
+        class IPNetworkVarJob(Job):
+            var1 = IPNetworkVar()
+
         # Validate IP network enforcement
         data = {"var1": "1.2.3"}
         form = IPNetworkVarJob().as_form(data)
@@ -202,6 +241,9 @@ class JobVariablesTest(TestCase):
         self.assertEqual(form.cleaned_data["var1"], IPNetwork(data["var1"]))
 
     def test_jsonvar(self):
+        class JSONVarJob(Job):
+            var1 = JSONVar()
+
         # Valid JSON value as dictionary
         data = {"var1": {"key1": "value1"}}
         form = JSONVarJob().as_form(data)