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

nautobot/extras/templatetags/job_buttons.py

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

nautobot/extras/test_jobs/api_test_job.py

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

nautobot/extras/test_jobs/atomic_transaction.py

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

nautobot/extras/test_jobs/dry_run.py

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

nautobot/extras/test_jobs/fail.py

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

nautobot/extras/test_jobs/file_output.py

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

nautobot/extras/test_jobs/file_upload_fail.py

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

nautobot/extras/test_jobs/file_upload_pass.py

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

nautobot/extras/test_jobs/ipaddress_vars.py

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

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

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

nautobot/extras/test_jobs/location_with_custom_field.py

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

nautobot/extras/test_jobs/log_redaction.py

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

nautobot/extras/test_jobs/log_skip_db_logging.py

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

nautobot/extras/test_jobs/modify_db.py

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

nautobot/extras/test_jobs/object_var_optional.py

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

nautobot/extras/test_jobs/object_var_required.py

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

nautobot/extras/test_jobs/object_vars.py

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

nautobot/extras/test_jobs/pass.py

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

nautobot/extras/test_jobs/profiling.py

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

nautobot/extras/test_jobs/relative_import.py

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

nautobot/extras/test_jobs/singleton.py

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

nautobot/extras/test_jobs/soft_time_limit_greater_than_time_limit.py

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

nautobot/extras/test_jobs/task_queues.py

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

nautobot/extras/tests/integration/test_plugin_banner.py

@@ -4,8 +4,6 @@ from nautobot.core.testing.integration import SeleniumTestCase
 class PluginBannerTestCase(SeleniumTestCase):
     """Integration test for rendering of plugin-injected banner content."""
 
