nautobot 3.0.0a2__py3-none-any.whl → 3.0.0rc1__py3-none-any.whl

nautobot/extras/tests/test_approvals.py

@@ -39,31 +39,31 @@ class ApprovalWorkflowTestMixin:
         cls.approval_workflow_def_1 = models.ApprovalWorkflowDefinition.objects.create(
             name="Test Approval Workflow Definition 1",
             model_content_type=scheduled_job_ct,
-            priority=0,
+            weight=0,
         )
         cls.approval_workflow_def_2 = models.ApprovalWorkflowDefinition.objects.create(
             name="Test Approval Workflow Definition 2",
             model_content_type=scheduled_job_ct,
             model_constraints={"name": "Bulk Delete Objects"},
-            priority=1,
+            weight=1,
         )
         cls.approval_workflow_def_3 = models.ApprovalWorkflowDefinition.objects.create(
             name="Test Approval Workflow Definition 3",
             model_content_type=scheduled_job_ct,
             model_constraints={"name": "Bulk Delete Objects"},
-            priority=2,
+            weight=2,
         )
         cls.approval_workflow_def_4 = models.ApprovalWorkflowDefinition.objects.create(
             name="Test Approval Workflow Definition 4",
             model_content_type=scheduled_job_ct,
             model_constraints={"name": "Bulk Delete Objects"},
-            priority=3,
+            weight=3,
         )
         cls.approval_workflow_def_5 = models.ApprovalWorkflowDefinition.objects.create(
             name="Test Approval Workflow Definition 5",
             model_content_type=scheduled_job_ct,
             model_constraints={"name": "Bulk Delete Objects"},
-            priority=4,
+            weight=4,
         )
         cls.approval_workflow_1_instance_1 = models.ApprovalWorkflow.objects.create(
             approval_workflow_definition=cls.approval_workflow_def_1,
@@ -97,7 +97,7 @@ class ApprovalWorkflowTestMixin:
         )
         cls.approval_workflow_1_stage_def_1 = models.ApprovalWorkflowStageDefinition.objects.create(
             approval_workflow_definition=cls.approval_workflow_def_1,
-            weight=100,
+            sequence=100,
             name="Test Approval Workflow 1 Stage 1",
             min_approvers=2,
             denial_message="Stage 1 Denial Message",
@@ -105,7 +105,7 @@ class ApprovalWorkflowTestMixin:
         )
         cls.approval_workflow_1_stage_def_2 = models.ApprovalWorkflowStageDefinition.objects.create(
             approval_workflow_definition=cls.approval_workflow_def_1,
-            weight=200,
+            sequence=200,
             name="Test Approval Workflow 1 Stage 2",
             min_approvers=2,
             denial_message="Stage 2 Denial Message",
@@ -113,7 +113,7 @@ class ApprovalWorkflowTestMixin:
         )
         cls.approval_workflow_1_stage_def_3 = models.ApprovalWorkflowStageDefinition.objects.create(
             approval_workflow_definition=cls.approval_workflow_def_1,
-            weight=300,
+            sequence=300,
             name="Test Approval Workflow 1 Stage 3",
             min_approvers=2,
             denial_message="Stage 3 Denial Message",
@@ -121,7 +121,7 @@ class ApprovalWorkflowTestMixin:
         )
         cls.approval_workflow_1_stage_def_4 = models.ApprovalWorkflowStageDefinition.objects.create(
             approval_workflow_definition=cls.approval_workflow_def_1,
-            weight=400,
+            sequence=400,
             name="Test Approval Workflow 1 Stage 4",
             min_approvers=2,
             denial_message="Stage 4 Denial Message",
@@ -129,7 +129,7 @@ class ApprovalWorkflowTestMixin:
         )
         cls.approval_workflow_1_stage_def_5 = models.ApprovalWorkflowStageDefinition.objects.create(
             approval_workflow_definition=cls.approval_workflow_def_1,
-            weight=500,
+            sequence=500,
             name="Test Approval Workflow 1 Stage 5",
             min_approvers=2,
             denial_message="Stage 5 Denial Message",
@@ -137,7 +137,7 @@ class ApprovalWorkflowTestMixin:
         )
         cls.approval_workflow_1_stage_def_6 = models.ApprovalWorkflowStageDefinition.objects.create(
             approval_workflow_definition=cls.approval_workflow_def_1,
-            weight=600,
+            sequence=600,
             name="Test Approval Workflow 1 Stage 6",
             min_approvers=2,
             denial_message="Stage 6 Denial Message",
@@ -145,7 +145,7 @@ class ApprovalWorkflowTestMixin:
         )
         cls.approval_workflow_2_stage_def_1 = models.ApprovalWorkflowStageDefinition.objects.create(
             approval_workflow_definition=cls.approval_workflow_def_2,
-            weight=100,
+            sequence=100,
             name="Test Approval Workflow 2 Stage 1",
             min_approvers=2,
             denial_message="Stage 1 Denial Message",
@@ -153,7 +153,7 @@ class ApprovalWorkflowTestMixin:
         )
         cls.approval_workflow_2_stage_def_2 = models.ApprovalWorkflowStageDefinition.objects.create(
             approval_workflow_definition=cls.approval_workflow_def_2,
-            weight=200,
+            sequence=200,
             name="Test Approval Workflow 2 Stage 2",
             min_approvers=2,
             denial_message="Stage 2 Denial Message",
@@ -161,7 +161,7 @@ class ApprovalWorkflowTestMixin:
         )
         cls.approval_workflow_2_stage_def_3 = models.ApprovalWorkflowStageDefinition.objects.create(
             approval_workflow_definition=cls.approval_workflow_def_2,
-            weight=300,
+            sequence=300,
             name="Test Approval Workflow 2 Stage 3",
             min_approvers=2,
             denial_message="Stage 3 Denial Message",
@@ -232,19 +232,19 @@ class ApprovalWorkflowDefinitionAPITest(ApprovalWorkflowTestMixin, APIViewTestCa
                 "name": "Approval Workflow Definition 1",
                 "model_content_type": "extras.scheduledjob",
                 "model_constraints": {"name": "Bulk Delete Objects"},
-                "priority": 5,
+                "weight": 5,
             },
             {
                 "name": "Approval Workflow Definition 2",
                 "model_content_type": "extras.scheduledjob",
                 "model_constraints": {},
-                "priority": 6,
+                "weight": 6,
             },
             {
                 "name": "Approval Workflow Definition 3",
                 "model_content_type": "extras.scheduledjob",
                 "model_constraints": {"name": "Bulk Delete Objects"},
-                "priority": 7,
+                "weight": 7,
             },
         ]
 
