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

nautobot/extras/tests/test_jobs.py

@@ -38,8 +38,6 @@ from nautobot.extras.choices import (
 )
 from nautobot.extras.context_managers import change_logging, JobHookChangeContext, web_request_context
 from nautobot.extras.jobs import get_job, get_jobs
-from nautobot.extras.models import Job, JobQueue
-from nautobot.extras.models.jobs import JobLogEntry
 
 
 class JobTest(TestCase):
@@ -163,7 +161,7 @@ class JobTest(TestCase):
         self.assertTrue(job_model.supports_dryrun)
 
         module = "pass"
-        name = "TestPassJob"
+        name = "TestPass"
         job_class, job_model = get_job_class_and_model(module, name)
         self.assertFalse(job_class.supports_dryrun)
         self.assertFalse(job_model.supports_dryrun)
@@ -193,31 +191,27 @@ class JobTest(TestCase):
                 with override_settings(JOBS_ROOT=temp_dir):
                     # Create a new Job and make sure it's discovered correctly
                     with open(os.path.join(temp_dir, "my_jobs.py"), "w") as fd:
-                        fd.write(
-                            """\
+                        fd.write("""\
 from nautobot.apps.jobs import Job, register_jobs
 class MyJob(Job):
     def run(self):
         pass
 register_jobs(MyJob)
-"""
-                        )
+""")
                     jobs_data = get_jobs(reload=True)
                     self.assertIn("my_jobs.MyJob", jobs_data.keys())
                     self.assertIsNotNone(get_job("my_jobs.MyJob"))
                     # Also make sure some representative previous JOBS_ROOT jobs aren't still around:
                     self.assertNotIn("dry_run.TestDryRun", jobs_data.keys())
-                    self.assertNotIn("pass.TestPassJob", jobs_data.keys())
+                    self.assertNotIn("pass.TestPass", jobs_data.keys())
 
                     # Create a second Job in the same module
                     with open(os.path.join(temp_dir, "my_jobs.py"), "a") as fd:
-                        fd.write(
-                            """
+                        fd.write("""
 class MyOtherJob(MyJob):
     pass
 register_jobs(MyOtherJob)
-"""
-                        )
+""")
                     jobs_data = get_jobs(reload=True)
                     self.assertIn("my_jobs.MyJob", jobs_data.keys())
                     self.assertIsNotNone(get_job("my_jobs.MyJob"))
@@ -226,16 +220,14 @@ register_jobs(MyOtherJob)
 
                     # Create a third Job in another module
                     with open(os.path.join(temp_dir, "their_jobs.py"), "w") as fd:
-                        fd.write(
-                            """
+                        fd.write("""
 from nautobot.apps.jobs import Job, register_jobs
 
 class MyJob(Job):
     def run(self):
         pass
 register_jobs(MyJob)
-"""
-                        )
+""")
                     jobs_data = get_jobs(reload=True)
                     self.assertIn("my_jobs.MyJob", jobs_data.keys())
                     self.assertIsNotNone(get_job("my_jobs.MyJob"))
@@ -257,16 +249,14 @@ register_jobs(MyJob)
 
                     # Create a module with an inauspicious name
                     with open(os.path.join(temp_dir, "traceback.py"), "w") as fd:
-                        fd.write(
-                            """
+                        fd.write("""
 from nautobot.apps.jobs import Job, register_jobs
 
 class BadJob(Job):
     def run(self):
         raise RuntimeError("You ran a bad job!")
 register_jobs(BadJob)
-"""
-                        )
+""")
                     jobs_data = get_jobs(reload=True)
                     self.assertIn("my_jobs.MyJob", jobs_data.keys())
                     self.assertIsNotNone(get_job("my_jobs.MyJob"))
@@ -298,105 +288,6 @@ class JobTransactionTest(TransactionTestCase):
         self.request.id = uuid.uuid4()
         self.request.user = self.user
 
