123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000 |
- 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, skipUnlessDBFeature
- from django.test.utils import isolate_apps, override_settings, register_lookup
- 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")
- 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(), [])
- def test_pointing_to_composite_primary_key(self):
- class Model(models.Model):
- pk = models.CompositePrimaryKey("version", "name")
- version = models.IntegerField()
- name = models.CharField(max_length=20)
- class Meta:
- unique_together = [["pk"]]
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'unique_together' refers to a CompositePrimaryKey 'pk', but "
- "CompositePrimaryKeys are not permitted in 'unique_together'.",
- obj=Model,
- id="models.E048",
- ),
- ],
- )
- @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_pointing_to_composite_primary_key(self):
- class Model(models.Model):
- pk = models.CompositePrimaryKey("version", "name")
- version = models.IntegerField()
- name = models.CharField(max_length=20)
- class Meta:
- indexes = [models.Index(fields=["pk", "name"], name="name")]
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'indexes' refers to a CompositePrimaryKey 'pk', but "
- "CompositePrimaryKeys are not permitted in 'indexes'.",
- obj=Model,
- id="models.E048",
- ),
- ],
- )
- 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:
- indexes = [
- models.Index(
- fields=["id"],
- include=["fk_1_id", "fk_2"],
- name="name",
- ),
- ]
- self.assertEqual(Model.check(databases=self.databases), [])
- @skipUnlessDBFeature("supports_covering_indexes")
- def test_index_include_pointing_to_composite_primary_key(self):
- class Model(models.Model):
- pk = models.CompositePrimaryKey("version", "name")
- version = models.IntegerField()
- name = models.CharField(max_length=20)
- class Meta:
- indexes = [models.Index(fields=["name"], include=["pk"], name="name")]
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'indexes' refers to a CompositePrimaryKey 'pk', but "
- "CompositePrimaryKeys are not permitted in 'indexes'.",
- obj=Model,
- id="models.E048",
- ),
- ],
- )
- 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(), [])
- def test_func_index_pointing_to_composite_primary_key(self):
- class Model(models.Model):
- pk = models.CompositePrimaryKey("version", "name")
- version = models.IntegerField()
- name = models.CharField(max_length=20)
- class Meta:
- indexes = [models.Index(Abs("pk"), name="name")]
- self.assertEqual(
- Model.check(),
- [
- Error(
- "'indexes' refers to a CompositePrimaryKey 'pk', but "
- "CompositePrimaryKeys are not permitted in 'indexes'.",
- obj=Model,
- id="models.E048",
- ),
- ],
- )
- @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_diamond_mti_common_parent(self):
- class GrandParent(models.Model):
- pass
- class Parent(GrandParent):
- pass
- class Child(Parent):
- pass
- class MTICommonParentModel(Child, GrandParent):
- pass
- self.assertEqual(
- MTICommonParentModel.check(),
- [
- Error(
- "The field 'grandparent_ptr' clashes with the field "
- "'grandparent_ptr' from model 'invalid_models_tests.parent'.",
- obj=MTICommonParentModel,
- 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_inherited_overriden_property_no_clash(self):
- class Cheese:
- @property
- def filling_id(self):
- pass
- class Sandwich(Cheese, models.Model):
- filling = models.ForeignKey("self", models.CASCADE)
- self.assertEqual(Sandwich.check(), [])
- 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",
- ),
- ],
- )
- @isolate_apps("invalid_models_tests")
- class DbTableCommentTests(TestCase):
- def test_db_table_comment(self):
- class Model(models.Model):
- class Meta:
- db_table_comment = "Table comment"
- errors = Model.check(databases=self.databases)
- expected = (
- []
- if connection.features.supports_comments
- else [
- Warning(
- f"{connection.display_name} does not support comments on tables "
- f"(db_table_comment).",
- obj=Model,
- id="models.W046",
- ),
- ]
- )
- self.assertEqual(errors, expected)
- def test_db_table_comment_required_db_features(self):
- class Model(models.Model):
- class Meta:
- db_table_comment = "Table comment"
- required_db_features = {"supports_comments"}
- self.assertEqual(Model.check(databases=self.databases), [])
- 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(
- condition=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(
- condition=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",
- 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_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", condition=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",
- 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",
- ),
- ],
- )
- @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", condition=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",
- condition=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",
- condition=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", condition=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",
- condition=models.Q(
- field1__lt=models.F("parent__field1")
- + models.F("parent__field2")
- ),
- ),
- models.CheckConstraint(
- name="name2", condition=models.Q(name=Lower("parent__name"))
- ),
- models.CheckConstraint(
- name="name3",
- condition=models.Q(parent__field3=models.F("field1")),
- ),
- models.CheckConstraint(
- name="name4",
- condition=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",
- condition=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(
- condition=models.Q(id__gt=0), name="q_check"
- ),
- models.CheckConstraint(
- condition=models.ExpressionWrapper(
- models.Q(price__gt=20),
- output_field=models.BooleanField(),
- ),
- name="expression_wrapper_check",
- ),
- models.CheckConstraint(
- condition=models.expressions.RawSQL(
- "id = 0",
- params=(),
- output_field=models.BooleanField(),
- ),
- name="raw_sql_check",
- ),
- models.CheckConstraint(
- condition=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)
- @skipUnlessDBFeature("supports_table_check_constraints")
- def test_check_constraint_pointing_to_composite_primary_key(self):
- class Model(models.Model):
- pk = models.CompositePrimaryKey("version", "name")
- version = models.IntegerField()
- name = models.CharField(max_length=20)
- class Meta:
- constraints = [
- models.CheckConstraint(
- name="name",
- condition=models.Q(pk__gt=(7, "focal")),
- ),
- ]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to a CompositePrimaryKey 'pk', but "
- "CompositePrimaryKeys are not permitted in 'constraints'.",
- obj=Model,
- id="models.E048",
- ),
- ],
- )
- 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_pointing_to_composite_primary_key(self):
- class Model(models.Model):
- pk = models.CompositePrimaryKey("version", "name")
- version = models.IntegerField()
- name = models.CharField(max_length=20)
- class Meta:
- constraints = [models.UniqueConstraint(fields=["pk"], name="name")]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to a CompositePrimaryKey 'pk', but "
- "CompositePrimaryKeys are not permitted in 'constraints'.",
- obj=Model,
- id="models.E048",
- ),
- ],
- )
- 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), [])
- @skipUnlessDBFeature("supports_covering_indexes")
- def test_unique_constraint_include_pointing_to_composite_primary_key(self):
- class Model(models.Model):
- pk = models.CompositePrimaryKey("version", "name")
- version = models.IntegerField()
- name = models.CharField(max_length=20)
- class Meta:
- constraints = [
- models.UniqueConstraint(
- fields=["version"],
- include=["pk"],
- name="name",
- ),
- ]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to a CompositePrimaryKey 'pk', but "
- "CompositePrimaryKeys are not permitted in 'constraints'.",
- obj=Model,
- id="models.E048",
- ),
- ],
- )
- 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), [])
- def test_unique_constraint_nulls_distinct(self):
- class Model(models.Model):
- name = models.CharField(max_length=10)
- class Meta:
- constraints = [
- models.UniqueConstraint(
- fields=["name"],
- name="name_uq_distinct_null",
- nulls_distinct=True,
- ),
- ]
- warn = Warning(
- f"{connection.display_name} does not support unique constraints with nulls "
- "distinct.",
- hint=(
- "A constraint won't be created. Silence this warning if you don't care "
- "about it."
- ),
- obj=Model,
- id="models.W047",
- )
- expected = (
- []
- if connection.features.supports_nulls_distinct_unique_constraints
- else [warn]
- )
- self.assertEqual(Model.check(databases=self.databases), expected)
- def test_unique_constraint_nulls_distinct_required_db_features(self):
- class Model(models.Model):
- name = models.CharField(max_length=10)
- class Meta:
- constraints = [
- models.UniqueConstraint(
- fields=["name"],
- name="name_uq_distinct_null",
- nulls_distinct=True,
- ),
- ]
- required_db_features = {"supports_nulls_distinct_unique_constraints"}
- 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), [])
- @skipUnlessDBFeature("supports_expression_indexes")
- def test_func_unique_constraint_pointing_composite_primary_key(self):
- class Model(models.Model):
- pk = models.CompositePrimaryKey("version", "name")
- version = models.IntegerField()
- name = models.CharField(max_length=20)
- class Meta:
- constraints = [models.UniqueConstraint(Abs("pk"), name="name")]
- self.assertEqual(
- Model.check(databases=self.databases),
- [
- Error(
- "'constraints' refers to a CompositePrimaryKey 'pk', but "
- "CompositePrimaryKeys are not permitted in 'constraints'.",
- obj=Model,
- id="models.E048",
- ),
- ],
- )
|