1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815 |
- import unittest
- from django.core.checks import Error, Warning
- from django.core.checks.model_checks import _check_lazy_references
- from django.db import connection, connections, models
- from django.db.models.functions import Abs, Lower, Round
- from django.db.models.signals import post_init
- from django.test import SimpleTestCase, TestCase, ignore_warnings, skipUnlessDBFeature
- from django.test.utils import isolate_apps, override_settings, register_lookup
- from django.utils.deprecation import RemovedInDjango51Warning
- class EmptyRouter:
- pass
- def get_max_column_name_length():
- allowed_len = None
- db_alias = None
- for db in ("default", "other"):
- connection = connections[db]
- max_name_length = connection.ops.max_name_length()
- if max_name_length is not None and not connection.features.truncates_names:
- if allowed_len is None or max_name_length < allowed_len:
- allowed_len = max_name_length
- db_alias = db
- return (allowed_len, db_alias)
- @isolate_apps("invalid_models_tests")
- @ignore_warnings(category=RemovedInDjango51Warning)
- class IndexTogetherTests(SimpleTestCase):
- def test_non_iterable(self):
- class Model(models.Model):
- class Meta:
- index_together = 42
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'index_together' must be a list or tuple.",
- obj=Model,
- id="models.E008",
- ),
- ],
- )
- def test_non_list(self):
- class Model(models.Model):
- class Meta:
- index_together = "not-a-list"
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'index_together' must be a list or tuple.",
- obj=Model,
- id="models.E008",
- ),
- ],
- )
- def test_list_containing_non_iterable(self):
- class Model(models.Model):
- class Meta:
- index_together = [("a", "b"), 42]
- self.assertEqual(
- Model.check(),
- [
- Error(
- "All 'index_together' elements must be lists or tuples.",
- obj=Model,
- id="models.E009",
- ),
- ],
- )
- def test_pointing_to_missing_field(self):
- class Model(models.Model):
- class Meta:
- index_together = [["missing_field"]]
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'index_together' refers to the nonexistent field 'missing_field'.",
- obj=Model,
- id="models.E012",
- ),
- ],
- )
- def test_pointing_to_non_local_field(self):
- class Foo(models.Model):
- field1 = models.IntegerField()
- class Bar(Foo):
- field2 = models.IntegerField()
- class Meta:
- index_together = [["field2", "field1"]]
- self.assertEqual(
- Bar.check(),
- [
- Error(
- "'index_together' refers to field 'field1' which is not "
- "local to model 'Bar'.",
- hint="This issue may be caused by multi-table inheritance.",
- obj=Bar,
- id="models.E016",
- ),
- ],
- )
- def test_pointing_to_m2m_field(self):
- class Model(models.Model):
- m2m = models.ManyToManyField("self")
- class Meta:
- index_together = [["m2m"]]
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'index_together' refers to a ManyToManyField 'm2m', but "
- "ManyToManyFields are not permitted in 'index_together'.",
- obj=Model,
- id="models.E013",
- ),
- ],
- )
- def test_pointing_to_fk(self):
- class Foo(models.Model):
- pass
- class Bar(models.Model):
- foo_1 = models.ForeignKey(
- Foo, on_delete=models.CASCADE, related_name="bar_1"
- )
- foo_2 = models.ForeignKey(
- Foo, on_delete=models.CASCADE, related_name="bar_2"
- )
- class Meta:
- index_together = [["foo_1_id", "foo_2"]]
- self.assertEqual(Bar.check(), [])
- # unique_together tests are very similar to index_together tests.
- @isolate_apps("invalid_models_tests")
- class UniqueTogetherTests(SimpleTestCase):
- def test_non_iterable(self):
- class Model(models.Model):
- class Meta:
- unique_together = 42
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'unique_together' must be a list or tuple.",
- obj=Model,
- id="models.E010",
- ),
- ],
- )
- def test_list_containing_non_iterable(self):
- class Model(models.Model):
- one = models.IntegerField()
- two = models.IntegerField()
- class Meta:
- unique_together = [("a", "b"), 42]
- self.assertEqual(
- Model.check(),
- [
- Error(
- "All 'unique_together' elements must be lists or tuples.",
- obj=Model,
- id="models.E011",
- ),
- ],
- )
- def test_non_list(self):
- class Model(models.Model):
- class Meta:
- unique_together = "not-a-list"
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'unique_together' must be a list or tuple.",
- obj=Model,
- id="models.E010",
- ),
- ],
- )
- def test_valid_model(self):
- class Model(models.Model):
- one = models.IntegerField()
- two = models.IntegerField()
- class Meta:
- # unique_together can be a simple tuple
- unique_together = ("one", "two")
- self.assertEqual(Model.check(), [])
- def test_pointing_to_missing_field(self):
- class Model(models.Model):
- class Meta:
- unique_together = [["missing_field"]]
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'unique_together' refers to the nonexistent field "
- "'missing_field'.",
- obj=Model,
- id="models.E012",
- ),
- ],
- )
- def test_pointing_to_m2m(self):
- class Model(models.Model):
- m2m = models.ManyToManyField("self")
- class Meta:
- unique_together = [["m2m"]]
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'unique_together' refers to a ManyToManyField 'm2m', but "
- "ManyToManyFields are not permitted in 'unique_together'.",
- obj=Model,
- id="models.E013",
- ),
- ],
- )
- def test_pointing_to_fk(self):
- class Foo(models.Model):
- pass
- class Bar(models.Model):
- foo_1 = models.ForeignKey(
- Foo, on_delete=models.CASCADE, related_name="bar_1"
- )
- foo_2 = models.ForeignKey(
- Foo, on_delete=models.CASCADE, related_name="bar_2"
- )
- class Meta:
- unique_together = [["foo_1_id", "foo_2"]]
- self.assertEqual(Bar.check(), [])
- @isolate_apps("invalid_models_tests")
- class IndexesTests(TestCase):
- def test_pointing_to_missing_field(self):
- class Model(models.Model):
- class Meta:
- indexes = [models.Index(fields=["missing_field"], name="name")]
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'indexes' refers to the nonexistent field 'missing_field'.",
- obj=Model,
- id="models.E012",
- ),
- ],
- )
- def test_pointing_to_m2m_field(self):
- class Model(models.Model):
- m2m = models.ManyToManyField("self")
- class Meta:
- indexes = [models.Index(fields=["m2m"], name="name")]
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'indexes' refers to a ManyToManyField 'm2m', but "
- "ManyToManyFields are not permitted in 'indexes'.",
- obj=Model,
- id="models.E013",
- ),
- ],
- )
- def test_pointing_to_non_local_field(self):
- class Foo(models.Model):
- field1 = models.IntegerField()
- class Bar(Foo):
- field2 = models.IntegerField()
- class Meta:
- indexes = [models.Index(fields=["field2", "field1"], name="name")]
- self.assertEqual(
- Bar.check(),
- [
- Error(
- "'indexes' refers to field 'field1' which is not local to "
- "model 'Bar'.",
- hint="This issue may be caused by multi-table inheritance.",
- obj=Bar,
- id="models.E016",
- ),
- ],
- )
- def test_pointing_to_fk(self):
- class Foo(models.Model):
- pass
- class Bar(models.Model):
- foo_1 = models.ForeignKey(
- Foo, on_delete=models.CASCADE, related_name="bar_1"
- )
- foo_2 = models.ForeignKey(
- Foo, on_delete=models.CASCADE, related_name="bar_2"
- )
- class Meta:
- indexes = [
- models.Index(fields=["foo_1_id", "foo_2"], name="index_name")
- ]
- self.assertEqual(Bar.check(), [])
- def test_name_constraints(self):
- class Model(models.Model):
- class Meta:
- indexes = [
- models.Index(fields=["id"], name="_index_name"),
- models.Index(fields=["id"], name="5index_name"),
- ]
- self.assertEqual(
- Model.check(),
- [
- Error(
- "The index name '%sindex_name' cannot start with an "
- "underscore or a number." % prefix,
- obj=Model,
- id="models.E033",
- )
- for prefix in ("_", "5")
- ],
- )
- def test_max_name_length(self):
- index_name = "x" * 31
- class Model(models.Model):
- class Meta:
- indexes = [models.Index(fields=["id"], name=index_name)]
- self.assertEqual(
- Model.check(),
- [
- Error(
- "The index name '%s' cannot be longer than 30 characters."
- % index_name,
- obj=Model,
- id="models.E034",
- ),
- ],
- )
- def test_index_with_condition(self):
- class Model(models.Model):
- age = models.IntegerField()
- class Meta:
- indexes = [
- models.Index(
- fields=["age"],
- name="index_age_gte_10",
- condition=models.Q(age__gte=10),
- ),
- ]
- errors = Model.check(databases=self.databases)
- expected = (
- []
- if connection.features.supports_partial_indexes
- else [
- Warning(
- "%s does not support indexes with conditions."
- % connection.display_name,
- hint=(
- "Conditions will be ignored. Silence this warning if you "
- "don't care about it."
- ),
- obj=Model,
- id="models.W037",
- )
- ]
- )
- self.assertEqual(errors, expected)
- def test_index_with_condition_required_db_features(self):
- class Model(models.Model):
- age = models.IntegerField()
- class Meta:
- required_db_features = {"supports_partial_indexes"}
- indexes = [
- models.Index(
- fields=["age"],
- name="index_age_gte_10",
- condition=models.Q(age__gte=10),
- ),
- ]
- self.assertEqual(Model.check(databases=self.databases), [])
- def test_index_with_include(self):
- class Model(models.Model):
- age = models.IntegerField()
- class Meta:
- indexes = [
- models.Index(
- fields=["age"],
- name="index_age_include_id",
- include=["id"],
- ),
- ]
- errors = Model.check(databases=self.databases)
- expected = (
- []
- if connection.features.supports_covering_indexes
- else [
- Warning(
- "%s does not support indexes with non-key columns."
- % connection.display_name,
- hint=(
- "Non-key columns will be ignored. Silence this warning if "
- "you don't care about it."
- ),
- obj=Model,
- id="models.W040",
- )
- ]
- )
- self.assertEqual(errors, expected)
- def test_index_with_include_required_db_features(self):
- class Model(models.Model):
- age = models.IntegerField()
- class Meta:
- required_db_features = {"supports_covering_indexes"}
- indexes = [
- models.Index(
- fields=["age"],
- name="index_age_include_id",
- include=["id"],
- ),
- ]
- self.assertEqual(Model.check(databases=self.databases), [])
- @skipUnlessDBFeature("supports_covering_indexes")
- def test_index_include_pointing_to_missing_field(self):
- class Model(models.Model):
- class Meta:
- indexes = [
- models.Index(fields=["id"], include=["missing_field"], name="name"),
- ]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'indexes' refers to the nonexistent field 'missing_field'.",
- obj=Model,
- id="models.E012",
- ),
- ],
- )
- @skipUnlessDBFeature("supports_covering_indexes")
- def test_index_include_pointing_to_m2m_field(self):
- class Model(models.Model):
- m2m = models.ManyToManyField("self")
- class Meta:
- indexes = [models.Index(fields=["id"], include=["m2m"], name="name")]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'indexes' refers to a ManyToManyField 'm2m', but "
- "ManyToManyFields are not permitted in 'indexes'.",
- obj=Model,
- id="models.E013",
- ),
- ],
- )
- @skipUnlessDBFeature("supports_covering_indexes")
- def test_index_include_pointing_to_non_local_field(self):
- class Parent(models.Model):
- field1 = models.IntegerField()
- class Child(Parent):
- field2 = models.IntegerField()
- class Meta:
- indexes = [
- models.Index(fields=["field2"], include=["field1"], name="name"),
- ]
- self.assertEqual(
- Child.check(databases=self.databases),
- [
- Error(
- "'indexes' refers to field 'field1' which is not local to "
- "model 'Child'.",
- hint="This issue may be caused by multi-table inheritance.",
- obj=Child,
- id="models.E016",
- ),
- ],
- )
- @skipUnlessDBFeature("supports_covering_indexes")
- def test_index_include_pointing_to_fk(self):
- class Target(models.Model):
- pass
- class Model(models.Model):
- fk_1 = models.ForeignKey(Target, models.CASCADE, related_name="target_1")
- fk_2 = models.ForeignKey(Target, models.CASCADE, related_name="target_2")
- class Meta:
- constraints = [
- models.Index(
- fields=["id"],
- include=["fk_1_id", "fk_2"],
- name="name",
- ),
- ]
- self.assertEqual(Model.check(databases=self.databases), [])
- def test_func_index(self):
- class Model(models.Model):
- name = models.CharField(max_length=10)
- class Meta:
- indexes = [models.Index(Lower("name"), name="index_lower_name")]
- warn = Warning(
- "%s does not support indexes on expressions." % connection.display_name,
- hint=(
- "An index won't be created. Silence this warning if you don't "
- "care about it."
- ),
- obj=Model,
- id="models.W043",
- )
- expected = [] if connection.features.supports_expression_indexes else [warn]
- self.assertEqual(Model.check(databases=self.databases), expected)
- def test_func_index_required_db_features(self):
- class Model(models.Model):
- name = models.CharField(max_length=10)
- class Meta:
- indexes = [models.Index(Lower("name"), name="index_lower_name")]
- required_db_features = {"supports_expression_indexes"}
- self.assertEqual(Model.check(databases=self.databases), [])
- def test_func_index_complex_expression_custom_lookup(self):
- class Model(models.Model):
- height = models.IntegerField()
- weight = models.IntegerField()
- class Meta:
- indexes = [
- models.Index(
- models.F("height")
- / (models.F("weight__abs") + models.Value(5)),
- name="name",
- ),
- ]
- with register_lookup(models.IntegerField, Abs):
- self.assertEqual(Model.check(), [])
- def test_func_index_pointing_to_missing_field(self):
- class Model(models.Model):
- class Meta:
- indexes = [models.Index(Lower("missing_field").desc(), name="name")]
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'indexes' refers to the nonexistent field 'missing_field'.",
- obj=Model,
- id="models.E012",
- ),
- ],
- )
- def test_func_index_pointing_to_missing_field_nested(self):
- class Model(models.Model):
- class Meta:
- indexes = [
- models.Index(Abs(Round("missing_field")), name="name"),
- ]
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'indexes' refers to the nonexistent field 'missing_field'.",
- obj=Model,
- id="models.E012",
- ),
- ],
- )
- def test_func_index_pointing_to_m2m_field(self):
- class Model(models.Model):
- m2m = models.ManyToManyField("self")
- class Meta:
- indexes = [models.Index(Lower("m2m"), name="name")]
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'indexes' refers to a ManyToManyField 'm2m', but "
- "ManyToManyFields are not permitted in 'indexes'.",
- obj=Model,
- id="models.E013",
- ),
- ],
- )
- def test_func_index_pointing_to_non_local_field(self):
- class Foo(models.Model):
- field1 = models.CharField(max_length=15)
- class Bar(Foo):
- class Meta:
- indexes = [models.Index(Lower("field1"), name="name")]
- self.assertEqual(
- Bar.check(),
- [
- Error(
- "'indexes' refers to field 'field1' which is not local to "
- "model 'Bar'.",
- hint="This issue may be caused by multi-table inheritance.",
- obj=Bar,
- id="models.E016",
- ),
- ],
- )
- def test_func_index_pointing_to_fk(self):
- class Foo(models.Model):
- pass
- class Bar(models.Model):
- foo_1 = models.ForeignKey(Foo, models.CASCADE, related_name="bar_1")
- foo_2 = models.ForeignKey(Foo, models.CASCADE, related_name="bar_2")
- class Meta:
- indexes = [
- models.Index(Lower("foo_1_id"), Lower("foo_2"), name="index_name"),
- ]
- self.assertEqual(Bar.check(), [])
- @isolate_apps("invalid_models_tests")
- class FieldNamesTests(TestCase):
- databases = {"default", "other"}
- def test_ending_with_underscore(self):
- class Model(models.Model):
- field_ = models.CharField(max_length=10)
- m2m_ = models.ManyToManyField("self")
- self.assertEqual(
- Model.check(),
- [
- Error(
- "Field names must not end with an underscore.",
- obj=Model._meta.get_field("field_"),
- id="fields.E001",
- ),
- Error(
- "Field names must not end with an underscore.",
- obj=Model._meta.get_field("m2m_"),
- id="fields.E001",
- ),
- ],
- )
- max_column_name_length, column_limit_db_alias = get_max_column_name_length()
- @unittest.skipIf(
- max_column_name_length is None,
- "The database doesn't have a column name length limit.",
- )
- def test_M2M_long_column_name(self):
- """
- #13711 -- Model check for long M2M column names when database has
- column name length limits.
- """
- # A model with very long name which will be used to set relations to.
- class VeryLongModelNamezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz(
- models.Model
- ):
- title = models.CharField(max_length=11)
- # Main model for which checks will be performed.
- class ModelWithLongField(models.Model):
- m2m_field = models.ManyToManyField(
- VeryLongModelNamezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
- related_name="rn1",
- )
- m2m_field2 = models.ManyToManyField(
- VeryLongModelNamezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
- related_name="rn2",
- through="m2msimple",
- )
- m2m_field3 = models.ManyToManyField(
- VeryLongModelNamezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
- related_name="rn3",
- through="m2mcomplex",
- )
- fk = models.ForeignKey(
- VeryLongModelNamezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
- models.CASCADE,
- related_name="rn4",
- )
- # Models used for setting `through` in M2M field.
- class m2msimple(models.Model):
- id2 = models.ForeignKey(ModelWithLongField, models.CASCADE)
- class m2mcomplex(models.Model):
- id2 = models.ForeignKey(ModelWithLongField, models.CASCADE)
- long_field_name = "a" * (self.max_column_name_length + 1)
- models.ForeignKey(
- VeryLongModelNamezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
- models.CASCADE,
- ).contribute_to_class(m2msimple, long_field_name)
- models.ForeignKey(
- VeryLongModelNamezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
- models.CASCADE,
- db_column=long_field_name,
- ).contribute_to_class(m2mcomplex, long_field_name)
- errors = ModelWithLongField.check(databases=("default", "other"))
- # First error because of M2M field set on the model with long name.
- m2m_long_name = (
- "verylongmodelnamezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz_id"
- )
- if self.max_column_name_length > len(m2m_long_name):
- # Some databases support names longer than the test name.
- expected = []
- else:
- expected = [
- Error(
- 'Autogenerated column name too long for M2M field "%s". '
- 'Maximum length is "%s" for database "%s".'
- % (
- m2m_long_name,
- self.max_column_name_length,
- self.column_limit_db_alias,
- ),
- hint="Use 'through' to create a separate model for "
- "M2M and then set column_name using 'db_column'.",
- obj=ModelWithLongField,
- id="models.E019",
- )
- ]
- # Second error because the FK specified in the `through` model
- # `m2msimple` has auto-generated name longer than allowed.
- # There will be no check errors in the other M2M because it
- # specifies db_column for the FK in `through` model even if the actual
- # name is longer than the limits of the database.
- expected.append(
- Error(
- 'Autogenerated column name too long for M2M field "%s_id". '
- 'Maximum length is "%s" for database "%s".'
- % (
- long_field_name,
- self.max_column_name_length,
- self.column_limit_db_alias,
- ),
- hint="Use 'through' to create a separate model for "
- "M2M and then set column_name using 'db_column'.",
- obj=ModelWithLongField,
- id="models.E019",
- )
- )
- self.assertEqual(errors, expected)
- # Check for long column names is called only for specified database
- # aliases.
- self.assertEqual(ModelWithLongField.check(databases=None), [])
- @unittest.skipIf(
- max_column_name_length is None,
- "The database doesn't have a column name length limit.",
- )
- def test_local_field_long_column_name(self):
- """
- #13711 -- Model check for long column names
- when database does not support long names.
- """
- class ModelWithLongField(models.Model):
- title = models.CharField(max_length=11)
- long_field_name = "a" * (self.max_column_name_length + 1)
- long_field_name2 = "b" * (self.max_column_name_length + 1)
- models.CharField(max_length=11).contribute_to_class(
- ModelWithLongField, long_field_name
- )
- models.CharField(max_length=11, db_column="vlmn").contribute_to_class(
- ModelWithLongField, long_field_name2
- )
- self.assertEqual(
- ModelWithLongField.check(databases=("default", "other")),
- [
- Error(
- 'Autogenerated column name too long for field "%s". '
- 'Maximum length is "%s" for database "%s".'
- % (
- long_field_name,
- self.max_column_name_length,
- self.column_limit_db_alias,
- ),
- hint="Set the column name manually using 'db_column'.",
- obj=ModelWithLongField,
- id="models.E018",
- )
- ],
- )
- # Check for long column names is called only for specified database
- # aliases.
- self.assertEqual(ModelWithLongField.check(databases=None), [])
- def test_including_separator(self):
- class Model(models.Model):
- some__field = models.IntegerField()
- self.assertEqual(
- Model.check(),
- [
- Error(
- 'Field names must not contain "__".',
- obj=Model._meta.get_field("some__field"),
- id="fields.E002",
- )
- ],
- )
- def test_pk(self):
- class Model(models.Model):
- pk = models.IntegerField()
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'pk' is a reserved word that cannot be used as a field name.",
- obj=Model._meta.get_field("pk"),
- id="fields.E003",
- )
- ],
- )
- def test_db_column_clash(self):
- class Model(models.Model):
- foo = models.IntegerField()
- bar = models.IntegerField(db_column="foo")
- self.assertEqual(
- Model.check(),
- [
- Error(
- "Field 'bar' has column name 'foo' that is used by "
- "another field.",
- hint="Specify a 'db_column' for the field.",
- obj=Model,
- id="models.E007",
- )
- ],
- )
- @isolate_apps("invalid_models_tests")
- class ShadowingFieldsTests(SimpleTestCase):
- def test_field_name_clash_with_child_accessor(self):
- class Parent(models.Model):
- pass
- class Child(Parent):
- child = models.CharField(max_length=100)
- self.assertEqual(
- Child.check(),
- [
- Error(
- "The field 'child' clashes with the field "
- "'child' from model 'invalid_models_tests.parent'.",
- obj=Child._meta.get_field("child"),
- id="models.E006",
- )
- ],
- )
- def test_field_name_clash_with_m2m_through(self):
- class Parent(models.Model):
- clash_id = models.IntegerField()
- class Child(Parent):
- clash = models.ForeignKey("Child", models.CASCADE)
- class Model(models.Model):
- parents = models.ManyToManyField(
- to=Parent,
- through="Through",
- through_fields=["parent", "model"],
- )
- class Through(models.Model):
- parent = models.ForeignKey(Parent, models.CASCADE)
- model = models.ForeignKey(Model, models.CASCADE)
- self.assertEqual(
- Child.check(),
- [
- Error(
- "The field 'clash' clashes with the field 'clash_id' from "
- "model 'invalid_models_tests.parent'.",
- obj=Child._meta.get_field("clash"),
- id="models.E006",
- )
- ],
- )
- def test_multiinheritance_clash(self):
- class Mother(models.Model):
- clash = models.IntegerField()
- class Father(models.Model):
- clash = models.IntegerField()
- class Child(Mother, Father):
- # Here we have two clashed: id (automatic field) and clash, because
- # both parents define these fields.
- pass
- self.assertEqual(
- Child.check(),
- [
- Error(
- "The field 'id' from parent model "
- "'invalid_models_tests.mother' clashes with the field 'id' "
- "from parent model 'invalid_models_tests.father'.",
- obj=Child,
- id="models.E005",
- ),
- Error(
- "The field 'clash' from parent model "
- "'invalid_models_tests.mother' clashes with the field 'clash' "
- "from parent model 'invalid_models_tests.father'.",
- obj=Child,
- id="models.E005",
- ),
- ],
- )
- def test_inheritance_clash(self):
- class Parent(models.Model):
- f_id = models.IntegerField()
- class Target(models.Model):
- # This field doesn't result in a clash.
- f_id = models.IntegerField()
- class Child(Parent):
- # This field clashes with parent "f_id" field.
- f = models.ForeignKey(Target, models.CASCADE)
- self.assertEqual(
- Child.check(),
- [
- Error(
- "The field 'f' clashes with the field 'f_id' "
- "from model 'invalid_models_tests.parent'.",
- obj=Child._meta.get_field("f"),
- id="models.E006",
- )
- ],
- )
- def test_multigeneration_inheritance(self):
- class GrandParent(models.Model):
- clash = models.IntegerField()
- class Parent(GrandParent):
- pass
- class Child(Parent):
- pass
- class GrandChild(Child):
- clash = models.IntegerField()
- self.assertEqual(
- GrandChild.check(),
- [
- Error(
- "The field 'clash' clashes with the field 'clash' "
- "from model 'invalid_models_tests.grandparent'.",
- obj=GrandChild._meta.get_field("clash"),
- id="models.E006",
- )
- ],
- )
- def test_id_clash(self):
- class Target(models.Model):
- pass
- class Model(models.Model):
- fk = models.ForeignKey(Target, models.CASCADE)
- fk_id = models.IntegerField()
- self.assertEqual(
- Model.check(),
- [
- Error(
- "The field 'fk_id' clashes with the field 'fk' from model "
- "'invalid_models_tests.model'.",
- obj=Model._meta.get_field("fk_id"),
- id="models.E006",
- )
- ],
- )
- @isolate_apps("invalid_models_tests")
- class OtherModelTests(SimpleTestCase):
- def test_unique_primary_key(self):
- invalid_id = models.IntegerField(primary_key=False)
- class Model(models.Model):
- id = invalid_id
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'id' can only be used as a field name if the field also sets "
- "'primary_key=True'.",
- obj=Model,
- id="models.E004",
- ),
- ],
- )
- def test_ordering_non_iterable(self):
- class Model(models.Model):
- class Meta:
- ordering = "missing_field"
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'ordering' must be a tuple or list "
- "(even if you want to order by only one field).",
- obj=Model,
- id="models.E014",
- ),
- ],
- )
- def test_just_ordering_no_errors(self):
- class Model(models.Model):
- order = models.PositiveIntegerField()
- class Meta:
- ordering = ["order"]
- self.assertEqual(Model.check(), [])
- def test_just_order_with_respect_to_no_errors(self):
- class Question(models.Model):
- pass
- class Answer(models.Model):
- question = models.ForeignKey(Question, models.CASCADE)
- class Meta:
- order_with_respect_to = "question"
- self.assertEqual(Answer.check(), [])
- def test_ordering_with_order_with_respect_to(self):
- class Question(models.Model):
- pass
- class Answer(models.Model):
- question = models.ForeignKey(Question, models.CASCADE)
- order = models.IntegerField()
- class Meta:
- order_with_respect_to = "question"
- ordering = ["order"]
- self.assertEqual(
- Answer.check(),
- [
- Error(
- "'ordering' and 'order_with_respect_to' cannot be used together.",
- obj=Answer,
- id="models.E021",
- ),
- ],
- )
- def test_non_valid(self):
- class RelationModel(models.Model):
- pass
- class Model(models.Model):
- relation = models.ManyToManyField(RelationModel)
- class Meta:
- ordering = ["relation"]
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'ordering' refers to the nonexistent field, related field, "
- "or lookup 'relation'.",
- obj=Model,
- id="models.E015",
- ),
- ],
- )
- def test_ordering_pointing_to_missing_field(self):
- class Model(models.Model):
- class Meta:
- ordering = ("missing_field",)
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'ordering' refers to the nonexistent field, related field, "
- "or lookup 'missing_field'.",
- obj=Model,
- id="models.E015",
- )
- ],
- )
- def test_ordering_pointing_to_missing_foreignkey_field(self):
- class Model(models.Model):
- missing_fk_field = models.IntegerField()
- class Meta:
- ordering = ("missing_fk_field_id",)
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'ordering' refers to the nonexistent field, related field, "
- "or lookup 'missing_fk_field_id'.",
- obj=Model,
- id="models.E015",
- )
- ],
- )
- def test_ordering_pointing_to_missing_related_field(self):
- class Model(models.Model):
- test = models.IntegerField()
- class Meta:
- ordering = ("missing_related__id",)
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'ordering' refers to the nonexistent field, related field, "
- "or lookup 'missing_related__id'.",
- obj=Model,
- id="models.E015",
- )
- ],
- )
- def test_ordering_pointing_to_missing_related_model_field(self):
- class Parent(models.Model):
- pass
- class Child(models.Model):
- parent = models.ForeignKey(Parent, models.CASCADE)
- class Meta:
- ordering = ("parent__missing_field",)
- self.assertEqual(
- Child.check(),
- [
- Error(
- "'ordering' refers to the nonexistent field, related field, "
- "or lookup 'parent__missing_field'.",
- obj=Child,
- id="models.E015",
- )
- ],
- )
- def test_ordering_pointing_to_non_related_field(self):
- class Child(models.Model):
- parent = models.IntegerField()
- class Meta:
- ordering = ("parent__missing_field",)
- self.assertEqual(
- Child.check(),
- [
- Error(
- "'ordering' refers to the nonexistent field, related field, "
- "or lookup 'parent__missing_field'.",
- obj=Child,
- id="models.E015",
- )
- ],
- )
- def test_ordering_pointing_to_two_related_model_field(self):
- class Parent2(models.Model):
- pass
- class Parent1(models.Model):
- parent2 = models.ForeignKey(Parent2, models.CASCADE)
- class Child(models.Model):
- parent1 = models.ForeignKey(Parent1, models.CASCADE)
- class Meta:
- ordering = ("parent1__parent2__missing_field",)
- self.assertEqual(
- Child.check(),
- [
- Error(
- "'ordering' refers to the nonexistent field, related field, "
- "or lookup 'parent1__parent2__missing_field'.",
- obj=Child,
- id="models.E015",
- )
- ],
- )
- def test_ordering_pointing_multiple_times_to_model_fields(self):
- class Parent(models.Model):
- field1 = models.CharField(max_length=100)
- field2 = models.CharField(max_length=100)
- class Child(models.Model):
- parent = models.ForeignKey(Parent, models.CASCADE)
- class Meta:
- ordering = ("parent__field1__field2",)
- self.assertEqual(
- Child.check(),
- [
- Error(
- "'ordering' refers to the nonexistent field, related field, "
- "or lookup 'parent__field1__field2'.",
- obj=Child,
- id="models.E015",
- )
- ],
- )
- def test_ordering_allows_registered_lookups(self):
- class Model(models.Model):
- test = models.CharField(max_length=100)
- class Meta:
- ordering = ("test__lower",)
- with register_lookup(models.CharField, Lower):
- self.assertEqual(Model.check(), [])
- def test_ordering_pointing_to_lookup_not_transform(self):
- class Model(models.Model):
- test = models.CharField(max_length=100)
- class Meta:
- ordering = ("test__isnull",)
- self.assertEqual(Model.check(), [])
- def test_ordering_pointing_to_related_model_pk(self):
- class Parent(models.Model):
- pass
- class Child(models.Model):
- parent = models.ForeignKey(Parent, models.CASCADE)
- class Meta:
- ordering = ("parent__pk",)
- self.assertEqual(Child.check(), [])
- def test_ordering_pointing_to_foreignkey_field(self):
- class Parent(models.Model):
- pass
- class Child(models.Model):
- parent = models.ForeignKey(Parent, models.CASCADE)
- class Meta:
- ordering = ("parent_id",)
- self.assertFalse(Child.check())
- def test_name_beginning_with_underscore(self):
- class _Model(models.Model):
- pass
- self.assertEqual(
- _Model.check(),
- [
- Error(
- "The model name '_Model' cannot start or end with an underscore "
- "as it collides with the query lookup syntax.",
- obj=_Model,
- id="models.E023",
- )
- ],
- )
- def test_name_ending_with_underscore(self):
- class Model_(models.Model):
- pass
- self.assertEqual(
- Model_.check(),
- [
- Error(
- "The model name 'Model_' cannot start or end with an underscore "
- "as it collides with the query lookup syntax.",
- obj=Model_,
- id="models.E023",
- )
- ],
- )
- def test_name_contains_double_underscores(self):
- class Test__Model(models.Model):
- pass
- self.assertEqual(
- Test__Model.check(),
- [
- Error(
- "The model name 'Test__Model' cannot contain double underscores "
- "as it collides with the query lookup syntax.",
- obj=Test__Model,
- id="models.E024",
- )
- ],
- )
- def test_property_and_related_field_accessor_clash(self):
- class Model(models.Model):
- fk = models.ForeignKey("self", models.CASCADE)
- # Override related field accessor.
- Model.fk_id = property(lambda self: "ERROR")
- self.assertEqual(
- Model.check(),
- [
- Error(
- "The property 'fk_id' clashes with a related field accessor.",
- obj=Model,
- id="models.E025",
- )
- ],
- )
- def test_single_primary_key(self):
- class Model(models.Model):
- foo = models.IntegerField(primary_key=True)
- bar = models.IntegerField(primary_key=True)
- self.assertEqual(
- Model.check(),
- [
- Error(
- "The model cannot have more than one field with "
- "'primary_key=True'.",
- obj=Model,
- id="models.E026",
- )
- ],
- )
- @override_settings(TEST_SWAPPED_MODEL_BAD_VALUE="not-a-model")
- def test_swappable_missing_app_name(self):
- class Model(models.Model):
- class Meta:
- swappable = "TEST_SWAPPED_MODEL_BAD_VALUE"
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'TEST_SWAPPED_MODEL_BAD_VALUE' is not of the form "
- "'app_label.app_name'.",
- id="models.E001",
- ),
- ],
- )
- @override_settings(TEST_SWAPPED_MODEL_BAD_MODEL="not_an_app.Target")
- def test_swappable_missing_app(self):
- class Model(models.Model):
- class Meta:
- swappable = "TEST_SWAPPED_MODEL_BAD_MODEL"
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'TEST_SWAPPED_MODEL_BAD_MODEL' references 'not_an_app.Target', "
- "which has not been installed, or is abstract.",
- id="models.E002",
- ),
- ],
- )
- def test_two_m2m_through_same_relationship(self):
- class Person(models.Model):
- pass
- class Group(models.Model):
- primary = models.ManyToManyField(
- Person, through="Membership", related_name="primary"
- )
- secondary = models.ManyToManyField(
- Person, through="Membership", related_name="secondary"
- )
- class Membership(models.Model):
- person = models.ForeignKey(Person, models.CASCADE)
- group = models.ForeignKey(Group, models.CASCADE)
- self.assertEqual(
- Group.check(),
- [
- Error(
- "The model has two identical many-to-many relations through "
- "the intermediate model 'invalid_models_tests.Membership'.",
- obj=Group,
- id="models.E003",
- )
- ],
- )
- def test_two_m2m_through_same_model_with_different_through_fields(self):
- class Country(models.Model):
- pass
- class ShippingMethod(models.Model):
- to_countries = models.ManyToManyField(
- Country,
- through="ShippingMethodPrice",
- through_fields=("method", "to_country"),
- )
- from_countries = models.ManyToManyField(
- Country,
- through="ShippingMethodPrice",
- through_fields=("method", "from_country"),
- related_name="+",
- )
- class ShippingMethodPrice(models.Model):
- method = models.ForeignKey(ShippingMethod, models.CASCADE)
- to_country = models.ForeignKey(Country, models.CASCADE)
- from_country = models.ForeignKey(Country, models.CASCADE)
- self.assertEqual(ShippingMethod.check(), [])
- def test_onetoone_with_parent_model(self):
- class Place(models.Model):
- pass
- class ParkingLot(Place):
- other_place = models.OneToOneField(
- Place, models.CASCADE, related_name="other_parking"
- )
- self.assertEqual(ParkingLot.check(), [])
- def test_onetoone_with_explicit_parent_link_parent_model(self):
- class Place(models.Model):
- pass
- class ParkingLot(Place):
- place = models.OneToOneField(
- Place, models.CASCADE, parent_link=True, primary_key=True
- )
- other_place = models.OneToOneField(
- Place, models.CASCADE, related_name="other_parking"
- )
- self.assertEqual(ParkingLot.check(), [])
- def test_m2m_table_name_clash(self):
- class Foo(models.Model):
- bar = models.ManyToManyField("Bar", db_table="myapp_bar")
- class Meta:
- db_table = "myapp_foo"
- class Bar(models.Model):
- class Meta:
- db_table = "myapp_bar"
- self.assertEqual(
- Foo.check(),
- [
- Error(
- "The field's intermediary table 'myapp_bar' clashes with the "
- "table name of 'invalid_models_tests.Bar'.",
- obj=Foo._meta.get_field("bar"),
- id="fields.E340",
- )
- ],
- )
- @override_settings(
- DATABASE_ROUTERS=["invalid_models_tests.test_models.EmptyRouter"]
- )
- def test_m2m_table_name_clash_database_routers_installed(self):
- class Foo(models.Model):
- bar = models.ManyToManyField("Bar", db_table="myapp_bar")
- class Meta:
- db_table = "myapp_foo"
- class Bar(models.Model):
- class Meta:
- db_table = "myapp_bar"
- self.assertEqual(
- Foo.check(),
- [
- Warning(
- "The field's intermediary table 'myapp_bar' clashes with the "
- "table name of 'invalid_models_tests.Bar'.",
- obj=Foo._meta.get_field("bar"),
- hint=(
- "You have configured settings.DATABASE_ROUTERS. Verify "
- "that the table of 'invalid_models_tests.Bar' is "
- "correctly routed to a separate database."
- ),
- id="fields.W344",
- ),
- ],
- )
- def test_m2m_field_table_name_clash(self):
- class Foo(models.Model):
- pass
- class Bar(models.Model):
- foos = models.ManyToManyField(Foo, db_table="clash")
- class Baz(models.Model):
- foos = models.ManyToManyField(Foo, db_table="clash")
- self.assertEqual(
- Bar.check() + Baz.check(),
- [
- Error(
- "The field's intermediary table 'clash' clashes with the "
- "table name of 'invalid_models_tests.Baz.foos'.",
- obj=Bar._meta.get_field("foos"),
- id="fields.E340",
- ),
- Error(
- "The field's intermediary table 'clash' clashes with the "
- "table name of 'invalid_models_tests.Bar.foos'.",
- obj=Baz._meta.get_field("foos"),
- id="fields.E340",
- ),
- ],
- )
- @override_settings(
- DATABASE_ROUTERS=["invalid_models_tests.test_models.EmptyRouter"]
- )
- def test_m2m_field_table_name_clash_database_routers_installed(self):
- class Foo(models.Model):
- pass
- class Bar(models.Model):
- foos = models.ManyToManyField(Foo, db_table="clash")
- class Baz(models.Model):
- foos = models.ManyToManyField(Foo, db_table="clash")
- self.assertEqual(
- Bar.check() + Baz.check(),
- [
- Warning(
- "The field's intermediary table 'clash' clashes with the "
- "table name of 'invalid_models_tests.%s.foos'." % clashing_model,
- obj=model_cls._meta.get_field("foos"),
- hint=(
- "You have configured settings.DATABASE_ROUTERS. Verify "
- "that the table of 'invalid_models_tests.%s.foos' is "
- "correctly routed to a separate database." % clashing_model
- ),
- id="fields.W344",
- )
- for model_cls, clashing_model in [(Bar, "Baz"), (Baz, "Bar")]
- ],
- )
- def test_m2m_autogenerated_table_name_clash(self):
- class Foo(models.Model):
- class Meta:
- db_table = "bar_foos"
- class Bar(models.Model):
- # The autogenerated `db_table` will be bar_foos.
- foos = models.ManyToManyField(Foo)
- class Meta:
- db_table = "bar"
- self.assertEqual(
- Bar.check(),
- [
- Error(
- "The field's intermediary table 'bar_foos' clashes with the "
- "table name of 'invalid_models_tests.Foo'.",
- obj=Bar._meta.get_field("foos"),
- id="fields.E340",
- )
- ],
- )
- @override_settings(
- DATABASE_ROUTERS=["invalid_models_tests.test_models.EmptyRouter"]
- )
- def test_m2m_autogenerated_table_name_clash_database_routers_installed(self):
- class Foo(models.Model):
- class Meta:
- db_table = "bar_foos"
- class Bar(models.Model):
- # The autogenerated db_table is bar_foos.
- foos = models.ManyToManyField(Foo)
- class Meta:
- db_table = "bar"
- self.assertEqual(
- Bar.check(),
- [
- Warning(
- "The field's intermediary table 'bar_foos' clashes with the "
- "table name of 'invalid_models_tests.Foo'.",
- obj=Bar._meta.get_field("foos"),
- hint=(
- "You have configured settings.DATABASE_ROUTERS. Verify "
- "that the table of 'invalid_models_tests.Foo' is "
- "correctly routed to a separate database."
- ),
- id="fields.W344",
- ),
- ],
- )
- def test_m2m_unmanaged_shadow_models_not_checked(self):
- class A1(models.Model):
- pass
- class C1(models.Model):
- mm_a = models.ManyToManyField(A1, db_table="d1")
- # Unmanaged models that shadow the above models. Reused table names
- # shouldn't be flagged by any checks.
- class A2(models.Model):
- class Meta:
- managed = False
- class C2(models.Model):
- mm_a = models.ManyToManyField(A2, through="Intermediate")
- class Meta:
- managed = False
- class Intermediate(models.Model):
- a2 = models.ForeignKey(A2, models.CASCADE, db_column="a1_id")
- c2 = models.ForeignKey(C2, models.CASCADE, db_column="c1_id")
- class Meta:
- db_table = "d1"
- managed = False
- self.assertEqual(C1.check(), [])
- self.assertEqual(C2.check(), [])
- def test_m2m_to_concrete_and_proxy_allowed(self):
- class A(models.Model):
- pass
- class Through(models.Model):
- a = models.ForeignKey("A", models.CASCADE)
- c = models.ForeignKey("C", models.CASCADE)
- class ThroughProxy(Through):
- class Meta:
- proxy = True
- class C(models.Model):
- mm_a = models.ManyToManyField(A, through=Through)
- mm_aproxy = models.ManyToManyField(
- A, through=ThroughProxy, related_name="proxied_m2m"
- )
- self.assertEqual(C.check(), [])
- @isolate_apps("django.contrib.auth", kwarg_name="apps")
- def test_lazy_reference_checks(self, apps):
- class DummyModel(models.Model):
- author = models.ForeignKey("Author", models.CASCADE)
- class Meta:
- app_label = "invalid_models_tests"
- class DummyClass:
- def __call__(self, **kwargs):
- pass
- def dummy_method(self):
- pass
- def dummy_function(*args, **kwargs):
- pass
- apps.lazy_model_operation(dummy_function, ("auth", "imaginarymodel"))
- apps.lazy_model_operation(dummy_function, ("fanciful_app", "imaginarymodel"))
- post_init.connect(dummy_function, sender="missing-app.Model", apps=apps)
- post_init.connect(DummyClass(), sender="missing-app.Model", apps=apps)
- post_init.connect(
- DummyClass().dummy_method, sender="missing-app.Model", apps=apps
- )
- self.assertEqual(
- _check_lazy_references(apps),
- [
- Error(
- "%r contains a lazy reference to auth.imaginarymodel, "
- "but app 'auth' doesn't provide model 'imaginarymodel'."
- % dummy_function,
- obj=dummy_function,
- id="models.E022",
- ),
- Error(
- "%r contains a lazy reference to fanciful_app.imaginarymodel, "
- "but app 'fanciful_app' isn't installed." % dummy_function,
- obj=dummy_function,
- id="models.E022",
- ),
- Error(
- "An instance of class 'DummyClass' was connected to "
- "the 'post_init' signal with a lazy reference to the sender "
- "'missing-app.model', but app 'missing-app' isn't installed.",
- hint=None,
- obj="invalid_models_tests.test_models",
- id="signals.E001",
- ),
- Error(
- "Bound method 'DummyClass.dummy_method' was connected to the "
- "'post_init' signal with a lazy reference to the sender "
- "'missing-app.model', but app 'missing-app' isn't installed.",
- hint=None,
- obj="invalid_models_tests.test_models",
- id="signals.E001",
- ),
- Error(
- "The field invalid_models_tests.DummyModel.author was declared "
- "with a lazy reference to 'invalid_models_tests.author', but app "
- "'invalid_models_tests' isn't installed.",
- hint=None,
- obj=DummyModel.author.field,
- id="fields.E307",
- ),
- Error(
- "The function 'dummy_function' was connected to the 'post_init' "
- "signal with a lazy reference to the sender "
- "'missing-app.model', but app 'missing-app' isn't installed.",
- hint=None,
- obj="invalid_models_tests.test_models",
- id="signals.E001",
- ),
- ],
- )
- class MultipleAutoFieldsTests(TestCase):
- def test_multiple_autofields(self):
- msg = (
- "Model invalid_models_tests.MultipleAutoFields can't have more "
- "than one auto-generated field."
- )
- with self.assertRaisesMessage(ValueError, msg):
- class MultipleAutoFields(models.Model):
- auto1 = models.AutoField(primary_key=True)
- auto2 = models.AutoField(primary_key=True)
- @isolate_apps("invalid_models_tests")
- class JSONFieldTests(TestCase):
- @skipUnlessDBFeature("supports_json_field")
- def test_ordering_pointing_to_json_field_value(self):
- class Model(models.Model):
- field = models.JSONField()
- class Meta:
- ordering = ["field__value"]
- self.assertEqual(Model.check(databases=self.databases), [])
- def test_check_jsonfield(self):
- class Model(models.Model):
- field = models.JSONField()
- error = Error(
- "%s does not support JSONFields." % connection.display_name,
- obj=Model,
- id="fields.E180",
- )
- expected = [] if connection.features.supports_json_field else [error]
- self.assertEqual(Model.check(databases=self.databases), expected)
- def test_check_jsonfield_required_db_features(self):
- class Model(models.Model):
- field = models.JSONField()
- class Meta:
- required_db_features = {"supports_json_field"}
- self.assertEqual(Model.check(databases=self.databases), [])
- @isolate_apps("invalid_models_tests")
- class ConstraintsTests(TestCase):
- def test_check_constraints(self):
- class Model(models.Model):
- age = models.IntegerField()
- class Meta:
- constraints = [
- models.CheckConstraint(check=models.Q(age__gte=18), name="is_adult")
- ]
- errors = Model.check(databases=self.databases)
- warn = Warning(
- "%s does not support check constraints." % connection.display_name,
- hint=(
- "A constraint won't be created. Silence this warning if you "
- "don't care about it."
- ),
- obj=Model,
- id="models.W027",
- )
- expected = (
- [] if connection.features.supports_table_check_constraints else [warn]
- )
- self.assertCountEqual(errors, expected)
- def test_check_constraints_required_db_features(self):
- class Model(models.Model):
- age = models.IntegerField()
- class Meta:
- required_db_features = {"supports_table_check_constraints"}
- constraints = [
- models.CheckConstraint(check=models.Q(age__gte=18), name="is_adult")
- ]
- self.assertEqual(Model.check(databases=self.databases), [])
- def test_check_constraint_pointing_to_missing_field(self):
- class Model(models.Model):
- class Meta:
- required_db_features = {"supports_table_check_constraints"}
- constraints = [
- models.CheckConstraint(
- name="name",
- check=models.Q(missing_field=2),
- ),
- ]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to the nonexistent field 'missing_field'.",
- obj=Model,
- id="models.E012",
- ),
- ]
- if connection.features.supports_table_check_constraints
- else [],
- )
- @skipUnlessDBFeature("supports_table_check_constraints")
- def test_check_constraint_pointing_to_reverse_fk(self):
- class Model(models.Model):
- parent = models.ForeignKey("self", models.CASCADE, related_name="parents")
- class Meta:
- constraints = [
- models.CheckConstraint(name="name", check=models.Q(parents=3)),
- ]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to the nonexistent field 'parents'.",
- obj=Model,
- id="models.E012",
- ),
- ],
- )
- @skipUnlessDBFeature("supports_table_check_constraints")
- def test_check_constraint_pointing_to_reverse_o2o(self):
- class Model(models.Model):
- parent = models.OneToOneField("self", models.CASCADE)
- class Meta:
- constraints = [
- models.CheckConstraint(
- name="name",
- check=models.Q(model__isnull=True),
- ),
- ]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to the nonexistent field 'model'.",
- obj=Model,
- id="models.E012",
- ),
- ],
- )
- @skipUnlessDBFeature("supports_table_check_constraints")
- def test_check_constraint_pointing_to_m2m_field(self):
- class Model(models.Model):
- m2m = models.ManyToManyField("self")
- class Meta:
- constraints = [
- models.CheckConstraint(name="name", check=models.Q(m2m=2)),
- ]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to a ManyToManyField 'm2m', but "
- "ManyToManyFields are not permitted in 'constraints'.",
- obj=Model,
- id="models.E013",
- ),
- ],
- )
- @skipUnlessDBFeature("supports_table_check_constraints")
- def test_check_constraint_pointing_to_fk(self):
- class Target(models.Model):
- pass
- class Model(models.Model):
- fk_1 = models.ForeignKey(Target, models.CASCADE, related_name="target_1")
- fk_2 = models.ForeignKey(Target, models.CASCADE, related_name="target_2")
- class Meta:
- constraints = [
- models.CheckConstraint(
- name="name",
- check=models.Q(fk_1_id=2) | models.Q(fk_2=2),
- ),
- ]
- self.assertEqual(Model.check(databases=self.databases), [])
- @skipUnlessDBFeature("supports_table_check_constraints")
- def test_check_constraint_pointing_to_pk(self):
- class Model(models.Model):
- age = models.SmallIntegerField()
- class Meta:
- constraints = [
- models.CheckConstraint(
- name="name",
- check=models.Q(pk__gt=5) & models.Q(age__gt=models.F("pk")),
- ),
- ]
- self.assertEqual(Model.check(databases=self.databases), [])
- @skipUnlessDBFeature("supports_table_check_constraints")
- def test_check_constraint_pointing_to_non_local_field(self):
- class Parent(models.Model):
- field1 = models.IntegerField()
- class Child(Parent):
- pass
- class Meta:
- constraints = [
- models.CheckConstraint(name="name", check=models.Q(field1=1)),
- ]
- self.assertEqual(
- Child.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to field 'field1' which is not local to "
- "model 'Child'.",
- hint="This issue may be caused by multi-table inheritance.",
- obj=Child,
- id="models.E016",
- ),
- ],
- )
- @skipUnlessDBFeature("supports_table_check_constraints")
- def test_check_constraint_pointing_to_joined_fields(self):
- class Model(models.Model):
- name = models.CharField(max_length=10)
- field1 = models.PositiveSmallIntegerField()
- field2 = models.PositiveSmallIntegerField()
- field3 = models.PositiveSmallIntegerField()
- parent = models.ForeignKey("self", models.CASCADE)
- previous = models.OneToOneField("self", models.CASCADE, related_name="next")
- class Meta:
- constraints = [
- models.CheckConstraint(
- name="name1",
- check=models.Q(
- field1__lt=models.F("parent__field1")
- + models.F("parent__field2")
- ),
- ),
- models.CheckConstraint(
- name="name2", check=models.Q(name=Lower("parent__name"))
- ),
- models.CheckConstraint(
- name="name3", check=models.Q(parent__field3=models.F("field1"))
- ),
- models.CheckConstraint(
- name="name4",
- check=models.Q(name=Lower("previous__name")),
- ),
- ]
- joined_fields = [
- "parent__field1",
- "parent__field2",
- "parent__field3",
- "parent__name",
- "previous__name",
- ]
- errors = Model.check(databases=self.databases)
- expected_errors = [
- Error(
- "'constraints' refers to the joined field '%s'." % field_name,
- obj=Model,
- id="models.E041",
- )
- for field_name in joined_fields
- ]
- self.assertCountEqual(errors, expected_errors)
- @skipUnlessDBFeature("supports_table_check_constraints")
- def test_check_constraint_pointing_to_joined_fields_complex_check(self):
- class Model(models.Model):
- name = models.PositiveSmallIntegerField()
- field1 = models.PositiveSmallIntegerField()
- field2 = models.PositiveSmallIntegerField()
- parent = models.ForeignKey("self", models.CASCADE)
- class Meta:
- constraints = [
- models.CheckConstraint(
- name="name",
- check=models.Q(
- (
- models.Q(name="test")
- & models.Q(field1__lt=models.F("parent__field1"))
- )
- | (
- models.Q(name__startswith=Lower("parent__name"))
- & models.Q(
- field1__gte=(
- models.F("parent__field1")
- + models.F("parent__field2")
- )
- )
- )
- )
- | (models.Q(name="test1")),
- ),
- ]
- joined_fields = ["parent__field1", "parent__field2", "parent__name"]
- errors = Model.check(databases=self.databases)
- expected_errors = [
- Error(
- "'constraints' refers to the joined field '%s'." % field_name,
- obj=Model,
- id="models.E041",
- )
- for field_name in joined_fields
- ]
- self.assertCountEqual(errors, expected_errors)
- def test_check_constraint_raw_sql_check(self):
- class Model(models.Model):
- class Meta:
- required_db_features = {"supports_table_check_constraints"}
- constraints = [
- models.CheckConstraint(check=models.Q(id__gt=0), name="q_check"),
- models.CheckConstraint(
- check=models.ExpressionWrapper(
- models.Q(price__gt=20),
- output_field=models.BooleanField(),
- ),
- name="expression_wrapper_check",
- ),
- models.CheckConstraint(
- check=models.expressions.RawSQL(
- "id = 0",
- params=(),
- output_field=models.BooleanField(),
- ),
- name="raw_sql_check",
- ),
- models.CheckConstraint(
- check=models.Q(
- models.ExpressionWrapper(
- models.Q(
- models.expressions.RawSQL(
- "id = 0",
- params=(),
- output_field=models.BooleanField(),
- )
- ),
- output_field=models.BooleanField(),
- )
- ),
- name="nested_raw_sql_check",
- ),
- ]
- expected_warnings = (
- [
- Warning(
- "Check constraint 'raw_sql_check' contains RawSQL() expression and "
- "won't be validated during the model full_clean().",
- hint="Silence this warning if you don't care about it.",
- obj=Model,
- id="models.W045",
- ),
- Warning(
- "Check constraint 'nested_raw_sql_check' contains RawSQL() "
- "expression and won't be validated during the model full_clean().",
- hint="Silence this warning if you don't care about it.",
- obj=Model,
- id="models.W045",
- ),
- ]
- if connection.features.supports_table_check_constraints
- else []
- )
- self.assertEqual(Model.check(databases=self.databases), expected_warnings)
- def test_unique_constraint_with_condition(self):
- class Model(models.Model):
- age = models.IntegerField()
- class Meta:
- constraints = [
- models.UniqueConstraint(
- fields=["age"],
- name="unique_age_gte_100",
- condition=models.Q(age__gte=100),
- ),
- ]
- errors = Model.check(databases=self.databases)
- expected = (
- []
- if connection.features.supports_partial_indexes
- else [
- Warning(
- "%s does not support unique constraints with conditions."
- % connection.display_name,
- hint=(
- "A constraint won't be created. Silence this warning if "
- "you don't care about it."
- ),
- obj=Model,
- id="models.W036",
- ),
- ]
- )
- self.assertEqual(errors, expected)
- def test_unique_constraint_with_condition_required_db_features(self):
- class Model(models.Model):
- age = models.IntegerField()
- class Meta:
- required_db_features = {"supports_partial_indexes"}
- constraints = [
- models.UniqueConstraint(
- fields=["age"],
- name="unique_age_gte_100",
- condition=models.Q(age__gte=100),
- ),
- ]
- self.assertEqual(Model.check(databases=self.databases), [])
- def test_unique_constraint_condition_pointing_to_missing_field(self):
- class Model(models.Model):
- age = models.SmallIntegerField()
- class Meta:
- required_db_features = {"supports_partial_indexes"}
- constraints = [
- models.UniqueConstraint(
- name="name",
- fields=["age"],
- condition=models.Q(missing_field=2),
- ),
- ]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to the nonexistent field 'missing_field'.",
- obj=Model,
- id="models.E012",
- ),
- ]
- if connection.features.supports_partial_indexes
- else [],
- )
- def test_unique_constraint_condition_pointing_to_joined_fields(self):
- class Model(models.Model):
- age = models.SmallIntegerField()
- parent = models.ForeignKey("self", models.CASCADE)
- class Meta:
- required_db_features = {"supports_partial_indexes"}
- constraints = [
- models.UniqueConstraint(
- name="name",
- fields=["age"],
- condition=models.Q(parent__age__lt=2),
- ),
- ]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to the joined field 'parent__age__lt'.",
- obj=Model,
- id="models.E041",
- )
- ]
- if connection.features.supports_partial_indexes
- else [],
- )
- def test_unique_constraint_pointing_to_reverse_o2o(self):
- class Model(models.Model):
- parent = models.OneToOneField("self", models.CASCADE)
- class Meta:
- required_db_features = {"supports_partial_indexes"}
- constraints = [
- models.UniqueConstraint(
- fields=["parent"],
- name="name",
- condition=models.Q(model__isnull=True),
- ),
- ]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to the nonexistent field 'model'.",
- obj=Model,
- id="models.E012",
- ),
- ]
- if connection.features.supports_partial_indexes
- else [],
- )
- def test_deferrable_unique_constraint(self):
- class Model(models.Model):
- age = models.IntegerField()
- class Meta:
- constraints = [
- models.UniqueConstraint(
- fields=["age"],
- name="unique_age_deferrable",
- deferrable=models.Deferrable.DEFERRED,
- ),
- ]
- errors = Model.check(databases=self.databases)
- expected = (
- []
- if connection.features.supports_deferrable_unique_constraints
- else [
- Warning(
- "%s does not support deferrable unique constraints."
- % connection.display_name,
- hint=(
- "A constraint won't be created. Silence this warning if "
- "you don't care about it."
- ),
- obj=Model,
- id="models.W038",
- ),
- ]
- )
- self.assertEqual(errors, expected)
- def test_deferrable_unique_constraint_required_db_features(self):
- class Model(models.Model):
- age = models.IntegerField()
- class Meta:
- required_db_features = {"supports_deferrable_unique_constraints"}
- constraints = [
- models.UniqueConstraint(
- fields=["age"],
- name="unique_age_deferrable",
- deferrable=models.Deferrable.IMMEDIATE,
- ),
- ]
- self.assertEqual(Model.check(databases=self.databases), [])
- def test_unique_constraint_pointing_to_missing_field(self):
- class Model(models.Model):
- class Meta:
- constraints = [
- models.UniqueConstraint(fields=["missing_field"], name="name")
- ]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to the nonexistent field 'missing_field'.",
- obj=Model,
- id="models.E012",
- ),
- ],
- )
- def test_unique_constraint_pointing_to_m2m_field(self):
- class Model(models.Model):
- m2m = models.ManyToManyField("self")
- class Meta:
- constraints = [models.UniqueConstraint(fields=["m2m"], name="name")]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to a ManyToManyField 'm2m', but "
- "ManyToManyFields are not permitted in 'constraints'.",
- obj=Model,
- id="models.E013",
- ),
- ],
- )
- def test_unique_constraint_pointing_to_non_local_field(self):
- class Parent(models.Model):
- field1 = models.IntegerField()
- class Child(Parent):
- field2 = models.IntegerField()
- class Meta:
- constraints = [
- models.UniqueConstraint(fields=["field2", "field1"], name="name"),
- ]
- self.assertEqual(
- Child.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to field 'field1' which is not local to "
- "model 'Child'.",
- hint="This issue may be caused by multi-table inheritance.",
- obj=Child,
- id="models.E016",
- ),
- ],
- )
- def test_unique_constraint_pointing_to_fk(self):
- class Target(models.Model):
- pass
- class Model(models.Model):
- fk_1 = models.ForeignKey(Target, models.CASCADE, related_name="target_1")
- fk_2 = models.ForeignKey(Target, models.CASCADE, related_name="target_2")
- class Meta:
- constraints = [
- models.UniqueConstraint(fields=["fk_1_id", "fk_2"], name="name"),
- ]
- self.assertEqual(Model.check(databases=self.databases), [])
- def test_unique_constraint_with_include(self):
- class Model(models.Model):
- age = models.IntegerField()
- class Meta:
- constraints = [
- models.UniqueConstraint(
- fields=["age"],
- name="unique_age_include_id",
- include=["id"],
- ),
- ]
- errors = Model.check(databases=self.databases)
- expected = (
- []
- if connection.features.supports_covering_indexes
- else [
- Warning(
- "%s does not support unique constraints with non-key columns."
- % connection.display_name,
- hint=(
- "A constraint won't be created. Silence this warning if "
- "you don't care about it."
- ),
- obj=Model,
- id="models.W039",
- ),
- ]
- )
- self.assertEqual(errors, expected)
- def test_unique_constraint_with_include_required_db_features(self):
- class Model(models.Model):
- age = models.IntegerField()
- class Meta:
- required_db_features = {"supports_covering_indexes"}
- constraints = [
- models.UniqueConstraint(
- fields=["age"],
- name="unique_age_include_id",
- include=["id"],
- ),
- ]
- self.assertEqual(Model.check(databases=self.databases), [])
- @skipUnlessDBFeature("supports_covering_indexes")
- def test_unique_constraint_include_pointing_to_missing_field(self):
- class Model(models.Model):
- class Meta:
- constraints = [
- models.UniqueConstraint(
- fields=["id"],
- include=["missing_field"],
- name="name",
- ),
- ]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to the nonexistent field 'missing_field'.",
- obj=Model,
- id="models.E012",
- ),
- ],
- )
- @skipUnlessDBFeature("supports_covering_indexes")
- def test_unique_constraint_include_pointing_to_m2m_field(self):
- class Model(models.Model):
- m2m = models.ManyToManyField("self")
- class Meta:
- constraints = [
- models.UniqueConstraint(
- fields=["id"],
- include=["m2m"],
- name="name",
- ),
- ]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to a ManyToManyField 'm2m', but "
- "ManyToManyFields are not permitted in 'constraints'.",
- obj=Model,
- id="models.E013",
- ),
- ],
- )
- @skipUnlessDBFeature("supports_covering_indexes")
- def test_unique_constraint_include_pointing_to_non_local_field(self):
- class Parent(models.Model):
- field1 = models.IntegerField()
- class Child(Parent):
- field2 = models.IntegerField()
- class Meta:
- constraints = [
- models.UniqueConstraint(
- fields=["field2"],
- include=["field1"],
- name="name",
- ),
- ]
- self.assertEqual(
- Child.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to field 'field1' which is not local to "
- "model 'Child'.",
- hint="This issue may be caused by multi-table inheritance.",
- obj=Child,
- id="models.E016",
- ),
- ],
- )
- @skipUnlessDBFeature("supports_covering_indexes")
- def test_unique_constraint_include_pointing_to_fk(self):
- class Target(models.Model):
- pass
- class Model(models.Model):
- fk_1 = models.ForeignKey(Target, models.CASCADE, related_name="target_1")
- fk_2 = models.ForeignKey(Target, models.CASCADE, related_name="target_2")
- class Meta:
- constraints = [
- models.UniqueConstraint(
- fields=["id"],
- include=["fk_1_id", "fk_2"],
- name="name",
- ),
- ]
- self.assertEqual(Model.check(databases=self.databases), [])
- def test_func_unique_constraint(self):
- class Model(models.Model):
- name = models.CharField(max_length=10)
- class Meta:
- constraints = [
- models.UniqueConstraint(Lower("name"), name="lower_name_uq"),
- ]
- warn = Warning(
- "%s does not support unique constraints on expressions."
- % connection.display_name,
- hint=(
- "A constraint won't be created. Silence this warning if you "
- "don't care about it."
- ),
- obj=Model,
- id="models.W044",
- )
- expected = [] if connection.features.supports_expression_indexes else [warn]
- self.assertEqual(Model.check(databases=self.databases), expected)
- def test_func_unique_constraint_required_db_features(self):
- class Model(models.Model):
- name = models.CharField(max_length=10)
- class Meta:
- constraints = [
- models.UniqueConstraint(Lower("name"), name="lower_name_unq"),
- ]
- required_db_features = {"supports_expression_indexes"}
- self.assertEqual(Model.check(databases=self.databases), [])
- @skipUnlessDBFeature("supports_expression_indexes")
- def test_func_unique_constraint_expression_custom_lookup(self):
- class Model(models.Model):
- height = models.IntegerField()
- weight = models.IntegerField()
- class Meta:
- constraints = [
- models.UniqueConstraint(
- models.F("height")
- / (models.F("weight__abs") + models.Value(5)),
- name="name",
- ),
- ]
- with register_lookup(models.IntegerField, Abs):
- self.assertEqual(Model.check(databases=self.databases), [])
- @skipUnlessDBFeature("supports_expression_indexes")
- def test_func_unique_constraint_pointing_to_missing_field(self):
- class Model(models.Model):
- class Meta:
- constraints = [
- models.UniqueConstraint(Lower("missing_field").desc(), name="name"),
- ]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to the nonexistent field 'missing_field'.",
- obj=Model,
- id="models.E012",
- ),
- ],
- )
- @skipUnlessDBFeature("supports_expression_indexes")
- def test_func_unique_constraint_pointing_to_missing_field_nested(self):
- class Model(models.Model):
- class Meta:
- constraints = [
- models.UniqueConstraint(Abs(Round("missing_field")), name="name"),
- ]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to the nonexistent field 'missing_field'.",
- obj=Model,
- id="models.E012",
- ),
- ],
- )
- @skipUnlessDBFeature("supports_expression_indexes")
- def test_func_unique_constraint_pointing_to_m2m_field(self):
- class Model(models.Model):
- m2m = models.ManyToManyField("self")
- class Meta:
- constraints = [models.UniqueConstraint(Lower("m2m"), name="name")]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to a ManyToManyField 'm2m', but "
- "ManyToManyFields are not permitted in 'constraints'.",
- obj=Model,
- id="models.E013",
- ),
- ],
- )
- @skipUnlessDBFeature("supports_expression_indexes")
- def test_func_unique_constraint_pointing_to_non_local_field(self):
- class Foo(models.Model):
- field1 = models.CharField(max_length=15)
- class Bar(Foo):
- class Meta:
- constraints = [models.UniqueConstraint(Lower("field1"), name="name")]
- self.assertEqual(
- Bar.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to field 'field1' which is not local to "
- "model 'Bar'.",
- hint="This issue may be caused by multi-table inheritance.",
- obj=Bar,
- id="models.E016",
- ),
- ],
- )
- @skipUnlessDBFeature("supports_expression_indexes")
- def test_func_unique_constraint_pointing_to_fk(self):
- class Foo(models.Model):
- id = models.CharField(primary_key=True, max_length=255)
- class Bar(models.Model):
- foo_1 = models.ForeignKey(Foo, models.CASCADE, related_name="bar_1")
- foo_2 = models.ForeignKey(Foo, models.CASCADE, related_name="bar_2")
- class Meta:
- constraints = [
- models.UniqueConstraint(
- Lower("foo_1_id"),
- Lower("foo_2"),
- name="name",
- ),
- ]
- self.assertEqual(Bar.check(databases=self.databases), [])
|