nautobot 1.6.26__py3-none-any.whl → 1.6.27__py3-none-any.whl

nautobot/core/management/commands/pre_migrate.py

@@ -7,6 +7,7 @@ from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ValidationError
 from django.core.management.base import BaseCommand, CommandError
 from django.db import models
+from django.db.models.fields.json import KeyTransform
 
 from nautobot.circuits.models import Circuit
 from nautobot.dcim.models import (
@@ -376,42 +377,61 @@ def check_permissions_constraints(command):
                 continue
 
             for lookup in qs._query.where.children:
-                related_model = lookup.lhs.target.related_model or lookup.lhs.target.model
-
-                if related_model in replaced_models:
-                    cls = f"{related_model.__module__}.{related_model.__name__}"
-                    warnings.append(
-                        f"ObjectPermission '{perm}' (id: {perm.id}) has a constraint that references "
-                        f"a model ({cls}) that will be migrated to a new model by the Nautobot 2.0 migration.\n"
-                        + json.dumps(perm.constraints, indent=4)
-                    )
-
-                if related_model in field_change_models:
-                    field_name = lookup.lhs.field.name
-                    if field_name in field_change_models[related_model]:
+                lhs = lookup.lhs
+
+                # Check if the left-hand side (lhs) of the lookup is a KeyTransform.
+                # KeyTransform is used for accessing nested keys in JSON fields.
+                if isinstance(lhs, KeyTransform):
+                    # If lhs is a KeyTransform, it means we're dealing with a JSON field lookup usually a CustomField.
+                    # `lhs.source_expressions` returns a list of `Col` objects representing the columns involved in the lookup.
+                    cols = lhs.source_expressions
+                    # - `col.field.name` gives the base field name (_custom_field_data).
+                    # - `lhs.key_name` provides the specific custom field name (test_custom_field).
+                    # Construct the field name by combining these with a double underscore.
+                    suffix = f"__{lhs.key_name}"
+                else:
+                    # If lhs is not a KeyTransform, it is a direct column reference.
+                    # Wrap lhs in a list to handle it uniformly in the next step.
+                    cols = [lhs]
+                    suffix = ""
+
+                for col in cols:
+                    field_name = f"{col.field.name}{suffix}"
+                    related_model = col.target.related_model or col.target.model
+
+                    if related_model in replaced_models:
                         cls = f"{related_model.__module__}.{related_model.__name__}"
                         warnings.append(
                             f"ObjectPermission '{perm}' (id: {perm.id}) has a constraint that references "
-                            f"a model field ({cls}.{field_name}) that may be changed by the Nautobot 2.0 migration.\n"
+                            f"a model ({cls}) that will be migrated to a new model by the Nautobot 2.0 migration.\n"
                             + json.dumps(perm.constraints, indent=4)
                         )
 
-                if lookup.lhs.field.name == "slug" and related_model is not GitRepository:
-                    warnings.append(
-                        f"ObjectPermission '{perm}' (id: {perm.id}) has a constraint that references "
-                        f"a 'slug' field that will be deleted by the Nautobot 2.0 migration.\n"
-                        + json.dumps(perm.constraints, indent=4)
-                    )
+                    if related_model in field_change_models:
+                        if col.field.name in field_change_models[related_model]:
+                            cls = f"{related_model.__module__}.{related_model.__name__}"
+                            warnings.append(
+                                f"ObjectPermission '{perm}' (id: {perm.id}) has a constraint that references "
+                                f"a model field ({cls}.{field_name}) that may be changed by the Nautobot 2.0 migration.\n"
+                                + json.dumps(perm.constraints, indent=4)
+                            )
 
-                if related_model in pk_change_models:
-                    if isinstance(lookup.lhs.target, (models.fields.related.RelatedField, models.fields.UUIDField)):
-                        cls = f"{related_model.__module__}.{related_model.__name__}"
+                    if field_name == "slug" and related_model is not GitRepository:
                         warnings.append(
                             f"ObjectPermission '{perm}' (id: {perm.id}) has a constraint that references "
-                            f"an object ({cls}) that may have its primary key changed by the Nautobot 2.0 migration.\n"
+                            f"a 'slug' field that will be deleted by the Nautobot 2.0 migration.\n"
                             + json.dumps(perm.constraints, indent=4)
                         )
 
+                    if related_model in pk_change_models:
+                        if isinstance(col.target, (models.fields.related.RelatedField, models.fields.UUIDField)):
+                            cls = f"{related_model.__module__}.{related_model.__name__}"
+                            warnings.append(
+                                f"ObjectPermission '{perm}' (id: {perm.id}) has a constraint that references "
+                                f"an object ({cls}) that may have its primary key changed by the Nautobot 2.0 migration.\n"
+                                + json.dumps(perm.constraints, indent=4)
+                            )
+
     if warnings:
         msg = """
 One or more permission constraints may be affected by the Nautobot 2.0 migration.

nautobot/core/tests/test_commands.py

@@ -5,6 +5,11 @@ from django.core.management import call_command
 from django.core.management.base import CommandError
 from django.contrib.contenttypes.models import ContentType
 
+from nautobot.dcim.models.devices import Device
+from nautobot.dcim.models.sites import Site
+from nautobot.extras.choices import CustomFieldTypeChoices
+from nautobot.extras.models.customfields import CustomField
+from nautobot.users.models import ObjectPermission
 from nautobot.utilities.testing import TestCase
 from nautobot.dcim.models import VirtualChassis
 from nautobot.extras.datasources.registry import get_datasource_contents
@@ -25,6 +30,17 @@ class PreMigrateCommandTest(TestCase):
         )
         self.git_repo.save(trigger_resync=False)
 
+        # Adding this test data to assert that https://github.com/nautobot/nautobot/issues/6081 is fixed
+        ct = ContentType.objects.get_for_model(GitRepository)
+        custom_field = CustomField.objects.create(type=CustomFieldTypeChoices.TYPE_TEXT, name="test_custom_field")
+        custom_field.content_types.add(ct)
+        self.obj_perm = ObjectPermission.objects.create(
+            name="Test permission",
+            constraints={"_custom_field_data__test_custom_field__in": ["test-1", "test-2"]},
+            actions=["view"],
+        )
+        self.obj_perm.object_types.add(ct)
+
     def run_command(self, *args):
         out = StringIO()
         err = StringIO()
@@ -42,6 +58,8 @@ class PreMigrateCommandTest(TestCase):
         out, err = self.run_command()
 
         self.assertIn("All pre-migration checks passed.", out)
+        # Assert Permission constrain warning not logged
+        self.assertNotIn(f"ObjectPermission '{self.obj_perm.name}'", out)
         self.assertEqual("", err)
 
     def test_configcontext_failure(self):
@@ -80,3 +98,22 @@ class PreMigrateCommandTest(TestCase):
 
         with self.assertRaises(CommandError):
             self.run_command()
+
+    def test_permission_constraints_failure(self):
+        """Test permission constraints logs warning when needed for CustomField."""
+        device_ct = ContentType.objects.get_for_model(Device)
+        site_ct = ContentType.objects.get_for_model(Site)
+        custom_field = CustomField.objects.create(type=CustomFieldTypeChoices.TYPE_TEXT, name="custom_field")
+        custom_field.content_types.add(site_ct)
+        obj_perm = ObjectPermission.objects.create(
+            name="Test permission 2",
+            constraints={"site___custom_field_data__custom_field__in": ["test-1", "test-2"]},
+            actions=["view"],
+        )
+        obj_perm.object_types.add(device_ct)
+
+        out, _ = self.run_command()
+        self.assertIn(
+            f"ObjectPermission 'Test permission 2' (id: {obj_perm.pk}) has a constraint that references a model (nautobot.dcim.models.sites.Site) that will be migrated to a new model by the Nautobot 2.0 migration.",
+            out,
+        )