Python でのテスト: Django の assertContains() を使って Web アプリケーションをデバッグ

test.SimpleTestCase.assertContains() は、Django のテストスイートモジュール django.test に提供されているアサーションメソッドの一つです。これは、テンプレートレンダリングされたレスポンスや生成されたHTMLコンテンツ内に特定の文字列が含まれているかどうかを確認するために使用されます。

このメソッドは、Webアプリケーションのテストにおいて、ビュー関数やテンプレートが期待通りの出力を生成していることを検証する際に役立ちます。

メソッドの構文

assertContains(response, text, status_code=None, msg_prefix='')

引数

msg_prefix: テスト失敗時のエラーメッセージの先頭に付加されるプレフィックス (オプション)
status_code: レスポンスのステータスコード (オプション)
text: レスポンス内に含まれていることを確認する文字列
response: テスト対象のレスポンスオブジェクト

動作

assertContains() は、まず response オブジェクトを文字列に変換します。
その後、変換された文字列内に text が含まれているかどうかを調べます。
status_code が指定されている場合は、レスポンスのステータスコードが一致するかどうか also 確認します。
上記のすべての条件が満たされない場合は、テストが失敗し、msg_prefix 付きのエラーメッセージが出力されます。

例

from django.test import TestCase

class MyTests(TestCase):
    def test_my_view(self):
        response = self.client.get('/my_view/')
        self.assertContains(response, 'Hello, world!')
        self.assertEqual(response.status_code, 200)

上記の例では、/my_view/ エンドポイントに GET リクエストを送信し、レスポンスが "Hello, world!" という文字列を含み、ステータスコードが 200 であることを確認しています。

assertContains() は、テンプレートレンダリングされたレスポンスだけでなく、生成されたHTMLコンテンツにも使用できます。
assertContains() は、HTML タグや改行を含む長い文字列に対しても使用できます。
assertContains() は、大小文字を区別して照合を行います。大文字と小文字を区別しない照合が必要な場合は、re.IGNORECASE フラグを text に渡すことができます。

例1：テンプレートレンダリングされたレスポンス内に特定の文字列が含まれていることを確認する

from django.test import TestCase

class MyTests(TestCase):
    def test_my_view(self):
        response = self.client.get('/my_view/')
        self.assertContains(response, 'Hello, world!')

この例では、/my_view/ エンドポイントに GET リクエストを送信し、レスポンスが "Hello, world!" という文字列を含んでいることを確認しています。

例2：HTML タグを含む長い文字列が含まれていることを確認する

from django.test import TestCase

class MyTests(TestCase):
    def test_my_view(self):
        response = self.client.get('/my_view/')
        self.assertContains(response, '<p>This is a longer text with HTML tags.</p>')

この例では、/my_view/ エンドポイントに GET リクエストを送信し、レスポンスが <p>This is a longer text with HTML tags.</p> という文字列を含んでいることを確認しています。

例3：大文字と小文字を区別せずに照合する

from django.test import TestCase
import re

class MyTests(TestCase):
    def test_my_view(self):
        response = self.client.get('/my_view/')
        self.assertContains(response, 'HELLO, WORLD!', re.IGNORECASE)

この例では、/my_view/ エンドポイントに GET リクエストを送信し、レスポンスが "HELLO, WORLD!" という文字列 (大小文字を問わず) を含んでいることを確認しています。

例4：ステータスコードも確認する

from django.test import TestCase

class MyTests(TestCase):
    def test_my_view(self):
        response = self.client.get('/my_view/')
        self.assertContains(response, 'Hello, world!', status_code=200)

例5：エラーメッセージの先頭にプレフィックスを付加する

from django.test import TestCase

class MyTests(TestCase):
    def test_my_view(self):
        response = self.client.get('/my_view/')
        self.assertContains(response, 'This text is not found.', msg_prefix='My custom error message: ')

この例では、/my_view/ エンドポイントに GET リクエストを送信し、レスポンスが "This text is not found." という文字列を含んでいないことを確認しています。テストが失敗した場合、エラーメッセージの先頭に "My custom error message: " が付加されます。

assertIn を使用する

assertIn は、ある要素がリストや文字列に含まれているかどうかを確認するために使用できる標準ライブラリの関数です。assertContains() の代わりに assertIn を使用することで、より簡潔で読みやすいコードを作成することができます。

from django.test import TestCase

class MyTests(TestCase):
    def test_my_view(self):
        response = self.client.get('/my_view/')
        self.assertIn('Hello, world!', response.content)

上記の例では、assertContains() の代わりに assertIn を使用して、レスポンスのコンテンツ内に "Hello, world!" という文字列が含まれていることを確認しています。

正規表現を使用する

正規表現は、より複雑なパターンマッチングを行うために使用できます。assertContains() は単純な文字列マッチングしか行えないため、正規表現を使用することで、より柔軟なテストを行うことができます。

from django.test import TestCase
import re

class MyTests(TestCase):
    def test_my_view(self):
        response = self.client.get('/my_view/')
        self.assertTrue(re.search(r'<p>This is a longer text with HTML tags.</p>', response.content))

上記の例では、正規表現を使用して、レスポンスのコンテンツ内に <p>This is a longer text with HTML tags.</p> というパターンが含まれていることを確認しています。

カスタムアサーションを作成する

独自のニーズに合わせたカスタムアサーションを作成することもできます。これは、複雑な検証ロジックが必要な場合に役立ちます。

from django.test import TestCase

class MyTests(TestCase):
    def assert_my_custom_assertion(self, response, text):
        # 独自の検証ロジックを実装する
        pass

    def test_my_view(self):
        response = self.client.get('/my_view/')
        self.assert_my_custom_assertion(response, 'Hello, world!')

上記の例では、assert_my_custom_assertion というカスタムアサーション関数を作成し、独自の検証ロジックを実装しています。このカスタムアサーションを使用して、test_my_view 関数内でレスポンスを検証しています。

どの方法を使用すべきか

使用する方法は、テストのニーズによって異なります。

独自の検証ロジックが必要な場合は、カスタムアサーションを作成する必要があります。
より複雑なパターンマッチングが必要な場合は、正規表現を使用する必要があります。
シンプルな文字列マッチングの場合は、assertIn が最も簡潔で読みやすい方法です。

test.SimpleTestCase.assertContains() は、Django テンプレートレンダリングされたレスポンスや生成された HTML コンテンツ内に特定の文字列が含まれていることを検証する際に役立つ便利なアサーションメソッドです。