@@ -271,18 +271,18 @@ class ApprovalWorkflowDefinitionManagerTest(TestCase):
             models.ApprovalWorkflowDefinition.objects.create(
                 name=f"Test Approval Workflow Definition {i}",
                 model_content_type=scheduled_job_ct,
-                priority=i,
+                weight=len(range(4)) - 1 - i,  # first with highest weight
             )
             for i in range(4)
         ]
 
     def test_find_for_model(self):
-        """Test that the workflow definition with the highest priority and no constraints is returned."""
+        """Test that the workflow definition with the highest weight and no constraints is returned."""
         self.assertEqual(
             models.ApprovalWorkflowDefinition.objects.find_for_model(self.scheduled_job),
             self.approval_workflow_defs[0],
         )
-        self.assertEqual(self.approval_workflow_defs[0].priority, 0)
+        self.assertEqual(self.approval_workflow_defs[0].weight, 3)
 
     def test_find_for_model_with_filter_match_constraints(self):
         """Test that a workflow definition with filter matching constraints is correctly returned."""
@@ -294,7 +294,7 @@ class ApprovalWorkflowDefinitionManagerTest(TestCase):
             models.ApprovalWorkflowDefinition.objects.find_for_model(self.scheduled_job),
             self.approval_workflow_defs[0],
         )
-        self.assertEqual(self.approval_workflow_defs[0].priority, 0)
+        self.assertEqual(self.approval_workflow_defs[0].weight, 3)
 
         export_job_model = models.Job.objects.get_for_class_path(ExportObjectList.class_path)
         export_scheduled_job = models.ScheduledJob.objects.create(
@@ -309,7 +309,7 @@ class ApprovalWorkflowDefinitionManagerTest(TestCase):
             models.ApprovalWorkflowDefinition.objects.find_for_model(export_scheduled_job),
             self.approval_workflow_defs[0],
         )