-    def test_bulk_delete_system_jobs_fail(self):
-        system_job_queryset = Job.objects.filter(module_name__startswith="nautobot.")
-        pk_list = [str(pk) for pk in system_job_queryset.values_list("pk", flat=True)[:3]]
-        initial_count = Job.objects.all().count()
-        self.add_permissions("extras.delete_job")
-        job_result = create_job_result_and_run_job(
-            "nautobot.core.jobs.bulk_actions",
-            "BulkDeleteObjects",
-            content_type=ContentType.objects.get_for_model(Job).id,
-            delete_all=False,
-            filter_query_params={},
-            pk_list=pk_list,
-            username=self.user.username,
-        )
-        self.assertEqual(job_result.status, JobResultStatusChoices.STATUS_FAILURE)
-        error_log = JobLogEntry.objects.get(job_result=job_result, log_level=LogLevelChoices.LOG_ERROR)
-        self.assertIn(
-            f"Unable to delete Job {system_job_queryset.first()}. System Job cannot be deleted", error_log.message
-        )
-        self.assertEqual(initial_count, Job.objects.all().count())
-
-    def test_job_bulk_edit_default_queue_stays_default_after_one_field_update(self):
-        self.add_permissions("extras.change_job", "extras.view_job")
-        job_class_to_test = "TestPassJob"
-        job_description = "default job queue test"
-        job_to_test = Job.objects.get(job_class_name=job_class_to_test)
-        queryset = Job.objects.filter(installed=True, hidden=False, job_class_name=job_class_to_test)
-        default_job_queue = job_to_test.default_job_queue
-        pk_list = list(queryset.values_list("pk", flat=True))
-
-        job_ct = ContentType.objects.get_for_model(Job)
-        job_result = create_job_result_and_run_job(
-            "nautobot.core.jobs.bulk_actions",
-            "BulkEditObjects",
-            content_type=job_ct.id,
-            edit_all=False,
-            filter_query_params={},
-            form_data={
-                "pk": pk_list,
-                "description": job_description,
-            },
-            username=self.user.username,
-        )
-        self.assertEqual(job_result.status, JobResultStatusChoices.STATUS_SUCCESS)
-        self.assertEqual(Job.objects.filter(description=job_description).count(), queryset.count())
-        self.assertFalse(
-            JobLogEntry.objects.filter(job_result=job_result, log_level=LogLevelChoices.LOG_WARNING).exists()
-        )
-        self.assertFalse(
-            JobLogEntry.objects.filter(job_result=job_result, log_level=LogLevelChoices.LOG_ERROR).exists()
-        )
-        instance = Job.objects.get(job_class_name=job_class_to_test)
-        self.assertEqual(instance.description, job_description)
-        self.assertEqual(instance.default_job_queue, default_job_queue)
-
-    def test_job_bulk_edit_preserve_job_queues_after_one_field_update(self):
-        self.add_permissions("extras.change_job", "extras.view_job")
-        job_class_to_test = "TestPassJob"
-        job_description = "job queues test"
-        job_to_test = Job.objects.get(job_class_name=job_class_to_test)
-
-        # Simulate 3 job queues set
-        job_queues = JobQueue.objects.all()[:3]
-        job_to_test.job_queues.set(job_queues)
-        job_to_test.job_queues.add(job_to_test.default_job_queue)
-        job_to_test.job_queues_override = True
-        job_to_test.save()
-
-        expected_job_queues = list(job_to_test.job_queues.values_list("pk", flat=True))
-
-        queryset = Job.objects.filter(installed=True, hidden=False, job_class_name=job_class_to_test)
-        pk_list = list(queryset.values_list("pk", flat=True))
-
-        job_ct = ContentType.objects.get_for_model(Job)
-        job_result = create_job_result_and_run_job(
-            "nautobot.core.jobs.bulk_actions",
-            "BulkEditObjects",
-            content_type=job_ct.id,
-            edit_all=False,
-            filter_query_params={},
-            form_data={
-                "pk": pk_list,
-                "description": job_description,
-            },
-            username=self.user.username,
-        )
-        self.assertEqual(job_result.status, JobResultStatusChoices.STATUS_SUCCESS)
-        self.assertEqual(Job.objects.filter(description=job_description).count(), queryset.count())
-        self.assertFalse(
-            JobLogEntry.objects.filter(job_result=job_result, log_level=LogLevelChoices.LOG_WARNING).exists()
-        )
-        self.assertFalse(
-            JobLogEntry.objects.filter(job_result=job_result, log_level=LogLevelChoices.LOG_ERROR).exists()
-        )
-
-        instance = Job.objects.get(job_class_name=job_class_to_test)
-        self.assertEqual(instance.description, job_description)
-        self.assertQuerySetEqual(instance.job_queues.all(), JobQueue.objects.filter(pk__in=expected_job_queues))
-
     def test_job_hard_time_limit_less_than_soft_time_limit(self):
         """
         Job test which produces a warning log message because the time_limit is less than the soft_time_limit.
@@ -419,7 +310,7 @@ class JobTransactionTest(TransactionTestCase):
         Job test with pass result.
         """
         module = "pass"
