nautobot 2.0.0a3__py3-none-any.whl → 2.0.0b1__py3-none-any.whl

nautobot/extras/tests/test_migrations.py

@@ -1,4 +1,4 @@
-from unittest import skipIf, skip
+from unittest import skip, skipIf
 
 from django.db import connection
 
@@ -11,9 +11,10 @@ from nautobot.extras.choices import CustomFieldTypeChoices
     connection.vendor != "postgresql",
     "mysql does not support rollbacks",
 )
+@skip("test skipped until base test can be fixed to handle new migrations")
 class CustomFieldDataMigrationTest(NautobotDataMigrationTest):
-    migrate_from = [("extras", "0074_rename_slug_to_key_for_custom_field")]
-    migrate_to = [("extras", "0075_migrate_custom_field_data")]
+    migrate_from = [("extras", "0075_rename_slug_to_key_for_custom_field")]
+    migrate_to = [("extras", "0076_migrate_custom_field_data")]
 
     def populateDataBeforeMigration(self, installed_apps):
         """populate CustomField data pre-migrations"""

nautobot/extras/tests/test_models.py

@@ -1,8 +1,7 @@
 import os
 import tempfile
-import datetime
-from unittest import mock, skip
-import uuid
+from unittest import mock
+import warnings
 
 from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
@@ -11,7 +10,7 @@ from django.core.files.uploadedfile import SimpleUploadedFile
 from django.db.models import ProtectedError
 from django.db.utils import IntegrityError
 from django.test import override_settings
-
+from django.test.utils import isolate_apps
 
 from nautobot.core.choices import ColorChoices
 from nautobot.core.testing import TestCase, TransactionTestCase
@@ -26,7 +25,7 @@ from nautobot.dcim.models import (
 )
 from nautobot.extras.constants import JOB_OVERRIDABLE_FIELDS
 from nautobot.extras.choices import LogLevelChoices, SecretsGroupAccessTypeChoices, SecretsGroupSecretTypeChoices