-        self.assertEqual(self.approval_workflow_defs[0].priority, 0)
+        self.assertEqual(self.approval_workflow_defs[0].weight, 3)
 
     def test_find_for_model_with_exact_match_constraints(self):
         """Test that a workflow definition with exact matching constraints is correctly returned."""
@@ -319,12 +319,12 @@ class ApprovalWorkflowDefinitionManagerTest(TestCase):
             models.ApprovalWorkflowDefinition.objects.find_for_model(self.scheduled_job),
             self.approval_workflow_defs[0],
         )
-        self.assertEqual(self.approval_workflow_defs[0].priority, 0)
+        self.assertEqual(self.approval_workflow_defs[0].weight, 3)
 
-    def test_find_for_model_returns_highest_priority_when_all_match(self):
+    def test_find_for_model_returns_highest_weight_when_all_match(self):
         """
         Test that when all workflow definitions match the model instance,
-        the one with the highest priority (lowest number) is returned.
+        the one with the highest weight is returned.
         """
         # Set all definitions to have matching constraints
         for definition in self.approval_workflow_defs:
@@ -335,14 +335,14 @@ class ApprovalWorkflowDefinitionManagerTest(TestCase):
             models.ApprovalWorkflowDefinition.objects.find_for_model(self.scheduled_job),
             self.approval_workflow_defs[0],
         )
-        self.assertEqual(self.approval_workflow_defs[0].priority, 0)
+        self.assertEqual(self.approval_workflow_defs[0].weight, 3)
 
     def test_find_for_model_skips_unmatched_constraints_and_returns_next_without_constraints(self):
         """
-        Test that if the highest priority workflow definition has unmatched constraints,
+        Test that if the highest weight workflow definition has unmatched constraints,
         the method skips it and returns the next one with no constraints.
         """
-        # Set constraints on the highest priority definition that do not match the instance
+        # Set constraints on the highest weight definition that do not match the instance
         self.approval_workflow_defs[0].model_constraints = {"name": "Non Matching Name"}
         self.approval_workflow_defs[0].save()
 
@@ -354,12 +354,12 @@ class ApprovalWorkflowDefinitionManagerTest(TestCase):
             models.ApprovalWorkflowDefinition.objects.find_for_model(self.scheduled_job),
             self.approval_workflow_defs[1],
         )
-        self.assertEqual(self.approval_workflow_defs[1].priority, 1)
+        self.assertEqual(self.approval_workflow_defs[1].weight, 2)
 
-    def test_find_for_model_matches_lower_priority_if_higher_fails(self):
+    def test_find_for_model_matches_lower_weight_if_higher_fails(self):
         """
-        Test that if the highest priority workflow definition's constraints don't match,
-        the next matching lower-priority definition is returned.
+        Test that if the highest weight workflow definition's constraints don't match,
+        the next matching lower-weight definition is returned.
         """
         self.approval_workflow_defs[0].model_constraints = {"name": "Non Matching Name"}
         self.approval_workflow_defs[0].save()
@@ -371,7 +371,7 @@ class ApprovalWorkflowDefinitionManagerTest(TestCase):
             models.ApprovalWorkflowDefinition.objects.find_for_model(self.scheduled_job),
             self.approval_workflow_defs[1],
         )
