tests.py 79 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158
  1. import os
  2. import unittest
  3. import warnings
  4. from io import StringIO
  5. from unittest import mock
  6. from django.conf import STATICFILES_STORAGE_ALIAS, settings
  7. from django.contrib.staticfiles.finders import get_finder, get_finders
  8. from django.contrib.staticfiles.storage import staticfiles_storage
  9. from django.core.exceptions import ImproperlyConfigured
  10. from django.core.files.storage import default_storage
  11. from django.db import (
  12. IntegrityError,
  13. connection,
  14. connections,
  15. models,
  16. router,
  17. transaction,
  18. )
  19. from django.forms import (
  20. CharField,
  21. EmailField,
  22. Form,
  23. IntegerField,
  24. ValidationError,
  25. formset_factory,
  26. )
  27. from django.http import HttpResponse
  28. from django.template import Context, Template
  29. from django.template.loader import render_to_string
  30. from django.test import (
  31. SimpleTestCase,
  32. TestCase,
  33. TransactionTestCase,
  34. skipIfDBFeature,
  35. skipUnlessDBFeature,
  36. )
  37. from django.test.html import HTMLParseError, parse_html
  38. from django.test.testcases import DatabaseOperationForbidden
  39. from django.test.utils import (
  40. CaptureQueriesContext,
  41. TestContextDecorator,
  42. isolate_apps,
  43. override_settings,
  44. setup_test_environment,
  45. )
  46. from django.urls import NoReverseMatch, path, reverse, reverse_lazy
  47. from django.utils.html import VOID_ELEMENTS
  48. from django.utils.version import PY311
  49. from .models import Car, Person, PossessedCar
  50. from .views import empty_response
  51. class SkippingTestCase(SimpleTestCase):
  52. def _assert_skipping(self, func, expected_exc, msg=None):
  53. try:
  54. if msg is not None:
  55. with self.assertRaisesMessage(expected_exc, msg):
  56. func()
  57. else:
  58. with self.assertRaises(expected_exc):
  59. func()
  60. except unittest.SkipTest:
  61. self.fail("%s should not result in a skipped test." % func.__name__)
  62. def test_skip_unless_db_feature(self):
  63. """
  64. Testing the django.test.skipUnlessDBFeature decorator.
  65. """
  66. # Total hack, but it works, just want an attribute that's always true.
  67. @skipUnlessDBFeature("__class__")
  68. def test_func():
  69. raise ValueError
  70. @skipUnlessDBFeature("notprovided")
  71. def test_func2():
  72. raise ValueError
  73. @skipUnlessDBFeature("__class__", "__class__")
  74. def test_func3():
  75. raise ValueError
  76. @skipUnlessDBFeature("__class__", "notprovided")
  77. def test_func4():
  78. raise ValueError
  79. self._assert_skipping(test_func, ValueError)
  80. self._assert_skipping(test_func2, unittest.SkipTest)
  81. self._assert_skipping(test_func3, ValueError)
  82. self._assert_skipping(test_func4, unittest.SkipTest)
  83. class SkipTestCase(SimpleTestCase):
  84. @skipUnlessDBFeature("missing")
  85. def test_foo(self):
  86. pass
  87. self._assert_skipping(
  88. SkipTestCase("test_foo").test_foo,
  89. ValueError,
  90. "skipUnlessDBFeature cannot be used on test_foo (test_utils.tests."
  91. "SkippingTestCase.test_skip_unless_db_feature.<locals>.SkipTestCase%s) "
  92. "as SkippingTestCase.test_skip_unless_db_feature.<locals>.SkipTestCase "
  93. "doesn't allow queries against the 'default' database."
  94. # Python 3.11 uses fully qualified test name in the output.
  95. % (".test_foo" if PY311 else ""),
  96. )
  97. def test_skip_if_db_feature(self):
  98. """
  99. Testing the django.test.skipIfDBFeature decorator.
  100. """
  101. @skipIfDBFeature("__class__")
  102. def test_func():
  103. raise ValueError
  104. @skipIfDBFeature("notprovided")
  105. def test_func2():
  106. raise ValueError
  107. @skipIfDBFeature("__class__", "__class__")
  108. def test_func3():
  109. raise ValueError
  110. @skipIfDBFeature("__class__", "notprovided")
  111. def test_func4():
  112. raise ValueError
  113. @skipIfDBFeature("notprovided", "notprovided")
  114. def test_func5():
  115. raise ValueError
  116. self._assert_skipping(test_func, unittest.SkipTest)
  117. self._assert_skipping(test_func2, ValueError)
  118. self._assert_skipping(test_func3, unittest.SkipTest)
  119. self._assert_skipping(test_func4, unittest.SkipTest)
  120. self._assert_skipping(test_func5, ValueError)
  121. class SkipTestCase(SimpleTestCase):
  122. @skipIfDBFeature("missing")
  123. def test_foo(self):
  124. pass
  125. self._assert_skipping(
  126. SkipTestCase("test_foo").test_foo,
  127. ValueError,
  128. "skipIfDBFeature cannot be used on test_foo (test_utils.tests."
  129. "SkippingTestCase.test_skip_if_db_feature.<locals>.SkipTestCase%s) "
  130. "as SkippingTestCase.test_skip_if_db_feature.<locals>.SkipTestCase "
  131. "doesn't allow queries against the 'default' database."
  132. # Python 3.11 uses fully qualified test name in the output.
  133. % (".test_foo" if PY311 else ""),
  134. )
  135. class SkippingClassTestCase(TestCase):
  136. def test_skip_class_unless_db_feature(self):
  137. @skipUnlessDBFeature("__class__")
  138. class NotSkippedTests(TestCase):
  139. def test_dummy(self):
  140. return
  141. @skipUnlessDBFeature("missing")
  142. @skipIfDBFeature("__class__")
  143. class SkippedTests(TestCase):
  144. def test_will_be_skipped(self):
  145. self.fail("We should never arrive here.")
  146. @skipIfDBFeature("__dict__")
  147. class SkippedTestsSubclass(SkippedTests):
  148. pass
  149. test_suite = unittest.TestSuite()
  150. test_suite.addTest(NotSkippedTests("test_dummy"))
  151. try:
  152. test_suite.addTest(SkippedTests("test_will_be_skipped"))
  153. test_suite.addTest(SkippedTestsSubclass("test_will_be_skipped"))
  154. except unittest.SkipTest:
  155. self.fail("SkipTest should not be raised here.")
  156. result = unittest.TextTestRunner(stream=StringIO()).run(test_suite)
  157. self.assertEqual(result.testsRun, 3)
  158. self.assertEqual(len(result.skipped), 2)
  159. self.assertEqual(result.skipped[0][1], "Database has feature(s) __class__")
  160. self.assertEqual(result.skipped[1][1], "Database has feature(s) __class__")
  161. def test_missing_default_databases(self):
  162. @skipIfDBFeature("missing")
  163. class MissingDatabases(SimpleTestCase):
  164. def test_assertion_error(self):
  165. pass
  166. suite = unittest.TestSuite()
  167. try:
  168. suite.addTest(MissingDatabases("test_assertion_error"))
  169. except unittest.SkipTest:
  170. self.fail("SkipTest should not be raised at this stage")
  171. runner = unittest.TextTestRunner(stream=StringIO())
  172. msg = (
  173. "skipIfDBFeature cannot be used on <class 'test_utils.tests."
  174. "SkippingClassTestCase.test_missing_default_databases.<locals>."
  175. "MissingDatabases'> as it doesn't allow queries against the "
  176. "'default' database."
  177. )
  178. with self.assertRaisesMessage(ValueError, msg):
  179. runner.run(suite)
  180. @override_settings(ROOT_URLCONF="test_utils.urls")
  181. class AssertNumQueriesTests(TestCase):
  182. def test_assert_num_queries(self):
  183. def test_func():
  184. raise ValueError
  185. with self.assertRaises(ValueError):
  186. self.assertNumQueries(2, test_func)
  187. def test_assert_num_queries_with_client(self):
  188. person = Person.objects.create(name="test")
  189. self.assertNumQueries(
  190. 1, self.client.get, "/test_utils/get_person/%s/" % person.pk
  191. )
  192. self.assertNumQueries(
  193. 1, self.client.get, "/test_utils/get_person/%s/" % person.pk
  194. )
  195. def test_func():
  196. self.client.get("/test_utils/get_person/%s/" % person.pk)
  197. self.client.get("/test_utils/get_person/%s/" % person.pk)
  198. self.assertNumQueries(2, test_func)
  199. class AssertNumQueriesUponConnectionTests(TransactionTestCase):
  200. available_apps = []
  201. def test_ignores_connection_configuration_queries(self):
  202. real_ensure_connection = connection.ensure_connection
  203. connection.close()
  204. def make_configuration_query():
  205. is_opening_connection = connection.connection is None
  206. real_ensure_connection()
  207. if is_opening_connection:
  208. # Avoid infinite recursion. Creating a cursor calls
  209. # ensure_connection() which is currently mocked by this method.
  210. with connection.cursor() as cursor:
  211. cursor.execute("SELECT 1" + connection.features.bare_select_suffix)
  212. ensure_connection = (
  213. "django.db.backends.base.base.BaseDatabaseWrapper.ensure_connection"
  214. )
  215. with mock.patch(ensure_connection, side_effect=make_configuration_query):
  216. with self.assertNumQueries(1):
  217. list(Car.objects.all())
  218. class AssertQuerySetEqualTests(TestCase):
  219. @classmethod
  220. def setUpTestData(cls):
  221. cls.p1 = Person.objects.create(name="p1")
  222. cls.p2 = Person.objects.create(name="p2")
  223. def test_empty(self):
  224. self.assertQuerySetEqual(Person.objects.filter(name="p3"), [])
  225. def test_ordered(self):
  226. self.assertQuerySetEqual(
  227. Person.objects.order_by("name"),
  228. [self.p1, self.p2],
  229. )
  230. def test_unordered(self):
  231. self.assertQuerySetEqual(
  232. Person.objects.order_by("name"), [self.p2, self.p1], ordered=False
  233. )
  234. def test_queryset(self):
  235. self.assertQuerySetEqual(
  236. Person.objects.order_by("name"),
  237. Person.objects.order_by("name"),
  238. )
  239. def test_flat_values_list(self):
  240. self.assertQuerySetEqual(
  241. Person.objects.order_by("name").values_list("name", flat=True),
  242. ["p1", "p2"],
  243. )
  244. def test_transform(self):
  245. self.assertQuerySetEqual(
  246. Person.objects.order_by("name"),
  247. [self.p1.pk, self.p2.pk],
  248. transform=lambda x: x.pk,
  249. )
  250. def test_repr_transform(self):
  251. self.assertQuerySetEqual(
  252. Person.objects.order_by("name"),
  253. [repr(self.p1), repr(self.p2)],
  254. transform=repr,
  255. )
  256. def test_undefined_order(self):
  257. # Using an unordered queryset with more than one ordered value
  258. # is an error.
  259. msg = (
  260. "Trying to compare non-ordered queryset against more than one "
  261. "ordered value."
  262. )
  263. with self.assertRaisesMessage(ValueError, msg):
  264. self.assertQuerySetEqual(
  265. Person.objects.all(),
  266. [self.p1, self.p2],
  267. )
  268. # No error for one value.
  269. self.assertQuerySetEqual(Person.objects.filter(name="p1"), [self.p1])
  270. def test_repeated_values(self):
  271. """
  272. assertQuerySetEqual checks the number of appearance of each item
  273. when used with option ordered=False.
  274. """
  275. batmobile = Car.objects.create(name="Batmobile")
  276. k2000 = Car.objects.create(name="K 2000")
  277. PossessedCar.objects.bulk_create(
  278. [
  279. PossessedCar(car=batmobile, belongs_to=self.p1),
  280. PossessedCar(car=batmobile, belongs_to=self.p1),
  281. PossessedCar(car=k2000, belongs_to=self.p1),
  282. PossessedCar(car=k2000, belongs_to=self.p1),
  283. PossessedCar(car=k2000, belongs_to=self.p1),
  284. PossessedCar(car=k2000, belongs_to=self.p1),
  285. ]
  286. )
  287. with self.assertRaises(AssertionError):
  288. self.assertQuerySetEqual(
  289. self.p1.cars.all(), [batmobile, k2000], ordered=False
  290. )
  291. self.assertQuerySetEqual(
  292. self.p1.cars.all(), [batmobile] * 2 + [k2000] * 4, ordered=False
  293. )
  294. def test_maxdiff(self):
  295. names = ["Joe Smith %s" % i for i in range(20)]
  296. Person.objects.bulk_create([Person(name=name) for name in names])
  297. names.append("Extra Person")
  298. with self.assertRaises(AssertionError) as ctx:
  299. self.assertQuerySetEqual(
  300. Person.objects.filter(name__startswith="Joe"),
  301. names,
  302. ordered=False,
  303. transform=lambda p: p.name,
  304. )
  305. self.assertIn("Set self.maxDiff to None to see it.", str(ctx.exception))
  306. original = self.maxDiff
  307. self.maxDiff = None
  308. try:
  309. with self.assertRaises(AssertionError) as ctx:
  310. self.assertQuerySetEqual(
  311. Person.objects.filter(name__startswith="Joe"),
  312. names,
  313. ordered=False,
  314. transform=lambda p: p.name,
  315. )
  316. finally:
  317. self.maxDiff = original
  318. exception_msg = str(ctx.exception)
  319. self.assertNotIn("Set self.maxDiff to None to see it.", exception_msg)
  320. for name in names:
  321. self.assertIn(name, exception_msg)
  322. @override_settings(ROOT_URLCONF="test_utils.urls")
  323. class CaptureQueriesContextManagerTests(TestCase):
  324. @classmethod
  325. def setUpTestData(cls):
  326. cls.person_pk = str(Person.objects.create(name="test").pk)
  327. def test_simple(self):
  328. with CaptureQueriesContext(connection) as captured_queries:
  329. Person.objects.get(pk=self.person_pk)
  330. self.assertEqual(len(captured_queries), 1)
  331. self.assertIn(self.person_pk, captured_queries[0]["sql"])
  332. with CaptureQueriesContext(connection) as captured_queries:
  333. pass
  334. self.assertEqual(0, len(captured_queries))
  335. def test_within(self):
  336. with CaptureQueriesContext(connection) as captured_queries:
  337. Person.objects.get(pk=self.person_pk)
  338. self.assertEqual(len(captured_queries), 1)
  339. self.assertIn(self.person_pk, captured_queries[0]["sql"])
  340. def test_nested(self):
  341. with CaptureQueriesContext(connection) as captured_queries:
  342. Person.objects.count()
  343. with CaptureQueriesContext(connection) as nested_captured_queries:
  344. Person.objects.count()
  345. self.assertEqual(1, len(nested_captured_queries))
  346. self.assertEqual(2, len(captured_queries))
  347. def test_failure(self):
  348. with self.assertRaises(TypeError):
  349. with CaptureQueriesContext(connection):
  350. raise TypeError
  351. def test_with_client(self):
  352. with CaptureQueriesContext(connection) as captured_queries:
  353. self.client.get("/test_utils/get_person/%s/" % self.person_pk)
  354. self.assertEqual(len(captured_queries), 1)
  355. self.assertIn(self.person_pk, captured_queries[0]["sql"])
  356. with CaptureQueriesContext(connection) as captured_queries:
  357. self.client.get("/test_utils/get_person/%s/" % self.person_pk)
  358. self.assertEqual(len(captured_queries), 1)
  359. self.assertIn(self.person_pk, captured_queries[0]["sql"])
  360. with CaptureQueriesContext(connection) as captured_queries:
  361. self.client.get("/test_utils/get_person/%s/" % self.person_pk)
  362. self.client.get("/test_utils/get_person/%s/" % self.person_pk)
  363. self.assertEqual(len(captured_queries), 2)
  364. self.assertIn(self.person_pk, captured_queries[0]["sql"])
  365. self.assertIn(self.person_pk, captured_queries[1]["sql"])
  366. @override_settings(ROOT_URLCONF="test_utils.urls")
  367. class AssertNumQueriesContextManagerTests(TestCase):
  368. def test_simple(self):
  369. with self.assertNumQueries(0):
  370. pass
  371. with self.assertNumQueries(1):
  372. Person.objects.count()
  373. with self.assertNumQueries(2):
  374. Person.objects.count()
  375. Person.objects.count()
  376. def test_failure(self):
  377. msg = "1 != 2 : 1 queries executed, 2 expected\nCaptured queries were:\n1."
  378. with self.assertRaisesMessage(AssertionError, msg):
  379. with self.assertNumQueries(2):
  380. Person.objects.count()
  381. with self.assertRaises(TypeError):
  382. with self.assertNumQueries(4000):
  383. raise TypeError
  384. def test_with_client(self):
  385. person = Person.objects.create(name="test")
  386. with self.assertNumQueries(1):
  387. self.client.get("/test_utils/get_person/%s/" % person.pk)
  388. with self.assertNumQueries(1):
  389. self.client.get("/test_utils/get_person/%s/" % person.pk)
  390. with self.assertNumQueries(2):
  391. self.client.get("/test_utils/get_person/%s/" % person.pk)
  392. self.client.get("/test_utils/get_person/%s/" % person.pk)
  393. @override_settings(ROOT_URLCONF="test_utils.urls")
  394. class AssertTemplateUsedContextManagerTests(SimpleTestCase):
  395. def test_usage(self):
  396. with self.assertTemplateUsed("template_used/base.html"):
  397. render_to_string("template_used/base.html")
  398. with self.assertTemplateUsed(template_name="template_used/base.html"):
  399. render_to_string("template_used/base.html")
  400. with self.assertTemplateUsed("template_used/base.html"):
  401. render_to_string("template_used/include.html")
  402. with self.assertTemplateUsed("template_used/base.html"):
  403. render_to_string("template_used/extends.html")
  404. with self.assertTemplateUsed("template_used/base.html"):
  405. render_to_string("template_used/base.html")
  406. render_to_string("template_used/base.html")
  407. def test_nested_usage(self):
  408. with self.assertTemplateUsed("template_used/base.html"):
  409. with self.assertTemplateUsed("template_used/include.html"):
  410. render_to_string("template_used/include.html")
  411. with self.assertTemplateUsed("template_used/extends.html"):
  412. with self.assertTemplateUsed("template_used/base.html"):
  413. render_to_string("template_used/extends.html")
  414. with self.assertTemplateUsed("template_used/base.html"):
  415. with self.assertTemplateUsed("template_used/alternative.html"):
  416. render_to_string("template_used/alternative.html")
  417. render_to_string("template_used/base.html")
  418. with self.assertTemplateUsed("template_used/base.html"):
  419. render_to_string("template_used/extends.html")
  420. with self.assertTemplateNotUsed("template_used/base.html"):
  421. render_to_string("template_used/alternative.html")
  422. render_to_string("template_used/base.html")
  423. def test_not_used(self):
  424. with self.assertTemplateNotUsed("template_used/base.html"):
  425. pass
  426. with self.assertTemplateNotUsed("template_used/alternative.html"):
  427. pass
  428. def test_error_message(self):
  429. msg = "No templates used to render the response"
  430. with self.assertRaisesMessage(AssertionError, msg):
  431. with self.assertTemplateUsed("template_used/base.html"):
  432. pass
  433. with self.assertRaisesMessage(AssertionError, msg):
  434. with self.assertTemplateUsed(template_name="template_used/base.html"):
  435. pass
  436. msg2 = (
  437. "Template 'template_used/base.html' was not a template used to render "
  438. "the response. Actual template(s) used: template_used/alternative.html"
  439. )
  440. with self.assertRaisesMessage(AssertionError, msg2):
  441. with self.assertTemplateUsed("template_used/base.html"):
  442. render_to_string("template_used/alternative.html")
  443. msg = "No templates used to render the response"
  444. with self.assertRaisesMessage(AssertionError, msg):
  445. response = self.client.get("/test_utils/no_template_used/")
  446. self.assertTemplateUsed(response, "template_used/base.html")
  447. with self.assertRaisesMessage(AssertionError, msg):
  448. with self.assertTemplateUsed("template_used/base.html"):
  449. self.client.get("/test_utils/no_template_used/")
  450. with self.assertRaisesMessage(AssertionError, msg):
  451. with self.assertTemplateUsed("template_used/base.html"):
  452. template = Template("template_used/alternative.html", name=None)
  453. template.render(Context())
  454. def test_msg_prefix(self):
  455. msg_prefix = "Prefix"
  456. msg = f"{msg_prefix}: No templates used to render the response"
  457. with self.assertRaisesMessage(AssertionError, msg):
  458. with self.assertTemplateUsed(
  459. "template_used/base.html", msg_prefix=msg_prefix
  460. ):
  461. pass
  462. with self.assertRaisesMessage(AssertionError, msg):
  463. with self.assertTemplateUsed(
  464. template_name="template_used/base.html",
  465. msg_prefix=msg_prefix,
  466. ):
  467. pass
  468. msg = (
  469. f"{msg_prefix}: Template 'template_used/base.html' was not a "
  470. f"template used to render the response. Actual template(s) used: "
  471. f"template_used/alternative.html"
  472. )
  473. with self.assertRaisesMessage(AssertionError, msg):
  474. with self.assertTemplateUsed(
  475. "template_used/base.html", msg_prefix=msg_prefix
  476. ):
  477. render_to_string("template_used/alternative.html")
  478. def test_count(self):
  479. with self.assertTemplateUsed("template_used/base.html", count=2):
  480. render_to_string("template_used/base.html")
  481. render_to_string("template_used/base.html")
  482. msg = (
  483. "Template 'template_used/base.html' was expected to be rendered "
  484. "3 time(s) but was actually rendered 2 time(s)."
  485. )
  486. with self.assertRaisesMessage(AssertionError, msg):
  487. with self.assertTemplateUsed("template_used/base.html", count=3):
  488. render_to_string("template_used/base.html")
  489. render_to_string("template_used/base.html")
  490. def test_failure(self):
  491. msg = "response and/or template_name argument must be provided"
  492. with self.assertRaisesMessage(TypeError, msg):
  493. with self.assertTemplateUsed():
  494. pass
  495. msg = "No templates used to render the response"
  496. with self.assertRaisesMessage(AssertionError, msg):
  497. with self.assertTemplateUsed(""):
  498. pass
  499. with self.assertRaisesMessage(AssertionError, msg):
  500. with self.assertTemplateUsed(""):
  501. render_to_string("template_used/base.html")
  502. with self.assertRaisesMessage(AssertionError, msg):
  503. with self.assertTemplateUsed(template_name=""):
  504. pass
  505. msg = (
  506. "Template 'template_used/base.html' was not a template used to "
  507. "render the response. Actual template(s) used: "
  508. "template_used/alternative.html"
  509. )
  510. with self.assertRaisesMessage(AssertionError, msg):
  511. with self.assertTemplateUsed("template_used/base.html"):
  512. render_to_string("template_used/alternative.html")
  513. def test_assert_used_on_http_response(self):
  514. response = HttpResponse()
  515. msg = "%s() is only usable on responses fetched using the Django test Client."
  516. with self.assertRaisesMessage(ValueError, msg % "assertTemplateUsed"):
  517. self.assertTemplateUsed(response, "template.html")
  518. with self.assertRaisesMessage(ValueError, msg % "assertTemplateNotUsed"):
  519. self.assertTemplateNotUsed(response, "template.html")
  520. class HTMLEqualTests(SimpleTestCase):
  521. def test_html_parser(self):
  522. element = parse_html("<div><p>Hello</p></div>")
  523. self.assertEqual(len(element.children), 1)
  524. self.assertEqual(element.children[0].name, "p")
  525. self.assertEqual(element.children[0].children[0], "Hello")
  526. parse_html("<p>")
  527. parse_html("<p attr>")
  528. dom = parse_html("<p>foo")
  529. self.assertEqual(len(dom.children), 1)
  530. self.assertEqual(dom.name, "p")
  531. self.assertEqual(dom[0], "foo")
  532. def test_parse_html_in_script(self):
  533. parse_html('<script>var a = "<p" + ">";</script>')
  534. parse_html(
  535. """
  536. <script>
  537. var js_sha_link='<p>***</p>';
  538. </script>
  539. """
  540. )
  541. # script content will be parsed to text
  542. dom = parse_html(
  543. """
  544. <script><p>foo</p> '</scr'+'ipt>' <span>bar</span></script>
  545. """
  546. )
  547. self.assertEqual(len(dom.children), 1)
  548. self.assertEqual(dom.children[0], "<p>foo</p> '</scr'+'ipt>' <span>bar</span>")
  549. def test_void_elements(self):
  550. for tag in VOID_ELEMENTS:
  551. with self.subTest(tag):
  552. dom = parse_html("<p>Hello <%s> world</p>" % tag)
  553. self.assertEqual(len(dom.children), 3)
  554. self.assertEqual(dom[0], "Hello")
  555. self.assertEqual(dom[1].name, tag)
  556. self.assertEqual(dom[2], "world")
  557. dom = parse_html("<p>Hello <%s /> world</p>" % tag)
  558. self.assertEqual(len(dom.children), 3)
  559. self.assertEqual(dom[0], "Hello")
  560. self.assertEqual(dom[1].name, tag)
  561. self.assertEqual(dom[2], "world")
  562. def test_simple_equal_html(self):
  563. self.assertHTMLEqual("", "")
  564. self.assertHTMLEqual("<p></p>", "<p></p>")
  565. self.assertHTMLEqual("<p></p>", " <p> </p> ")
  566. self.assertHTMLEqual("<div><p>Hello</p></div>", "<div><p>Hello</p></div>")
  567. self.assertHTMLEqual("<div><p>Hello</p></div>", "<div> <p>Hello</p> </div>")
  568. self.assertHTMLEqual("<div>\n<p>Hello</p></div>", "<div><p>Hello</p></div>\n")
  569. self.assertHTMLEqual(
  570. "<div><p>Hello\nWorld !</p></div>", "<div><p>Hello World\n!</p></div>"
  571. )
  572. self.assertHTMLEqual(
  573. "<div><p>Hello\nWorld !</p></div>", "<div><p>Hello World\n!</p></div>"
  574. )
  575. self.assertHTMLEqual("<p>Hello World !</p>", "<p>Hello World\n\n!</p>")
  576. self.assertHTMLEqual("<p> </p>", "<p></p>")
  577. self.assertHTMLEqual("<p/>", "<p></p>")
  578. self.assertHTMLEqual("<p />", "<p></p>")
  579. self.assertHTMLEqual("<input checked>", '<input checked="checked">')
  580. self.assertHTMLEqual("<p>Hello", "<p> Hello")
  581. self.assertHTMLEqual("<p>Hello</p>World", "<p>Hello</p> World")
  582. def test_ignore_comments(self):
  583. self.assertHTMLEqual(
  584. "<div>Hello<!-- this is a comment --> World!</div>",
  585. "<div>Hello World!</div>",
  586. )
  587. def test_unequal_html(self):
  588. self.assertHTMLNotEqual("<p>Hello</p>", "<p>Hello!</p>")
  589. self.assertHTMLNotEqual("<p>foo&#20;bar</p>", "<p>foo&nbsp;bar</p>")
  590. self.assertHTMLNotEqual("<p>foo bar</p>", "<p>foo &nbsp;bar</p>")
  591. self.assertHTMLNotEqual("<p>foo nbsp</p>", "<p>foo &nbsp;</p>")
  592. self.assertHTMLNotEqual("<p>foo #20</p>", "<p>foo &#20;</p>")
  593. self.assertHTMLNotEqual(
  594. "<p><span>Hello</span><span>World</span></p>",
  595. "<p><span>Hello</span>World</p>",
  596. )
  597. self.assertHTMLNotEqual(
  598. "<p><span>Hello</span>World</p>",
  599. "<p><span>Hello</span><span>World</span></p>",
  600. )
  601. def test_attributes(self):
  602. self.assertHTMLEqual(
  603. '<input type="text" id="id_name" />', '<input id="id_name" type="text" />'
  604. )
  605. self.assertHTMLEqual(
  606. """<input type='text' id="id_name" />""",
  607. '<input id="id_name" type="text" />',
  608. )
  609. self.assertHTMLNotEqual(
  610. '<input type="text" id="id_name" />',
  611. '<input type="password" id="id_name" />',
  612. )
  613. def test_class_attribute(self):
  614. pairs = [
  615. ('<p class="foo bar"></p>', '<p class="bar foo"></p>'),
  616. ('<p class=" foo bar "></p>', '<p class="bar foo"></p>'),
  617. ('<p class=" foo bar "></p>', '<p class="bar foo"></p>'),
  618. ('<p class="foo\tbar"></p>', '<p class="bar foo"></p>'),
  619. ('<p class="\tfoo\tbar\t"></p>', '<p class="bar foo"></p>'),
  620. ('<p class="\t\t\tfoo\t\t\tbar\t\t\t"></p>', '<p class="bar foo"></p>'),
  621. ('<p class="\t \nfoo \t\nbar\n\t "></p>', '<p class="bar foo"></p>'),
  622. ]
  623. for html1, html2 in pairs:
  624. with self.subTest(html1):
  625. self.assertHTMLEqual(html1, html2)
  626. def test_boolean_attribute(self):
  627. html1 = "<input checked>"
  628. html2 = '<input checked="">'
  629. html3 = '<input checked="checked">'
  630. self.assertHTMLEqual(html1, html2)
  631. self.assertHTMLEqual(html1, html3)
  632. self.assertHTMLEqual(html2, html3)
  633. self.assertHTMLNotEqual(html1, '<input checked="invalid">')
  634. self.assertEqual(str(parse_html(html1)), "<input checked>")
  635. self.assertEqual(str(parse_html(html2)), "<input checked>")
  636. self.assertEqual(str(parse_html(html3)), "<input checked>")
  637. def test_non_boolean_attibutes(self):
  638. html1 = "<input value>"
  639. html2 = '<input value="">'
  640. html3 = '<input value="value">'
  641. self.assertHTMLEqual(html1, html2)
  642. self.assertHTMLNotEqual(html1, html3)
  643. self.assertEqual(str(parse_html(html1)), '<input value="">')
  644. self.assertEqual(str(parse_html(html2)), '<input value="">')
  645. def test_normalize_refs(self):
  646. pairs = [
  647. ("&#39;", "&#x27;"),
  648. ("&#39;", "'"),
  649. ("&#x27;", "&#39;"),
  650. ("&#x27;", "'"),
  651. ("'", "&#39;"),
  652. ("'", "&#x27;"),
  653. ("&amp;", "&#38;"),
  654. ("&amp;", "&#x26;"),
  655. ("&amp;", "&"),
  656. ("&#38;", "&amp;"),
  657. ("&#38;", "&#x26;"),
  658. ("&#38;", "&"),
  659. ("&#x26;", "&amp;"),
  660. ("&#x26;", "&#38;"),
  661. ("&#x26;", "&"),
  662. ("&", "&amp;"),
  663. ("&", "&#38;"),
  664. ("&", "&#x26;"),
  665. ]
  666. for pair in pairs:
  667. with self.subTest(repr(pair)):
  668. self.assertHTMLEqual(*pair)
  669. def test_complex_examples(self):
  670. self.assertHTMLEqual(
  671. """<tr><th><label for="id_first_name">First name:</label></th>
  672. <td><input type="text" name="first_name" value="John" id="id_first_name" /></td></tr>
  673. <tr><th><label for="id_last_name">Last name:</label></th>
  674. <td><input type="text" id="id_last_name" name="last_name" value="Lennon" /></td></tr>
  675. <tr><th><label for="id_birthday">Birthday:</label></th>
  676. <td><input type="text" value="1940-10-9" name="birthday" id="id_birthday" /></td></tr>""", # NOQA
  677. """
  678. <tr><th>
  679. <label for="id_first_name">First name:</label></th><td>
  680. <input type="text" name="first_name" value="John" id="id_first_name" />
  681. </td></tr>
  682. <tr><th>
  683. <label for="id_last_name">Last name:</label></th><td>
  684. <input type="text" name="last_name" value="Lennon" id="id_last_name" />
  685. </td></tr>
  686. <tr><th>
  687. <label for="id_birthday">Birthday:</label></th><td>
  688. <input type="text" name="birthday" value="1940-10-9" id="id_birthday" />
  689. </td></tr>
  690. """,
  691. )
  692. self.assertHTMLEqual(
  693. """<!DOCTYPE html>
  694. <html>
  695. <head>
  696. <link rel="stylesheet">
  697. <title>Document</title>
  698. <meta attribute="value">
  699. </head>
  700. <body>
  701. <p>
  702. This is a valid paragraph
  703. <div> this is a div AFTER the p</div>
  704. </body>
  705. </html>""",
  706. """
  707. <html>
  708. <head>
  709. <link rel="stylesheet">
  710. <title>Document</title>
  711. <meta attribute="value">
  712. </head>
  713. <body>
  714. <p> This is a valid paragraph
  715. <!-- browsers would close the p tag here -->
  716. <div> this is a div AFTER the p</div>
  717. </p> <!-- this is invalid HTML parsing, but it should make no
  718. difference in most cases -->
  719. </body>
  720. </html>""",
  721. )
  722. def test_html_contain(self):
  723. # equal html contains each other
  724. dom1 = parse_html("<p>foo")
  725. dom2 = parse_html("<p>foo</p>")
  726. self.assertIn(dom1, dom2)
  727. self.assertIn(dom2, dom1)
  728. dom2 = parse_html("<div><p>foo</p></div>")
  729. self.assertIn(dom1, dom2)
  730. self.assertNotIn(dom2, dom1)
  731. self.assertNotIn("<p>foo</p>", dom2)
  732. self.assertIn("foo", dom2)
  733. # when a root element is used ...
  734. dom1 = parse_html("<p>foo</p><p>bar</p>")
  735. dom2 = parse_html("<p>foo</p><p>bar</p>")
  736. self.assertIn(dom1, dom2)
  737. dom1 = parse_html("<p>foo</p>")
  738. self.assertIn(dom1, dom2)
  739. dom1 = parse_html("<p>bar</p>")
  740. self.assertIn(dom1, dom2)
  741. dom1 = parse_html("<div><p>foo</p><p>bar</p></div>")
  742. self.assertIn(dom2, dom1)
  743. def test_count(self):
  744. # equal html contains each other one time
  745. dom1 = parse_html("<p>foo")
  746. dom2 = parse_html("<p>foo</p>")
  747. self.assertEqual(dom1.count(dom2), 1)
  748. self.assertEqual(dom2.count(dom1), 1)
  749. dom2 = parse_html("<p>foo</p><p>bar</p>")
  750. self.assertEqual(dom2.count(dom1), 1)
  751. dom2 = parse_html("<p>foo foo</p><p>foo</p>")
  752. self.assertEqual(dom2.count("foo"), 3)
  753. dom2 = parse_html('<p class="bar">foo</p>')
  754. self.assertEqual(dom2.count("bar"), 0)
  755. self.assertEqual(dom2.count("class"), 0)
  756. self.assertEqual(dom2.count("p"), 0)
  757. self.assertEqual(dom2.count("o"), 2)
  758. dom2 = parse_html("<p>foo</p><p>foo</p>")
  759. self.assertEqual(dom2.count(dom1), 2)
  760. dom2 = parse_html('<div><p>foo<input type=""></p><p>foo</p></div>')
  761. self.assertEqual(dom2.count(dom1), 1)
  762. dom2 = parse_html("<div><div><p>foo</p></div></div>")
  763. self.assertEqual(dom2.count(dom1), 1)
  764. dom2 = parse_html("<p>foo<p>foo</p></p>")
  765. self.assertEqual(dom2.count(dom1), 1)
  766. dom2 = parse_html("<p>foo<p>bar</p></p>")
  767. self.assertEqual(dom2.count(dom1), 0)
  768. # HTML with a root element contains the same HTML with no root element.
  769. dom1 = parse_html("<p>foo</p><p>bar</p>")
  770. dom2 = parse_html("<div><p>foo</p><p>bar</p></div>")
  771. self.assertEqual(dom2.count(dom1), 1)
  772. # Target of search is a sequence of child elements and appears more
  773. # than once.
  774. dom2 = parse_html("<div><p>foo</p><p>bar</p><p>foo</p><p>bar</p></div>")
  775. self.assertEqual(dom2.count(dom1), 2)
  776. # Searched HTML has additional children.
  777. dom1 = parse_html("<a/><b/>")
  778. dom2 = parse_html("<a/><b/><c/>")
  779. self.assertEqual(dom2.count(dom1), 1)
  780. # No match found in children.
  781. dom1 = parse_html("<b/><a/>")
  782. self.assertEqual(dom2.count(dom1), 0)
  783. # Target of search found among children and grandchildren.
  784. dom1 = parse_html("<b/><b/>")
  785. dom2 = parse_html("<a><b/><b/></a><b/><b/>")
  786. self.assertEqual(dom2.count(dom1), 2)
  787. def test_root_element_escaped_html(self):
  788. html = "&lt;br&gt;"
  789. parsed = parse_html(html)
  790. self.assertEqual(str(parsed), html)
  791. def test_parsing_errors(self):
  792. with self.assertRaises(AssertionError):
  793. self.assertHTMLEqual("<p>", "")
  794. with self.assertRaises(AssertionError):
  795. self.assertHTMLEqual("", "<p>")
  796. error_msg = (
  797. "First argument is not valid HTML:\n"
  798. "('Unexpected end tag `div` (Line 1, Column 6)', (1, 6))"
  799. )
  800. with self.assertRaisesMessage(AssertionError, error_msg):
  801. self.assertHTMLEqual("< div></ div>", "<div></div>")
  802. with self.assertRaises(HTMLParseError):
  803. parse_html("</p>")
  804. def test_escaped_html_errors(self):
  805. msg = "<p>\n<foo>\n</p> != <p>\n&lt;foo&gt;\n</p>\n"
  806. with self.assertRaisesMessage(AssertionError, msg):
  807. self.assertHTMLEqual("<p><foo></p>", "<p>&lt;foo&gt;</p>")
  808. with self.assertRaisesMessage(AssertionError, msg):
  809. self.assertHTMLEqual("<p><foo></p>", "<p>&#60;foo&#62;</p>")
  810. def test_contains_html(self):
  811. response = HttpResponse(
  812. """<body>
  813. This is a form: <form method="get">
  814. <input type="text" name="Hello" />
  815. </form></body>"""
  816. )
  817. self.assertNotContains(response, "<input name='Hello' type='text'>")
  818. self.assertContains(response, '<form method="get">')
  819. self.assertContains(response, "<input name='Hello' type='text'>", html=True)
  820. self.assertNotContains(response, '<form method="get">', html=True)
  821. invalid_response = HttpResponse("""<body <bad>>""")
  822. with self.assertRaises(AssertionError):
  823. self.assertContains(invalid_response, "<p></p>")
  824. with self.assertRaises(AssertionError):
  825. self.assertContains(response, '<p "whats" that>')
  826. def test_unicode_handling(self):
  827. response = HttpResponse(
  828. '<p class="help">Some help text for the title (with Unicode ŠĐĆŽćžšđ)</p>'
  829. )
  830. self.assertContains(
  831. response,
  832. '<p class="help">Some help text for the title (with Unicode ŠĐĆŽćžšđ)</p>',
  833. html=True,
  834. )
  835. class InHTMLTests(SimpleTestCase):
  836. def test_needle_msg(self):
  837. msg = "False is not true : Couldn't find '<b>Hello</b>' in response"
  838. with self.assertRaisesMessage(AssertionError, msg):
  839. self.assertInHTML("<b>Hello</b>", "<p>Test</p>")
  840. class JSONEqualTests(SimpleTestCase):
  841. def test_simple_equal(self):
  842. json1 = '{"attr1": "foo", "attr2":"baz"}'
  843. json2 = '{"attr1": "foo", "attr2":"baz"}'
  844. self.assertJSONEqual(json1, json2)
  845. def test_simple_equal_unordered(self):
  846. json1 = '{"attr1": "foo", "attr2":"baz"}'
  847. json2 = '{"attr2":"baz", "attr1": "foo"}'
  848. self.assertJSONEqual(json1, json2)
  849. def test_simple_equal_raise(self):
  850. json1 = '{"attr1": "foo", "attr2":"baz"}'
  851. json2 = '{"attr2":"baz"}'
  852. with self.assertRaises(AssertionError):
  853. self.assertJSONEqual(json1, json2)
  854. def test_equal_parsing_errors(self):
  855. invalid_json = '{"attr1": "foo, "attr2":"baz"}'
  856. valid_json = '{"attr1": "foo", "attr2":"baz"}'
  857. with self.assertRaises(AssertionError):
  858. self.assertJSONEqual(invalid_json, valid_json)
  859. with self.assertRaises(AssertionError):
  860. self.assertJSONEqual(valid_json, invalid_json)
  861. def test_simple_not_equal(self):
  862. json1 = '{"attr1": "foo", "attr2":"baz"}'
  863. json2 = '{"attr2":"baz"}'
  864. self.assertJSONNotEqual(json1, json2)
  865. def test_simple_not_equal_raise(self):
  866. json1 = '{"attr1": "foo", "attr2":"baz"}'
  867. json2 = '{"attr1": "foo", "attr2":"baz"}'
  868. with self.assertRaises(AssertionError):
  869. self.assertJSONNotEqual(json1, json2)
  870. def test_not_equal_parsing_errors(self):
  871. invalid_json = '{"attr1": "foo, "attr2":"baz"}'
  872. valid_json = '{"attr1": "foo", "attr2":"baz"}'
  873. with self.assertRaises(AssertionError):
  874. self.assertJSONNotEqual(invalid_json, valid_json)
  875. with self.assertRaises(AssertionError):
  876. self.assertJSONNotEqual(valid_json, invalid_json)
  877. class XMLEqualTests(SimpleTestCase):
  878. def test_simple_equal(self):
  879. xml1 = "<elem attr1='a' attr2='b' />"
  880. xml2 = "<elem attr1='a' attr2='b' />"
  881. self.assertXMLEqual(xml1, xml2)
  882. def test_simple_equal_unordered(self):
  883. xml1 = "<elem attr1='a' attr2='b' />"
  884. xml2 = "<elem attr2='b' attr1='a' />"
  885. self.assertXMLEqual(xml1, xml2)
  886. def test_simple_equal_raise(self):
  887. xml1 = "<elem attr1='a' />"
  888. xml2 = "<elem attr2='b' attr1='a' />"
  889. with self.assertRaises(AssertionError):
  890. self.assertXMLEqual(xml1, xml2)
  891. def test_simple_equal_raises_message(self):
  892. xml1 = "<elem attr1='a' />"
  893. xml2 = "<elem attr2='b' attr1='a' />"
  894. msg = """{xml1} != {xml2}
  895. - <elem attr1='a' />
  896. + <elem attr2='b' attr1='a' />
  897. ? ++++++++++
  898. """.format(
  899. xml1=repr(xml1), xml2=repr(xml2)
  900. )
  901. with self.assertRaisesMessage(AssertionError, msg):
  902. self.assertXMLEqual(xml1, xml2)
  903. def test_simple_not_equal(self):
  904. xml1 = "<elem attr1='a' attr2='c' />"
  905. xml2 = "<elem attr1='a' attr2='b' />"
  906. self.assertXMLNotEqual(xml1, xml2)
  907. def test_simple_not_equal_raise(self):
  908. xml1 = "<elem attr1='a' attr2='b' />"
  909. xml2 = "<elem attr2='b' attr1='a' />"
  910. with self.assertRaises(AssertionError):
  911. self.assertXMLNotEqual(xml1, xml2)
  912. def test_parsing_errors(self):
  913. xml_unvalid = "<elem attr1='a attr2='b' />"
  914. xml2 = "<elem attr2='b' attr1='a' />"
  915. with self.assertRaises(AssertionError):
  916. self.assertXMLNotEqual(xml_unvalid, xml2)
  917. def test_comment_root(self):
  918. xml1 = "<?xml version='1.0'?><!-- comment1 --><elem attr1='a' attr2='b' />"
  919. xml2 = "<?xml version='1.0'?><!-- comment2 --><elem attr2='b' attr1='a' />"
  920. self.assertXMLEqual(xml1, xml2)
  921. def test_simple_equal_with_leading_or_trailing_whitespace(self):
  922. xml1 = "<elem>foo</elem> \t\n"
  923. xml2 = " \t\n<elem>foo</elem>"
  924. self.assertXMLEqual(xml1, xml2)
  925. def test_simple_not_equal_with_whitespace_in_the_middle(self):
  926. xml1 = "<elem>foo</elem><elem>bar</elem>"
  927. xml2 = "<elem>foo</elem> <elem>bar</elem>"
  928. self.assertXMLNotEqual(xml1, xml2)
  929. def test_doctype_root(self):
  930. xml1 = '<?xml version="1.0"?><!DOCTYPE root SYSTEM "example1.dtd"><root />'
  931. xml2 = '<?xml version="1.0"?><!DOCTYPE root SYSTEM "example2.dtd"><root />'
  932. self.assertXMLEqual(xml1, xml2)
  933. def test_processing_instruction(self):
  934. xml1 = (
  935. '<?xml version="1.0"?>'
  936. '<?xml-model href="http://www.example1.com"?><root />'
  937. )
  938. xml2 = (
  939. '<?xml version="1.0"?>'
  940. '<?xml-model href="http://www.example2.com"?><root />'
  941. )
  942. self.assertXMLEqual(xml1, xml2)
  943. self.assertXMLEqual(
  944. '<?xml-stylesheet href="style1.xslt" type="text/xsl"?><root />',
  945. '<?xml-stylesheet href="style2.xslt" type="text/xsl"?><root />',
  946. )
  947. class SkippingExtraTests(TestCase):
  948. fixtures = ["should_not_be_loaded.json"]
  949. # HACK: This depends on internals of our TestCase subclasses
  950. def __call__(self, result=None):
  951. # Detect fixture loading by counting SQL queries, should be zero
  952. with self.assertNumQueries(0):
  953. super().__call__(result)
  954. @unittest.skip("Fixture loading should not be performed for skipped tests.")
  955. def test_fixtures_are_skipped(self):
  956. pass
  957. class AssertRaisesMsgTest(SimpleTestCase):
  958. def test_assert_raises_message(self):
  959. msg = "'Expected message' not found in 'Unexpected message'"
  960. # context manager form of assertRaisesMessage()
  961. with self.assertRaisesMessage(AssertionError, msg):
  962. with self.assertRaisesMessage(ValueError, "Expected message"):
  963. raise ValueError("Unexpected message")
  964. # callable form
  965. def func():
  966. raise ValueError("Unexpected message")
  967. with self.assertRaisesMessage(AssertionError, msg):
  968. self.assertRaisesMessage(ValueError, "Expected message", func)
  969. def test_special_re_chars(self):
  970. """assertRaisesMessage shouldn't interpret RE special chars."""
  971. def func1():
  972. raise ValueError("[.*x+]y?")
  973. with self.assertRaisesMessage(ValueError, "[.*x+]y?"):
  974. func1()
  975. class AssertWarnsMessageTests(SimpleTestCase):
  976. def test_context_manager(self):
  977. with self.assertWarnsMessage(UserWarning, "Expected message"):
  978. warnings.warn("Expected message", UserWarning)
  979. def test_context_manager_failure(self):
  980. msg = "Expected message' not found in 'Unexpected message'"
  981. with self.assertRaisesMessage(AssertionError, msg):
  982. with self.assertWarnsMessage(UserWarning, "Expected message"):
  983. warnings.warn("Unexpected message", UserWarning)
  984. def test_callable(self):
  985. def func():
  986. warnings.warn("Expected message", UserWarning)
  987. self.assertWarnsMessage(UserWarning, "Expected message", func)
  988. def test_special_re_chars(self):
  989. def func1():
  990. warnings.warn("[.*x+]y?", UserWarning)
  991. with self.assertWarnsMessage(UserWarning, "[.*x+]y?"):
  992. func1()
  993. class AssertFieldOutputTests(SimpleTestCase):
  994. def test_assert_field_output(self):
  995. error_invalid = ["Enter a valid email address."]
  996. self.assertFieldOutput(
  997. EmailField, {"a@a.com": "a@a.com"}, {"aaa": error_invalid}
  998. )
  999. with self.assertRaises(AssertionError):
  1000. self.assertFieldOutput(
  1001. EmailField,
  1002. {"a@a.com": "a@a.com"},
  1003. {"aaa": error_invalid + ["Another error"]},
  1004. )
  1005. with self.assertRaises(AssertionError):
  1006. self.assertFieldOutput(
  1007. EmailField, {"a@a.com": "Wrong output"}, {"aaa": error_invalid}
  1008. )
  1009. with self.assertRaises(AssertionError):
  1010. self.assertFieldOutput(
  1011. EmailField,
  1012. {"a@a.com": "a@a.com"},
  1013. {"aaa": ["Come on, gimme some well formatted data, dude."]},
  1014. )
  1015. def test_custom_required_message(self):
  1016. class MyCustomField(IntegerField):
  1017. default_error_messages = {
  1018. "required": "This is really required.",
  1019. }
  1020. self.assertFieldOutput(MyCustomField, {}, {}, empty_value=None)
  1021. @override_settings(ROOT_URLCONF="test_utils.urls")
  1022. class AssertURLEqualTests(SimpleTestCase):
  1023. def test_equal(self):
  1024. valid_tests = (
  1025. ("http://example.com/?", "http://example.com/"),
  1026. ("http://example.com/?x=1&", "http://example.com/?x=1"),
  1027. ("http://example.com/?x=1&y=2", "http://example.com/?y=2&x=1"),
  1028. ("http://example.com/?x=1&y=2", "http://example.com/?y=2&x=1"),
  1029. (
  1030. "http://example.com/?x=1&y=2&a=1&a=2",
  1031. "http://example.com/?a=1&a=2&y=2&x=1",
  1032. ),
  1033. ("/path/to/?x=1&y=2&z=3", "/path/to/?z=3&y=2&x=1"),
  1034. ("?x=1&y=2&z=3", "?z=3&y=2&x=1"),
  1035. ("/test_utils/no_template_used/", reverse_lazy("no_template_used")),
  1036. )
  1037. for url1, url2 in valid_tests:
  1038. with self.subTest(url=url1):
  1039. self.assertURLEqual(url1, url2)
  1040. def test_not_equal(self):
  1041. invalid_tests = (
  1042. # Protocol must be the same.
  1043. ("http://example.com/", "https://example.com/"),
  1044. ("http://example.com/?x=1&x=2", "https://example.com/?x=2&x=1"),
  1045. ("http://example.com/?x=1&y=bar&x=2", "https://example.com/?y=bar&x=2&x=1"),
  1046. # Parameters of the same name must be in the same order.
  1047. ("/path/to?a=1&a=2", "/path/to/?a=2&a=1"),
  1048. )
  1049. for url1, url2 in invalid_tests:
  1050. with self.subTest(url=url1), self.assertRaises(AssertionError):
  1051. self.assertURLEqual(url1, url2)
  1052. def test_message(self):
  1053. msg = (
  1054. "Expected 'http://example.com/?x=1&x=2' to equal "
  1055. "'https://example.com/?x=2&x=1'"
  1056. )
  1057. with self.assertRaisesMessage(AssertionError, msg):
  1058. self.assertURLEqual(
  1059. "http://example.com/?x=1&x=2", "https://example.com/?x=2&x=1"
  1060. )
  1061. def test_msg_prefix(self):
  1062. msg = (
  1063. "Prefix: Expected 'http://example.com/?x=1&x=2' to equal "
  1064. "'https://example.com/?x=2&x=1'"
  1065. )
  1066. with self.assertRaisesMessage(AssertionError, msg):
  1067. self.assertURLEqual(
  1068. "http://example.com/?x=1&x=2",
  1069. "https://example.com/?x=2&x=1",
  1070. msg_prefix="Prefix: ",
  1071. )
  1072. class TestForm(Form):
  1073. field = CharField()
  1074. def clean_field(self):
  1075. value = self.cleaned_data.get("field", "")
  1076. if value == "invalid":
  1077. raise ValidationError("invalid value")
  1078. return value
  1079. def clean(self):
  1080. if self.cleaned_data.get("field") == "invalid_non_field":
  1081. raise ValidationError("non-field error")
  1082. return self.cleaned_data
  1083. @classmethod
  1084. def _get_cleaned_form(cls, field_value):
  1085. form = cls({"field": field_value})
  1086. form.full_clean()
  1087. return form
  1088. @classmethod
  1089. def valid(cls):
  1090. return cls._get_cleaned_form("valid")
  1091. @classmethod
  1092. def invalid(cls, nonfield=False):
  1093. return cls._get_cleaned_form("invalid_non_field" if nonfield else "invalid")
  1094. class TestFormset(formset_factory(TestForm)):
  1095. @classmethod
  1096. def _get_cleaned_formset(cls, field_value):
  1097. formset = cls(
  1098. {
  1099. "form-TOTAL_FORMS": "1",
  1100. "form-INITIAL_FORMS": "0",
  1101. "form-0-field": field_value,
  1102. }
  1103. )
  1104. formset.full_clean()
  1105. return formset
  1106. @classmethod
  1107. def valid(cls):
  1108. return cls._get_cleaned_formset("valid")
  1109. @classmethod
  1110. def invalid(cls, nonfield=False, nonform=False):
  1111. if nonform:
  1112. formset = cls({}, error_messages={"missing_management_form": "error"})
  1113. formset.full_clean()
  1114. return formset
  1115. return cls._get_cleaned_formset("invalid_non_field" if nonfield else "invalid")
  1116. class AssertFormErrorTests(SimpleTestCase):
  1117. def test_single_error(self):
  1118. self.assertFormError(TestForm.invalid(), "field", "invalid value")
  1119. def test_error_list(self):
  1120. self.assertFormError(TestForm.invalid(), "field", ["invalid value"])
  1121. def test_empty_errors_valid_form(self):
  1122. self.assertFormError(TestForm.valid(), "field", [])
  1123. def test_empty_errors_valid_form_non_field_errors(self):
  1124. self.assertFormError(TestForm.valid(), None, [])
  1125. def test_field_not_in_form(self):
  1126. msg = (
  1127. "The form <TestForm bound=True, valid=False, fields=(field)> does not "
  1128. "contain the field 'other_field'."
  1129. )
  1130. with self.assertRaisesMessage(AssertionError, msg):
  1131. self.assertFormError(TestForm.invalid(), "other_field", "invalid value")
  1132. msg_prefix = "Custom prefix"
  1133. with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
  1134. self.assertFormError(
  1135. TestForm.invalid(),
  1136. "other_field",
  1137. "invalid value",
  1138. msg_prefix=msg_prefix,
  1139. )
  1140. def test_field_with_no_errors(self):
  1141. msg = (
  1142. "The errors of field 'field' on form <TestForm bound=True, valid=True, "
  1143. "fields=(field)> don't match."
  1144. )
  1145. with self.assertRaisesMessage(AssertionError, msg) as ctx:
  1146. self.assertFormError(TestForm.valid(), "field", "invalid value")
  1147. self.assertIn("[] != ['invalid value']", str(ctx.exception))
  1148. msg_prefix = "Custom prefix"
  1149. with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
  1150. self.assertFormError(
  1151. TestForm.valid(), "field", "invalid value", msg_prefix=msg_prefix
  1152. )
  1153. def test_field_with_different_error(self):
  1154. msg = (
  1155. "The errors of field 'field' on form <TestForm bound=True, valid=False, "
  1156. "fields=(field)> don't match."
  1157. )
  1158. with self.assertRaisesMessage(AssertionError, msg) as ctx:
  1159. self.assertFormError(TestForm.invalid(), "field", "other error")
  1160. self.assertIn("['invalid value'] != ['other error']", str(ctx.exception))
  1161. msg_prefix = "Custom prefix"
  1162. with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
  1163. self.assertFormError(
  1164. TestForm.invalid(), "field", "other error", msg_prefix=msg_prefix
  1165. )
  1166. def test_unbound_form(self):
  1167. msg = (
  1168. "The form <TestForm bound=False, valid=Unknown, fields=(field)> is not "
  1169. "bound, it will never have any errors."
  1170. )
  1171. with self.assertRaisesMessage(AssertionError, msg):
  1172. self.assertFormError(TestForm(), "field", [])
  1173. msg_prefix = "Custom prefix"
  1174. with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
  1175. self.assertFormError(TestForm(), "field", [], msg_prefix=msg_prefix)
  1176. def test_empty_errors_invalid_form(self):
  1177. msg = (
  1178. "The errors of field 'field' on form <TestForm bound=True, valid=False, "
  1179. "fields=(field)> don't match."
  1180. )
  1181. with self.assertRaisesMessage(AssertionError, msg) as ctx:
  1182. self.assertFormError(TestForm.invalid(), "field", [])
  1183. self.assertIn("['invalid value'] != []", str(ctx.exception))
  1184. def test_non_field_errors(self):
  1185. self.assertFormError(TestForm.invalid(nonfield=True), None, "non-field error")
  1186. def test_different_non_field_errors(self):
  1187. msg = (
  1188. "The non-field errors of form <TestForm bound=True, valid=False, "
  1189. "fields=(field)> don't match."
  1190. )
  1191. with self.assertRaisesMessage(AssertionError, msg) as ctx:
  1192. self.assertFormError(
  1193. TestForm.invalid(nonfield=True), None, "other non-field error"
  1194. )
  1195. self.assertIn(
  1196. "['non-field error'] != ['other non-field error']", str(ctx.exception)
  1197. )
  1198. msg_prefix = "Custom prefix"
  1199. with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
  1200. self.assertFormError(
  1201. TestForm.invalid(nonfield=True),
  1202. None,
  1203. "other non-field error",
  1204. msg_prefix=msg_prefix,
  1205. )
  1206. class AssertFormSetErrorTests(SimpleTestCase):
  1207. def test_single_error(self):
  1208. self.assertFormSetError(TestFormset.invalid(), 0, "field", "invalid value")
  1209. def test_error_list(self):
  1210. self.assertFormSetError(TestFormset.invalid(), 0, "field", ["invalid value"])
  1211. def test_empty_errors_valid_formset(self):
  1212. self.assertFormSetError(TestFormset.valid(), 0, "field", [])
  1213. def test_multiple_forms(self):
  1214. formset = TestFormset(
  1215. {
  1216. "form-TOTAL_FORMS": "2",
  1217. "form-INITIAL_FORMS": "0",
  1218. "form-0-field": "valid",
  1219. "form-1-field": "invalid",
  1220. }
  1221. )
  1222. formset.full_clean()
  1223. self.assertFormSetError(formset, 0, "field", [])
  1224. self.assertFormSetError(formset, 1, "field", ["invalid value"])
  1225. def test_field_not_in_form(self):
  1226. msg = (
  1227. "The form 0 of formset <TestFormset: bound=True valid=False total_forms=1> "
  1228. "does not contain the field 'other_field'."
  1229. )
  1230. with self.assertRaisesMessage(AssertionError, msg):
  1231. self.assertFormSetError(
  1232. TestFormset.invalid(), 0, "other_field", "invalid value"
  1233. )
  1234. msg_prefix = "Custom prefix"
  1235. with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
  1236. self.assertFormSetError(
  1237. TestFormset.invalid(),
  1238. 0,
  1239. "other_field",
  1240. "invalid value",
  1241. msg_prefix=msg_prefix,
  1242. )
  1243. def test_field_with_no_errors(self):
  1244. msg = (
  1245. "The errors of field 'field' on form 0 of formset <TestFormset: bound=True "
  1246. "valid=True total_forms=1> don't match."
  1247. )
  1248. with self.assertRaisesMessage(AssertionError, msg) as ctx:
  1249. self.assertFormSetError(TestFormset.valid(), 0, "field", "invalid value")
  1250. self.assertIn("[] != ['invalid value']", str(ctx.exception))
  1251. msg_prefix = "Custom prefix"
  1252. with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
  1253. self.assertFormSetError(
  1254. TestFormset.valid(), 0, "field", "invalid value", msg_prefix=msg_prefix
  1255. )
  1256. def test_field_with_different_error(self):
  1257. msg = (
  1258. "The errors of field 'field' on form 0 of formset <TestFormset: bound=True "
  1259. "valid=False total_forms=1> don't match."
  1260. )
  1261. with self.assertRaisesMessage(AssertionError, msg) as ctx:
  1262. self.assertFormSetError(TestFormset.invalid(), 0, "field", "other error")
  1263. self.assertIn("['invalid value'] != ['other error']", str(ctx.exception))
  1264. msg_prefix = "Custom prefix"
  1265. with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
  1266. self.assertFormSetError(
  1267. TestFormset.invalid(), 0, "field", "other error", msg_prefix=msg_prefix
  1268. )
  1269. def test_unbound_formset(self):
  1270. msg = (
  1271. "The formset <TestFormset: bound=False valid=Unknown total_forms=1> is not "
  1272. "bound, it will never have any errors."
  1273. )
  1274. with self.assertRaisesMessage(AssertionError, msg):
  1275. self.assertFormSetError(TestFormset(), 0, "field", [])
  1276. def test_empty_errors_invalid_formset(self):
  1277. msg = (
  1278. "The errors of field 'field' on form 0 of formset <TestFormset: bound=True "
  1279. "valid=False total_forms=1> don't match."
  1280. )
  1281. with self.assertRaisesMessage(AssertionError, msg) as ctx:
  1282. self.assertFormSetError(TestFormset.invalid(), 0, "field", [])
  1283. self.assertIn("['invalid value'] != []", str(ctx.exception))
  1284. def test_non_field_errors(self):
  1285. self.assertFormSetError(
  1286. TestFormset.invalid(nonfield=True), 0, None, "non-field error"
  1287. )
  1288. def test_different_non_field_errors(self):
  1289. msg = (
  1290. "The non-field errors of form 0 of formset <TestFormset: bound=True "
  1291. "valid=False total_forms=1> don't match."
  1292. )
  1293. with self.assertRaisesMessage(AssertionError, msg) as ctx:
  1294. self.assertFormSetError(
  1295. TestFormset.invalid(nonfield=True), 0, None, "other non-field error"
  1296. )
  1297. self.assertIn(
  1298. "['non-field error'] != ['other non-field error']", str(ctx.exception)
  1299. )
  1300. msg_prefix = "Custom prefix"
  1301. with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
  1302. self.assertFormSetError(
  1303. TestFormset.invalid(nonfield=True),
  1304. 0,
  1305. None,
  1306. "other non-field error",
  1307. msg_prefix=msg_prefix,
  1308. )
  1309. def test_no_non_field_errors(self):
  1310. msg = (
  1311. "The non-field errors of form 0 of formset <TestFormset: bound=True "
  1312. "valid=False total_forms=1> don't match."
  1313. )
  1314. with self.assertRaisesMessage(AssertionError, msg) as ctx:
  1315. self.assertFormSetError(TestFormset.invalid(), 0, None, "non-field error")
  1316. self.assertIn("[] != ['non-field error']", str(ctx.exception))
  1317. msg_prefix = "Custom prefix"
  1318. with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
  1319. self.assertFormSetError(
  1320. TestFormset.invalid(), 0, None, "non-field error", msg_prefix=msg_prefix
  1321. )
  1322. def test_non_form_errors(self):
  1323. self.assertFormSetError(TestFormset.invalid(nonform=True), None, None, "error")
  1324. def test_different_non_form_errors(self):
  1325. msg = (
  1326. "The non-form errors of formset <TestFormset: bound=True valid=False "
  1327. "total_forms=0> don't match."
  1328. )
  1329. with self.assertRaisesMessage(AssertionError, msg) as ctx:
  1330. self.assertFormSetError(
  1331. TestFormset.invalid(nonform=True), None, None, "other error"
  1332. )
  1333. self.assertIn("['error'] != ['other error']", str(ctx.exception))
  1334. msg_prefix = "Custom prefix"
  1335. with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
  1336. self.assertFormSetError(
  1337. TestFormset.invalid(nonform=True),
  1338. None,
  1339. None,
  1340. "other error",
  1341. msg_prefix=msg_prefix,
  1342. )
  1343. def test_no_non_form_errors(self):
  1344. msg = (
  1345. "The non-form errors of formset <TestFormset: bound=True valid=False "
  1346. "total_forms=1> don't match."
  1347. )
  1348. with self.assertRaisesMessage(AssertionError, msg) as ctx:
  1349. self.assertFormSetError(TestFormset.invalid(), None, None, "error")
  1350. self.assertIn("[] != ['error']", str(ctx.exception))
  1351. msg_prefix = "Custom prefix"
  1352. with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
  1353. self.assertFormSetError(
  1354. TestFormset.invalid(),
  1355. None,
  1356. None,
  1357. "error",
  1358. msg_prefix=msg_prefix,
  1359. )
  1360. def test_non_form_errors_with_field(self):
  1361. msg = "You must use field=None with form_index=None."
  1362. with self.assertRaisesMessage(ValueError, msg):
  1363. self.assertFormSetError(
  1364. TestFormset.invalid(nonform=True), None, "field", "error"
  1365. )
  1366. def test_form_index_too_big(self):
  1367. msg = (
  1368. "The formset <TestFormset: bound=True valid=False total_forms=1> only has "
  1369. "1 form."
  1370. )
  1371. with self.assertRaisesMessage(AssertionError, msg):
  1372. self.assertFormSetError(TestFormset.invalid(), 2, "field", "error")
  1373. def test_form_index_too_big_plural(self):
  1374. formset = TestFormset(
  1375. {
  1376. "form-TOTAL_FORMS": "2",
  1377. "form-INITIAL_FORMS": "0",
  1378. "form-0-field": "valid",
  1379. "form-1-field": "valid",
  1380. }
  1381. )
  1382. formset.full_clean()
  1383. msg = (
  1384. "The formset <TestFormset: bound=True valid=True total_forms=2> only has 2 "
  1385. "forms."
  1386. )
  1387. with self.assertRaisesMessage(AssertionError, msg):
  1388. self.assertFormSetError(formset, 2, "field", "error")
  1389. class FirstUrls:
  1390. urlpatterns = [path("first/", empty_response, name="first")]
  1391. class SecondUrls:
  1392. urlpatterns = [path("second/", empty_response, name="second")]
  1393. class SetupTestEnvironmentTests(SimpleTestCase):
  1394. def test_setup_test_environment_calling_more_than_once(self):
  1395. with self.assertRaisesMessage(
  1396. RuntimeError, "setup_test_environment() was already called"
  1397. ):
  1398. setup_test_environment()
  1399. def test_allowed_hosts(self):
  1400. for type_ in (list, tuple):
  1401. with self.subTest(type_=type_):
  1402. allowed_hosts = type_("*")
  1403. with mock.patch("django.test.utils._TestState") as x:
  1404. del x.saved_data
  1405. with self.settings(ALLOWED_HOSTS=allowed_hosts):
  1406. setup_test_environment()
  1407. self.assertEqual(settings.ALLOWED_HOSTS, ["*", "testserver"])
  1408. class OverrideSettingsTests(SimpleTestCase):
  1409. # #21518 -- If neither override_settings nor a setting_changed receiver
  1410. # clears the URL cache between tests, then one of test_first or
  1411. # test_second will fail.
  1412. @override_settings(ROOT_URLCONF=FirstUrls)
  1413. def test_urlconf_first(self):
  1414. reverse("first")
  1415. @override_settings(ROOT_URLCONF=SecondUrls)
  1416. def test_urlconf_second(self):
  1417. reverse("second")
  1418. def test_urlconf_cache(self):
  1419. with self.assertRaises(NoReverseMatch):
  1420. reverse("first")
  1421. with self.assertRaises(NoReverseMatch):
  1422. reverse("second")
  1423. with override_settings(ROOT_URLCONF=FirstUrls):
  1424. self.client.get(reverse("first"))
  1425. with self.assertRaises(NoReverseMatch):
  1426. reverse("second")
  1427. with override_settings(ROOT_URLCONF=SecondUrls):
  1428. with self.assertRaises(NoReverseMatch):
  1429. reverse("first")
  1430. self.client.get(reverse("second"))
  1431. self.client.get(reverse("first"))
  1432. with self.assertRaises(NoReverseMatch):
  1433. reverse("second")
  1434. with self.assertRaises(NoReverseMatch):
  1435. reverse("first")
  1436. with self.assertRaises(NoReverseMatch):
  1437. reverse("second")
  1438. def test_override_media_root(self):
  1439. """
  1440. Overriding the MEDIA_ROOT setting should be reflected in the
  1441. base_location attribute of django.core.files.storage.default_storage.
  1442. """
  1443. self.assertEqual(default_storage.base_location, "")
  1444. with self.settings(MEDIA_ROOT="test_value"):
  1445. self.assertEqual(default_storage.base_location, "test_value")
  1446. def test_override_media_url(self):
  1447. """
  1448. Overriding the MEDIA_URL setting should be reflected in the
  1449. base_url attribute of django.core.files.storage.default_storage.
  1450. """
  1451. self.assertEqual(default_storage.base_location, "")
  1452. with self.settings(MEDIA_URL="/test_value/"):
  1453. self.assertEqual(default_storage.base_url, "/test_value/")
  1454. def test_override_file_upload_permissions(self):
  1455. """
  1456. Overriding the FILE_UPLOAD_PERMISSIONS setting should be reflected in
  1457. the file_permissions_mode attribute of
  1458. django.core.files.storage.default_storage.
  1459. """
  1460. self.assertEqual(default_storage.file_permissions_mode, 0o644)
  1461. with self.settings(FILE_UPLOAD_PERMISSIONS=0o777):
  1462. self.assertEqual(default_storage.file_permissions_mode, 0o777)
  1463. def test_override_file_upload_directory_permissions(self):
  1464. """
  1465. Overriding the FILE_UPLOAD_DIRECTORY_PERMISSIONS setting should be
  1466. reflected in the directory_permissions_mode attribute of
  1467. django.core.files.storage.default_storage.
  1468. """
  1469. self.assertIsNone(default_storage.directory_permissions_mode)
  1470. with self.settings(FILE_UPLOAD_DIRECTORY_PERMISSIONS=0o777):
  1471. self.assertEqual(default_storage.directory_permissions_mode, 0o777)
  1472. def test_override_database_routers(self):
  1473. """
  1474. Overriding DATABASE_ROUTERS should update the base router.
  1475. """
  1476. test_routers = [object()]
  1477. with self.settings(DATABASE_ROUTERS=test_routers):
  1478. self.assertEqual(router.routers, test_routers)
  1479. def test_override_static_url(self):
  1480. """
  1481. Overriding the STATIC_URL setting should be reflected in the
  1482. base_url attribute of
  1483. django.contrib.staticfiles.storage.staticfiles_storage.
  1484. """
  1485. with self.settings(STATIC_URL="/test/"):
  1486. self.assertEqual(staticfiles_storage.base_url, "/test/")
  1487. def test_override_static_root(self):
  1488. """
  1489. Overriding the STATIC_ROOT setting should be reflected in the
  1490. location attribute of
  1491. django.contrib.staticfiles.storage.staticfiles_storage.
  1492. """
  1493. with self.settings(STATIC_ROOT="/tmp/test"):
  1494. self.assertEqual(staticfiles_storage.location, os.path.abspath("/tmp/test"))
  1495. def test_override_staticfiles_storage(self):
  1496. """
  1497. Overriding the STORAGES setting should be reflected in
  1498. the value of django.contrib.staticfiles.storage.staticfiles_storage.
  1499. """
  1500. new_class = "ManifestStaticFilesStorage"
  1501. new_storage = "django.contrib.staticfiles.storage." + new_class
  1502. with self.settings(
  1503. STORAGES={STATICFILES_STORAGE_ALIAS: {"BACKEND": new_storage}}
  1504. ):
  1505. self.assertEqual(staticfiles_storage.__class__.__name__, new_class)
  1506. def test_override_staticfiles_finders(self):
  1507. """
  1508. Overriding the STATICFILES_FINDERS setting should be reflected in
  1509. the return value of django.contrib.staticfiles.finders.get_finders.
  1510. """
  1511. current = get_finders()
  1512. self.assertGreater(len(list(current)), 1)
  1513. finders = ["django.contrib.staticfiles.finders.FileSystemFinder"]
  1514. with self.settings(STATICFILES_FINDERS=finders):
  1515. self.assertEqual(len(list(get_finders())), len(finders))
  1516. def test_override_staticfiles_dirs(self):
  1517. """
  1518. Overriding the STATICFILES_DIRS setting should be reflected in
  1519. the locations attribute of the
  1520. django.contrib.staticfiles.finders.FileSystemFinder instance.
  1521. """
  1522. finder = get_finder("django.contrib.staticfiles.finders.FileSystemFinder")
  1523. test_path = "/tmp/test"
  1524. expected_location = ("", test_path)
  1525. self.assertNotIn(expected_location, finder.locations)
  1526. with self.settings(STATICFILES_DIRS=[test_path]):
  1527. finder = get_finder("django.contrib.staticfiles.finders.FileSystemFinder")
  1528. self.assertIn(expected_location, finder.locations)
  1529. @skipUnlessDBFeature("supports_transactions")
  1530. class TestBadSetUpTestData(TestCase):
  1531. """
  1532. An exception in setUpTestData() shouldn't leak a transaction which would
  1533. cascade across the rest of the test suite.
  1534. """
  1535. class MyException(Exception):
  1536. pass
  1537. @classmethod
  1538. def setUpClass(cls):
  1539. try:
  1540. super().setUpClass()
  1541. except cls.MyException:
  1542. cls._in_atomic_block = connection.in_atomic_block
  1543. @classmethod
  1544. def tearDownClass(Cls):
  1545. # override to avoid a second cls._rollback_atomics() which would fail.
  1546. # Normal setUpClass() methods won't have exception handling so this
  1547. # method wouldn't typically be run.
  1548. pass
  1549. @classmethod
  1550. def setUpTestData(cls):
  1551. # Simulate a broken setUpTestData() method.
  1552. raise cls.MyException()
  1553. def test_failure_in_setUpTestData_should_rollback_transaction(self):
  1554. # setUpTestData() should call _rollback_atomics() so that the
  1555. # transaction doesn't leak.
  1556. self.assertFalse(self._in_atomic_block)
  1557. @skipUnlessDBFeature("supports_transactions")
  1558. class CaptureOnCommitCallbacksTests(TestCase):
  1559. databases = {"default", "other"}
  1560. callback_called = False
  1561. def enqueue_callback(self, using="default"):
  1562. def hook():
  1563. self.callback_called = True
  1564. transaction.on_commit(hook, using=using)
  1565. def test_no_arguments(self):
  1566. with self.captureOnCommitCallbacks() as callbacks:
  1567. self.enqueue_callback()
  1568. self.assertEqual(len(callbacks), 1)
  1569. self.assertIs(self.callback_called, False)
  1570. callbacks[0]()
  1571. self.assertIs(self.callback_called, True)
  1572. def test_using(self):
  1573. with self.captureOnCommitCallbacks(using="other") as callbacks:
  1574. self.enqueue_callback(using="other")
  1575. self.assertEqual(len(callbacks), 1)
  1576. self.assertIs(self.callback_called, False)
  1577. callbacks[0]()
  1578. self.assertIs(self.callback_called, True)
  1579. def test_different_using(self):
  1580. with self.captureOnCommitCallbacks(using="default") as callbacks:
  1581. self.enqueue_callback(using="other")
  1582. self.assertEqual(callbacks, [])
  1583. def test_execute(self):
  1584. with self.captureOnCommitCallbacks(execute=True) as callbacks:
  1585. self.enqueue_callback()
  1586. self.assertEqual(len(callbacks), 1)
  1587. self.assertIs(self.callback_called, True)
  1588. def test_pre_callback(self):
  1589. def pre_hook():
  1590. pass
  1591. transaction.on_commit(pre_hook, using="default")
  1592. with self.captureOnCommitCallbacks() as callbacks:
  1593. self.enqueue_callback()
  1594. self.assertEqual(len(callbacks), 1)
  1595. self.assertNotEqual(callbacks[0], pre_hook)
  1596. def test_with_rolled_back_savepoint(self):
  1597. with self.captureOnCommitCallbacks() as callbacks:
  1598. try:
  1599. with transaction.atomic():
  1600. self.enqueue_callback()
  1601. raise IntegrityError
  1602. except IntegrityError:
  1603. # Inner transaction.atomic() has been rolled back.
  1604. pass
  1605. self.assertEqual(callbacks, [])
  1606. def test_execute_recursive(self):
  1607. with self.captureOnCommitCallbacks(execute=True) as callbacks:
  1608. transaction.on_commit(self.enqueue_callback)
  1609. self.assertEqual(len(callbacks), 2)
  1610. self.assertIs(self.callback_called, True)
  1611. def test_execute_tree(self):
  1612. """
  1613. A visualisation of the callback tree tested. Each node is expected to
  1614. be visited only once:
  1615. └─branch_1
  1616. ├─branch_2
  1617. │ ├─leaf_1
  1618. │ └─leaf_2
  1619. └─leaf_3
  1620. """
  1621. branch_1_call_counter = 0
  1622. branch_2_call_counter = 0
  1623. leaf_1_call_counter = 0
  1624. leaf_2_call_counter = 0
  1625. leaf_3_call_counter = 0
  1626. def leaf_1():
  1627. nonlocal leaf_1_call_counter
  1628. leaf_1_call_counter += 1
  1629. def leaf_2():
  1630. nonlocal leaf_2_call_counter
  1631. leaf_2_call_counter += 1
  1632. def leaf_3():
  1633. nonlocal leaf_3_call_counter
  1634. leaf_3_call_counter += 1
  1635. def branch_1():
  1636. nonlocal branch_1_call_counter
  1637. branch_1_call_counter += 1
  1638. transaction.on_commit(branch_2)
  1639. transaction.on_commit(leaf_3)
  1640. def branch_2():
  1641. nonlocal branch_2_call_counter
  1642. branch_2_call_counter += 1
  1643. transaction.on_commit(leaf_1)
  1644. transaction.on_commit(leaf_2)
  1645. with self.captureOnCommitCallbacks(execute=True) as callbacks:
  1646. transaction.on_commit(branch_1)
  1647. self.assertEqual(branch_1_call_counter, 1)
  1648. self.assertEqual(branch_2_call_counter, 1)
  1649. self.assertEqual(leaf_1_call_counter, 1)
  1650. self.assertEqual(leaf_2_call_counter, 1)
  1651. self.assertEqual(leaf_3_call_counter, 1)
  1652. self.assertEqual(callbacks, [branch_1, branch_2, leaf_3, leaf_1, leaf_2])
  1653. def test_execute_robust(self):
  1654. class MyException(Exception):
  1655. pass
  1656. def hook():
  1657. self.callback_called = True
  1658. raise MyException("robust callback")
  1659. with self.assertLogs("django.test", "ERROR") as cm:
  1660. with self.captureOnCommitCallbacks(execute=True) as callbacks:
  1661. transaction.on_commit(hook, robust=True)
  1662. self.assertEqual(len(callbacks), 1)
  1663. self.assertIs(self.callback_called, True)
  1664. log_record = cm.records[0]
  1665. self.assertEqual(
  1666. log_record.getMessage(),
  1667. "Error calling CaptureOnCommitCallbacksTests.test_execute_robust.<locals>."
  1668. "hook in on_commit() (robust callback).",
  1669. )
  1670. self.assertIsNotNone(log_record.exc_info)
  1671. raised_exception = log_record.exc_info[1]
  1672. self.assertIsInstance(raised_exception, MyException)
  1673. self.assertEqual(str(raised_exception), "robust callback")
  1674. class DisallowedDatabaseQueriesTests(SimpleTestCase):
  1675. def test_disallowed_database_connections(self):
  1676. expected_message = (
  1677. "Database connections to 'default' are not allowed in SimpleTestCase "
  1678. "subclasses. Either subclass TestCase or TransactionTestCase to "
  1679. "ensure proper test isolation or add 'default' to "
  1680. "test_utils.tests.DisallowedDatabaseQueriesTests.databases to "
  1681. "silence this failure."
  1682. )
  1683. with self.assertRaisesMessage(DatabaseOperationForbidden, expected_message):
  1684. connection.connect()
  1685. with self.assertRaisesMessage(DatabaseOperationForbidden, expected_message):
  1686. connection.temporary_connection()
  1687. def test_disallowed_database_queries(self):
  1688. expected_message = (
  1689. "Database queries to 'default' are not allowed in SimpleTestCase "
  1690. "subclasses. Either subclass TestCase or TransactionTestCase to "
  1691. "ensure proper test isolation or add 'default' to "
  1692. "test_utils.tests.DisallowedDatabaseQueriesTests.databases to "
  1693. "silence this failure."
  1694. )
  1695. with self.assertRaisesMessage(DatabaseOperationForbidden, expected_message):
  1696. Car.objects.first()
  1697. def test_disallowed_database_chunked_cursor_queries(self):
  1698. expected_message = (
  1699. "Database queries to 'default' are not allowed in SimpleTestCase "
  1700. "subclasses. Either subclass TestCase or TransactionTestCase to "
  1701. "ensure proper test isolation or add 'default' to "
  1702. "test_utils.tests.DisallowedDatabaseQueriesTests.databases to "
  1703. "silence this failure."
  1704. )
  1705. with self.assertRaisesMessage(DatabaseOperationForbidden, expected_message):
  1706. next(Car.objects.iterator())
  1707. class AllowedDatabaseQueriesTests(SimpleTestCase):
  1708. databases = {"default"}
  1709. def test_allowed_database_queries(self):
  1710. Car.objects.first()
  1711. def test_allowed_database_chunked_cursor_queries(self):
  1712. next(Car.objects.iterator(), None)
  1713. class DatabaseAliasTests(SimpleTestCase):
  1714. def setUp(self):
  1715. self.addCleanup(setattr, self.__class__, "databases", self.databases)
  1716. def test_no_close_match(self):
  1717. self.__class__.databases = {"void"}
  1718. message = (
  1719. "test_utils.tests.DatabaseAliasTests.databases refers to 'void' which is "
  1720. "not defined in settings.DATABASES."
  1721. )
  1722. with self.assertRaisesMessage(ImproperlyConfigured, message):
  1723. self._validate_databases()
  1724. def test_close_match(self):
  1725. self.__class__.databases = {"defualt"}
  1726. message = (
  1727. "test_utils.tests.DatabaseAliasTests.databases refers to 'defualt' which "
  1728. "is not defined in settings.DATABASES. Did you mean 'default'?"
  1729. )
  1730. with self.assertRaisesMessage(ImproperlyConfigured, message):
  1731. self._validate_databases()
  1732. def test_match(self):
  1733. self.__class__.databases = {"default", "other"}
  1734. self.assertEqual(self._validate_databases(), frozenset({"default", "other"}))
  1735. def test_all(self):
  1736. self.__class__.databases = "__all__"
  1737. self.assertEqual(self._validate_databases(), frozenset(connections))
  1738. @isolate_apps("test_utils", attr_name="class_apps")
  1739. class IsolatedAppsTests(SimpleTestCase):
  1740. def test_installed_apps(self):
  1741. self.assertEqual(
  1742. [app_config.label for app_config in self.class_apps.get_app_configs()],
  1743. ["test_utils"],
  1744. )
  1745. def test_class_decoration(self):
  1746. class ClassDecoration(models.Model):
  1747. pass
  1748. self.assertEqual(ClassDecoration._meta.apps, self.class_apps)
  1749. @isolate_apps("test_utils", kwarg_name="method_apps")
  1750. def test_method_decoration(self, method_apps):
  1751. class MethodDecoration(models.Model):
  1752. pass
  1753. self.assertEqual(MethodDecoration._meta.apps, method_apps)
  1754. def test_context_manager(self):
  1755. with isolate_apps("test_utils") as context_apps:
  1756. class ContextManager(models.Model):
  1757. pass
  1758. self.assertEqual(ContextManager._meta.apps, context_apps)
  1759. @isolate_apps("test_utils", kwarg_name="method_apps")
  1760. def test_nested(self, method_apps):
  1761. class MethodDecoration(models.Model):
  1762. pass
  1763. with isolate_apps("test_utils") as context_apps:
  1764. class ContextManager(models.Model):
  1765. pass
  1766. with isolate_apps("test_utils") as nested_context_apps:
  1767. class NestedContextManager(models.Model):
  1768. pass
  1769. self.assertEqual(MethodDecoration._meta.apps, method_apps)
  1770. self.assertEqual(ContextManager._meta.apps, context_apps)
  1771. self.assertEqual(NestedContextManager._meta.apps, nested_context_apps)
  1772. class DoNothingDecorator(TestContextDecorator):
  1773. def enable(self):
  1774. pass
  1775. def disable(self):
  1776. pass
  1777. class TestContextDecoratorTests(SimpleTestCase):
  1778. @mock.patch.object(DoNothingDecorator, "disable")
  1779. def test_exception_in_setup(self, mock_disable):
  1780. """An exception is setUp() is reraised after disable() is called."""
  1781. class ExceptionInSetUp(unittest.TestCase):
  1782. def setUp(self):
  1783. raise NotImplementedError("reraised")
  1784. decorator = DoNothingDecorator()
  1785. decorated_test_class = decorator.__call__(ExceptionInSetUp)()
  1786. self.assertFalse(mock_disable.called)
  1787. with self.assertRaisesMessage(NotImplementedError, "reraised"):
  1788. decorated_test_class.setUp()
  1789. decorated_test_class.doCleanups()
  1790. self.assertTrue(mock_disable.called)
  1791. def test_cleanups_run_after_tearDown(self):
  1792. calls = []
  1793. class SaveCallsDecorator(TestContextDecorator):
  1794. def enable(self):
  1795. calls.append("enable")
  1796. def disable(self):
  1797. calls.append("disable")
  1798. class AddCleanupInSetUp(unittest.TestCase):
  1799. def setUp(self):
  1800. calls.append("setUp")
  1801. self.addCleanup(lambda: calls.append("cleanup"))
  1802. decorator = SaveCallsDecorator()
  1803. decorated_test_class = decorator.__call__(AddCleanupInSetUp)()
  1804. decorated_test_class.setUp()
  1805. decorated_test_class.tearDown()
  1806. decorated_test_class.doCleanups()
  1807. self.assertEqual(calls, ["enable", "setUp", "cleanup", "disable"])