tests.py 80 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937
  1. import datetime
  2. from unittest import mock
  3. from django.contrib import admin
  4. from django.contrib.admin.models import LogEntry
  5. from django.contrib.admin.options import IncorrectLookupParameters
  6. from django.contrib.admin.templatetags.admin_list import pagination
  7. from django.contrib.admin.tests import AdminSeleniumTestCase
  8. from django.contrib.admin.views.main import (
  9. ALL_VAR,
  10. IS_POPUP_VAR,
  11. ORDER_VAR,
  12. PAGE_VAR,
  13. SEARCH_VAR,
  14. TO_FIELD_VAR,
  15. )
  16. from django.contrib.auth.models import User
  17. from django.contrib.contenttypes.models import ContentType
  18. from django.contrib.messages.storage.cookie import CookieStorage
  19. from django.db import DatabaseError, connection, models
  20. from django.db.models import F, Field, IntegerField
  21. from django.db.models.functions import Upper
  22. from django.db.models.lookups import Contains, Exact
  23. from django.template import Context, Template, TemplateSyntaxError
  24. from django.test import TestCase, override_settings, skipUnlessDBFeature
  25. from django.test.client import RequestFactory
  26. from django.test.utils import CaptureQueriesContext, isolate_apps, register_lookup
  27. from django.urls import reverse
  28. from django.utils import formats
  29. from .admin import (
  30. BandAdmin,
  31. ChildAdmin,
  32. ChordsBandAdmin,
  33. ConcertAdmin,
  34. CustomPaginationAdmin,
  35. CustomPaginator,
  36. DynamicListDisplayChildAdmin,
  37. DynamicListDisplayLinksChildAdmin,
  38. DynamicListFilterChildAdmin,
  39. DynamicSearchFieldsChildAdmin,
  40. EmptyValueChildAdmin,
  41. EventAdmin,
  42. FilteredChildAdmin,
  43. GroupAdmin,
  44. InvitationAdmin,
  45. NoListDisplayLinksParentAdmin,
  46. ParentAdmin,
  47. ParentAdminTwoSearchFields,
  48. QuartetAdmin,
  49. SwallowAdmin,
  50. )
  51. from .admin import site as custom_site
  52. from .models import (
  53. Band,
  54. CharPK,
  55. Child,
  56. ChordsBand,
  57. ChordsMusician,
  58. Concert,
  59. CustomIdUser,
  60. Event,
  61. Genre,
  62. Group,
  63. Invitation,
  64. Membership,
  65. Musician,
  66. OrderedObject,
  67. Parent,
  68. Quartet,
  69. Swallow,
  70. SwallowOneToOne,
  71. UnorderedObject,
  72. )
  73. def build_tbody_html(pk, href, extra_fields):
  74. return (
  75. "<tbody><tr>"
  76. '<td class="action-checkbox">'
  77. '<input type="checkbox" name="_selected_action" value="{}" '
  78. 'class="action-select"></td>'
  79. '<th class="field-name"><a href="{}">name</a></th>'
  80. "{}</tr></tbody>"
  81. ).format(pk, href, extra_fields)
  82. @override_settings(ROOT_URLCONF="admin_changelist.urls")
  83. class ChangeListTests(TestCase):
  84. factory = RequestFactory()
  85. @classmethod
  86. def setUpTestData(cls):
  87. cls.superuser = User.objects.create_superuser(
  88. username="super", email="a@b.com", password="xxx"
  89. )
  90. def _create_superuser(self, username):
  91. return User.objects.create_superuser(
  92. username=username, email="a@b.com", password="xxx"
  93. )
  94. def _mocked_authenticated_request(self, url, user):
  95. request = self.factory.get(url)
  96. request.user = user
  97. return request
  98. def test_repr(self):
  99. m = ChildAdmin(Child, custom_site)
  100. request = self.factory.get("/child/")
  101. request.user = self.superuser
  102. cl = m.get_changelist_instance(request)
  103. self.assertEqual(repr(cl), "<ChangeList: model=Child model_admin=ChildAdmin>")
  104. def test_specified_ordering_by_f_expression(self):
  105. class OrderedByFBandAdmin(admin.ModelAdmin):
  106. list_display = ["name", "genres", "nr_of_members"]
  107. ordering = (
  108. F("nr_of_members").desc(nulls_last=True),
  109. Upper(F("name")).asc(),
  110. F("genres").asc(),
  111. )
  112. m = OrderedByFBandAdmin(Band, custom_site)
  113. request = self.factory.get("/band/")
  114. request.user = self.superuser
  115. cl = m.get_changelist_instance(request)
  116. self.assertEqual(cl.get_ordering_field_columns(), {3: "desc", 2: "asc"})
  117. def test_specified_ordering_by_f_expression_without_asc_desc(self):
  118. class OrderedByFBandAdmin(admin.ModelAdmin):
  119. list_display = ["name", "genres", "nr_of_members"]
  120. ordering = (F("nr_of_members"), Upper("name"), F("genres"))
  121. m = OrderedByFBandAdmin(Band, custom_site)
  122. request = self.factory.get("/band/")
  123. request.user = self.superuser
  124. cl = m.get_changelist_instance(request)
  125. self.assertEqual(cl.get_ordering_field_columns(), {3: "asc", 2: "asc"})
  126. def test_select_related_preserved(self):
  127. """
  128. Regression test for #10348: ChangeList.get_queryset() shouldn't
  129. overwrite a custom select_related provided by ModelAdmin.get_queryset().
  130. """
  131. m = ChildAdmin(Child, custom_site)
  132. request = self.factory.get("/child/")
  133. request.user = self.superuser
  134. cl = m.get_changelist_instance(request)
  135. self.assertEqual(cl.queryset.query.select_related, {"parent": {}})
  136. def test_select_related_preserved_when_multi_valued_in_search_fields(self):
  137. parent = Parent.objects.create(name="Mary")
  138. Child.objects.create(parent=parent, name="Danielle")
  139. Child.objects.create(parent=parent, name="Daniel")
  140. m = ParentAdmin(Parent, custom_site)
  141. request = self.factory.get("/parent/", data={SEARCH_VAR: "daniel"})
  142. request.user = self.superuser
  143. cl = m.get_changelist_instance(request)
  144. self.assertEqual(cl.queryset.count(), 1)
  145. # select_related is preserved.
  146. self.assertEqual(cl.queryset.query.select_related, {"child": {}})
  147. def test_select_related_as_tuple(self):
  148. ia = InvitationAdmin(Invitation, custom_site)
  149. request = self.factory.get("/invitation/")
  150. request.user = self.superuser
  151. cl = ia.get_changelist_instance(request)
  152. self.assertEqual(cl.queryset.query.select_related, {"player": {}})
  153. def test_select_related_as_empty_tuple(self):
  154. ia = InvitationAdmin(Invitation, custom_site)
  155. ia.list_select_related = ()
  156. request = self.factory.get("/invitation/")
  157. request.user = self.superuser
  158. cl = ia.get_changelist_instance(request)
  159. self.assertIs(cl.queryset.query.select_related, False)
  160. def test_get_select_related_custom_method(self):
  161. class GetListSelectRelatedAdmin(admin.ModelAdmin):
  162. list_display = ("band", "player")
  163. def get_list_select_related(self, request):
  164. return ("band", "player")
  165. ia = GetListSelectRelatedAdmin(Invitation, custom_site)
  166. request = self.factory.get("/invitation/")
  167. request.user = self.superuser
  168. cl = ia.get_changelist_instance(request)
  169. self.assertEqual(cl.queryset.query.select_related, {"player": {}, "band": {}})
  170. def test_many_search_terms(self):
  171. parent = Parent.objects.create(name="Mary")
  172. Child.objects.create(parent=parent, name="Danielle")
  173. Child.objects.create(parent=parent, name="Daniel")
  174. m = ParentAdmin(Parent, custom_site)
  175. request = self.factory.get("/parent/", data={SEARCH_VAR: "daniel " * 80})
  176. request.user = self.superuser
  177. cl = m.get_changelist_instance(request)
  178. with CaptureQueriesContext(connection) as context:
  179. object_count = cl.queryset.count()
  180. self.assertEqual(object_count, 1)
  181. self.assertEqual(context.captured_queries[0]["sql"].count("JOIN"), 1)
  182. def test_related_field_multiple_search_terms(self):
  183. """
  184. Searches over multi-valued relationships return rows from related
  185. models only when all searched fields match that row.
  186. """
  187. parent = Parent.objects.create(name="Mary")
  188. Child.objects.create(parent=parent, name="Danielle", age=18)
  189. Child.objects.create(parent=parent, name="Daniel", age=19)
  190. m = ParentAdminTwoSearchFields(Parent, custom_site)
  191. request = self.factory.get("/parent/", data={SEARCH_VAR: "danielle 19"})
  192. request.user = self.superuser
  193. cl = m.get_changelist_instance(request)
  194. self.assertEqual(cl.queryset.count(), 0)
  195. request = self.factory.get("/parent/", data={SEARCH_VAR: "daniel 19"})
  196. request.user = self.superuser
  197. cl = m.get_changelist_instance(request)
  198. self.assertEqual(cl.queryset.count(), 1)
  199. def test_result_list_empty_changelist_value(self):
  200. """
  201. Regression test for #14982: EMPTY_CHANGELIST_VALUE should be honored
  202. for relationship fields
  203. """
  204. new_child = Child.objects.create(name="name", parent=None)
  205. request = self.factory.get("/child/")
  206. request.user = self.superuser
  207. m = ChildAdmin(Child, custom_site)
  208. cl = m.get_changelist_instance(request)
  209. cl.formset = None
  210. template = Template(
  211. "{% load admin_list %}{% spaceless %}{% result_list cl %}{% endspaceless %}"
  212. )
  213. context = Context({"cl": cl, "opts": Child._meta})
  214. table_output = template.render(context)
  215. link = reverse("admin:admin_changelist_child_change", args=(new_child.id,))
  216. row_html = build_tbody_html(
  217. new_child.id, link, '<td class="field-parent nowrap">-</td>'
  218. )
  219. self.assertNotEqual(
  220. table_output.find(row_html),
  221. -1,
  222. "Failed to find expected row element: %s" % table_output,
  223. )
  224. def test_result_list_set_empty_value_display_on_admin_site(self):
  225. """
  226. Empty value display can be set on AdminSite.
  227. """
  228. new_child = Child.objects.create(name="name", parent=None)
  229. request = self.factory.get("/child/")
  230. request.user = self.superuser
  231. # Set a new empty display value on AdminSite.
  232. admin.site.empty_value_display = "???"
  233. m = ChildAdmin(Child, admin.site)
  234. cl = m.get_changelist_instance(request)
  235. cl.formset = None
  236. template = Template(
  237. "{% load admin_list %}{% spaceless %}{% result_list cl %}{% endspaceless %}"
  238. )
  239. context = Context({"cl": cl, "opts": Child._meta})
  240. table_output = template.render(context)
  241. link = reverse("admin:admin_changelist_child_change", args=(new_child.id,))
  242. row_html = build_tbody_html(
  243. new_child.id, link, '<td class="field-parent nowrap">???</td>'
  244. )
  245. self.assertNotEqual(
  246. table_output.find(row_html),
  247. -1,
  248. "Failed to find expected row element: %s" % table_output,
  249. )
  250. def test_result_list_set_empty_value_display_in_model_admin(self):
  251. """
  252. Empty value display can be set in ModelAdmin or individual fields.
  253. """
  254. new_child = Child.objects.create(name="name", parent=None)
  255. request = self.factory.get("/child/")
  256. request.user = self.superuser
  257. m = EmptyValueChildAdmin(Child, admin.site)
  258. cl = m.get_changelist_instance(request)
  259. cl.formset = None
  260. template = Template(
  261. "{% load admin_list %}{% spaceless %}{% result_list cl %}{% endspaceless %}"
  262. )
  263. context = Context({"cl": cl, "opts": Child._meta})
  264. table_output = template.render(context)
  265. link = reverse("admin:admin_changelist_child_change", args=(new_child.id,))
  266. row_html = build_tbody_html(
  267. new_child.id,
  268. link,
  269. '<td class="field-age_display">&amp;dagger;</td>'
  270. '<td class="field-age">-empty-</td>',
  271. )
  272. self.assertNotEqual(
  273. table_output.find(row_html),
  274. -1,
  275. "Failed to find expected row element: %s" % table_output,
  276. )
  277. def test_result_list_html(self):
  278. """
  279. Inclusion tag result_list generates a table when with default
  280. ModelAdmin settings.
  281. """
  282. new_parent = Parent.objects.create(name="parent")
  283. new_child = Child.objects.create(name="name", parent=new_parent)
  284. request = self.factory.get("/child/")
  285. request.user = self.superuser
  286. m = ChildAdmin(Child, custom_site)
  287. cl = m.get_changelist_instance(request)
  288. cl.formset = None
  289. template = Template(
  290. "{% load admin_list %}{% spaceless %}{% result_list cl %}{% endspaceless %}"
  291. )
  292. context = Context({"cl": cl, "opts": Child._meta})
  293. table_output = template.render(context)
  294. link = reverse("admin:admin_changelist_child_change", args=(new_child.id,))
  295. row_html = build_tbody_html(
  296. new_child.id, link, '<td class="field-parent nowrap">%s</td>' % new_parent
  297. )
  298. self.assertNotEqual(
  299. table_output.find(row_html),
  300. -1,
  301. "Failed to find expected row element: %s" % table_output,
  302. )
  303. def test_result_list_editable_html(self):
  304. """
  305. Regression tests for #11791: Inclusion tag result_list generates a
  306. table and this checks that the items are nested within the table
  307. element tags.
  308. Also a regression test for #13599, verifies that hidden fields
  309. when list_editable is enabled are rendered in a div outside the
  310. table.
  311. """
  312. new_parent = Parent.objects.create(name="parent")
  313. new_child = Child.objects.create(name="name", parent=new_parent)
  314. request = self.factory.get("/child/")
  315. request.user = self.superuser
  316. m = ChildAdmin(Child, custom_site)
  317. # Test with list_editable fields
  318. m.list_display = ["id", "name", "parent"]
  319. m.list_display_links = ["id"]
  320. m.list_editable = ["name"]
  321. cl = m.get_changelist_instance(request)
  322. FormSet = m.get_changelist_formset(request)
  323. cl.formset = FormSet(queryset=cl.result_list)
  324. template = Template(
  325. "{% load admin_list %}{% spaceless %}{% result_list cl %}{% endspaceless %}"
  326. )
  327. context = Context({"cl": cl, "opts": Child._meta})
  328. table_output = template.render(context)
  329. # make sure that hidden fields are in the correct place
  330. hiddenfields_div = (
  331. '<div class="hiddenfields">'
  332. '<input type="hidden" name="form-0-id" value="%d" id="id_form-0-id">'
  333. "</div>"
  334. ) % new_child.id
  335. self.assertInHTML(
  336. hiddenfields_div, table_output, msg_prefix="Failed to find hidden fields"
  337. )
  338. # make sure that list editable fields are rendered in divs correctly
  339. editable_name_field = (
  340. '<input name="form-0-name" value="name" class="vTextField" '
  341. 'maxlength="30" type="text" id="id_form-0-name">'
  342. )
  343. self.assertInHTML(
  344. '<td class="field-name">%s</td>' % editable_name_field,
  345. table_output,
  346. msg_prefix='Failed to find "name" list_editable field',
  347. )
  348. def test_result_list_editable(self):
  349. """
  350. Regression test for #14312: list_editable with pagination
  351. """
  352. new_parent = Parent.objects.create(name="parent")
  353. for i in range(1, 201):
  354. Child.objects.create(name="name %s" % i, parent=new_parent)
  355. request = self.factory.get("/child/", data={"p": -1}) # Anything outside range
  356. request.user = self.superuser
  357. m = ChildAdmin(Child, custom_site)
  358. # Test with list_editable fields
  359. m.list_display = ["id", "name", "parent"]
  360. m.list_display_links = ["id"]
  361. m.list_editable = ["name"]
  362. with self.assertRaises(IncorrectLookupParameters):
  363. m.get_changelist_instance(request)
  364. @skipUnlessDBFeature("supports_transactions")
  365. def test_list_editable_atomicity(self):
  366. a = Swallow.objects.create(origin="Swallow A", load=4, speed=1)
  367. b = Swallow.objects.create(origin="Swallow B", load=2, speed=2)
  368. self.client.force_login(self.superuser)
  369. changelist_url = reverse("admin:admin_changelist_swallow_changelist")
  370. data = {
  371. "form-TOTAL_FORMS": "2",
  372. "form-INITIAL_FORMS": "2",
  373. "form-MIN_NUM_FORMS": "0",
  374. "form-MAX_NUM_FORMS": "1000",
  375. "form-0-uuid": str(a.pk),
  376. "form-1-uuid": str(b.pk),
  377. "form-0-load": "9.0",
  378. "form-0-speed": "3.0",
  379. "form-1-load": "5.0",
  380. "form-1-speed": "1.0",
  381. "_save": "Save",
  382. }
  383. with mock.patch(
  384. "django.contrib.admin.ModelAdmin.log_change", side_effect=DatabaseError
  385. ):
  386. with self.assertRaises(DatabaseError):
  387. self.client.post(changelist_url, data)
  388. # Original values are preserved.
  389. a.refresh_from_db()
  390. self.assertEqual(a.load, 4)
  391. self.assertEqual(a.speed, 1)
  392. b.refresh_from_db()
  393. self.assertEqual(b.load, 2)
  394. self.assertEqual(b.speed, 2)
  395. with mock.patch(
  396. "django.contrib.admin.ModelAdmin.log_change",
  397. side_effect=[None, DatabaseError],
  398. ):
  399. with self.assertRaises(DatabaseError):
  400. self.client.post(changelist_url, data)
  401. # Original values are preserved.
  402. a.refresh_from_db()
  403. self.assertEqual(a.load, 4)
  404. self.assertEqual(a.speed, 1)
  405. b.refresh_from_db()
  406. self.assertEqual(b.load, 2)
  407. self.assertEqual(b.speed, 2)
  408. def test_custom_paginator(self):
  409. new_parent = Parent.objects.create(name="parent")
  410. for i in range(1, 201):
  411. Child.objects.create(name="name %s" % i, parent=new_parent)
  412. request = self.factory.get("/child/")
  413. request.user = self.superuser
  414. m = CustomPaginationAdmin(Child, custom_site)
  415. cl = m.get_changelist_instance(request)
  416. cl.get_results(request)
  417. self.assertIsInstance(cl.paginator, CustomPaginator)
  418. def test_no_duplicates_for_m2m_in_list_filter(self):
  419. """
  420. Regression test for #13902: When using a ManyToMany in list_filter,
  421. results shouldn't appear more than once. Basic ManyToMany.
  422. """
  423. blues = Genre.objects.create(name="Blues")
  424. band = Band.objects.create(name="B.B. King Review", nr_of_members=11)
  425. band.genres.add(blues)
  426. band.genres.add(blues)
  427. m = BandAdmin(Band, custom_site)
  428. request = self.factory.get("/band/", data={"genres": blues.pk})
  429. request.user = self.superuser
  430. cl = m.get_changelist_instance(request)
  431. cl.get_results(request)
  432. # There's only one Group instance
  433. self.assertEqual(cl.result_count, 1)
  434. # Queryset must be deletable.
  435. self.assertIs(cl.queryset.query.distinct, False)
  436. cl.queryset.delete()
  437. self.assertEqual(cl.queryset.count(), 0)
  438. def test_no_duplicates_for_through_m2m_in_list_filter(self):
  439. """
  440. Regression test for #13902: When using a ManyToMany in list_filter,
  441. results shouldn't appear more than once. With an intermediate model.
  442. """
  443. lead = Musician.objects.create(name="Vox")
  444. band = Group.objects.create(name="The Hype")
  445. Membership.objects.create(group=band, music=lead, role="lead voice")
  446. Membership.objects.create(group=band, music=lead, role="bass player")
  447. m = GroupAdmin(Group, custom_site)
  448. request = self.factory.get("/group/", data={"members": lead.pk})
  449. request.user = self.superuser
  450. cl = m.get_changelist_instance(request)
  451. cl.get_results(request)
  452. # There's only one Group instance
  453. self.assertEqual(cl.result_count, 1)
  454. # Queryset must be deletable.
  455. self.assertIs(cl.queryset.query.distinct, False)
  456. cl.queryset.delete()
  457. self.assertEqual(cl.queryset.count(), 0)
  458. def test_no_duplicates_for_through_m2m_at_second_level_in_list_filter(self):
  459. """
  460. When using a ManyToMany in list_filter at the second level behind a
  461. ForeignKey, results shouldn't appear more than once.
  462. """
  463. lead = Musician.objects.create(name="Vox")
  464. band = Group.objects.create(name="The Hype")
  465. Concert.objects.create(name="Woodstock", group=band)
  466. Membership.objects.create(group=band, music=lead, role="lead voice")
  467. Membership.objects.create(group=band, music=lead, role="bass player")
  468. m = ConcertAdmin(Concert, custom_site)
  469. request = self.factory.get("/concert/", data={"group__members": lead.pk})
  470. request.user = self.superuser
  471. cl = m.get_changelist_instance(request)
  472. cl.get_results(request)
  473. # There's only one Concert instance
  474. self.assertEqual(cl.result_count, 1)
  475. # Queryset must be deletable.
  476. self.assertIs(cl.queryset.query.distinct, False)
  477. cl.queryset.delete()
  478. self.assertEqual(cl.queryset.count(), 0)
  479. def test_no_duplicates_for_inherited_m2m_in_list_filter(self):
  480. """
  481. Regression test for #13902: When using a ManyToMany in list_filter,
  482. results shouldn't appear more than once. Model managed in the
  483. admin inherits from the one that defines the relationship.
  484. """
  485. lead = Musician.objects.create(name="John")
  486. four = Quartet.objects.create(name="The Beatles")
  487. Membership.objects.create(group=four, music=lead, role="lead voice")
  488. Membership.objects.create(group=four, music=lead, role="guitar player")
  489. m = QuartetAdmin(Quartet, custom_site)
  490. request = self.factory.get("/quartet/", data={"members": lead.pk})
  491. request.user = self.superuser
  492. cl = m.get_changelist_instance(request)
  493. cl.get_results(request)
  494. # There's only one Quartet instance
  495. self.assertEqual(cl.result_count, 1)
  496. # Queryset must be deletable.
  497. self.assertIs(cl.queryset.query.distinct, False)
  498. cl.queryset.delete()
  499. self.assertEqual(cl.queryset.count(), 0)
  500. def test_no_duplicates_for_m2m_to_inherited_in_list_filter(self):
  501. """
  502. Regression test for #13902: When using a ManyToMany in list_filter,
  503. results shouldn't appear more than once. Target of the relationship
  504. inherits from another.
  505. """
  506. lead = ChordsMusician.objects.create(name="Player A")
  507. three = ChordsBand.objects.create(name="The Chords Trio")
  508. Invitation.objects.create(band=three, player=lead, instrument="guitar")
  509. Invitation.objects.create(band=three, player=lead, instrument="bass")
  510. m = ChordsBandAdmin(ChordsBand, custom_site)
  511. request = self.factory.get("/chordsband/", data={"members": lead.pk})
  512. request.user = self.superuser
  513. cl = m.get_changelist_instance(request)
  514. cl.get_results(request)
  515. # There's only one ChordsBand instance
  516. self.assertEqual(cl.result_count, 1)
  517. # Queryset must be deletable.
  518. self.assertIs(cl.queryset.query.distinct, False)
  519. cl.queryset.delete()
  520. self.assertEqual(cl.queryset.count(), 0)
  521. def test_no_duplicates_for_non_unique_related_object_in_list_filter(self):
  522. """
  523. Regressions tests for #15819: If a field listed in list_filters is a
  524. non-unique related object, results shouldn't appear more than once.
  525. """
  526. parent = Parent.objects.create(name="Mary")
  527. # Two children with the same name
  528. Child.objects.create(parent=parent, name="Daniel")
  529. Child.objects.create(parent=parent, name="Daniel")
  530. m = ParentAdmin(Parent, custom_site)
  531. request = self.factory.get("/parent/", data={"child__name": "Daniel"})
  532. request.user = self.superuser
  533. cl = m.get_changelist_instance(request)
  534. # Exists() is applied.
  535. self.assertEqual(cl.queryset.count(), 1)
  536. # Queryset must be deletable.
  537. self.assertIs(cl.queryset.query.distinct, False)
  538. cl.queryset.delete()
  539. self.assertEqual(cl.queryset.count(), 0)
  540. def test_changelist_search_form_validation(self):
  541. m = ConcertAdmin(Concert, custom_site)
  542. tests = [
  543. ({SEARCH_VAR: "\x00"}, "Null characters are not allowed."),
  544. ({SEARCH_VAR: "some\x00thing"}, "Null characters are not allowed."),
  545. ]
  546. for case, error in tests:
  547. with self.subTest(case=case):
  548. request = self.factory.get("/concert/", case)
  549. request.user = self.superuser
  550. request._messages = CookieStorage(request)
  551. m.get_changelist_instance(request)
  552. messages = [m.message for m in request._messages]
  553. self.assertEqual(1, len(messages))
  554. self.assertEqual(error, messages[0])
  555. def test_no_duplicates_for_non_unique_related_object_in_search_fields(self):
  556. """
  557. Regressions tests for #15819: If a field listed in search_fields
  558. is a non-unique related object, Exists() must be applied.
  559. """
  560. parent = Parent.objects.create(name="Mary")
  561. Child.objects.create(parent=parent, name="Danielle")
  562. Child.objects.create(parent=parent, name="Daniel")
  563. m = ParentAdmin(Parent, custom_site)
  564. request = self.factory.get("/parent/", data={SEARCH_VAR: "daniel"})
  565. request.user = self.superuser
  566. cl = m.get_changelist_instance(request)
  567. # Exists() is applied.
  568. self.assertEqual(cl.queryset.count(), 1)
  569. # Queryset must be deletable.
  570. self.assertIs(cl.queryset.query.distinct, False)
  571. cl.queryset.delete()
  572. self.assertEqual(cl.queryset.count(), 0)
  573. def test_no_duplicates_for_many_to_many_at_second_level_in_search_fields(self):
  574. """
  575. When using a ManyToMany in search_fields at the second level behind a
  576. ForeignKey, Exists() must be applied and results shouldn't appear more
  577. than once.
  578. """
  579. lead = Musician.objects.create(name="Vox")
  580. band = Group.objects.create(name="The Hype")
  581. Concert.objects.create(name="Woodstock", group=band)
  582. Membership.objects.create(group=band, music=lead, role="lead voice")
  583. Membership.objects.create(group=band, music=lead, role="bass player")
  584. m = ConcertAdmin(Concert, custom_site)
  585. request = self.factory.get("/concert/", data={SEARCH_VAR: "vox"})
  586. request.user = self.superuser
  587. cl = m.get_changelist_instance(request)
  588. # There's only one Concert instance
  589. self.assertEqual(cl.queryset.count(), 1)
  590. # Queryset must be deletable.
  591. self.assertIs(cl.queryset.query.distinct, False)
  592. cl.queryset.delete()
  593. self.assertEqual(cl.queryset.count(), 0)
  594. def test_multiple_search_fields(self):
  595. """
  596. All rows containing each of the searched words are returned, where each
  597. word must be in one of search_fields.
  598. """
  599. band_duo = Group.objects.create(name="Duo")
  600. band_hype = Group.objects.create(name="The Hype")
  601. mary = Musician.objects.create(name="Mary Halvorson")
  602. jonathan = Musician.objects.create(name="Jonathan Finlayson")
  603. band_duo.members.set([mary, jonathan])
  604. Concert.objects.create(name="Tiny desk concert", group=band_duo)
  605. Concert.objects.create(name="Woodstock concert", group=band_hype)
  606. # FK lookup.
  607. concert_model_admin = ConcertAdmin(Concert, custom_site)
  608. concert_model_admin.search_fields = ["group__name", "name"]
  609. # Reverse FK lookup.
  610. group_model_admin = GroupAdmin(Group, custom_site)
  611. group_model_admin.search_fields = ["name", "concert__name", "members__name"]
  612. for search_string, result_count in (
  613. ("Duo Concert", 1),
  614. ("Tiny Desk Concert", 1),
  615. ("Concert", 2),
  616. ("Other Concert", 0),
  617. ("Duo Woodstock", 0),
  618. ):
  619. with self.subTest(search_string=search_string):
  620. # FK lookup.
  621. request = self.factory.get(
  622. "/concert/", data={SEARCH_VAR: search_string}
  623. )
  624. request.user = self.superuser
  625. concert_changelist = concert_model_admin.get_changelist_instance(
  626. request
  627. )
  628. self.assertEqual(concert_changelist.queryset.count(), result_count)
  629. # Reverse FK lookup.
  630. request = self.factory.get("/group/", data={SEARCH_VAR: search_string})
  631. request.user = self.superuser
  632. group_changelist = group_model_admin.get_changelist_instance(request)
  633. self.assertEqual(group_changelist.queryset.count(), result_count)
  634. # Many-to-many lookup.
  635. for search_string, result_count in (
  636. ("Finlayson Duo Tiny", 1),
  637. ("Finlayson", 1),
  638. ("Finlayson Hype", 0),
  639. ("Jonathan Finlayson Duo", 1),
  640. ("Mary Jonathan Duo", 0),
  641. ("Oscar Finlayson Duo", 0),
  642. ):
  643. with self.subTest(search_string=search_string):
  644. request = self.factory.get("/group/", data={SEARCH_VAR: search_string})
  645. request.user = self.superuser
  646. group_changelist = group_model_admin.get_changelist_instance(request)
  647. self.assertEqual(group_changelist.queryset.count(), result_count)
  648. def test_pk_in_search_fields(self):
  649. band = Group.objects.create(name="The Hype")
  650. Concert.objects.create(name="Woodstock", group=band)
  651. m = ConcertAdmin(Concert, custom_site)
  652. m.search_fields = ["group__pk"]
  653. request = self.factory.get("/concert/", data={SEARCH_VAR: band.pk})
  654. request.user = self.superuser
  655. cl = m.get_changelist_instance(request)
  656. self.assertEqual(cl.queryset.count(), 1)
  657. request = self.factory.get("/concert/", data={SEARCH_VAR: band.pk + 5})
  658. request.user = self.superuser
  659. cl = m.get_changelist_instance(request)
  660. self.assertEqual(cl.queryset.count(), 0)
  661. def test_builtin_lookup_in_search_fields(self):
  662. band = Group.objects.create(name="The Hype")
  663. concert = Concert.objects.create(name="Woodstock", group=band)
  664. m = ConcertAdmin(Concert, custom_site)
  665. m.search_fields = ["name__iexact"]
  666. request = self.factory.get("/", data={SEARCH_VAR: "woodstock"})
  667. request.user = self.superuser
  668. cl = m.get_changelist_instance(request)
  669. self.assertCountEqual(cl.queryset, [concert])
  670. request = self.factory.get("/", data={SEARCH_VAR: "wood"})
  671. request.user = self.superuser
  672. cl = m.get_changelist_instance(request)
  673. self.assertCountEqual(cl.queryset, [])
  674. def test_custom_lookup_in_search_fields(self):
  675. band = Group.objects.create(name="The Hype")
  676. concert = Concert.objects.create(name="Woodstock", group=band)
  677. m = ConcertAdmin(Concert, custom_site)
  678. m.search_fields = ["group__name__cc"]
  679. with register_lookup(Field, Contains, lookup_name="cc"):
  680. request = self.factory.get("/", data={SEARCH_VAR: "Hype"})
  681. request.user = self.superuser
  682. cl = m.get_changelist_instance(request)
  683. self.assertCountEqual(cl.queryset, [concert])
  684. request = self.factory.get("/", data={SEARCH_VAR: "Woodstock"})
  685. request.user = self.superuser
  686. cl = m.get_changelist_instance(request)
  687. self.assertCountEqual(cl.queryset, [])
  688. def test_spanning_relations_with_custom_lookup_in_search_fields(self):
  689. hype = Group.objects.create(name="The Hype")
  690. concert = Concert.objects.create(name="Woodstock", group=hype)
  691. vox = Musician.objects.create(name="Vox", age=20)
  692. Membership.objects.create(music=vox, group=hype)
  693. # Register a custom lookup on IntegerField to ensure that field
  694. # traversing logic in ModelAdmin.get_search_results() works.
  695. with register_lookup(IntegerField, Exact, lookup_name="exactly"):
  696. m = ConcertAdmin(Concert, custom_site)
  697. m.search_fields = ["group__members__age__exactly"]
  698. request = self.factory.get("/", data={SEARCH_VAR: "20"})
  699. request.user = self.superuser
  700. cl = m.get_changelist_instance(request)
  701. self.assertCountEqual(cl.queryset, [concert])
  702. request = self.factory.get("/", data={SEARCH_VAR: "21"})
  703. request.user = self.superuser
  704. cl = m.get_changelist_instance(request)
  705. self.assertCountEqual(cl.queryset, [])
  706. def test_custom_lookup_with_pk_shortcut(self):
  707. self.assertEqual(CharPK._meta.pk.name, "char_pk") # Not equal to 'pk'.
  708. m = admin.ModelAdmin(CustomIdUser, custom_site)
  709. abc = CharPK.objects.create(char_pk="abc")
  710. abcd = CharPK.objects.create(char_pk="abcd")
  711. m = admin.ModelAdmin(CharPK, custom_site)
  712. m.search_fields = ["pk__exact"]
  713. request = self.factory.get("/", data={SEARCH_VAR: "abc"})
  714. request.user = self.superuser
  715. cl = m.get_changelist_instance(request)
  716. self.assertCountEqual(cl.queryset, [abc])
  717. request = self.factory.get("/", data={SEARCH_VAR: "abcd"})
  718. request.user = self.superuser
  719. cl = m.get_changelist_instance(request)
  720. self.assertCountEqual(cl.queryset, [abcd])
  721. def test_no_exists_for_m2m_in_list_filter_without_params(self):
  722. """
  723. If a ManyToManyField is in list_filter but isn't in any lookup params,
  724. the changelist's query shouldn't have Exists().
  725. """
  726. m = BandAdmin(Band, custom_site)
  727. for lookup_params in ({}, {"name": "test"}):
  728. request = self.factory.get("/band/", lookup_params)
  729. request.user = self.superuser
  730. cl = m.get_changelist_instance(request)
  731. self.assertNotIn(" EXISTS", str(cl.queryset.query))
  732. # A ManyToManyField in params does have Exists() applied.
  733. request = self.factory.get("/band/", {"genres": "0"})
  734. request.user = self.superuser
  735. cl = m.get_changelist_instance(request)
  736. self.assertIn(" EXISTS", str(cl.queryset.query))
  737. def test_pagination(self):
  738. """
  739. Regression tests for #12893: Pagination in admins changelist doesn't
  740. use queryset set by modeladmin.
  741. """
  742. parent = Parent.objects.create(name="anything")
  743. for i in range(1, 31):
  744. Child.objects.create(name="name %s" % i, parent=parent)
  745. Child.objects.create(name="filtered %s" % i, parent=parent)
  746. request = self.factory.get("/child/")
  747. request.user = self.superuser
  748. # Test default queryset
  749. m = ChildAdmin(Child, custom_site)
  750. cl = m.get_changelist_instance(request)
  751. self.assertEqual(cl.queryset.count(), 60)
  752. self.assertEqual(cl.paginator.count, 60)
  753. self.assertEqual(list(cl.paginator.page_range), [1, 2, 3, 4, 5, 6])
  754. # Test custom queryset
  755. m = FilteredChildAdmin(Child, custom_site)
  756. cl = m.get_changelist_instance(request)
  757. self.assertEqual(cl.queryset.count(), 30)
  758. self.assertEqual(cl.paginator.count, 30)
  759. self.assertEqual(list(cl.paginator.page_range), [1, 2, 3])
  760. def test_computed_list_display_localization(self):
  761. """
  762. Regression test for #13196: output of functions should be localized
  763. in the changelist.
  764. """
  765. self.client.force_login(self.superuser)
  766. event = Event.objects.create(date=datetime.date.today())
  767. response = self.client.get(reverse("admin:admin_changelist_event_changelist"))
  768. self.assertContains(response, formats.localize(event.date))
  769. self.assertNotContains(response, str(event.date))
  770. def test_dynamic_list_display(self):
  771. """
  772. Regression tests for #14206: dynamic list_display support.
  773. """
  774. parent = Parent.objects.create(name="parent")
  775. for i in range(10):
  776. Child.objects.create(name="child %s" % i, parent=parent)
  777. user_noparents = self._create_superuser("noparents")
  778. user_parents = self._create_superuser("parents")
  779. # Test with user 'noparents'
  780. m = custom_site._registry[Child]
  781. request = self._mocked_authenticated_request("/child/", user_noparents)
  782. response = m.changelist_view(request)
  783. self.assertNotContains(response, "Parent object")
  784. list_display = m.get_list_display(request)
  785. list_display_links = m.get_list_display_links(request, list_display)
  786. self.assertEqual(list_display, ["name", "age"])
  787. self.assertEqual(list_display_links, ["name"])
  788. # Test with user 'parents'
  789. m = DynamicListDisplayChildAdmin(Child, custom_site)
  790. request = self._mocked_authenticated_request("/child/", user_parents)
  791. response = m.changelist_view(request)
  792. self.assertContains(response, "Parent object")
  793. custom_site.unregister(Child)
  794. list_display = m.get_list_display(request)
  795. list_display_links = m.get_list_display_links(request, list_display)
  796. self.assertEqual(list_display, ("parent", "name", "age"))
  797. self.assertEqual(list_display_links, ["parent"])
  798. # Test default implementation
  799. custom_site.register(Child, ChildAdmin)
  800. m = custom_site._registry[Child]
  801. request = self._mocked_authenticated_request("/child/", user_noparents)
  802. response = m.changelist_view(request)
  803. self.assertContains(response, "Parent object")
  804. def test_show_all(self):
  805. parent = Parent.objects.create(name="anything")
  806. for i in range(1, 31):
  807. Child.objects.create(name="name %s" % i, parent=parent)
  808. Child.objects.create(name="filtered %s" % i, parent=parent)
  809. # Add "show all" parameter to request
  810. request = self.factory.get("/child/", data={ALL_VAR: ""})
  811. request.user = self.superuser
  812. # Test valid "show all" request (number of total objects is under max)
  813. m = ChildAdmin(Child, custom_site)
  814. m.list_max_show_all = 200
  815. # 200 is the max we'll pass to ChangeList
  816. cl = m.get_changelist_instance(request)
  817. cl.get_results(request)
  818. self.assertEqual(len(cl.result_list), 60)
  819. # Test invalid "show all" request (number of total objects over max)
  820. # falls back to paginated pages
  821. m = ChildAdmin(Child, custom_site)
  822. m.list_max_show_all = 30
  823. # 30 is the max we'll pass to ChangeList for this test
  824. cl = m.get_changelist_instance(request)
  825. cl.get_results(request)
  826. self.assertEqual(len(cl.result_list), 10)
  827. def test_dynamic_list_display_links(self):
  828. """
  829. Regression tests for #16257: dynamic list_display_links support.
  830. """
  831. parent = Parent.objects.create(name="parent")
  832. for i in range(1, 10):
  833. Child.objects.create(id=i, name="child %s" % i, parent=parent, age=i)
  834. m = DynamicListDisplayLinksChildAdmin(Child, custom_site)
  835. superuser = self._create_superuser("superuser")
  836. request = self._mocked_authenticated_request("/child/", superuser)
  837. response = m.changelist_view(request)
  838. for i in range(1, 10):
  839. link = reverse("admin:admin_changelist_child_change", args=(i,))
  840. self.assertContains(response, '<a href="%s">%s</a>' % (link, i))
  841. list_display = m.get_list_display(request)
  842. list_display_links = m.get_list_display_links(request, list_display)
  843. self.assertEqual(list_display, ("parent", "name", "age"))
  844. self.assertEqual(list_display_links, ["age"])
  845. def test_no_list_display_links(self):
  846. """#15185 -- Allow no links from the 'change list' view grid."""
  847. p = Parent.objects.create(name="parent")
  848. m = NoListDisplayLinksParentAdmin(Parent, custom_site)
  849. superuser = self._create_superuser("superuser")
  850. request = self._mocked_authenticated_request("/parent/", superuser)
  851. response = m.changelist_view(request)
  852. link = reverse("admin:admin_changelist_parent_change", args=(p.pk,))
  853. self.assertNotContains(response, '<a href="%s">' % link)
  854. def test_clear_all_filters_link(self):
  855. self.client.force_login(self.superuser)
  856. url = reverse("admin:auth_user_changelist")
  857. response = self.client.get(url)
  858. self.assertNotContains(response, "&#10006; Clear all filters")
  859. link = '<a href="%s">&#10006; Clear all filters</a>'
  860. for data, href in (
  861. ({"is_staff__exact": "0"}, "?"),
  862. (
  863. {"is_staff__exact": "0", "username__startswith": "test"},
  864. "?username__startswith=test",
  865. ),
  866. (
  867. {"is_staff__exact": "0", SEARCH_VAR: "test"},
  868. "?%s=test" % SEARCH_VAR,
  869. ),
  870. (
  871. {"is_staff__exact": "0", IS_POPUP_VAR: "id"},
  872. "?%s=id" % IS_POPUP_VAR,
  873. ),
  874. ):
  875. with self.subTest(data=data):
  876. response = self.client.get(url, data=data)
  877. self.assertContains(response, link % href)
  878. def test_clear_all_filters_link_callable_filter(self):
  879. self.client.force_login(self.superuser)
  880. url = reverse("admin:admin_changelist_band_changelist")
  881. response = self.client.get(url)
  882. self.assertNotContains(response, "&#10006; Clear all filters")
  883. link = '<a href="%s">&#10006; Clear all filters</a>'
  884. for data, href in (
  885. ({"nr_of_members_partition": "5"}, "?"),
  886. (
  887. {"nr_of_members_partition": "more", "name__startswith": "test"},
  888. "?name__startswith=test",
  889. ),
  890. (
  891. {"nr_of_members_partition": "5", IS_POPUP_VAR: "id"},
  892. "?%s=id" % IS_POPUP_VAR,
  893. ),
  894. ):
  895. with self.subTest(data=data):
  896. response = self.client.get(url, data=data)
  897. self.assertContains(response, link % href)
  898. def test_no_clear_all_filters_link(self):
  899. self.client.force_login(self.superuser)
  900. url = reverse("admin:auth_user_changelist")
  901. link = ">&#10006; Clear all filters</a>"
  902. for data in (
  903. {SEARCH_VAR: "test"},
  904. {ORDER_VAR: "-1"},
  905. {TO_FIELD_VAR: "id"},
  906. {PAGE_VAR: "1"},
  907. {IS_POPUP_VAR: "1"},
  908. {"username__startswith": "test"},
  909. ):
  910. with self.subTest(data=data):
  911. response = self.client.get(url, data=data)
  912. self.assertNotContains(response, link)
  913. def test_tuple_list_display(self):
  914. swallow = Swallow.objects.create(origin="Africa", load="12.34", speed="22.2")
  915. swallow2 = Swallow.objects.create(origin="Africa", load="12.34", speed="22.2")
  916. swallow_o2o = SwallowOneToOne.objects.create(swallow=swallow2)
  917. model_admin = SwallowAdmin(Swallow, custom_site)
  918. superuser = self._create_superuser("superuser")
  919. request = self._mocked_authenticated_request("/swallow/", superuser)
  920. response = model_admin.changelist_view(request)
  921. # just want to ensure it doesn't blow up during rendering
  922. self.assertContains(response, str(swallow.origin))
  923. self.assertContains(response, str(swallow.load))
  924. self.assertContains(response, str(swallow.speed))
  925. # Reverse one-to-one relations should work.
  926. self.assertContains(response, '<td class="field-swallowonetoone">-</td>')
  927. self.assertContains(
  928. response, '<td class="field-swallowonetoone">%s</td>' % swallow_o2o
  929. )
  930. def test_multiuser_edit(self):
  931. """
  932. Simultaneous edits of list_editable fields on the changelist by
  933. different users must not result in one user's edits creating a new
  934. object instead of modifying the correct existing object (#11313).
  935. """
  936. # To replicate this issue, simulate the following steps:
  937. # 1. User1 opens an admin changelist with list_editable fields.
  938. # 2. User2 edits object "Foo" such that it moves to another page in
  939. # the pagination order and saves.
  940. # 3. User1 edits object "Foo" and saves.
  941. # 4. The edit made by User1 does not get applied to object "Foo" but
  942. # instead is used to create a new object (bug).
  943. # For this test, order the changelist by the 'speed' attribute and
  944. # display 3 objects per page (SwallowAdmin.list_per_page = 3).
  945. # Setup the test to reflect the DB state after step 2 where User2 has
  946. # edited the first swallow object's speed from '4' to '1'.
  947. a = Swallow.objects.create(origin="Swallow A", load=4, speed=1)
  948. b = Swallow.objects.create(origin="Swallow B", load=2, speed=2)
  949. c = Swallow.objects.create(origin="Swallow C", load=5, speed=5)
  950. d = Swallow.objects.create(origin="Swallow D", load=9, speed=9)
  951. superuser = self._create_superuser("superuser")
  952. self.client.force_login(superuser)
  953. changelist_url = reverse("admin:admin_changelist_swallow_changelist")
  954. # Send the POST from User1 for step 3. It's still using the changelist
  955. # ordering from before User2's edits in step 2.
  956. data = {
  957. "form-TOTAL_FORMS": "3",
  958. "form-INITIAL_FORMS": "3",
  959. "form-MIN_NUM_FORMS": "0",
  960. "form-MAX_NUM_FORMS": "1000",
  961. "form-0-uuid": str(d.pk),
  962. "form-1-uuid": str(c.pk),
  963. "form-2-uuid": str(a.pk),
  964. "form-0-load": "9.0",
  965. "form-0-speed": "9.0",
  966. "form-1-load": "5.0",
  967. "form-1-speed": "5.0",
  968. "form-2-load": "5.0",
  969. "form-2-speed": "4.0",
  970. "_save": "Save",
  971. }
  972. response = self.client.post(
  973. changelist_url, data, follow=True, extra={"o": "-2"}
  974. )
  975. # The object User1 edited in step 3 is displayed on the changelist and
  976. # has the correct edits applied.
  977. self.assertContains(response, "1 swallow was changed successfully.")
  978. self.assertContains(response, a.origin)
  979. a.refresh_from_db()
  980. self.assertEqual(a.load, float(data["form-2-load"]))
  981. self.assertEqual(a.speed, float(data["form-2-speed"]))
  982. b.refresh_from_db()
  983. self.assertEqual(b.load, 2)
  984. self.assertEqual(b.speed, 2)
  985. c.refresh_from_db()
  986. self.assertEqual(c.load, float(data["form-1-load"]))
  987. self.assertEqual(c.speed, float(data["form-1-speed"]))
  988. d.refresh_from_db()
  989. self.assertEqual(d.load, float(data["form-0-load"]))
  990. self.assertEqual(d.speed, float(data["form-0-speed"]))
  991. # No new swallows were created.
  992. self.assertEqual(len(Swallow.objects.all()), 4)
  993. def test_get_edited_object_ids(self):
  994. a = Swallow.objects.create(origin="Swallow A", load=4, speed=1)
  995. b = Swallow.objects.create(origin="Swallow B", load=2, speed=2)
  996. c = Swallow.objects.create(origin="Swallow C", load=5, speed=5)
  997. superuser = self._create_superuser("superuser")
  998. self.client.force_login(superuser)
  999. changelist_url = reverse("admin:admin_changelist_swallow_changelist")
  1000. m = SwallowAdmin(Swallow, custom_site)
  1001. data = {
  1002. "form-TOTAL_FORMS": "3",
  1003. "form-INITIAL_FORMS": "3",
  1004. "form-MIN_NUM_FORMS": "0",
  1005. "form-MAX_NUM_FORMS": "1000",
  1006. "form-0-uuid": str(a.pk),
  1007. "form-1-uuid": str(b.pk),
  1008. "form-2-uuid": str(c.pk),
  1009. "form-0-load": "9.0",
  1010. "form-0-speed": "9.0",
  1011. "form-1-load": "5.0",
  1012. "form-1-speed": "5.0",
  1013. "form-2-load": "5.0",
  1014. "form-2-speed": "4.0",
  1015. "_save": "Save",
  1016. }
  1017. request = self.factory.post(changelist_url, data=data)
  1018. pks = m._get_edited_object_pks(request, prefix="form")
  1019. self.assertEqual(sorted(pks), sorted([str(a.pk), str(b.pk), str(c.pk)]))
  1020. def test_get_list_editable_queryset(self):
  1021. a = Swallow.objects.create(origin="Swallow A", load=4, speed=1)
  1022. Swallow.objects.create(origin="Swallow B", load=2, speed=2)
  1023. data = {
  1024. "form-TOTAL_FORMS": "2",
  1025. "form-INITIAL_FORMS": "2",
  1026. "form-MIN_NUM_FORMS": "0",
  1027. "form-MAX_NUM_FORMS": "1000",
  1028. "form-0-uuid": str(a.pk),
  1029. "form-0-load": "10",
  1030. "_save": "Save",
  1031. }
  1032. superuser = self._create_superuser("superuser")
  1033. self.client.force_login(superuser)
  1034. changelist_url = reverse("admin:admin_changelist_swallow_changelist")
  1035. m = SwallowAdmin(Swallow, custom_site)
  1036. request = self.factory.post(changelist_url, data=data)
  1037. queryset = m._get_list_editable_queryset(request, prefix="form")
  1038. self.assertEqual(queryset.count(), 1)
  1039. data["form-0-uuid"] = "INVALD_PRIMARY_KEY"
  1040. # The unfiltered queryset is returned if there's invalid data.
  1041. request = self.factory.post(changelist_url, data=data)
  1042. queryset = m._get_list_editable_queryset(request, prefix="form")
  1043. self.assertEqual(queryset.count(), 2)
  1044. def test_get_list_editable_queryset_with_regex_chars_in_prefix(self):
  1045. a = Swallow.objects.create(origin="Swallow A", load=4, speed=1)
  1046. Swallow.objects.create(origin="Swallow B", load=2, speed=2)
  1047. data = {
  1048. "form$-TOTAL_FORMS": "2",
  1049. "form$-INITIAL_FORMS": "2",
  1050. "form$-MIN_NUM_FORMS": "0",
  1051. "form$-MAX_NUM_FORMS": "1000",
  1052. "form$-0-uuid": str(a.pk),
  1053. "form$-0-load": "10",
  1054. "_save": "Save",
  1055. }
  1056. superuser = self._create_superuser("superuser")
  1057. self.client.force_login(superuser)
  1058. changelist_url = reverse("admin:admin_changelist_swallow_changelist")
  1059. m = SwallowAdmin(Swallow, custom_site)
  1060. request = self.factory.post(changelist_url, data=data)
  1061. queryset = m._get_list_editable_queryset(request, prefix="form$")
  1062. self.assertEqual(queryset.count(), 1)
  1063. def test_changelist_view_list_editable_changed_objects_uses_filter(self):
  1064. """list_editable edits use a filtered queryset to limit memory usage."""
  1065. a = Swallow.objects.create(origin="Swallow A", load=4, speed=1)
  1066. Swallow.objects.create(origin="Swallow B", load=2, speed=2)
  1067. data = {
  1068. "form-TOTAL_FORMS": "2",
  1069. "form-INITIAL_FORMS": "2",
  1070. "form-MIN_NUM_FORMS": "0",
  1071. "form-MAX_NUM_FORMS": "1000",
  1072. "form-0-uuid": str(a.pk),
  1073. "form-0-load": "10",
  1074. "_save": "Save",
  1075. }
  1076. superuser = self._create_superuser("superuser")
  1077. self.client.force_login(superuser)
  1078. changelist_url = reverse("admin:admin_changelist_swallow_changelist")
  1079. with CaptureQueriesContext(connection) as context:
  1080. response = self.client.post(changelist_url, data=data)
  1081. self.assertEqual(response.status_code, 200)
  1082. self.assertIn("WHERE", context.captured_queries[4]["sql"])
  1083. self.assertIn("IN", context.captured_queries[4]["sql"])
  1084. # Check only the first few characters since the UUID may have dashes.
  1085. self.assertIn(str(a.pk)[:8], context.captured_queries[4]["sql"])
  1086. def test_deterministic_order_for_unordered_model(self):
  1087. """
  1088. The primary key is used in the ordering of the changelist's results to
  1089. guarantee a deterministic order, even when the model doesn't have any
  1090. default ordering defined (#17198).
  1091. """
  1092. superuser = self._create_superuser("superuser")
  1093. for counter in range(1, 51):
  1094. UnorderedObject.objects.create(id=counter, bool=True)
  1095. class UnorderedObjectAdmin(admin.ModelAdmin):
  1096. list_per_page = 10
  1097. def check_results_order(ascending=False):
  1098. custom_site.register(UnorderedObject, UnorderedObjectAdmin)
  1099. model_admin = UnorderedObjectAdmin(UnorderedObject, custom_site)
  1100. counter = 0 if ascending else 51
  1101. for page in range(1, 6):
  1102. request = self._mocked_authenticated_request(
  1103. "/unorderedobject/?p=%s" % page, superuser
  1104. )
  1105. response = model_admin.changelist_view(request)
  1106. for result in response.context_data["cl"].result_list:
  1107. counter += 1 if ascending else -1
  1108. self.assertEqual(result.id, counter)
  1109. custom_site.unregister(UnorderedObject)
  1110. # When no order is defined at all, everything is ordered by '-pk'.
  1111. check_results_order()
  1112. # When an order field is defined but multiple records have the same
  1113. # value for that field, make sure everything gets ordered by -pk as well.
  1114. UnorderedObjectAdmin.ordering = ["bool"]
  1115. check_results_order()
  1116. # When order fields are defined, including the pk itself, use them.
  1117. UnorderedObjectAdmin.ordering = ["bool", "-pk"]
  1118. check_results_order()
  1119. UnorderedObjectAdmin.ordering = ["bool", "pk"]
  1120. check_results_order(ascending=True)
  1121. UnorderedObjectAdmin.ordering = ["-id", "bool"]
  1122. check_results_order()
  1123. UnorderedObjectAdmin.ordering = ["id", "bool"]
  1124. check_results_order(ascending=True)
  1125. def test_deterministic_order_for_model_ordered_by_its_manager(self):
  1126. """
  1127. The primary key is used in the ordering of the changelist's results to
  1128. guarantee a deterministic order, even when the model has a manager that
  1129. defines a default ordering (#17198).
  1130. """
  1131. superuser = self._create_superuser("superuser")
  1132. for counter in range(1, 51):
  1133. OrderedObject.objects.create(id=counter, bool=True, number=counter)
  1134. class OrderedObjectAdmin(admin.ModelAdmin):
  1135. list_per_page = 10
  1136. def check_results_order(ascending=False):
  1137. custom_site.register(OrderedObject, OrderedObjectAdmin)
  1138. model_admin = OrderedObjectAdmin(OrderedObject, custom_site)
  1139. counter = 0 if ascending else 51
  1140. for page in range(1, 6):
  1141. request = self._mocked_authenticated_request(
  1142. "/orderedobject/?p=%s" % page, superuser
  1143. )
  1144. response = model_admin.changelist_view(request)
  1145. for result in response.context_data["cl"].result_list:
  1146. counter += 1 if ascending else -1
  1147. self.assertEqual(result.id, counter)
  1148. custom_site.unregister(OrderedObject)
  1149. # When no order is defined at all, use the model's default ordering
  1150. # (i.e. 'number').
  1151. check_results_order(ascending=True)
  1152. # When an order field is defined but multiple records have the same
  1153. # value for that field, make sure everything gets ordered by -pk as well.
  1154. OrderedObjectAdmin.ordering = ["bool"]
  1155. check_results_order()
  1156. # When order fields are defined, including the pk itself, use them.
  1157. OrderedObjectAdmin.ordering = ["bool", "-pk"]
  1158. check_results_order()
  1159. OrderedObjectAdmin.ordering = ["bool", "pk"]
  1160. check_results_order(ascending=True)
  1161. OrderedObjectAdmin.ordering = ["-id", "bool"]
  1162. check_results_order()
  1163. OrderedObjectAdmin.ordering = ["id", "bool"]
  1164. check_results_order(ascending=True)
  1165. @isolate_apps("admin_changelist")
  1166. def test_total_ordering_optimization(self):
  1167. class Related(models.Model):
  1168. unique_field = models.BooleanField(unique=True)
  1169. class Meta:
  1170. ordering = ("unique_field",)
  1171. class Model(models.Model):
  1172. unique_field = models.BooleanField(unique=True)
  1173. unique_nullable_field = models.BooleanField(unique=True, null=True)
  1174. related = models.ForeignKey(Related, models.CASCADE)
  1175. other_related = models.ForeignKey(Related, models.CASCADE)
  1176. related_unique = models.OneToOneField(Related, models.CASCADE)
  1177. field = models.BooleanField()
  1178. other_field = models.BooleanField()
  1179. null_field = models.BooleanField(null=True)
  1180. class Meta:
  1181. unique_together = {
  1182. ("field", "other_field"),
  1183. ("field", "null_field"),
  1184. ("related", "other_related_id"),
  1185. }
  1186. class ModelAdmin(admin.ModelAdmin):
  1187. def get_queryset(self, request):
  1188. return Model.objects.none()
  1189. request = self._mocked_authenticated_request("/", self.superuser)
  1190. site = admin.AdminSite(name="admin")
  1191. model_admin = ModelAdmin(Model, site)
  1192. change_list = model_admin.get_changelist_instance(request)
  1193. tests = (
  1194. ([], ["-pk"]),
  1195. # Unique non-nullable field.
  1196. (["unique_field"], ["unique_field"]),
  1197. (["-unique_field"], ["-unique_field"]),
  1198. # Unique nullable field.
  1199. (["unique_nullable_field"], ["unique_nullable_field", "-pk"]),
  1200. # Field.
  1201. (["field"], ["field", "-pk"]),
  1202. # Related field introspection is not implemented.
  1203. (["related__unique_field"], ["related__unique_field", "-pk"]),
  1204. # Related attname unique.
  1205. (["related_unique_id"], ["related_unique_id"]),
  1206. # Related ordering introspection is not implemented.
  1207. (["related_unique"], ["related_unique", "-pk"]),
  1208. # Composite unique.
  1209. (["field", "-other_field"], ["field", "-other_field"]),
  1210. # Composite unique nullable.
  1211. (["-field", "null_field"], ["-field", "null_field", "-pk"]),
  1212. # Composite unique and nullable.
  1213. (
  1214. ["-field", "null_field", "other_field"],
  1215. ["-field", "null_field", "other_field"],
  1216. ),
  1217. # Composite unique attnames.
  1218. (["related_id", "-other_related_id"], ["related_id", "-other_related_id"]),
  1219. # Composite unique names.
  1220. (["related", "-other_related_id"], ["related", "-other_related_id", "-pk"]),
  1221. )
  1222. # F() objects composite unique.
  1223. total_ordering = [F("field"), F("other_field").desc(nulls_last=True)]
  1224. # F() objects composite unique nullable.
  1225. non_total_ordering = [F("field"), F("null_field").desc(nulls_last=True)]
  1226. tests += (
  1227. (total_ordering, total_ordering),
  1228. (non_total_ordering, non_total_ordering + ["-pk"]),
  1229. )
  1230. for ordering, expected in tests:
  1231. with self.subTest(ordering=ordering):
  1232. self.assertEqual(
  1233. change_list._get_deterministic_ordering(ordering), expected
  1234. )
  1235. @isolate_apps("admin_changelist")
  1236. def test_total_ordering_optimization_meta_constraints(self):
  1237. class Related(models.Model):
  1238. unique_field = models.BooleanField(unique=True)
  1239. class Meta:
  1240. ordering = ("unique_field",)
  1241. class Model(models.Model):
  1242. field_1 = models.BooleanField()
  1243. field_2 = models.BooleanField()
  1244. field_3 = models.BooleanField()
  1245. field_4 = models.BooleanField()
  1246. field_5 = models.BooleanField()
  1247. field_6 = models.BooleanField()
  1248. nullable_1 = models.BooleanField(null=True)
  1249. nullable_2 = models.BooleanField(null=True)
  1250. related_1 = models.ForeignKey(Related, models.CASCADE)
  1251. related_2 = models.ForeignKey(Related, models.CASCADE)
  1252. related_3 = models.ForeignKey(Related, models.CASCADE)
  1253. related_4 = models.ForeignKey(Related, models.CASCADE)
  1254. class Meta:
  1255. constraints = [
  1256. *[
  1257. models.UniqueConstraint(fields=fields, name="".join(fields))
  1258. for fields in (
  1259. ["field_1"],
  1260. ["nullable_1"],
  1261. ["related_1"],
  1262. ["related_2_id"],
  1263. ["field_2", "field_3"],
  1264. ["field_2", "nullable_2"],
  1265. ["field_2", "related_3"],
  1266. ["field_3", "related_4_id"],
  1267. )
  1268. ],
  1269. models.CheckConstraint(check=models.Q(id__gt=0), name="foo"),
  1270. models.UniqueConstraint(
  1271. fields=["field_5"],
  1272. condition=models.Q(id__gt=10),
  1273. name="total_ordering_1",
  1274. ),
  1275. models.UniqueConstraint(
  1276. fields=["field_6"],
  1277. condition=models.Q(),
  1278. name="total_ordering",
  1279. ),
  1280. ]
  1281. class ModelAdmin(admin.ModelAdmin):
  1282. def get_queryset(self, request):
  1283. return Model.objects.none()
  1284. request = self._mocked_authenticated_request("/", self.superuser)
  1285. site = admin.AdminSite(name="admin")
  1286. model_admin = ModelAdmin(Model, site)
  1287. change_list = model_admin.get_changelist_instance(request)
  1288. tests = (
  1289. # Unique non-nullable field.
  1290. (["field_1"], ["field_1"]),
  1291. # Unique nullable field.
  1292. (["nullable_1"], ["nullable_1", "-pk"]),
  1293. # Related attname unique.
  1294. (["related_1_id"], ["related_1_id"]),
  1295. (["related_2_id"], ["related_2_id"]),
  1296. # Related ordering introspection is not implemented.
  1297. (["related_1"], ["related_1", "-pk"]),
  1298. # Composite unique.
  1299. (["-field_2", "field_3"], ["-field_2", "field_3"]),
  1300. # Composite unique nullable.
  1301. (["field_2", "-nullable_2"], ["field_2", "-nullable_2", "-pk"]),
  1302. # Composite unique and nullable.
  1303. (
  1304. ["field_2", "-nullable_2", "field_3"],
  1305. ["field_2", "-nullable_2", "field_3"],
  1306. ),
  1307. # Composite field and related field name.
  1308. (["field_2", "-related_3"], ["field_2", "-related_3", "-pk"]),
  1309. (["field_3", "related_4"], ["field_3", "related_4", "-pk"]),
  1310. # Composite field and related field attname.
  1311. (["field_2", "related_3_id"], ["field_2", "related_3_id"]),
  1312. (["field_3", "-related_4_id"], ["field_3", "-related_4_id"]),
  1313. # Partial unique constraint is ignored.
  1314. (["field_5"], ["field_5", "-pk"]),
  1315. # Unique constraint with an empty condition.
  1316. (["field_6"], ["field_6"]),
  1317. )
  1318. for ordering, expected in tests:
  1319. with self.subTest(ordering=ordering):
  1320. self.assertEqual(
  1321. change_list._get_deterministic_ordering(ordering), expected
  1322. )
  1323. def test_dynamic_list_filter(self):
  1324. """
  1325. Regression tests for ticket #17646: dynamic list_filter support.
  1326. """
  1327. parent = Parent.objects.create(name="parent")
  1328. for i in range(10):
  1329. Child.objects.create(name="child %s" % i, parent=parent)
  1330. user_noparents = self._create_superuser("noparents")
  1331. user_parents = self._create_superuser("parents")
  1332. # Test with user 'noparents'
  1333. m = DynamicListFilterChildAdmin(Child, custom_site)
  1334. request = self._mocked_authenticated_request("/child/", user_noparents)
  1335. response = m.changelist_view(request)
  1336. self.assertEqual(response.context_data["cl"].list_filter, ["name", "age"])
  1337. # Test with user 'parents'
  1338. m = DynamicListFilterChildAdmin(Child, custom_site)
  1339. request = self._mocked_authenticated_request("/child/", user_parents)
  1340. response = m.changelist_view(request)
  1341. self.assertEqual(
  1342. response.context_data["cl"].list_filter, ("parent", "name", "age")
  1343. )
  1344. def test_dynamic_search_fields(self):
  1345. child = self._create_superuser("child")
  1346. m = DynamicSearchFieldsChildAdmin(Child, custom_site)
  1347. request = self._mocked_authenticated_request("/child/", child)
  1348. response = m.changelist_view(request)
  1349. self.assertEqual(response.context_data["cl"].search_fields, ("name", "age"))
  1350. def test_pagination_page_range(self):
  1351. """
  1352. Regression tests for ticket #15653: ensure the number of pages
  1353. generated for changelist views are correct.
  1354. """
  1355. # instantiating and setting up ChangeList object
  1356. m = GroupAdmin(Group, custom_site)
  1357. request = self.factory.get("/group/")
  1358. request.user = self.superuser
  1359. cl = m.get_changelist_instance(request)
  1360. cl.list_per_page = 10
  1361. ELLIPSIS = cl.paginator.ELLIPSIS
  1362. for number, pages, expected in [
  1363. (1, 1, []),
  1364. (1, 2, [1, 2]),
  1365. (6, 11, [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]),
  1366. (6, 12, [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]),
  1367. (6, 13, [1, 2, 3, 4, 5, 6, 7, 8, 9, ELLIPSIS, 12, 13]),
  1368. (7, 12, [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]),
  1369. (7, 13, [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]),
  1370. (7, 14, [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ELLIPSIS, 13, 14]),
  1371. (8, 13, [1, 2, ELLIPSIS, 5, 6, 7, 8, 9, 10, 11, 12, 13]),
  1372. (8, 14, [1, 2, ELLIPSIS, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14]),
  1373. (8, 15, [1, 2, ELLIPSIS, 5, 6, 7, 8, 9, 10, 11, ELLIPSIS, 14, 15]),
  1374. ]:
  1375. with self.subTest(number=number, pages=pages):
  1376. # assuming exactly `pages * cl.list_per_page` objects
  1377. Group.objects.all().delete()
  1378. for i in range(pages * cl.list_per_page):
  1379. Group.objects.create(name="test band")
  1380. # setting page number and calculating page range
  1381. cl.page_num = number
  1382. cl.get_results(request)
  1383. self.assertEqual(list(pagination(cl)["page_range"]), expected)
  1384. def test_object_tools_displayed_no_add_permission(self):
  1385. """
  1386. When ModelAdmin.has_add_permission() returns False, the object-tools
  1387. block is still shown.
  1388. """
  1389. superuser = self._create_superuser("superuser")
  1390. m = EventAdmin(Event, custom_site)
  1391. request = self._mocked_authenticated_request("/event/", superuser)
  1392. self.assertFalse(m.has_add_permission(request))
  1393. response = m.changelist_view(request)
  1394. self.assertIn('<ul class="object-tools">', response.rendered_content)
  1395. # The "Add" button inside the object-tools shouldn't appear.
  1396. self.assertNotIn("Add ", response.rendered_content)
  1397. def test_search_help_text(self):
  1398. superuser = self._create_superuser("superuser")
  1399. m = BandAdmin(Band, custom_site)
  1400. # search_fields without search_help_text.
  1401. m.search_fields = ["name"]
  1402. request = self._mocked_authenticated_request("/band/", superuser)
  1403. response = m.changelist_view(request)
  1404. self.assertIsNone(response.context_data["cl"].search_help_text)
  1405. self.assertNotContains(response, '<div class="help id="searchbar_helptext">')
  1406. # search_fields with search_help_text.
  1407. m.search_help_text = "Search help text"
  1408. request = self._mocked_authenticated_request("/band/", superuser)
  1409. response = m.changelist_view(request)
  1410. self.assertEqual(
  1411. response.context_data["cl"].search_help_text, "Search help text"
  1412. )
  1413. self.assertContains(
  1414. response, '<div class="help" id="searchbar_helptext">Search help text</div>'
  1415. )
  1416. self.assertContains(
  1417. response,
  1418. '<input type="text" size="40" name="q" value="" id="searchbar" '
  1419. 'aria-describedby="searchbar_helptext">',
  1420. )
  1421. class GetAdminLogTests(TestCase):
  1422. def test_custom_user_pk_not_named_id(self):
  1423. """
  1424. {% get_admin_log %} works if the user model's primary key isn't named
  1425. 'id'.
  1426. """
  1427. context = Context(
  1428. {
  1429. "user": CustomIdUser(),
  1430. "log_entries": LogEntry.objects.all(),
  1431. }
  1432. )
  1433. template = Template(
  1434. "{% load log %}{% get_admin_log 10 as admin_log for_user user %}"
  1435. )
  1436. # This template tag just logs.
  1437. self.assertEqual(template.render(context), "")
  1438. def test_no_user(self):
  1439. """{% get_admin_log %} works without specifying a user."""
  1440. user = User(username="jondoe", password="secret", email="super@example.com")
  1441. user.save()
  1442. ct = ContentType.objects.get_for_model(User)
  1443. LogEntry.objects.log_action(user.pk, ct.pk, user.pk, repr(user), 1)
  1444. context = Context({"log_entries": LogEntry.objects.all()})
  1445. t = Template(
  1446. "{% load log %}"
  1447. "{% get_admin_log 100 as admin_log %}"
  1448. "{% for entry in admin_log %}"
  1449. "{{ entry|safe }}"
  1450. "{% endfor %}"
  1451. )
  1452. self.assertEqual(t.render(context), "Added “<User: jondoe>”.")
  1453. def test_missing_args(self):
  1454. msg = "'get_admin_log' statements require two arguments"
  1455. with self.assertRaisesMessage(TemplateSyntaxError, msg):
  1456. Template("{% load log %}{% get_admin_log 10 as %}")
  1457. def test_non_integer_limit(self):
  1458. msg = "First argument to 'get_admin_log' must be an integer"
  1459. with self.assertRaisesMessage(TemplateSyntaxError, msg):
  1460. Template(
  1461. '{% load log %}{% get_admin_log "10" as admin_log for_user user %}'
  1462. )
  1463. def test_without_as(self):
  1464. msg = "Second argument to 'get_admin_log' must be 'as'"
  1465. with self.assertRaisesMessage(TemplateSyntaxError, msg):
  1466. Template("{% load log %}{% get_admin_log 10 ad admin_log for_user user %}")
  1467. def test_without_for_user(self):
  1468. msg = "Fourth argument to 'get_admin_log' must be 'for_user'"
  1469. with self.assertRaisesMessage(TemplateSyntaxError, msg):
  1470. Template("{% load log %}{% get_admin_log 10 as admin_log foruser user %}")
  1471. @override_settings(ROOT_URLCONF="admin_changelist.urls")
  1472. class SeleniumTests(AdminSeleniumTestCase):
  1473. available_apps = ["admin_changelist"] + AdminSeleniumTestCase.available_apps
  1474. def setUp(self):
  1475. User.objects.create_superuser(username="super", password="secret", email=None)
  1476. def test_add_row_selection(self):
  1477. """
  1478. The status line for selected rows gets updated correctly (#22038).
  1479. """
  1480. from selenium.webdriver.common.by import By
  1481. self.admin_login(username="super", password="secret")
  1482. self.selenium.get(self.live_server_url + reverse("admin:auth_user_changelist"))
  1483. form_id = "#changelist-form"
  1484. # Test amount of rows in the Changelist
  1485. rows = self.selenium.find_elements(
  1486. By.CSS_SELECTOR, "%s #result_list tbody tr" % form_id
  1487. )
  1488. self.assertEqual(len(rows), 1)
  1489. row = rows[0]
  1490. selection_indicator = self.selenium.find_element(
  1491. By.CSS_SELECTOR, "%s .action-counter" % form_id
  1492. )
  1493. all_selector = self.selenium.find_element(By.ID, "action-toggle")
  1494. row_selector = self.selenium.find_element(
  1495. By.CSS_SELECTOR,
  1496. "%s #result_list tbody tr:first-child .action-select" % form_id,
  1497. )
  1498. # Test current selection
  1499. self.assertEqual(selection_indicator.text, "0 of 1 selected")
  1500. self.assertIs(all_selector.get_property("checked"), False)
  1501. self.assertEqual(row.get_attribute("class"), "")
  1502. # Select a row and check again
  1503. row_selector.click()
  1504. self.assertEqual(selection_indicator.text, "1 of 1 selected")
  1505. self.assertIs(all_selector.get_property("checked"), True)
  1506. self.assertEqual(row.get_attribute("class"), "selected")
  1507. # Deselect a row and check again
  1508. row_selector.click()
  1509. self.assertEqual(selection_indicator.text, "0 of 1 selected")
  1510. self.assertIs(all_selector.get_property("checked"), False)
  1511. self.assertEqual(row.get_attribute("class"), "")
  1512. def test_modifier_allows_multiple_section(self):
  1513. """
  1514. Selecting a row and then selecting another row whilst holding shift
  1515. should select all rows in-between.
  1516. """
  1517. from selenium.webdriver.common.action_chains import ActionChains
  1518. from selenium.webdriver.common.by import By
  1519. from selenium.webdriver.common.keys import Keys
  1520. Parent.objects.bulk_create([Parent(name="parent%d" % i) for i in range(5)])
  1521. self.admin_login(username="super", password="secret")
  1522. self.selenium.get(
  1523. self.live_server_url + reverse("admin:admin_changelist_parent_changelist")
  1524. )
  1525. checkboxes = self.selenium.find_elements(
  1526. By.CSS_SELECTOR, "tr input.action-select"
  1527. )
  1528. self.assertEqual(len(checkboxes), 5)
  1529. for c in checkboxes:
  1530. self.assertIs(c.get_property("checked"), False)
  1531. # Check first row. Hold-shift and check next-to-last row.
  1532. checkboxes[0].click()
  1533. ActionChains(self.selenium).key_down(Keys.SHIFT).click(checkboxes[-2]).key_up(
  1534. Keys.SHIFT
  1535. ).perform()
  1536. for c in checkboxes[:-2]:
  1537. self.assertIs(c.get_property("checked"), True)
  1538. self.assertIs(checkboxes[-1].get_property("checked"), False)
  1539. def test_select_all_across_pages(self):
  1540. from selenium.webdriver.common.by import By
  1541. Parent.objects.bulk_create([Parent(name="parent%d" % i) for i in range(101)])
  1542. self.admin_login(username="super", password="secret")
  1543. self.selenium.get(
  1544. self.live_server_url + reverse("admin:admin_changelist_parent_changelist")
  1545. )
  1546. selection_indicator = self.selenium.find_element(
  1547. By.CSS_SELECTOR, ".action-counter"
  1548. )
  1549. select_all_indicator = self.selenium.find_element(
  1550. By.CSS_SELECTOR, ".actions .all"
  1551. )
  1552. question = self.selenium.find_element(By.CSS_SELECTOR, ".actions > .question")
  1553. clear = self.selenium.find_element(By.CSS_SELECTOR, ".actions > .clear")
  1554. select_all = self.selenium.find_element(By.ID, "action-toggle")
  1555. select_across = self.selenium.find_elements(By.NAME, "select_across")
  1556. self.assertIs(question.is_displayed(), False)
  1557. self.assertIs(clear.is_displayed(), False)
  1558. self.assertIs(select_all.get_property("checked"), False)
  1559. for hidden_input in select_across:
  1560. self.assertEqual(hidden_input.get_property("value"), "0")
  1561. self.assertIs(selection_indicator.is_displayed(), True)
  1562. self.assertEqual(selection_indicator.text, "0 of 100 selected")
  1563. self.assertIs(select_all_indicator.is_displayed(), False)
  1564. select_all.click()
  1565. self.assertIs(question.is_displayed(), True)
  1566. self.assertIs(clear.is_displayed(), False)
  1567. self.assertIs(select_all.get_property("checked"), True)
  1568. for hidden_input in select_across:
  1569. self.assertEqual(hidden_input.get_property("value"), "0")
  1570. self.assertIs(selection_indicator.is_displayed(), True)
  1571. self.assertEqual(selection_indicator.text, "100 of 100 selected")
  1572. self.assertIs(select_all_indicator.is_displayed(), False)
  1573. question.click()
  1574. self.assertIs(question.is_displayed(), False)
  1575. self.assertIs(clear.is_displayed(), True)
  1576. self.assertIs(select_all.get_property("checked"), True)
  1577. for hidden_input in select_across:
  1578. self.assertEqual(hidden_input.get_property("value"), "1")
  1579. self.assertIs(selection_indicator.is_displayed(), False)
  1580. self.assertIs(select_all_indicator.is_displayed(), True)
  1581. clear.click()
  1582. self.assertIs(question.is_displayed(), False)
  1583. self.assertIs(clear.is_displayed(), False)
  1584. self.assertIs(select_all.get_property("checked"), False)
  1585. for hidden_input in select_across:
  1586. self.assertEqual(hidden_input.get_property("value"), "0")
  1587. self.assertIs(selection_indicator.is_displayed(), True)
  1588. self.assertEqual(selection_indicator.text, "0 of 100 selected")
  1589. self.assertIs(select_all_indicator.is_displayed(), False)
  1590. def test_actions_warn_on_pending_edits(self):
  1591. from selenium.webdriver.common.by import By
  1592. Parent.objects.create(name="foo")
  1593. self.admin_login(username="super", password="secret")
  1594. self.selenium.get(
  1595. self.live_server_url + reverse("admin:admin_changelist_parent_changelist")
  1596. )
  1597. name_input = self.selenium.find_element(By.ID, "id_form-0-name")
  1598. name_input.clear()
  1599. name_input.send_keys("bar")
  1600. self.selenium.find_element(By.ID, "action-toggle").click()
  1601. self.selenium.find_element(By.NAME, "index").click() # Go
  1602. alert = self.selenium.switch_to.alert
  1603. try:
  1604. self.assertEqual(
  1605. alert.text,
  1606. "You have unsaved changes on individual editable fields. If you "
  1607. "run an action, your unsaved changes will be lost.",
  1608. )
  1609. finally:
  1610. alert.dismiss()
  1611. def test_save_with_changes_warns_on_pending_action(self):
  1612. from selenium.webdriver.common.by import By
  1613. from selenium.webdriver.support.ui import Select
  1614. Parent.objects.create(name="parent")
  1615. self.admin_login(username="super", password="secret")
  1616. self.selenium.get(
  1617. self.live_server_url + reverse("admin:admin_changelist_parent_changelist")
  1618. )
  1619. name_input = self.selenium.find_element(By.ID, "id_form-0-name")
  1620. name_input.clear()
  1621. name_input.send_keys("other name")
  1622. Select(self.selenium.find_element(By.NAME, "action")).select_by_value(
  1623. "delete_selected"
  1624. )
  1625. self.selenium.find_element(By.NAME, "_save").click()
  1626. alert = self.selenium.switch_to.alert
  1627. try:
  1628. self.assertEqual(
  1629. alert.text,
  1630. "You have selected an action, but you haven’t saved your "
  1631. "changes to individual fields yet. Please click OK to save. "
  1632. "You’ll need to re-run the action.",
  1633. )
  1634. finally:
  1635. alert.dismiss()
  1636. def test_save_without_changes_warns_on_pending_action(self):
  1637. from selenium.webdriver.common.by import By
  1638. from selenium.webdriver.support.ui import Select
  1639. Parent.objects.create(name="parent")
  1640. self.admin_login(username="super", password="secret")
  1641. self.selenium.get(
  1642. self.live_server_url + reverse("admin:admin_changelist_parent_changelist")
  1643. )
  1644. Select(self.selenium.find_element(By.NAME, "action")).select_by_value(
  1645. "delete_selected"
  1646. )
  1647. self.selenium.find_element(By.NAME, "_save").click()
  1648. alert = self.selenium.switch_to.alert
  1649. try:
  1650. self.assertEqual(
  1651. alert.text,
  1652. "You have selected an action, and you haven’t made any "
  1653. "changes on individual fields. You’re probably looking for "
  1654. "the Go button rather than the Save button.",
  1655. )
  1656. finally:
  1657. alert.dismiss()
  1658. def test_collapse_filters(self):
  1659. from selenium.webdriver.common.by import By
  1660. self.admin_login(username="super", password="secret")
  1661. self.selenium.get(self.live_server_url + reverse("admin:auth_user_changelist"))
  1662. # The UserAdmin has 3 field filters by default: "staff status",
  1663. # "superuser status", and "active".
  1664. details = self.selenium.find_elements(By.CSS_SELECTOR, "details")
  1665. # All filters are opened at first.
  1666. for detail in details:
  1667. self.assertTrue(detail.get_attribute("open"))
  1668. # Collapse "staff' and "superuser" filters.
  1669. for detail in details[:2]:
  1670. summary = detail.find_element(By.CSS_SELECTOR, "summary")
  1671. summary.click()
  1672. self.assertFalse(detail.get_attribute("open"))
  1673. # Filters are in the same state after refresh.
  1674. self.selenium.refresh()
  1675. self.assertFalse(
  1676. self.selenium.find_element(
  1677. By.CSS_SELECTOR, "[data-filter-title='staff status']"
  1678. ).get_attribute("open")
  1679. )
  1680. self.assertFalse(
  1681. self.selenium.find_element(
  1682. By.CSS_SELECTOR, "[data-filter-title='superuser status']"
  1683. ).get_attribute("open")
  1684. )
  1685. self.assertTrue(
  1686. self.selenium.find_element(
  1687. By.CSS_SELECTOR, "[data-filter-title='active']"
  1688. ).get_attribute("open")
  1689. )
  1690. # Collapse a filter on another view (Bands).
  1691. self.selenium.get(
  1692. self.live_server_url + reverse("admin:admin_changelist_band_changelist")
  1693. )
  1694. self.selenium.find_element(By.CSS_SELECTOR, "summary").click()
  1695. # Go to Users view and then, back again to Bands view.
  1696. self.selenium.get(self.live_server_url + reverse("admin:auth_user_changelist"))
  1697. self.selenium.get(
  1698. self.live_server_url + reverse("admin:admin_changelist_band_changelist")
  1699. )
  1700. # The filter remains in the same state.
  1701. self.assertFalse(
  1702. self.selenium.find_element(
  1703. By.CSS_SELECTOR,
  1704. "[data-filter-title='number of members']",
  1705. ).get_attribute("open")
  1706. )
  1707. def test_collapse_filter_with_unescaped_title(self):
  1708. from selenium.webdriver.common.by import By
  1709. self.admin_login(username="super", password="secret")
  1710. changelist_url = reverse("admin:admin_changelist_proxyuser_changelist")
  1711. self.selenium.get(self.live_server_url + changelist_url)
  1712. # Title is escaped.
  1713. filter_title = self.selenium.find_element(
  1714. By.CSS_SELECTOR, "[data-filter-title='It\\'s OK']"
  1715. )
  1716. filter_title.find_element(By.CSS_SELECTOR, "summary").click()
  1717. self.assertFalse(filter_title.get_attribute("open"))
  1718. # Filter is in the same state after refresh.
  1719. self.selenium.refresh()
  1720. self.assertFalse(
  1721. self.selenium.find_element(
  1722. By.CSS_SELECTOR, "[data-filter-title='It\\'s OK']"
  1723. ).get_attribute("open")
  1724. )