【Djangoテスト】`test.Response.context`属性のしくみを徹底解説！テンプレートコンテキストの確認と操作方法をマスターしよう

test.Response.context は、Django のテストフレームワーク django.test における重要な属性であり、テスト対象のビュー関数がテンプレートに渡すコンテキストデータを取得するために使用されます。このコンテキストデータは、テンプレートエンジンによってレンダリングされる HTML コンテンツを動的に生成するために使用されます。

属性の役割

test.Response.context 属性は、ビュー関数によってテンプレートに渡されるコンテキストデータを表す辞書オブジェクトです。この辞書には、キーと値のペアが含まれており、キーはテンプレート内で変数として使用される名前、値はテンプレート内で使用される実際のデータに対応します。

使用方法

test.Response.context 属性は、テストコード内で以下の方法で使用できます。

ビュー関数がテンプレートに渡すコンテキストデータを確認する
```
def test_my_view(self):
    response = self.client.get('/my/view/')
    self.assertEqual(response.context['my_data'], 'Hello, world!')
```
上記の例では、test_my_view テスト関数は /my/view/ パスに対して GET リクエストを送信し、レスポンスオブジェクトを取得します。その後、response.context 属性を使用してテンプレートに渡されたコンテキストデータにアクセスし、my_data キーに対応する値が Hello, world! であることを確認します。
ビュー関数がテンプレートに渡すコンテキストデータを変更する
```
def test_my_view(self):
    response = self.client.get('/my/view/')
    response.context['my_data'] = 'Modified data'
    self.assertEqual(response.rendered_content, 'This is a template with modified data.')
```
上記の例では、test_my_view テスト関数は /my/view/ パスに対して GET リクエストを送信し、レスポンスオブジェクトを取得します。その後、response.context 属性を使用してテンプレートに渡されたコンテキストデータにアクセスし、my_data キーに対応する値を Modified data に変更します。最後に、response.rendered_content 属性を使用してレンダリングされた HTML コンテンツを取得し、それが This is a template with modified data. であることを確認します。

テストフレームワーク django.test には、test.Template クラスを使用してテンプレートを直接レンダリングするための機能も提供されています。この機能を使用すると、test.Response.context 属性にアクセスすることなく、テンプレートがレンダリングされた結果を確認することができます。
test.Response.context 属性は、ビュー関数によってテンプレートに渡されるコンテキストデータのみを反映します。テンプレート内で直接定義された変数は、この属性には含まれません。
test.Response.context 属性は、ビュー関数が実際にテンプレートをレンダリングする前にアクセスする必要があります。テストコード内でテンプレートがレンダリングされた後にこの属性にアクセスすると、空の辞書が返される場合があります。

ビュー関数がテンプレートに渡すコンテキストデータを確認する

# views.py
def my_view(request):
    context = {
        'my_data': 'Hello, world!',
    }
    return render(request, 'my_template.html', context)

# tests.py
def test_my_view(self):
    response = self.client.get('/my/view/')
    self.assertEqual(response.context['my_data'], 'Hello, world!')

# views.py
def my_view(request):
    context = {
        'my_data': 'Original data',
    }
    return render(request, 'my_template.html', context)

# tests.py
def test_my_view(self):
    response = self.client.get('/my/view/')
    response.context['my_data'] = 'Modified data'
    self.assertEqual(response.rendered_content, 'This is a template with modified data.')

上記のコードでは、my_view ビュー関数は my_template.html テンプレートに my_data というキーで Original data という値を含むコンテキストデータを渡します。

# views.py
def my_view(request):
    context = {
        'my_data': 'Hello, world!',
    }
    return render(request, 'my_template.html', context)

# tests.py
def test_my_view(self):
    response = self.client.get('/my/view/')
    self.assertTemplateUsed(response, 'my_template.html')
    self.assertContains(response, 'Hello, world!')

上記のコードでは、my_view ビュー関数は my_template.html テンプレートに my_data というキーで Hello, world! という値を含むコンテキストデータを渡します。

response.template 属性を使用する

response.template 属性は、ビュー関数によってレンダリングされたテンプレートオブジェクトを表します。このオブジェクトには、テンプレート内で使用される変数と値を含むコンテキストデータにアクセスするためのメソッドが用意されています。

# tests.py
def test_my_view(self):
    response = self.client.get('/my/view/')
    template_context = response.template.context
    self.assertEqual(template_context['my_data'], 'Hello, world!')

上記の例では、test_my_view テスト関数は response.template 属性を使用してテンプレートオブジェクトを取得し、そのオブジェクトの context 属性を使用してコンテキストデータにアクセスします。

response.rendered_content 属性を使用する

response.rendered_content 属性は、ビュー関数によってレンダリングされた HTML コンテンツを表す文字列オブジェクトです。この文字列オブジェクトは、テンプレート内で使用される変数と値が実際にどのようにレンダリングされたかを確認するために使用できます。

# tests.py
def test_my_view(self):
    response = self.client.get('/my/view/')
    rendered_content = response.rendered_content
    self.assertContains(rendered_content, 'This is a template with Hello, world!')

上記の例では、test_my_view テスト関数は response.rendered_content 属性を使用してレンダリングされた HTML コンテンツを取得し、assertContains アサーションを使用して、そのコンテンツに This is a template with Hello, world! という文字列が含まれていることを確認します。

TestCase.assertTemplateUsed メソッドを使用する

TestCase.assertTemplateUsed メソッドは、指定されたテンプレートがレンダリングされたかどうかを確認するために使用できます。このメソッドは、テンプレート名とオプションのコンテキストデータを渡すことができます。

# tests.py
def test_my_view(self):
    response = self.client.get('/my/view/')
    self.assertTemplateUsed(response, 'my_template.html', context={'my_data': 'Hello, world!'})

上記の例では、test_my_view テスト関数は assertTemplateUsed メソッドを使用して、my_template.html テンプレートがレンダリングされたことと、そのテンプレートに my_data というキーで Hello, world! という値を含むコンテキストデータが渡されたことを確認します。

TestCase.assertContains メソッドを使用する

TestCase.assertContains メソッドは、レンダリングされた HTML コンテンツに特定の文字列が含まれているかどうかを確認するために使用できます。このメソッドは、文字列とオプションの検索方法を渡すことができます。

# tests.py
def test_my_view(self):
    response = self.client.get('/my/view/')
    self.assertContains(response, 'This is a template with Hello, world!', status_code=200)

上記の例では、test_my_view テスト関数は assertContains メソッドを使用して、レンダリングされた HTML コンテンツに This is a template with Hello, world! という文字列が含まれていることと、レスポンスのステータスコードが 200 であることを確認します。

上記の方法は、それぞれ異なる目的で使用されます。

TestCase.assertContains メソッドは、レンダリングされた HTML コンテンツに特定の文字列が含まれているかどうかを確認するために使用されます。
TestCase.assertTemplateUsed メソッドは、指定されたテンプレートがレンダリングされたかどうかを確認するために使用されます。
response.rendered_content 属性は、レンダリングされた HTML コンテンツを直接操作するために使用されます。
response.template 属性は、テンプレートオブジェクト自体にアクセスするために使用されます。
test.Response.context 属性は、ビュー関数がテンプレートに渡すコンテキストデータの詳細を確認するために使用されます。