-        self.assertEqual(self.approval_workflow_defs[1].priority, 1)
+        self.assertEqual(self.approval_workflow_defs[1].weight, 2)
 
     def test_find_for_model_ignores_constraints_matching_different_instance(self):
         """
@@ -412,7 +412,7 @@ class ApprovalWorkflowStageDefinitionAPITest(ApprovalWorkflowTestMixin, APIViewT
         cls.create_data = [
             {
                 "approval_workflow_definition": cls.approval_workflow_def_2.pk,
-                "weight": 400,
+                "sequence": 400,
                 "name": "Test Approval Workflow 2 Stage 4 Definition",
                 "min_approvers": 3,
                 "denial_message": "Stage 4 Denial Message",
@@ -420,7 +420,7 @@ class ApprovalWorkflowStageDefinitionAPITest(ApprovalWorkflowTestMixin, APIViewT
             },
             {
                 "approval_workflow_definition": cls.approval_workflow_def_2.pk,
-                "weight": 500,
+                "sequence": 500,
                 "name": "Test Approval Workflow 2 Stage 5 Definition",
                 "min_approvers": 2,
                 "denial_message": "Stage 5 Denial Message",
@@ -428,7 +428,7 @@ class ApprovalWorkflowStageDefinitionAPITest(ApprovalWorkflowTestMixin, APIViewT
             },
             {
                 "approval_workflow_definition": cls.approval_workflow_def_2.pk,
-                "weight": 600,
+                "sequence": 600,
                 "name": "Test Approval Workflow 2 Stage 6 Definition",
                 "min_approvers": 1,
                 "denial_message": "Stage 6 Denial Message",
@@ -437,7 +437,7 @@ class ApprovalWorkflowStageDefinitionAPITest(ApprovalWorkflowTestMixin, APIViewT
         ]
 
         cls.update_data = {
-            "weight": 700,
+            "sequence": 700,
             "approval_workflow_definition": cls.approval_workflow_def_2.pk,
             "min_approvers": 4,
             "denial_message": "Updated Denial Message",
@@ -505,7 +505,7 @@ class ApprovalWorkflowTriggerAPITest(APITestCase):
         )
         models.ApprovalWorkflowStageDefinition.objects.create(
             approval_workflow_definition=self.approval_workflow_def,
-            weight=100,
+            sequence=100,
             name="Test Approval Workflow Stage 1",
             min_approvers=2,
             denial_message="Stage 1 Denial Message",

nautobot/extras/tests/test_changelog.py

@@ -1,5 +1,7 @@
+import uuid
+
 from django.contrib.contenttypes.models import ContentType
-from django.test import override_settings
+from django.test import override_settings, tag
 from django.urls import reverse
 from django.utils.html import escape
 from rest_framework import status
@@ -22,8 +24,6 @@ from nautobot.extras.models import CustomField, CustomFieldChoice, DynamicGroup,
 from nautobot.ipam.models import VLAN, VLANGroup
 from nautobot.virtualization.models import Cluster, ClusterType, VirtualMachine, VMInterface
 
-from example_app.signals import EXAMPLE_APP_CUSTOM_FIELD_DEFAULT, EXAMPLE_APP_CUSTOM_FIELD_NAME
-
 
 class ChangeLogViewTest(ModelViewTestCase):
     model = Location
@@ -234,6 +234,32 @@ class ChangeLogViewTest(ModelViewTestCase):
             self.assertContains(resp, escape('"description": "changed description2"'))
             self.assertContains(resp, escape('"description": "changed description3"'))
 
+    def test_objectchange_skips_add_conditional_prefetch(self):
+        """
+        Test that ObjectChange.objects.all() skips prefetch_related on ContentTypes without a model class.
+        """
+        self.add_permissions("extras.view_objectchange")
+
+        ct = ContentType.objects.create(app_label="nonexistent_app", model="nonexistentmodel")
+        oc = ObjectChange.objects.create(
+            changed_object_type=ct,
+            changed_object_id=1,
+            object_repr="nonexistentobject",
+            action=ObjectChangeActionChoices.ACTION_CREATE,
+            user=self.user,
+            object_data={},
+            request_id=uuid.uuid4(),
+        )
+        url = reverse("extras:objectchange_list")
+        with self.assertLogs(level="WARNING") as cm:
+            response = self.client.get(url)
+            self.assertHttpStatus(response, 200)
+            self.assertContains(response, oc.object_repr)
+            self.assertIn(
+                ("One or more ContentType entries in the database are invalid."),
+                cm.output[0],
+            )
+
 
 class ChangeLogAPITest(APITestCase):
     def setUp(self):
@@ -260,7 +286,10 @@ class ChangeLogAPITest(APITestCase):
         self.tags = Tag.objects.get_for_model(Location)
         self.statuses = Status.objects.get_for_model(Location)
 
+    @tag("example_app")
     def test_create_object(self):
+        from example_app.signals import EXAMPLE_APP_CUSTOM_FIELD_DEFAULT, EXAMPLE_APP_CUSTOM_FIELD_NAME
+
         location_type = LocationType.objects.get(name="Campus")
         data = {
             "name": "Test Location 1",
@@ -290,8 +319,11 @@ class ChangeLogAPITest(APITestCase):
         self.assertEqual(oc.object_data["tags"], sorted([self.tags[0].name, self.tags[1].name]))
         self.assertEqual(oc.user_id, self.user.pk)
 
+    @tag("example_app")
     def test_update_object(self):
         """Test PUT with changelogs."""
+        from example_app.signals import EXAMPLE_APP_CUSTOM_FIELD_DEFAULT, EXAMPLE_APP_CUSTOM_FIELD_NAME
+
         location_type = LocationType.objects.get(name="Campus")
         location = Location.objects.create(
             name="Test Location 1",
@@ -510,13 +542,35 @@ class ObjectChangeModelTest(TestCase):  # TODO: change to BaseModelTestCase once
     def setUpTestData(cls):
         cls.location_status = Status.objects.get_for_model(Location).first()
 
+    def test_m2m_fields_not_excluded(self):
+        """Ensure that m2m fields are included in object changes, even if exclude_m2m is the default in the REST API."""
+        with context_managers.web_request_context(self.user):
+            location_type = LocationType.objects.create(name="Test m2m locationtype")
+
+        with context_managers.web_request_context(self.user):
+            location_type.content_types.set(ContentType.objects.filter(app_label="dcim"))
+
+        object_changes = get_changes_for_model(location_type)
+        self.assertEqual(object_changes.count(), 2)
+
+        snapshots = object_changes.first().get_snapshots()
+        self.assertIsNotNone(snapshots["differences"]["removed"])
+        self.assertIsNotNone(snapshots["differences"]["added"])
+        self.assertIn("content_types", snapshots["differences"]["removed"])
+        self.assertIn("content_types", snapshots["differences"]["added"])
+        self.assertEqual(
+            len(snapshots["differences"]["added"]["content_types"]),
+            ContentType.objects.filter(app_label="dcim").count(),
+        )
+
     def test_opt_out(self):
         """Hidden static group associations can "opt out" of change logging."""
         dg = DynamicGroup.objects.exclude(group_type=DynamicGroupTypeChoices.TYPE_STATIC).first()
         # Force reassignment of all cached memberships:
         members = list(dg.members)
-        dg._set_members([])
-        dg._set_members(members)
+        with context_managers.web_request_context(self.user):
+            dg._set_members([])
+            dg._set_members(members)
 
         for sga in dg.static_group_associations(manager="all_objects").all():
             self.assertIsNone(get_changes_for_model(sga).first())

nautobot/extras/tests/test_customfields.py

@@ -1,11 +1,11 @@
 import json
 import logging
 
-from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ValidationError
 from django.db.models import ProtectedError, QuerySet
 from django.forms import ChoiceField, IntegerField, NumberInput
+from django.test import tag
 from django.urls import reverse
 from rest_framework import status
 
@@ -31,6 +31,7 @@ from nautobot.virtualization.models import VirtualMachine
 # TODO: this needs to be both a BaseModelTestCase (as it tests the model class) and a (views) TestCase,
 #       (due to the test_multi_select_field_value_after_bulk_update() test).
 #       At some point we should probably split this into separate classes.
+@tag("example_app")
 class CustomFieldTest(ModelTestCases.BaseModelTestCase, TestCase):
     model = CustomField
 
@@ -397,6 +398,7 @@ class CustomFieldTest(ModelTestCases.BaseModelTestCase, TestCase):
             self.assertIsInstance(filter_field.widget, NumberInput)
 
 
+@tag("example_app")
 class CustomFieldManagerTest(TestCase):
     def setUp(self):
         self.content_type = ContentType.objects.get_for_model(Location)
@@ -569,6 +571,7 @@ class ComputedFieldManagerTestCase(TestCase):
         self.assertQuerysetEqualAndNotEmpty(qs, listing)
 
 
+@tag("example_app")
 class CustomFieldDataAPITest(APITestCase):
     """
     Check that object representations in the REST API include their custom field data.
