Fixed #20098 -- Added a check for model Meta.db_table collisions.

This commit is contained in:
Sanyam Khurana 2018-12-13 01:41:50 +05:30 committed by Tim Graham
parent e626a3f993
commit 5d25804eaf
3 changed files with 91 additions and 0 deletions

View File

@ -1,5 +1,6 @@
import inspect import inspect
import types import types
from collections import defaultdict
from itertools import chain from itertools import chain
from django.apps import apps from django.apps import apps
@ -8,12 +9,15 @@ from django.core.checks import Error, Tags, register
@register(Tags.models) @register(Tags.models)
def check_all_models(app_configs=None, **kwargs): def check_all_models(app_configs=None, **kwargs):
db_table_models = defaultdict(list)
errors = [] errors = []
if app_configs is None: if app_configs is None:
models = apps.get_models() models = apps.get_models()
else: else:
models = chain.from_iterable(app_config.get_models() for app_config in app_configs) models = chain.from_iterable(app_config.get_models() for app_config in app_configs)
for model in models: for model in models:
if model._meta.managed and not model._meta.proxy:
db_table_models[model._meta.db_table].append(model._meta.label)
if not inspect.ismethod(model.check): if not inspect.ismethod(model.check):
errors.append( errors.append(
Error( Error(
@ -25,6 +29,16 @@ def check_all_models(app_configs=None, **kwargs):
) )
else: else:
errors.extend(model.check(**kwargs)) errors.extend(model.check(**kwargs))
for db_table, model_labels in db_table_models.items():
if len(model_labels) != 1:
errors.append(
Error(
"db_table '%s' is used by multiple models: %s."
% (db_table, ', '.join(db_table_models[db_table])),
obj=db_table,
id='models.E028',
)
)
return errors return errors

View File

@ -302,6 +302,8 @@ Models
* **models.E026**: The model cannot have more than one field with * **models.E026**: The model cannot have more than one field with
``primary_key=True``. ``primary_key=True``.
* **models.W027**: ``<database>`` does not support check constraints. * **models.W027**: ``<database>`` does not support check constraints.
* **models.E028**: ``db_table`` ``<db_table>`` is used by multiple models:
``<model list>``.
Security Security
-------- --------

View File

@ -0,0 +1,75 @@
from django.core import checks
from django.core.checks import Error
from django.db import models
from django.test import SimpleTestCase
from django.test.utils import (
isolate_apps, modify_settings, override_system_checks,
)
@isolate_apps('check_framework', attr_name='apps')
@override_system_checks([checks.model_checks.check_all_models])
class DuplicateDBTableTests(SimpleTestCase):
def test_collision_in_same_app(self):
class Model1(models.Model):
class Meta:
db_table = 'test_table'
class Model2(models.Model):
class Meta:
db_table = 'test_table'
self.assertEqual(checks.run_checks(app_configs=self.apps.get_app_configs()), [
Error(
"db_table 'test_table' is used by multiple models: "
"check_framework.Model1, check_framework.Model2.",
obj='test_table',
id='models.E028',
)
])
@modify_settings(INSTALLED_APPS={'append': 'basic'})
@isolate_apps('basic', 'check_framework', kwarg_name='apps')
def test_collision_across_apps(self, apps):
class Model1(models.Model):
class Meta:
app_label = 'basic'
db_table = 'test_table'
class Model2(models.Model):
class Meta:
app_label = 'check_framework'
db_table = 'test_table'
self.assertEqual(checks.run_checks(app_configs=apps.get_app_configs()), [
Error(
"db_table 'test_table' is used by multiple models: "
"basic.Model1, check_framework.Model2.",
obj='test_table',
id='models.E028',
)
])
def test_no_collision_for_unmanaged_models(self):
class Unmanaged(models.Model):
class Meta:
db_table = 'test_table'
managed = False
class Managed(models.Model):
class Meta:
db_table = 'test_table'
self.assertEqual(checks.run_checks(app_configs=self.apps.get_app_configs()), [])
def test_no_collision_for_proxy_models(self):
class Model(models.Model):
class Meta:
db_table = 'test_table'
class ProxyModel(Model):
class Meta:
proxy = True
self.assertEqual(Model._meta.db_table, ProxyModel._meta.db_table)
self.assertEqual(checks.run_checks(app_configs=self.apps.get_app_configs()), [])