-        name = "TestPassJob"
+        name = "TestPass"
         job_result = create_job_result_and_run_job(module, name)
         self.assertEqual(job_result.status, JobResultStatusChoices.STATUS_SUCCESS)
         self.assertEqual(job_result.result, True)
@@ -453,7 +344,7 @@ class JobTransactionTest(TransactionTestCase):
         Job test with fail result.
         """
         module = "fail"
-        name = "TestFailJob"
+        name = "TestFail"
         job_result = create_job_result_and_run_job(module, name)
         self.assertEqual(job_result.status, JobResultStatusChoices.STATUS_FAILURE)
         logs = job_result.job_log_entries
@@ -688,7 +579,7 @@ class JobTransactionTest(TransactionTestCase):
         Job test to see if the latest_result property is indeed returning the most recent job result
         """
         module = "pass"
-        name = "TestPassJob"
+        name = "TestPass"
         job_result_1 = create_job_result_and_run_job(module, name)
         self.assertEqual(job_result_1.status, JobResultStatusChoices.STATUS_SUCCESS)
         job_result_2 = create_job_result_and_run_job(module, name)
@@ -715,38 +606,6 @@ class JobTransactionTest(TransactionTestCase):
         self.assertTrue(profiling_result.exists())
         profiling_result.unlink()
 
-    def test_job_singleton(self):
-        module = "singleton"
-        name = "TestSingletonJob"
-
-        job_class, _ = get_job_class_and_model(module, name, "local")
-        self.assertTrue(job_class.is_singleton)
-        cache.set(job_class.singleton_cache_key, 1)
-        failed_job_result = create_job_result_and_run_job(module, name)
-
-        self.assertEqual(
-            failed_job_result.status, JobResultStatusChoices.STATUS_FAILURE, msg="Duplicate singleton job didn't error."
-        )
-        self.assertIsNone(cache.get(job_class.singleton_cache_key, None))
-
-    def test_job_ignore_singleton(self):
-        module = "singleton"
-        name = "TestSingletonJob"
-
-        job_class, _ = get_job_class_and_model(module, name, "local")
-        self.assertTrue(job_class.is_singleton)
-        cache.set(job_class.singleton_cache_key, 1)
-        passed_job_result = create_job_result_and_run_job(
-            module, name, celery_kwargs={"nautobot_job_ignore_singleton_lock": True}
-        )
-
-        self.assertEqual(
-            passed_job_result.status,
-            JobResultStatusChoices.STATUS_SUCCESS,
-            msg="Duplicate singleton job didn't succeed with nautobot_job_ignore_singleton_lock=True.",
-        )
-        self.assertIsNone(cache.get(job_class.singleton_cache_key, None))
-
     @mock.patch("nautobot.extras.context_managers.enqueue_webhooks")
     def test_job_fires_webhooks(self, mock_enqueue_webhooks):
         module = "atomic_transaction"
@@ -935,7 +794,7 @@ class RunJobManagementCommandTest(TransactionTestCase):
     def test_runjob_nochange_successful(self):
         """Basic success-path test for Jobs that don't modify the Nautobot database."""
         module = "pass"
