test_models.py 95 KB

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