@@ -693,9 +696,8 @@ class CustomFieldDataAPITest(APITestCase):
             self.cf_json,
         ]
 
-        if "example_app" in settings.PLUGINS:
-            self.cf_plugin_field = CustomField.objects.get(key="example_app_auto_custom_field")
-            self.all_cfs.append(self.cf_plugin_field)
+        self.cf_plugin_field = CustomField.objects.get(key="example_app_auto_custom_field")
+        self.all_cfs.append(self.cf_plugin_field)
         self.statuses = Status.objects.get_for_model(Location)
 
         # Create some locations
@@ -717,8 +719,7 @@ class CustomFieldDataAPITest(APITestCase):
             self.cf_markdown.key: "### Hello world!\n\n- Item 1\n- Item 2\n- Item 3",
             self.cf_json.key: {"hello": "world"},
         }
-        if "example_app" in settings.PLUGINS:
-            self.locations[1]._custom_field_data[self.cf_plugin_field.key] = "Custom value"
+        self.locations[1]._custom_field_data[self.cf_plugin_field.key] = "Custom value"
         self.locations[1].validated_save()
         self.list_url = reverse("dcim-api:location-list")
         self.detail_url = reverse("dcim-api:location-detail", kwargs={"pk": self.locations[1].pk})
@@ -792,8 +793,7 @@ class CustomFieldDataAPITest(APITestCase):
                 self.cf_json.key: {"foo": "bar"},
             },
         }
