test_relative_fields.py 67 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775
  1. from unittest import mock
  2. from django.core.checks import Error, Warning as DjangoWarning
  3. from django.db import connection, models
  4. from django.test.testcases import SimpleTestCase
  5. from django.test.utils import isolate_apps, modify_settings, override_settings
  6. @isolate_apps('invalid_models_tests')
  7. class RelativeFieldTests(SimpleTestCase):
  8. def test_valid_foreign_key_without_accessor(self):
  9. class Target(models.Model):
  10. # There would be a clash if Model.field installed an accessor.
  11. model = models.IntegerField()
  12. class Model(models.Model):
  13. field = models.ForeignKey(Target, models.CASCADE, related_name='+')
  14. field = Model._meta.get_field('field')
  15. self.assertEqual(field.check(), [])
  16. def test_foreign_key_to_missing_model(self):
  17. # Model names are resolved when a model is being created, so we cannot
  18. # test relative fields in isolation and we need to attach them to a
  19. # model.
  20. class Model(models.Model):
  21. foreign_key = models.ForeignKey('Rel1', models.CASCADE)
  22. field = Model._meta.get_field('foreign_key')
  23. self.assertEqual(field.check(), [
  24. Error(
  25. "Field defines a relation with model 'Rel1', "
  26. "which is either not installed, or is abstract.",
  27. obj=field,
  28. id='fields.E300',
  29. ),
  30. ])
  31. @isolate_apps('invalid_models_tests')
  32. def test_foreign_key_to_isolate_apps_model(self):
  33. """
  34. #25723 - Referenced model registration lookup should be run against the
  35. field's model registry.
  36. """
  37. class OtherModel(models.Model):
  38. pass
  39. class Model(models.Model):
  40. foreign_key = models.ForeignKey('OtherModel', models.CASCADE)
  41. field = Model._meta.get_field('foreign_key')
  42. self.assertEqual(field.check(from_model=Model), [])
  43. def test_many_to_many_to_missing_model(self):
  44. class Model(models.Model):
  45. m2m = models.ManyToManyField("Rel2")
  46. field = Model._meta.get_field('m2m')
  47. self.assertEqual(field.check(from_model=Model), [
  48. Error(
  49. "Field defines a relation with model 'Rel2', "
  50. "which is either not installed, or is abstract.",
  51. obj=field,
  52. id='fields.E300',
  53. ),
  54. ])
  55. @isolate_apps('invalid_models_tests')
  56. def test_many_to_many_to_isolate_apps_model(self):
  57. """
  58. #25723 - Referenced model registration lookup should be run against the
  59. field's model registry.
  60. """
  61. class OtherModel(models.Model):
  62. pass
  63. class Model(models.Model):
  64. m2m = models.ManyToManyField('OtherModel')
  65. field = Model._meta.get_field('m2m')
  66. self.assertEqual(field.check(from_model=Model), [])
  67. def test_many_to_many_with_useless_options(self):
  68. class Model(models.Model):
  69. name = models.CharField(max_length=20)
  70. class ModelM2M(models.Model):
  71. m2m = models.ManyToManyField(Model, null=True, validators=[lambda x: x])
  72. field = ModelM2M._meta.get_field('m2m')
  73. self.assertEqual(ModelM2M.check(), [
  74. DjangoWarning(
  75. 'null has no effect on ManyToManyField.',
  76. obj=field,
  77. id='fields.W340',
  78. ),
  79. DjangoWarning(
  80. 'ManyToManyField does not support validators.',
  81. obj=field,
  82. id='fields.W341',
  83. ),
  84. ])
  85. def test_many_to_many_with_useless_related_name(self):
  86. class ModelM2M(models.Model):
  87. m2m = models.ManyToManyField('self', related_name='children')
  88. field = ModelM2M._meta.get_field('m2m')
  89. self.assertEqual(ModelM2M.check(), [
  90. DjangoWarning(
  91. 'related_name has no effect on ManyToManyField with '
  92. 'a symmetrical relationship, e.g. to "self".',
  93. obj=field,
  94. id='fields.W345',
  95. ),
  96. ])
  97. def test_ambiguous_relationship_model_from(self):
  98. class Person(models.Model):
  99. pass
  100. class Group(models.Model):
  101. field = models.ManyToManyField('Person', through='AmbiguousRelationship')
  102. class AmbiguousRelationship(models.Model):
  103. person = models.ForeignKey(Person, models.CASCADE)
  104. first_group = models.ForeignKey(Group, models.CASCADE, related_name='first')
  105. second_group = models.ForeignKey(Group, models.CASCADE, related_name='second')
  106. field = Group._meta.get_field('field')
  107. self.assertEqual(field.check(from_model=Group), [
  108. Error(
  109. "The model is used as an intermediate model by "
  110. "'invalid_models_tests.Group.field', but it has more than one "
  111. "foreign key from 'Group', which is ambiguous. You must "
  112. "specify which foreign key Django should use via the "
  113. "through_fields keyword argument.",
  114. hint=(
  115. 'If you want to create a recursive relationship, use '
  116. 'ManyToManyField("self", through="AmbiguousRelationship").'
  117. ),
  118. obj=field,
  119. id='fields.E334',
  120. ),
  121. ])
  122. def test_ambiguous_relationship_model_to(self):
  123. class Person(models.Model):
  124. pass
  125. class Group(models.Model):
  126. field = models.ManyToManyField('Person', through="AmbiguousRelationship", related_name='tertiary')
  127. class AmbiguousRelationship(models.Model):
  128. # Too much foreign keys to Person.
  129. first_person = models.ForeignKey(Person, models.CASCADE, related_name="first")
  130. second_person = models.ForeignKey(Person, models.CASCADE, related_name="second")
  131. second_model = models.ForeignKey(Group, models.CASCADE)
  132. field = Group._meta.get_field('field')
  133. self.assertEqual(field.check(from_model=Group), [
  134. Error(
  135. "The model is used as an intermediate model by "
  136. "'invalid_models_tests.Group.field', but it has more than one "
  137. "foreign key to 'Person', which is ambiguous. You must specify "
  138. "which foreign key Django should use via the through_fields "
  139. "keyword argument.",
  140. hint=(
  141. 'If you want to create a recursive relationship, use '
  142. 'ManyToManyField("self", through="AmbiguousRelationship").'
  143. ),
  144. obj=field,
  145. id='fields.E335',
  146. ),
  147. ])
  148. def test_relationship_model_with_foreign_key_to_wrong_model(self):
  149. class WrongModel(models.Model):
  150. pass
  151. class Person(models.Model):
  152. pass
  153. class Group(models.Model):
  154. members = models.ManyToManyField('Person', through="InvalidRelationship")
  155. class InvalidRelationship(models.Model):
  156. person = models.ForeignKey(Person, models.CASCADE)
  157. wrong_foreign_key = models.ForeignKey(WrongModel, models.CASCADE)
  158. # The last foreign key should point to Group model.
  159. field = Group._meta.get_field('members')
  160. self.assertEqual(field.check(from_model=Group), [
  161. Error(
  162. "The model is used as an intermediate model by "
  163. "'invalid_models_tests.Group.members', but it does not "
  164. "have a foreign key to 'Group' or 'Person'.",
  165. obj=InvalidRelationship,
  166. id='fields.E336',
  167. ),
  168. ])
  169. def test_relationship_model_missing_foreign_key(self):
  170. class Person(models.Model):
  171. pass
  172. class Group(models.Model):
  173. members = models.ManyToManyField('Person', through="InvalidRelationship")
  174. class InvalidRelationship(models.Model):
  175. group = models.ForeignKey(Group, models.CASCADE)
  176. # No foreign key to Person
  177. field = Group._meta.get_field('members')
  178. self.assertEqual(field.check(from_model=Group), [
  179. Error(
  180. "The model is used as an intermediate model by "
  181. "'invalid_models_tests.Group.members', but it does not have "
  182. "a foreign key to 'Group' or 'Person'.",
  183. obj=InvalidRelationship,
  184. id='fields.E336',
  185. ),
  186. ])
  187. def test_missing_relationship_model(self):
  188. class Person(models.Model):
  189. pass
  190. class Group(models.Model):
  191. members = models.ManyToManyField('Person', through="MissingM2MModel")
  192. field = Group._meta.get_field('members')
  193. self.assertEqual(field.check(from_model=Group), [
  194. Error(
  195. "Field specifies a many-to-many relation through model "
  196. "'MissingM2MModel', which has not been installed.",
  197. obj=field,
  198. id='fields.E331',
  199. ),
  200. ])
  201. def test_missing_relationship_model_on_model_check(self):
  202. class Person(models.Model):
  203. pass
  204. class Group(models.Model):
  205. members = models.ManyToManyField('Person', through='MissingM2MModel')
  206. self.assertEqual(Group.check(), [
  207. Error(
  208. "Field specifies a many-to-many relation through model "
  209. "'MissingM2MModel', which has not been installed.",
  210. obj=Group._meta.get_field('members'),
  211. id='fields.E331',
  212. ),
  213. ])
  214. @isolate_apps('invalid_models_tests')
  215. def test_many_to_many_through_isolate_apps_model(self):
  216. """
  217. #25723 - Through model registration lookup should be run against the
  218. field's model registry.
  219. """
  220. class GroupMember(models.Model):
  221. person = models.ForeignKey('Person', models.CASCADE)
  222. group = models.ForeignKey('Group', models.CASCADE)
  223. class Person(models.Model):
  224. pass
  225. class Group(models.Model):
  226. members = models.ManyToManyField('Person', through='GroupMember')
  227. field = Group._meta.get_field('members')
  228. self.assertEqual(field.check(from_model=Group), [])
  229. def test_too_many_foreign_keys_in_self_referential_model(self):
  230. class Person(models.Model):
  231. friends = models.ManyToManyField('self', through="InvalidRelationship", symmetrical=False)
  232. class InvalidRelationship(models.Model):
  233. first = models.ForeignKey(Person, models.CASCADE, related_name="rel_from_set_2")
  234. second = models.ForeignKey(Person, models.CASCADE, related_name="rel_to_set_2")
  235. third = models.ForeignKey(Person, models.CASCADE, related_name="too_many_by_far")
  236. field = Person._meta.get_field('friends')
  237. self.assertEqual(field.check(from_model=Person), [
  238. Error(
  239. "The model is used as an intermediate model by "
  240. "'invalid_models_tests.Person.friends', but it has more than two "
  241. "foreign keys to 'Person', which is ambiguous. You must specify "
  242. "which two foreign keys Django should use via the through_fields "
  243. "keyword argument.",
  244. hint='Use through_fields to specify which two foreign keys Django should use.',
  245. obj=InvalidRelationship,
  246. id='fields.E333',
  247. ),
  248. ])
  249. def test_foreign_key_to_abstract_model(self):
  250. class AbstractModel(models.Model):
  251. class Meta:
  252. abstract = True
  253. class Model(models.Model):
  254. rel_string_foreign_key = models.ForeignKey('AbstractModel', models.CASCADE)
  255. rel_class_foreign_key = models.ForeignKey(AbstractModel, models.CASCADE)
  256. fields = [
  257. Model._meta.get_field('rel_string_foreign_key'),
  258. Model._meta.get_field('rel_class_foreign_key'),
  259. ]
  260. expected_error = Error(
  261. "Field defines a relation with model 'AbstractModel', "
  262. "which is either not installed, or is abstract.",
  263. id='fields.E300',
  264. )
  265. for field in fields:
  266. expected_error.obj = field
  267. self.assertEqual(field.check(), [expected_error])
  268. def test_m2m_to_abstract_model(self):
  269. class AbstractModel(models.Model):
  270. class Meta:
  271. abstract = True
  272. class Model(models.Model):
  273. rel_string_m2m = models.ManyToManyField('AbstractModel')
  274. rel_class_m2m = models.ManyToManyField(AbstractModel)
  275. fields = [
  276. Model._meta.get_field('rel_string_m2m'),
  277. Model._meta.get_field('rel_class_m2m'),
  278. ]
  279. expected_error = Error(
  280. "Field defines a relation with model 'AbstractModel', "
  281. "which is either not installed, or is abstract.",
  282. id='fields.E300',
  283. )
  284. for field in fields:
  285. expected_error.obj = field
  286. self.assertEqual(field.check(from_model=Model), [expected_error])
  287. def test_unique_m2m(self):
  288. class Person(models.Model):
  289. name = models.CharField(max_length=5)
  290. class Group(models.Model):
  291. members = models.ManyToManyField('Person', unique=True)
  292. field = Group._meta.get_field('members')
  293. self.assertEqual(field.check(from_model=Group), [
  294. Error(
  295. 'ManyToManyFields cannot be unique.',
  296. obj=field,
  297. id='fields.E330',
  298. ),
  299. ])
  300. def test_foreign_key_to_non_unique_field(self):
  301. class Target(models.Model):
  302. bad = models.IntegerField() # No unique=True
  303. class Model(models.Model):
  304. foreign_key = models.ForeignKey('Target', models.CASCADE, to_field='bad')
  305. field = Model._meta.get_field('foreign_key')
  306. self.assertEqual(field.check(), [
  307. Error(
  308. "'Target.bad' must be unique because it is referenced by a foreign key.",
  309. hint=(
  310. 'Add unique=True to this field or add a UniqueConstraint '
  311. '(without condition) in the model Meta.constraints.'
  312. ),
  313. obj=field,
  314. id='fields.E311',
  315. ),
  316. ])
  317. def test_foreign_key_to_non_unique_field_under_explicit_model(self):
  318. class Target(models.Model):
  319. bad = models.IntegerField()
  320. class Model(models.Model):
  321. field = models.ForeignKey(Target, models.CASCADE, to_field='bad')
  322. field = Model._meta.get_field('field')
  323. self.assertEqual(field.check(), [
  324. Error(
  325. "'Target.bad' must be unique because it is referenced by a foreign key.",
  326. hint=(
  327. 'Add unique=True to this field or add a UniqueConstraint '
  328. '(without condition) in the model Meta.constraints.'
  329. ),
  330. obj=field,
  331. id='fields.E311',
  332. ),
  333. ])
  334. def test_foreign_key_to_partially_unique_field(self):
  335. class Target(models.Model):
  336. source = models.IntegerField()
  337. class Meta:
  338. constraints = [
  339. models.UniqueConstraint(
  340. fields=['source'],
  341. name='tfktpuf_partial_unique',
  342. condition=models.Q(pk__gt=2),
  343. ),
  344. ]
  345. class Model(models.Model):
  346. field = models.ForeignKey(Target, models.CASCADE, to_field='source')
  347. field = Model._meta.get_field('field')
  348. self.assertEqual(field.check(), [
  349. Error(
  350. "'Target.source' must be unique because it is referenced by a "
  351. "foreign key.",
  352. hint=(
  353. 'Add unique=True to this field or add a UniqueConstraint '
  354. '(without condition) in the model Meta.constraints.'
  355. ),
  356. obj=field,
  357. id='fields.E311',
  358. ),
  359. ])
  360. def test_foreign_key_to_unique_field_with_meta_constraint(self):
  361. class Target(models.Model):
  362. source = models.IntegerField()
  363. class Meta:
  364. constraints = [
  365. models.UniqueConstraint(
  366. fields=['source'],
  367. name='tfktufwmc_unique',
  368. ),
  369. ]
  370. class Model(models.Model):
  371. field = models.ForeignKey(Target, models.CASCADE, to_field='source')
  372. field = Model._meta.get_field('field')
  373. self.assertEqual(field.check(), [])
  374. def test_foreign_object_to_non_unique_fields(self):
  375. class Person(models.Model):
  376. # Note that both fields are not unique.
  377. country_id = models.IntegerField()
  378. city_id = models.IntegerField()
  379. class MMembership(models.Model):
  380. person_country_id = models.IntegerField()
  381. person_city_id = models.IntegerField()
  382. person = models.ForeignObject(
  383. Person,
  384. on_delete=models.CASCADE,
  385. from_fields=['person_country_id', 'person_city_id'],
  386. to_fields=['country_id', 'city_id'],
  387. )
  388. field = MMembership._meta.get_field('person')
  389. self.assertEqual(field.check(), [
  390. Error(
  391. "No subset of the fields 'country_id', 'city_id' on model 'Person' is unique.",
  392. hint=(
  393. 'Mark a single field as unique=True or add a set of '
  394. 'fields to a unique constraint (via unique_together or a '
  395. 'UniqueConstraint (without condition) in the model '
  396. 'Meta.constraints).'
  397. ),
  398. obj=field,
  399. id='fields.E310',
  400. )
  401. ])
  402. def test_foreign_object_to_partially_unique_field(self):
  403. class Person(models.Model):
  404. country_id = models.IntegerField()
  405. city_id = models.IntegerField()
  406. class Meta:
  407. constraints = [
  408. models.UniqueConstraint(
  409. fields=['country_id', 'city_id'],
  410. name='tfotpuf_partial_unique',
  411. condition=models.Q(pk__gt=2),
  412. ),
  413. ]
  414. class MMembership(models.Model):
  415. person_country_id = models.IntegerField()
  416. person_city_id = models.IntegerField()
  417. person = models.ForeignObject(
  418. Person,
  419. on_delete=models.CASCADE,
  420. from_fields=['person_country_id', 'person_city_id'],
  421. to_fields=['country_id', 'city_id'],
  422. )
  423. field = MMembership._meta.get_field('person')
  424. self.assertEqual(field.check(), [
  425. Error(
  426. "No subset of the fields 'country_id', 'city_id' on model "
  427. "'Person' is unique.",
  428. hint=(
  429. 'Mark a single field as unique=True or add a set of '
  430. 'fields to a unique constraint (via unique_together or a '
  431. 'UniqueConstraint (without condition) in the model '
  432. 'Meta.constraints).'
  433. ),
  434. obj=field,
  435. id='fields.E310',
  436. ),
  437. ])
  438. def test_foreign_object_to_unique_field_with_meta_constraint(self):
  439. class Person(models.Model):
  440. country_id = models.IntegerField()
  441. city_id = models.IntegerField()
  442. class Meta:
  443. constraints = [
  444. models.UniqueConstraint(
  445. fields=['country_id', 'city_id'],
  446. name='tfotpuf_unique',
  447. ),
  448. ]
  449. class MMembership(models.Model):
  450. person_country_id = models.IntegerField()
  451. person_city_id = models.IntegerField()
  452. person = models.ForeignObject(
  453. Person,
  454. on_delete=models.CASCADE,
  455. from_fields=['person_country_id', 'person_city_id'],
  456. to_fields=['country_id', 'city_id'],
  457. )
  458. field = MMembership._meta.get_field('person')
  459. self.assertEqual(field.check(), [])
  460. def test_on_delete_set_null_on_non_nullable_field(self):
  461. class Person(models.Model):
  462. pass
  463. class Model(models.Model):
  464. foreign_key = models.ForeignKey('Person', models.SET_NULL)
  465. field = Model._meta.get_field('foreign_key')
  466. self.assertEqual(field.check(), [
  467. Error(
  468. 'Field specifies on_delete=SET_NULL, but cannot be null.',
  469. hint='Set null=True argument on the field, or change the on_delete rule.',
  470. obj=field,
  471. id='fields.E320',
  472. ),
  473. ])
  474. def test_on_delete_set_default_without_default_value(self):
  475. class Person(models.Model):
  476. pass
  477. class Model(models.Model):
  478. foreign_key = models.ForeignKey('Person', models.SET_DEFAULT)
  479. field = Model._meta.get_field('foreign_key')
  480. self.assertEqual(field.check(), [
  481. Error(
  482. 'Field specifies on_delete=SET_DEFAULT, but has no default value.',
  483. hint='Set a default value, or change the on_delete rule.',
  484. obj=field,
  485. id='fields.E321',
  486. ),
  487. ])
  488. def test_nullable_primary_key(self):
  489. class Model(models.Model):
  490. field = models.IntegerField(primary_key=True, null=True)
  491. field = Model._meta.get_field('field')
  492. with mock.patch.object(connection.features, 'interprets_empty_strings_as_nulls', False):
  493. results = field.check()
  494. self.assertEqual(results, [
  495. Error(
  496. 'Primary keys must not have null=True.',
  497. hint='Set null=False on the field, or remove primary_key=True argument.',
  498. obj=field,
  499. id='fields.E007',
  500. ),
  501. ])
  502. def test_not_swapped_model(self):
  503. class SwappableModel(models.Model):
  504. # A model that can be, but isn't swapped out. References to this
  505. # model should *not* raise any validation error.
  506. class Meta:
  507. swappable = 'TEST_SWAPPABLE_MODEL'
  508. class Model(models.Model):
  509. explicit_fk = models.ForeignKey(
  510. SwappableModel,
  511. models.CASCADE,
  512. related_name='explicit_fk',
  513. )
  514. implicit_fk = models.ForeignKey(
  515. 'invalid_models_tests.SwappableModel',
  516. models.CASCADE,
  517. related_name='implicit_fk',
  518. )
  519. explicit_m2m = models.ManyToManyField(SwappableModel, related_name='explicit_m2m')
  520. implicit_m2m = models.ManyToManyField(
  521. 'invalid_models_tests.SwappableModel',
  522. related_name='implicit_m2m',
  523. )
  524. explicit_fk = Model._meta.get_field('explicit_fk')
  525. self.assertEqual(explicit_fk.check(), [])
  526. implicit_fk = Model._meta.get_field('implicit_fk')
  527. self.assertEqual(implicit_fk.check(), [])
  528. explicit_m2m = Model._meta.get_field('explicit_m2m')
  529. self.assertEqual(explicit_m2m.check(from_model=Model), [])
  530. implicit_m2m = Model._meta.get_field('implicit_m2m')
  531. self.assertEqual(implicit_m2m.check(from_model=Model), [])
  532. @override_settings(TEST_SWAPPED_MODEL='invalid_models_tests.Replacement')
  533. def test_referencing_to_swapped_model(self):
  534. class Replacement(models.Model):
  535. pass
  536. class SwappedModel(models.Model):
  537. class Meta:
  538. swappable = 'TEST_SWAPPED_MODEL'
  539. class Model(models.Model):
  540. explicit_fk = models.ForeignKey(
  541. SwappedModel,
  542. models.CASCADE,
  543. related_name='explicit_fk',
  544. )
  545. implicit_fk = models.ForeignKey(
  546. 'invalid_models_tests.SwappedModel',
  547. models.CASCADE,
  548. related_name='implicit_fk',
  549. )
  550. explicit_m2m = models.ManyToManyField(SwappedModel, related_name='explicit_m2m')
  551. implicit_m2m = models.ManyToManyField(
  552. 'invalid_models_tests.SwappedModel',
  553. related_name='implicit_m2m',
  554. )
  555. fields = [
  556. Model._meta.get_field('explicit_fk'),
  557. Model._meta.get_field('implicit_fk'),
  558. Model._meta.get_field('explicit_m2m'),
  559. Model._meta.get_field('implicit_m2m'),
  560. ]
  561. expected_error = Error(
  562. ("Field defines a relation with the model "
  563. "'invalid_models_tests.SwappedModel', which has been swapped out."),
  564. hint="Update the relation to point at 'settings.TEST_SWAPPED_MODEL'.",
  565. id='fields.E301',
  566. )
  567. for field in fields:
  568. expected_error.obj = field
  569. self.assertEqual(field.check(from_model=Model), [expected_error])
  570. def test_related_field_has_invalid_related_name(self):
  571. digit = 0
  572. illegal_non_alphanumeric = '!'
  573. whitespace = '\t'
  574. invalid_related_names = [
  575. '%s_begins_with_digit' % digit,
  576. '%s_begins_with_illegal_non_alphanumeric' % illegal_non_alphanumeric,
  577. '%s_begins_with_whitespace' % whitespace,
  578. 'contains_%s_illegal_non_alphanumeric' % illegal_non_alphanumeric,
  579. 'contains_%s_whitespace' % whitespace,
  580. 'ends_with_with_illegal_non_alphanumeric_%s' % illegal_non_alphanumeric,
  581. 'ends_with_whitespace_%s' % whitespace,
  582. 'with', # a Python keyword
  583. 'related_name\n',
  584. '',
  585. ',', # non-ASCII
  586. ]
  587. class Parent(models.Model):
  588. pass
  589. for invalid_related_name in invalid_related_names:
  590. Child = type('Child%s' % invalid_related_name, (models.Model,), {
  591. 'parent': models.ForeignKey('Parent', models.CASCADE, related_name=invalid_related_name),
  592. '__module__': Parent.__module__,
  593. })
  594. field = Child._meta.get_field('parent')
  595. self.assertEqual(Child.check(), [
  596. Error(
  597. "The name '%s' is invalid related_name for field Child%s.parent"
  598. % (invalid_related_name, invalid_related_name),
  599. hint="Related name must be a valid Python identifier or end with a '+'",
  600. obj=field,
  601. id='fields.E306',
  602. ),
  603. ])
  604. def test_related_field_has_valid_related_name(self):
  605. lowercase = 'a'
  606. uppercase = 'A'
  607. digit = 0
  608. related_names = [
  609. '%s_starts_with_lowercase' % lowercase,
  610. '%s_tarts_with_uppercase' % uppercase,
  611. '_starts_with_underscore',
  612. 'contains_%s_digit' % digit,
  613. 'ends_with_plus+',
  614. '_+',
  615. '+',
  616. '試',
  617. '試驗+',
  618. ]
  619. class Parent(models.Model):
  620. pass
  621. for related_name in related_names:
  622. Child = type('Child%s' % related_name, (models.Model,), {
  623. 'parent': models.ForeignKey('Parent', models.CASCADE, related_name=related_name),
  624. '__module__': Parent.__module__,
  625. })
  626. self.assertEqual(Child.check(), [])
  627. def test_to_fields_exist(self):
  628. class Parent(models.Model):
  629. pass
  630. class Child(models.Model):
  631. a = models.PositiveIntegerField()
  632. b = models.PositiveIntegerField()
  633. parent = models.ForeignObject(
  634. Parent,
  635. on_delete=models.SET_NULL,
  636. from_fields=('a', 'b'),
  637. to_fields=('a', 'b'),
  638. )
  639. field = Child._meta.get_field('parent')
  640. self.assertEqual(field.check(), [
  641. Error(
  642. "The to_field 'a' doesn't exist on the related model 'invalid_models_tests.Parent'.",
  643. obj=field,
  644. id='fields.E312',
  645. ),
  646. Error(
  647. "The to_field 'b' doesn't exist on the related model 'invalid_models_tests.Parent'.",
  648. obj=field,
  649. id='fields.E312',
  650. ),
  651. ])
  652. def test_to_fields_not_checked_if_related_model_doesnt_exist(self):
  653. class Child(models.Model):
  654. a = models.PositiveIntegerField()
  655. b = models.PositiveIntegerField()
  656. parent = models.ForeignObject(
  657. 'invalid_models_tests.Parent',
  658. on_delete=models.SET_NULL,
  659. from_fields=('a', 'b'),
  660. to_fields=('a', 'b'),
  661. )
  662. field = Child._meta.get_field('parent')
  663. self.assertEqual(field.check(), [
  664. Error(
  665. "Field defines a relation with model 'invalid_models_tests.Parent', "
  666. "which is either not installed, or is abstract.",
  667. id='fields.E300',
  668. obj=field,
  669. ),
  670. ])
  671. def test_invalid_related_query_name(self):
  672. class Target(models.Model):
  673. pass
  674. class Model(models.Model):
  675. first = models.ForeignKey(Target, models.CASCADE, related_name='contains__double')
  676. second = models.ForeignKey(Target, models.CASCADE, related_query_name='ends_underscore_')
  677. self.assertEqual(Model.check(), [
  678. Error(
  679. "Reverse query name 'contains__double' must not contain '__'.",
  680. hint=("Add or change a related_name or related_query_name "
  681. "argument for this field."),
  682. obj=Model._meta.get_field('first'),
  683. id='fields.E309',
  684. ),
  685. Error(
  686. "Reverse query name 'ends_underscore_' must not end with an "
  687. "underscore.",
  688. hint=("Add or change a related_name or related_query_name "
  689. "argument for this field."),
  690. obj=Model._meta.get_field('second'),
  691. id='fields.E308',
  692. ),
  693. ])
  694. @isolate_apps('invalid_models_tests')
  695. class AccessorClashTests(SimpleTestCase):
  696. def test_fk_to_integer(self):
  697. self._test_accessor_clash(
  698. target=models.IntegerField(),
  699. relative=models.ForeignKey('Target', models.CASCADE))
  700. def test_fk_to_fk(self):
  701. self._test_accessor_clash(
  702. target=models.ForeignKey('Another', models.CASCADE),
  703. relative=models.ForeignKey('Target', models.CASCADE))
  704. def test_fk_to_m2m(self):
  705. self._test_accessor_clash(
  706. target=models.ManyToManyField('Another'),
  707. relative=models.ForeignKey('Target', models.CASCADE))
  708. def test_m2m_to_integer(self):
  709. self._test_accessor_clash(
  710. target=models.IntegerField(),
  711. relative=models.ManyToManyField('Target'))
  712. def test_m2m_to_fk(self):
  713. self._test_accessor_clash(
  714. target=models.ForeignKey('Another', models.CASCADE),
  715. relative=models.ManyToManyField('Target'))
  716. def test_m2m_to_m2m(self):
  717. self._test_accessor_clash(
  718. target=models.ManyToManyField('Another'),
  719. relative=models.ManyToManyField('Target'))
  720. def _test_accessor_clash(self, target, relative):
  721. class Another(models.Model):
  722. pass
  723. class Target(models.Model):
  724. model_set = target
  725. class Model(models.Model):
  726. rel = relative
  727. self.assertEqual(Model.check(), [
  728. Error(
  729. "Reverse accessor 'Target.model_set' for "
  730. "'invalid_models_tests.Model.rel' clashes with field name "
  731. "'invalid_models_tests.Target.model_set'.",
  732. hint=(
  733. "Rename field 'invalid_models_tests.Target.model_set', or "
  734. "add/change a related_name argument to the definition for "
  735. "field 'invalid_models_tests.Model.rel'."
  736. ),
  737. obj=Model._meta.get_field('rel'),
  738. id='fields.E302',
  739. ),
  740. ])
  741. def test_clash_between_accessors(self):
  742. class Target(models.Model):
  743. pass
  744. class Model(models.Model):
  745. foreign = models.ForeignKey(Target, models.CASCADE)
  746. m2m = models.ManyToManyField(Target)
  747. self.assertEqual(Model.check(), [
  748. Error(
  749. "Reverse accessor 'Target.model_set' for "
  750. "'invalid_models_tests.Model.foreign' clashes with reverse "
  751. "accessor for 'invalid_models_tests.Model.m2m'.",
  752. hint=(
  753. "Add or change a related_name argument to the definition "
  754. "for 'invalid_models_tests.Model.foreign' or "
  755. "'invalid_models_tests.Model.m2m'."
  756. ),
  757. obj=Model._meta.get_field('foreign'),
  758. id='fields.E304',
  759. ),
  760. Error(
  761. "Reverse accessor 'Target.model_set' for "
  762. "'invalid_models_tests.Model.m2m' clashes with reverse "
  763. "accessor for 'invalid_models_tests.Model.foreign'.",
  764. hint=(
  765. "Add or change a related_name argument to the definition "
  766. "for 'invalid_models_tests.Model.m2m' or "
  767. "'invalid_models_tests.Model.foreign'."
  768. ),
  769. obj=Model._meta.get_field('m2m'),
  770. id='fields.E304',
  771. ),
  772. ])
  773. def test_m2m_to_m2m_with_inheritance(self):
  774. """ Ref #22047. """
  775. class Target(models.Model):
  776. pass
  777. class Model(models.Model):
  778. children = models.ManyToManyField('Child', related_name="m2m_clash", related_query_name="no_clash")
  779. class Parent(models.Model):
  780. m2m_clash = models.ManyToManyField('Target')
  781. class Child(Parent):
  782. pass
  783. self.assertEqual(Model.check(), [
  784. Error(
  785. "Reverse accessor 'Child.m2m_clash' for "
  786. "'invalid_models_tests.Model.children' clashes with field "
  787. "name 'invalid_models_tests.Child.m2m_clash'.",
  788. hint=(
  789. "Rename field 'invalid_models_tests.Child.m2m_clash', or "
  790. "add/change a related_name argument to the definition for "
  791. "field 'invalid_models_tests.Model.children'."
  792. ),
  793. obj=Model._meta.get_field('children'),
  794. id='fields.E302',
  795. )
  796. ])
  797. def test_no_clash_for_hidden_related_name(self):
  798. class Stub(models.Model):
  799. pass
  800. class ManyToManyRel(models.Model):
  801. thing1 = models.ManyToManyField(Stub, related_name='+')
  802. thing2 = models.ManyToManyField(Stub, related_name='+')
  803. class FKRel(models.Model):
  804. thing1 = models.ForeignKey(Stub, models.CASCADE, related_name='+')
  805. thing2 = models.ForeignKey(Stub, models.CASCADE, related_name='+')
  806. self.assertEqual(ManyToManyRel.check(), [])
  807. self.assertEqual(FKRel.check(), [])
  808. @isolate_apps('invalid_models_tests')
  809. class ReverseQueryNameClashTests(SimpleTestCase):
  810. def test_fk_to_integer(self):
  811. self._test_reverse_query_name_clash(
  812. target=models.IntegerField(),
  813. relative=models.ForeignKey('Target', models.CASCADE))
  814. def test_fk_to_fk(self):
  815. self._test_reverse_query_name_clash(
  816. target=models.ForeignKey('Another', models.CASCADE),
  817. relative=models.ForeignKey('Target', models.CASCADE))
  818. def test_fk_to_m2m(self):
  819. self._test_reverse_query_name_clash(
  820. target=models.ManyToManyField('Another'),
  821. relative=models.ForeignKey('Target', models.CASCADE))
  822. def test_m2m_to_integer(self):
  823. self._test_reverse_query_name_clash(
  824. target=models.IntegerField(),
  825. relative=models.ManyToManyField('Target'))
  826. def test_m2m_to_fk(self):
  827. self._test_reverse_query_name_clash(
  828. target=models.ForeignKey('Another', models.CASCADE),
  829. relative=models.ManyToManyField('Target'))
  830. def test_m2m_to_m2m(self):
  831. self._test_reverse_query_name_clash(
  832. target=models.ManyToManyField('Another'),
  833. relative=models.ManyToManyField('Target'))
  834. def _test_reverse_query_name_clash(self, target, relative):
  835. class Another(models.Model):
  836. pass
  837. class Target(models.Model):
  838. model = target
  839. class Model(models.Model):
  840. rel = relative
  841. self.assertEqual(Model.check(), [
  842. Error(
  843. "Reverse query name for 'invalid_models_tests.Model.rel' "
  844. "clashes with field name 'invalid_models_tests.Target.model'.",
  845. hint=(
  846. "Rename field 'invalid_models_tests.Target.model', or "
  847. "add/change a related_name argument to the definition for "
  848. "field 'invalid_models_tests.Model.rel'."
  849. ),
  850. obj=Model._meta.get_field('rel'),
  851. id='fields.E303',
  852. ),
  853. ])
  854. @modify_settings(INSTALLED_APPS={'append': 'basic'})
  855. @isolate_apps('basic', 'invalid_models_tests')
  856. def test_no_clash_across_apps_without_accessor(self):
  857. class Target(models.Model):
  858. class Meta:
  859. app_label = 'invalid_models_tests'
  860. class Model(models.Model):
  861. m2m = models.ManyToManyField(Target, related_name='+')
  862. class Meta:
  863. app_label = 'basic'
  864. def _test():
  865. # Define model with the same name.
  866. class Model(models.Model):
  867. m2m = models.ManyToManyField(Target, related_name='+')
  868. class Meta:
  869. app_label = 'invalid_models_tests'
  870. self.assertEqual(Model.check(), [])
  871. _test()
  872. self.assertEqual(Model.check(), [])
  873. @isolate_apps('invalid_models_tests')
  874. class ExplicitRelatedNameClashTests(SimpleTestCase):
  875. def test_fk_to_integer(self):
  876. self._test_explicit_related_name_clash(
  877. target=models.IntegerField(),
  878. relative=models.ForeignKey('Target', models.CASCADE, related_name='clash'))
  879. def test_fk_to_fk(self):
  880. self._test_explicit_related_name_clash(
  881. target=models.ForeignKey('Another', models.CASCADE),
  882. relative=models.ForeignKey('Target', models.CASCADE, related_name='clash'))
  883. def test_fk_to_m2m(self):
  884. self._test_explicit_related_name_clash(
  885. target=models.ManyToManyField('Another'),
  886. relative=models.ForeignKey('Target', models.CASCADE, related_name='clash'))
  887. def test_m2m_to_integer(self):
  888. self._test_explicit_related_name_clash(
  889. target=models.IntegerField(),
  890. relative=models.ManyToManyField('Target', related_name='clash'))
  891. def test_m2m_to_fk(self):
  892. self._test_explicit_related_name_clash(
  893. target=models.ForeignKey('Another', models.CASCADE),
  894. relative=models.ManyToManyField('Target', related_name='clash'))
  895. def test_m2m_to_m2m(self):
  896. self._test_explicit_related_name_clash(
  897. target=models.ManyToManyField('Another'),
  898. relative=models.ManyToManyField('Target', related_name='clash'))
  899. def _test_explicit_related_name_clash(self, target, relative):
  900. class Another(models.Model):
  901. pass
  902. class Target(models.Model):
  903. clash = target
  904. class Model(models.Model):
  905. rel = relative
  906. self.assertEqual(Model.check(), [
  907. Error(
  908. "Reverse accessor 'Target.clash' for "
  909. "'invalid_models_tests.Model.rel' clashes with field name "
  910. "'invalid_models_tests.Target.clash'.",
  911. hint=(
  912. "Rename field 'invalid_models_tests.Target.clash', or "
  913. "add/change a related_name argument to the definition for "
  914. "field 'invalid_models_tests.Model.rel'."
  915. ),
  916. obj=Model._meta.get_field('rel'),
  917. id='fields.E302',
  918. ),
  919. Error(
  920. "Reverse query name for 'invalid_models_tests.Model.rel' "
  921. "clashes with field name 'invalid_models_tests.Target.clash'.",
  922. hint=(
  923. "Rename field 'invalid_models_tests.Target.clash', or "
  924. "add/change a related_name argument to the definition for "
  925. "field 'invalid_models_tests.Model.rel'."
  926. ),
  927. obj=Model._meta.get_field('rel'),
  928. id='fields.E303',
  929. ),
  930. ])
  931. @isolate_apps('invalid_models_tests')
  932. class ExplicitRelatedQueryNameClashTests(SimpleTestCase):
  933. def test_fk_to_integer(self, related_name=None):
  934. self._test_explicit_related_query_name_clash(
  935. target=models.IntegerField(),
  936. relative=models.ForeignKey(
  937. 'Target',
  938. models.CASCADE,
  939. related_name=related_name,
  940. related_query_name='clash',
  941. )
  942. )
  943. def test_hidden_fk_to_integer(self, related_name=None):
  944. self.test_fk_to_integer(related_name='+')
  945. def test_fk_to_fk(self, related_name=None):
  946. self._test_explicit_related_query_name_clash(
  947. target=models.ForeignKey('Another', models.CASCADE),
  948. relative=models.ForeignKey(
  949. 'Target',
  950. models.CASCADE,
  951. related_name=related_name,
  952. related_query_name='clash',
  953. )
  954. )
  955. def test_hidden_fk_to_fk(self):
  956. self.test_fk_to_fk(related_name='+')
  957. def test_fk_to_m2m(self, related_name=None):
  958. self._test_explicit_related_query_name_clash(
  959. target=models.ManyToManyField('Another'),
  960. relative=models.ForeignKey(
  961. 'Target',
  962. models.CASCADE,
  963. related_name=related_name,
  964. related_query_name='clash',
  965. )
  966. )
  967. def test_hidden_fk_to_m2m(self):
  968. self.test_fk_to_m2m(related_name='+')
  969. def test_m2m_to_integer(self, related_name=None):
  970. self._test_explicit_related_query_name_clash(
  971. target=models.IntegerField(),
  972. relative=models.ManyToManyField('Target', related_name=related_name, related_query_name='clash'))
  973. def test_hidden_m2m_to_integer(self):
  974. self.test_m2m_to_integer(related_name='+')
  975. def test_m2m_to_fk(self, related_name=None):
  976. self._test_explicit_related_query_name_clash(
  977. target=models.ForeignKey('Another', models.CASCADE),
  978. relative=models.ManyToManyField('Target', related_name=related_name, related_query_name='clash'))
  979. def test_hidden_m2m_to_fk(self):
  980. self.test_m2m_to_fk(related_name='+')
  981. def test_m2m_to_m2m(self, related_name=None):
  982. self._test_explicit_related_query_name_clash(
  983. target=models.ManyToManyField('Another'),
  984. relative=models.ManyToManyField(
  985. 'Target',
  986. related_name=related_name,
  987. related_query_name='clash',
  988. )
  989. )
  990. def test_hidden_m2m_to_m2m(self):
  991. self.test_m2m_to_m2m(related_name='+')
  992. def _test_explicit_related_query_name_clash(self, target, relative):
  993. class Another(models.Model):
  994. pass
  995. class Target(models.Model):
  996. clash = target
  997. class Model(models.Model):
  998. rel = relative
  999. self.assertEqual(Model.check(), [
  1000. Error(
  1001. "Reverse query name for 'invalid_models_tests.Model.rel' "
  1002. "clashes with field name 'invalid_models_tests.Target.clash'.",
  1003. hint=(
  1004. "Rename field 'invalid_models_tests.Target.clash', or "
  1005. "add/change a related_name argument to the definition for "
  1006. "field 'invalid_models_tests.Model.rel'."
  1007. ),
  1008. obj=Model._meta.get_field('rel'),
  1009. id='fields.E303',
  1010. ),
  1011. ])
  1012. @isolate_apps('invalid_models_tests')
  1013. class SelfReferentialM2MClashTests(SimpleTestCase):
  1014. def test_clash_between_accessors(self):
  1015. class Model(models.Model):
  1016. first_m2m = models.ManyToManyField('self', symmetrical=False)
  1017. second_m2m = models.ManyToManyField('self', symmetrical=False)
  1018. self.assertEqual(Model.check(), [
  1019. Error(
  1020. "Reverse accessor 'Model.model_set' for "
  1021. "'invalid_models_tests.Model.first_m2m' clashes with reverse "
  1022. "accessor for 'invalid_models_tests.Model.second_m2m'.",
  1023. hint=(
  1024. "Add or change a related_name argument to the definition "
  1025. "for 'invalid_models_tests.Model.first_m2m' or "
  1026. "'invalid_models_tests.Model.second_m2m'."
  1027. ),
  1028. obj=Model._meta.get_field('first_m2m'),
  1029. id='fields.E304',
  1030. ),
  1031. Error(
  1032. "Reverse accessor 'Model.model_set' for "
  1033. "'invalid_models_tests.Model.second_m2m' clashes with reverse "
  1034. "accessor for 'invalid_models_tests.Model.first_m2m'.",
  1035. hint=(
  1036. "Add or change a related_name argument to the definition "
  1037. "for 'invalid_models_tests.Model.second_m2m' or "
  1038. "'invalid_models_tests.Model.first_m2m'."
  1039. ),
  1040. obj=Model._meta.get_field('second_m2m'),
  1041. id='fields.E304',
  1042. ),
  1043. ])
  1044. def test_accessor_clash(self):
  1045. class Model(models.Model):
  1046. model_set = models.ManyToManyField("self", symmetrical=False)
  1047. self.assertEqual(Model.check(), [
  1048. Error(
  1049. "Reverse accessor 'Model.model_set' for "
  1050. "'invalid_models_tests.Model.model_set' clashes with field "
  1051. "name 'invalid_models_tests.Model.model_set'.",
  1052. hint=(
  1053. "Rename field 'invalid_models_tests.Model.model_set', or "
  1054. "add/change a related_name argument to the definition for "
  1055. "field 'invalid_models_tests.Model.model_set'."
  1056. ),
  1057. obj=Model._meta.get_field('model_set'),
  1058. id='fields.E302',
  1059. ),
  1060. ])
  1061. def test_reverse_query_name_clash(self):
  1062. class Model(models.Model):
  1063. model = models.ManyToManyField("self", symmetrical=False)
  1064. self.assertEqual(Model.check(), [
  1065. Error(
  1066. "Reverse query name for 'invalid_models_tests.Model.model' "
  1067. "clashes with field name 'invalid_models_tests.Model.model'.",
  1068. hint=(
  1069. "Rename field 'invalid_models_tests.Model.model', or "
  1070. "add/change a related_name argument to the definition for "
  1071. "field 'invalid_models_tests.Model.model'."
  1072. ),
  1073. obj=Model._meta.get_field('model'),
  1074. id='fields.E303',
  1075. ),
  1076. ])
  1077. def test_clash_under_explicit_related_name(self):
  1078. class Model(models.Model):
  1079. clash = models.IntegerField()
  1080. m2m = models.ManyToManyField("self", symmetrical=False, related_name='clash')
  1081. self.assertEqual(Model.check(), [
  1082. Error(
  1083. "Reverse accessor 'Model.clash' for "
  1084. "'invalid_models_tests.Model.m2m' clashes with field name "
  1085. "'invalid_models_tests.Model.clash'.",
  1086. hint=(
  1087. "Rename field 'invalid_models_tests.Model.clash', or "
  1088. "add/change a related_name argument to the definition for "
  1089. "field 'invalid_models_tests.Model.m2m'."
  1090. ),
  1091. obj=Model._meta.get_field('m2m'),
  1092. id='fields.E302',
  1093. ),
  1094. Error(
  1095. "Reverse query name for 'invalid_models_tests.Model.m2m' "
  1096. "clashes with field name 'invalid_models_tests.Model.clash'.",
  1097. hint=(
  1098. "Rename field 'invalid_models_tests.Model.clash', or "
  1099. "add/change a related_name argument to the definition for "
  1100. "field 'invalid_models_tests.Model.m2m'."
  1101. ),
  1102. obj=Model._meta.get_field('m2m'),
  1103. id='fields.E303',
  1104. ),
  1105. ])
  1106. def test_valid_model(self):
  1107. class Model(models.Model):
  1108. first = models.ManyToManyField("self", symmetrical=False, related_name='first_accessor')
  1109. second = models.ManyToManyField("self", symmetrical=False, related_name='second_accessor')
  1110. self.assertEqual(Model.check(), [])
  1111. @isolate_apps('invalid_models_tests')
  1112. class SelfReferentialFKClashTests(SimpleTestCase):
  1113. def test_accessor_clash(self):
  1114. class Model(models.Model):
  1115. model_set = models.ForeignKey("Model", models.CASCADE)
  1116. self.assertEqual(Model.check(), [
  1117. Error(
  1118. "Reverse accessor 'Model.model_set' for "
  1119. "'invalid_models_tests.Model.model_set' clashes with field "
  1120. "name 'invalid_models_tests.Model.model_set'.",
  1121. hint=(
  1122. "Rename field 'invalid_models_tests.Model.model_set', or "
  1123. "add/change a related_name argument to the definition for "
  1124. "field 'invalid_models_tests.Model.model_set'."
  1125. ),
  1126. obj=Model._meta.get_field('model_set'),
  1127. id='fields.E302',
  1128. ),
  1129. ])
  1130. def test_reverse_query_name_clash(self):
  1131. class Model(models.Model):
  1132. model = models.ForeignKey("Model", models.CASCADE)
  1133. self.assertEqual(Model.check(), [
  1134. Error(
  1135. "Reverse query name for 'invalid_models_tests.Model.model' "
  1136. "clashes with field name 'invalid_models_tests.Model.model'.",
  1137. hint=(
  1138. "Rename field 'invalid_models_tests.Model.model', or "
  1139. "add/change a related_name argument to the definition for "
  1140. "field 'invalid_models_tests.Model.model'."
  1141. ),
  1142. obj=Model._meta.get_field('model'),
  1143. id='fields.E303',
  1144. ),
  1145. ])
  1146. def test_clash_under_explicit_related_name(self):
  1147. class Model(models.Model):
  1148. clash = models.CharField(max_length=10)
  1149. foreign = models.ForeignKey("Model", models.CASCADE, related_name='clash')
  1150. self.assertEqual(Model.check(), [
  1151. Error(
  1152. "Reverse accessor 'Model.clash' for "
  1153. "'invalid_models_tests.Model.foreign' clashes with field name "
  1154. "'invalid_models_tests.Model.clash'.",
  1155. hint=(
  1156. "Rename field 'invalid_models_tests.Model.clash', or "
  1157. "add/change a related_name argument to the definition for "
  1158. "field 'invalid_models_tests.Model.foreign'."
  1159. ),
  1160. obj=Model._meta.get_field('foreign'),
  1161. id='fields.E302',
  1162. ),
  1163. Error(
  1164. "Reverse query name for 'invalid_models_tests.Model.foreign' "
  1165. "clashes with field name 'invalid_models_tests.Model.clash'.",
  1166. hint=(
  1167. "Rename field 'invalid_models_tests.Model.clash', or "
  1168. "add/change a related_name argument to the definition for "
  1169. "field 'invalid_models_tests.Model.foreign'."
  1170. ),
  1171. obj=Model._meta.get_field('foreign'),
  1172. id='fields.E303',
  1173. ),
  1174. ])
  1175. @isolate_apps('invalid_models_tests')
  1176. class ComplexClashTests(SimpleTestCase):
  1177. # New tests should not be included here, because this is a single,
  1178. # self-contained sanity check, not a test of everything.
  1179. def test_complex_clash(self):
  1180. class Target(models.Model):
  1181. tgt_safe = models.CharField(max_length=10)
  1182. clash = models.CharField(max_length=10)
  1183. model = models.CharField(max_length=10)
  1184. clash1_set = models.CharField(max_length=10)
  1185. class Model(models.Model):
  1186. src_safe = models.CharField(max_length=10)
  1187. foreign_1 = models.ForeignKey(Target, models.CASCADE, related_name='id')
  1188. foreign_2 = models.ForeignKey(Target, models.CASCADE, related_name='src_safe')
  1189. m2m_1 = models.ManyToManyField(Target, related_name='id')
  1190. m2m_2 = models.ManyToManyField(Target, related_name='src_safe')
  1191. self.assertEqual(Model.check(), [
  1192. Error(
  1193. "Reverse accessor 'Target.id' for "
  1194. "'invalid_models_tests.Model.foreign_1' clashes with field "
  1195. "name 'invalid_models_tests.Target.id'.",
  1196. hint=(
  1197. "Rename field 'invalid_models_tests.Target.id', or "
  1198. "add/change a related_name argument to the definition for "
  1199. "field 'invalid_models_tests.Model.foreign_1'."
  1200. ),
  1201. obj=Model._meta.get_field('foreign_1'),
  1202. id='fields.E302',
  1203. ),
  1204. Error(
  1205. "Reverse query name for 'invalid_models_tests.Model.foreign_1' "
  1206. "clashes with field name 'invalid_models_tests.Target.id'.",
  1207. hint=(
  1208. "Rename field 'invalid_models_tests.Target.id', or "
  1209. "add/change a related_name argument to the definition for "
  1210. "field 'invalid_models_tests.Model.foreign_1'."
  1211. ),
  1212. obj=Model._meta.get_field('foreign_1'),
  1213. id='fields.E303',
  1214. ),
  1215. Error(
  1216. "Reverse accessor 'Target.id' for "
  1217. "'invalid_models_tests.Model.foreign_1' clashes with reverse "
  1218. "accessor for 'invalid_models_tests.Model.m2m_1'.",
  1219. hint=(
  1220. "Add or change a related_name argument to the definition "
  1221. "for 'invalid_models_tests.Model.foreign_1' or "
  1222. "'invalid_models_tests.Model.m2m_1'."
  1223. ),
  1224. obj=Model._meta.get_field('foreign_1'),
  1225. id='fields.E304',
  1226. ),
  1227. Error(
  1228. "Reverse query name for 'invalid_models_tests.Model.foreign_1' "
  1229. "clashes with reverse query name for "
  1230. "'invalid_models_tests.Model.m2m_1'.",
  1231. hint=(
  1232. "Add or change a related_name argument to the definition "
  1233. "for 'invalid_models_tests.Model.foreign_1' or "
  1234. "'invalid_models_tests.Model.m2m_1'."
  1235. ),
  1236. obj=Model._meta.get_field('foreign_1'),
  1237. id='fields.E305',
  1238. ),
  1239. Error(
  1240. "Reverse accessor 'Target.src_safe' for "
  1241. "'invalid_models_tests.Model.foreign_2' clashes with reverse "
  1242. "accessor for 'invalid_models_tests.Model.m2m_2'.",
  1243. hint=(
  1244. "Add or change a related_name argument to the definition "
  1245. "for 'invalid_models_tests.Model.foreign_2' or "
  1246. "'invalid_models_tests.Model.m2m_2'."
  1247. ),
  1248. obj=Model._meta.get_field('foreign_2'),
  1249. id='fields.E304',
  1250. ),
  1251. Error(
  1252. "Reverse query name for 'invalid_models_tests.Model.foreign_2' "
  1253. "clashes with reverse query name for "
  1254. "'invalid_models_tests.Model.m2m_2'.",
  1255. hint=(
  1256. "Add or change a related_name argument to the definition "
  1257. "for 'invalid_models_tests.Model.foreign_2' or "
  1258. "'invalid_models_tests.Model.m2m_2'."
  1259. ),
  1260. obj=Model._meta.get_field('foreign_2'),
  1261. id='fields.E305',
  1262. ),
  1263. Error(
  1264. "Reverse accessor 'Target.id' for "
  1265. "'invalid_models_tests.Model.m2m_1' clashes with field name "
  1266. "'invalid_models_tests.Target.id'.",
  1267. hint=(
  1268. "Rename field 'invalid_models_tests.Target.id', or "
  1269. "add/change a related_name argument to the definition for "
  1270. "field 'invalid_models_tests.Model.m2m_1'."
  1271. ),
  1272. obj=Model._meta.get_field('m2m_1'),
  1273. id='fields.E302',
  1274. ),
  1275. Error(
  1276. "Reverse query name for 'invalid_models_tests.Model.m2m_1' "
  1277. "clashes with field name 'invalid_models_tests.Target.id'.",
  1278. hint=(
  1279. "Rename field 'invalid_models_tests.Target.id', or "
  1280. "add/change a related_name argument to the definition for "
  1281. "field 'invalid_models_tests.Model.m2m_1'."
  1282. ),
  1283. obj=Model._meta.get_field('m2m_1'),
  1284. id='fields.E303',
  1285. ),
  1286. Error(
  1287. "Reverse accessor 'Target.id' for "
  1288. "'invalid_models_tests.Model.m2m_1' clashes with reverse "
  1289. "accessor for 'invalid_models_tests.Model.foreign_1'.",
  1290. hint=(
  1291. "Add or change a related_name argument to the definition "
  1292. "for 'invalid_models_tests.Model.m2m_1' or "
  1293. "'invalid_models_tests.Model.foreign_1'."
  1294. ),
  1295. obj=Model._meta.get_field('m2m_1'),
  1296. id='fields.E304',
  1297. ),
  1298. Error(
  1299. "Reverse query name for 'invalid_models_tests.Model.m2m_1' "
  1300. "clashes with reverse query name for "
  1301. "'invalid_models_tests.Model.foreign_1'.",
  1302. hint=(
  1303. "Add or change a related_name argument to the definition "
  1304. "for 'invalid_models_tests.Model.m2m_1' or "
  1305. "'invalid_models_tests.Model.foreign_1'."
  1306. ),
  1307. obj=Model._meta.get_field('m2m_1'),
  1308. id='fields.E305',
  1309. ),
  1310. Error(
  1311. "Reverse accessor 'Target.src_safe' for "
  1312. "'invalid_models_tests.Model.m2m_2' clashes with reverse "
  1313. "accessor for 'invalid_models_tests.Model.foreign_2'.",
  1314. hint=(
  1315. "Add or change a related_name argument to the definition "
  1316. "for 'invalid_models_tests.Model.m2m_2' or "
  1317. "'invalid_models_tests.Model.foreign_2'."
  1318. ),
  1319. obj=Model._meta.get_field('m2m_2'),
  1320. id='fields.E304',
  1321. ),
  1322. Error(
  1323. "Reverse query name for 'invalid_models_tests.Model.m2m_2' "
  1324. "clashes with reverse query name for "
  1325. "'invalid_models_tests.Model.foreign_2'.",
  1326. hint=(
  1327. "Add or change a related_name argument to the definition "
  1328. "for 'invalid_models_tests.Model.m2m_2' or "
  1329. "'invalid_models_tests.Model.foreign_2'."
  1330. ),
  1331. obj=Model._meta.get_field('m2m_2'),
  1332. id='fields.E305',
  1333. ),
  1334. ])
  1335. def test_clash_parent_link(self):
  1336. class Parent(models.Model):
  1337. pass
  1338. class Child(Parent):
  1339. other_parent = models.OneToOneField(Parent, models.CASCADE)
  1340. errors = [
  1341. ('fields.E304', 'accessor', " 'Parent.child'", 'parent_ptr', 'other_parent'),
  1342. ('fields.E305', 'query name', '', 'parent_ptr', 'other_parent'),
  1343. ('fields.E304', 'accessor', " 'Parent.child'", 'other_parent', 'parent_ptr'),
  1344. ('fields.E305', 'query name', '', 'other_parent', 'parent_ptr'),
  1345. ]
  1346. self.assertEqual(Child.check(), [
  1347. Error(
  1348. "Reverse %s%s for 'invalid_models_tests.Child.%s' clashes with "
  1349. "reverse %s for 'invalid_models_tests.Child.%s'."
  1350. % (attr, rel_name, field_name, attr, clash_name),
  1351. hint=(
  1352. "Add or change a related_name argument to the definition "
  1353. "for 'invalid_models_tests.Child.%s' or "
  1354. "'invalid_models_tests.Child.%s'." % (field_name, clash_name)
  1355. ),
  1356. obj=Child._meta.get_field(field_name),
  1357. id=error_id,
  1358. )
  1359. for error_id, attr, rel_name, field_name, clash_name in errors
  1360. ])
  1361. @isolate_apps('invalid_models_tests')
  1362. class M2mThroughFieldsTests(SimpleTestCase):
  1363. def test_m2m_field_argument_validation(self):
  1364. """
  1365. ManyToManyField accepts the ``through_fields`` kwarg
  1366. only if an intermediary table is specified.
  1367. """
  1368. class Fan(models.Model):
  1369. pass
  1370. with self.assertRaisesMessage(ValueError, 'Cannot specify through_fields without a through model'):
  1371. models.ManyToManyField(Fan, through_fields=('f1', 'f2'))
  1372. def test_invalid_order(self):
  1373. """
  1374. Mixing up the order of link fields to ManyToManyField.through_fields
  1375. triggers validation errors.
  1376. """
  1377. class Fan(models.Model):
  1378. pass
  1379. class Event(models.Model):
  1380. invitees = models.ManyToManyField(Fan, through='Invitation', through_fields=('invitee', 'event'))
  1381. class Invitation(models.Model):
  1382. event = models.ForeignKey(Event, models.CASCADE)
  1383. invitee = models.ForeignKey(Fan, models.CASCADE)
  1384. inviter = models.ForeignKey(Fan, models.CASCADE, related_name='+')
  1385. field = Event._meta.get_field('invitees')
  1386. self.assertEqual(field.check(from_model=Event), [
  1387. Error(
  1388. "'Invitation.invitee' is not a foreign key to 'Event'.",
  1389. hint="Did you mean one of the following foreign keys to 'Event': event?",
  1390. obj=field,
  1391. id='fields.E339',
  1392. ),
  1393. Error(
  1394. "'Invitation.event' is not a foreign key to 'Fan'.",
  1395. hint="Did you mean one of the following foreign keys to 'Fan': invitee, inviter?",
  1396. obj=field,
  1397. id='fields.E339',
  1398. ),
  1399. ])
  1400. def test_invalid_field(self):
  1401. """
  1402. Providing invalid field names to ManyToManyField.through_fields
  1403. triggers validation errors.
  1404. """
  1405. class Fan(models.Model):
  1406. pass
  1407. class Event(models.Model):
  1408. invitees = models.ManyToManyField(
  1409. Fan,
  1410. through='Invitation',
  1411. through_fields=('invalid_field_1', 'invalid_field_2'),
  1412. )
  1413. class Invitation(models.Model):
  1414. event = models.ForeignKey(Event, models.CASCADE)
  1415. invitee = models.ForeignKey(Fan, models.CASCADE)
  1416. inviter = models.ForeignKey(Fan, models.CASCADE, related_name='+')
  1417. field = Event._meta.get_field('invitees')
  1418. self.assertEqual(field.check(from_model=Event), [
  1419. Error(
  1420. "The intermediary model 'invalid_models_tests.Invitation' has no field 'invalid_field_1'.",
  1421. hint="Did you mean one of the following foreign keys to 'Event': event?",
  1422. obj=field,
  1423. id='fields.E338',
  1424. ),
  1425. Error(
  1426. "The intermediary model 'invalid_models_tests.Invitation' has no field 'invalid_field_2'.",
  1427. hint="Did you mean one of the following foreign keys to 'Fan': invitee, inviter?",
  1428. obj=field,
  1429. id='fields.E338',
  1430. ),
  1431. ])
  1432. def test_explicit_field_names(self):
  1433. """
  1434. If ``through_fields`` kwarg is given, it must specify both
  1435. link fields of the intermediary table.
  1436. """
  1437. class Fan(models.Model):
  1438. pass
  1439. class Event(models.Model):
  1440. invitees = models.ManyToManyField(Fan, through='Invitation', through_fields=(None, 'invitee'))
  1441. class Invitation(models.Model):
  1442. event = models.ForeignKey(Event, models.CASCADE)
  1443. invitee = models.ForeignKey(Fan, models.CASCADE)
  1444. inviter = models.ForeignKey(Fan, models.CASCADE, related_name='+')
  1445. field = Event._meta.get_field('invitees')
  1446. self.assertEqual(field.check(from_model=Event), [
  1447. Error(
  1448. "Field specifies 'through_fields' but does not provide the names "
  1449. "of the two link fields that should be used for the relation "
  1450. "through model 'invalid_models_tests.Invitation'.",
  1451. hint="Make sure you specify 'through_fields' as through_fields=('field1', 'field2')",
  1452. obj=field,
  1453. id='fields.E337',
  1454. ),
  1455. ])
  1456. def test_superset_foreign_object(self):
  1457. class Parent(models.Model):
  1458. a = models.PositiveIntegerField()
  1459. b = models.PositiveIntegerField()
  1460. c = models.PositiveIntegerField()
  1461. class Meta:
  1462. unique_together = (('a', 'b', 'c'),)
  1463. class Child(models.Model):
  1464. a = models.PositiveIntegerField()
  1465. b = models.PositiveIntegerField()
  1466. value = models.CharField(max_length=255)
  1467. parent = models.ForeignObject(
  1468. Parent,
  1469. on_delete=models.SET_NULL,
  1470. from_fields=('a', 'b'),
  1471. to_fields=('a', 'b'),
  1472. related_name='children',
  1473. )
  1474. field = Child._meta.get_field('parent')
  1475. self.assertEqual(field.check(from_model=Child), [
  1476. Error(
  1477. "No subset of the fields 'a', 'b' on model 'Parent' is unique.",
  1478. hint=(
  1479. 'Mark a single field as unique=True or add a set of '
  1480. 'fields to a unique constraint (via unique_together or a '
  1481. 'UniqueConstraint (without condition) in the model '
  1482. 'Meta.constraints).'
  1483. ),
  1484. obj=field,
  1485. id='fields.E310',
  1486. ),
  1487. ])
  1488. def test_intersection_foreign_object(self):
  1489. class Parent(models.Model):
  1490. a = models.PositiveIntegerField()
  1491. b = models.PositiveIntegerField()
  1492. c = models.PositiveIntegerField()
  1493. d = models.PositiveIntegerField()
  1494. class Meta:
  1495. unique_together = (('a', 'b', 'c'),)
  1496. class Child(models.Model):
  1497. a = models.PositiveIntegerField()
  1498. b = models.PositiveIntegerField()
  1499. d = models.PositiveIntegerField()
  1500. value = models.CharField(max_length=255)
  1501. parent = models.ForeignObject(
  1502. Parent,
  1503. on_delete=models.SET_NULL,
  1504. from_fields=('a', 'b', 'd'),
  1505. to_fields=('a', 'b', 'd'),
  1506. related_name='children',
  1507. )
  1508. field = Child._meta.get_field('parent')
  1509. self.assertEqual(field.check(from_model=Child), [
  1510. Error(
  1511. "No subset of the fields 'a', 'b', 'd' on model 'Parent' is unique.",
  1512. hint=(
  1513. 'Mark a single field as unique=True or add a set of '
  1514. 'fields to a unique constraint (via unique_together or a '
  1515. 'UniqueConstraint (without condition) in the model '
  1516. 'Meta.constraints).'
  1517. ),
  1518. obj=field,
  1519. id='fields.E310',
  1520. ),
  1521. ])