1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158 |
- import os
- import unittest
- import warnings
- from io import StringIO
- from unittest import mock
- from django.conf import STATICFILES_STORAGE_ALIAS, settings
- from django.contrib.staticfiles.finders import get_finder, get_finders
- from django.contrib.staticfiles.storage import staticfiles_storage
- from django.core.exceptions import ImproperlyConfigured
- from django.core.files.storage import default_storage
- from django.db import (
- IntegrityError,
- connection,
- connections,
- models,
- router,
- transaction,
- )
- from django.forms import (
- CharField,
- EmailField,
- Form,
- IntegerField,
- ValidationError,
- formset_factory,
- )
- from django.http import HttpResponse
- from django.template import Context, Template
- from django.template.loader import render_to_string
- from django.test import (
- SimpleTestCase,
- TestCase,
- TransactionTestCase,
- skipIfDBFeature,
- skipUnlessDBFeature,
- )
- from django.test.html import HTMLParseError, parse_html
- from django.test.testcases import DatabaseOperationForbidden
- from django.test.utils import (
- CaptureQueriesContext,
- TestContextDecorator,
- isolate_apps,
- override_settings,
- setup_test_environment,
- )
- from django.urls import NoReverseMatch, path, reverse, reverse_lazy
- from django.utils.html import VOID_ELEMENTS
- from django.utils.version import PY311
- from .models import Car, Person, PossessedCar
- from .views import empty_response
- class SkippingTestCase(SimpleTestCase):
- def _assert_skipping(self, func, expected_exc, msg=None):
- try:
- if msg is not None:
- with self.assertRaisesMessage(expected_exc, msg):
- func()
- else:
- with self.assertRaises(expected_exc):
- func()
- except unittest.SkipTest:
- self.fail("%s should not result in a skipped test." % func.__name__)
- def test_skip_unless_db_feature(self):
- """
- Testing the django.test.skipUnlessDBFeature decorator.
- """
- # Total hack, but it works, just want an attribute that's always true.
- @skipUnlessDBFeature("__class__")
- def test_func():
- raise ValueError
- @skipUnlessDBFeature("notprovided")
- def test_func2():
- raise ValueError
- @skipUnlessDBFeature("__class__", "__class__")
- def test_func3():
- raise ValueError
- @skipUnlessDBFeature("__class__", "notprovided")
- def test_func4():
- raise ValueError
- self._assert_skipping(test_func, ValueError)
- self._assert_skipping(test_func2, unittest.SkipTest)
- self._assert_skipping(test_func3, ValueError)
- self._assert_skipping(test_func4, unittest.SkipTest)
- class SkipTestCase(SimpleTestCase):
- @skipUnlessDBFeature("missing")
- def test_foo(self):
- pass
- self._assert_skipping(
- SkipTestCase("test_foo").test_foo,
- ValueError,
- "skipUnlessDBFeature cannot be used on test_foo (test_utils.tests."
- "SkippingTestCase.test_skip_unless_db_feature.<locals>.SkipTestCase%s) "
- "as SkippingTestCase.test_skip_unless_db_feature.<locals>.SkipTestCase "
- "doesn't allow queries against the 'default' database."
- # Python 3.11 uses fully qualified test name in the output.
- % (".test_foo" if PY311 else ""),
- )
- def test_skip_if_db_feature(self):
- """
- Testing the django.test.skipIfDBFeature decorator.
- """
- @skipIfDBFeature("__class__")
- def test_func():
- raise ValueError
- @skipIfDBFeature("notprovided")
- def test_func2():
- raise ValueError
- @skipIfDBFeature("__class__", "__class__")
- def test_func3():
- raise ValueError
- @skipIfDBFeature("__class__", "notprovided")
- def test_func4():
- raise ValueError
- @skipIfDBFeature("notprovided", "notprovided")
- def test_func5():
- raise ValueError
- self._assert_skipping(test_func, unittest.SkipTest)
- self._assert_skipping(test_func2, ValueError)
- self._assert_skipping(test_func3, unittest.SkipTest)
- self._assert_skipping(test_func4, unittest.SkipTest)
- self._assert_skipping(test_func5, ValueError)
- class SkipTestCase(SimpleTestCase):
- @skipIfDBFeature("missing")
- def test_foo(self):
- pass
- self._assert_skipping(
- SkipTestCase("test_foo").test_foo,
- ValueError,
- "skipIfDBFeature cannot be used on test_foo (test_utils.tests."
- "SkippingTestCase.test_skip_if_db_feature.<locals>.SkipTestCase%s) "
- "as SkippingTestCase.test_skip_if_db_feature.<locals>.SkipTestCase "
- "doesn't allow queries against the 'default' database."
- # Python 3.11 uses fully qualified test name in the output.
- % (".test_foo" if PY311 else ""),
- )
- class SkippingClassTestCase(TestCase):
- def test_skip_class_unless_db_feature(self):
- @skipUnlessDBFeature("__class__")
- class NotSkippedTests(TestCase):
- def test_dummy(self):
- return
- @skipUnlessDBFeature("missing")
- @skipIfDBFeature("__class__")
- class SkippedTests(TestCase):
- def test_will_be_skipped(self):
- self.fail("We should never arrive here.")
- @skipIfDBFeature("__dict__")
- class SkippedTestsSubclass(SkippedTests):
- pass
- test_suite = unittest.TestSuite()
- test_suite.addTest(NotSkippedTests("test_dummy"))
- try:
- test_suite.addTest(SkippedTests("test_will_be_skipped"))
- test_suite.addTest(SkippedTestsSubclass("test_will_be_skipped"))
- except unittest.SkipTest:
- self.fail("SkipTest should not be raised here.")
- result = unittest.TextTestRunner(stream=StringIO()).run(test_suite)
- self.assertEqual(result.testsRun, 3)
- self.assertEqual(len(result.skipped), 2)
- self.assertEqual(result.skipped[0][1], "Database has feature(s) __class__")
- self.assertEqual(result.skipped[1][1], "Database has feature(s) __class__")
- def test_missing_default_databases(self):
- @skipIfDBFeature("missing")
- class MissingDatabases(SimpleTestCase):
- def test_assertion_error(self):
- pass
- suite = unittest.TestSuite()
- try:
- suite.addTest(MissingDatabases("test_assertion_error"))
- except unittest.SkipTest:
- self.fail("SkipTest should not be raised at this stage")
- runner = unittest.TextTestRunner(stream=StringIO())
- msg = (
- "skipIfDBFeature cannot be used on <class 'test_utils.tests."
- "SkippingClassTestCase.test_missing_default_databases.<locals>."
- "MissingDatabases'> as it doesn't allow queries against the "
- "'default' database."
- )
- with self.assertRaisesMessage(ValueError, msg):
- runner.run(suite)
- @override_settings(ROOT_URLCONF="test_utils.urls")
- class AssertNumQueriesTests(TestCase):
- def test_assert_num_queries(self):
- def test_func():
- raise ValueError
- with self.assertRaises(ValueError):
- self.assertNumQueries(2, test_func)
- def test_assert_num_queries_with_client(self):
- person = Person.objects.create(name="test")
- self.assertNumQueries(
- 1, self.client.get, "/test_utils/get_person/%s/" % person.pk
- )
- self.assertNumQueries(
- 1, self.client.get, "/test_utils/get_person/%s/" % person.pk
- )
- def test_func():
- self.client.get("/test_utils/get_person/%s/" % person.pk)
- self.client.get("/test_utils/get_person/%s/" % person.pk)
- self.assertNumQueries(2, test_func)
- class AssertNumQueriesUponConnectionTests(TransactionTestCase):
- available_apps = []
- def test_ignores_connection_configuration_queries(self):
- real_ensure_connection = connection.ensure_connection
- connection.close()
- def make_configuration_query():
- is_opening_connection = connection.connection is None
- real_ensure_connection()
- if is_opening_connection:
- # Avoid infinite recursion. Creating a cursor calls
- # ensure_connection() which is currently mocked by this method.
- with connection.cursor() as cursor:
- cursor.execute("SELECT 1" + connection.features.bare_select_suffix)
- ensure_connection = (
- "django.db.backends.base.base.BaseDatabaseWrapper.ensure_connection"
- )
- with mock.patch(ensure_connection, side_effect=make_configuration_query):
- with self.assertNumQueries(1):
- list(Car.objects.all())
- class AssertQuerySetEqualTests(TestCase):
- @classmethod
- def setUpTestData(cls):
- cls.p1 = Person.objects.create(name="p1")
- cls.p2 = Person.objects.create(name="p2")
- def test_empty(self):
- self.assertQuerySetEqual(Person.objects.filter(name="p3"), [])
- def test_ordered(self):
- self.assertQuerySetEqual(
- Person.objects.order_by("name"),
- [self.p1, self.p2],
- )
- def test_unordered(self):
- self.assertQuerySetEqual(
- Person.objects.order_by("name"), [self.p2, self.p1], ordered=False
- )
- def test_queryset(self):
- self.assertQuerySetEqual(
- Person.objects.order_by("name"),
- Person.objects.order_by("name"),
- )
- def test_flat_values_list(self):
- self.assertQuerySetEqual(
- Person.objects.order_by("name").values_list("name", flat=True),
- ["p1", "p2"],
- )
- def test_transform(self):
- self.assertQuerySetEqual(
- Person.objects.order_by("name"),
- [self.p1.pk, self.p2.pk],
- transform=lambda x: x.pk,
- )
- def test_repr_transform(self):
- self.assertQuerySetEqual(
- Person.objects.order_by("name"),
- [repr(self.p1), repr(self.p2)],
- transform=repr,
- )
- def test_undefined_order(self):
- # Using an unordered queryset with more than one ordered value
- # is an error.
- msg = (
- "Trying to compare non-ordered queryset against more than one "
- "ordered value."
- )
- with self.assertRaisesMessage(ValueError, msg):
- self.assertQuerySetEqual(
- Person.objects.all(),
- [self.p1, self.p2],
- )
- # No error for one value.
- self.assertQuerySetEqual(Person.objects.filter(name="p1"), [self.p1])
- def test_repeated_values(self):
- """
- assertQuerySetEqual checks the number of appearance of each item
- when used with option ordered=False.
- """
- batmobile = Car.objects.create(name="Batmobile")
- k2000 = Car.objects.create(name="K 2000")
- PossessedCar.objects.bulk_create(
- [
- PossessedCar(car=batmobile, belongs_to=self.p1),
- PossessedCar(car=batmobile, belongs_to=self.p1),
- PossessedCar(car=k2000, belongs_to=self.p1),
- PossessedCar(car=k2000, belongs_to=self.p1),
- PossessedCar(car=k2000, belongs_to=self.p1),
- PossessedCar(car=k2000, belongs_to=self.p1),
- ]
- )
- with self.assertRaises(AssertionError):
- self.assertQuerySetEqual(
- self.p1.cars.all(), [batmobile, k2000], ordered=False
- )
- self.assertQuerySetEqual(
- self.p1.cars.all(), [batmobile] * 2 + [k2000] * 4, ordered=False
- )
- def test_maxdiff(self):
- names = ["Joe Smith %s" % i for i in range(20)]
- Person.objects.bulk_create([Person(name=name) for name in names])
- names.append("Extra Person")
- with self.assertRaises(AssertionError) as ctx:
- self.assertQuerySetEqual(
- Person.objects.filter(name__startswith="Joe"),
- names,
- ordered=False,
- transform=lambda p: p.name,
- )
- self.assertIn("Set self.maxDiff to None to see it.", str(ctx.exception))
- original = self.maxDiff
- self.maxDiff = None
- try:
- with self.assertRaises(AssertionError) as ctx:
- self.assertQuerySetEqual(
- Person.objects.filter(name__startswith="Joe"),
- names,
- ordered=False,
- transform=lambda p: p.name,
- )
- finally:
- self.maxDiff = original
- exception_msg = str(ctx.exception)
- self.assertNotIn("Set self.maxDiff to None to see it.", exception_msg)
- for name in names:
- self.assertIn(name, exception_msg)
- @override_settings(ROOT_URLCONF="test_utils.urls")
- class CaptureQueriesContextManagerTests(TestCase):
- @classmethod
- def setUpTestData(cls):
- cls.person_pk = str(Person.objects.create(name="test").pk)
- def test_simple(self):
- with CaptureQueriesContext(connection) as captured_queries:
- Person.objects.get(pk=self.person_pk)
- self.assertEqual(len(captured_queries), 1)
- self.assertIn(self.person_pk, captured_queries[0]["sql"])
- with CaptureQueriesContext(connection) as captured_queries:
- pass
- self.assertEqual(0, len(captured_queries))
- def test_within(self):
- with CaptureQueriesContext(connection) as captured_queries:
- Person.objects.get(pk=self.person_pk)
- self.assertEqual(len(captured_queries), 1)
- self.assertIn(self.person_pk, captured_queries[0]["sql"])
- def test_nested(self):
- with CaptureQueriesContext(connection) as captured_queries:
- Person.objects.count()
- with CaptureQueriesContext(connection) as nested_captured_queries:
- Person.objects.count()
- self.assertEqual(1, len(nested_captured_queries))
- self.assertEqual(2, len(captured_queries))
- def test_failure(self):
- with self.assertRaises(TypeError):
- with CaptureQueriesContext(connection):
- raise TypeError
- def test_with_client(self):
- with CaptureQueriesContext(connection) as captured_queries:
- self.client.get("/test_utils/get_person/%s/" % self.person_pk)
- self.assertEqual(len(captured_queries), 1)
- self.assertIn(self.person_pk, captured_queries[0]["sql"])
- with CaptureQueriesContext(connection) as captured_queries:
- self.client.get("/test_utils/get_person/%s/" % self.person_pk)
- self.assertEqual(len(captured_queries), 1)
- self.assertIn(self.person_pk, captured_queries[0]["sql"])
- with CaptureQueriesContext(connection) as captured_queries:
- self.client.get("/test_utils/get_person/%s/" % self.person_pk)
- self.client.get("/test_utils/get_person/%s/" % self.person_pk)
- self.assertEqual(len(captured_queries), 2)
- self.assertIn(self.person_pk, captured_queries[0]["sql"])
- self.assertIn(self.person_pk, captured_queries[1]["sql"])
- @override_settings(ROOT_URLCONF="test_utils.urls")
- class AssertNumQueriesContextManagerTests(TestCase):
- def test_simple(self):
- with self.assertNumQueries(0):
- pass
- with self.assertNumQueries(1):
- Person.objects.count()
- with self.assertNumQueries(2):
- Person.objects.count()
- Person.objects.count()
- def test_failure(self):
- msg = "1 != 2 : 1 queries executed, 2 expected\nCaptured queries were:\n1."
- with self.assertRaisesMessage(AssertionError, msg):
- with self.assertNumQueries(2):
- Person.objects.count()
- with self.assertRaises(TypeError):
- with self.assertNumQueries(4000):
- raise TypeError
- def test_with_client(self):
- person = Person.objects.create(name="test")
- with self.assertNumQueries(1):
- self.client.get("/test_utils/get_person/%s/" % person.pk)
- with self.assertNumQueries(1):
- self.client.get("/test_utils/get_person/%s/" % person.pk)
- with self.assertNumQueries(2):
- self.client.get("/test_utils/get_person/%s/" % person.pk)
- self.client.get("/test_utils/get_person/%s/" % person.pk)
- @override_settings(ROOT_URLCONF="test_utils.urls")
- class AssertTemplateUsedContextManagerTests(SimpleTestCase):
- def test_usage(self):
- with self.assertTemplateUsed("template_used/base.html"):
- render_to_string("template_used/base.html")
- with self.assertTemplateUsed(template_name="template_used/base.html"):
- render_to_string("template_used/base.html")
- with self.assertTemplateUsed("template_used/base.html"):
- render_to_string("template_used/include.html")
- with self.assertTemplateUsed("template_used/base.html"):
- render_to_string("template_used/extends.html")
- with self.assertTemplateUsed("template_used/base.html"):
- render_to_string("template_used/base.html")
- render_to_string("template_used/base.html")
- def test_nested_usage(self):
- with self.assertTemplateUsed("template_used/base.html"):
- with self.assertTemplateUsed("template_used/include.html"):
- render_to_string("template_used/include.html")
- with self.assertTemplateUsed("template_used/extends.html"):
- with self.assertTemplateUsed("template_used/base.html"):
- render_to_string("template_used/extends.html")
- with self.assertTemplateUsed("template_used/base.html"):
- with self.assertTemplateUsed("template_used/alternative.html"):
- render_to_string("template_used/alternative.html")
- render_to_string("template_used/base.html")
- with self.assertTemplateUsed("template_used/base.html"):
- render_to_string("template_used/extends.html")
- with self.assertTemplateNotUsed("template_used/base.html"):
- render_to_string("template_used/alternative.html")
- render_to_string("template_used/base.html")
- def test_not_used(self):
- with self.assertTemplateNotUsed("template_used/base.html"):
- pass
- with self.assertTemplateNotUsed("template_used/alternative.html"):
- pass
- def test_error_message(self):
- msg = "No templates used to render the response"
- with self.assertRaisesMessage(AssertionError, msg):
- with self.assertTemplateUsed("template_used/base.html"):
- pass
- with self.assertRaisesMessage(AssertionError, msg):
- with self.assertTemplateUsed(template_name="template_used/base.html"):
- pass
- msg2 = (
- "Template 'template_used/base.html' was not a template used to render "
- "the response. Actual template(s) used: template_used/alternative.html"
- )
- with self.assertRaisesMessage(AssertionError, msg2):
- with self.assertTemplateUsed("template_used/base.html"):
- render_to_string("template_used/alternative.html")
- msg = "No templates used to render the response"
- with self.assertRaisesMessage(AssertionError, msg):
- response = self.client.get("/test_utils/no_template_used/")
- self.assertTemplateUsed(response, "template_used/base.html")
- with self.assertRaisesMessage(AssertionError, msg):
- with self.assertTemplateUsed("template_used/base.html"):
- self.client.get("/test_utils/no_template_used/")
- with self.assertRaisesMessage(AssertionError, msg):
- with self.assertTemplateUsed("template_used/base.html"):
- template = Template("template_used/alternative.html", name=None)
- template.render(Context())
- def test_msg_prefix(self):
- msg_prefix = "Prefix"
- msg = f"{msg_prefix}: No templates used to render the response"
- with self.assertRaisesMessage(AssertionError, msg):
- with self.assertTemplateUsed(
- "template_used/base.html", msg_prefix=msg_prefix
- ):
- pass
- with self.assertRaisesMessage(AssertionError, msg):
- with self.assertTemplateUsed(
- template_name="template_used/base.html",
- msg_prefix=msg_prefix,
- ):
- pass
- msg = (
- f"{msg_prefix}: Template 'template_used/base.html' was not a "
- f"template used to render the response. Actual template(s) used: "
- f"template_used/alternative.html"
- )
- with self.assertRaisesMessage(AssertionError, msg):
- with self.assertTemplateUsed(
- "template_used/base.html", msg_prefix=msg_prefix
- ):
- render_to_string("template_used/alternative.html")
- def test_count(self):
- with self.assertTemplateUsed("template_used/base.html", count=2):
- render_to_string("template_used/base.html")
- render_to_string("template_used/base.html")
- msg = (
- "Template 'template_used/base.html' was expected to be rendered "
- "3 time(s) but was actually rendered 2 time(s)."
- )
- with self.assertRaisesMessage(AssertionError, msg):
- with self.assertTemplateUsed("template_used/base.html", count=3):
- render_to_string("template_used/base.html")
- render_to_string("template_used/base.html")
- def test_failure(self):
- msg = "response and/or template_name argument must be provided"
- with self.assertRaisesMessage(TypeError, msg):
- with self.assertTemplateUsed():
- pass
- msg = "No templates used to render the response"
- with self.assertRaisesMessage(AssertionError, msg):
- with self.assertTemplateUsed(""):
- pass
- with self.assertRaisesMessage(AssertionError, msg):
- with self.assertTemplateUsed(""):
- render_to_string("template_used/base.html")
- with self.assertRaisesMessage(AssertionError, msg):
- with self.assertTemplateUsed(template_name=""):
- pass
- msg = (
- "Template 'template_used/base.html' was not a template used to "
- "render the response. Actual template(s) used: "
- "template_used/alternative.html"
- )
- with self.assertRaisesMessage(AssertionError, msg):
- with self.assertTemplateUsed("template_used/base.html"):
- render_to_string("template_used/alternative.html")
- def test_assert_used_on_http_response(self):
- response = HttpResponse()
- msg = "%s() is only usable on responses fetched using the Django test Client."
- with self.assertRaisesMessage(ValueError, msg % "assertTemplateUsed"):
- self.assertTemplateUsed(response, "template.html")
- with self.assertRaisesMessage(ValueError, msg % "assertTemplateNotUsed"):
- self.assertTemplateNotUsed(response, "template.html")
- class HTMLEqualTests(SimpleTestCase):
- def test_html_parser(self):
- element = parse_html("<div><p>Hello</p></div>")
- self.assertEqual(len(element.children), 1)
- self.assertEqual(element.children[0].name, "p")
- self.assertEqual(element.children[0].children[0], "Hello")
- parse_html("<p>")
- parse_html("<p attr>")
- dom = parse_html("<p>foo")
- self.assertEqual(len(dom.children), 1)
- self.assertEqual(dom.name, "p")
- self.assertEqual(dom[0], "foo")
- def test_parse_html_in_script(self):
- parse_html('<script>var a = "<p" + ">";</script>')
- parse_html(
- """
- <script>
- var js_sha_link='<p>***</p>';
- </script>
- """
- )
- # script content will be parsed to text
- dom = parse_html(
- """
- <script><p>foo</p> '</scr'+'ipt>' <span>bar</span></script>
- """
- )
- self.assertEqual(len(dom.children), 1)
- self.assertEqual(dom.children[0], "<p>foo</p> '</scr'+'ipt>' <span>bar</span>")
- def test_void_elements(self):
- for tag in VOID_ELEMENTS:
- with self.subTest(tag):
- dom = parse_html("<p>Hello <%s> world</p>" % tag)
- self.assertEqual(len(dom.children), 3)
- self.assertEqual(dom[0], "Hello")
- self.assertEqual(dom[1].name, tag)
- self.assertEqual(dom[2], "world")
- dom = parse_html("<p>Hello <%s /> world</p>" % tag)
- self.assertEqual(len(dom.children), 3)
- self.assertEqual(dom[0], "Hello")
- self.assertEqual(dom[1].name, tag)
- self.assertEqual(dom[2], "world")
- def test_simple_equal_html(self):
- self.assertHTMLEqual("", "")
- self.assertHTMLEqual("<p></p>", "<p></p>")
- self.assertHTMLEqual("<p></p>", " <p> </p> ")
- self.assertHTMLEqual("<div><p>Hello</p></div>", "<div><p>Hello</p></div>")
- self.assertHTMLEqual("<div><p>Hello</p></div>", "<div> <p>Hello</p> </div>")
- self.assertHTMLEqual("<div>\n<p>Hello</p></div>", "<div><p>Hello</p></div>\n")
- self.assertHTMLEqual(
- "<div><p>Hello\nWorld !</p></div>", "<div><p>Hello World\n!</p></div>"
- )
- self.assertHTMLEqual(
- "<div><p>Hello\nWorld !</p></div>", "<div><p>Hello World\n!</p></div>"
- )
- self.assertHTMLEqual("<p>Hello World !</p>", "<p>Hello World\n\n!</p>")
- self.assertHTMLEqual("<p> </p>", "<p></p>")
- self.assertHTMLEqual("<p/>", "<p></p>")
- self.assertHTMLEqual("<p />", "<p></p>")
- self.assertHTMLEqual("<input checked>", '<input checked="checked">')
- self.assertHTMLEqual("<p>Hello", "<p> Hello")
- self.assertHTMLEqual("<p>Hello</p>World", "<p>Hello</p> World")
- def test_ignore_comments(self):
- self.assertHTMLEqual(
- "<div>Hello<!-- this is a comment --> World!</div>",
- "<div>Hello World!</div>",
- )
- def test_unequal_html(self):
- self.assertHTMLNotEqual("<p>Hello</p>", "<p>Hello!</p>")
- self.assertHTMLNotEqual("<p>foobar</p>", "<p>foo bar</p>")
- self.assertHTMLNotEqual("<p>foo bar</p>", "<p>foo bar</p>")
- self.assertHTMLNotEqual("<p>foo nbsp</p>", "<p>foo </p>")
- self.assertHTMLNotEqual("<p>foo #20</p>", "<p>foo </p>")
- self.assertHTMLNotEqual(
- "<p><span>Hello</span><span>World</span></p>",
- "<p><span>Hello</span>World</p>",
- )
- self.assertHTMLNotEqual(
- "<p><span>Hello</span>World</p>",
- "<p><span>Hello</span><span>World</span></p>",
- )
- def test_attributes(self):
- self.assertHTMLEqual(
- '<input type="text" id="id_name" />', '<input id="id_name" type="text" />'
- )
- self.assertHTMLEqual(
- """<input type='text' id="id_name" />""",
- '<input id="id_name" type="text" />',
- )
- self.assertHTMLNotEqual(
- '<input type="text" id="id_name" />',
- '<input type="password" id="id_name" />',
- )
- def test_class_attribute(self):
- pairs = [
- ('<p class="foo bar"></p>', '<p class="bar foo"></p>'),
- ('<p class=" foo bar "></p>', '<p class="bar foo"></p>'),
- ('<p class=" foo bar "></p>', '<p class="bar foo"></p>'),
- ('<p class="foo\tbar"></p>', '<p class="bar foo"></p>'),
- ('<p class="\tfoo\tbar\t"></p>', '<p class="bar foo"></p>'),
- ('<p class="\t\t\tfoo\t\t\tbar\t\t\t"></p>', '<p class="bar foo"></p>'),
- ('<p class="\t \nfoo \t\nbar\n\t "></p>', '<p class="bar foo"></p>'),
- ]
- for html1, html2 in pairs:
- with self.subTest(html1):
- self.assertHTMLEqual(html1, html2)
- def test_boolean_attribute(self):
- html1 = "<input checked>"
- html2 = '<input checked="">'
- html3 = '<input checked="checked">'
- self.assertHTMLEqual(html1, html2)
- self.assertHTMLEqual(html1, html3)
- self.assertHTMLEqual(html2, html3)
- self.assertHTMLNotEqual(html1, '<input checked="invalid">')
- self.assertEqual(str(parse_html(html1)), "<input checked>")
- self.assertEqual(str(parse_html(html2)), "<input checked>")
- self.assertEqual(str(parse_html(html3)), "<input checked>")
- def test_non_boolean_attibutes(self):
- html1 = "<input value>"
- html2 = '<input value="">'
- html3 = '<input value="value">'
- self.assertHTMLEqual(html1, html2)
- self.assertHTMLNotEqual(html1, html3)
- self.assertEqual(str(parse_html(html1)), '<input value="">')
- self.assertEqual(str(parse_html(html2)), '<input value="">')
- def test_normalize_refs(self):
- pairs = [
- ("'", "'"),
- ("'", "'"),
- ("'", "'"),
- ("'", "'"),
- ("'", "'"),
- ("'", "'"),
- ("&", "&"),
- ("&", "&"),
- ("&", "&"),
- ("&", "&"),
- ("&", "&"),
- ("&", "&"),
- ("&", "&"),
- ("&", "&"),
- ("&", "&"),
- ("&", "&"),
- ("&", "&"),
- ("&", "&"),
- ]
- for pair in pairs:
- with self.subTest(repr(pair)):
- self.assertHTMLEqual(*pair)
- def test_complex_examples(self):
- self.assertHTMLEqual(
- """<tr><th><label for="id_first_name">First name:</label></th>
- <td><input type="text" name="first_name" value="John" id="id_first_name" /></td></tr>
- <tr><th><label for="id_last_name">Last name:</label></th>
- <td><input type="text" id="id_last_name" name="last_name" value="Lennon" /></td></tr>
- <tr><th><label for="id_birthday">Birthday:</label></th>
- <td><input type="text" value="1940-10-9" name="birthday" id="id_birthday" /></td></tr>""", # NOQA
- """
- <tr><th>
- <label for="id_first_name">First name:</label></th><td>
- <input type="text" name="first_name" value="John" id="id_first_name" />
- </td></tr>
- <tr><th>
- <label for="id_last_name">Last name:</label></th><td>
- <input type="text" name="last_name" value="Lennon" id="id_last_name" />
- </td></tr>
- <tr><th>
- <label for="id_birthday">Birthday:</label></th><td>
- <input type="text" name="birthday" value="1940-10-9" id="id_birthday" />
- </td></tr>
- """,
- )
- self.assertHTMLEqual(
- """<!DOCTYPE html>
- <html>
- <head>
- <link rel="stylesheet">
- <title>Document</title>
- <meta attribute="value">
- </head>
- <body>
- <p>
- This is a valid paragraph
- <div> this is a div AFTER the p</div>
- </body>
- </html>""",
- """
- <html>
- <head>
- <link rel="stylesheet">
- <title>Document</title>
- <meta attribute="value">
- </head>
- <body>
- <p> This is a valid paragraph
- <!-- browsers would close the p tag here -->
- <div> this is a div AFTER the p</div>
- </p> <!-- this is invalid HTML parsing, but it should make no
- difference in most cases -->
- </body>
- </html>""",
- )
- def test_html_contain(self):
- # equal html contains each other
- dom1 = parse_html("<p>foo")
- dom2 = parse_html("<p>foo</p>")
- self.assertIn(dom1, dom2)
- self.assertIn(dom2, dom1)
- dom2 = parse_html("<div><p>foo</p></div>")
- self.assertIn(dom1, dom2)
- self.assertNotIn(dom2, dom1)
- self.assertNotIn("<p>foo</p>", dom2)
- self.assertIn("foo", dom2)
- # when a root element is used ...
- dom1 = parse_html("<p>foo</p><p>bar</p>")
- dom2 = parse_html("<p>foo</p><p>bar</p>")
- self.assertIn(dom1, dom2)
- dom1 = parse_html("<p>foo</p>")
- self.assertIn(dom1, dom2)
- dom1 = parse_html("<p>bar</p>")
- self.assertIn(dom1, dom2)
- dom1 = parse_html("<div><p>foo</p><p>bar</p></div>")
- self.assertIn(dom2, dom1)
- def test_count(self):
- # equal html contains each other one time
- dom1 = parse_html("<p>foo")
- dom2 = parse_html("<p>foo</p>")
- self.assertEqual(dom1.count(dom2), 1)
- self.assertEqual(dom2.count(dom1), 1)
- dom2 = parse_html("<p>foo</p><p>bar</p>")
- self.assertEqual(dom2.count(dom1), 1)
- dom2 = parse_html("<p>foo foo</p><p>foo</p>")
- self.assertEqual(dom2.count("foo"), 3)
- dom2 = parse_html('<p class="bar">foo</p>')
- self.assertEqual(dom2.count("bar"), 0)
- self.assertEqual(dom2.count("class"), 0)
- self.assertEqual(dom2.count("p"), 0)
- self.assertEqual(dom2.count("o"), 2)
- dom2 = parse_html("<p>foo</p><p>foo</p>")
- self.assertEqual(dom2.count(dom1), 2)
- dom2 = parse_html('<div><p>foo<input type=""></p><p>foo</p></div>')
- self.assertEqual(dom2.count(dom1), 1)
- dom2 = parse_html("<div><div><p>foo</p></div></div>")
- self.assertEqual(dom2.count(dom1), 1)
- dom2 = parse_html("<p>foo<p>foo</p></p>")
- self.assertEqual(dom2.count(dom1), 1)
- dom2 = parse_html("<p>foo<p>bar</p></p>")
- self.assertEqual(dom2.count(dom1), 0)
- # HTML with a root element contains the same HTML with no root element.
- dom1 = parse_html("<p>foo</p><p>bar</p>")
- dom2 = parse_html("<div><p>foo</p><p>bar</p></div>")
- self.assertEqual(dom2.count(dom1), 1)
- # Target of search is a sequence of child elements and appears more
- # than once.
- dom2 = parse_html("<div><p>foo</p><p>bar</p><p>foo</p><p>bar</p></div>")
- self.assertEqual(dom2.count(dom1), 2)
- # Searched HTML has additional children.
- dom1 = parse_html("<a/><b/>")
- dom2 = parse_html("<a/><b/><c/>")
- self.assertEqual(dom2.count(dom1), 1)
- # No match found in children.
- dom1 = parse_html("<b/><a/>")
- self.assertEqual(dom2.count(dom1), 0)
- # Target of search found among children and grandchildren.
- dom1 = parse_html("<b/><b/>")
- dom2 = parse_html("<a><b/><b/></a><b/><b/>")
- self.assertEqual(dom2.count(dom1), 2)
- def test_root_element_escaped_html(self):
- html = "<br>"
- parsed = parse_html(html)
- self.assertEqual(str(parsed), html)
- def test_parsing_errors(self):
- with self.assertRaises(AssertionError):
- self.assertHTMLEqual("<p>", "")
- with self.assertRaises(AssertionError):
- self.assertHTMLEqual("", "<p>")
- error_msg = (
- "First argument is not valid HTML:\n"
- "('Unexpected end tag `div` (Line 1, Column 6)', (1, 6))"
- )
- with self.assertRaisesMessage(AssertionError, error_msg):
- self.assertHTMLEqual("< div></ div>", "<div></div>")
- with self.assertRaises(HTMLParseError):
- parse_html("</p>")
- def test_escaped_html_errors(self):
- msg = "<p>\n<foo>\n</p> != <p>\n<foo>\n</p>\n"
- with self.assertRaisesMessage(AssertionError, msg):
- self.assertHTMLEqual("<p><foo></p>", "<p><foo></p>")
- with self.assertRaisesMessage(AssertionError, msg):
- self.assertHTMLEqual("<p><foo></p>", "<p><foo></p>")
- def test_contains_html(self):
- response = HttpResponse(
- """<body>
- This is a form: <form method="get">
- <input type="text" name="Hello" />
- </form></body>"""
- )
- self.assertNotContains(response, "<input name='Hello' type='text'>")
- self.assertContains(response, '<form method="get">')
- self.assertContains(response, "<input name='Hello' type='text'>", html=True)
- self.assertNotContains(response, '<form method="get">', html=True)
- invalid_response = HttpResponse("""<body <bad>>""")
- with self.assertRaises(AssertionError):
- self.assertContains(invalid_response, "<p></p>")
- with self.assertRaises(AssertionError):
- self.assertContains(response, '<p "whats" that>')
- def test_unicode_handling(self):
- response = HttpResponse(
- '<p class="help">Some help text for the title (with Unicode ŠĐĆŽćžšđ)</p>'
- )
- self.assertContains(
- response,
- '<p class="help">Some help text for the title (with Unicode ŠĐĆŽćžšđ)</p>',
- html=True,
- )
- class InHTMLTests(SimpleTestCase):
- def test_needle_msg(self):
- msg = "False is not true : Couldn't find '<b>Hello</b>' in response"
- with self.assertRaisesMessage(AssertionError, msg):
- self.assertInHTML("<b>Hello</b>", "<p>Test</p>")
- class JSONEqualTests(SimpleTestCase):
- def test_simple_equal(self):
- json1 = '{"attr1": "foo", "attr2":"baz"}'
- json2 = '{"attr1": "foo", "attr2":"baz"}'
- self.assertJSONEqual(json1, json2)
- def test_simple_equal_unordered(self):
- json1 = '{"attr1": "foo", "attr2":"baz"}'
- json2 = '{"attr2":"baz", "attr1": "foo"}'
- self.assertJSONEqual(json1, json2)
- def test_simple_equal_raise(self):
- json1 = '{"attr1": "foo", "attr2":"baz"}'
- json2 = '{"attr2":"baz"}'
- with self.assertRaises(AssertionError):
- self.assertJSONEqual(json1, json2)
- def test_equal_parsing_errors(self):
- invalid_json = '{"attr1": "foo, "attr2":"baz"}'
- valid_json = '{"attr1": "foo", "attr2":"baz"}'
- with self.assertRaises(AssertionError):
- self.assertJSONEqual(invalid_json, valid_json)
- with self.assertRaises(AssertionError):
- self.assertJSONEqual(valid_json, invalid_json)
- def test_simple_not_equal(self):
- json1 = '{"attr1": "foo", "attr2":"baz"}'
- json2 = '{"attr2":"baz"}'
- self.assertJSONNotEqual(json1, json2)
- def test_simple_not_equal_raise(self):
- json1 = '{"attr1": "foo", "attr2":"baz"}'
- json2 = '{"attr1": "foo", "attr2":"baz"}'
- with self.assertRaises(AssertionError):
- self.assertJSONNotEqual(json1, json2)
- def test_not_equal_parsing_errors(self):
- invalid_json = '{"attr1": "foo, "attr2":"baz"}'
- valid_json = '{"attr1": "foo", "attr2":"baz"}'
- with self.assertRaises(AssertionError):
- self.assertJSONNotEqual(invalid_json, valid_json)
- with self.assertRaises(AssertionError):
- self.assertJSONNotEqual(valid_json, invalid_json)
- class XMLEqualTests(SimpleTestCase):
- def test_simple_equal(self):
- xml1 = "<elem attr1='a' attr2='b' />"
- xml2 = "<elem attr1='a' attr2='b' />"
- self.assertXMLEqual(xml1, xml2)
- def test_simple_equal_unordered(self):
- xml1 = "<elem attr1='a' attr2='b' />"
- xml2 = "<elem attr2='b' attr1='a' />"
- self.assertXMLEqual(xml1, xml2)
- def test_simple_equal_raise(self):
- xml1 = "<elem attr1='a' />"
- xml2 = "<elem attr2='b' attr1='a' />"
- with self.assertRaises(AssertionError):
- self.assertXMLEqual(xml1, xml2)
- def test_simple_equal_raises_message(self):
- xml1 = "<elem attr1='a' />"
- xml2 = "<elem attr2='b' attr1='a' />"
- msg = """{xml1} != {xml2}
- - <elem attr1='a' />
- + <elem attr2='b' attr1='a' />
- ? ++++++++++
- """.format(
- xml1=repr(xml1), xml2=repr(xml2)
- )
- with self.assertRaisesMessage(AssertionError, msg):
- self.assertXMLEqual(xml1, xml2)
- def test_simple_not_equal(self):
- xml1 = "<elem attr1='a' attr2='c' />"
- xml2 = "<elem attr1='a' attr2='b' />"
- self.assertXMLNotEqual(xml1, xml2)
- def test_simple_not_equal_raise(self):
- xml1 = "<elem attr1='a' attr2='b' />"
- xml2 = "<elem attr2='b' attr1='a' />"
- with self.assertRaises(AssertionError):
- self.assertXMLNotEqual(xml1, xml2)
- def test_parsing_errors(self):
- xml_unvalid = "<elem attr1='a attr2='b' />"
- xml2 = "<elem attr2='b' attr1='a' />"
- with self.assertRaises(AssertionError):
- self.assertXMLNotEqual(xml_unvalid, xml2)
- def test_comment_root(self):
- xml1 = "<?xml version='1.0'?><!-- comment1 --><elem attr1='a' attr2='b' />"
- xml2 = "<?xml version='1.0'?><!-- comment2 --><elem attr2='b' attr1='a' />"
- self.assertXMLEqual(xml1, xml2)
- def test_simple_equal_with_leading_or_trailing_whitespace(self):
- xml1 = "<elem>foo</elem> \t\n"
- xml2 = " \t\n<elem>foo</elem>"
- self.assertXMLEqual(xml1, xml2)
- def test_simple_not_equal_with_whitespace_in_the_middle(self):
- xml1 = "<elem>foo</elem><elem>bar</elem>"
- xml2 = "<elem>foo</elem> <elem>bar</elem>"
- self.assertXMLNotEqual(xml1, xml2)
- def test_doctype_root(self):
- xml1 = '<?xml version="1.0"?><!DOCTYPE root SYSTEM "example1.dtd"><root />'
- xml2 = '<?xml version="1.0"?><!DOCTYPE root SYSTEM "example2.dtd"><root />'
- self.assertXMLEqual(xml1, xml2)
- def test_processing_instruction(self):
- xml1 = (
- '<?xml version="1.0"?>'
- '<?xml-model href="http://www.example1.com"?><root />'
- )
- xml2 = (
- '<?xml version="1.0"?>'
- '<?xml-model href="http://www.example2.com"?><root />'
- )
- self.assertXMLEqual(xml1, xml2)
- self.assertXMLEqual(
- '<?xml-stylesheet href="style1.xslt" type="text/xsl"?><root />',
- '<?xml-stylesheet href="style2.xslt" type="text/xsl"?><root />',
- )
- class SkippingExtraTests(TestCase):
- fixtures = ["should_not_be_loaded.json"]
- # HACK: This depends on internals of our TestCase subclasses
- def __call__(self, result=None):
- # Detect fixture loading by counting SQL queries, should be zero
- with self.assertNumQueries(0):
- super().__call__(result)
- @unittest.skip("Fixture loading should not be performed for skipped tests.")
- def test_fixtures_are_skipped(self):
- pass
- class AssertRaisesMsgTest(SimpleTestCase):
- def test_assert_raises_message(self):
- msg = "'Expected message' not found in 'Unexpected message'"
- # context manager form of assertRaisesMessage()
- with self.assertRaisesMessage(AssertionError, msg):
- with self.assertRaisesMessage(ValueError, "Expected message"):
- raise ValueError("Unexpected message")
- # callable form
- def func():
- raise ValueError("Unexpected message")
- with self.assertRaisesMessage(AssertionError, msg):
- self.assertRaisesMessage(ValueError, "Expected message", func)
- def test_special_re_chars(self):
- """assertRaisesMessage shouldn't interpret RE special chars."""
- def func1():
- raise ValueError("[.*x+]y?")
- with self.assertRaisesMessage(ValueError, "[.*x+]y?"):
- func1()
- class AssertWarnsMessageTests(SimpleTestCase):
- def test_context_manager(self):
- with self.assertWarnsMessage(UserWarning, "Expected message"):
- warnings.warn("Expected message", UserWarning)
- def test_context_manager_failure(self):
- msg = "Expected message' not found in 'Unexpected message'"
- with self.assertRaisesMessage(AssertionError, msg):
- with self.assertWarnsMessage(UserWarning, "Expected message"):
- warnings.warn("Unexpected message", UserWarning)
- def test_callable(self):
- def func():
- warnings.warn("Expected message", UserWarning)
- self.assertWarnsMessage(UserWarning, "Expected message", func)
- def test_special_re_chars(self):
- def func1():
- warnings.warn("[.*x+]y?", UserWarning)
- with self.assertWarnsMessage(UserWarning, "[.*x+]y?"):
- func1()
- class AssertFieldOutputTests(SimpleTestCase):
- def test_assert_field_output(self):
- error_invalid = ["Enter a valid email address."]
- self.assertFieldOutput(
- EmailField, {"a@a.com": "a@a.com"}, {"aaa": error_invalid}
- )
- with self.assertRaises(AssertionError):
- self.assertFieldOutput(
- EmailField,
- {"a@a.com": "a@a.com"},
- {"aaa": error_invalid + ["Another error"]},
- )
- with self.assertRaises(AssertionError):
- self.assertFieldOutput(
- EmailField, {"a@a.com": "Wrong output"}, {"aaa": error_invalid}
- )
- with self.assertRaises(AssertionError):
- self.assertFieldOutput(
- EmailField,
- {"a@a.com": "a@a.com"},
- {"aaa": ["Come on, gimme some well formatted data, dude."]},
- )
- def test_custom_required_message(self):
- class MyCustomField(IntegerField):
- default_error_messages = {
- "required": "This is really required.",
- }
- self.assertFieldOutput(MyCustomField, {}, {}, empty_value=None)
- @override_settings(ROOT_URLCONF="test_utils.urls")
- class AssertURLEqualTests(SimpleTestCase):
- def test_equal(self):
- valid_tests = (
- ("http://example.com/?", "http://example.com/"),
- ("http://example.com/?x=1&", "http://example.com/?x=1"),
- ("http://example.com/?x=1&y=2", "http://example.com/?y=2&x=1"),
- ("http://example.com/?x=1&y=2", "http://example.com/?y=2&x=1"),
- (
- "http://example.com/?x=1&y=2&a=1&a=2",
- "http://example.com/?a=1&a=2&y=2&x=1",
- ),
- ("/path/to/?x=1&y=2&z=3", "/path/to/?z=3&y=2&x=1"),
- ("?x=1&y=2&z=3", "?z=3&y=2&x=1"),
- ("/test_utils/no_template_used/", reverse_lazy("no_template_used")),
- )
- for url1, url2 in valid_tests:
- with self.subTest(url=url1):
- self.assertURLEqual(url1, url2)
- def test_not_equal(self):
- invalid_tests = (
- # Protocol must be the same.
- ("http://example.com/", "https://example.com/"),
- ("http://example.com/?x=1&x=2", "https://example.com/?x=2&x=1"),
- ("http://example.com/?x=1&y=bar&x=2", "https://example.com/?y=bar&x=2&x=1"),
- # Parameters of the same name must be in the same order.
- ("/path/to?a=1&a=2", "/path/to/?a=2&a=1"),
- )
- for url1, url2 in invalid_tests:
- with self.subTest(url=url1), self.assertRaises(AssertionError):
- self.assertURLEqual(url1, url2)
- def test_message(self):
- msg = (
- "Expected 'http://example.com/?x=1&x=2' to equal "
- "'https://example.com/?x=2&x=1'"
- )
- with self.assertRaisesMessage(AssertionError, msg):
- self.assertURLEqual(
- "http://example.com/?x=1&x=2", "https://example.com/?x=2&x=1"
- )
- def test_msg_prefix(self):
- msg = (
- "Prefix: Expected 'http://example.com/?x=1&x=2' to equal "
- "'https://example.com/?x=2&x=1'"
- )
- with self.assertRaisesMessage(AssertionError, msg):
- self.assertURLEqual(
- "http://example.com/?x=1&x=2",
- "https://example.com/?x=2&x=1",
- msg_prefix="Prefix: ",
- )
- class TestForm(Form):
- field = CharField()
- def clean_field(self):
- value = self.cleaned_data.get("field", "")
- if value == "invalid":
- raise ValidationError("invalid value")
- return value
- def clean(self):
- if self.cleaned_data.get("field") == "invalid_non_field":
- raise ValidationError("non-field error")
- return self.cleaned_data
- @classmethod
- def _get_cleaned_form(cls, field_value):
- form = cls({"field": field_value})
- form.full_clean()
- return form
- @classmethod
- def valid(cls):
- return cls._get_cleaned_form("valid")
- @classmethod
- def invalid(cls, nonfield=False):
- return cls._get_cleaned_form("invalid_non_field" if nonfield else "invalid")
- class TestFormset(formset_factory(TestForm)):
- @classmethod
- def _get_cleaned_formset(cls, field_value):
- formset = cls(
- {
- "form-TOTAL_FORMS": "1",
- "form-INITIAL_FORMS": "0",
- "form-0-field": field_value,
- }
- )
- formset.full_clean()
- return formset
- @classmethod
- def valid(cls):
- return cls._get_cleaned_formset("valid")
- @classmethod
- def invalid(cls, nonfield=False, nonform=False):
- if nonform:
- formset = cls({}, error_messages={"missing_management_form": "error"})
- formset.full_clean()
- return formset
- return cls._get_cleaned_formset("invalid_non_field" if nonfield else "invalid")
- class AssertFormErrorTests(SimpleTestCase):
- def test_single_error(self):
- self.assertFormError(TestForm.invalid(), "field", "invalid value")
- def test_error_list(self):
- self.assertFormError(TestForm.invalid(), "field", ["invalid value"])
- def test_empty_errors_valid_form(self):
- self.assertFormError(TestForm.valid(), "field", [])
- def test_empty_errors_valid_form_non_field_errors(self):
- self.assertFormError(TestForm.valid(), None, [])
- def test_field_not_in_form(self):
- msg = (
- "The form <TestForm bound=True, valid=False, fields=(field)> does not "
- "contain the field 'other_field'."
- )
- with self.assertRaisesMessage(AssertionError, msg):
- self.assertFormError(TestForm.invalid(), "other_field", "invalid value")
- msg_prefix = "Custom prefix"
- with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
- self.assertFormError(
- TestForm.invalid(),
- "other_field",
- "invalid value",
- msg_prefix=msg_prefix,
- )
- def test_field_with_no_errors(self):
- msg = (
- "The errors of field 'field' on form <TestForm bound=True, valid=True, "
- "fields=(field)> don't match."
- )
- with self.assertRaisesMessage(AssertionError, msg) as ctx:
- self.assertFormError(TestForm.valid(), "field", "invalid value")
- self.assertIn("[] != ['invalid value']", str(ctx.exception))
- msg_prefix = "Custom prefix"
- with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
- self.assertFormError(
- TestForm.valid(), "field", "invalid value", msg_prefix=msg_prefix
- )
- def test_field_with_different_error(self):
- msg = (
- "The errors of field 'field' on form <TestForm bound=True, valid=False, "
- "fields=(field)> don't match."
- )
- with self.assertRaisesMessage(AssertionError, msg) as ctx:
- self.assertFormError(TestForm.invalid(), "field", "other error")
- self.assertIn("['invalid value'] != ['other error']", str(ctx.exception))
- msg_prefix = "Custom prefix"
- with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
- self.assertFormError(
- TestForm.invalid(), "field", "other error", msg_prefix=msg_prefix
- )
- def test_unbound_form(self):
- msg = (
- "The form <TestForm bound=False, valid=Unknown, fields=(field)> is not "
- "bound, it will never have any errors."
- )
- with self.assertRaisesMessage(AssertionError, msg):
- self.assertFormError(TestForm(), "field", [])
- msg_prefix = "Custom prefix"
- with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
- self.assertFormError(TestForm(), "field", [], msg_prefix=msg_prefix)
- def test_empty_errors_invalid_form(self):
- msg = (
- "The errors of field 'field' on form <TestForm bound=True, valid=False, "
- "fields=(field)> don't match."
- )
- with self.assertRaisesMessage(AssertionError, msg) as ctx:
- self.assertFormError(TestForm.invalid(), "field", [])
- self.assertIn("['invalid value'] != []", str(ctx.exception))
- def test_non_field_errors(self):
- self.assertFormError(TestForm.invalid(nonfield=True), None, "non-field error")
- def test_different_non_field_errors(self):
- msg = (
- "The non-field errors of form <TestForm bound=True, valid=False, "
- "fields=(field)> don't match."
- )
- with self.assertRaisesMessage(AssertionError, msg) as ctx:
- self.assertFormError(
- TestForm.invalid(nonfield=True), None, "other non-field error"
- )
- self.assertIn(
- "['non-field error'] != ['other non-field error']", str(ctx.exception)
- )
- msg_prefix = "Custom prefix"
- with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
- self.assertFormError(
- TestForm.invalid(nonfield=True),
- None,
- "other non-field error",
- msg_prefix=msg_prefix,
- )
- class AssertFormSetErrorTests(SimpleTestCase):
- def test_single_error(self):
- self.assertFormSetError(TestFormset.invalid(), 0, "field", "invalid value")
- def test_error_list(self):
- self.assertFormSetError(TestFormset.invalid(), 0, "field", ["invalid value"])
- def test_empty_errors_valid_formset(self):
- self.assertFormSetError(TestFormset.valid(), 0, "field", [])
- def test_multiple_forms(self):
- formset = TestFormset(
- {
- "form-TOTAL_FORMS": "2",
- "form-INITIAL_FORMS": "0",
- "form-0-field": "valid",
- "form-1-field": "invalid",
- }
- )
- formset.full_clean()
- self.assertFormSetError(formset, 0, "field", [])
- self.assertFormSetError(formset, 1, "field", ["invalid value"])
- def test_field_not_in_form(self):
- msg = (
- "The form 0 of formset <TestFormset: bound=True valid=False total_forms=1> "
- "does not contain the field 'other_field'."
- )
- with self.assertRaisesMessage(AssertionError, msg):
- self.assertFormSetError(
- TestFormset.invalid(), 0, "other_field", "invalid value"
- )
- msg_prefix = "Custom prefix"
- with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
- self.assertFormSetError(
- TestFormset.invalid(),
- 0,
- "other_field",
- "invalid value",
- msg_prefix=msg_prefix,
- )
- def test_field_with_no_errors(self):
- msg = (
- "The errors of field 'field' on form 0 of formset <TestFormset: bound=True "
- "valid=True total_forms=1> don't match."
- )
- with self.assertRaisesMessage(AssertionError, msg) as ctx:
- self.assertFormSetError(TestFormset.valid(), 0, "field", "invalid value")
- self.assertIn("[] != ['invalid value']", str(ctx.exception))
- msg_prefix = "Custom prefix"
- with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
- self.assertFormSetError(
- TestFormset.valid(), 0, "field", "invalid value", msg_prefix=msg_prefix
- )
- def test_field_with_different_error(self):
- msg = (
- "The errors of field 'field' on form 0 of formset <TestFormset: bound=True "
- "valid=False total_forms=1> don't match."
- )
- with self.assertRaisesMessage(AssertionError, msg) as ctx:
- self.assertFormSetError(TestFormset.invalid(), 0, "field", "other error")
- self.assertIn("['invalid value'] != ['other error']", str(ctx.exception))
- msg_prefix = "Custom prefix"
- with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
- self.assertFormSetError(
- TestFormset.invalid(), 0, "field", "other error", msg_prefix=msg_prefix
- )
- def test_unbound_formset(self):
- msg = (
- "The formset <TestFormset: bound=False valid=Unknown total_forms=1> is not "
- "bound, it will never have any errors."
- )
- with self.assertRaisesMessage(AssertionError, msg):
- self.assertFormSetError(TestFormset(), 0, "field", [])
- def test_empty_errors_invalid_formset(self):
- msg = (
- "The errors of field 'field' on form 0 of formset <TestFormset: bound=True "
- "valid=False total_forms=1> don't match."
- )
- with self.assertRaisesMessage(AssertionError, msg) as ctx:
- self.assertFormSetError(TestFormset.invalid(), 0, "field", [])
- self.assertIn("['invalid value'] != []", str(ctx.exception))
- def test_non_field_errors(self):
- self.assertFormSetError(
- TestFormset.invalid(nonfield=True), 0, None, "non-field error"
- )
- def test_different_non_field_errors(self):
- msg = (
- "The non-field errors of form 0 of formset <TestFormset: bound=True "
- "valid=False total_forms=1> don't match."
- )
- with self.assertRaisesMessage(AssertionError, msg) as ctx:
- self.assertFormSetError(
- TestFormset.invalid(nonfield=True), 0, None, "other non-field error"
- )
- self.assertIn(
- "['non-field error'] != ['other non-field error']", str(ctx.exception)
- )
- msg_prefix = "Custom prefix"
- with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
- self.assertFormSetError(
- TestFormset.invalid(nonfield=True),
- 0,
- None,
- "other non-field error",
- msg_prefix=msg_prefix,
- )
- def test_no_non_field_errors(self):
- msg = (
- "The non-field errors of form 0 of formset <TestFormset: bound=True "
- "valid=False total_forms=1> don't match."
- )
- with self.assertRaisesMessage(AssertionError, msg) as ctx:
- self.assertFormSetError(TestFormset.invalid(), 0, None, "non-field error")
- self.assertIn("[] != ['non-field error']", str(ctx.exception))
- msg_prefix = "Custom prefix"
- with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
- self.assertFormSetError(
- TestFormset.invalid(), 0, None, "non-field error", msg_prefix=msg_prefix
- )
- def test_non_form_errors(self):
- self.assertFormSetError(TestFormset.invalid(nonform=True), None, None, "error")
- def test_different_non_form_errors(self):
- msg = (
- "The non-form errors of formset <TestFormset: bound=True valid=False "
- "total_forms=0> don't match."
- )
- with self.assertRaisesMessage(AssertionError, msg) as ctx:
- self.assertFormSetError(
- TestFormset.invalid(nonform=True), None, None, "other error"
- )
- self.assertIn("['error'] != ['other error']", str(ctx.exception))
- msg_prefix = "Custom prefix"
- with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
- self.assertFormSetError(
- TestFormset.invalid(nonform=True),
- None,
- None,
- "other error",
- msg_prefix=msg_prefix,
- )
- def test_no_non_form_errors(self):
- msg = (
- "The non-form errors of formset <TestFormset: bound=True valid=False "
- "total_forms=1> don't match."
- )
- with self.assertRaisesMessage(AssertionError, msg) as ctx:
- self.assertFormSetError(TestFormset.invalid(), None, None, "error")
- self.assertIn("[] != ['error']", str(ctx.exception))
- msg_prefix = "Custom prefix"
- with self.assertRaisesMessage(AssertionError, f"{msg_prefix}: {msg}"):
- self.assertFormSetError(
- TestFormset.invalid(),
- None,
- None,
- "error",
- msg_prefix=msg_prefix,
- )
- def test_non_form_errors_with_field(self):
- msg = "You must use field=None with form_index=None."
- with self.assertRaisesMessage(ValueError, msg):
- self.assertFormSetError(
- TestFormset.invalid(nonform=True), None, "field", "error"
- )
- def test_form_index_too_big(self):
- msg = (
- "The formset <TestFormset: bound=True valid=False total_forms=1> only has "
- "1 form."
- )
- with self.assertRaisesMessage(AssertionError, msg):
- self.assertFormSetError(TestFormset.invalid(), 2, "field", "error")
- def test_form_index_too_big_plural(self):
- formset = TestFormset(
- {
- "form-TOTAL_FORMS": "2",
- "form-INITIAL_FORMS": "0",
- "form-0-field": "valid",
- "form-1-field": "valid",
- }
- )
- formset.full_clean()
- msg = (
- "The formset <TestFormset: bound=True valid=True total_forms=2> only has 2 "
- "forms."
- )
- with self.assertRaisesMessage(AssertionError, msg):
- self.assertFormSetError(formset, 2, "field", "error")
- class FirstUrls:
- urlpatterns = [path("first/", empty_response, name="first")]
- class SecondUrls:
- urlpatterns = [path("second/", empty_response, name="second")]
- class SetupTestEnvironmentTests(SimpleTestCase):
- def test_setup_test_environment_calling_more_than_once(self):
- with self.assertRaisesMessage(
- RuntimeError, "setup_test_environment() was already called"
- ):
- setup_test_environment()
- def test_allowed_hosts(self):
- for type_ in (list, tuple):
- with self.subTest(type_=type_):
- allowed_hosts = type_("*")
- with mock.patch("django.test.utils._TestState") as x:
- del x.saved_data
- with self.settings(ALLOWED_HOSTS=allowed_hosts):
- setup_test_environment()
- self.assertEqual(settings.ALLOWED_HOSTS, ["*", "testserver"])
- class OverrideSettingsTests(SimpleTestCase):
- # #21518 -- If neither override_settings nor a setting_changed receiver
- # clears the URL cache between tests, then one of test_first or
- # test_second will fail.
- @override_settings(ROOT_URLCONF=FirstUrls)
- def test_urlconf_first(self):
- reverse("first")
- @override_settings(ROOT_URLCONF=SecondUrls)
- def test_urlconf_second(self):
- reverse("second")
- def test_urlconf_cache(self):
- with self.assertRaises(NoReverseMatch):
- reverse("first")
- with self.assertRaises(NoReverseMatch):
- reverse("second")
- with override_settings(ROOT_URLCONF=FirstUrls):
- self.client.get(reverse("first"))
- with self.assertRaises(NoReverseMatch):
- reverse("second")
- with override_settings(ROOT_URLCONF=SecondUrls):
- with self.assertRaises(NoReverseMatch):
- reverse("first")
- self.client.get(reverse("second"))
- self.client.get(reverse("first"))
- with self.assertRaises(NoReverseMatch):
- reverse("second")
- with self.assertRaises(NoReverseMatch):
- reverse("first")
- with self.assertRaises(NoReverseMatch):
- reverse("second")
- def test_override_media_root(self):
- """
- Overriding the MEDIA_ROOT setting should be reflected in the
- base_location attribute of django.core.files.storage.default_storage.
- """
- self.assertEqual(default_storage.base_location, "")
- with self.settings(MEDIA_ROOT="test_value"):
- self.assertEqual(default_storage.base_location, "test_value")
- def test_override_media_url(self):
- """
- Overriding the MEDIA_URL setting should be reflected in the
- base_url attribute of django.core.files.storage.default_storage.
- """
- self.assertEqual(default_storage.base_location, "")
- with self.settings(MEDIA_URL="/test_value/"):
- self.assertEqual(default_storage.base_url, "/test_value/")
- def test_override_file_upload_permissions(self):
- """
- Overriding the FILE_UPLOAD_PERMISSIONS setting should be reflected in
- the file_permissions_mode attribute of
- django.core.files.storage.default_storage.
- """
- self.assertEqual(default_storage.file_permissions_mode, 0o644)
- with self.settings(FILE_UPLOAD_PERMISSIONS=0o777):
- self.assertEqual(default_storage.file_permissions_mode, 0o777)
- def test_override_file_upload_directory_permissions(self):
- """
- Overriding the FILE_UPLOAD_DIRECTORY_PERMISSIONS setting should be
- reflected in the directory_permissions_mode attribute of
- django.core.files.storage.default_storage.
- """
- self.assertIsNone(default_storage.directory_permissions_mode)
- with self.settings(FILE_UPLOAD_DIRECTORY_PERMISSIONS=0o777):
- self.assertEqual(default_storage.directory_permissions_mode, 0o777)
- def test_override_database_routers(self):
- """
- Overriding DATABASE_ROUTERS should update the base router.
- """
- test_routers = [object()]
- with self.settings(DATABASE_ROUTERS=test_routers):
- self.assertEqual(router.routers, test_routers)
- def test_override_static_url(self):
- """
- Overriding the STATIC_URL setting should be reflected in the
- base_url attribute of
- django.contrib.staticfiles.storage.staticfiles_storage.
- """
- with self.settings(STATIC_URL="/test/"):
- self.assertEqual(staticfiles_storage.base_url, "/test/")
- def test_override_static_root(self):
- """
- Overriding the STATIC_ROOT setting should be reflected in the
- location attribute of
- django.contrib.staticfiles.storage.staticfiles_storage.
- """
- with self.settings(STATIC_ROOT="/tmp/test"):
- self.assertEqual(staticfiles_storage.location, os.path.abspath("/tmp/test"))
- def test_override_staticfiles_storage(self):
- """
- Overriding the STORAGES setting should be reflected in
- the value of django.contrib.staticfiles.storage.staticfiles_storage.
- """
- new_class = "ManifestStaticFilesStorage"
- new_storage = "django.contrib.staticfiles.storage." + new_class
- with self.settings(
- STORAGES={STATICFILES_STORAGE_ALIAS: {"BACKEND": new_storage}}
- ):
- self.assertEqual(staticfiles_storage.__class__.__name__, new_class)
- def test_override_staticfiles_finders(self):
- """
- Overriding the STATICFILES_FINDERS setting should be reflected in
- the return value of django.contrib.staticfiles.finders.get_finders.
- """
- current = get_finders()
- self.assertGreater(len(list(current)), 1)
- finders = ["django.contrib.staticfiles.finders.FileSystemFinder"]
- with self.settings(STATICFILES_FINDERS=finders):
- self.assertEqual(len(list(get_finders())), len(finders))
- def test_override_staticfiles_dirs(self):
- """
- Overriding the STATICFILES_DIRS setting should be reflected in
- the locations attribute of the
- django.contrib.staticfiles.finders.FileSystemFinder instance.
- """
- finder = get_finder("django.contrib.staticfiles.finders.FileSystemFinder")
- test_path = "/tmp/test"
- expected_location = ("", test_path)
- self.assertNotIn(expected_location, finder.locations)
- with self.settings(STATICFILES_DIRS=[test_path]):
- finder = get_finder("django.contrib.staticfiles.finders.FileSystemFinder")
- self.assertIn(expected_location, finder.locations)
- @skipUnlessDBFeature("supports_transactions")
- class TestBadSetUpTestData(TestCase):
- """
- An exception in setUpTestData() shouldn't leak a transaction which would
- cascade across the rest of the test suite.
- """
- class MyException(Exception):
- pass
- @classmethod
- def setUpClass(cls):
- try:
- super().setUpClass()
- except cls.MyException:
- cls._in_atomic_block = connection.in_atomic_block
- @classmethod
- def tearDownClass(Cls):
- # override to avoid a second cls._rollback_atomics() which would fail.
- # Normal setUpClass() methods won't have exception handling so this
- # method wouldn't typically be run.
- pass
- @classmethod
- def setUpTestData(cls):
- # Simulate a broken setUpTestData() method.
- raise cls.MyException()
- def test_failure_in_setUpTestData_should_rollback_transaction(self):
- # setUpTestData() should call _rollback_atomics() so that the
- # transaction doesn't leak.
- self.assertFalse(self._in_atomic_block)
- @skipUnlessDBFeature("supports_transactions")
- class CaptureOnCommitCallbacksTests(TestCase):
- databases = {"default", "other"}
- callback_called = False
- def enqueue_callback(self, using="default"):
- def hook():
- self.callback_called = True
- transaction.on_commit(hook, using=using)
- def test_no_arguments(self):
- with self.captureOnCommitCallbacks() as callbacks:
- self.enqueue_callback()
- self.assertEqual(len(callbacks), 1)
- self.assertIs(self.callback_called, False)
- callbacks[0]()
- self.assertIs(self.callback_called, True)
- def test_using(self):
- with self.captureOnCommitCallbacks(using="other") as callbacks:
- self.enqueue_callback(using="other")
- self.assertEqual(len(callbacks), 1)
- self.assertIs(self.callback_called, False)
- callbacks[0]()
- self.assertIs(self.callback_called, True)
- def test_different_using(self):
- with self.captureOnCommitCallbacks(using="default") as callbacks:
- self.enqueue_callback(using="other")
- self.assertEqual(callbacks, [])
- def test_execute(self):
- with self.captureOnCommitCallbacks(execute=True) as callbacks:
- self.enqueue_callback()
- self.assertEqual(len(callbacks), 1)
- self.assertIs(self.callback_called, True)
- def test_pre_callback(self):
- def pre_hook():
- pass
- transaction.on_commit(pre_hook, using="default")
- with self.captureOnCommitCallbacks() as callbacks:
- self.enqueue_callback()
- self.assertEqual(len(callbacks), 1)
- self.assertNotEqual(callbacks[0], pre_hook)
- def test_with_rolled_back_savepoint(self):
- with self.captureOnCommitCallbacks() as callbacks:
- try:
- with transaction.atomic():
- self.enqueue_callback()
- raise IntegrityError
- except IntegrityError:
- # Inner transaction.atomic() has been rolled back.
- pass
- self.assertEqual(callbacks, [])
- def test_execute_recursive(self):
- with self.captureOnCommitCallbacks(execute=True) as callbacks:
- transaction.on_commit(self.enqueue_callback)
- self.assertEqual(len(callbacks), 2)
- self.assertIs(self.callback_called, True)
- def test_execute_tree(self):
- """
- A visualisation of the callback tree tested. Each node is expected to
- be visited only once:
- └─branch_1
- ├─branch_2
- │ ├─leaf_1
- │ └─leaf_2
- └─leaf_3
- """
- branch_1_call_counter = 0
- branch_2_call_counter = 0
- leaf_1_call_counter = 0
- leaf_2_call_counter = 0
- leaf_3_call_counter = 0
- def leaf_1():
- nonlocal leaf_1_call_counter
- leaf_1_call_counter += 1
- def leaf_2():
- nonlocal leaf_2_call_counter
- leaf_2_call_counter += 1
- def leaf_3():
- nonlocal leaf_3_call_counter
- leaf_3_call_counter += 1
- def branch_1():
- nonlocal branch_1_call_counter
- branch_1_call_counter += 1
- transaction.on_commit(branch_2)
- transaction.on_commit(leaf_3)
- def branch_2():
- nonlocal branch_2_call_counter
- branch_2_call_counter += 1
- transaction.on_commit(leaf_1)
- transaction.on_commit(leaf_2)
- with self.captureOnCommitCallbacks(execute=True) as callbacks:
- transaction.on_commit(branch_1)
- self.assertEqual(branch_1_call_counter, 1)
- self.assertEqual(branch_2_call_counter, 1)
- self.assertEqual(leaf_1_call_counter, 1)
- self.assertEqual(leaf_2_call_counter, 1)
- self.assertEqual(leaf_3_call_counter, 1)
- self.assertEqual(callbacks, [branch_1, branch_2, leaf_3, leaf_1, leaf_2])
- def test_execute_robust(self):
- class MyException(Exception):
- pass
- def hook():
- self.callback_called = True
- raise MyException("robust callback")
- with self.assertLogs("django.test", "ERROR") as cm:
- with self.captureOnCommitCallbacks(execute=True) as callbacks:
- transaction.on_commit(hook, robust=True)
- self.assertEqual(len(callbacks), 1)
- self.assertIs(self.callback_called, True)
- log_record = cm.records[0]
- self.assertEqual(
- log_record.getMessage(),
- "Error calling CaptureOnCommitCallbacksTests.test_execute_robust.<locals>."
- "hook in on_commit() (robust callback).",
- )
- self.assertIsNotNone(log_record.exc_info)
- raised_exception = log_record.exc_info[1]
- self.assertIsInstance(raised_exception, MyException)
- self.assertEqual(str(raised_exception), "robust callback")
- class DisallowedDatabaseQueriesTests(SimpleTestCase):
- def test_disallowed_database_connections(self):
- expected_message = (
- "Database connections to 'default' are not allowed in SimpleTestCase "
- "subclasses. Either subclass TestCase or TransactionTestCase to "
- "ensure proper test isolation or add 'default' to "
- "test_utils.tests.DisallowedDatabaseQueriesTests.databases to "
- "silence this failure."
- )
- with self.assertRaisesMessage(DatabaseOperationForbidden, expected_message):
- connection.connect()
- with self.assertRaisesMessage(DatabaseOperationForbidden, expected_message):
- connection.temporary_connection()
- def test_disallowed_database_queries(self):
- expected_message = (
- "Database queries to 'default' are not allowed in SimpleTestCase "
- "subclasses. Either subclass TestCase or TransactionTestCase to "
- "ensure proper test isolation or add 'default' to "
- "test_utils.tests.DisallowedDatabaseQueriesTests.databases to "
- "silence this failure."
- )
- with self.assertRaisesMessage(DatabaseOperationForbidden, expected_message):
- Car.objects.first()
- def test_disallowed_database_chunked_cursor_queries(self):
- expected_message = (
- "Database queries to 'default' are not allowed in SimpleTestCase "
- "subclasses. Either subclass TestCase or TransactionTestCase to "
- "ensure proper test isolation or add 'default' to "
- "test_utils.tests.DisallowedDatabaseQueriesTests.databases to "
- "silence this failure."
- )
- with self.assertRaisesMessage(DatabaseOperationForbidden, expected_message):
- next(Car.objects.iterator())
- class AllowedDatabaseQueriesTests(SimpleTestCase):
- databases = {"default"}
- def test_allowed_database_queries(self):
- Car.objects.first()
- def test_allowed_database_chunked_cursor_queries(self):
- next(Car.objects.iterator(), None)
- class DatabaseAliasTests(SimpleTestCase):
- def setUp(self):
- self.addCleanup(setattr, self.__class__, "databases", self.databases)
- def test_no_close_match(self):
- self.__class__.databases = {"void"}
- message = (
- "test_utils.tests.DatabaseAliasTests.databases refers to 'void' which is "
- "not defined in settings.DATABASES."
- )
- with self.assertRaisesMessage(ImproperlyConfigured, message):
- self._validate_databases()
- def test_close_match(self):
- self.__class__.databases = {"defualt"}
- message = (
- "test_utils.tests.DatabaseAliasTests.databases refers to 'defualt' which "
- "is not defined in settings.DATABASES. Did you mean 'default'?"
- )
- with self.assertRaisesMessage(ImproperlyConfigured, message):
- self._validate_databases()
- def test_match(self):
- self.__class__.databases = {"default", "other"}
- self.assertEqual(self._validate_databases(), frozenset({"default", "other"}))
- def test_all(self):
- self.__class__.databases = "__all__"
- self.assertEqual(self._validate_databases(), frozenset(connections))
- @isolate_apps("test_utils", attr_name="class_apps")
- class IsolatedAppsTests(SimpleTestCase):
- def test_installed_apps(self):
- self.assertEqual(
- [app_config.label for app_config in self.class_apps.get_app_configs()],
- ["test_utils"],
- )
- def test_class_decoration(self):
- class ClassDecoration(models.Model):
- pass
- self.assertEqual(ClassDecoration._meta.apps, self.class_apps)
- @isolate_apps("test_utils", kwarg_name="method_apps")
- def test_method_decoration(self, method_apps):
- class MethodDecoration(models.Model):
- pass
- self.assertEqual(MethodDecoration._meta.apps, method_apps)
- def test_context_manager(self):
- with isolate_apps("test_utils") as context_apps:
- class ContextManager(models.Model):
- pass
- self.assertEqual(ContextManager._meta.apps, context_apps)
- @isolate_apps("test_utils", kwarg_name="method_apps")
- def test_nested(self, method_apps):
- class MethodDecoration(models.Model):
- pass
- with isolate_apps("test_utils") as context_apps:
- class ContextManager(models.Model):
- pass
- with isolate_apps("test_utils") as nested_context_apps:
- class NestedContextManager(models.Model):
- pass
- self.assertEqual(MethodDecoration._meta.apps, method_apps)
- self.assertEqual(ContextManager._meta.apps, context_apps)
- self.assertEqual(NestedContextManager._meta.apps, nested_context_apps)
- class DoNothingDecorator(TestContextDecorator):
- def enable(self):
- pass
- def disable(self):
- pass
- class TestContextDecoratorTests(SimpleTestCase):
- @mock.patch.object(DoNothingDecorator, "disable")
- def test_exception_in_setup(self, mock_disable):
- """An exception is setUp() is reraised after disable() is called."""
- class ExceptionInSetUp(unittest.TestCase):
- def setUp(self):
- raise NotImplementedError("reraised")
- decorator = DoNothingDecorator()
- decorated_test_class = decorator.__call__(ExceptionInSetUp)()
- self.assertFalse(mock_disable.called)
- with self.assertRaisesMessage(NotImplementedError, "reraised"):
- decorated_test_class.setUp()
- decorated_test_class.doCleanups()
- self.assertTrue(mock_disable.called)
- def test_cleanups_run_after_tearDown(self):
- calls = []
- class SaveCallsDecorator(TestContextDecorator):
- def enable(self):
- calls.append("enable")
- def disable(self):
- calls.append("disable")
- class AddCleanupInSetUp(unittest.TestCase):
- def setUp(self):
- calls.append("setUp")
- self.addCleanup(lambda: calls.append("cleanup"))
- decorator = SaveCallsDecorator()
- decorated_test_class = decorator.__call__(AddCleanupInSetUp)()
- decorated_test_class.setUp()
- decorated_test_class.tearDown()
- decorated_test_class.doCleanups()
- self.assertEqual(calls, ["enable", "setUp", "cleanup", "disable"])
|