-from nautobot.extras.jobs import get_job, Job as JobClass
+from nautobot.extras.jobs import get_job
 from nautobot.extras.models import (
     ComputedField,
     ConfigContext,
@@ -47,9 +46,9 @@ from nautobot.extras.models import (
     Tag,
     Webhook,
 )
-from nautobot.extras.utils import get_job_content_type
+from nautobot.extras.models.statuses import StatusModel
 from nautobot.extras.secrets.exceptions import SecretParametersError, SecretProviderError, SecretValueNotFoundError
-from nautobot.ipam.models import IPAddress, Prefix, Namespace
+from nautobot.ipam.models import IPAddress
 from nautobot.tenancy.models import Tenant
 from nautobot.virtualization.models import (
     Cluster,
@@ -59,7 +58,6 @@ from nautobot.virtualization.models import (
 )
 
 
-@skip(reason="Content Types are BROKEN")
 class ComputedFieldTest(ModelTestCases.BaseModelTestCase):
     """
     Tests for the `ComputedField` Model
@@ -70,7 +68,7 @@ class ComputedFieldTest(ModelTestCases.BaseModelTestCase):
     def setUp(self):
         self.good_computed_field = ComputedField.objects.create(
             content_type=ContentType.objects.get_for_model(Location),
-            slug="good_computed_field",
+            key="good_computed_field",
             label="Good Computed Field",
             template="{{ obj.name }} is awesome!",
             fallback_value="This template has errored",
@@ -78,7 +76,7 @@ class ComputedFieldTest(ModelTestCases.BaseModelTestCase):
         )
         self.bad_computed_field = ComputedField.objects.create(
             content_type=ContentType.objects.get_for_model(Location),
-            slug="bad_computed_field",
+            key="bad_computed_field",
             label="Bad Computed Field",
             template="{{ not_in_context | not_a_filter }} is horrible!",
             fallback_value="An error occurred while rendering this template.",
@@ -86,7 +84,7 @@ class ComputedFieldTest(ModelTestCases.BaseModelTestCase):
         )
         self.blank_fallback_value = ComputedField.objects.create(
             content_type=ContentType.objects.get_for_model(Location),
-            slug="blank_fallback_value",
+            key="blank_fallback_value",
             label="Blank Fallback Value",
             template="{{ obj.location }}",
             weight=50,
@@ -105,6 +103,47 @@ class ComputedFieldTest(ModelTestCases.BaseModelTestCase):
         rendered_value = self.bad_computed_field.render(context={"obj": self.location1})
         self.assertEqual(rendered_value, self.bad_computed_field.fallback_value)
 
+    def test_check_if_key_is_graphql_safe(self):
+        """
+        Check the GraphQL validation method on CustomField Key Attribute.
+        """
+        # Check if it catches the cpf.key starting with a digit.
+        cpf1 = ComputedField(
+            label="Test 1",
+            key="12_test_1",
+            content_type=ContentType.objects.get_for_model(Device),
+        )
+        with self.assertRaises(ValidationError) as error:
+            cpf1.validated_save()
+        self.assertIn(
+            "This key is not Python/GraphQL safe. Please do not start the key with a digit and do not use hyphens or whitespace",
+            str(error.exception),
+        )
+        # Check if it catches the cpf.key with whitespace.
+        cpf1.key = "test 1"
+        with self.assertRaises(ValidationError) as error:
+            cpf1.validated_save()
+        self.assertIn(
+            "This key is not Python/GraphQL safe. Please do not start the key with a digit and do not use hyphens or whitespace",
+            str(error.exception),
+        )
+        # Check if it catches the cpf.key with hyphens.
+        cpf1.key = "test-1-computed-field"
+        with self.assertRaises(ValidationError) as error:
+            cpf1.validated_save()
+        self.assertIn(
+            "This key is not Python/GraphQL safe. Please do not start the key with a digit and do not use hyphens or whitespace",
+            str(error.exception),
+        )
+        # Check if it catches the cpf.key with special characters
+        cpf1.key = "test_1_computed_f)(&d"
+        with self.assertRaises(ValidationError) as error:
+            cpf1.validated_save()
+        self.assertIn(
+            "This key is not Python/GraphQL safe. Please do not start the key with a digit and do not use hyphens or whitespace",
+            str(error.exception),
+        )
+
 
 class ConfigContextTest(ModelTestCases.BaseModelTestCase):
     """
@@ -115,39 +154,43 @@ class ConfigContextTest(ModelTestCases.BaseModelTestCase):
 
     model = ConfigContext
 
-    def setUp(self):
+    @classmethod
+    def setUpTestData(cls):
         manufacturer = Manufacturer.objects.first()
-        self.devicetype = DeviceType.objects.create(
+        cls.devicetype = DeviceType.objects.create(
             manufacturer=manufacturer, model="Device Type 1", slug="device-type-1"
         )
-        self.devicerole = Role.objects.get_for_model(Device).first()
+        cls.devicerole = Role.objects.get_for_model(Device).first()
         location_type = LocationType.objects.create(name="Location Type 1")
-        self.location = Location.objects.create(name="Location 1", location_type=location_type)
-        self.platform = Platform.objects.first()
-        self.tenant = Tenant.objects.first()
-        self.tenantgroup = self.tenant.tenant_group
-        self.tag, self.tag2 = Tag.objects.get_for_model(Device)[:2]
-        self.dynamic_groups = DynamicGroup.objects.create(
+        location_status = Status.objects.get_for_model(Location).first()
+        cls.location = Location.objects.create(name="Location 1", location_type=location_type, status=location_status)
+        cls.platform = Platform.objects.first()
+        cls.tenant = Tenant.objects.first()
+        cls.tenantgroup = cls.tenant.tenant_group
+        cls.tag, cls.tag2 = Tag.objects.get_for_model(Device)[:2]
+        cls.dynamic_groups = DynamicGroup.objects.create(
             name="Dynamic Group",
             content_type=ContentType.objects.get_for_model(Device),
             filter={"name": ["Device 1", "Device 2"]},
         )
-        self.dynamic_group_2 = DynamicGroup.objects.create(
+        cls.dynamic_group_2 = DynamicGroup.objects.create(
             name="Dynamic Group 2",
             content_type=ContentType.objects.get_for_model(Device),
             filter={"name": ["Device 2"]},
         )
-        self.vm_dynamic_group = DynamicGroup.objects.create(
+        cls.vm_dynamic_group = DynamicGroup.objects.create(
             name="VM Dynamic Group",
             content_type=ContentType.objects.get_for_model(VirtualMachine),
             filter={"name": ["VM 1"]},
         )
 
-        self.device = Device.objects.create(
+        cls.device_status = Status.objects.get_for_model(Device).first()
+        cls.device = Device.objects.create(
             name="Device 1",
-            device_type=self.devicetype,
-            role=self.devicerole,
-            location=self.location,
+            device_type=cls.devicetype,
+            role=cls.devicerole,
+            location=cls.location,
+            status=cls.device_status,
         )
 
         ConfigContext.objects.create(name="context 1", weight=100, data={"a": 123, "b": 456, "c": 777})
@@ -178,7 +221,7 @@ class ConfigContextTest(ModelTestCases.BaseModelTestCase):
             slug="test-git-repo",
             remote_url="http://localhost/git.git",
         )
-        repo.save(trigger_resync=False)
+        repo.save()
 
         nonduplicate_context = ConfigContext(name="context 1", weight=300, data={"a": "22"}, owner=repo)
         nonduplicate_context.validated_save()
@@ -217,6 +260,7 @@ class ConfigContextTest(ModelTestCases.BaseModelTestCase):
             tenant=self.tenant,
             platform=self.platform,
             role=self.devicerole,
+            status=self.device_status,
             device_type=self.devicetype,
         )
         device.tags.add(self.tag)
@@ -257,12 +301,14 @@ class ConfigContextTest(ModelTestCases.BaseModelTestCase):
         )
         dynamic_group_context.dynamic_groups.add(self.vm_dynamic_group)
 
+        vm_status = Status.objects.get_for_model(VirtualMachine).first()
         virtual_machine = VirtualMachine.objects.create(
             name="VM 1",
             cluster=cluster,
             tenant=self.tenant,
             platform=self.platform,
             role=self.devicerole,
+            status=vm_status,
         )
         virtual_machine.tags.add(self.tag)
 
@@ -301,6 +347,7 @@ class ConfigContextTest(ModelTestCases.BaseModelTestCase):
             tenant=self.tenant,
             platform=self.platform,
             role=self.devicerole,
+            status=self.device_status,
             device_type=self.devicetype,
         )
         device.tags.add(self.tag)
@@ -332,6 +379,7 @@ class ConfigContextTest(ModelTestCases.BaseModelTestCase):
             tenant=self.tenant,
             platform=self.platform,
             role=self.devicerole,
+            status=self.device_status,
             device_type=self.devicetype,
         )
         device.tags.add(self.tag)
@@ -355,6 +403,7 @@ class ConfigContextTest(ModelTestCases.BaseModelTestCase):
             tenant=self.tenant,
             platform=self.platform,
             role=self.devicerole,
+            status=self.device_status,
             device_type=self.devicetype,
         )
         dynamic_group_context = ConfigContext.objects.create(
@@ -650,7 +699,7 @@ class ExportTemplateTest(ModelTestCases.BaseModelTestCase):
             slug="test-git-repo",
             remote_url="http://localhost/git.git",
         )
-        repo.save(trigger_resync=False)
+        repo.save()
         nonduplicate_template = ExportTemplate(
             content_type=self.device_ct, name="Export Template 1", owner=repo, template_code="bar"
         )
@@ -701,26 +750,11 @@ class GitRepositoryTest(TransactionTestCase):  # TODO: BaseModelTestCase mixin?
             slug="test-git-repo",
             remote_url="http://localhost/git.git",
         )