-    fixtures = ("user-data",)
-
     def test_banner_not_rendered(self):
         """As implemented, plugin banner does not render if the user is not logged in.
 

nautobot/extras/tests/test_api.py

@@ -1536,10 +1536,10 @@ class JobTest(
         self.assertHttpStatus(response, status.HTTP_404_NOT_FOUND)
 
         # Try post to permitted job
-        job_model = Job.objects.get_for_class_path("pass.TestPass")
+        job_model = Job.objects.get_for_class_path("pass.TestPassJob")
         job_model.enabled = True
         job_model.validated_save()
-        url = self.get_run_url("pass.TestPass")
+        url = self.get_run_url("pass.TestPassJob")
         response = self.client.post(url, **self.header)
         self.assertHttpStatus(response, self.run_success_response_status)
 
@@ -2129,7 +2129,7 @@ class JobTest(
     @mock.patch("nautobot.extras.api.views.get_worker_count", return_value=1)
     def test_run_job_with_default_queue_with_empty_job_model_job_queues(self, _):
         self.add_permissions("extras.run_job")
-        job_model = Job.objects.get_for_class_path("pass.TestPass")
+        job_model = Job.objects.get_for_class_path("pass.TestPassJob")
         data = {
             "task_queue": job_model.default_job_queue.name,
         }
@@ -2137,7 +2137,7 @@ class JobTest(
         job_model.job_queues.set([])
         job_model.enabled = True
         job_model.validated_save()
-        url = self.get_run_url("pass.TestPass")
+        url = self.get_run_url("pass.TestPassJob")
         response = self.client.post(url, data, format="json", **self.header)
         self.assertHttpStatus(response, self.run_success_response_status)
 
@@ -2564,10 +2564,10 @@ class ScheduledJobTest(
     @classmethod
     def setUpTestData(cls):
         user = User.objects.create(username="user1", is_active=True)
-        job_model = Job.objects.get_for_class_path("pass.TestPass")
+        job_model = Job.objects.get_for_class_path("pass.TestPassJob")
         ScheduledJob.objects.create(
             name="test1",
-            task="pass.TestPass",
+            task="pass.TestPassJob",
             job_model=job_model,
             interval=JobExecutionType.TYPE_IMMEDIATELY,
             user=user,
@@ -2576,7 +2576,7 @@ class ScheduledJobTest(
         )
         ScheduledJob.objects.create(
             name="test2",
-            task="pass.TestPass",
+            task="pass.TestPassJob",
             job_model=job_model,
             interval=JobExecutionType.TYPE_DAILY,
             user=user,
@@ -2586,7 +2586,7 @@ class ScheduledJobTest(
         )
         ScheduledJob.objects.create(
             name="test3",
-            task="pass.TestPass",
+            task="pass.TestPassJob",
             job_model=job_model,
             interval=JobExecutionType.TYPE_CUSTOM,
             crontab="34 12 * * *",
@@ -2601,12 +2601,12 @@ class JobApprovalTest(APITestCase):
     @classmethod
     def setUpTestData(cls):
         cls.additional_user = User.objects.create(username="user1", is_active=True)
-        cls.job_model = Job.objects.get_for_class_path("pass.TestPass")
+        cls.job_model = Job.objects.get_for_class_path("pass.TestPassJob")
         cls.job_model.enabled = True
         cls.job_model.save()
         cls.scheduled_job = ScheduledJob.objects.create(
             name="test pass",
-            task="pass.TestPass",
+            task="pass.TestPassJob",
             job_model=cls.job_model,
             interval=JobExecutionType.TYPE_IMMEDIATELY,
             user=cls.additional_user,
@@ -2659,7 +2659,7 @@ class JobApprovalTest(APITestCase):
         self.add_permissions("extras.approve_job", "extras.view_scheduledjob", "extras.change_scheduledjob")
         scheduled_job = ScheduledJob.objects.create(
             name="test",
-            task="pass.TestPass",
+            task="pass.TestPassJob",
             job_model=self.job_model,
             interval=JobExecutionType.TYPE_IMMEDIATELY,
             user=self.user,
@@ -2682,7 +2682,7 @@ class JobApprovalTest(APITestCase):
         self.add_permissions("extras.approve_job", "extras.view_scheduledjob", "extras.change_scheduledjob")
         scheduled_job = ScheduledJob.objects.create(
             name="test",
-            task="pass.TestPass",
+            task="pass.TestPassJob",
             job_model=self.job_model,
             interval=JobExecutionType.TYPE_FUTURE,
             one_off=True,
@@ -2699,7 +2699,7 @@ class JobApprovalTest(APITestCase):
         self.add_permissions("extras.approve_job", "extras.view_scheduledjob", "extras.change_scheduledjob")
         scheduled_job = ScheduledJob.objects.create(
             name="test",
-            task="pass.TestPass",
+            task="pass.TestPassJob",
             job_model=self.job_model,
             interval=JobExecutionType.TYPE_FUTURE,
             one_off=True,

nautobot/extras/tests/test_customfields.py

@@ -2240,7 +2240,7 @@ class CustomFieldTableTest(TestCase):
             self.assertIsNotNone(custom_column, internal_col_name)
             self.assertIsInstance(custom_column, CustomFieldColumn)
 
-            rendered_value = bound_row.get_cell(internal_col_name)
+            rendered_value = bound_row.get_cell(internal_col_name)  # pylint: disable=no-member
             self.assertEqual(rendered_value, col_expected_value)
 
 

nautobot/extras/tests/test_datasources.py

@@ -285,7 +285,8 @@ class GitTest(TransactionTestCase):
 
                 self.repo.secrets_group = secrets_group
                 self.repo.remote_url = "http://localhost/git.git"
-                self.repo.provided_contents.remove("extras.job")  # avoid failing due to lack of jobs module
+                # avoid failing due to lack of jobs module
+                self.repo.provided_contents.remove("extras.job")  # pylint: disable=no-member
                 self.repo.save()
 
                 self.mock_request.id = uuid.uuid4()

nautobot/extras/tests/test_dynamicgroups.py

@@ -587,7 +587,7 @@ class DynamicGroupModelTest(DynamicGroupTestBase):  # TODO: BaseModelTestCase mi
         """
         pfx_content_type = ContentType.objects.get_for_model(Prefix)
         group = DynamicGroup(name="pfx", content_type=pfx_content_type)
-        filterset = group.filterset_class()
+        filterset = group.filterset_class()  # pylint: disable=not-callable  # should not be None here!
         fields = group._map_filter_fields
 
         # We know that `within_include` does not have a `generate_query_{filter_method}` method.

nautobot/extras/tests/test_filters.py

@@ -890,11 +890,11 @@ class JobFilterSetTestCase(FilterTestCases.FilterTestCase):
         Job.objects.last().tags.set(Tag.objects.get_for_model(Job)[:3])
 
     def test_installed(self):
-        params = {"job_class_name": "TestPass", "installed": True}
+        params = {"job_class_name": "TestPassJob", "installed": True}
         self.assertTrue(self.filterset(params, self.queryset).qs.exists())
 
     def test_enabled(self):
-        params = {"job_class_name": "TestPass", "enabled": False}
+        params = {"job_class_name": "TestPassJob", "enabled": False}
         self.assertTrue(self.filterset(params, self.queryset).qs.exists())
 
     def test_dryrun_default(self):