-        name = "TestPassJob"
+        name = "TestPass"
         _job_class, job_model = get_job_class_and_model(module, name)
 
         out, err = self.run_command("--local", "--no-color", "--username", self.user.username, job_model.class_path)
@@ -1033,7 +892,7 @@ class JobButtonReceiverTest(TestCase):
     def test_is_job_button(self):
         with self.subTest(expected=False):
             module = "pass"
-            name = "TestPassJob"
+            name = "TestPass"
             _job_class, job_model = get_job_class_and_model(module, name)
             self.assertFalse(job_model.is_job_button_receiver)
 
@@ -1096,7 +955,7 @@ class JobHookReceiverTest(TestCase):
     def test_is_job_hook(self):
         with self.subTest(expected=False):
             module = "pass"
-            name = "TestPassJob"
+            name = "TestPass"
             _job_class, job_model = get_job_class_and_model(module, name)
             self.assertFalse(job_model.is_job_hook_receiver)
 
@@ -1257,7 +1116,7 @@ class RemoveScheduledJobManagementCommandTestCase(TestCase):
         for i in range(1, 7):
             models.ScheduledJob.objects.create(
                 name=f"test{i}",
-                task="pass.TestPassJob",
+                task="pass.TestPass",
                 interval=JobExecutionType.TYPE_FUTURE,
                 user=self.user,
                 start_time=timezone.now() - datetime.timedelta(days=i * 30),
@@ -1266,7 +1125,7 @@ class RemoveScheduledJobManagementCommandTestCase(TestCase):
 
         models.ScheduledJob.objects.create(
             name="test7",
-            task="pass.TestPassJob",
+            task="pass.TestPass",
             interval=JobExecutionType.TYPE_DAILY,
             user=self.user,
             start_time=timezone.now() - datetime.timedelta(days=180),
@@ -1294,7 +1153,7 @@ class ScheduledJobIntervalTestCase(TestCase):
         start_time = timezone.now() + datetime.timedelta(days=6)
         scheduled_job = models.ScheduledJob.objects.create(
             name="weekly_interval",
-            task="pass.TestPassJob",
+            task="pass.TestPass",
             interval=JobExecutionType.TYPE_WEEKLY,
             user=self.user,
             start_time=start_time,

nautobot/extras/tests/test_models.py

@@ -1083,7 +1083,7 @@ class JobModelTest(ModelTestCases.BaseModelTestCase):
     @classmethod
     def setUpTestData(cls):
         # JobModel instances are automatically instantiated at startup, so we just need to look them up.
-        cls.local_job = JobModel.objects.get(job_class_name="TestPassJob")
+        cls.local_job = JobModel.objects.get(job_class_name="TestPass")
         cls.job_containing_sensitive_variables = JobModel.objects.get(job_class_name="ExampleLoggingJob")
         cls.app_job = JobModel.objects.get(job_class_name="ExampleJob")
 
@@ -1095,7 +1095,7 @@ class JobModelTest(ModelTestCases.BaseModelTestCase):
         self.assertEqual(self.app_job.job_class, ExampleJob)
 
     def test_class_path(self):
-        self.assertEqual(self.local_job.class_path, "pass.TestPassJob")
+        self.assertEqual(self.local_job.class_path, "pass.TestPass")
         self.assertIsNotNone(self.local_job.job_class)
         self.assertEqual(self.local_job.class_path, self.local_job.job_class.class_path)
 
@@ -1832,11 +1832,11 @@ class ScheduledJobTest(ModelTestCases.BaseModelTestCase):
 
     def setUp(self):
         self.user = User.objects.create_user(username="scheduledjobuser")
-        self.job_model = JobModel.objects.get(name="TestPassJob")
+        self.job_model = JobModel.objects.get(name="TestPass")
 
         self.daily_utc_job = ScheduledJob.objects.create(
             name="Daily UTC Job",
-            task="pass.TestPassJob",
+            task="pass.TestPass",
             job_model=self.job_model,
             interval=JobExecutionType.TYPE_DAILY,
             start_time=datetime(year=2050, month=1, day=22, hour=17, minute=0, tzinfo=get_default_timezone()),
@@ -1844,7 +1844,7 @@ class ScheduledJobTest(ModelTestCases.BaseModelTestCase):
         )
         self.daily_est_job = ScheduledJob.objects.create(
             name="Daily EST Job",
-            task="pass.TestPassJob",
+            task="pass.TestPass",
             job_model=self.job_model,
             interval=JobExecutionType.TYPE_DAILY,
             start_time=datetime(year=2050, month=1, day=22, hour=17, minute=0, tzinfo=ZoneInfo("America/New_York")),
@@ -1859,7 +1859,7 @@ class ScheduledJobTest(ModelTestCases.BaseModelTestCase):
         )
         self.crontab_est_job = ScheduledJob.objects.create(
             name="Crontab EST Job",
-            task="pass.TestPassJob",
+            task="pass.TestPass",
             job_model=self.job_model,
             interval=JobExecutionType.TYPE_CUSTOM,
             start_time=datetime(year=2050, month=1, day=22, hour=17, minute=0, tzinfo=ZoneInfo("America/New_York")),
@@ -1868,7 +1868,7 @@ class ScheduledJobTest(ModelTestCases.BaseModelTestCase):
         )
         self.one_off_utc_job = ScheduledJob.objects.create(
             name="One-off UTC Job",
-            task="pass.TestPassJob",
+            task="pass.TestPass",
             job_model=self.job_model,
             interval=JobExecutionType.TYPE_FUTURE,
             start_time=datetime(year=2050, month=1, day=22, hour=0, minute=0, tzinfo=ZoneInfo("UTC")),
@@ -2015,7 +2015,7 @@ class ScheduledJobTest(ModelTestCases.BaseModelTestCase):
         """Test that TYPE_CUSTOM behavior around DST is as expected."""
         cronjob = ScheduledJob.objects.create(
             name="DST Aware Cronjob",
-            task="pass.TestPassJob",
+            task="pass.TestPass",
             job_model=self.job_model,
             enabled=False,
             interval=JobExecutionType.TYPE_CUSTOM,
@@ -2070,7 +2070,7 @@ class ScheduledJobTest(ModelTestCases.BaseModelTestCase):
         """Test the interaction of TYPE_DAILY around DST."""
         daily = ScheduledJob.objects.create(
             name="Daily Job",
-            task="pass.TestPassJob",
+            task="pass.TestPass",
             job_model=self.job_model,
             enabled=False,
             interval=JobExecutionType.TYPE_DAILY,
@@ -2638,7 +2638,7 @@ class JobLogEntryTest(TestCase):  # TODO: change to BaseModelTestCase
 
     def setUp(self):
         module = "pass"
-        name = "TestPassJob"
+        name = "TestPass"
         job_class = get_job(f"{module}.{name}")
 
         self.job_result = JobResult.objects.create(name=job_class.class_path, user=None)

nautobot/extras/tests/test_plugins.py

@@ -1,6 +1,5 @@
-from unittest import mock, skip
+from unittest import mock, skip, skipIf
 
-from django.apps import apps
 from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ValidationError
@@ -22,7 +21,6 @@ from nautobot.extras.models import CustomField, Relationship, RelationshipAssoci
 from nautobot.extras.plugins.exceptions import PluginImproperlyConfigured
 from nautobot.extras.plugins.utils import load_plugin
 from nautobot.extras.plugins.validators import wrap_model_clean_methods
-from nautobot.extras.plugins.views import extract_app_data
 from nautobot.extras.registry import DatasourceContent, registry
 from nautobot.ipam.models import IPAddress, Namespace, Prefix
 from nautobot.tenancy.filters import TenantFilterSet
@@ -317,61 +315,6 @@ class AppListViewTest(TestCase):
         response_body = extract_page_body(response.content.decode(response.charset)).lower()
         self.assertIn("example app", response_body, msg=response_body)
 
-    def test_extract_app_data(self):
-        app_config = apps.get_app_config("example_app")
-        # Without a corresponding entry in marketplace_data
-        self.assertEqual(
-            extract_app_data(app_config, {"apps": []}),
-            {
-                "name": "Example Nautobot App",
-                "package": "example_app",
-                "app_label": "example_app",
-                "author": "Nautobot development team",
-                "author_email": "nautobot@example.com",
-                "headline": "For testing purposes only",
-                "description": "For testing purposes only",
-                "version": "1.0.0",
-                "home_url": "plugins:example_app:home",
-                "config_url": "plugins:example_app:config",
-                "docs_url": "plugins:example_app:docs",
-            },
-        )
-
-        # With a corresponding entry in marketplace_data
-        mock_marketplace_data = {
-            "apps": [
-                {
-                    "name": "Nautobot Example App",
-                    "use_cases": ["Example", "Development"],
-                    "requires": [],
-                    "docs": "https://example.com/docs/example_app/",
-                    "headline": "Demonstrate and test various parts of Nautobot App APIs and functionality.",
-                    "description": "An example of the kinds of things a Nautobot App can do, including ...",
-                    "package_name": "example_app",
-                    "author": "Network to Code (NTC)",
-                    "availability": "Open Source",
-                    "icon": "...",
-                },
-            ],
-        }
-        self.assertEqual(
-            extract_app_data(app_config, mock_marketplace_data),
-            {
-                "name": "Nautobot Example App",
-                "package": "example_app",
-                "app_label": "example_app",
-                "author": "Network to Code (NTC)",
-                "author_email": "nautobot@example.com",
-                "availability": "Open Source",
-                "headline": "Demonstrate and test various parts of Nautobot App APIs and functionality.",
-                "description": "An example of the kinds of things a Nautobot App can do, including ...",
-                "version": "1.0.0",
-                "home_url": "plugins:example_app:home",
-                "config_url": "plugins:example_app:config",
-                "docs_url": "plugins:example_app:docs",
-            },
-        )
-
 
 class PluginDetailViewTest(TestCase):
     def test_view_detail_anonymous(self):
@@ -857,6 +800,10 @@ class TestAppCoreViewOverrides(TestCase):
         )
 
 
+@skipIf(
+    "example_plugin" not in settings.PLUGINS,
+    "example_plugin not in settings.PLUGINS",
+)
 class PluginTemplateExtensionsTest(TestCase):
     """
     Test that registered TemplateExtensions inject content as expected
@@ -876,19 +823,19 @@ class PluginTemplateExtensionsTest(TestCase):
     def test_detail_view_buttons(self):
         response = self.client.get(reverse("dcim:location", kwargs={"pk": self.location.pk}))
         response_body = extract_page_body(response.content.decode(response.charset))
-        self.assertIn("APP INJECTED LOCATION CONTENT - BUTTONS", response_body, msg=response_body)
+        self.assertIn("LOCATION CONTENT - BUTTONS", response_body, msg=response_body)
 
     def test_detail_view_left_page(self):
         response = self.client.get(reverse("dcim:location", kwargs={"pk": self.location.pk}))
         response_body = extract_page_body(response.content.decode(response.charset))
-        self.assertIn("App Injected Content - Left", response_body, msg=response_body)
+        self.assertIn("LOCATION CONTENT - LEFT PAGE", response_body, msg=response_body)
 
     def test_detail_view_right_page(self):
         response = self.client.get(reverse("dcim:location", kwargs={"pk": self.location.pk}))
         response_body = extract_page_body(response.content.decode(response.charset))
-        self.assertIn("App Injected Content - Right", response_body, msg=response_body)
+        self.assertIn("LOCATION CONTENT - RIGHT PAGE", response_body, msg=response_body)
 
     def test_detail_view_full_width_page(self):
         response = self.client.get(reverse("dcim:location", kwargs={"pk": self.location.pk}))
         response_body = extract_page_body(response.content.decode(response.charset))
-        self.assertIn("App Injected Content - Full Width", response_body, msg=response_body)
+        self.assertIn("LOCATION CONTENT - FULL WIDTH PAGE", response_body, msg=response_body)