-        self.repo.save(trigger_resync=False)
+        self.repo.save()
 
     def test_filesystem_path(self):
         self.assertEqual(self.repo.filesystem_path, os.path.join(settings.GIT_ROOT, self.repo.slug))
 
-    def test_save_relocate_directory(self):
-        with tempfile.TemporaryDirectory() as tmpdirname:
-            with self.settings(GIT_ROOT=tmpdirname):
-                initial_path = self.repo.filesystem_path
-                self.assertIn(self.repo.slug, initial_path)
-                os.makedirs(initial_path)
-
-                self.repo.slug = "a-new-location"
-                self.repo.save(trigger_resync=False)
-
-                self.assertFalse(os.path.exists(initial_path))
-                new_path = self.repo.filesystem_path
-                self.assertIn(self.repo.slug, new_path)
-                self.assertTrue(os.path.isdir(new_path))
-
 
 class JobModelTest(ModelTestCases.BaseModelTestCase):
     """
@@ -744,10 +778,10 @@ class JobModelTest(ModelTestCases.BaseModelTestCase):
         self.assertEqual(self.plugin_job.job_class, ExampleJob)
 
     def test_class_path(self):
-        self.assertEqual(self.local_job.class_path, "local/test_pass/TestPass")
+        self.assertEqual(self.local_job.class_path, "pass.TestPass")
         self.assertEqual(self.local_job.class_path, self.local_job.job_class.class_path)
 
-        self.assertEqual(self.plugin_job.class_path, "plugins/example_plugin.jobs/ExampleJob")
+        self.assertEqual(self.plugin_job.class_path, "example_plugin.jobs.ExampleJob")
         self.assertEqual(self.plugin_job.class_path, self.plugin_job.job_class.class_path)
 
     def test_latest_result(self):
@@ -759,13 +793,24 @@ class JobModelTest(ModelTestCases.BaseModelTestCase):
         """Verify that defaults for discovered JobModel instances are as expected."""
         for job_model in JobModel.objects.all():
             self.assertTrue(job_model.installed)
-            self.assertFalse(job_model.enabled)
+            # System jobs should be enabled by default, all others are disabled by default
+            if job_model.module_name.startswith("nautobot."):
+                self.assertTrue(job_model.enabled)
+            else:
+                self.assertFalse(job_model.enabled)
             for field_name in JOB_OVERRIDABLE_FIELDS:
-                if field_name == "name" and "test_duplicate_name" in job_model.job_class.__module__:
+                if field_name == "name" and "duplicate_name" in job_model.job_class.__module__:
                     pass  # name field for test_duplicate_name jobs tested in test_duplicate_job_name below
                 else:
-                    self.assertFalse(getattr(job_model, f"{field_name}_override"))
-                    self.assertEqual(getattr(job_model, field_name), getattr(job_model.job_class, field_name))
+                    self.assertFalse(
+                        getattr(job_model, f"{field_name}_override"),
+                        (field_name, getattr(job_model, field_name), getattr(job_model.job_class, field_name)),
+                    )
+                    self.assertEqual(
+                        getattr(job_model, field_name),
+                        getattr(job_model.job_class, field_name),
+                        field_name,
+                    )
 
     def test_duplicate_job_name(self):
         self.assertTrue(JobModel.objects.filter(name="TestDuplicateNameNoMeta").exists())
@@ -780,9 +825,8 @@ class JobModelTest(ModelTestCases.BaseModelTestCase):
             "grouping": "Overridden Grouping",
             "name": "Overridden Name",
             "description": "Overridden Description",
-            "commit_default": not self.job_containing_sensitive_variables.commit_default,
+            "dryrun_default": not self.job_containing_sensitive_variables.dryrun_default,
             "hidden": not self.job_containing_sensitive_variables.hidden,
-            "read_only": not self.job_containing_sensitive_variables.read_only,
             "approval_required": not self.job_containing_sensitive_variables.approval_required,
             "has_sensitive_variables": not self.job_containing_sensitive_variables.has_sensitive_variables,
             "soft_time_limit": 350,
@@ -816,7 +860,6 @@ class JobModelTest(ModelTestCases.BaseModelTestCase):
         """Verify that cleaning enforces validation of potentially unsanitized user input."""
         with self.assertRaises(ValidationError) as handler:
             JobModel(
-                source="local",
                 module_name="too_long_of_a_module_name.too_long_of_a_module_name.too_long_of_a_module_name.too_long_of_a_module_name.too_long_of_a_module_name",
                 job_class_name="JobClass",
                 grouping="grouping",
@@ -826,7 +869,6 @@ class JobModelTest(ModelTestCases.BaseModelTestCase):
 
         with self.assertRaises(ValidationError) as handler:
             JobModel(
-                source="local",
                 module_name="module_name",
                 job_class_name="ThisIsARidiculouslyLongJobClassNameWhoWouldEverDoSuchAnUtterlyRidiculousThingButBetterSafeThanSorrySinceWeAreDealingWithUserInputHere",
                 grouping="grouping",
@@ -836,7 +878,6 @@ class JobModelTest(ModelTestCases.BaseModelTestCase):
 
         with self.assertRaises(ValidationError) as handler:
             JobModel(
-                source="local",
                 module_name="module_name",
                 job_class_name="JobClassName",
                 grouping="OK now this is just ridiculous. Why would you ever want to deal with typing in 255+ characters of grouping information and have to copy-paste it to the other jobs in the same grouping or risk dealing with typos when typing out such a ridiculously long grouping string? Still, once again, better safe than sorry!",
@@ -846,7 +887,6 @@ class JobModelTest(ModelTestCases.BaseModelTestCase):
 
         with self.assertRaises(ValidationError) as handler:
             JobModel(
-                source="local",
                 module_name="module_name",
                 job_class_name="JobClassName",
                 grouping="grouping",
@@ -856,7 +896,6 @@ class JobModelTest(ModelTestCases.BaseModelTestCase):
 
         with self.assertRaises(ValidationError) as handler:
             JobModel(
-                source="local",
                 module_name="module_name",
                 job_class_name="JobClassName",
                 grouping="grouping",
@@ -870,67 +909,6 @@ class JobModelTest(ModelTestCases.BaseModelTestCase):
         )
 
 
-class JobResultTest(TestCase):
-    """
-    Tests for the `JobResult` model class.
-    """
-
-    def test_related_object(self):
-        """Test that the `related_object` property is computed properly."""
-        # Case 1: Job, identified by class_path.
-        job_class = get_job("local/test_pass/TestPass")
-        job_result = JobResult(
-            name=job_class.class_path,
-            obj_type=get_job_content_type(),
-            task_id=uuid.uuid4(),
-        )
-
-        # Can't just do self.assertEqual(job_result.related_object, job_class) here for some reason
-        self.assertEqual(type(job_result.related_object), type)
-        self.assertTrue(issubclass(job_result.related_object, JobClass))
-        self.assertEqual(job_result.related_object.class_path, "local/test_pass/TestPass")
-
-        job_result.name = "local/no_such_job/NoSuchJob"
-        self.assertIsNone(job_result.related_object)
-
-        job_result.name = "not-a-class-path"
-        self.assertIsNone(job_result.related_object)
-
-        # Case 2: GitRepository, identified by name.
-        repo = GitRepository(
-            name="Test Git Repository",
-            slug="test-git-repo",
-            remote_url="http://localhost/git.git",
-        )
-        repo.save(trigger_resync=False)
-
-        job_result = JobResult(
-            name=repo.name,
-            obj_type=ContentType.objects.get_for_model(repo),
-            task_id=uuid.uuid4(),
-        )
-
-        self.assertEqual(job_result.related_object, repo)
-
-        job_result.name = "No such GitRepository"
-        self.assertIsNone(job_result.related_object)
-
-        # Case 3: Related object with no name, identified by PK/ID
-        namespace = Namespace.objects.first()
-        Prefix.objects.create(prefix="1.1.1.0/24", namespace=namespace)
-        ip_address = IPAddress.objects.create(address="1.1.1.1/32", namespace=namespace)
-        job_result = JobResult(
-            name="irrelevant",
-            obj_type=ContentType.objects.get_for_model(ip_address),
-            task_id=ip_address.pk,
-        )
-
-        self.assertEqual(job_result.related_object, ip_address)
-
-        job_result.task_id = uuid.uuid4()
-        self.assertIsNone(job_result.related_object)
-
-
 class RoleTest(TestCase):
     """Tests for `Role` model class."""
 
@@ -1395,6 +1373,22 @@ class StatusTest(ModelTestCases.BaseModelTestCase):
             self.status.save()
             self.assertEqual(str(self.status), test)
 
+    @isolate_apps("nautobot.extras.tests")
+    def test_deprecated_mixin_class(self):
+        """Test that inheriting from StatusModel raises a DeprecationWarning."""
+        with warnings.catch_warnings(record=True) as warn_list:
+            warnings.simplefilter("always")
+
+            class MyModel(StatusModel):  # pylint: disable=unused-variable
+                pass
+
+        self.assertEqual(len(warn_list), 1)
+        warning = warn_list[0]
+        self.assertTrue(issubclass(warning.category, DeprecationWarning))
+        self.assertIn("StatusModel is deprecated", str(warning))
+        self.assertIn("Instead of deriving MyModel from StatusModel", str(warning))
+        self.assertIn("please directly declare `status = StatusField(...)` on your model instead", str(warning))
+
 
 class TagTest(ModelTestCases.BaseModelTestCase):
     model = Tag
@@ -1412,20 +1406,15 @@ class JobLogEntryTest(TestCase):  # TODO: change to BaseModelTestCase
     """
 
     def setUp(self):
