nautobot 2.2.8__py3-none-any.whl → 2.3.0__py3-none-any.whl

nautobot/extras/tests/test_changelog.py

@@ -12,8 +12,13 @@ from nautobot.core.utils.lookup import get_changes_for_model
 from nautobot.dcim.choices import InterfaceModeChoices
 from nautobot.dcim.models import Location, LocationType
 from nautobot.extras import context_managers
-from nautobot.extras.choices import CustomFieldTypeChoices, ObjectChangeActionChoices, ObjectChangeEventContextChoices
-from nautobot.extras.models import CustomField, CustomFieldChoice, ObjectChange, Status, Tag
+from nautobot.extras.choices import (
+    CustomFieldTypeChoices,
+    DynamicGroupTypeChoices,
+    ObjectChangeActionChoices,
+    ObjectChangeEventContextChoices,
+)
+from nautobot.extras.models import CustomField, CustomFieldChoice, DynamicGroup, ObjectChange, Status, Tag
 from nautobot.ipam.models import VLAN, VLANGroup
 from nautobot.virtualization.models import Cluster, ClusterType, VirtualMachine, VMInterface
 
@@ -271,7 +276,6 @@ class ChangeLogAPITest(APITestCase):
                 {"name": self.tags[1].name},
             ],
         }
-        self.assertEqual(ObjectChange.objects.count(), 0)
         url = reverse("dcim-api:location-list")
         self.add_permissions("dcim.add_location", "extras.view_status")
 
@@ -306,7 +310,6 @@ class ChangeLogAPITest(APITestCase):
             },
             "tags": [{"name": self.tags[2].name}],
         }
-        self.assertEqual(ObjectChange.objects.count(), 0)
         self.add_permissions("dcim.change_location", "extras.view_status")
         url = reverse("dcim-api:location-detail", kwargs={"pk": location.pk})
 
@@ -340,7 +343,6 @@ class ChangeLogAPITest(APITestCase):
             "description": "new description",
         }
 
-        self.assertEqual(ObjectChange.objects.count(), 0)
         self.add_permissions("dcim.change_location", "extras.view_status")
         url = reverse("dcim-api:location-detail", kwargs={"pk": location.pk})
 
@@ -368,7 +370,6 @@ class ChangeLogAPITest(APITestCase):
         )
         location.save()
         location.tags.set(self.tags[:2])
-        self.assertEqual(ObjectChange.objects.count(), 0)
         self.add_permissions("dcim.delete_location", "extras.view_status")
         url = reverse("dcim-api:location-detail", kwargs={"pk": location.pk})
         initial_count = Location.objects.count()
@@ -425,6 +426,7 @@ class ChangeLogAPITest(APITestCase):
         resp = execute_query(gql_payload, user=self.user).to_dict()
         self.assertFalse(resp["data"].get("error"))
         self.assertIsInstance(resp["data"].get("query"), list)
+        # ObjectChangeFactory creates records in the last year only; there shouldn't be any in this filtered response.
         self.assertEqual(len(resp["data"].get("query")), 0)
 
     @override_settings(EXEMPT_VIEW_PERMISSIONS=["*"])
@@ -455,7 +457,6 @@ class ChangeLogAPITest(APITestCase):
             "status": self.statuses[0].pk,
             "location_type": location_type.pk,
         }
-        self.assertEqual(ObjectChange.objects.count(), 0)
         self.add_permissions("dcim.add_location")
         url = reverse("dcim-api:location-list")
 
@@ -491,7 +492,6 @@ class ChangeLogAPITest(APITestCase):
         )
 
         payload = {"tagged_vlans": [str(tagged_vlan.pk)], "description": "test vm interface m2m change"}
-        self.assertEqual(ObjectChange.objects.count(), 0)
         self.add_permissions("virtualization.change_vminterface", "ipam.change_vlan")
         url = reverse("virtualization-api:vminterface-detail", kwargs={"pk": vm_interface.pk})
         response = self.client.patch(url, payload, format="json", **self.header)
@@ -499,7 +499,7 @@ class ChangeLogAPITest(APITestCase):
         self.assertHttpStatus(response, status.HTTP_200_OK)
 
         oc = get_changes_for_model(vm_interface).first()
