2
0

tools.txt 65 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647
  1. =============
  2. Testing tools
  3. =============
  4. .. currentmodule:: django.test
  5. Django provides a small set of tools that come in handy when writing tests.
  6. .. _test-client:
  7. The test client
  8. ---------------
  9. The test client is a Python class that acts as a dummy Web browser, allowing
  10. you to test your views and interact with your Django-powered application
  11. programmatically.
  12. Some of the things you can do with the test client are:
  13. * Simulate GET and POST requests on a URL and observe the response --
  14. everything from low-level HTTP (result headers and status codes) to
  15. page content.
  16. * See the chain of redirects (if any) and check the URL and status code at
  17. each step.
  18. * Test that a given request is rendered by a given Django template, with
  19. a template context that contains certain values.
  20. Note that the test client is not intended to be a replacement for Selenium_ or
  21. other "in-browser" frameworks. Django's test client has a different focus. In
  22. short:
  23. * Use Django's test client to establish that the correct template is being
  24. rendered and that the template is passed the correct context data.
  25. * Use in-browser frameworks like Selenium_ to test *rendered* HTML and the
  26. *behavior* of Web pages, namely JavaScript functionality. Django also
  27. provides special support for those frameworks; see the section on
  28. :class:`~django.test.LiveServerTestCase` for more details.
  29. A comprehensive test suite should use a combination of both test types.
  30. Overview and a quick example
  31. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  32. To use the test client, instantiate ``django.test.Client`` and retrieve
  33. Web pages::
  34. >>> from django.test import Client
  35. >>> c = Client()
  36. >>> response = c.post('/login/', {'username': 'john', 'password': 'smith'})
  37. >>> response.status_code
  38. 200
  39. >>> response = c.get('/customer/details/')
  40. >>> response.content
  41. '<!DOCTYPE html...'
  42. As this example suggests, you can instantiate ``Client`` from within a session
  43. of the Python interactive interpreter.
  44. Note a few important things about how the test client works:
  45. * The test client does *not* require the Web server to be running. In fact,
  46. it will run just fine with no Web server running at all! That's because
  47. it avoids the overhead of HTTP and deals directly with the Django
  48. framework. This helps make the unit tests run quickly.
  49. * When retrieving pages, remember to specify the *path* of the URL, not the
  50. whole domain. For example, this is correct::
  51. >>> c.get('/login/')
  52. This is incorrect::
  53. >>> c.get('http://www.example.com/login/')
  54. The test client is not capable of retrieving Web pages that are not
  55. powered by your Django project. If you need to retrieve other Web pages,
  56. use a Python standard library module such as :mod:`urllib`.
  57. * To resolve URLs, the test client uses whatever URLconf is pointed-to by
  58. your :setting:`ROOT_URLCONF` setting.
  59. * Although the above example would work in the Python interactive
  60. interpreter, some of the test client's functionality, notably the
  61. template-related functionality, is only available *while tests are
  62. running*.
  63. The reason for this is that Django's test runner performs a bit of black
  64. magic in order to determine which template was loaded by a given view.
  65. This black magic (essentially a patching of Django's template system in
  66. memory) only happens during test running.
  67. * By default, the test client will disable any CSRF checks
  68. performed by your site.
  69. If, for some reason, you *want* the test client to perform CSRF
  70. checks, you can create an instance of the test client that
  71. enforces CSRF checks. To do this, pass in the
  72. ``enforce_csrf_checks`` argument when you construct your
  73. client::
  74. >>> from django.test import Client
  75. >>> csrf_client = Client(enforce_csrf_checks=True)
  76. Making requests
  77. ~~~~~~~~~~~~~~~
  78. Use the ``django.test.Client`` class to make requests.
  79. .. class:: Client(enforce_csrf_checks=False, **defaults)
  80. It requires no arguments at time of construction. However, you can use
  81. keywords arguments to specify some default headers. For example, this will
  82. send a ``User-Agent`` HTTP header in each request::
  83. >>> c = Client(HTTP_USER_AGENT='Mozilla/5.0')
  84. The values from the ``extra`` keywords arguments passed to
  85. :meth:`~django.test.Client.get()`,
  86. :meth:`~django.test.Client.post()`, etc. have precedence over
  87. the defaults passed to the class constructor.
  88. The ``enforce_csrf_checks`` argument can be used to test CSRF
  89. protection (see above).
  90. Once you have a ``Client`` instance, you can call any of the following
  91. methods:
  92. .. method:: Client.get(path, data=None, follow=False, secure=False, **extra)
  93. .. versionadded:: 1.7
  94. The ``secure`` argument was added.
  95. Makes a GET request on the provided ``path`` and returns a ``Response``
  96. object, which is documented below.
  97. The key-value pairs in the ``data`` dictionary are used to create a GET
  98. data payload. For example::
  99. >>> c = Client()
  100. >>> c.get('/customers/details/', {'name': 'fred', 'age': 7})
  101. ...will result in the evaluation of a GET request equivalent to::
  102. /customers/details/?name=fred&age=7
  103. The ``extra`` keyword arguments parameter can be used to specify
  104. headers to be sent in the request. For example::
  105. >>> c = Client()
  106. >>> c.get('/customers/details/', {'name': 'fred', 'age': 7},
  107. ... HTTP_X_REQUESTED_WITH='XMLHttpRequest')
  108. ...will send the HTTP header ``HTTP_X_REQUESTED_WITH`` to the
  109. details view, which is a good way to test code paths that use the
  110. :meth:`django.http.HttpRequest.is_ajax()` method.
  111. .. admonition:: CGI specification
  112. The headers sent via ``**extra`` should follow CGI_ specification.
  113. For example, emulating a different "Host" header as sent in the
  114. HTTP request from the browser to the server should be passed
  115. as ``HTTP_HOST``.
  116. .. _CGI: http://www.w3.org/CGI/
  117. If you already have the GET arguments in URL-encoded form, you can
  118. use that encoding instead of using the data argument. For example,
  119. the previous GET request could also be posed as::
  120. >>> c = Client()
  121. >>> c.get('/customers/details/?name=fred&age=7')
  122. If you provide a URL with both an encoded GET data and a data argument,
  123. the data argument will take precedence.
  124. If you set ``follow`` to ``True`` the client will follow any redirects
  125. and a ``redirect_chain`` attribute will be set in the response object
  126. containing tuples of the intermediate urls and status codes.
  127. If you had a URL ``/redirect_me/`` that redirected to ``/next/``, that
  128. redirected to ``/final/``, this is what you'd see::
  129. >>> response = c.get('/redirect_me/', follow=True)
  130. >>> response.redirect_chain
  131. [('http://testserver/next/', 302), ('http://testserver/final/', 302)]
  132. If you set ``secure`` to ``True`` the client will emulate an HTTPS
  133. request.
  134. .. method:: Client.post(path, data=None, content_type=MULTIPART_CONTENT, follow=False, secure=False, **extra)
  135. Makes a POST request on the provided ``path`` and returns a
  136. ``Response`` object, which is documented below.
  137. The key-value pairs in the ``data`` dictionary are used to submit POST
  138. data. For example::
  139. >>> c = Client()
  140. >>> c.post('/login/', {'name': 'fred', 'passwd': 'secret'})
  141. ...will result in the evaluation of a POST request to this URL::
  142. /login/
  143. ...with this POST data::
  144. name=fred&passwd=secret
  145. If you provide ``content_type`` (e.g. :mimetype:`text/xml` for an XML
  146. payload), the contents of ``data`` will be sent as-is in the POST
  147. request, using ``content_type`` in the HTTP ``Content-Type`` header.
  148. If you don't provide a value for ``content_type``, the values in
  149. ``data`` will be transmitted with a content type of
  150. :mimetype:`multipart/form-data`. In this case, the key-value pairs in
  151. ``data`` will be encoded as a multipart message and used to create the
  152. POST data payload.
  153. To submit multiple values for a given key -- for example, to specify
  154. the selections for a ``<select multiple>`` -- provide the values as a
  155. list or tuple for the required key. For example, this value of ``data``
  156. would submit three selected values for the field named ``choices``::
  157. {'choices': ('a', 'b', 'd')}
  158. Submitting files is a special case. To POST a file, you need only
  159. provide the file field name as a key, and a file handle to the file you
  160. wish to upload as a value. For example::
  161. >>> c = Client()
  162. >>> with open('wishlist.doc') as fp:
  163. ... c.post('/customers/wishes/', {'name': 'fred', 'attachment': fp})
  164. (The name ``attachment`` here is not relevant; use whatever name your
  165. file-processing code expects.)
  166. Note that if you wish to use the same file handle for multiple
  167. ``post()`` calls then you will need to manually reset the file
  168. pointer between posts. The easiest way to do this is to
  169. manually close the file after it has been provided to
  170. ``post()``, as demonstrated above.
  171. You should also ensure that the file is opened in a way that
  172. allows the data to be read. If your file contains binary data
  173. such as an image, this means you will need to open the file in
  174. ``rb`` (read binary) mode.
  175. The ``extra`` argument acts the same as for :meth:`Client.get`.
  176. If the URL you request with a POST contains encoded parameters, these
  177. parameters will be made available in the request.GET data. For example,
  178. if you were to make the request::
  179. >>> c.post('/login/?visitor=true', {'name': 'fred', 'passwd': 'secret'})
  180. ... the view handling this request could interrogate request.POST
  181. to retrieve the username and password, and could interrogate request.GET
  182. to determine if the user was a visitor.
  183. If you set ``follow`` to ``True`` the client will follow any redirects
  184. and a ``redirect_chain`` attribute will be set in the response object
  185. containing tuples of the intermediate urls and status codes.
  186. If you set ``secure`` to ``True`` the client will emulate an HTTPS
  187. request.
  188. .. method:: Client.head(path, data=None, follow=False, secure=False, **extra)
  189. Makes a HEAD request on the provided ``path`` and returns a
  190. ``Response`` object. This method works just like :meth:`Client.get`,
  191. including the ``follow``, ``secure`` and ``extra`` arguments, except
  192. it does not return a message body.
  193. .. method:: Client.options(path, data='', content_type='application/octet-stream', follow=False, secure=False, **extra)
  194. Makes an OPTIONS request on the provided ``path`` and returns a
  195. ``Response`` object. Useful for testing RESTful interfaces.
  196. When ``data`` is provided, it is used as the request body, and
  197. a ``Content-Type`` header is set to ``content_type``.
  198. The ``follow``, ``secure`` and ``extra`` arguments act the same as for
  199. :meth:`Client.get`.
  200. .. method:: Client.put(path, data='', content_type='application/octet-stream', follow=False, secure=False, **extra)
  201. Makes a PUT request on the provided ``path`` and returns a
  202. ``Response`` object. Useful for testing RESTful interfaces.
  203. When ``data`` is provided, it is used as the request body, and
  204. a ``Content-Type`` header is set to ``content_type``.
  205. The ``follow``, ``secure`` and ``extra`` arguments act the same as for
  206. :meth:`Client.get`.
  207. .. method:: Client.patch(path, data='', content_type='application/octet-stream', follow=False, secure=False, **extra)
  208. Makes a PATCH request on the provided ``path`` and returns a
  209. ``Response`` object. Useful for testing RESTful interfaces.
  210. The ``follow``, ``secure`` and ``extra`` arguments act the same as for
  211. :meth:`Client.get`.
  212. .. method:: Client.delete(path, data='', content_type='application/octet-stream', follow=False, secure=False, **extra)
  213. Makes an DELETE request on the provided ``path`` and returns a
  214. ``Response`` object. Useful for testing RESTful interfaces.
  215. When ``data`` is provided, it is used as the request body, and
  216. a ``Content-Type`` header is set to ``content_type``.
  217. The ``follow``, ``secure`` and ``extra`` arguments act the same as for
  218. :meth:`Client.get`.
  219. .. method:: Client.login(**credentials)
  220. If your site uses Django's :doc:`authentication system</topics/auth/index>`
  221. and you deal with logging in users, you can use the test client's
  222. ``login()`` method to simulate the effect of a user logging into the
  223. site.
  224. After you call this method, the test client will have all the cookies
  225. and session data required to pass any login-based tests that may form
  226. part of a view.
  227. The format of the ``credentials`` argument depends on which
  228. :ref:`authentication backend <authentication-backends>` you're using
  229. (which is configured by your :setting:`AUTHENTICATION_BACKENDS`
  230. setting). If you're using the standard authentication backend provided
  231. by Django (``ModelBackend``), ``credentials`` should be the user's
  232. username and password, provided as keyword arguments::
  233. >>> c = Client()
  234. >>> c.login(username='fred', password='secret')
  235. # Now you can access a view that's only available to logged-in users.
  236. If you're using a different authentication backend, this method may
  237. require different credentials. It requires whichever credentials are
  238. required by your backend's ``authenticate()`` method.
  239. ``login()`` returns ``True`` if it the credentials were accepted and
  240. login was successful.
  241. Finally, you'll need to remember to create user accounts before you can
  242. use this method. As we explained above, the test runner is executed
  243. using a test database, which contains no users by default. As a result,
  244. user accounts that are valid on your production site will not work
  245. under test conditions. You'll need to create users as part of the test
  246. suite -- either manually (using the Django model API) or with a test
  247. fixture. Remember that if you want your test user to have a password,
  248. you can't set the user's password by setting the password attribute
  249. directly -- you must use the
  250. :meth:`~django.contrib.auth.models.User.set_password()` function to
  251. store a correctly hashed password. Alternatively, you can use the
  252. :meth:`~django.contrib.auth.models.UserManager.create_user` helper
  253. method to create a new user with a correctly hashed password.
  254. .. method:: Client.logout()
  255. If your site uses Django's :doc:`authentication system</topics/auth/index>`,
  256. the ``logout()`` method can be used to simulate the effect of a user
  257. logging out of your site.
  258. After you call this method, the test client will have all the cookies
  259. and session data cleared to defaults. Subsequent requests will appear
  260. to come from an :class:`~django.contrib.auth.models.AnonymousUser`.
  261. Testing responses
  262. ~~~~~~~~~~~~~~~~~
  263. The ``get()`` and ``post()`` methods both return a ``Response`` object. This
  264. ``Response`` object is *not* the same as the ``HttpResponse`` object returned
  265. Django views; the test response object has some additional data useful for
  266. test code to verify.
  267. Specifically, a ``Response`` object has the following attributes:
  268. .. class:: Response()
  269. .. attribute:: client
  270. The test client that was used to make the request that resulted in the
  271. response.
  272. .. attribute:: content
  273. The body of the response, as a string. This is the final page content as
  274. rendered by the view, or any error message.
  275. .. attribute:: context
  276. The template ``Context`` instance that was used to render the template that
  277. produced the response content.
  278. If the rendered page used multiple templates, then ``context`` will be a
  279. list of ``Context`` objects, in the order in which they were rendered.
  280. Regardless of the number of templates used during rendering, you can
  281. retrieve context values using the ``[]`` operator. For example, the
  282. context variable ``name`` could be retrieved using::
  283. >>> response = client.get('/foo/')
  284. >>> response.context['name']
  285. 'Arthur'
  286. .. attribute:: request
  287. The request data that stimulated the response.
  288. .. attribute:: wsgi_request
  289. .. versionadded:: 1.7
  290. The ``WSGIRequest`` instance generated by the test handler that
  291. generated the response.
  292. .. attribute:: status_code
  293. The HTTP status of the response, as an integer. See
  294. :rfc:`2616#section-10` for a full list of HTTP status codes.
  295. .. attribute:: templates
  296. A list of ``Template`` instances used to render the final content, in
  297. the order they were rendered. For each template in the list, use
  298. ``template.name`` to get the template's file name, if the template was
  299. loaded from a file. (The name is a string such as
  300. ``'admin/index.html'``.)
  301. .. attribute:: resolver_match
  302. .. versionadded:: 1.8
  303. An instance of :class:`~django.core.urlresolvers.ResolverMatch` for the
  304. response. You can use the
  305. :attr:`~django.core.urlresolvers.ResolverMatch.func` attribute, for
  306. example, to verify the view that served the response::
  307. # my_view here is a function based view
  308. self.assertEqual(response.resolver_match.func, my_view)
  309. # class based views need to be compared by name, as the functions
  310. # generated by as_view() won't be equal
  311. self.assertEqual(response.resolver_match.func.__name__, MyView.as_view().__name__)
  312. If the given URL is not found, accessing this attribute will raise a
  313. :exc:`~django.core.urlresolvers.Resolver404` exception.
  314. You can also use dictionary syntax on the response object to query the value
  315. of any settings in the HTTP headers. For example, you could determine the
  316. content type of a response using ``response['Content-Type']``.
  317. Exceptions
  318. ~~~~~~~~~~
  319. If you point the test client at a view that raises an exception, that exception
  320. will be visible in the test case. You can then use a standard ``try ... except``
  321. block or :meth:`~unittest.TestCase.assertRaises` to test for exceptions.
  322. The only exceptions that are not visible to the test client are ``Http404``,
  323. ``PermissionDenied`` and ``SystemExit``. Django catches these exceptions
  324. internally and converts them into the appropriate HTTP response codes. In these
  325. cases, you can check ``response.status_code`` in your test.
  326. Persistent state
  327. ~~~~~~~~~~~~~~~~
  328. The test client is stateful. If a response returns a cookie, then that cookie
  329. will be stored in the test client and sent with all subsequent ``get()`` and
  330. ``post()`` requests.
  331. Expiration policies for these cookies are not followed. If you want a cookie
  332. to expire, either delete it manually or create a new ``Client`` instance (which
  333. will effectively delete all cookies).
  334. A test client has two attributes that store persistent state information. You
  335. can access these properties as part of a test condition.
  336. .. attribute:: Client.cookies
  337. A Python :class:`~http.cookies.SimpleCookie` object, containing the current
  338. values of all the client cookies. See the documentation of the
  339. :mod:`http.cookies` module for more.
  340. .. attribute:: Client.session
  341. A dictionary-like object containing session information. See the
  342. :doc:`session documentation</topics/http/sessions>` for full details.
  343. To modify the session and then save it, it must be stored in a variable
  344. first (because a new ``SessionStore`` is created every time this property
  345. is accessed)::
  346. def test_something(self):
  347. session = self.client.session
  348. session['somekey'] = 'test'
  349. session.save()
  350. Example
  351. ~~~~~~~
  352. The following is a simple unit test using the test client::
  353. import unittest
  354. from django.test import Client
  355. class SimpleTest(unittest.TestCase):
  356. def setUp(self):
  357. # Every test needs a client.
  358. self.client = Client()
  359. def test_details(self):
  360. # Issue a GET request.
  361. response = self.client.get('/customer/details/')
  362. # Check that the response is 200 OK.
  363. self.assertEqual(response.status_code, 200)
  364. # Check that the rendered context contains 5 customers.
  365. self.assertEqual(len(response.context['customers']), 5)
  366. .. seealso::
  367. :class:`django.test.RequestFactory`
  368. .. _django-testcase-subclasses:
  369. Provided test case classes
  370. --------------------------
  371. Normal Python unit test classes extend a base class of
  372. :class:`unittest.TestCase`. Django provides a few extensions of this base class:
  373. .. _testcase_hierarchy_diagram:
  374. .. figure:: _images/django_unittest_classes_hierarchy.*
  375. :alt: Hierarchy of Django unit testing classes (TestCase subclasses)
  376. :width: 508
  377. :height: 328
  378. Hierarchy of Django unit testing classes
  379. SimpleTestCase
  380. ~~~~~~~~~~~~~~
  381. .. class:: SimpleTestCase()
  382. A thin subclass of :class:`unittest.TestCase`, it extends it with some basic
  383. functionality like:
  384. * Saving and restoring the Python warning machinery state.
  385. * Some useful assertions like:
  386. * Checking that a callable :meth:`raises a certain exception
  387. <SimpleTestCase.assertRaisesMessage>`.
  388. * Testing form field :meth:`rendering and error treatment
  389. <SimpleTestCase.assertFieldOutput>`.
  390. * Testing :meth:`HTML responses for the presence/lack of a given fragment
  391. <SimpleTestCase.assertContains>`.
  392. * Verifying that a template :meth:`has/hasn't been used to generate a given
  393. response content <SimpleTestCase.assertTemplateUsed>`.
  394. * Verifying a HTTP :meth:`redirect <SimpleTestCase.assertRedirects>` is
  395. performed by the app.
  396. * Robustly testing two :meth:`HTML fragments <SimpleTestCase.assertHTMLEqual>`
  397. for equality/inequality or :meth:`containment <SimpleTestCase.assertInHTML>`.
  398. * Robustly testing two :meth:`XML fragments <SimpleTestCase.assertXMLEqual>`
  399. for equality/inequality.
  400. * Robustly testing two :meth:`JSON fragments <SimpleTestCase.assertJSONEqual>`
  401. for equality.
  402. * The ability to run tests with :ref:`modified settings <overriding-settings>`.
  403. * Using the :attr:`~SimpleTestCase.client` :class:`~django.test.Client`.
  404. * Custom test-time :attr:`URL maps <SimpleTestCase.urls>`.
  405. If you need any of the other more complex and heavyweight Django-specific
  406. features like:
  407. * Testing or using the ORM.
  408. * Database :attr:`~TransactionTestCase.fixtures`.
  409. * Test :ref:`skipping based on database backend features <skipping-tests>`.
  410. * The remaining specialized :meth:`assert*
  411. <TransactionTestCase.assertQuerysetEqual>` methods.
  412. then you should use :class:`~django.test.TransactionTestCase` or
  413. :class:`~django.test.TestCase` instead.
  414. ``SimpleTestCase`` inherits from ``unittest.TestCase``.
  415. TransactionTestCase
  416. ~~~~~~~~~~~~~~~~~~~
  417. .. class:: TransactionTestCase()
  418. Django's ``TestCase`` class (described below) makes use of database transaction
  419. facilities to speed up the process of resetting the database to a known state
  420. at the beginning of each test. A consequence of this, however, is that the
  421. effects of transaction commit and rollback cannot be tested by a Django
  422. ``TestCase`` class. If your test requires testing of such transactional
  423. behavior, you should use a Django ``TransactionTestCase``.
  424. ``TransactionTestCase`` and ``TestCase`` are identical except for the manner
  425. in which the database is reset to a known state and the ability for test code
  426. to test the effects of commit and rollback:
  427. * A ``TransactionTestCase`` resets the database after the test runs by
  428. truncating all tables. A ``TransactionTestCase`` may call commit and rollback
  429. and observe the effects of these calls on the database.
  430. * A ``TestCase``, on the other hand, does not truncate tables after a test.
  431. Instead, it encloses the test code in a database transaction that is rolled
  432. back at the end of the test. Both explicit commits like
  433. ``transaction.commit()`` and implicit ones that may be caused by
  434. ``transaction.atomic()`` are replaced with a ``nop`` operation. This
  435. guarantees that the rollback at the end of the test restores the database to
  436. its initial state.
  437. .. warning::
  438. ``TestCase`` running on a database that does not support rollback (e.g. MySQL with the
  439. MyISAM storage engine), and all instances of ``TransactionTestCase``, will
  440. roll back at the end of the test by deleting all data from the test database
  441. and reloading initial data for apps without migrations.
  442. Apps with migrations :ref:`will not see their data reloaded <test-case-serialized-rollback>`;
  443. if you need this functionality (for example, third-party apps should enable
  444. this) you can set ``serialized_rollback = True`` inside the
  445. ``TestCase`` body.
  446. .. warning::
  447. While ``commit`` and ``rollback`` operations still *appear* to work when
  448. used in ``TestCase``, no actual commit or rollback will be performed by the
  449. database. This can cause your tests to pass or fail unexpectedly. Always
  450. use ``TransactionTestCase`` when testing transactional behavior or any code
  451. that can't normally be executed in autocommit mode
  452. (:meth:`~django.db.models.query.QuerySet.select_for_update()` is an
  453. example).
  454. ``TransactionTestCase`` inherits from :class:`~django.test.SimpleTestCase`.
  455. TestCase
  456. ~~~~~~~~
  457. .. class:: TestCase()
  458. This class provides some additional capabilities that can be useful for testing
  459. Web sites.
  460. Converting a normal :class:`unittest.TestCase` to a Django :class:`TestCase` is
  461. easy: Just change the base class of your test from ``'unittest.TestCase'`` to
  462. ``'django.test.TestCase'``. All of the standard Python unit test functionality
  463. will continue to be available, but it will be augmented with some useful
  464. additions, including:
  465. * Automatic loading of fixtures.
  466. * Wraps each test in a transaction.
  467. * Creates a TestClient instance.
  468. * Django-specific assertions for testing for things like redirection and form
  469. errors.
  470. ``TestCase`` inherits from :class:`~django.test.TransactionTestCase`.
  471. .. _live-test-server:
  472. LiveServerTestCase
  473. ~~~~~~~~~~~~~~~~~~
  474. .. class:: LiveServerTestCase()
  475. ``LiveServerTestCase`` does basically the same as
  476. :class:`~django.test.TransactionTestCase` with one extra feature: it launches a
  477. live Django server in the background on setup, and shuts it down on teardown.
  478. This allows the use of automated test clients other than the
  479. :ref:`Django dummy client <test-client>` such as, for example, the Selenium_
  480. client, to execute a series of functional tests inside a browser and simulate a
  481. real user's actions.
  482. By default the live server's address is ``'localhost:8081'`` and the full URL
  483. can be accessed during the tests with ``self.live_server_url``. If you'd like
  484. to change the default address (in the case, for example, where the 8081 port is
  485. already taken) then you may pass a different one to the :djadmin:`test` command
  486. via the :djadminopt:`--liveserver` option, for example:
  487. .. code-block:: bash
  488. ./manage.py test --liveserver=localhost:8082
  489. Another way of changing the default server address is by setting the
  490. `DJANGO_LIVE_TEST_SERVER_ADDRESS` environment variable somewhere in your
  491. code (for example, in a :ref:`custom test runner<topics-testing-test_runner>`)::
  492. import os
  493. os.environ['DJANGO_LIVE_TEST_SERVER_ADDRESS'] = 'localhost:8082'
  494. In the case where the tests are run by multiple processes in parallel (for
  495. example, in the context of several simultaneous `continuous integration`_
  496. builds), the processes will compete for the same address, and therefore your
  497. tests might randomly fail with an "Address already in use" error. To avoid this
  498. problem, you can pass a comma-separated list of ports or ranges of ports (at
  499. least as many as the number of potential parallel processes). For example:
  500. .. code-block:: bash
  501. ./manage.py test --liveserver=localhost:8082,8090-8100,9000-9200,7041
  502. Then, during test execution, each new live test server will try every specified
  503. port until it finds one that is free and takes it.
  504. .. _continuous integration: http://en.wikipedia.org/wiki/Continuous_integration
  505. To demonstrate how to use ``LiveServerTestCase``, let's write a simple Selenium
  506. test. First of all, you need to install the `selenium package`_ into your
  507. Python path:
  508. .. code-block:: bash
  509. pip install selenium
  510. Then, add a ``LiveServerTestCase``-based test to your app's tests module
  511. (for example: ``myapp/tests.py``). The code for this test may look as follows::
  512. from django.test import LiveServerTestCase
  513. from selenium.webdriver.firefox.webdriver import WebDriver
  514. class MySeleniumTests(LiveServerTestCase):
  515. fixtures = ['user-data.json']
  516. @classmethod
  517. def setUpClass(cls):
  518. cls.selenium = WebDriver()
  519. super(MySeleniumTests, cls).setUpClass()
  520. @classmethod
  521. def tearDownClass(cls):
  522. cls.selenium.quit()
  523. super(MySeleniumTests, cls).tearDownClass()
  524. def test_login(self):
  525. self.selenium.get('%s%s' % (self.live_server_url, '/login/'))
  526. username_input = self.selenium.find_element_by_name("username")
  527. username_input.send_keys('myuser')
  528. password_input = self.selenium.find_element_by_name("password")
  529. password_input.send_keys('secret')
  530. self.selenium.find_element_by_xpath('//input[@value="Log in"]').click()
  531. Finally, you may run the test as follows:
  532. .. code-block:: bash
  533. ./manage.py test myapp.MySeleniumTests.test_login
  534. This example will automatically open Firefox then go to the login page, enter
  535. the credentials and press the "Log in" button. Selenium offers other drivers in
  536. case you do not have Firefox installed or wish to use another browser. The
  537. example above is just a tiny fraction of what the Selenium client can do; check
  538. out the `full reference`_ for more details.
  539. .. _Selenium: http://seleniumhq.org/
  540. .. _selenium package: https://pypi.python.org/pypi/selenium
  541. .. _full reference: http://selenium-python.readthedocs.org/en/latest/api.html
  542. .. _Firefox: http://www.mozilla.com/firefox/
  543. .. versionchanged:: 1.7
  544. Before Django 1.7 ``LiveServerTestCase`` used to rely on the
  545. :doc:`staticfiles contrib app </howto/static-files/index>` to get the
  546. static assets of the application(s) under test transparently served at their
  547. expected locations during the execution of these tests.
  548. In Django 1.7 this dependency of core functionality on a ``contrib``
  549. application has been removed, because of which ``LiveServerTestCase``
  550. ability in this respect has been retrofitted to simply publish the contents
  551. of the file system under :setting:`STATIC_ROOT` at the :setting:`STATIC_URL`
  552. URL.
  553. If you use the ``staticfiles`` app in your project and need to perform live
  554. testing then you might want to consider using the
  555. :class:`~django.contrib.staticfiles.testing.StaticLiveServerCase` subclass
  556. shipped with it instead because it's the one that implements the original
  557. behavior now. See :ref:`the relevant documentation
  558. <staticfiles-testing-support>` for more details.
  559. .. note::
  560. When using an in-memory SQLite database to run the tests, the same database
  561. connection will be shared by two threads in parallel: the thread in which
  562. the live server is run and the thread in which the test case is run. It's
  563. important to prevent simultaneous database queries via this shared
  564. connection by the two threads, as that may sometimes randomly cause the
  565. tests to fail. So you need to ensure that the two threads don't access the
  566. database at the same time. In particular, this means that in some cases
  567. (for example, just after clicking a link or submitting a form), you might
  568. need to check that a response is received by Selenium and that the next
  569. page is loaded before proceeding with further test execution.
  570. Do this, for example, by making Selenium wait until the ``<body>`` HTML tag
  571. is found in the response (requires Selenium > 2.13)::
  572. def test_login(self):
  573. from selenium.webdriver.support.wait import WebDriverWait
  574. timeout = 2
  575. ...
  576. self.selenium.find_element_by_xpath('//input[@value="Log in"]').click()
  577. # Wait until the response is received
  578. WebDriverWait(self.selenium, timeout).until(
  579. lambda driver: driver.find_element_by_tag_name('body'))
  580. The tricky thing here is that there's really no such thing as a "page load,"
  581. especially in modern Web apps that generate HTML dynamically after the
  582. server generates the initial document. So, simply checking for the presence
  583. of ``<body>`` in the response might not necessarily be appropriate for all
  584. use cases. Please refer to the `Selenium FAQ`_ and
  585. `Selenium documentation`_ for more information.
  586. .. _Selenium FAQ: http://code.google.com/p/selenium/wiki/FrequentlyAskedQuestions#Q:_WebDriver_fails_to_find_elements_/_Does_not_block_on_page_loa
  587. .. _Selenium documentation: http://seleniumhq.org/docs/04_webdriver_advanced.html#explicit-waits
  588. Test cases features
  589. -------------------
  590. Default test client
  591. ~~~~~~~~~~~~~~~~~~~
  592. .. attribute:: SimpleTestCase.client
  593. Every test case in a ``django.test.*TestCase`` instance has access to an
  594. instance of a Django test client. This client can be accessed as
  595. ``self.client``. This client is recreated for each test, so you don't have to
  596. worry about state (such as cookies) carrying over from one test to another.
  597. This means, instead of instantiating a ``Client`` in each test::
  598. import unittest
  599. from django.test import Client
  600. class SimpleTest(unittest.TestCase):
  601. def test_details(self):
  602. client = Client()
  603. response = client.get('/customer/details/')
  604. self.assertEqual(response.status_code, 200)
  605. def test_index(self):
  606. client = Client()
  607. response = client.get('/customer/index/')
  608. self.assertEqual(response.status_code, 200)
  609. ...you can just refer to ``self.client``, like so::
  610. from django.test import TestCase
  611. class SimpleTest(TestCase):
  612. def test_details(self):
  613. response = self.client.get('/customer/details/')
  614. self.assertEqual(response.status_code, 200)
  615. def test_index(self):
  616. response = self.client.get('/customer/index/')
  617. self.assertEqual(response.status_code, 200)
  618. Customizing the test client
  619. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  620. .. attribute:: SimpleTestCase.client_class
  621. If you want to use a different ``Client`` class (for example, a subclass
  622. with customized behavior), use the :attr:`~SimpleTestCase.client_class` class
  623. attribute::
  624. from django.test import TestCase, Client
  625. class MyTestClient(Client):
  626. # Specialized methods for your environment...
  627. class MyTest(TestCase):
  628. client_class = MyTestClient
  629. def test_my_stuff(self):
  630. # Here self.client is an instance of MyTestClient...
  631. call_some_test_code()
  632. .. _topics-testing-fixtures:
  633. Fixture loading
  634. ~~~~~~~~~~~~~~~
  635. .. attribute:: TransactionTestCase.fixtures
  636. A test case for a database-backed Web site isn't much use if there isn't any
  637. data in the database. To make it easy to put test data into the database,
  638. Django's custom ``TransactionTestCase`` class provides a way of loading
  639. **fixtures**.
  640. A fixture is a collection of data that Django knows how to import into a
  641. database. For example, if your site has user accounts, you might set up a
  642. fixture of fake user accounts in order to populate your database during tests.
  643. The most straightforward way of creating a fixture is to use the
  644. :djadmin:`manage.py dumpdata <dumpdata>` command. This assumes you
  645. already have some data in your database. See the :djadmin:`dumpdata
  646. documentation<dumpdata>` for more details.
  647. .. note::
  648. If you've ever run :djadmin:`manage.py migrate<migrate>`, you've
  649. already used a fixture without even knowing it! When you call
  650. :djadmin:`migrate` in the database for the first time, Django
  651. installs a fixture called ``initial_data``. This gives you a way
  652. of populating a new database with any initial data, such as a
  653. default set of categories.
  654. Fixtures with other names can always be installed manually using
  655. the :djadmin:`manage.py loaddata<loaddata>` command.
  656. .. admonition:: Initial SQL data and testing
  657. Django provides a second way to insert initial data into models --
  658. the :ref:`custom SQL hook <initial-sql>`. However, this technique
  659. *cannot* be used to provide initial data for testing purposes.
  660. Django's test framework flushes the contents of the test database
  661. after each test; as a result, any data added using the custom SQL
  662. hook will be lost.
  663. Once you've created a fixture and placed it in a ``fixtures`` directory in one
  664. of your :setting:`INSTALLED_APPS`, you can use it in your unit tests by
  665. specifying a ``fixtures`` class attribute on your :class:`django.test.TestCase`
  666. subclass::
  667. from django.test import TestCase
  668. from myapp.models import Animal
  669. class AnimalTestCase(TestCase):
  670. fixtures = ['mammals.json', 'birds']
  671. def setUp(self):
  672. # Test definitions as before.
  673. call_setup_methods()
  674. def testFluffyAnimals(self):
  675. # A test that uses the fixtures.
  676. call_some_test_code()
  677. Here's specifically what will happen:
  678. * At the start of each test case, before ``setUp()`` is run, Django will
  679. flush the database, returning the database to the state it was in
  680. directly after :djadmin:`migrate` was called.
  681. * Then, all the named fixtures are installed. In this example, Django will
  682. install any JSON fixture named ``mammals``, followed by any fixture named
  683. ``birds``. See the :djadmin:`loaddata` documentation for more
  684. details on defining and installing fixtures.
  685. This flush/load procedure is repeated for each test in the test case, so you
  686. can be certain that the outcome of a test will not be affected by another test,
  687. or by the order of test execution.
  688. By default, fixtures are only loaded into the ``default`` database. If you are
  689. using multiple databases and set :attr:`multi_db=True
  690. <TransactionTestCase.multi_db>`, fixtures will be loaded into all databases.
  691. URLconf configuration
  692. ~~~~~~~~~~~~~~~~~~~~~
  693. .. attribute:: SimpleTestCase.urls
  694. .. deprecated:: 1.8
  695. Use ``@override_settings(ROOT_URLCONF=...)`` instead for URLconf
  696. configuration.
  697. If your application provides views, you may want to include tests that use the
  698. test client to exercise those views. However, an end user is free to deploy the
  699. views in your application at any URL of their choosing. This means that your
  700. tests can't rely upon the fact that your views will be available at a
  701. particular URL.
  702. In order to provide a reliable URL space for your test,
  703. ``django.test.*TestCase`` classes provide the ability to customize the URLconf
  704. configuration for the duration of the execution of a test suite. If your
  705. ``*TestCase`` instance defines an ``urls`` attribute, the ``*TestCase`` will use
  706. the value of that attribute as the :setting:`ROOT_URLCONF` for the duration
  707. of that test.
  708. For example::
  709. from django.test import TestCase
  710. class TestMyViews(TestCase):
  711. urls = 'myapp.test_urls'
  712. def testIndexPageView(self):
  713. # Here you'd test your view using ``Client``.
  714. call_some_test_code()
  715. This test case will use the contents of ``myapp.test_urls`` as the
  716. URLconf for the duration of the test case.
  717. .. _emptying-test-outbox:
  718. Multi-database support
  719. ~~~~~~~~~~~~~~~~~~~~~~
  720. .. attribute:: TransactionTestCase.multi_db
  721. Django sets up a test database corresponding to every database that is
  722. defined in the :setting:`DATABASES` definition in your settings
  723. file. However, a big part of the time taken to run a Django TestCase
  724. is consumed by the call to ``flush`` that ensures that you have a
  725. clean database at the start of each test run. If you have multiple
  726. databases, multiple flushes are required (one for each database),
  727. which can be a time consuming activity -- especially if your tests
  728. don't need to test multi-database activity.
  729. As an optimization, Django only flushes the ``default`` database at
  730. the start of each test run. If your setup contains multiple databases,
  731. and you have a test that requires every database to be clean, you can
  732. use the ``multi_db`` attribute on the test suite to request a full
  733. flush.
  734. For example::
  735. class TestMyViews(TestCase):
  736. multi_db = True
  737. def testIndexPageView(self):
  738. call_some_test_code()
  739. This test case will flush *all* the test databases before running
  740. ``testIndexPageView``.
  741. The ``multi_db`` flag also affects into which databases the
  742. attr:`TransactionTestCase.fixtures` are loaded. By default (when
  743. ``multi_db=False``), fixtures are only loaded into the ``default`` database.
  744. If ``multi_db=True``, fixtures are loaded into all databases.
  745. .. _overriding-settings:
  746. Overriding settings
  747. ~~~~~~~~~~~~~~~~~~~
  748. .. method:: SimpleTestCase.settings()
  749. For testing purposes it's often useful to change a setting temporarily and
  750. revert to the original value after running the testing code. For this use case
  751. Django provides a standard Python context manager (see :pep:`343`) called
  752. :meth:`~django.test.SimpleTestCase.settings`, which can be used like this::
  753. from django.test import TestCase
  754. class LoginTestCase(TestCase):
  755. def test_login(self):
  756. # First check for the default behavior
  757. response = self.client.get('/sekrit/')
  758. self.assertRedirects(response, '/accounts/login/?next=/sekrit/')
  759. # Then override the LOGIN_URL setting
  760. with self.settings(LOGIN_URL='/other/login/'):
  761. response = self.client.get('/sekrit/')
  762. self.assertRedirects(response, '/other/login/?next=/sekrit/')
  763. This example will override the :setting:`LOGIN_URL` setting for the code
  764. in the ``with`` block and reset its value to the previous state afterwards.
  765. .. method:: SimpleTestCase.modify_settings()
  766. .. versionadded:: 1.7
  767. It can prove unwieldy to redefine settings that contain a list of values. In
  768. practice, adding or removing values is often sufficient. The
  769. :meth:`~django.test.SimpleTestCase.modify_settings` context manager makes it
  770. easy::
  771. from django.test import TestCase
  772. class MiddlewareTestCase(TestCase):
  773. def test_cache_middleware(self):
  774. with self.modify_settings(MIDDLEWARE_CLASSES={
  775. 'append': 'django.middleware.cache.FetchFromCacheMiddleware',
  776. 'prepend': 'django.middleware.cache.UpdateCacheMiddleware',
  777. 'remove': [
  778. 'django.contrib.sessions.middleware.SessionMiddleware',
  779. 'django.contrib.auth.middleware.AuthenticationMiddleware',
  780. 'django.contrib.messages.middleware.MessageMiddleware',
  781. ],
  782. }):
  783. response = self.client.get('/')
  784. # ...
  785. For each action, you can supply either a list of values or a string. When the
  786. value already exists in the list, ``append`` and ``prepend`` have no effect;
  787. neither does ``remove`` when the value doesn't exist.
  788. .. function:: override_settings
  789. In case you want to override a setting for a test method, Django provides the
  790. :func:`~django.test.override_settings` decorator (see :pep:`318`). It's used
  791. like this::
  792. from django.test import TestCase, override_settings
  793. class LoginTestCase(TestCase):
  794. @override_settings(LOGIN_URL='/other/login/')
  795. def test_login(self):
  796. response = self.client.get('/sekrit/')
  797. self.assertRedirects(response, '/other/login/?next=/sekrit/')
  798. The decorator can also be applied to :class:`~django.test.TestCase` classes::
  799. from django.test import TestCase, override_settings
  800. @override_settings(LOGIN_URL='/other/login/')
  801. class LoginTestCase(TestCase):
  802. def test_login(self):
  803. response = self.client.get('/sekrit/')
  804. self.assertRedirects(response, '/other/login/?next=/sekrit/')
  805. .. versionchanged:: 1.7
  806. Previously, ``override_settings`` was imported from ``django.test.utils``.
  807. .. function:: modify_settings
  808. .. versionadded:: 1.7
  809. Likewise, Django provides the :func:`~django.test.modify_settings`
  810. decorator::
  811. from django.test import TestCase, modify_settings
  812. class MiddlewareTestCase(TestCase):
  813. @modify_settings(MIDDLEWARE_CLASSES={
  814. 'append': 'django.middleware.cache.FetchFromCacheMiddleware',
  815. 'prepend': 'django.middleware.cache.UpdateCacheMiddleware',
  816. })
  817. def test_cache_middleware(self):
  818. response = self.client.get('/')
  819. # ...
  820. The decorator can also be applied to test case classes::
  821. from django.test import TestCase, modify_settings
  822. @modify_settings(MIDDLEWARE_CLASSES={
  823. 'append': 'django.middleware.cache.FetchFromCacheMiddleware',
  824. 'prepend': 'django.middleware.cache.UpdateCacheMiddleware',
  825. })
  826. class MiddlewareTestCase(TestCase):
  827. def test_cache_middleware(self):
  828. response = self.client.get('/')
  829. # ...
  830. .. note::
  831. When given a class, these decorators modify the class directly and return
  832. it; they don't create and return a modified copy of it. So if you try to
  833. tweak the above examples to assign the return value to a different name
  834. than ``LoginTestCase`` or ``MiddlewareTestCase``, you may be surprised to
  835. find that the original test case classes are still equally affected by the
  836. decorator. For a given class, :func:`~django.test.modify_settings` is
  837. always applied after :func:`~django.test.override_settings`.
  838. .. warning::
  839. The settings file contains some settings that are only consulted during
  840. initialization of Django internals. If you change them with
  841. ``override_settings``, the setting is changed if you access it via the
  842. ``django.conf.settings`` module, however, Django's internals access it
  843. differently. Effectively, using :func:`~django.test.override_settings` or
  844. :func:`~django.test.modify_settings` with these settings is probably not
  845. going to do what you expect it to do.
  846. We do not recommend altering the :setting:`DATABASES` setting. Altering
  847. the :setting:`CACHES` setting is possible, but a bit tricky if you are
  848. using internals that make using of caching, like
  849. :mod:`django.contrib.sessions`. For example, you will have to reinitialize
  850. the session backend in a test that uses cached sessions and overrides
  851. :setting:`CACHES`.
  852. Finally, avoid aliasing your settings as module-level constants as
  853. ``override_settings()`` won't work on such values since they are
  854. only evaluated the first time the module is imported.
  855. You can also simulate the absence of a setting by deleting it after settings
  856. have been overridden, like this::
  857. @override_settings()
  858. def test_something(self):
  859. del settings.LOGIN_URL
  860. ...
  861. .. versionchanged:: 1.7
  862. Previously, you could only simulate the deletion of a setting which was
  863. explicitly overridden.
  864. When overriding settings, make sure to handle the cases in which your app's
  865. code uses a cache or similar feature that retains state even if the setting is
  866. changed. Django provides the :data:`django.test.signals.setting_changed`
  867. signal that lets you register callbacks to clean up and otherwise reset state
  868. when settings are changed.
  869. Django itself uses this signal to reset various data:
  870. ================================ ========================
  871. Overridden settings Data reset
  872. ================================ ========================
  873. USE_TZ, TIME_ZONE Databases timezone
  874. TEMPLATE_CONTEXT_PROCESSORS Context processors cache
  875. TEMPLATE_LOADERS Template loaders cache
  876. SERIALIZATION_MODULES Serializers cache
  877. LOCALE_PATHS, LANGUAGE_CODE Default translation and loaded translations
  878. MEDIA_ROOT, DEFAULT_FILE_STORAGE Default file storage
  879. ================================ ========================
  880. Emptying the test outbox
  881. ~~~~~~~~~~~~~~~~~~~~~~~~
  882. If you use any of Django's custom ``TestCase`` classes, the test runner will
  883. clear the contents of the test email outbox at the start of each test case.
  884. For more detail on email services during tests, see `Email services`_ below.
  885. .. _assertions:
  886. Assertions
  887. ~~~~~~~~~~
  888. As Python's normal :class:`unittest.TestCase` class implements assertion methods
  889. such as :meth:`~unittest.TestCase.assertTrue` and
  890. :meth:`~unittest.TestCase.assertEqual`, Django's custom :class:`TestCase` class
  891. provides a number of custom assertion methods that are useful for testing Web
  892. applications:
  893. The failure messages given by most of these assertion methods can be customized
  894. with the ``msg_prefix`` argument. This string will be prefixed to any failure
  895. message generated by the assertion. This allows you to provide additional
  896. details that may help you to identify the location and cause of an failure in
  897. your test suite.
  898. .. method:: SimpleTestCase.assertRaisesMessage(expected_exception, expected_message, callable_obj=None, *args, **kwargs)
  899. Asserts that execution of callable ``callable_obj`` raised the
  900. ``expected_exception`` exception and that such exception has an
  901. ``expected_message`` representation. Any other outcome is reported as a
  902. failure. Similar to unittest's :meth:`~unittest.TestCase.assertRaisesRegex`
  903. with the difference that ``expected_message`` isn't a regular expression.
  904. .. method:: SimpleTestCase.assertFieldOutput(fieldclass, valid, invalid, field_args=None, field_kwargs=None, empty_value='')
  905. Asserts that a form field behaves correctly with various inputs.
  906. :param fieldclass: the class of the field to be tested.
  907. :param valid: a dictionary mapping valid inputs to their expected cleaned
  908. values.
  909. :param invalid: a dictionary mapping invalid inputs to one or more raised
  910. error messages.
  911. :param field_args: the args passed to instantiate the field.
  912. :param field_kwargs: the kwargs passed to instantiate the field.
  913. :param empty_value: the expected clean output for inputs in ``empty_values``.
  914. For example, the following code tests that an ``EmailField`` accepts
  915. ``a@a.com`` as a valid email address, but rejects ``aaa`` with a reasonable
  916. error message::
  917. self.assertFieldOutput(EmailField, {'a@a.com': 'a@a.com'}, {'aaa': ['Enter a valid email address.']})
  918. .. method:: SimpleTestCase.assertFormError(response, form, field, errors, msg_prefix='')
  919. Asserts that a field on a form raises the provided list of errors when
  920. rendered on the form.
  921. ``form`` is the name the ``Form`` instance was given in the template
  922. context.
  923. ``field`` is the name of the field on the form to check. If ``field``
  924. has a value of ``None``, non-field errors (errors you can access via
  925. :meth:`form.non_field_errors() <django.forms.Form.non_field_errors>`) will
  926. be checked.
  927. ``errors`` is an error string, or a list of error strings, that are
  928. expected as a result of form validation.
  929. .. method:: SimpleTestCase.assertFormsetError(response, formset, form_index, field, errors, msg_prefix='')
  930. Asserts that the ``formset`` raises the provided list of errors when
  931. rendered.
  932. ``formset`` is the name the ``Formset`` instance was given in the template
  933. context.
  934. ``form_index`` is the number of the form within the ``Formset``. If
  935. ``form_index`` has a value of ``None``, non-form errors (errors you can
  936. access via ``formset.non_form_errors()``) will be checked.
  937. ``field`` is the name of the field on the form to check. If ``field``
  938. has a value of ``None``, non-field errors (errors you can access via
  939. :meth:`form.non_field_errors() <django.forms.Form.non_field_errors>`) will
  940. be checked.
  941. ``errors`` is an error string, or a list of error strings, that are
  942. expected as a result of form validation.
  943. .. method:: SimpleTestCase.assertContains(response, text, count=None, status_code=200, msg_prefix='', html=False)
  944. Asserts that a ``Response`` instance produced the given ``status_code`` and
  945. that ``text`` appears in the content of the response. If ``count`` is
  946. provided, ``text`` must occur exactly ``count`` times in the response.
  947. Set ``html`` to ``True`` to handle ``text`` as HTML. The comparison with
  948. the response content will be based on HTML semantics instead of
  949. character-by-character equality. Whitespace is ignored in most cases,
  950. attribute ordering is not significant. See
  951. :meth:`~SimpleTestCase.assertHTMLEqual` for more details.
  952. .. method:: SimpleTestCase.assertNotContains(response, text, status_code=200, msg_prefix='', html=False)
  953. Asserts that a ``Response`` instance produced the given ``status_code`` and
  954. that ``text`` does not appears in the content of the response.
  955. Set ``html`` to ``True`` to handle ``text`` as HTML. The comparison with
  956. the response content will be based on HTML semantics instead of
  957. character-by-character equality. Whitespace is ignored in most cases,
  958. attribute ordering is not significant. See
  959. :meth:`~SimpleTestCase.assertHTMLEqual` for more details.
  960. .. method:: SimpleTestCase.assertTemplateUsed(response, template_name, msg_prefix='', count=None)
  961. Asserts that the template with the given name was used in rendering the
  962. response.
  963. The name is a string such as ``'admin/index.html'``.
  964. .. versionadded:: 1.8
  965. The count argument is an integer indicating the number of times the
  966. template should be rendered. Default is ``None``, meaning that the
  967. template should be rendered one or more times.
  968. You can use this as a context manager, like this::
  969. with self.assertTemplateUsed('index.html'):
  970. render_to_string('index.html')
  971. with self.assertTemplateUsed(template_name='index.html'):
  972. render_to_string('index.html')
  973. .. method:: SimpleTestCase.assertTemplateNotUsed(response, template_name, msg_prefix='')
  974. Asserts that the template with the given name was *not* used in rendering
  975. the response.
  976. You can use this as a context manager in the same way as
  977. :meth:`~SimpleTestCase.assertTemplateUsed`.
  978. .. method:: SimpleTestCase.assertRedirects(response, expected_url, status_code=302, target_status_code=200, host=None, msg_prefix='', fetch_redirect_response=True)
  979. Asserts that the response returned a ``status_code`` redirect status,
  980. redirected to ``expected_url`` (including any ``GET`` data), and that the
  981. final page was received with ``target_status_code``.
  982. If your request used the ``follow`` argument, the ``expected_url`` and
  983. ``target_status_code`` will be the url and status code for the final
  984. point of the redirect chain.
  985. The ``host`` argument sets a default host if ``expected_url`` doesn't
  986. include one (e.g. ``"/bar/"``). If ``expected_url`` is an absolute URL that
  987. includes a host (e.g. ``"http://testhost/bar/"``), the ``host`` parameter
  988. will be ignored. Note that the test client doesn't support fetching external
  989. URLs, but the parameter may be useful if you are testing with a custom HTTP
  990. host (for example, initializing the test client with
  991. ``Client(HTTP_HOST="testhost")``.
  992. .. versionadded:: 1.7
  993. If ``fetch_redirect_response`` is ``False``, the final page won't be
  994. loaded. Since the test client can't fetch externals URLs, this is
  995. particularly useful if ``expected_url`` isn't part of your Django app.
  996. .. versionadded:: 1.7
  997. Scheme is handled correctly when making comparisons between two URLs. If
  998. there isn't any scheme specified in the location where we are redirected to,
  999. the original request's scheme is used. If present, the scheme in
  1000. ``expected_url`` is the one used to make the comparisons to.
  1001. .. method:: SimpleTestCase.assertHTMLEqual(html1, html2, msg=None)
  1002. Asserts that the strings ``html1`` and ``html2`` are equal. The comparison
  1003. is based on HTML semantics. The comparison takes following things into
  1004. account:
  1005. * Whitespace before and after HTML tags is ignored.
  1006. * All types of whitespace are considered equivalent.
  1007. * All open tags are closed implicitly, e.g. when a surrounding tag is
  1008. closed or the HTML document ends.
  1009. * Empty tags are equivalent to their self-closing version.
  1010. * The ordering of attributes of an HTML element is not significant.
  1011. * Attributes without an argument are equal to attributes that equal in
  1012. name and value (see the examples).
  1013. The following examples are valid tests and don't raise any
  1014. ``AssertionError``::
  1015. self.assertHTMLEqual('<p>Hello <b>world!</p>',
  1016. '''<p>
  1017. Hello <b>world! <b/>
  1018. </p>''')
  1019. self.assertHTMLEqual(
  1020. '<input type="checkbox" checked="checked" id="id_accept_terms" />',
  1021. '<input id="id_accept_terms" type='checkbox' checked>')
  1022. ``html1`` and ``html2`` must be valid HTML. An ``AssertionError`` will be
  1023. raised if one of them cannot be parsed.
  1024. Output in case of error can be customized with the ``msg`` argument.
  1025. .. method:: SimpleTestCase.assertHTMLNotEqual(html1, html2, msg=None)
  1026. Asserts that the strings ``html1`` and ``html2`` are *not* equal. The
  1027. comparison is based on HTML semantics. See
  1028. :meth:`~SimpleTestCase.assertHTMLEqual` for details.
  1029. ``html1`` and ``html2`` must be valid HTML. An ``AssertionError`` will be
  1030. raised if one of them cannot be parsed.
  1031. Output in case of error can be customized with the ``msg`` argument.
  1032. .. method:: SimpleTestCase.assertXMLEqual(xml1, xml2, msg=None)
  1033. Asserts that the strings ``xml1`` and ``xml2`` are equal. The
  1034. comparison is based on XML semantics. Similarly to
  1035. :meth:`~SimpleTestCase.assertHTMLEqual`, the comparison is
  1036. made on parsed content, hence only semantic differences are considered, not
  1037. syntax differences. When invalid XML is passed in any parameter, an
  1038. ``AssertionError`` is always raised, even if both string are identical.
  1039. Output in case of error can be customized with the ``msg`` argument.
  1040. .. method:: SimpleTestCase.assertXMLNotEqual(xml1, xml2, msg=None)
  1041. Asserts that the strings ``xml1`` and ``xml2`` are *not* equal. The
  1042. comparison is based on XML semantics. See
  1043. :meth:`~SimpleTestCase.assertXMLEqual` for details.
  1044. Output in case of error can be customized with the ``msg`` argument.
  1045. .. method:: SimpleTestCase.assertInHTML(needle, haystack, count=None, msg_prefix='')
  1046. Asserts that the HTML fragment ``needle`` is contained in the ``haystack`` one.
  1047. If the ``count`` integer argument is specified, then additionally the number
  1048. of ``needle`` occurrences will be strictly verified.
  1049. Whitespace in most cases is ignored, and attribute ordering is not
  1050. significant. The passed-in arguments must be valid HTML.
  1051. .. method:: SimpleTestCase.assertJSONEqual(raw, expected_data, msg=None)
  1052. Asserts that the JSON fragments ``raw`` and ``expected_data`` are equal.
  1053. Usual JSON non-significant whitespace rules apply as the heavyweight is
  1054. delegated to the :mod:`json` library.
  1055. Output in case of error can be customized with the ``msg`` argument.
  1056. .. method:: SimpleTestCase.assertJSONNotEqual(raw, expected_data, msg=None)
  1057. .. versionadded:: 1.8
  1058. Asserts that the JSON fragments ``raw`` and ``expected_data`` are *not* equal.
  1059. See :meth:`~SimpleTestCase.assertJSONEqual` for further details.
  1060. Output in case of error can be customized with the ``msg`` argument.
  1061. .. method:: TransactionTestCase.assertQuerysetEqual(qs, values, transform=repr, ordered=True, msg=None)
  1062. Asserts that a queryset ``qs`` returns a particular list of values ``values``.
  1063. The comparison of the contents of ``qs`` and ``values`` is performed using
  1064. the function ``transform``; by default, this means that the ``repr()`` of
  1065. each value is compared. Any other callable can be used if ``repr()`` doesn't
  1066. provide a unique or helpful comparison.
  1067. By default, the comparison is also ordering dependent. If ``qs`` doesn't
  1068. provide an implicit ordering, you can set the ``ordered`` parameter to
  1069. ``False``, which turns the comparison into a Python set comparison.
  1070. If the order is undefined (if the given ``qs`` isn't ordered and the
  1071. comparison is against more than one ordered values), a ``ValueError`` is
  1072. raised.
  1073. Output in case of error can be customized with the ``msg`` argument.
  1074. .. versionchanged:: 1.7
  1075. The method now accepts a ``msg`` parameter to allow customization of
  1076. error message
  1077. .. method:: TransactionTestCase.assertNumQueries(num, func, *args, **kwargs)
  1078. Asserts that when ``func`` is called with ``*args`` and ``**kwargs`` that
  1079. ``num`` database queries are executed.
  1080. If a ``"using"`` key is present in ``kwargs`` it is used as the database
  1081. alias for which to check the number of queries. If you wish to call a
  1082. function with a ``using`` parameter you can do it by wrapping the call with
  1083. a ``lambda`` to add an extra parameter::
  1084. self.assertNumQueries(7, lambda: my_function(using=7))
  1085. You can also use this as a context manager::
  1086. with self.assertNumQueries(2):
  1087. Person.objects.create(name="Aaron")
  1088. Person.objects.create(name="Daniel")
  1089. .. _topics-testing-email:
  1090. Email services
  1091. --------------
  1092. If any of your Django views send email using :doc:`Django's email
  1093. functionality </topics/email>`, you probably don't want to send email each time
  1094. you run a test using that view. For this reason, Django's test runner
  1095. automatically redirects all Django-sent email to a dummy outbox. This lets you
  1096. test every aspect of sending email -- from the number of messages sent to the
  1097. contents of each message -- without actually sending the messages.
  1098. The test runner accomplishes this by transparently replacing the normal
  1099. email backend with a testing backend.
  1100. (Don't worry -- this has no effect on any other email senders outside of
  1101. Django, such as your machine's mail server, if you're running one.)
  1102. .. currentmodule:: django.core.mail
  1103. .. data:: django.core.mail.outbox
  1104. During test running, each outgoing email is saved in
  1105. ``django.core.mail.outbox``. This is a simple list of all
  1106. :class:`~django.core.mail.EmailMessage` instances that have been sent.
  1107. The ``outbox`` attribute is a special attribute that is created *only* when
  1108. the ``locmem`` email backend is used. It doesn't normally exist as part of the
  1109. :mod:`django.core.mail` module and you can't import it directly. The code
  1110. below shows how to access this attribute correctly.
  1111. Here's an example test that examines ``django.core.mail.outbox`` for length
  1112. and contents::
  1113. from django.core import mail
  1114. from django.test import TestCase
  1115. class EmailTest(TestCase):
  1116. def test_send_email(self):
  1117. # Send message.
  1118. mail.send_mail('Subject here', 'Here is the message.',
  1119. 'from@example.com', ['to@example.com'],
  1120. fail_silently=False)
  1121. # Test that one message has been sent.
  1122. self.assertEqual(len(mail.outbox), 1)
  1123. # Verify that the subject of the first message is correct.
  1124. self.assertEqual(mail.outbox[0].subject, 'Subject here')
  1125. As noted :ref:`previously <emptying-test-outbox>`, the test outbox is emptied
  1126. at the start of every test in a Django ``*TestCase``. To empty the outbox
  1127. manually, assign the empty list to ``mail.outbox``::
  1128. from django.core import mail
  1129. # Empty the test outbox
  1130. mail.outbox = []
  1131. .. _skipping-tests:
  1132. Skipping tests
  1133. --------------
  1134. .. currentmodule:: django.test
  1135. The unittest library provides the :func:`@skipIf <unittest.skipIf>` and
  1136. :func:`@skipUnless <unittest.skipUnless>` decorators to allow you to skip tests
  1137. if you know ahead of time that those tests are going to fail under certain
  1138. conditions.
  1139. For example, if your test requires a particular optional library in order to
  1140. succeed, you could decorate the test case with :func:`@skipIf
  1141. <unittest.skipIf>`. Then, the test runner will report that the test wasn't
  1142. executed and why, instead of failing the test or omitting the test altogether.
  1143. To supplement these test skipping behaviors, Django provides two
  1144. additional skip decorators. Instead of testing a generic boolean,
  1145. these decorators check the capabilities of the database, and skip the
  1146. test if the database doesn't support a specific named feature.
  1147. The decorators use a string identifier to describe database features.
  1148. This string corresponds to attributes of the database connection
  1149. features class. See ``django.db.backends.BaseDatabaseFeatures``
  1150. class for a full list of database features that can be used as a basis
  1151. for skipping tests.
  1152. .. function:: skipIfDBFeature(feature_name_string)
  1153. Skip the decorated test or ``TestCase`` if the named database feature is
  1154. supported.
  1155. For example, the following test will not be executed if the database
  1156. supports transactions (e.g., it would *not* run under PostgreSQL, but
  1157. it would under MySQL with MyISAM tables)::
  1158. class MyTests(TestCase):
  1159. @skipIfDBFeature('supports_transactions')
  1160. def test_transaction_behavior(self):
  1161. # ... conditional test code
  1162. .. versionchanged:: 1.7
  1163. ``skipIfDBFeature`` can now be used to decorate a ``TestCase`` class.
  1164. .. function:: skipUnlessDBFeature(feature_name_string)
  1165. Skip the decorated test or ``TestCase`` if the named database feature is *not*
  1166. supported.
  1167. For example, the following test will only be executed if the database
  1168. supports transactions (e.g., it would run under PostgreSQL, but *not*
  1169. under MySQL with MyISAM tables)::
  1170. class MyTests(TestCase):
  1171. @skipUnlessDBFeature('supports_transactions')
  1172. def test_transaction_behavior(self):
  1173. # ... conditional test code
  1174. .. versionchanged:: 1.7
  1175. ``skipUnlessDBFeature`` can now be used to decorate a ``TestCase`` class.