[5.1.x] Fixed #35625 -- Fixed a crash when adding a field with db_default and check constraint.

This is the exact same issue as refs #30408 but for creating a model with a
constraint containing % escapes instead of column addition. All of these issues
stem from a lack of SQL and parameters separation from the BaseConstraint DDL
generating methods preventing them from being mixed with other parts of the
schema alteration logic that do make use of parametrization on some backends
(e.g. Postgres, MySQL for DEFAULT).

Prior to the addition of Field.db_default and GeneratedField in 5.0
parametrization of DDL was never exercised on model creation so this is
effectively a bug with db_default as the GeneratedField case was addressed by
refs #35336.

Thanks Julien Chaumont for the report and Mariusz Felisiak for the review.

Backport of f359990e49 from main.
This commit is contained in:
Simon Charette 2024-07-23 00:33:31 -04:00 committed by Sarah Boyce
parent 249f2fd423
commit d8116bf7f5
3 changed files with 83 additions and 8 deletions

View File

@ -164,7 +164,7 @@ class BaseDatabaseSchemaEditor:
def __exit__(self, exc_type, exc_value, traceback): def __exit__(self, exc_type, exc_value, traceback):
if exc_type is None: if exc_type is None:
for sql in self.deferred_sql: for sql in self.deferred_sql:
self.execute(sql) self.execute(sql, None)
if self.atomic_migration: if self.atomic_migration:
self.atomic.__exit__(exc_type, exc_value, traceback) self.atomic.__exit__(exc_type, exc_value, traceback)
@ -265,16 +265,29 @@ class BaseDatabaseSchemaEditor:
) )
if autoinc_sql: if autoinc_sql:
self.deferred_sql.extend(autoinc_sql) self.deferred_sql.extend(autoinc_sql)
constraints = [ # The BaseConstraint DDL creation methods such as constraint_sql(),
constraint.constraint_sql(model, self) # create_sql(), and delete_sql(), were not designed in a way that
for constraint in model._meta.constraints # separate SQL from parameters which make their generated SQL unfit to
] # be used in a context where parametrization is delegated to the
# backend.
constraint_sqls = []
if params:
# If parameters are present (e.g. a DEFAULT clause on backends that
# allow parametrization) defer constraint creation so they are not
# mixed with SQL meant to be parametrized.
for constraint in model._meta.constraints:
self.deferred_sql.append(constraint.create_sql(model, self))
else:
constraint_sqls.extend(
constraint.constraint_sql(model, self)
for constraint in model._meta.constraints
)
sql = self.sql_create_table % { sql = self.sql_create_table % {
"table": self.quote_name(model._meta.db_table), "table": self.quote_name(model._meta.db_table),
"definition": ", ".join( "definition": ", ".join(
str(constraint) str(statement)
for constraint in (*column_sqls, *constraints) for statement in (*column_sqls, *constraint_sqls)
if constraint if statement
), ),
} }
if model._meta.db_tablespace: if model._meta.db_tablespace:

View File

@ -15,3 +15,7 @@ Bugfixes
* Fixed a regression in Django 5.0 where ``ModelAdmin.action_checkbox`` could * Fixed a regression in Django 5.0 where ``ModelAdmin.action_checkbox`` could
break the admin changelist HTML page when rendering a model instance with a break the admin changelist HTML page when rendering a model instance with a
``__html__`` method (:ticket:`35606`). ``__html__`` method (:ticket:`35606`).
* Fixed a crash when creating a model with a ``Field.db_default`` and a
``Meta.constraints`` constraint composed of ``__endswith``, ``__startswith``,
or ``__contains`` lookups (:ticket:`35625`).

View File

@ -4107,6 +4107,64 @@ class OperationTests(OperationTestBase):
definition[2], {"model_name": "Pony", "constraint": gt_constraint} definition[2], {"model_name": "Pony", "constraint": gt_constraint}
) )
@skipUnlessDBFeature("supports_table_check_constraints")
def test_create_model_constraint_percent_escaping(self):
app_label = "add_constraint_string_quoting"
from_state = ProjectState()
checks = [
# "%" generated in startswith lookup should be escaped in a way
# that is considered a leading wildcard.
(
models.Q(name__startswith="Albert"),
{"name": "Alberta"},
{"name": "Artur"},
),
# Literal "%" should be escaped in a way that is not a considered a
# wildcard.
(models.Q(rebate__endswith="%"), {"rebate": "10%"}, {"rebate": "10%$"}),
# Right-hand-side baked "%" literals should not be used for
# parameters interpolation.
(
~models.Q(surname__startswith=models.F("name")),
{"name": "Albert"},
{"name": "Albert", "surname": "Alberto"},
),
# Exact matches against "%" literals should also be supported.
(
models.Q(name="%"),
{"name": "%"},
{"name": "Albert"},
),
]
for check, valid, invalid in checks:
with self.subTest(condition=check, valid=valid, invalid=invalid):
constraint = models.CheckConstraint(condition=check, name="constraint")
operation = migrations.CreateModel(
"Author",
fields=[
("id", models.AutoField(primary_key=True)),
("name", models.CharField(max_length=100)),
("surname", models.CharField(max_length=100, db_default="")),
("rebate", models.CharField(max_length=100)),
],
options={"constraints": [constraint]},
)
to_state = from_state.clone()
operation.state_forwards(app_label, to_state)
with connection.schema_editor() as editor:
operation.database_forwards(app_label, editor, from_state, to_state)
Author = to_state.apps.get_model(app_label, "Author")
try:
with transaction.atomic():
Author.objects.create(**valid).delete()
with self.assertRaises(IntegrityError), transaction.atomic():
Author.objects.create(**invalid)
finally:
with connection.schema_editor() as editor:
migrations.DeleteModel("Author").database_forwards(
app_label, editor, to_state, from_state
)
@skipUnlessDBFeature("supports_table_check_constraints") @skipUnlessDBFeature("supports_table_check_constraints")
def test_add_constraint_percent_escaping(self): def test_add_constraint_percent_escaping(self):
app_label = "add_constraint_string_quoting" app_label = "add_constraint_string_quoting"