-        self.assertEqual(ObjectChange.objects.count(), 1)
+        self.assertEqual(get_changes_for_model(vm_interface).count(), 1)
         self.assertEqual(oc.user_id, self.user.pk)
         self.assertEqual(vm_interface.description, "test vm interface m2m change")
         self.assertSequenceEqual(list(vm_interface.tagged_vlans.all()), [tagged_vlan])
@@ -510,6 +510,17 @@ class ObjectChangeModelTest(TestCase):  # TODO: change to BaseModelTestCase once
     def setUpTestData(cls):
         cls.location_status = Status.objects.get_for_model(Location).first()
 
+    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)
+
+        for sga in dg.static_group_associations(manager="all_objects").all():
+            self.assertIsNone(get_changes_for_model(sga).first())
+
     def test_get_snapshots(self):
         with context_managers.web_request_context(self.user):
             location_type = LocationType.objects.get(name="Campus")

nautobot/extras/tests/test_context_managers.py

@@ -67,7 +67,7 @@ class WebRequestContextTestCase(TestCase):
             location.save()
 
         location = Location.objects.get(name="Test Location 1")
-        oc_list = get_changes_for_model(location).order_by("pk")
+        oc_list = get_changes_for_model(location).order_by("pk").filter(changed_object_id=location.id)
         self.assertEqual(len(oc_list), 1)
         self.assertEqual(oc_list[0].changed_object, location)
         self.assertEqual(oc_list[0].action, ObjectChangeActionChoices.ACTION_CREATE)
@@ -123,7 +123,7 @@ class WebRequestContextTestCase(TestCase):
             location.description = "changed"
             location.save()
 
-        oc_list = get_changes_for_model(location)
+        oc_list = get_changes_for_model(location).filter(changed_object_id=location.id)
         self.assertEqual(len(oc_list), 1)
         self.assertEqual(oc_list[0].action, ObjectChangeActionChoices.ACTION_CREATE)
         snapshots = oc_list[0].get_snapshots()
@@ -136,10 +136,12 @@ class WebRequestContextTestCase(TestCase):
         """Test that a delete followed by a create is logged as a single update"""
         location_type = LocationType.objects.get(name="Campus")
         location_status = Status.objects.get_for_model(Location).first()
+        pk_list = []
         with web_request_context(self.user):
             location = Location(name="Test Location 1", location_type=location_type, status=location_status)
             location.save()
             location_pk = location.pk
+            pk_list.append(location.pk)
         with web_request_context(self.user):
             location.delete()
             location = Location.objects.create(
@@ -149,8 +151,9 @@ class WebRequestContextTestCase(TestCase):
                 status=location_status,
                 description="changed",
             )
+            pk_list.append(location.pk)
 
-        oc_list = get_changes_for_model(location)
+        oc_list = get_changes_for_model(location).filter(changed_object_id__in=pk_list)
         self.assertEqual(len(oc_list), 2)
         self.assertEqual(oc_list[0].action, ObjectChangeActionChoices.ACTION_UPDATE)
         snapshots = oc_list[0].get_snapshots()
@@ -202,10 +205,11 @@ class WebRequestContextTransactionTestCase(TransactionTestCase):
         user = User.objects.create(username="test-user123")
         with web_request_context(user, context_detail="test_change_log_context"):
             with web_request_context(user, context_detail="test_change_log_context"):
-                Status.objects.create(name="Test Status 1")
-            Status.objects.create(name="Test Status 2")
+                status1 = Status.objects.create(name="Test Status 1")
+            status2 = Status.objects.create(name="Test Status 2")
 
-        self.assertEqual(get_changes_for_model(Status).count(), 2)
+        self.assertEqual(get_changes_for_model(status1).count(), 1)
+        self.assertEqual(get_changes_for_model(status2).count(), 1)
 
 
 class BulkEditDeleteChangeLogging(TestCase):
@@ -225,7 +229,7 @@ class BulkEditDeleteChangeLogging(TestCase):
                 location.save()
 
         location = Location.objects.get(name="Test Location 1")
