test_models.py 91 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806
  1. import unittest
  2. from django.core.checks import Error, Warning
  3. from django.core.checks.model_checks import _check_lazy_references
  4. from django.db import connection, connections, models
  5. from django.db.models.functions import Abs, Lower, Round
  6. from django.db.models.signals import post_init
  7. from django.test import SimpleTestCase, TestCase, skipUnlessDBFeature
  8. from django.test.utils import isolate_apps, override_settings, register_lookup
  9. class EmptyRouter:
  10. pass
  11. def get_max_column_name_length():
  12. allowed_len = None
  13. db_alias = None
  14. for db in ("default", "other"):
  15. connection = connections[db]
  16. max_name_length = connection.ops.max_name_length()
  17. if max_name_length is not None and not connection.features.truncates_names:
  18. if allowed_len is None or max_name_length < allowed_len:
  19. allowed_len = max_name_length
  20. db_alias = db
  21. return (allowed_len, db_alias)
  22. @isolate_apps("invalid_models_tests")
  23. class UniqueTogetherTests(SimpleTestCase):
  24. def test_non_iterable(self):
  25. class Model(models.Model):
  26. class Meta:
  27. unique_together = 42
  28. self.assertEqual(
  29. Model.check(),
  30. [
  31. Error(
  32. "'unique_together' must be a list or tuple.",
  33. obj=Model,
  34. id="models.E010",
  35. ),
  36. ],
  37. )
  38. def test_list_containing_non_iterable(self):
  39. class Model(models.Model):
  40. one = models.IntegerField()
  41. two = models.IntegerField()
  42. class Meta:
  43. unique_together = [("a", "b"), 42]
  44. self.assertEqual(
  45. Model.check(),
  46. [
  47. Error(
  48. "All 'unique_together' elements must be lists or tuples.",
  49. obj=Model,
  50. id="models.E011",
  51. ),
  52. ],
  53. )
  54. def test_non_list(self):
  55. class Model(models.Model):
  56. class Meta:
  57. unique_together = "not-a-list"
  58. self.assertEqual(
  59. Model.check(),
  60. [
  61. Error(
  62. "'unique_together' must be a list or tuple.",
  63. obj=Model,
  64. id="models.E010",
  65. ),
  66. ],
  67. )
  68. def test_valid_model(self):
  69. class Model(models.Model):
  70. one = models.IntegerField()
  71. two = models.IntegerField()
  72. class Meta:
  73. # unique_together can be a simple tuple
  74. unique_together = ("one", "two")
  75. self.assertEqual(Model.check(), [])
  76. def test_pointing_to_missing_field(self):
  77. class Model(models.Model):
  78. class Meta:
  79. unique_together = [["missing_field"]]
  80. self.assertEqual(
  81. Model.check(),
  82. [
  83. Error(
  84. "'unique_together' refers to the nonexistent field "
  85. "'missing_field'.",
  86. obj=Model,
  87. id="models.E012",
  88. ),
  89. ],
  90. )
  91. def test_pointing_to_m2m(self):
  92. class Model(models.Model):
  93. m2m = models.ManyToManyField("self")
  94. class Meta:
  95. unique_together = [["m2m"]]
  96. self.assertEqual(
  97. Model.check(),
  98. [
  99. Error(
  100. "'unique_together' refers to a ManyToManyField 'm2m', but "
  101. "ManyToManyFields are not permitted in 'unique_together'.",
  102. obj=Model,
  103. id="models.E013",
  104. ),
  105. ],
  106. )
  107. def test_pointing_to_fk(self):
  108. class Foo(models.Model):
  109. pass
  110. class Bar(models.Model):
  111. foo_1 = models.ForeignKey(
  112. Foo, on_delete=models.CASCADE, related_name="bar_1"
  113. )
  114. foo_2 = models.ForeignKey(
  115. Foo, on_delete=models.CASCADE, related_name="bar_2"
  116. )
  117. class Meta:
  118. unique_together = [["foo_1_id", "foo_2"]]
  119. self.assertEqual(Bar.check(), [])
  120. @isolate_apps("invalid_models_tests")
  121. class IndexesTests(TestCase):
  122. def test_pointing_to_missing_field(self):
  123. class Model(models.Model):
  124. class Meta:
  125. indexes = [models.Index(fields=["missing_field"], name="name")]
  126. self.assertEqual(
  127. Model.check(),
  128. [
  129. Error(
  130. "'indexes' refers to the nonexistent field 'missing_field'.",
  131. obj=Model,
  132. id="models.E012",
  133. ),
  134. ],
  135. )
  136. def test_pointing_to_m2m_field(self):
  137. class Model(models.Model):
  138. m2m = models.ManyToManyField("self")
  139. class Meta:
  140. indexes = [models.Index(fields=["m2m"], name="name")]
  141. self.assertEqual(
  142. Model.check(),
  143. [
  144. Error(
  145. "'indexes' refers to a ManyToManyField 'm2m', but "
  146. "ManyToManyFields are not permitted in 'indexes'.",
  147. obj=Model,
  148. id="models.E013",
  149. ),
  150. ],
  151. )
  152. def test_pointing_to_non_local_field(self):
  153. class Foo(models.Model):
  154. field1 = models.IntegerField()
  155. class Bar(Foo):
  156. field2 = models.IntegerField()
  157. class Meta:
  158. indexes = [models.Index(fields=["field2", "field1"], name="name")]
  159. self.assertEqual(
  160. Bar.check(),
  161. [
  162. Error(
  163. "'indexes' refers to field 'field1' which is not local to "
  164. "model 'Bar'.",
  165. hint="This issue may be caused by multi-table inheritance.",
  166. obj=Bar,
  167. id="models.E016",
  168. ),
  169. ],
  170. )
  171. def test_pointing_to_fk(self):
  172. class Foo(models.Model):
  173. pass
  174. class Bar(models.Model):
  175. foo_1 = models.ForeignKey(
  176. Foo, on_delete=models.CASCADE, related_name="bar_1"
  177. )
  178. foo_2 = models.ForeignKey(
  179. Foo, on_delete=models.CASCADE, related_name="bar_2"
  180. )
  181. class Meta:
  182. indexes = [
  183. models.Index(fields=["foo_1_id", "foo_2"], name="index_name")
  184. ]
  185. self.assertEqual(Bar.check(), [])
  186. def test_name_constraints(self):
  187. class Model(models.Model):
  188. class Meta:
  189. indexes = [
  190. models.Index(fields=["id"], name="_index_name"),
  191. models.Index(fields=["id"], name="5index_name"),
  192. ]
  193. self.assertEqual(
  194. Model.check(),
  195. [
  196. Error(
  197. "The index name '%sindex_name' cannot start with an "
  198. "underscore or a number." % prefix,
  199. obj=Model,
  200. id="models.E033",
  201. )
  202. for prefix in ("_", "5")
  203. ],
  204. )
  205. def test_max_name_length(self):
  206. index_name = "x" * 31
  207. class Model(models.Model):
  208. class Meta:
  209. indexes = [models.Index(fields=["id"], name=index_name)]
  210. self.assertEqual(
  211. Model.check(),
  212. [
  213. Error(
  214. "The index name '%s' cannot be longer than 30 characters."
  215. % index_name,
  216. obj=Model,
  217. id="models.E034",
  218. ),
  219. ],
  220. )
  221. def test_index_with_condition(self):
  222. class Model(models.Model):
  223. age = models.IntegerField()
  224. class Meta:
  225. indexes = [
  226. models.Index(
  227. fields=["age"],
  228. name="index_age_gte_10",
  229. condition=models.Q(age__gte=10),
  230. ),
  231. ]
  232. errors = Model.check(databases=self.databases)
  233. expected = (
  234. []
  235. if connection.features.supports_partial_indexes
  236. else [
  237. Warning(
  238. "%s does not support indexes with conditions."
  239. % connection.display_name,
  240. hint=(
  241. "Conditions will be ignored. Silence this warning if you "
  242. "don't care about it."
  243. ),
  244. obj=Model,
  245. id="models.W037",
  246. )
  247. ]
  248. )
  249. self.assertEqual(errors, expected)
  250. def test_index_with_condition_required_db_features(self):
  251. class Model(models.Model):
  252. age = models.IntegerField()
  253. class Meta:
  254. required_db_features = {"supports_partial_indexes"}
  255. indexes = [
  256. models.Index(
  257. fields=["age"],
  258. name="index_age_gte_10",
  259. condition=models.Q(age__gte=10),
  260. ),
  261. ]
  262. self.assertEqual(Model.check(databases=self.databases), [])
  263. def test_index_with_include(self):
  264. class Model(models.Model):
  265. age = models.IntegerField()
  266. class Meta:
  267. indexes = [
  268. models.Index(
  269. fields=["age"],
  270. name="index_age_include_id",
  271. include=["id"],
  272. ),
  273. ]
  274. errors = Model.check(databases=self.databases)
  275. expected = (
  276. []
  277. if connection.features.supports_covering_indexes
  278. else [
  279. Warning(
  280. "%s does not support indexes with non-key columns."
  281. % connection.display_name,
  282. hint=(
  283. "Non-key columns will be ignored. Silence this warning if "
  284. "you don't care about it."
  285. ),
  286. obj=Model,
  287. id="models.W040",
  288. )
  289. ]
  290. )
  291. self.assertEqual(errors, expected)
  292. def test_index_with_include_required_db_features(self):
  293. class Model(models.Model):
  294. age = models.IntegerField()
  295. class Meta:
  296. required_db_features = {"supports_covering_indexes"}
  297. indexes = [
  298. models.Index(
  299. fields=["age"],
  300. name="index_age_include_id",
  301. include=["id"],
  302. ),
  303. ]
  304. self.assertEqual(Model.check(databases=self.databases), [])
  305. @skipUnlessDBFeature("supports_covering_indexes")
  306. def test_index_include_pointing_to_missing_field(self):
  307. class Model(models.Model):
  308. class Meta:
  309. indexes = [
  310. models.Index(fields=["id"], include=["missing_field"], name="name"),
  311. ]
  312. self.assertEqual(
  313. Model.check(databases=self.databases),
  314. [
  315. Error(
  316. "'indexes' refers to the nonexistent field 'missing_field'.",
  317. obj=Model,
  318. id="models.E012",
  319. ),
  320. ],
  321. )
  322. @skipUnlessDBFeature("supports_covering_indexes")
  323. def test_index_include_pointing_to_m2m_field(self):
  324. class Model(models.Model):
  325. m2m = models.ManyToManyField("self")
  326. class Meta:
  327. indexes = [models.Index(fields=["id"], include=["m2m"], name="name")]
  328. self.assertEqual(
  329. Model.check(databases=self.databases),
  330. [
  331. Error(
  332. "'indexes' refers to a ManyToManyField 'm2m', but "
  333. "ManyToManyFields are not permitted in 'indexes'.",
  334. obj=Model,
  335. id="models.E013",
  336. ),
  337. ],
  338. )
  339. @skipUnlessDBFeature("supports_covering_indexes")
  340. def test_index_include_pointing_to_non_local_field(self):
  341. class Parent(models.Model):
  342. field1 = models.IntegerField()
  343. class Child(Parent):
  344. field2 = models.IntegerField()
  345. class Meta:
  346. indexes = [
  347. models.Index(fields=["field2"], include=["field1"], name="name"),
  348. ]
  349. self.assertEqual(
  350. Child.check(databases=self.databases),
  351. [
  352. Error(
  353. "'indexes' refers to field 'field1' which is not local to "
  354. "model 'Child'.",
  355. hint="This issue may be caused by multi-table inheritance.",
  356. obj=Child,
  357. id="models.E016",
  358. ),
  359. ],
  360. )
  361. @skipUnlessDBFeature("supports_covering_indexes")
  362. def test_index_include_pointing_to_fk(self):
  363. class Target(models.Model):
  364. pass
  365. class Model(models.Model):
  366. fk_1 = models.ForeignKey(Target, models.CASCADE, related_name="target_1")
  367. fk_2 = models.ForeignKey(Target, models.CASCADE, related_name="target_2")
  368. class Meta:
  369. indexes = [
  370. models.Index(
  371. fields=["id"],
  372. include=["fk_1_id", "fk_2"],
  373. name="name",
  374. ),
  375. ]
  376. self.assertEqual(Model.check(databases=self.databases), [])
  377. def test_func_index(self):
  378. class Model(models.Model):
  379. name = models.CharField(max_length=10)
  380. class Meta:
  381. indexes = [models.Index(Lower("name"), name="index_lower_name")]
  382. warn = Warning(
  383. "%s does not support indexes on expressions." % connection.display_name,
  384. hint=(
  385. "An index won't be created. Silence this warning if you don't "
  386. "care about it."
  387. ),
  388. obj=Model,
  389. id="models.W043",
  390. )
  391. expected = [] if connection.features.supports_expression_indexes else [warn]
  392. self.assertEqual(Model.check(databases=self.databases), expected)
  393. def test_func_index_required_db_features(self):
  394. class Model(models.Model):
  395. name = models.CharField(max_length=10)
  396. class Meta:
  397. indexes = [models.Index(Lower("name"), name="index_lower_name")]
  398. required_db_features = {"supports_expression_indexes"}
  399. self.assertEqual(Model.check(databases=self.databases), [])
  400. def test_func_index_complex_expression_custom_lookup(self):
  401. class Model(models.Model):
  402. height = models.IntegerField()
  403. weight = models.IntegerField()
  404. class Meta:
  405. indexes = [
  406. models.Index(
  407. models.F("height")
  408. / (models.F("weight__abs") + models.Value(5)),
  409. name="name",
  410. ),
  411. ]
  412. with register_lookup(models.IntegerField, Abs):
  413. self.assertEqual(Model.check(), [])
  414. def test_func_index_pointing_to_missing_field(self):
  415. class Model(models.Model):
  416. class Meta:
  417. indexes = [models.Index(Lower("missing_field").desc(), name="name")]
  418. self.assertEqual(
  419. Model.check(),
  420. [
  421. Error(
  422. "'indexes' refers to the nonexistent field 'missing_field'.",
  423. obj=Model,
  424. id="models.E012",
  425. ),
  426. ],
  427. )
  428. def test_func_index_pointing_to_missing_field_nested(self):
  429. class Model(models.Model):
  430. class Meta:
  431. indexes = [
  432. models.Index(Abs(Round("missing_field")), name="name"),
  433. ]
  434. self.assertEqual(
  435. Model.check(),
  436. [
  437. Error(
  438. "'indexes' refers to the nonexistent field 'missing_field'.",
  439. obj=Model,
  440. id="models.E012",
  441. ),
  442. ],
  443. )
  444. def test_func_index_pointing_to_m2m_field(self):
  445. class Model(models.Model):
  446. m2m = models.ManyToManyField("self")
  447. class Meta:
  448. indexes = [models.Index(Lower("m2m"), name="name")]
  449. self.assertEqual(
  450. Model.check(),
  451. [
  452. Error(
  453. "'indexes' refers to a ManyToManyField 'm2m', but "
  454. "ManyToManyFields are not permitted in 'indexes'.",
  455. obj=Model,
  456. id="models.E013",
  457. ),
  458. ],
  459. )
  460. def test_func_index_pointing_to_non_local_field(self):
  461. class Foo(models.Model):
  462. field1 = models.CharField(max_length=15)
  463. class Bar(Foo):
  464. class Meta:
  465. indexes = [models.Index(Lower("field1"), name="name")]
  466. self.assertEqual(
  467. Bar.check(),
  468. [
  469. Error(
  470. "'indexes' refers to field 'field1' which is not local to "
  471. "model 'Bar'.",
  472. hint="This issue may be caused by multi-table inheritance.",
  473. obj=Bar,
  474. id="models.E016",
  475. ),
  476. ],
  477. )
  478. def test_func_index_pointing_to_fk(self):
  479. class Foo(models.Model):
  480. pass
  481. class Bar(models.Model):
  482. foo_1 = models.ForeignKey(Foo, models.CASCADE, related_name="bar_1")
  483. foo_2 = models.ForeignKey(Foo, models.CASCADE, related_name="bar_2")
  484. class Meta:
  485. indexes = [
  486. models.Index(Lower("foo_1_id"), Lower("foo_2"), name="index_name"),
  487. ]
  488. self.assertEqual(Bar.check(), [])
  489. @isolate_apps("invalid_models_tests")
  490. class FieldNamesTests(TestCase):
  491. databases = {"default", "other"}
  492. def test_ending_with_underscore(self):
  493. class Model(models.Model):
  494. field_ = models.CharField(max_length=10)
  495. m2m_ = models.ManyToManyField("self")
  496. self.assertEqual(
  497. Model.check(),
  498. [
  499. Error(
  500. "Field names must not end with an underscore.",
  501. obj=Model._meta.get_field("field_"),
  502. id="fields.E001",
  503. ),
  504. Error(
  505. "Field names must not end with an underscore.",
  506. obj=Model._meta.get_field("m2m_"),
  507. id="fields.E001",
  508. ),
  509. ],
  510. )
  511. max_column_name_length, column_limit_db_alias = get_max_column_name_length()
  512. @unittest.skipIf(
  513. max_column_name_length is None,
  514. "The database doesn't have a column name length limit.",
  515. )
  516. def test_M2M_long_column_name(self):
  517. """
  518. #13711 -- Model check for long M2M column names when database has
  519. column name length limits.
  520. """
  521. # A model with very long name which will be used to set relations to.
  522. class VeryLongModelNamezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz(
  523. models.Model
  524. ):
  525. title = models.CharField(max_length=11)
  526. # Main model for which checks will be performed.
  527. class ModelWithLongField(models.Model):
  528. m2m_field = models.ManyToManyField(
  529. VeryLongModelNamezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
  530. related_name="rn1",
  531. )
  532. m2m_field2 = models.ManyToManyField(
  533. VeryLongModelNamezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
  534. related_name="rn2",
  535. through="m2msimple",
  536. )
  537. m2m_field3 = models.ManyToManyField(
  538. VeryLongModelNamezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
  539. related_name="rn3",
  540. through="m2mcomplex",
  541. )
  542. fk = models.ForeignKey(
  543. VeryLongModelNamezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
  544. models.CASCADE,
  545. related_name="rn4",
  546. )
  547. # Models used for setting `through` in M2M field.
  548. class m2msimple(models.Model):
  549. id2 = models.ForeignKey(ModelWithLongField, models.CASCADE)
  550. class m2mcomplex(models.Model):
  551. id2 = models.ForeignKey(ModelWithLongField, models.CASCADE)
  552. long_field_name = "a" * (self.max_column_name_length + 1)
  553. models.ForeignKey(
  554. VeryLongModelNamezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
  555. models.CASCADE,
  556. ).contribute_to_class(m2msimple, long_field_name)
  557. models.ForeignKey(
  558. VeryLongModelNamezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
  559. models.CASCADE,
  560. db_column=long_field_name,
  561. ).contribute_to_class(m2mcomplex, long_field_name)
  562. errors = ModelWithLongField.check(databases=("default", "other"))
  563. # First error because of M2M field set on the model with long name.
  564. m2m_long_name = (
  565. "verylongmodelnamezzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz_id"
  566. )
  567. if self.max_column_name_length > len(m2m_long_name):
  568. # Some databases support names longer than the test name.
  569. expected = []
  570. else:
  571. expected = [
  572. Error(
  573. 'Autogenerated column name too long for M2M field "%s". '
  574. 'Maximum length is "%s" for database "%s".'
  575. % (
  576. m2m_long_name,
  577. self.max_column_name_length,
  578. self.column_limit_db_alias,
  579. ),
  580. hint="Use 'through' to create a separate model for "
  581. "M2M and then set column_name using 'db_column'.",
  582. obj=ModelWithLongField,
  583. id="models.E019",
  584. )
  585. ]
  586. # Second error because the FK specified in the `through` model
  587. # `m2msimple` has auto-generated name longer than allowed.
  588. # There will be no check errors in the other M2M because it
  589. # specifies db_column for the FK in `through` model even if the actual
  590. # name is longer than the limits of the database.
  591. expected.append(
  592. Error(
  593. 'Autogenerated column name too long for M2M field "%s_id". '
  594. 'Maximum length is "%s" for database "%s".'
  595. % (
  596. long_field_name,
  597. self.max_column_name_length,
  598. self.column_limit_db_alias,
  599. ),
  600. hint="Use 'through' to create a separate model for "
  601. "M2M and then set column_name using 'db_column'.",
  602. obj=ModelWithLongField,
  603. id="models.E019",
  604. )
  605. )
  606. self.assertEqual(errors, expected)
  607. # Check for long column names is called only for specified database
  608. # aliases.
  609. self.assertEqual(ModelWithLongField.check(databases=None), [])
  610. @unittest.skipIf(
  611. max_column_name_length is None,
  612. "The database doesn't have a column name length limit.",
  613. )
  614. def test_local_field_long_column_name(self):
  615. """
  616. #13711 -- Model check for long column names
  617. when database does not support long names.
  618. """
  619. class ModelWithLongField(models.Model):
  620. title = models.CharField(max_length=11)
  621. long_field_name = "a" * (self.max_column_name_length + 1)
  622. long_field_name2 = "b" * (self.max_column_name_length + 1)
  623. models.CharField(max_length=11).contribute_to_class(
  624. ModelWithLongField, long_field_name
  625. )
  626. models.CharField(max_length=11, db_column="vlmn").contribute_to_class(
  627. ModelWithLongField, long_field_name2
  628. )
  629. self.assertEqual(
  630. ModelWithLongField.check(databases=("default", "other")),
  631. [
  632. Error(
  633. 'Autogenerated column name too long for field "%s". '
  634. 'Maximum length is "%s" for database "%s".'
  635. % (
  636. long_field_name,
  637. self.max_column_name_length,
  638. self.column_limit_db_alias,
  639. ),
  640. hint="Set the column name manually using 'db_column'.",
  641. obj=ModelWithLongField,
  642. id="models.E018",
  643. )
  644. ],
  645. )
  646. # Check for long column names is called only for specified database
  647. # aliases.
  648. self.assertEqual(ModelWithLongField.check(databases=None), [])
  649. def test_including_separator(self):
  650. class Model(models.Model):
  651. some__field = models.IntegerField()
  652. self.assertEqual(
  653. Model.check(),
  654. [
  655. Error(
  656. 'Field names must not contain "__".',
  657. obj=Model._meta.get_field("some__field"),
  658. id="fields.E002",
  659. )
  660. ],
  661. )
  662. def test_pk(self):
  663. class Model(models.Model):
  664. pk = models.IntegerField()
  665. self.assertEqual(
  666. Model.check(),
  667. [
  668. Error(
  669. "'pk' is a reserved word that cannot be used as a field name.",
  670. obj=Model._meta.get_field("pk"),
  671. id="fields.E003",
  672. )
  673. ],
  674. )
  675. def test_db_column_clash(self):
  676. class Model(models.Model):
  677. foo = models.IntegerField()
  678. bar = models.IntegerField(db_column="foo")
  679. self.assertEqual(
  680. Model.check(),
  681. [
  682. Error(
  683. "Field 'bar' has column name 'foo' that is used by "
  684. "another field.",
  685. hint="Specify a 'db_column' for the field.",
  686. obj=Model,
  687. id="models.E007",
  688. )
  689. ],
  690. )
  691. @isolate_apps("invalid_models_tests")
  692. class ShadowingFieldsTests(SimpleTestCase):
  693. def test_field_name_clash_with_child_accessor(self):
  694. class Parent(models.Model):
  695. pass
  696. class Child(Parent):
  697. child = models.CharField(max_length=100)
  698. self.assertEqual(
  699. Child.check(),
  700. [
  701. Error(
  702. "The field 'child' clashes with the field "
  703. "'child' from model 'invalid_models_tests.parent'.",
  704. obj=Child._meta.get_field("child"),
  705. id="models.E006",
  706. )
  707. ],
  708. )
  709. def test_field_name_clash_with_m2m_through(self):
  710. class Parent(models.Model):
  711. clash_id = models.IntegerField()
  712. class Child(Parent):
  713. clash = models.ForeignKey("Child", models.CASCADE)
  714. class Model(models.Model):
  715. parents = models.ManyToManyField(
  716. to=Parent,
  717. through="Through",
  718. through_fields=["parent", "model"],
  719. )
  720. class Through(models.Model):
  721. parent = models.ForeignKey(Parent, models.CASCADE)
  722. model = models.ForeignKey(Model, models.CASCADE)
  723. self.assertEqual(
  724. Child.check(),
  725. [
  726. Error(
  727. "The field 'clash' clashes with the field 'clash_id' from "
  728. "model 'invalid_models_tests.parent'.",
  729. obj=Child._meta.get_field("clash"),
  730. id="models.E006",
  731. )
  732. ],
  733. )
  734. def test_multiinheritance_clash(self):
  735. class Mother(models.Model):
  736. clash = models.IntegerField()
  737. class Father(models.Model):
  738. clash = models.IntegerField()
  739. class Child(Mother, Father):
  740. # Here we have two clashed: id (automatic field) and clash, because
  741. # both parents define these fields.
  742. pass
  743. self.assertEqual(
  744. Child.check(),
  745. [
  746. Error(
  747. "The field 'id' from parent model "
  748. "'invalid_models_tests.mother' clashes with the field 'id' "
  749. "from parent model 'invalid_models_tests.father'.",
  750. obj=Child,
  751. id="models.E005",
  752. ),
  753. Error(
  754. "The field 'clash' from parent model "
  755. "'invalid_models_tests.mother' clashes with the field 'clash' "
  756. "from parent model 'invalid_models_tests.father'.",
  757. obj=Child,
  758. id="models.E005",
  759. ),
  760. ],
  761. )
  762. def test_inheritance_clash(self):
  763. class Parent(models.Model):
  764. f_id = models.IntegerField()
  765. class Target(models.Model):
  766. # This field doesn't result in a clash.
  767. f_id = models.IntegerField()
  768. class Child(Parent):
  769. # This field clashes with parent "f_id" field.
  770. f = models.ForeignKey(Target, models.CASCADE)
  771. self.assertEqual(
  772. Child.check(),
  773. [
  774. Error(
  775. "The field 'f' clashes with the field 'f_id' "
  776. "from model 'invalid_models_tests.parent'.",
  777. obj=Child._meta.get_field("f"),
  778. id="models.E006",
  779. )
  780. ],
  781. )
  782. def test_multigeneration_inheritance(self):
  783. class GrandParent(models.Model):
  784. clash = models.IntegerField()
  785. class Parent(GrandParent):
  786. pass
  787. class Child(Parent):
  788. pass
  789. class GrandChild(Child):
  790. clash = models.IntegerField()
  791. self.assertEqual(
  792. GrandChild.check(),
  793. [
  794. Error(
  795. "The field 'clash' clashes with the field 'clash' "
  796. "from model 'invalid_models_tests.grandparent'.",
  797. obj=GrandChild._meta.get_field("clash"),
  798. id="models.E006",
  799. )
  800. ],
  801. )
  802. def test_diamond_mti_common_parent(self):
  803. class GrandParent(models.Model):
  804. pass
  805. class Parent(GrandParent):
  806. pass
  807. class Child(Parent):
  808. pass
  809. class MTICommonParentModel(Child, GrandParent):
  810. pass
  811. self.assertEqual(
  812. MTICommonParentModel.check(),
  813. [
  814. Error(
  815. "The field 'grandparent_ptr' clashes with the field "
  816. "'grandparent_ptr' from model 'invalid_models_tests.parent'.",
  817. obj=MTICommonParentModel,
  818. id="models.E006",
  819. )
  820. ],
  821. )
  822. def test_id_clash(self):
  823. class Target(models.Model):
  824. pass
  825. class Model(models.Model):
  826. fk = models.ForeignKey(Target, models.CASCADE)
  827. fk_id = models.IntegerField()
  828. self.assertEqual(
  829. Model.check(),
  830. [
  831. Error(
  832. "The field 'fk_id' clashes with the field 'fk' from model "
  833. "'invalid_models_tests.model'.",
  834. obj=Model._meta.get_field("fk_id"),
  835. id="models.E006",
  836. )
  837. ],
  838. )
  839. @isolate_apps("invalid_models_tests")
  840. class OtherModelTests(SimpleTestCase):
  841. def test_unique_primary_key(self):
  842. invalid_id = models.IntegerField(primary_key=False)
  843. class Model(models.Model):
  844. id = invalid_id
  845. self.assertEqual(
  846. Model.check(),
  847. [
  848. Error(
  849. "'id' can only be used as a field name if the field also sets "
  850. "'primary_key=True'.",
  851. obj=Model,
  852. id="models.E004",
  853. ),
  854. ],
  855. )
  856. def test_ordering_non_iterable(self):
  857. class Model(models.Model):
  858. class Meta:
  859. ordering = "missing_field"
  860. self.assertEqual(
  861. Model.check(),
  862. [
  863. Error(
  864. "'ordering' must be a tuple or list "
  865. "(even if you want to order by only one field).",
  866. obj=Model,
  867. id="models.E014",
  868. ),
  869. ],
  870. )
  871. def test_just_ordering_no_errors(self):
  872. class Model(models.Model):
  873. order = models.PositiveIntegerField()
  874. class Meta:
  875. ordering = ["order"]
  876. self.assertEqual(Model.check(), [])
  877. def test_just_order_with_respect_to_no_errors(self):
  878. class Question(models.Model):
  879. pass
  880. class Answer(models.Model):
  881. question = models.ForeignKey(Question, models.CASCADE)
  882. class Meta:
  883. order_with_respect_to = "question"
  884. self.assertEqual(Answer.check(), [])
  885. def test_ordering_with_order_with_respect_to(self):
  886. class Question(models.Model):
  887. pass
  888. class Answer(models.Model):
  889. question = models.ForeignKey(Question, models.CASCADE)
  890. order = models.IntegerField()
  891. class Meta:
  892. order_with_respect_to = "question"
  893. ordering = ["order"]
  894. self.assertEqual(
  895. Answer.check(),
  896. [
  897. Error(
  898. "'ordering' and 'order_with_respect_to' cannot be used together.",
  899. obj=Answer,
  900. id="models.E021",
  901. ),
  902. ],
  903. )
  904. def test_non_valid(self):
  905. class RelationModel(models.Model):
  906. pass
  907. class Model(models.Model):
  908. relation = models.ManyToManyField(RelationModel)
  909. class Meta:
  910. ordering = ["relation"]
  911. self.assertEqual(
  912. Model.check(),
  913. [
  914. Error(
  915. "'ordering' refers to the nonexistent field, related field, "
  916. "or lookup 'relation'.",
  917. obj=Model,
  918. id="models.E015",
  919. ),
  920. ],
  921. )
  922. def test_ordering_pointing_to_missing_field(self):
  923. class Model(models.Model):
  924. class Meta:
  925. ordering = ("missing_field",)
  926. self.assertEqual(
  927. Model.check(),
  928. [
  929. Error(
  930. "'ordering' refers to the nonexistent field, related field, "
  931. "or lookup 'missing_field'.",
  932. obj=Model,
  933. id="models.E015",
  934. )
  935. ],
  936. )
  937. def test_ordering_pointing_to_missing_foreignkey_field(self):
  938. class Model(models.Model):
  939. missing_fk_field = models.IntegerField()
  940. class Meta:
  941. ordering = ("missing_fk_field_id",)
  942. self.assertEqual(
  943. Model.check(),
  944. [
  945. Error(
  946. "'ordering' refers to the nonexistent field, related field, "
  947. "or lookup 'missing_fk_field_id'.",
  948. obj=Model,
  949. id="models.E015",
  950. )
  951. ],
  952. )
  953. def test_ordering_pointing_to_missing_related_field(self):
  954. class Model(models.Model):
  955. test = models.IntegerField()
  956. class Meta:
  957. ordering = ("missing_related__id",)
  958. self.assertEqual(
  959. Model.check(),
  960. [
  961. Error(
  962. "'ordering' refers to the nonexistent field, related field, "
  963. "or lookup 'missing_related__id'.",
  964. obj=Model,
  965. id="models.E015",
  966. )
  967. ],
  968. )
  969. def test_ordering_pointing_to_missing_related_model_field(self):
  970. class Parent(models.Model):
  971. pass
  972. class Child(models.Model):
  973. parent = models.ForeignKey(Parent, models.CASCADE)
  974. class Meta:
  975. ordering = ("parent__missing_field",)
  976. self.assertEqual(
  977. Child.check(),
  978. [
  979. Error(
  980. "'ordering' refers to the nonexistent field, related field, "
  981. "or lookup 'parent__missing_field'.",
  982. obj=Child,
  983. id="models.E015",
  984. )
  985. ],
  986. )
  987. def test_ordering_pointing_to_non_related_field(self):
  988. class Child(models.Model):
  989. parent = models.IntegerField()
  990. class Meta:
  991. ordering = ("parent__missing_field",)
  992. self.assertEqual(
  993. Child.check(),
  994. [
  995. Error(
  996. "'ordering' refers to the nonexistent field, related field, "
  997. "or lookup 'parent__missing_field'.",
  998. obj=Child,
  999. id="models.E015",
  1000. )
  1001. ],
  1002. )
  1003. def test_ordering_pointing_to_two_related_model_field(self):
  1004. class Parent2(models.Model):
  1005. pass
  1006. class Parent1(models.Model):
  1007. parent2 = models.ForeignKey(Parent2, models.CASCADE)
  1008. class Child(models.Model):
  1009. parent1 = models.ForeignKey(Parent1, models.CASCADE)
  1010. class Meta:
  1011. ordering = ("parent1__parent2__missing_field",)
  1012. self.assertEqual(
  1013. Child.check(),
  1014. [
  1015. Error(
  1016. "'ordering' refers to the nonexistent field, related field, "
  1017. "or lookup 'parent1__parent2__missing_field'.",
  1018. obj=Child,
  1019. id="models.E015",
  1020. )
  1021. ],
  1022. )
  1023. def test_ordering_pointing_multiple_times_to_model_fields(self):
  1024. class Parent(models.Model):
  1025. field1 = models.CharField(max_length=100)
  1026. field2 = models.CharField(max_length=100)
  1027. class Child(models.Model):
  1028. parent = models.ForeignKey(Parent, models.CASCADE)
  1029. class Meta:
  1030. ordering = ("parent__field1__field2",)
  1031. self.assertEqual(
  1032. Child.check(),
  1033. [
  1034. Error(
  1035. "'ordering' refers to the nonexistent field, related field, "
  1036. "or lookup 'parent__field1__field2'.",
  1037. obj=Child,
  1038. id="models.E015",
  1039. )
  1040. ],
  1041. )
  1042. def test_ordering_allows_registered_lookups(self):
  1043. class Model(models.Model):
  1044. test = models.CharField(max_length=100)
  1045. class Meta:
  1046. ordering = ("test__lower",)
  1047. with register_lookup(models.CharField, Lower):
  1048. self.assertEqual(Model.check(), [])
  1049. def test_ordering_pointing_to_lookup_not_transform(self):
  1050. class Model(models.Model):
  1051. test = models.CharField(max_length=100)
  1052. class Meta:
  1053. ordering = ("test__isnull",)
  1054. self.assertEqual(Model.check(), [])
  1055. def test_ordering_pointing_to_related_model_pk(self):
  1056. class Parent(models.Model):
  1057. pass
  1058. class Child(models.Model):
  1059. parent = models.ForeignKey(Parent, models.CASCADE)
  1060. class Meta:
  1061. ordering = ("parent__pk",)
  1062. self.assertEqual(Child.check(), [])
  1063. def test_ordering_pointing_to_foreignkey_field(self):
  1064. class Parent(models.Model):
  1065. pass
  1066. class Child(models.Model):
  1067. parent = models.ForeignKey(Parent, models.CASCADE)
  1068. class Meta:
  1069. ordering = ("parent_id",)
  1070. self.assertFalse(Child.check())
  1071. def test_name_beginning_with_underscore(self):
  1072. class _Model(models.Model):
  1073. pass
  1074. self.assertEqual(
  1075. _Model.check(),
  1076. [
  1077. Error(
  1078. "The model name '_Model' cannot start or end with an underscore "
  1079. "as it collides with the query lookup syntax.",
  1080. obj=_Model,
  1081. id="models.E023",
  1082. )
  1083. ],
  1084. )
  1085. def test_name_ending_with_underscore(self):
  1086. class Model_(models.Model):
  1087. pass
  1088. self.assertEqual(
  1089. Model_.check(),
  1090. [
  1091. Error(
  1092. "The model name 'Model_' cannot start or end with an underscore "
  1093. "as it collides with the query lookup syntax.",
  1094. obj=Model_,
  1095. id="models.E023",
  1096. )
  1097. ],
  1098. )
  1099. def test_name_contains_double_underscores(self):
  1100. class Test__Model(models.Model):
  1101. pass
  1102. self.assertEqual(
  1103. Test__Model.check(),
  1104. [
  1105. Error(
  1106. "The model name 'Test__Model' cannot contain double underscores "
  1107. "as it collides with the query lookup syntax.",
  1108. obj=Test__Model,
  1109. id="models.E024",
  1110. )
  1111. ],
  1112. )
  1113. def test_property_and_related_field_accessor_clash(self):
  1114. class Model(models.Model):
  1115. fk = models.ForeignKey("self", models.CASCADE)
  1116. # Override related field accessor.
  1117. Model.fk_id = property(lambda self: "ERROR")
  1118. self.assertEqual(
  1119. Model.check(),
  1120. [
  1121. Error(
  1122. "The property 'fk_id' clashes with a related field accessor.",
  1123. obj=Model,
  1124. id="models.E025",
  1125. )
  1126. ],
  1127. )
  1128. def test_single_primary_key(self):
  1129. class Model(models.Model):
  1130. foo = models.IntegerField(primary_key=True)
  1131. bar = models.IntegerField(primary_key=True)
  1132. self.assertEqual(
  1133. Model.check(),
  1134. [
  1135. Error(
  1136. "The model cannot have more than one field with "
  1137. "'primary_key=True'.",
  1138. obj=Model,
  1139. id="models.E026",
  1140. )
  1141. ],
  1142. )
  1143. @override_settings(TEST_SWAPPED_MODEL_BAD_VALUE="not-a-model")
  1144. def test_swappable_missing_app_name(self):
  1145. class Model(models.Model):
  1146. class Meta:
  1147. swappable = "TEST_SWAPPED_MODEL_BAD_VALUE"
  1148. self.assertEqual(
  1149. Model.check(),
  1150. [
  1151. Error(
  1152. "'TEST_SWAPPED_MODEL_BAD_VALUE' is not of the form "
  1153. "'app_label.app_name'.",
  1154. id="models.E001",
  1155. ),
  1156. ],
  1157. )
  1158. @override_settings(TEST_SWAPPED_MODEL_BAD_MODEL="not_an_app.Target")
  1159. def test_swappable_missing_app(self):
  1160. class Model(models.Model):
  1161. class Meta:
  1162. swappable = "TEST_SWAPPED_MODEL_BAD_MODEL"
  1163. self.assertEqual(
  1164. Model.check(),
  1165. [
  1166. Error(
  1167. "'TEST_SWAPPED_MODEL_BAD_MODEL' references 'not_an_app.Target', "
  1168. "which has not been installed, or is abstract.",
  1169. id="models.E002",
  1170. ),
  1171. ],
  1172. )
  1173. def test_two_m2m_through_same_relationship(self):
  1174. class Person(models.Model):
  1175. pass
  1176. class Group(models.Model):
  1177. primary = models.ManyToManyField(
  1178. Person, through="Membership", related_name="primary"
  1179. )
  1180. secondary = models.ManyToManyField(
  1181. Person, through="Membership", related_name="secondary"
  1182. )
  1183. class Membership(models.Model):
  1184. person = models.ForeignKey(Person, models.CASCADE)
  1185. group = models.ForeignKey(Group, models.CASCADE)
  1186. self.assertEqual(
  1187. Group.check(),
  1188. [
  1189. Error(
  1190. "The model has two identical many-to-many relations through "
  1191. "the intermediate model 'invalid_models_tests.Membership'.",
  1192. obj=Group,
  1193. id="models.E003",
  1194. )
  1195. ],
  1196. )
  1197. def test_two_m2m_through_same_model_with_different_through_fields(self):
  1198. class Country(models.Model):
  1199. pass
  1200. class ShippingMethod(models.Model):
  1201. to_countries = models.ManyToManyField(
  1202. Country,
  1203. through="ShippingMethodPrice",
  1204. through_fields=("method", "to_country"),
  1205. )
  1206. from_countries = models.ManyToManyField(
  1207. Country,
  1208. through="ShippingMethodPrice",
  1209. through_fields=("method", "from_country"),
  1210. related_name="+",
  1211. )
  1212. class ShippingMethodPrice(models.Model):
  1213. method = models.ForeignKey(ShippingMethod, models.CASCADE)
  1214. to_country = models.ForeignKey(Country, models.CASCADE)
  1215. from_country = models.ForeignKey(Country, models.CASCADE)
  1216. self.assertEqual(ShippingMethod.check(), [])
  1217. def test_onetoone_with_parent_model(self):
  1218. class Place(models.Model):
  1219. pass
  1220. class ParkingLot(Place):
  1221. other_place = models.OneToOneField(
  1222. Place, models.CASCADE, related_name="other_parking"
  1223. )
  1224. self.assertEqual(ParkingLot.check(), [])
  1225. def test_onetoone_with_explicit_parent_link_parent_model(self):
  1226. class Place(models.Model):
  1227. pass
  1228. class ParkingLot(Place):
  1229. place = models.OneToOneField(
  1230. Place, models.CASCADE, parent_link=True, primary_key=True
  1231. )
  1232. other_place = models.OneToOneField(
  1233. Place, models.CASCADE, related_name="other_parking"
  1234. )
  1235. self.assertEqual(ParkingLot.check(), [])
  1236. def test_m2m_table_name_clash(self):
  1237. class Foo(models.Model):
  1238. bar = models.ManyToManyField("Bar", db_table="myapp_bar")
  1239. class Meta:
  1240. db_table = "myapp_foo"
  1241. class Bar(models.Model):
  1242. class Meta:
  1243. db_table = "myapp_bar"
  1244. self.assertEqual(
  1245. Foo.check(),
  1246. [
  1247. Error(
  1248. "The field's intermediary table 'myapp_bar' clashes with the "
  1249. "table name of 'invalid_models_tests.Bar'.",
  1250. obj=Foo._meta.get_field("bar"),
  1251. id="fields.E340",
  1252. )
  1253. ],
  1254. )
  1255. @override_settings(
  1256. DATABASE_ROUTERS=["invalid_models_tests.test_models.EmptyRouter"]
  1257. )
  1258. def test_m2m_table_name_clash_database_routers_installed(self):
  1259. class Foo(models.Model):
  1260. bar = models.ManyToManyField("Bar", db_table="myapp_bar")
  1261. class Meta:
  1262. db_table = "myapp_foo"
  1263. class Bar(models.Model):
  1264. class Meta:
  1265. db_table = "myapp_bar"
  1266. self.assertEqual(
  1267. Foo.check(),
  1268. [
  1269. Warning(
  1270. "The field's intermediary table 'myapp_bar' clashes with the "
  1271. "table name of 'invalid_models_tests.Bar'.",
  1272. obj=Foo._meta.get_field("bar"),
  1273. hint=(
  1274. "You have configured settings.DATABASE_ROUTERS. Verify "
  1275. "that the table of 'invalid_models_tests.Bar' is "
  1276. "correctly routed to a separate database."
  1277. ),
  1278. id="fields.W344",
  1279. ),
  1280. ],
  1281. )
  1282. def test_m2m_field_table_name_clash(self):
  1283. class Foo(models.Model):
  1284. pass
  1285. class Bar(models.Model):
  1286. foos = models.ManyToManyField(Foo, db_table="clash")
  1287. class Baz(models.Model):
  1288. foos = models.ManyToManyField(Foo, db_table="clash")
  1289. self.assertEqual(
  1290. Bar.check() + Baz.check(),
  1291. [
  1292. Error(
  1293. "The field's intermediary table 'clash' clashes with the "
  1294. "table name of 'invalid_models_tests.Baz.foos'.",
  1295. obj=Bar._meta.get_field("foos"),
  1296. id="fields.E340",
  1297. ),
  1298. Error(
  1299. "The field's intermediary table 'clash' clashes with the "
  1300. "table name of 'invalid_models_tests.Bar.foos'.",
  1301. obj=Baz._meta.get_field("foos"),
  1302. id="fields.E340",
  1303. ),
  1304. ],
  1305. )
  1306. @override_settings(
  1307. DATABASE_ROUTERS=["invalid_models_tests.test_models.EmptyRouter"]
  1308. )
  1309. def test_m2m_field_table_name_clash_database_routers_installed(self):
  1310. class Foo(models.Model):
  1311. pass
  1312. class Bar(models.Model):
  1313. foos = models.ManyToManyField(Foo, db_table="clash")
  1314. class Baz(models.Model):
  1315. foos = models.ManyToManyField(Foo, db_table="clash")
  1316. self.assertEqual(
  1317. Bar.check() + Baz.check(),
  1318. [
  1319. Warning(
  1320. "The field's intermediary table 'clash' clashes with the "
  1321. "table name of 'invalid_models_tests.%s.foos'." % clashing_model,
  1322. obj=model_cls._meta.get_field("foos"),
  1323. hint=(
  1324. "You have configured settings.DATABASE_ROUTERS. Verify "
  1325. "that the table of 'invalid_models_tests.%s.foos' is "
  1326. "correctly routed to a separate database." % clashing_model
  1327. ),
  1328. id="fields.W344",
  1329. )
  1330. for model_cls, clashing_model in [(Bar, "Baz"), (Baz, "Bar")]
  1331. ],
  1332. )
  1333. def test_m2m_autogenerated_table_name_clash(self):
  1334. class Foo(models.Model):
  1335. class Meta:
  1336. db_table = "bar_foos"
  1337. class Bar(models.Model):
  1338. # The autogenerated `db_table` will be bar_foos.
  1339. foos = models.ManyToManyField(Foo)
  1340. class Meta:
  1341. db_table = "bar"
  1342. self.assertEqual(
  1343. Bar.check(),
  1344. [
  1345. Error(
  1346. "The field's intermediary table 'bar_foos' clashes with the "
  1347. "table name of 'invalid_models_tests.Foo'.",
  1348. obj=Bar._meta.get_field("foos"),
  1349. id="fields.E340",
  1350. )
  1351. ],
  1352. )
  1353. @override_settings(
  1354. DATABASE_ROUTERS=["invalid_models_tests.test_models.EmptyRouter"]
  1355. )
  1356. def test_m2m_autogenerated_table_name_clash_database_routers_installed(self):
  1357. class Foo(models.Model):
  1358. class Meta:
  1359. db_table = "bar_foos"
  1360. class Bar(models.Model):
  1361. # The autogenerated db_table is bar_foos.
  1362. foos = models.ManyToManyField(Foo)
  1363. class Meta:
  1364. db_table = "bar"
  1365. self.assertEqual(
  1366. Bar.check(),
  1367. [
  1368. Warning(
  1369. "The field's intermediary table 'bar_foos' clashes with the "
  1370. "table name of 'invalid_models_tests.Foo'.",
  1371. obj=Bar._meta.get_field("foos"),
  1372. hint=(
  1373. "You have configured settings.DATABASE_ROUTERS. Verify "
  1374. "that the table of 'invalid_models_tests.Foo' is "
  1375. "correctly routed to a separate database."
  1376. ),
  1377. id="fields.W344",
  1378. ),
  1379. ],
  1380. )
  1381. def test_m2m_unmanaged_shadow_models_not_checked(self):
  1382. class A1(models.Model):
  1383. pass
  1384. class C1(models.Model):
  1385. mm_a = models.ManyToManyField(A1, db_table="d1")
  1386. # Unmanaged models that shadow the above models. Reused table names
  1387. # shouldn't be flagged by any checks.
  1388. class A2(models.Model):
  1389. class Meta:
  1390. managed = False
  1391. class C2(models.Model):
  1392. mm_a = models.ManyToManyField(A2, through="Intermediate")
  1393. class Meta:
  1394. managed = False
  1395. class Intermediate(models.Model):
  1396. a2 = models.ForeignKey(A2, models.CASCADE, db_column="a1_id")
  1397. c2 = models.ForeignKey(C2, models.CASCADE, db_column="c1_id")
  1398. class Meta:
  1399. db_table = "d1"
  1400. managed = False
  1401. self.assertEqual(C1.check(), [])
  1402. self.assertEqual(C2.check(), [])
  1403. def test_m2m_to_concrete_and_proxy_allowed(self):
  1404. class A(models.Model):
  1405. pass
  1406. class Through(models.Model):
  1407. a = models.ForeignKey("A", models.CASCADE)
  1408. c = models.ForeignKey("C", models.CASCADE)
  1409. class ThroughProxy(Through):
  1410. class Meta:
  1411. proxy = True
  1412. class C(models.Model):
  1413. mm_a = models.ManyToManyField(A, through=Through)
  1414. mm_aproxy = models.ManyToManyField(
  1415. A, through=ThroughProxy, related_name="proxied_m2m"
  1416. )
  1417. self.assertEqual(C.check(), [])
  1418. @isolate_apps("django.contrib.auth", kwarg_name="apps")
  1419. def test_lazy_reference_checks(self, apps):
  1420. class DummyModel(models.Model):
  1421. author = models.ForeignKey("Author", models.CASCADE)
  1422. class Meta:
  1423. app_label = "invalid_models_tests"
  1424. class DummyClass:
  1425. def __call__(self, **kwargs):
  1426. pass
  1427. def dummy_method(self):
  1428. pass
  1429. def dummy_function(*args, **kwargs):
  1430. pass
  1431. apps.lazy_model_operation(dummy_function, ("auth", "imaginarymodel"))
  1432. apps.lazy_model_operation(dummy_function, ("fanciful_app", "imaginarymodel"))
  1433. post_init.connect(dummy_function, sender="missing-app.Model", apps=apps)
  1434. post_init.connect(DummyClass(), sender="missing-app.Model", apps=apps)
  1435. post_init.connect(
  1436. DummyClass().dummy_method, sender="missing-app.Model", apps=apps
  1437. )
  1438. self.assertEqual(
  1439. _check_lazy_references(apps),
  1440. [
  1441. Error(
  1442. "%r contains a lazy reference to auth.imaginarymodel, "
  1443. "but app 'auth' doesn't provide model 'imaginarymodel'."
  1444. % dummy_function,
  1445. obj=dummy_function,
  1446. id="models.E022",
  1447. ),
  1448. Error(
  1449. "%r contains a lazy reference to fanciful_app.imaginarymodel, "
  1450. "but app 'fanciful_app' isn't installed." % dummy_function,
  1451. obj=dummy_function,
  1452. id="models.E022",
  1453. ),
  1454. Error(
  1455. "An instance of class 'DummyClass' was connected to "
  1456. "the 'post_init' signal with a lazy reference to the sender "
  1457. "'missing-app.model', but app 'missing-app' isn't installed.",
  1458. hint=None,
  1459. obj="invalid_models_tests.test_models",
  1460. id="signals.E001",
  1461. ),
  1462. Error(
  1463. "Bound method 'DummyClass.dummy_method' was connected to the "
  1464. "'post_init' signal with a lazy reference to the sender "
  1465. "'missing-app.model', but app 'missing-app' isn't installed.",
  1466. hint=None,
  1467. obj="invalid_models_tests.test_models",
  1468. id="signals.E001",
  1469. ),
  1470. Error(
  1471. "The field invalid_models_tests.DummyModel.author was declared "
  1472. "with a lazy reference to 'invalid_models_tests.author', but app "
  1473. "'invalid_models_tests' isn't installed.",
  1474. hint=None,
  1475. obj=DummyModel.author.field,
  1476. id="fields.E307",
  1477. ),
  1478. Error(
  1479. "The function 'dummy_function' was connected to the 'post_init' "
  1480. "signal with a lazy reference to the sender "
  1481. "'missing-app.model', but app 'missing-app' isn't installed.",
  1482. hint=None,
  1483. obj="invalid_models_tests.test_models",
  1484. id="signals.E001",
  1485. ),
  1486. ],
  1487. )
  1488. @isolate_apps("invalid_models_tests")
  1489. class DbTableCommentTests(TestCase):
  1490. def test_db_table_comment(self):
  1491. class Model(models.Model):
  1492. class Meta:
  1493. db_table_comment = "Table comment"
  1494. errors = Model.check(databases=self.databases)
  1495. expected = (
  1496. []
  1497. if connection.features.supports_comments
  1498. else [
  1499. Warning(
  1500. f"{connection.display_name} does not support comments on tables "
  1501. f"(db_table_comment).",
  1502. obj=Model,
  1503. id="models.W046",
  1504. ),
  1505. ]
  1506. )
  1507. self.assertEqual(errors, expected)
  1508. def test_db_table_comment_required_db_features(self):
  1509. class Model(models.Model):
  1510. class Meta:
  1511. db_table_comment = "Table comment"
  1512. required_db_features = {"supports_comments"}
  1513. self.assertEqual(Model.check(databases=self.databases), [])
  1514. class MultipleAutoFieldsTests(TestCase):
  1515. def test_multiple_autofields(self):
  1516. msg = (
  1517. "Model invalid_models_tests.MultipleAutoFields can't have more "
  1518. "than one auto-generated field."
  1519. )
  1520. with self.assertRaisesMessage(ValueError, msg):
  1521. class MultipleAutoFields(models.Model):
  1522. auto1 = models.AutoField(primary_key=True)
  1523. auto2 = models.AutoField(primary_key=True)
  1524. @isolate_apps("invalid_models_tests")
  1525. class JSONFieldTests(TestCase):
  1526. @skipUnlessDBFeature("supports_json_field")
  1527. def test_ordering_pointing_to_json_field_value(self):
  1528. class Model(models.Model):
  1529. field = models.JSONField()
  1530. class Meta:
  1531. ordering = ["field__value"]
  1532. self.assertEqual(Model.check(databases=self.databases), [])
  1533. def test_check_jsonfield(self):
  1534. class Model(models.Model):
  1535. field = models.JSONField()
  1536. error = Error(
  1537. "%s does not support JSONFields." % connection.display_name,
  1538. obj=Model,
  1539. id="fields.E180",
  1540. )
  1541. expected = [] if connection.features.supports_json_field else [error]
  1542. self.assertEqual(Model.check(databases=self.databases), expected)
  1543. def test_check_jsonfield_required_db_features(self):
  1544. class Model(models.Model):
  1545. field = models.JSONField()
  1546. class Meta:
  1547. required_db_features = {"supports_json_field"}
  1548. self.assertEqual(Model.check(databases=self.databases), [])
  1549. @isolate_apps("invalid_models_tests")
  1550. class ConstraintsTests(TestCase):
  1551. def test_check_constraints(self):
  1552. class Model(models.Model):
  1553. age = models.IntegerField()
  1554. class Meta:
  1555. constraints = [
  1556. models.CheckConstraint(
  1557. condition=models.Q(age__gte=18), name="is_adult"
  1558. )
  1559. ]
  1560. errors = Model.check(databases=self.databases)
  1561. warn = Warning(
  1562. "%s does not support check constraints." % connection.display_name,
  1563. hint=(
  1564. "A constraint won't be created. Silence this warning if you "
  1565. "don't care about it."
  1566. ),
  1567. obj=Model,
  1568. id="models.W027",
  1569. )
  1570. expected = (
  1571. [] if connection.features.supports_table_check_constraints else [warn]
  1572. )
  1573. self.assertCountEqual(errors, expected)
  1574. def test_check_constraints_required_db_features(self):
  1575. class Model(models.Model):
  1576. age = models.IntegerField()
  1577. class Meta:
  1578. required_db_features = {"supports_table_check_constraints"}
  1579. constraints = [
  1580. models.CheckConstraint(
  1581. condition=models.Q(age__gte=18), name="is_adult"
  1582. )
  1583. ]
  1584. self.assertEqual(Model.check(databases=self.databases), [])
  1585. def test_check_constraint_pointing_to_missing_field(self):
  1586. class Model(models.Model):
  1587. class Meta:
  1588. required_db_features = {"supports_table_check_constraints"}
  1589. constraints = [
  1590. models.CheckConstraint(
  1591. name="name",
  1592. condition=models.Q(missing_field=2),
  1593. ),
  1594. ]
  1595. self.assertEqual(
  1596. Model.check(databases=self.databases),
  1597. (
  1598. [
  1599. Error(
  1600. "'constraints' refers to the nonexistent field "
  1601. "'missing_field'.",
  1602. obj=Model,
  1603. id="models.E012",
  1604. ),
  1605. ]
  1606. if connection.features.supports_table_check_constraints
  1607. else []
  1608. ),
  1609. )
  1610. @skipUnlessDBFeature("supports_table_check_constraints")
  1611. def test_check_constraint_pointing_to_reverse_fk(self):
  1612. class Model(models.Model):
  1613. parent = models.ForeignKey("self", models.CASCADE, related_name="parents")
  1614. class Meta:
  1615. constraints = [
  1616. models.CheckConstraint(name="name", condition=models.Q(parents=3)),
  1617. ]
  1618. self.assertEqual(
  1619. Model.check(databases=self.databases),
  1620. [
  1621. Error(
  1622. "'constraints' refers to the nonexistent field 'parents'.",
  1623. obj=Model,
  1624. id="models.E012",
  1625. ),
  1626. ],
  1627. )
  1628. @skipUnlessDBFeature("supports_table_check_constraints")
  1629. def test_check_constraint_pointing_to_reverse_o2o(self):
  1630. class Model(models.Model):
  1631. parent = models.OneToOneField("self", models.CASCADE)
  1632. class Meta:
  1633. constraints = [
  1634. models.CheckConstraint(
  1635. name="name",
  1636. condition=models.Q(model__isnull=True),
  1637. ),
  1638. ]
  1639. self.assertEqual(
  1640. Model.check(databases=self.databases),
  1641. [
  1642. Error(
  1643. "'constraints' refers to the nonexistent field 'model'.",
  1644. obj=Model,
  1645. id="models.E012",
  1646. ),
  1647. ],
  1648. )
  1649. @skipUnlessDBFeature("supports_table_check_constraints")
  1650. def test_check_constraint_pointing_to_m2m_field(self):
  1651. class Model(models.Model):
  1652. m2m = models.ManyToManyField("self")
  1653. class Meta:
  1654. constraints = [
  1655. models.CheckConstraint(name="name", condition=models.Q(m2m=2)),
  1656. ]
  1657. self.assertEqual(
  1658. Model.check(databases=self.databases),
  1659. [
  1660. Error(
  1661. "'constraints' refers to a ManyToManyField 'm2m', but "
  1662. "ManyToManyFields are not permitted in 'constraints'.",
  1663. obj=Model,
  1664. id="models.E013",
  1665. ),
  1666. ],
  1667. )
  1668. @skipUnlessDBFeature("supports_table_check_constraints")
  1669. def test_check_constraint_pointing_to_fk(self):
  1670. class Target(models.Model):
  1671. pass
  1672. class Model(models.Model):
  1673. fk_1 = models.ForeignKey(Target, models.CASCADE, related_name="target_1")
  1674. fk_2 = models.ForeignKey(Target, models.CASCADE, related_name="target_2")
  1675. class Meta:
  1676. constraints = [
  1677. models.CheckConstraint(
  1678. name="name",
  1679. condition=models.Q(fk_1_id=2) | models.Q(fk_2=2),
  1680. ),
  1681. ]
  1682. self.assertEqual(Model.check(databases=self.databases), [])
  1683. @skipUnlessDBFeature("supports_table_check_constraints")
  1684. def test_check_constraint_pointing_to_pk(self):
  1685. class Model(models.Model):
  1686. age = models.SmallIntegerField()
  1687. class Meta:
  1688. constraints = [
  1689. models.CheckConstraint(
  1690. name="name",
  1691. condition=models.Q(pk__gt=5) & models.Q(age__gt=models.F("pk")),
  1692. ),
  1693. ]
  1694. self.assertEqual(Model.check(databases=self.databases), [])
  1695. @skipUnlessDBFeature("supports_table_check_constraints")
  1696. def test_check_constraint_pointing_to_non_local_field(self):
  1697. class Parent(models.Model):
  1698. field1 = models.IntegerField()
  1699. class Child(Parent):
  1700. pass
  1701. class Meta:
  1702. constraints = [
  1703. models.CheckConstraint(name="name", condition=models.Q(field1=1)),
  1704. ]
  1705. self.assertEqual(
  1706. Child.check(databases=self.databases),
  1707. [
  1708. Error(
  1709. "'constraints' refers to field 'field1' which is not local to "
  1710. "model 'Child'.",
  1711. hint="This issue may be caused by multi-table inheritance.",
  1712. obj=Child,
  1713. id="models.E016",
  1714. ),
  1715. ],
  1716. )
  1717. @skipUnlessDBFeature("supports_table_check_constraints")
  1718. def test_check_constraint_pointing_to_joined_fields(self):
  1719. class Model(models.Model):
  1720. name = models.CharField(max_length=10)
  1721. field1 = models.PositiveSmallIntegerField()
  1722. field2 = models.PositiveSmallIntegerField()
  1723. field3 = models.PositiveSmallIntegerField()
  1724. parent = models.ForeignKey("self", models.CASCADE)
  1725. previous = models.OneToOneField("self", models.CASCADE, related_name="next")
  1726. class Meta:
  1727. constraints = [
  1728. models.CheckConstraint(
  1729. name="name1",
  1730. condition=models.Q(
  1731. field1__lt=models.F("parent__field1")
  1732. + models.F("parent__field2")
  1733. ),
  1734. ),
  1735. models.CheckConstraint(
  1736. name="name2", condition=models.Q(name=Lower("parent__name"))
  1737. ),
  1738. models.CheckConstraint(
  1739. name="name3",
  1740. condition=models.Q(parent__field3=models.F("field1")),
  1741. ),
  1742. models.CheckConstraint(
  1743. name="name4",
  1744. condition=models.Q(name=Lower("previous__name")),
  1745. ),
  1746. ]
  1747. joined_fields = [
  1748. "parent__field1",
  1749. "parent__field2",
  1750. "parent__field3",
  1751. "parent__name",
  1752. "previous__name",
  1753. ]
  1754. errors = Model.check(databases=self.databases)
  1755. expected_errors = [
  1756. Error(
  1757. "'constraints' refers to the joined field '%s'." % field_name,
  1758. obj=Model,
  1759. id="models.E041",
  1760. )
  1761. for field_name in joined_fields
  1762. ]
  1763. self.assertCountEqual(errors, expected_errors)
  1764. @skipUnlessDBFeature("supports_table_check_constraints")
  1765. def test_check_constraint_pointing_to_joined_fields_complex_check(self):
  1766. class Model(models.Model):
  1767. name = models.PositiveSmallIntegerField()
  1768. field1 = models.PositiveSmallIntegerField()
  1769. field2 = models.PositiveSmallIntegerField()
  1770. parent = models.ForeignKey("self", models.CASCADE)
  1771. class Meta:
  1772. constraints = [
  1773. models.CheckConstraint(
  1774. name="name",
  1775. condition=models.Q(
  1776. (
  1777. models.Q(name="test")
  1778. & models.Q(field1__lt=models.F("parent__field1"))
  1779. )
  1780. | (
  1781. models.Q(name__startswith=Lower("parent__name"))
  1782. & models.Q(
  1783. field1__gte=(
  1784. models.F("parent__field1")
  1785. + models.F("parent__field2")
  1786. )
  1787. )
  1788. )
  1789. )
  1790. | (models.Q(name="test1")),
  1791. ),
  1792. ]
  1793. joined_fields = ["parent__field1", "parent__field2", "parent__name"]
  1794. errors = Model.check(databases=self.databases)
  1795. expected_errors = [
  1796. Error(
  1797. "'constraints' refers to the joined field '%s'." % field_name,
  1798. obj=Model,
  1799. id="models.E041",
  1800. )
  1801. for field_name in joined_fields
  1802. ]
  1803. self.assertCountEqual(errors, expected_errors)
  1804. def test_check_constraint_raw_sql_check(self):
  1805. class Model(models.Model):
  1806. class Meta:
  1807. required_db_features = {"supports_table_check_constraints"}
  1808. constraints = [
  1809. models.CheckConstraint(
  1810. condition=models.Q(id__gt=0), name="q_check"
  1811. ),
  1812. models.CheckConstraint(
  1813. condition=models.ExpressionWrapper(
  1814. models.Q(price__gt=20),
  1815. output_field=models.BooleanField(),
  1816. ),
  1817. name="expression_wrapper_check",
  1818. ),
  1819. models.CheckConstraint(
  1820. condition=models.expressions.RawSQL(
  1821. "id = 0",
  1822. params=(),
  1823. output_field=models.BooleanField(),
  1824. ),
  1825. name="raw_sql_check",
  1826. ),
  1827. models.CheckConstraint(
  1828. condition=models.Q(
  1829. models.ExpressionWrapper(
  1830. models.Q(
  1831. models.expressions.RawSQL(
  1832. "id = 0",
  1833. params=(),
  1834. output_field=models.BooleanField(),
  1835. )
  1836. ),
  1837. output_field=models.BooleanField(),
  1838. )
  1839. ),
  1840. name="nested_raw_sql_check",
  1841. ),
  1842. ]
  1843. expected_warnings = (
  1844. [
  1845. Warning(
  1846. "Check constraint 'raw_sql_check' contains RawSQL() expression and "
  1847. "won't be validated during the model full_clean().",
  1848. hint="Silence this warning if you don't care about it.",
  1849. obj=Model,
  1850. id="models.W045",
  1851. ),
  1852. Warning(
  1853. "Check constraint 'nested_raw_sql_check' contains RawSQL() "
  1854. "expression and won't be validated during the model full_clean().",
  1855. hint="Silence this warning if you don't care about it.",
  1856. obj=Model,
  1857. id="models.W045",
  1858. ),
  1859. ]
  1860. if connection.features.supports_table_check_constraints
  1861. else []
  1862. )
  1863. self.assertEqual(Model.check(databases=self.databases), expected_warnings)
  1864. def test_unique_constraint_with_condition(self):
  1865. class Model(models.Model):
  1866. age = models.IntegerField()
  1867. class Meta:
  1868. constraints = [
  1869. models.UniqueConstraint(
  1870. fields=["age"],
  1871. name="unique_age_gte_100",
  1872. condition=models.Q(age__gte=100),
  1873. ),
  1874. ]
  1875. errors = Model.check(databases=self.databases)
  1876. expected = (
  1877. []
  1878. if connection.features.supports_partial_indexes
  1879. else [
  1880. Warning(
  1881. "%s does not support unique constraints with conditions."
  1882. % connection.display_name,
  1883. hint=(
  1884. "A constraint won't be created. Silence this warning if "
  1885. "you don't care about it."
  1886. ),
  1887. obj=Model,
  1888. id="models.W036",
  1889. ),
  1890. ]
  1891. )
  1892. self.assertEqual(errors, expected)
  1893. def test_unique_constraint_with_condition_required_db_features(self):
  1894. class Model(models.Model):
  1895. age = models.IntegerField()
  1896. class Meta:
  1897. required_db_features = {"supports_partial_indexes"}
  1898. constraints = [
  1899. models.UniqueConstraint(
  1900. fields=["age"],
  1901. name="unique_age_gte_100",
  1902. condition=models.Q(age__gte=100),
  1903. ),
  1904. ]
  1905. self.assertEqual(Model.check(databases=self.databases), [])
  1906. def test_unique_constraint_condition_pointing_to_missing_field(self):
  1907. class Model(models.Model):
  1908. age = models.SmallIntegerField()
  1909. class Meta:
  1910. required_db_features = {"supports_partial_indexes"}
  1911. constraints = [
  1912. models.UniqueConstraint(
  1913. name="name",
  1914. fields=["age"],
  1915. condition=models.Q(missing_field=2),
  1916. ),
  1917. ]
  1918. self.assertEqual(
  1919. Model.check(databases=self.databases),
  1920. (
  1921. [
  1922. Error(
  1923. "'constraints' refers to the nonexistent field "
  1924. "'missing_field'.",
  1925. obj=Model,
  1926. id="models.E012",
  1927. ),
  1928. ]
  1929. if connection.features.supports_partial_indexes
  1930. else []
  1931. ),
  1932. )
  1933. def test_unique_constraint_condition_pointing_to_joined_fields(self):
  1934. class Model(models.Model):
  1935. age = models.SmallIntegerField()
  1936. parent = models.ForeignKey("self", models.CASCADE)
  1937. class Meta:
  1938. required_db_features = {"supports_partial_indexes"}
  1939. constraints = [
  1940. models.UniqueConstraint(
  1941. name="name",
  1942. fields=["age"],
  1943. condition=models.Q(parent__age__lt=2),
  1944. ),
  1945. ]
  1946. self.assertEqual(
  1947. Model.check(databases=self.databases),
  1948. (
  1949. [
  1950. Error(
  1951. "'constraints' refers to the joined field 'parent__age__lt'.",
  1952. obj=Model,
  1953. id="models.E041",
  1954. )
  1955. ]
  1956. if connection.features.supports_partial_indexes
  1957. else []
  1958. ),
  1959. )
  1960. def test_unique_constraint_pointing_to_reverse_o2o(self):
  1961. class Model(models.Model):
  1962. parent = models.OneToOneField("self", models.CASCADE)
  1963. class Meta:
  1964. required_db_features = {"supports_partial_indexes"}
  1965. constraints = [
  1966. models.UniqueConstraint(
  1967. fields=["parent"],
  1968. name="name",
  1969. condition=models.Q(model__isnull=True),
  1970. ),
  1971. ]
  1972. self.assertEqual(
  1973. Model.check(databases=self.databases),
  1974. (
  1975. [
  1976. Error(
  1977. "'constraints' refers to the nonexistent field 'model'.",
  1978. obj=Model,
  1979. id="models.E012",
  1980. ),
  1981. ]
  1982. if connection.features.supports_partial_indexes
  1983. else []
  1984. ),
  1985. )
  1986. def test_deferrable_unique_constraint(self):
  1987. class Model(models.Model):
  1988. age = models.IntegerField()
  1989. class Meta:
  1990. constraints = [
  1991. models.UniqueConstraint(
  1992. fields=["age"],
  1993. name="unique_age_deferrable",
  1994. deferrable=models.Deferrable.DEFERRED,
  1995. ),
  1996. ]
  1997. errors = Model.check(databases=self.databases)
  1998. expected = (
  1999. []
  2000. if connection.features.supports_deferrable_unique_constraints
  2001. else [
  2002. Warning(
  2003. "%s does not support deferrable unique constraints."
  2004. % connection.display_name,
  2005. hint=(
  2006. "A constraint won't be created. Silence this warning if "
  2007. "you don't care about it."
  2008. ),
  2009. obj=Model,
  2010. id="models.W038",
  2011. ),
  2012. ]
  2013. )
  2014. self.assertEqual(errors, expected)
  2015. def test_deferrable_unique_constraint_required_db_features(self):
  2016. class Model(models.Model):
  2017. age = models.IntegerField()
  2018. class Meta:
  2019. required_db_features = {"supports_deferrable_unique_constraints"}
  2020. constraints = [
  2021. models.UniqueConstraint(
  2022. fields=["age"],
  2023. name="unique_age_deferrable",
  2024. deferrable=models.Deferrable.IMMEDIATE,
  2025. ),
  2026. ]
  2027. self.assertEqual(Model.check(databases=self.databases), [])
  2028. def test_unique_constraint_pointing_to_missing_field(self):
  2029. class Model(models.Model):
  2030. class Meta:
  2031. constraints = [
  2032. models.UniqueConstraint(fields=["missing_field"], name="name")
  2033. ]
  2034. self.assertEqual(
  2035. Model.check(databases=self.databases),
  2036. [
  2037. Error(
  2038. "'constraints' refers to the nonexistent field 'missing_field'.",
  2039. obj=Model,
  2040. id="models.E012",
  2041. ),
  2042. ],
  2043. )
  2044. def test_unique_constraint_pointing_to_m2m_field(self):
  2045. class Model(models.Model):
  2046. m2m = models.ManyToManyField("self")
  2047. class Meta:
  2048. constraints = [models.UniqueConstraint(fields=["m2m"], name="name")]
  2049. self.assertEqual(
  2050. Model.check(databases=self.databases),
  2051. [
  2052. Error(
  2053. "'constraints' refers to a ManyToManyField 'm2m', but "
  2054. "ManyToManyFields are not permitted in 'constraints'.",
  2055. obj=Model,
  2056. id="models.E013",
  2057. ),
  2058. ],
  2059. )
  2060. def test_unique_constraint_pointing_to_non_local_field(self):
  2061. class Parent(models.Model):
  2062. field1 = models.IntegerField()
  2063. class Child(Parent):
  2064. field2 = models.IntegerField()
  2065. class Meta:
  2066. constraints = [
  2067. models.UniqueConstraint(fields=["field2", "field1"], name="name"),
  2068. ]
  2069. self.assertEqual(
  2070. Child.check(databases=self.databases),
  2071. [
  2072. Error(
  2073. "'constraints' refers to field 'field1' which is not local to "
  2074. "model 'Child'.",
  2075. hint="This issue may be caused by multi-table inheritance.",
  2076. obj=Child,
  2077. id="models.E016",
  2078. ),
  2079. ],
  2080. )
  2081. def test_unique_constraint_pointing_to_fk(self):
  2082. class Target(models.Model):
  2083. pass
  2084. class Model(models.Model):
  2085. fk_1 = models.ForeignKey(Target, models.CASCADE, related_name="target_1")
  2086. fk_2 = models.ForeignKey(Target, models.CASCADE, related_name="target_2")
  2087. class Meta:
  2088. constraints = [
  2089. models.UniqueConstraint(fields=["fk_1_id", "fk_2"], name="name"),
  2090. ]
  2091. self.assertEqual(Model.check(databases=self.databases), [])
  2092. def test_unique_constraint_with_include(self):
  2093. class Model(models.Model):
  2094. age = models.IntegerField()
  2095. class Meta:
  2096. constraints = [
  2097. models.UniqueConstraint(
  2098. fields=["age"],
  2099. name="unique_age_include_id",
  2100. include=["id"],
  2101. ),
  2102. ]
  2103. errors = Model.check(databases=self.databases)
  2104. expected = (
  2105. []
  2106. if connection.features.supports_covering_indexes
  2107. else [
  2108. Warning(
  2109. "%s does not support unique constraints with non-key columns."
  2110. % connection.display_name,
  2111. hint=(
  2112. "A constraint won't be created. Silence this warning if "
  2113. "you don't care about it."
  2114. ),
  2115. obj=Model,
  2116. id="models.W039",
  2117. ),
  2118. ]
  2119. )
  2120. self.assertEqual(errors, expected)
  2121. def test_unique_constraint_with_include_required_db_features(self):
  2122. class Model(models.Model):
  2123. age = models.IntegerField()
  2124. class Meta:
  2125. required_db_features = {"supports_covering_indexes"}
  2126. constraints = [
  2127. models.UniqueConstraint(
  2128. fields=["age"],
  2129. name="unique_age_include_id",
  2130. include=["id"],
  2131. ),
  2132. ]
  2133. self.assertEqual(Model.check(databases=self.databases), [])
  2134. @skipUnlessDBFeature("supports_covering_indexes")
  2135. def test_unique_constraint_include_pointing_to_missing_field(self):
  2136. class Model(models.Model):
  2137. class Meta:
  2138. constraints = [
  2139. models.UniqueConstraint(
  2140. fields=["id"],
  2141. include=["missing_field"],
  2142. name="name",
  2143. ),
  2144. ]
  2145. self.assertEqual(
  2146. Model.check(databases=self.databases),
  2147. [
  2148. Error(
  2149. "'constraints' refers to the nonexistent field 'missing_field'.",
  2150. obj=Model,
  2151. id="models.E012",
  2152. ),
  2153. ],
  2154. )
  2155. @skipUnlessDBFeature("supports_covering_indexes")
  2156. def test_unique_constraint_include_pointing_to_m2m_field(self):
  2157. class Model(models.Model):
  2158. m2m = models.ManyToManyField("self")
  2159. class Meta:
  2160. constraints = [
  2161. models.UniqueConstraint(
  2162. fields=["id"],
  2163. include=["m2m"],
  2164. name="name",
  2165. ),
  2166. ]
  2167. self.assertEqual(
  2168. Model.check(databases=self.databases),
  2169. [
  2170. Error(
  2171. "'constraints' refers to a ManyToManyField 'm2m', but "
  2172. "ManyToManyFields are not permitted in 'constraints'.",
  2173. obj=Model,
  2174. id="models.E013",
  2175. ),
  2176. ],
  2177. )
  2178. @skipUnlessDBFeature("supports_covering_indexes")
  2179. def test_unique_constraint_include_pointing_to_non_local_field(self):
  2180. class Parent(models.Model):
  2181. field1 = models.IntegerField()
  2182. class Child(Parent):
  2183. field2 = models.IntegerField()
  2184. class Meta:
  2185. constraints = [
  2186. models.UniqueConstraint(
  2187. fields=["field2"],
  2188. include=["field1"],
  2189. name="name",
  2190. ),
  2191. ]
  2192. self.assertEqual(
  2193. Child.check(databases=self.databases),
  2194. [
  2195. Error(
  2196. "'constraints' refers to field 'field1' which is not local to "
  2197. "model 'Child'.",
  2198. hint="This issue may be caused by multi-table inheritance.",
  2199. obj=Child,
  2200. id="models.E016",
  2201. ),
  2202. ],
  2203. )
  2204. @skipUnlessDBFeature("supports_covering_indexes")
  2205. def test_unique_constraint_include_pointing_to_fk(self):
  2206. class Target(models.Model):
  2207. pass
  2208. class Model(models.Model):
  2209. fk_1 = models.ForeignKey(Target, models.CASCADE, related_name="target_1")
  2210. fk_2 = models.ForeignKey(Target, models.CASCADE, related_name="target_2")
  2211. class Meta:
  2212. constraints = [
  2213. models.UniqueConstraint(
  2214. fields=["id"],
  2215. include=["fk_1_id", "fk_2"],
  2216. name="name",
  2217. ),
  2218. ]
  2219. self.assertEqual(Model.check(databases=self.databases), [])
  2220. def test_func_unique_constraint(self):
  2221. class Model(models.Model):
  2222. name = models.CharField(max_length=10)
  2223. class Meta:
  2224. constraints = [
  2225. models.UniqueConstraint(Lower("name"), name="lower_name_uq"),
  2226. ]
  2227. warn = Warning(
  2228. "%s does not support unique constraints on expressions."
  2229. % connection.display_name,
  2230. hint=(
  2231. "A constraint won't be created. Silence this warning if you "
  2232. "don't care about it."
  2233. ),
  2234. obj=Model,
  2235. id="models.W044",
  2236. )
  2237. expected = [] if connection.features.supports_expression_indexes else [warn]
  2238. self.assertEqual(Model.check(databases=self.databases), expected)
  2239. def test_func_unique_constraint_required_db_features(self):
  2240. class Model(models.Model):
  2241. name = models.CharField(max_length=10)
  2242. class Meta:
  2243. constraints = [
  2244. models.UniqueConstraint(Lower("name"), name="lower_name_unq"),
  2245. ]
  2246. required_db_features = {"supports_expression_indexes"}
  2247. self.assertEqual(Model.check(databases=self.databases), [])
  2248. def test_unique_constraint_nulls_distinct(self):
  2249. class Model(models.Model):
  2250. name = models.CharField(max_length=10)
  2251. class Meta:
  2252. constraints = [
  2253. models.UniqueConstraint(
  2254. fields=["name"],
  2255. name="name_uq_distinct_null",
  2256. nulls_distinct=True,
  2257. ),
  2258. ]
  2259. warn = Warning(
  2260. f"{connection.display_name} does not support unique constraints with nulls "
  2261. "distinct.",
  2262. hint=(
  2263. "A constraint won't be created. Silence this warning if you don't care "
  2264. "about it."
  2265. ),
  2266. obj=Model,
  2267. id="models.W047",
  2268. )
  2269. expected = (
  2270. []
  2271. if connection.features.supports_nulls_distinct_unique_constraints
  2272. else [warn]
  2273. )
  2274. self.assertEqual(Model.check(databases=self.databases), expected)
  2275. def test_unique_constraint_nulls_distinct_required_db_features(self):
  2276. class Model(models.Model):
  2277. name = models.CharField(max_length=10)
  2278. class Meta:
  2279. constraints = [
  2280. models.UniqueConstraint(
  2281. fields=["name"],
  2282. name="name_uq_distinct_null",
  2283. nulls_distinct=True,
  2284. ),
  2285. ]
  2286. required_db_features = {"supports_nulls_distinct_unique_constraints"}
  2287. self.assertEqual(Model.check(databases=self.databases), [])
  2288. @skipUnlessDBFeature("supports_expression_indexes")
  2289. def test_func_unique_constraint_expression_custom_lookup(self):
  2290. class Model(models.Model):
  2291. height = models.IntegerField()
  2292. weight = models.IntegerField()
  2293. class Meta:
  2294. constraints = [
  2295. models.UniqueConstraint(
  2296. models.F("height")
  2297. / (models.F("weight__abs") + models.Value(5)),
  2298. name="name",
  2299. ),
  2300. ]
  2301. with register_lookup(models.IntegerField, Abs):
  2302. self.assertEqual(Model.check(databases=self.databases), [])
  2303. @skipUnlessDBFeature("supports_expression_indexes")
  2304. def test_func_unique_constraint_pointing_to_missing_field(self):
  2305. class Model(models.Model):
  2306. class Meta:
  2307. constraints = [
  2308. models.UniqueConstraint(Lower("missing_field").desc(), name="name"),
  2309. ]
  2310. self.assertEqual(
  2311. Model.check(databases=self.databases),
  2312. [
  2313. Error(
  2314. "'constraints' refers to the nonexistent field 'missing_field'.",
  2315. obj=Model,
  2316. id="models.E012",
  2317. ),
  2318. ],
  2319. )
  2320. @skipUnlessDBFeature("supports_expression_indexes")
  2321. def test_func_unique_constraint_pointing_to_missing_field_nested(self):
  2322. class Model(models.Model):
  2323. class Meta:
  2324. constraints = [
  2325. models.UniqueConstraint(Abs(Round("missing_field")), name="name"),
  2326. ]
  2327. self.assertEqual(
  2328. Model.check(databases=self.databases),
  2329. [
  2330. Error(
  2331. "'constraints' refers to the nonexistent field 'missing_field'.",
  2332. obj=Model,
  2333. id="models.E012",
  2334. ),
  2335. ],
  2336. )
  2337. @skipUnlessDBFeature("supports_expression_indexes")
  2338. def test_func_unique_constraint_pointing_to_m2m_field(self):
  2339. class Model(models.Model):
  2340. m2m = models.ManyToManyField("self")
  2341. class Meta:
  2342. constraints = [models.UniqueConstraint(Lower("m2m"), name="name")]
  2343. self.assertEqual(
  2344. Model.check(databases=self.databases),
  2345. [
  2346. Error(
  2347. "'constraints' refers to a ManyToManyField 'm2m', but "
  2348. "ManyToManyFields are not permitted in 'constraints'.",
  2349. obj=Model,
  2350. id="models.E013",
  2351. ),
  2352. ],
  2353. )
  2354. @skipUnlessDBFeature("supports_expression_indexes")
  2355. def test_func_unique_constraint_pointing_to_non_local_field(self):
  2356. class Foo(models.Model):
  2357. field1 = models.CharField(max_length=15)
  2358. class Bar(Foo):
  2359. class Meta:
  2360. constraints = [models.UniqueConstraint(Lower("field1"), name="name")]
  2361. self.assertEqual(
  2362. Bar.check(databases=self.databases),
  2363. [
  2364. Error(
  2365. "'constraints' refers to field 'field1' which is not local to "
  2366. "model 'Bar'.",
  2367. hint="This issue may be caused by multi-table inheritance.",
  2368. obj=Bar,
  2369. id="models.E016",
  2370. ),
  2371. ],
  2372. )
  2373. @skipUnlessDBFeature("supports_expression_indexes")
  2374. def test_func_unique_constraint_pointing_to_fk(self):
  2375. class Foo(models.Model):
  2376. id = models.CharField(primary_key=True, max_length=255)
  2377. class Bar(models.Model):
  2378. foo_1 = models.ForeignKey(Foo, models.CASCADE, related_name="bar_1")
  2379. foo_2 = models.ForeignKey(Foo, models.CASCADE, related_name="bar_2")
  2380. class Meta:
  2381. constraints = [
  2382. models.UniqueConstraint(
  2383. Lower("foo_1_id"),
  2384. Lower("foo_2"),
  2385. name="name",
  2386. ),
  2387. ]
  2388. self.assertEqual(Bar.check(databases=self.databases), [])