test_models.py 91 KB

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