-        module = "test_pass"
+        module = "pass"
         name = "TestPass"
-        job_class = get_job(f"local/{module}/{name}")
+        job_class = get_job(f"{module}.{name}")
 
-        self.job_result = JobResult.objects.create(
-            name=job_class.class_path,
-            obj_type=get_job_content_type(),
-            user=None,
-            task_id=uuid.uuid4(),
-        )
+        self.job_result = JobResult.objects.create(name=job_class.class_path, user=None)
 
     def test_log_entry_creation(self):
         log = JobLogEntry(
-            log_level=LogLevelChoices.LOG_SUCCESS,
+            log_level=LogLevelChoices.LOG_INFO,
             job_result=self.job_result,
             grouping="run",
             message="This is a test",
@@ -1438,40 +1427,6 @@ class JobLogEntryTest(TestCase):  # TODO: change to BaseModelTestCase
         self.assertEqual(log_object.log_level, log.log_level)
         self.assertEqual(log_object.grouping, log.grouping)
 
-    def test_to_csv_no_log_object(self):
-        """Check that `to_csv` returns the correct data from the JobLogEntry model."""
-        expected_data = ("2020-01-26 15:37:36", "run", "success", "", "Django Test")
-
-        joblogentry_a = JobLogEntry(
-            job_result=self.job_result,
-            log_level=LogLevelChoices.LOG_SUCCESS,
-            grouping="run",
-            message="Django Test",
-            created=datetime.datetime(2020, 1, 26, 15, 37, 36),
-            log_object="",
-            absolute_url="",
-        )
-        joblogentry_a.validated_save()
-        csv_data = joblogentry_a.to_csv()
-        self.assertEqual(expected_data, csv_data)
-
-    def test_to_csv_with_log_object(self):
-        """Check that `to_csv` returns the correct data from the JobLogEntry model."""
-        expected_data = ("2030-05-26 15:37:36", "run", "success", "ams01-dist-01", "Django Test 2")
-
-        joblogentry_a = JobLogEntry(
-            job_result=self.job_result,
-            log_level=LogLevelChoices.LOG_SUCCESS,
-            grouping="run",
-            message="Django Test 2",
-            created=datetime.datetime(2030, 5, 26, 15, 37, 36),
-            log_object="ams01-dist-01",
-            absolute_url="https://nautobot.io/dcim/devices/8d769e14-286a-489c-b705-bd15c476abbb",
-        )
-        joblogentry_a.validated_save()
-        csv_data = joblogentry_a.to_csv()
-        self.assertEqual(expected_data, csv_data)
-
 
 class WebhookTest(TestCase):  # TODO: change to BaseModelTestCase
     def test_type_error_not_raised_when_calling_check_for_conflicts(self):