Django テストで assertContains() 以外に使える 5 つの方法

Djangoのdjango.testにおけるtest.SimpleTestCase.assertContains()の詳細解説

django.test.SimpleTestCase.assertContains()は、Djangoのテストスイートで提供されるアサーションメソッドです。これは、テンプレートレンダリングされたレスポンスやその他のテキストデータ内に、指定された文字列が含まれていることを検証するために使用されます。

使用方法

assertContains()は以下の引数を受け取ります。

• response: テスト対象となるレスポンスオブジェクト
• text: 検証対象となる文字列
• count: オプション引数。デフォルトはNone。textがレスポンス内に何回含まれているかを指定します。
• status_code: オプション引数。デフォルトは200。レスポンスのステータスコードを指定します。
• msg_prefix: オプション引数。デフォルトは空文字列。テスト失敗時のメッセージに追加されるプレフィックスを指定します。
• html: オプション引数。デフォルトはFalse。レスポンスがHTML形式である場合はTrueに設定します。

例

from django.test import SimpleTestCase

class MyTestCase(SimpleTestCase):
    def test_my_view(self):
        response = self.client.get('/')
        self.assertContains(response, 'Hello, world!')
        self.assertContains(response, 'This is my website.', count=2)
        self.assertContains(response, '<h1>Welcome</h1>', html=True)

この例では、assertContains()を使用して、以下の検証を行っています。

• レスポンス内に "Hello, world!" という文字列が含まれていること
• レスポンス内に "This is my website." という文字列が2回含まれていること
• レスポンス内に "<h1>Welcome</h1>" というHTMLタグが含まれていること

詳細

assertContains()は、以下の点に注意する必要があります。

• テキスト比較は、大文字と小文字を区別します。
• テキスト比較は、デフォルトで空白文字を無視します。html=Trueに設定すると、空白文字も比較されます。
• レスポンスが複数行の場合、assertContains()は各行を個別に検査します。
• assertContains()は、レスポンス全体を検査するのではなく、レスポンスのコンテンツ部分のみを検査します。

補足

• assertContains()は、assertNotIn()メソッドと組み合わせて、特定の文字列が含まれていないことを検証することもできます。
• assertContains()は、assertRegex()メソッドと組み合わせて、正規表現を使用してテキストを検証することもできます。

assertContains() のサンプルコード

テンプレートレンダリングされたレスポンス内の文字列検証

from django.test import SimpleTestCase

class MyTestCase(SimpleTestCase):
    def test_my_view(self):
        response = self.client.get('/')
        self.assertContains(response, '<h1>Welcome</h1>')
        self.assertContains(response, 'This is my website.')
        self.assertContains(response, 'Learn more about Django', count=2)

• <h1>Welcome</h1> というHTMLタグ
• This is my website. という文字列
• Learn more about Django という文字列が2回

レスポンスステータスコードの検証

from django.test import SimpleTestCase

class MyTestCase(SimpleTestCase):
    def test_my_view(self):
        response = self.client.get('/forbidden/')
        self.assertContains(response, 'Forbidden', status_code=403)

この例では、/forbidden/ エンドポイントへのアクセスが403 Forbiddenエラーとなることを検証しています。

テキスト比較オプションの検証

from django.test import SimpleTestCase

class MyTestCase(SimpleTestCase):
    def test_my_view(self):
        response = self.client.get('/')
        self.assertContains(response, 'This is my website.')
        self.assertContains(response, 'This is my website.', ignore_whitespace=True)

この例では、ignore_whitespaceオプションを指定することで、空白文字を無視してテキスト比較を行うことを示しています。

HTML形式のテキスト検証

from django.test import SimpleTestCase

class MyTestCase(SimpleTestCase):
    def test_my_view(self):
        response = self.client.get('/')
        self.assertContains(response, '<h1>Welcome</h1>', html=True)

この例では、htmlオプションを指定することで、レスポンスがHTML形式であることを考慮してテキスト比較を行うことを示しています。

テキスト存在否定の検証

from django.test import SimpleTestCase

class MyTestCase(SimpleTestCase):
    def test_my_view(self):
        response = self.client.get('/')
        self.assertNotIn(response, 'This is not my website.')

この例では、assertNotIn()を使用して、レスポンス内にThis is not my website.という文字列が含まれていないことを検証しています。

正規表現によるテキスト検証

from django.test import SimpleTestCase

class MyTestCase(SimpleTestCase):
    def test_my_view(self):
        response = self.client.get('/')
        self.assertRegex(response, r'This is my website\s+\(v\d+\.\d+\.\d+\)')

この例では、assertRegex()を使用して、正規表現を使用してレスポンス内のテキストを検証しています。

これらのサンプルコードは、assertContains()メソッドのさまざまな使用方法を示しています。これらの例を参考にして、テストコードを作成してください。

assertContains() 以外の方法

テンプレート変数への直接アクセス

from django.test import SimpleTestCase

class MyTestCase(SimpleTestCase):
    def test_my_view(self):
        response = self.client.get('/')
        self.assertEqual(response.context['title'], 'Welcome')
        self.assertEqual(response.context['message'], 'This is my website.')

この例では、テンプレート変数titleとmessageに直接アクセスして、期待する値と一致することを検証しています。

BeautifulSoup などのライブラリを使用する

from django.test import SimpleTestCase
from bs4 import BeautifulSoup

class MyTestCase(SimpleTestCase):
    def test_my_view(self):
        response = self.client.get('/')
        soup = BeautifulSoup(response.content, 'html.parser')
        self.assertEqual(soup.title.text, 'Welcome')
        self.assertEqual(soup.find('p').text, 'This is my website.')

この例では、BeautifulSoup ライブラリを使用して、レスポンスのHTMLを解析し、期待するテキストが含まれていることを検証しています。

Selenium などのライブラリを使用する

from django.test import LiveServerTestCase
from selenium import webdriver

class MyTestCase(LiveServerTestCase):
    def test_my_view(self):
        browser = webdriver.Firefox()
        browser.get(self.live_server_url + '/')
        self.assertEqual(browser.find_element_by_tag_name('h1').text, 'Welcome')
        self.assertEqual(browser.find_element_by_css_selector('p').text, 'This is my website.')

この例では、Selenium ライブラリを使用して、ブラウザで実際にページをレンダリングし、期待するテキストが表示されていることを検証しています。

どの方法を選択するべきかは、テスト対象のコードと検証したい内容によって異なります。

• テンプレート変数に直接アクセスできる場合は、それが最も簡単な方法です。
• テンプレート内で複雑な処理が行われている場合は、BeautifulSoup などのライブラリを使用して、HTMLを解析する方が効率的です。
• JavaScript などの動的な要素を検証したい場合は、Selenium などのライブラリを使用する必要があります。

それぞれの方法の長所と短所を理解し、状況に応じて適切な方法を選択してください。