-        oc_list = get_changes_for_model(location).order_by("pk")
+        oc_list = get_changes_for_model(location).order_by("pk").filter(changed_object_id=location.id)
         self.assertEqual(len(oc_list), 1)
         self.assertEqual(oc_list[0].changed_object, location)
         self.assertEqual(oc_list[0].action, ObjectChangeActionChoices.ACTION_CREATE)
@@ -269,7 +273,7 @@ class BulkEditDeleteChangeLogging(TestCase):
                 location.description = "changed"
                 location.save()
 
-        oc_list = get_changes_for_model(location)
+        oc_list = get_changes_for_model(location).filter(changed_object_id=location.id)
         self.assertEqual(len(oc_list), 1)
         self.assertEqual(oc_list[0].action, ObjectChangeActionChoices.ACTION_CREATE)
         snapshots = oc_list[0].get_snapshots()
@@ -287,13 +291,15 @@ class BulkEditDeleteChangeLogging(TestCase):
             for i in range(1, 4)
         ]
         Location.objects.bulk_create(locations)
+        pk_list = []
         with web_request_context(self.user):
             with deferred_change_logging_for_bulk_operation():
                 for location in locations:
                     location.description = "changed"
                     location.save()
+                    pk_list.append(location.id)
 
-        oc_list = get_changes_for_model(Location)
+        oc_list = get_changes_for_model(Location).filter(changed_object_id__in=pk_list)
         self.assertEqual(len(oc_list), 3)
         for oc in oc_list:
             self.assertEqual(oc.action, ObjectChangeActionChoices.ACTION_UPDATE)
@@ -314,17 +320,18 @@ class BulkEditDeleteChangeLogging(TestCase):
         )
         device_type = DeviceType.objects.create(manufacturer=manufacturer, model="test123")
         device_type.software_image_files.set([software_image_file])
+        oc_list_1 = list(get_changes_for_model(DeviceTypeToSoftwareImageFile))
         with web_request_context(self.user):
             with deferred_change_logging_for_bulk_operation():
                 device_type.software_image_files.set([])
                 device_type.save()
 
-        oc_list = get_changes_for_model(DeviceTypeToSoftwareImageFile)
-        self.assertEqual(len(oc_list), 1)
-        self.assertEqual(oc_list[0].action, ObjectChangeActionChoices.ACTION_DELETE)
-        self.assertIsNotNone(oc_list[0].changed_object_id)
-        self.assertEqual(oc_list[0].user, self.user)
-        self.assertEqual(oc_list[0].user_name, self.user.username)
+        oc_list_2 = list(get_changes_for_model(DeviceTypeToSoftwareImageFile))
+        self.assertEqual(len(oc_list_2) - len(oc_list_1), 1)
+        self.assertEqual(oc_list_2[0].action, ObjectChangeActionChoices.ACTION_DELETE)
+        self.assertIsNotNone(oc_list_2[0].changed_object_id)
+        self.assertEqual(oc_list_2[0].user, self.user)
+        self.assertEqual(oc_list_2[0].user_name, self.user.username)
 
     def test_change_log_context(self):
         location_type = LocationType.objects.get(name="Campus")

nautobot/extras/tests/test_datasources.py

@@ -549,12 +549,24 @@ class GitTest(TransactionTestCase):
 
                 # Now delete the GitRepository
                 repo_pk = self.repo.pk
+                repo_name = self.repo.name
                 self.repo.delete()
                 self.repo = None
 
                 with self.subTest("Assert Deleted GitRepo do not create a never ending JobResult record"):
                     # Bug fix test for https://github.com/nautobot/nautobot/issues/5121
-                    self.assertEqual(JobResult.objects.last().status, JobResultStatusChoices.STATUS_SUCCESS)
+                    delete_job_result = JobResult.objects.filter(name=repo_name).first()
+                    # Make sure we didn't get the wrong JobResult
+                    self.assertNotEqual(job_result, delete_job_result)
+                    self.assertEqual(
+                        delete_job_result.status,
+                        JobResultStatusChoices.STATUS_SUCCESS,
+                        (
+                            delete_job_result,
+                            delete_job_result.traceback,
+                            list(delete_job_result.job_log_entries.values_list("message", flat=True)),
+                        ),
+                    )
 
                 with self.assertRaises(ConfigContext.DoesNotExist):
                     ConfigContext.objects.get(