-        if "example_app" in settings.PLUGINS:
-            data["custom_fields"]["example_app_auto_custom_field"] = "Custom value"
+        data["custom_fields"]["example_app_auto_custom_field"] = "Custom value"
         response = self.client.post(self.list_url, data, format="json", **self.header)
         self.assertHttpStatus(response, status.HTTP_201_CREATED)
 
@@ -865,9 +865,8 @@ class CustomFieldDataAPITest(APITestCase):
             self.cf_markdown.key: "### Heading",
             self.cf_json.key: {"dict1": {"dict2": {}}},
         }
-        if "example_app" in settings.PLUGINS:
-            self.cf_plugin_field = CustomField.objects.get(key="example_app_auto_custom_field")
-            custom_field_data[self.cf_plugin_field.key] = "Custom Value"
+        self.cf_plugin_field = CustomField.objects.get(key="example_app_auto_custom_field")
+        custom_field_data[self.cf_plugin_field.key] = "Custom Value"
         data = (
             {
                 "name": "Location 3",
@@ -1169,6 +1168,7 @@ class CustomFieldDataAPITest(APITestCase):
         self.assertContains(response, "Invalid choice", status_code=status.HTTP_400_BAD_REQUEST)
 
 
+@tag("example_app")
 class CustomFieldImportTest(TestCase):
     """
     Test importing object custom field data along with the object itself.
@@ -2009,20 +2009,29 @@ class CustomFieldFilterTest(TestCase):
         )
 
     def test_filter_multi_select(self):
-        self.assertQuerysetEqual(
+        self.assertQuerysetEqualAndNotEmpty(
             self.filterset({"cf_cf9": "Foo"}, self.queryset).qs,
             self.queryset.filter(_custom_field_data__cf9__contains="Foo"),
         )
-        self.assertQuerysetEqual(
+        self.assertQuerysetEqualAndNotEmpty(
             self.filterset({"cf_cf9": "Bar"}, self.queryset).qs,
             self.queryset.filter(_custom_field_data__cf9__contains="Bar"),
         )
+        self.assertQuerysetEqualAndNotEmpty(
+            self.filterset({"cf_cf9": ["Foo"]}, self.queryset).qs,
+            self.queryset.filter(_custom_field_data__cf9__contains="Foo"),
+        )
+        self.assertQuerysetEqualAndNotEmpty(
+            self.filterset({"cf_cf9": ["Bar"]}, self.queryset).qs,
+            self.queryset.filter(_custom_field_data__cf9__contains="Bar"),
+        )
         self.assertQuerysetEqualAndNotEmpty(  # https://github.com/nautobot/nautobot/issues/5009
             self.filterset({"cf_cf9": str(self.multiselect_choices[0].pk)}, self.queryset).qs,
             self.queryset.filter(_custom_field_data__cf9__contains=self.multiselect_choices[0].value),
         )
 
 
+@tag("example_app")
 class CustomFieldChoiceTest(ModelTestCases.BaseModelTestCase):
     model = CustomFieldChoice