@@ -992,11 +992,11 @@ class JobResultFilterSetTestCase(FilterTestCases.FilterTestCase):
         jobs = Job.objects.all()[:3]
         cls.jobs = jobs
         user = User.objects.create(username="user1", is_active=True)
-        job_model = Job.objects.get_for_class_path("pass.TestPass")
+        job_model = Job.objects.get_for_class_path("pass.TestPassJob")
         scheduled_jobs = [
             ScheduledJob.objects.create(
                 name="test1",
-                task="pass.TestPass",
+                task="pass.TestPassJob",
                 job_model=job_model,
                 interval=JobExecutionType.TYPE_IMMEDIATELY,
                 user=user,
@@ -1005,7 +1005,7 @@ class JobResultFilterSetTestCase(FilterTestCases.FilterTestCase):
             ),
             ScheduledJob.objects.create(
                 name="test2",
-                task="pass.TestPass",
+                task="pass.TestPassJob",
                 job_model=job_model,
                 interval=JobExecutionType.TYPE_DAILY,
                 user=user,
@@ -1015,7 +1015,7 @@ class JobResultFilterSetTestCase(FilterTestCases.FilterTestCase):
             ),
             ScheduledJob.objects.create(
                 name="test3",
-                task="pass.TestPass",
+                task="pass.TestPassJob",
                 job_model=job_model,
                 interval=JobExecutionType.TYPE_CUSTOM,
                 crontab="34 12 * * *",

nautobot/extras/tests/test_forms.py

@@ -4,12 +4,13 @@ import warnings
 from django.contrib.auth import get_user_model
 from django.contrib.contenttypes.models import ContentType
 from django.db.models import Q
+from django.forms import ChoiceField, MultipleChoiceField
 from django.test import override_settings, TestCase
 
 from nautobot.dcim.forms import DeviceForm, LocationBulkEditForm, LocationForm
 import nautobot.dcim.models as dcim_models
 from nautobot.dcim.models import Device, Location, LocationType
-from nautobot.extras.choices import RelationshipTypeChoices
+from nautobot.extras.choices import CustomFieldTypeChoices, RelationshipTypeChoices
 from nautobot.extras.forms import (
     ConfigContextFilterForm,
     ConfigContextForm,
@@ -25,6 +26,7 @@ from nautobot.extras.forms import (
     WebhookForm,
 )
 from nautobot.extras.models import (
+    CustomField,
     Job,
     JobButton,
     JobHook,
@@ -908,6 +910,19 @@ class RelationshipModelBulkEditFormMixinTestCase(TestCase):
         ras = RelationshipAssociation.objects.filter(relationship=self.rel_mtom_s)
         self.assertEqual(1, ras.count())
 
+    def test_form_save_relationship_with_nullified_fields_is_none(self):
+        """Test save_relationships with nullified_fields=None."""
+        form = LocationBulkEditForm(
+            model=dcim_models.Location,
+            data={
+                "pks": [self.locations[0].pk],
+                "add_cr_multiplexing__destination": [ipaddress.pk for ipaddress in self.ipaddresses],
+                "add_cr_peer_locations__peer": [self.locations[1].pk],
+            },
+        )
+        form.is_valid()
+        form.save_relationships(instance=self.locations[0], nullified_fields=None)
+
     def test_location_form_remove_mtom(self):
         """Test removal of relationship-associations for many-to-many relationships."""
         RelationshipAssociation.objects.create(
@@ -1217,3 +1232,20 @@ class CustomFieldModelFormMixinTestCase(TestCase):
 
         custom_field_form = TestForm()
         self.assertIn("_custom_field_data", custom_field_form.fields)
+
+
+class CustomFieldTestCase(TestCase):
+    def test_to_form_field_type_select(self):
+        """Verify that `to_form_field` and `to_filter_form_field` return the correct field types for a select-type CustomField."""
+        custom_field = CustomField.objects.create(
+            type=CustomFieldTypeChoices.TYPE_SELECT,
+            label="Custom Field Select",
+        )
+        form = custom_field.to_filter_form_field()
+        self.assertIsInstance(form, MultipleChoiceField)
+
+        form = custom_field.to_form_field(for_filter_form=True)
+        self.assertIsInstance(form, MultipleChoiceField)
+
+        form = custom_field.to_form_field(for_filter_form=False)
+        self.assertIsInstance(form, ChoiceField)