17

In the unittest style, I can test that a page uses a particular template by calling assertTemplateUsed. This is useful, for example, when Django inserts values through a template, so that I can't just test string equality.

How should I write the equivalent statement in pytest?

I've been looking in pytest-django but don't see how to do it.

Stan Reduta
  • 3,292
  • 5
  • 31
  • 55
Hatshepsut
  • 5,962
  • 8
  • 44
  • 80
  • I dont understand your question you want to test that the data that you pass to a template is correctly rendered? – Agustin Aug 28 '17 at 20:46
  • @Augustin No, I want to test that when I get a page, it's using the template file I expect it to use. – Hatshepsut Aug 28 '17 at 21:10
  • If you get the "Page" then you are getting the template, if not, what do you mean by getting a "page"? Could you provide some sort of code so I can help you out? – Agustin Aug 29 '17 at 12:36
  • 5
    The code for [assertTemplateUsed](https://docs.djangoproject.com/en/1.11/_modules/django/test/testcases/#SimpleTestCase.assertTemplateUsed) and `_assert_template_used` show there is an attribute `.templates` in `reponse`. So you need something like `assert response.templates and ('mytemplate' in [t.name for t in response.templates if t.name is not None])`. – phd Aug 29 '17 at 18:00

3 Answers3

18

As phd stated in a comment, use the following to assert that a template file is actually used in a view:

response = client.get(article.get_absolute_url())
assert 'article_detail.html' in (t.name for t in response.templates)

Update: Since v3.8.0 (2020-01-14) pytest-django makes all of the assertions in Django's TestCase available in pytest_django.asserts. See Stan Redoute's answer for an example.

jnns
  • 5,148
  • 4
  • 47
  • 74
  • This a workaround rather than actual solution to the problem. – Stan Reduta Jan 08 '21 at 14:19
  • Why do you say that? It's what Django does in `assertTemplateUsed()`. Wrap it in a function and that's it. What more do you want for it to not be a "workaround"? – jnns Jan 10 '21 at 08:59
  • 1
    Maybe “workaround” was an overstatement, however there’s a dedicated assertion provided by `pytest_django`. – Stan Reduta Jan 11 '21 at 07:21
17

To assert whether given template was used to render specific view you can (and even should) use helpers provided by pytest-django:

import pytest
from pytest_django.asserts import assertTemplateUsed

...

def test_should_use_correct_template_to_render_a_view(client):
    response = client.get('.../your-url/')
    assertTemplateUsed(response, 'template_name.html')

pytest-django even uses this exact assertion as an example in documentation.

Stan Reduta
  • 3,292
  • 5
  • 31
  • 55
0

If I understand clearly, you want to test if Django renders the data that you pass to the template correctly. If this is the case, then the concepts are wrong, you should test the data gathered in your view first, and then make sure it calls the template. Testing that the template contains the correct data would be testing Django framework itself.

Agustin
  • 95
  • 2
  • 10