\nテストクライアントは、ダミーのウェブブラウザとして振る舞う Python のクラスです。これを使えば、ビューと Django で作ったアプリケーションとの関係をプログラムから自動でテストできるようになります。
\nテストクライアントでは、次のようなことができます。
\n\nある URL に対する GET および POST リクエストのシミュレートと、その結果の観察。低レベルの HTTP (レスポンスのヘッダーやステータスコードなど) から、ページのコンテンツまで、あらゆるレスポンスの内容を調査できます。
一連の (好きな数の) リダイレクトを見て、その各ステップごとに URL とステータスコードをチェックする。
指定したリクエストが特定の Django テンプレートによってレンダリングされたとき、テンプレートのコンテキストが正しく特定の値を含んでいるかどうかをテストする。
\nテストクライアントは Selenium や他の "ブラウザ内 (in-browser)" フレームワークの代替を目指すものではないことに注意してください。Django のテストクライアントの目的は別の点にあります。つまり、
\n\nDjango のテストクライアントは、正しいテンプレートがレンダリングされ、そのテンプレートが正しいコンテキストデータをちゃんと渡しているのかをチェックするために使います。
ビューの機能を直接テストするには、RequestFactory
Selenium などのブラウザー内フレームワークは、HTML の レンダリング や、ウェブページの 振る舞い 、つまり JavaScript の機能性をテストするために使います。また、Django はこれらのフレームワーク向けの特別なサポートも提供しています。詳細については、LiveServerTestCase
\n包括的なテストスイートを実現するには、これらすべてのタイプのテストを組み合わせて行うべきです。
\n\n\nテストクライアントを使うには、django.test.Client
\nPython console Copy
>>> from django.test import Client \n>>> c = Client () \n>>> response = c . post ( "/login/" , { "username" : "john" , "password" : "smith" }) \n>>> response . status_code \n200 \n>>> response = c . get ( "/customer/details/" ) \n>>> response . content \nb'<!DOCTYPE html...' \nこの例が示唆しているように、 Client
\nテストクライアントの動作の仕方に関して、いくつか大切な注意点があります。
\n\nテストクライアントが動作するために、ウェブサーバーが動作している必要は ありません 。実際、ウェブサーバーを一切起動せずに動作するのです！ HTTP のオーバーヘッドを避けて、Django フレームワークと直接やりとりすることでこれを実現しています。これにより、高速なユニットテストが可能になっています。
ページの取得時には、ドメイン全体ではなく、URL の path だけを指定することを覚えておいてください。たとえば、次は正しいです。
\nPython console Copy
>>> c . get ( "/login/" ) \nしかし、これは間違いです。
\nPython console Copy
>>> c . get ( "https://www.example.com/login/" ) \nテストクライアントには、自分の Django プロジェクト以外のウェブページを取得する機能はありません。他のウェブページが必要な場合には、 urllib
\nURL を解決するとき、テストクライアントは ROOT_URLCONF
上の例では Python のインタラクティブなインタプリタ上でも動作するはずですが、テストクライアントの一部の機能、特にテンプレート関係の機能は、 テストの実行中 にしか使えないことがあります。
\nというのも、Django のテストランナーは、与えられたビューによって読み込まれるテンプレートを決定する時に、ちょっとした黒魔術を使っています。この黒魔術 (具体的には Django のテンプレートシステムに対してメモリ上でパッチを当てています) は、テストの実行中にだけ使われるのです。
\nデフォルトでは、テストクライアントはサイト上でのすべての CSRF チェックを無効にしています。
\n何らかの理由でテストクライアントに CSRF チェックを実行して ほしい ときには、CSRF チェックの実行を強制するテストクライアントのインスタンスを作ることができます。これには、クライアントを作る時に次のように enforce_csrf_checks
\nPython console Copy
>>> from django.test import Client \n>>> csrf_client = Client ( enforce_csrf_checks = True ) \n \n \n\n\nリクエストの作成には、django.test.Client
\n\n\nclass Client ( enforce_csrf_checks = False raise_request_exception = True json_encoder = DjangoJSONEncoder * headers = None query_params = None ** defaults ) Link to this definition # \nテスト用の HTTP クライアントです。いくつかの引数で動作をカスタマイズできます。
\nheaders User-Agent
\nCode Copy
client = Client ( headers = { "user-agent" : "curl/7.79.1" }) \nquery_params
\nDefaults 環境変数
\nCode Copy
client = Client ( SCRIPT_NAME = "/app/" ) \nThe values from the headers query_params extra get() post()
\nenforce_csrf_checks
\nraise_request_exception True
\njson_encoder post()
\nClient
\n\n\nget ( path data = None follow = False secure = False * headers = None query_params = None ** extra ) Link to this definition # \n与えられた path Response Response
\nquery_params
\nPython console Copy
>>> c = Client () \n>>> c . get ( "/customers/details/" , query_params = { "name" : "fred" , "age" : 7 }) \n引数の評価の結果、次の GET リクエストの実行と等価になります。
\nText Copy
/customers/details/?name=fred&age=7\nこれらのパラメータを data query_params query_params
\nheaders
\nPython console Copy
>>> c = Client () \n>>> c . get ( \n... "/customers/details/" , \n... query_params = { "name" : "fred" , "age" : 7 }, \n... headers = { "accept" : "application/json" }, \n... ) \n...will send the HTTP header HTTP_ACCEPT django.http.HttpRequest.accepts()
\n任意のキーワード引数には、WSGI 環境変数
\nPython console Copy
>>> c = Client () \n>>> c . get ( "/" , SCRIPT_NAME = "/app/" ) \nGET の引数がすでに URL エンコードされた形式である場合は、data 引数の代わりにエンコード済みの文字列を使うことができます。たとえば、先ほどの GET リクエストは次のようにも書けます。
\nPython console Copy
>>> c = Client () \n>>> c . get ( "/customers/details/?name=fred&age=7" ) \nエンコード済みのGETデータを含むURLと query_params data
\nfollow True redirect_chain
\nたとえば、URL /redirect_me/ /next/ /final/ redirect_chain
\nPython console Copy
>>> response = c . get ( "/redirect_me/" , follow = True ) \n>>> response . redirect_chain \n[('http://testserver/next/', 302), ('http://testserver/final/', 302)] \nsecure True
\n \n\n\n\npost ( path data = None content_type = MULTIPART_CONTENT follow = False secure = False * headers = None query_params = None ** extra ) Link to this definition # \n与えられた path Response Response
\ndata
\nPython console Copy
>>> c = Client () \n>>> c . post ( "/login/" , { "name" : "fred" , "passwd" : "secret" }) \n引数の評価の結果、次の URL へ POST リクエストが行われます。
\n\nリクエストで送られる POST データは次のものになります。
\nText Copy
name=fred&passwd=secret\ncontent_type application/json を指定すると、 data json.dumps() DjangoJSONEncoder Client json_encoder put() patch() delete()
\nもし他の content_type text/xml ) を与えると、data Content-Type content_type
\ncontent_type data multipart/form-data のコンテンツタイプとして送信します。この場合は、 data
\nたとえば <select multiple> data choice
\nCode Copy
{ "choices" : [ "a" , "b" , "d" ]} \nファイルの送信は特別なケースです。ファイルをPOSTするには、キーとしてファイルフィールド名を、値としてアップロードしたいファイルへのファイルハンドルを渡すだけで十分です。例えば、フォームに name attachment FileField
\nPython console Copy
>>> c = Client () \n>>> with open ( "wishlist.doc" , "rb" ) as fp : \n... c . post ( "/customers/wishes/" , { "name" : "fred" , "attachment" : fp }) \n... \nまた、ファイルのようなオブジェクト (例えば StringIO BytesIO ImageField validate_image_file_extension name
\nPython console Copy
>>> from io import BytesIO \n>>> img = BytesIO ( \n... b "GIF89a \\x01\\x00\\x01\\x00\\x00\\x00\\x00 ! \\xf9\\x04\\x01\\x00\\x00\\x00 " \n... b " \\x00 , \\x00\\x00\\x00\\x00\\x01\\x00\\x01\\x00\\x00\\x02\\x01\\x00\\x00 " \n... ) \n>>> img . name = "myimage.gif" \n複数の post() post()
\nデータが読み込めるように、正しい方法でファイルを開くようにする必要があります。これはつまり、画像ファイルなどのバイナリデータが含まれている場合には、rb
\nheaders query_params extra Client.get()
\nPOST でリクエストした URL にエンコード済みパラメータが含まれている場合には、これらのデータは request.GET データから利用できます。たとえば、次のようなリクエストを行った場合、
\nPython console Copy
>>> c . post ( \n... "/login/" , { "name" : "fred" , "passwd" : "secret" }, query_params = { "visitor" : "true" } \n... ) \nこのリクエストをハンドリングするビューでは、request.POST からはユーザー名とパスワードを取得し、request.GET からはユーザーが visitor であるかどうかを特定できます。
\nfollow True redirect_chain
\nsecure True
\n \n\n\n\nhead ( path data = None follow = False secure = False * headers = None query_params = None ** extra ) Link to this definition # \n指定された path Response Client.get() follow secure headers query_params extra
\n \n\n\n\noptions ( path data = '' content_type = 'application/octet-stream' follow = False secure = False * headers = None query_params = None ** extra ) Link to this definition # \n与えられた path Response
\ndata content_type Content-Type
\nfollow secure headers query_params extra Client.get()
\n \n\n\n\nput ( path data = '' content_type = 'application/octet-stream' follow = False secure = False * headers = None query_params = None ** extra ) Link to this definition # \n与えられた path Response
\ndata content_type Content-Type
\nfollow secure headers query_params extra Client.get()
\n \n\n\n\npatch ( path data = '' content_type = 'application/octet-stream' follow = False secure = False * headers = None query_params = None ** extra ) Link to this definition # \n与えられた path Response
\nfollow secure headers query_params extra Client.get()
\n \n\n\n\ndelete ( path data = '' content_type = 'application/octet-stream' follow = False secure = False * headers = None query_params = None ** extra ) Link to this definition # \n与えられた path Response
\ndata content_type Content-Type
\nfollow secure headers query_params extra Client.get()
\n \n\n\n\ntrace ( path follow = False secure = False * headers = None query_params = None ** extra ) Link to this definition # \n与えられた path Response
\n他のリクエストメソッドとは違い、 data RFC 9110 Section 9.3.8
\nfollow secure headers query_params extra Client.get()
\n \n\n\n\nlogin ( ** credentials ) Link to this definition # \n \n\n\n\nalogin ( ** credentials ) Link to this definition # \n非同期バージョン : alogin()
\nあなたのサイトが Django の 認証システム login()
\nこのメソッドを呼ぶ事で、テストクライアントはログインに基づいてビューを形成するテストを行う上で必要なクッキーとセッション情報を全て持ちます。
\n引数 credentials AUTHENTICATION_BACKENDS 認証バックエンド ModelBackend credentials
\nPython console Copy
>>> c = Client () \n>>> c . login ( username = "fred" , password = "secret" ) \n\n# Now you can access a view that's only available to logged-in users. \nもし標準以外の認証バックエンドを利用している場合、このメソッドは異なった認証情報を必要とします。この値では利用している認証バックエンドの authenticate()
\nlogin() True
\nFinally, you'll need to remember to create user accounts before you can\nuse this method. As we explained above, the test runner is executed\nusing a test database, which contains no users by default. As a result,\nuser accounts that are valid on your production site will not work\nunder test conditions. You'll need to create users as part of the test\nsuite -- either manually (using the Django model API) or with a test\nfixture. Remember that if you want your test user to have a password,\nyou can't set the user's password by setting the password attribute\ndirectly -- you must use the\nset_password() create_user()
\n \n\n\n\nforce_login ( user backend = None ) Link to this definition # \n \n\n\n\naforce_login ( user backend = None ) Link to this definition # \n非同期バージョン : aforce_login()
\nあなたのサイトが Django の 認証システム force_login() login()
\nlogin() is_active=False
\nユーザーには、 backend backend settings.AUTHENTICATION_BACKENDS[0] login() authenticate()
\nこのメソッドは、高コストなパスワードハッシングアルゴリズムを回避するため、 login() テストに弱いハッシャーを使う login()
\n \n\n\n\nlogout ( ) Link to this definition # \n \n\n\n\nalogout ( ) Link to this definition # \n非同期バージョン : alogout()
\nあなたのサイトが Django の 認証システム logout()
\nこのメソッドを呼び出した後、テストクライアントはすべてのクッキーとセッションデータをデフォルトにクリアします。それ以降のリクエストは AnonymousUser
\n \n\n \n\n \n\n\nget() post() Response Response HttpResponse 異なるもの であり、テストのレスポンスには、テストコードの検証に便利な追加データがいくつかあります。
\n特に、Response
\n\n\nclass Response Link to this definition # \n\n\nclient Link to this definition # \nレスポンスの結果の元となるリクエストを作るために使われた、テストクライアントです。
\n \n\n\n\ncontent Link to this definition # \nBytestring としてのレスポンスの本文です。ビューないしエラーメッセージによってレンダリングされる際の最終的なページコンテンツです。
\n \n\n\n\ncontext Link to this definition # \nテンプレートの Context
\n描画されたページが複数のテンプレートを使っていた場合、context Context
\nレンダリングに使われるテンプレートの数にかかわらず、[] name
\nPython console Copy
>>> response = client . get ( "/foo/" ) \n>>> response . context [ "name" ] \n'Arthur' \n\nDjango のテンプレートを使っていない？
\nこの属性は、DjangoTemplates context_data
\n \n \n\n\n\nexc_info Link to this definition # \nビュー中で発生した未処理の例外 (もし存在すれば) に関する情報を提供する3つの値のタプル。
\n値は (type, value, traceback) であり、Python の sys.exc_info()
\n\n例外が発生しなかった場合、exc_info None
\n \n\n\n\njson ( ** kwargs ) Link to this definition # \nJSON としてパースされた、レスポンスの本文です。追加のキーワード引数が json.loads()
\nPython console Copy
>>> response = client . get ( "/foo/" ) \n>>> response . json ()[ "name" ] \n'Arthur' \nContent-Type "application/json" ValueError
\n \n\n\n\nrequest Link to this definition # \nレスポンスを機能させるリクエストデータです。
\n \n\n\n\nwsgi_request Link to this definition # \nレスポンスを生成したテストハンドラーによって生成された WSGIRequest
\n \n\n\n\nstatus_code Link to this definition # \nレスポンスの HTTP ステータスで、数値です。 定義済みのコードの全リストは、IANA status code registry を参照してください。
\n \n\n\n\ntemplates Link to this definition # \n最終コンテンツをレンダリングするときに使われる Template template.name 'admin/index.html'
\n\nDjango のテンプレートを使っていない？
\nこの属性は、DjangoTemplates template_name
\n \n \n\n\n\nresolver_match Link to this definition # \nレスポンスに対する ResolverMatch func
\nCode Copy
# my_view here is a function based view. \nself . assertEqual ( response . resolver_match . func , my_view ) \n\n# Class-based views need to compare the view_class, as the \n# functions generated by as_view() won't be equal. \nself . assertIs ( response . resolver_match . func . view_class , MyView ) \n指定された URL が見つからない場合、この属性にアクセスすると Resolver404
\n \n\n \n\n通常のレスポンスと同様に、HttpResponse.headers response.headers['Content-Type']
\n \n\n\n例外を発生させるビューをテストクライアントで指定し、Client.raise_request_exception True try ... except assertRaises()
\nテストクライアントに可視化されない唯一の例外は、Http404 PermissionDenied SystemExit SuspiciousOperation response.status_code
\nClient.raise_request_exception False exc_info
\n \n\n\nテストクライアントはステートフルです。レスポンスがクッキーを返す場合、そのクッキーはテストクライアント内に保持され、以降すべての get() post()
\nクッキーに対する有効期限ポリシーは使えません。クッキーを期限切れにしたい場合、手動で削除するか、新たに (すべてのクッキーを削除するために) Client
\nテストクライアントは、永続的なステート情報を保持する属性を持ちます。テスト条件の一環として、これらのプロパティにアクセスできます。
\n\n\nClient. cookies Link to this definition # \nPython の SimpleCookie http.cookies
\n \n\n\n\nClient. session Link to this definition # \n辞書形式のようなオブジェクトで、セッション情報を含みます。セッションのドキュメント
\nセッションを修正し保存するためには、まず変数に格納される必要があります (新しい SessionStore
\nCode Copy
def test_something ( self ): \n session = self . client . session \n session [ "somekey" ] = "test" \n session . save () \n \n\n\n\nClient. asession ( ) Link to this definition # \nsession
\n \n\n \n\n\n国際化とローカライズをサポートしているアプリケーションをテストする際、テストクライアントのリクエストに対して言語を設定するのがよいでしょう。その方法は、LocaleMiddleware
\nミドルウェアが有効化されている場合、LANGUAGE_COOKIE_NAME
\nCode Copy
from django.conf import settings \n\n\ndef test_language_using_cookie ( self ): \n self . client . cookies . load ({ settings . LANGUAGE_COOKIE_NAME : "fr" }) \n response = self . client . get ( "/" ) \n self . assertEqual ( response . content , b "Bienvenue sur mon site." ) \nもしくは、Accept-Language
\nCode Copy
def test_language_using_header ( self ): \n response = self . client . get ( "/" , headers = { "accept-language" : "fr" }) \n self . assertEqual ( response . content , b "Bienvenue sur mon site." ) \n\n注釈
\nこれらのメソッドを使用するときは、必ず各テストの最後にアクティブな言語をリセットしてください。
\nCode Copy
def tearDown ( self ): \n translation . activate ( settings . LANGUAGE_CODE ) \n \nさらなる詳細は Django はどうやって言語の優先順位を検出するのか？
\nミドルウェアが有効化されていない場合、アクティブな言語は translation.override()
\nCode Copy
from django.utils import translation \n\n\ndef test_language_using_override ( self ): \n with translation . override ( "fr" ): \n response = self . client . get ( "/" ) \n self . assertEqual ( response . content , b "Bienvenue sur mon site." ) \nさらなる詳細は 明示的にアクティブな言語をセットする
\n \n\n\n以下は、テストクライアントを使ったユニットテストです。
\nCode Copy
import unittest \nfrom django.test import Client \n\n\nclass SimpleTest ( unittest . TestCase ): \n def setUp ( self ): \n # Every test needs a client. \n self . client = Client () \n\n def test_details ( self ): \n # Issue a GET request. \n response = self . client . get ( "/customer/details/" ) \n\n # Check that the response is 200 OK. \n self . assertEqual ( response . status_code , 200 ) \n\n # Check that the rendered context contains 5 customers. \n self . assertEqual ( len ( response . context [ "customers" ]), 5 ) \n \n \n\n標準の Python ユニットテストのクラスは、unittest.TestCase
\n\n\nDjango ユニットテストクラスの階層 Link to this image #
\n \n \n通常の unittest.TestCase unittest.TestCase
\n\n\n\n\nclass SimpleTestCase Link to this definition # \n \n\n以下の機能を追加する、unittest.TestCase
\n\nデータベースクエリを作る手薄との場合、サブクラス TransactionTestCase TestCase
\n\n\nSimpleTestCase. databases Link to this definition # \nSimpleTestCase SimpleTestCase databases '__all__'
\n \n\n\n警告
\nSimpleTestCase TestCase setUpClass() tearDownClass() super
\nCode Copy
class MyTestCase ( TestCase ): \n @classmethod \n def setUpClass ( cls ): \n super () . setUpClass () \n ... \n\n @classmethod \n def tearDownClass ( cls ): \n ... \n super () . tearDownClass () \nsetUpClass() tearDownClass() django.test.TestCase super() setUpClass() unittest.SkipTest super()
\n \n \n\n\n\n\nclass TransactionTestCase Link to this definition # \n \n\nTransactionTestCase SimpleTestCase
\n\nDjango's TestCase TransactionTestCase TestCase select_for_update() TransactionTestCase
\nTransactionTestCase TestCase
\n\nTransactionTestCase TransactionTestCase
一方、TestCase
\n\n警告
\nロールバックをサポートしないデータベース (例: MyISAM ストレージエンジンを使用した MySQL) 上で実行される TestCase TransactionTestCase
\nアプリは データの再読み込みを確認しません TestCase serialized_rollback = True
\n \n \n\n\n\n\nclass TestCase Link to this definition # \n \n\nこれは、Django でテストを書く際に使われる、最も一般的なクラスです。TransactionTestCase SimpleTestCase SimpleTestCase
\nクラス:
\n\nさらに、以下のような追加メソッドを提供します。
\n\n\nclassmethod TestCase. setUpTestData ( ) Link to this definition # \n上述のクラスレベルの atomic TestCase setUp()
\n例:
\nCode Copy
from django.test import TestCase \n\n\nclass MyTests ( TestCase ): \n @classmethod \n def setUpTestData ( cls ): \n # Set up data for the whole TestCase \n cls . foo = Foo . objects . create ( bar = "Test" ) \n ... \n\n def test1 ( self ): \n # Some test using self.foo \n ... \n\n def test2 ( self ): \n # Some other test using self.foo \n ... \nテストがトランザクションサポートのないデータベース (たとえば MyISAM エンジンの MySQL) で実行される場合、各テストの前に setUpTestData()
\nObjects assigned to class attributes in setUpTestData() copy.deepcopy()
\n \n\n\n\nclassmethod TestCase. captureOnCommitCallbacks ( using = DEFAULT_DB_ALIAS execute = False ) Link to this definition # \n指定されたデータベースコネクションに対する transaction.on_commit()
\nusing
\nexecute True
\n例:
\nCode Copy
from django.core import mail \nfrom django.test import TestCase \n\n\nclass ContactTests ( TestCase ): \n def test_post ( self ): \n with self . captureOnCommitCallbacks ( execute = True ) as callbacks : \n response = self . client . post ( \n "/contact/" , \n { "message" : "I like your site" }, \n ) \n\n self . assertEqual ( response . status_code , 200 ) \n self . assertEqual ( len ( callbacks ), 1 ) \n self . assertEqual ( len ( mail . outbox ), 1 ) \n self . assertEqual ( mail . outbox [ 0 ] . subject , "Contact Form" ) \n self . assertEqual ( mail . outbox [ 0 ] . body , "I like your site" ) \n \n\n \n\n\n\nclass LiveServerTestCase Link to this definition # \n \n\nLiveServerTestCase TransactionTestCase Selenium クライアントのような Django ダミークライアント
\nライブサーバーは localhost self.live_server_url
\nLiveServerTestCase selenium パッケージをインストールする必要があります。
\nLinux / macOS
Shell Copy
$ python -m pip install "selenium >= 4.23.0" \n\n
Windows
Windows Copy
...\\> py -m pip install "selenium >= 4.23.0" \nその後、LiveServerTestCase myapp/tests.py staticfiles DEBUG=True collectstatic StaticLiveServerTestCase django.test.LiveServerTestCase
\nこのテストに対するコードは、以下のようになるでしょう。
\nCode Copy
from django.contrib.staticfiles.testing import StaticLiveServerTestCase \nfrom selenium.webdriver.common.by import By \nfrom selenium.webdriver.firefox.webdriver import WebDriver \n\n\nclass MySeleniumTests ( StaticLiveServerTestCase ): \n fixtures = [ "user-data.json" ] \n\n @classmethod \n def setUpClass ( cls ): \n super () . setUpClass () \n cls . selenium = WebDriver () \n cls . selenium . implicitly_wait ( 10 ) \n\n @classmethod \n def tearDownClass ( cls ): \n cls . selenium . quit () \n super () . tearDownClass () \n\n def test_login ( self ): \n self . selenium . get ( f " { self . live_server_url } /login/" ) \n username_input = self . selenium . find_element ( By . NAME , "username" ) \n username_input . send_keys ( "myuser" ) \n password_input = self . selenium . find_element ( By . NAME , "password" ) \n password_input . send_keys ( "secret" ) \n self . selenium . find_element ( By . XPATH , '//input[@value="Log in"]' ) . click () \n最後に、次のようにテストを実行できます。
\nLinux / macOS
Shell Copy
$ ./manage.py test myapp.tests.MySeleniumTests.test_login\n\n
Windows
Windows Copy
...\\> manage.py test myapp.tests.MySeleniumTests.test_login\nこの例では、Firefox が自動的に開き、ログインページに行き、クレデンシャルを入力して、「Log in」ボタンをクリックします。Selenium は、Firefox をインストール済みでないか、他のブラウザを使いたいときのために、他のドライバも提供します。上の例は、Selenium クライアントができることのほんの一部に過ぎません。詳細については、完全なリファレンス を確認してください。
\n\n注釈
\nインメモリ SQLite データベースを使用してテストを実行する場合、同じデータベース接続を 2 つのスレッドで並行して共有します。ライブサーバを実行するスレッドとテストケースを実行するスレッドです。この 2 つのスレッドが共有接続を介して同時にデータベースをクエリしないようにすることが重要です。これは、テストがランダムに失敗する可能性があるからです。そのため、2 つのスレッドが同時にデータベースにアクセスしないようにする必要があります。特に、場合によっては (たとえばリンクをクリックしたりフォームを送信したりした直後に) Selenium がレスポンスを受け取り、次のページが読み込まれたことを確認してからテストを実行する必要があるかもしれません。たとえば、レスポンスの中に <body>
\nCode Copy
def test_login ( self ): \n from selenium.webdriver.support.wait import WebDriverWait \n\n timeout = 2 \n ... \n self . selenium . find_element ( By . XPATH , '//input[@value="Log in"]' ) . click () \n # Wait until the response is received \n WebDriverWait ( self . selenium , timeout ) . until ( \n lambda driver : driver . find_element ( By . TAG_NAME , "body" ) \n ) \nここで厄介なのは、特にサーバーが最初のドキュメントを生成した後に動的にHTMLを生成する最近のウェブアプリでは、「ページの読み込み」というものが実際には存在しないということです。そのため、レスポンスに <body> Selenium FAQ と Selenium documentation を参照してください。
\n \n \n \n\n\n\n\n\n\nSimpleTestCase. client Link to this definition # \n \n\n\n\nSimpleTestCase. async_client Link to this definition # \n \n\nEvery django.test.*TestCase self.client self.async_client
\nFor example, rather than instantiating a Client
\nCode Copy
import unittest \nfrom django.test import Client \n\n\nclass SimpleTest ( unittest . TestCase ): \n def test_details ( self ): \n client = Client () \n response = client . get ( "/customer/details/" ) \n self . assertEqual ( response . status_code , 200 ) \n\n def test_index ( self ): \n client = Client () \n response = client . get ( "/customer/index/" ) \n self . assertEqual ( response . status_code , 200 ) \n次のように self.client
\nCode Copy
from django.test import TestCase \n\n\nclass SimpleTest ( TestCase ): \n def test_details ( self ): \n response = self . client . get ( "/customer/details/" ) \n self . assertEqual ( response . status_code , 200 ) \n\n def test_index ( self ): \n response = self . client . get ( "/customer/index/" ) \n self . assertEqual ( response . status_code , 200 ) \n \n\n\n\n\nSimpleTestCase. client_class Link to this definition # \n \n\n\n\nSimpleTestCase. async_client_class Link to this definition # \n \n\nIf you want to use a different Client AsyncClient client_class async_client_class
\nFor example, to customize the synchronous test client:
\nCode Copy
from django.test import Client , TestCase \n\n\nclass MyTestClient ( Client ): \n # Specialized methods for your environment \n ... \n\n\nclass MyTest ( TestCase ): \n client_class = MyTestClient \n\n def test_my_stuff ( self ): \n # Here self.client is an instance of MyTestClient... \n call_some_test_code () \nThe same pattern applies to the asynchronous test client by subclassing\nAsyncClient async_client_class
\n \n\n\n\nTransactionTestCase. fixtures Link to this definition # \n \n\nデータベースを利用したウェブサイト向けのテストケースクラスは、データベースにデータが何もなければあまり役に立ちません。TestCase.setUpTestData() フィクスチャ
\nフィクスチャは、Django がどうやってデータベースにインポートするか分かっているデータのコレクションです。たとえば、サイトがユーザーアカウントを持つ場合、テスト内でデータベースに格納させるために、フェイクのユーザーアカウントのフィクスチャをセットアップできます。
\nフィクスチャを作成するもっとも分かりやすい方法は、manage.py dumpdata dumpdata のドキュメント
\nいったんフィクスチャを作成して INSTALLED_APPS fixtures django.test.TestCase fixtures
\nCode Copy
from django.test import TestCase \nfrom myapp.models import Animal \n\n\nclass AnimalTestCase ( TestCase ): \n fixtures = [ "mammals.json" , "birds" ] \n\n def setUp ( self ): \n # Test definitions as before. \n call_setup_methods () \n\n def test_fluffy_animals ( self ): \n # A test that uses the fixtures. \n call_some_test_code () \n具体的には、以下のことが起こります。
\n\n多くのユニットテストで使用される TestCase TransactionTestCase
\n\nいずれの場合でも、あるテストの結果が他のテストやテストの実行順によって影響を受けることはありません。
\nデフォルトでは、フィクスチャは default TransactionTestCase.databases
\n \n\n\nアプリケーションがヴューを提供する場合、テストクライアントを使ってビューを実行するテストを含めたくなるかもしれません。しかし、エンドユーザーは、アプリケーション内で選択した任意の URL に自由にビューをデプロイできます。これが意味するのは、テストはビューが特定の URL で利用可能であるという事実に頼ることができないということです。URLconf の設定のためには、テストクラスまたはメソッドを @override_settings(ROOT_URLCONF=...)
\n \n\n\n\nTransactionTestCase. databases Link to this definition # \n \n\nDjango は、設定の DATABASES databases
\nしかし、 Django の TestCase flush
\n最適化として、Django は各テスト実行の終了時に default databases
\n例:
\nCode Copy
class TestMyViews ( TransactionTestCase ): \n databases = { "default" , "other" } \n\n def test_index_page_view ( self ): \n call_some_test_code () \nこのテストケースクラスは test_index_page_view default other '__all__'
\ndatabases TransactionTestCase.fixtures default
\ndatabases
\n\n\nTestCase. databases Link to this definition # \n \n\nデフォルトでは、TestCase default
\nデフォルト以外のデータベースに対してトランザクションラッピングを要求するには、テストクラスの databases
\n例:
\nCode Copy
class OtherDBTests ( TestCase ): \n databases = { "other" } \n\n def test_other_db_query ( self ): ... \nこのテストは other SimpleTestCase.databases TransactionTestCase.databases '__all__'
\n \n\n\n\nSimpleTestCase. settings ( ) Link to this definition # \n \n\nFor testing purposes it's often useful to change a setting temporarily and\nrevert to the original value after running the testing code. For this use case\nDjango provides a standard context manager settings()
\nCode Copy
from django.test import TestCase \n\n\nclass LoginTestCase ( TestCase ): \n def test_login ( self ): \n # First check for the default behavior \n response = self . client . get ( "/sekrit/" ) \n self . assertRedirects ( response , "/accounts/login/?next=/sekrit/" ) \n\n # Then override the LOGIN_URL setting \n with self . settings ( LOGIN_URL = "/other/login/" ): \n response = self . client . get ( "/sekrit/" ) \n self . assertRedirects ( response , "/other/login/?next=/sekrit/" ) \nこの例では、 with LOGIN_URL
\n\n\nSimpleTestCase. modify_settings ( ) Link to this definition # \n \n\n値のリストを含む設定の再定義は難しいことがあります。実際には、値の追加や削除で十分なことも多いです。Django には設定を簡単に変更するための modify_settings()
\nCode Copy
from django.test import TestCase \n\n\nclass MiddlewareTestCase ( TestCase ): \n def test_cache_middleware ( self ): \n with self . modify_settings ( \n MIDDLEWARE = { \n "append" : "django.middleware.cache.FetchFromCacheMiddleware" , \n "prepend" : "django.middleware.cache.UpdateCacheMiddleware" , \n "remove" : [ \n "django.contrib.sessions.middleware.SessionMiddleware" , \n "django.contrib.auth.middleware.AuthenticationMiddleware" , \n "django.contrib.messages.middleware.MessageMiddleware" , \n ], \n } \n ): \n response = self . client . get ( "/" ) \n # ... \n各アクションに対して、値のリストまたは文字列を指定できます。値がすでにリストに存在する場合、 append prepend remove
\n\n\noverride_settings ( ** kwargs ) Link to this definition # \n \n\nIn case you want to override a setting for a test method, Django provides the\noverride_settings() decorator
\nCode Copy
from django.test import TestCase , override_settings \n\n\nclass LoginTestCase ( TestCase ): \n @override_settings ( LOGIN_URL = "/other/login/" ) \n def test_login ( self ): \n response = self . client . get ( "/sekrit/" ) \n self . assertRedirects ( response , "/other/login/?next=/sekrit/" ) \nこのデコレータは TestCase
\nCode Copy
from django.test import TestCase , override_settings \n\n\n@override_settings ( LOGIN_URL = "/other/login/" ) \nclass LoginTestCase ( TestCase ): \n def test_login ( self ): \n response = self . client . get ( "/sekrit/" ) \n self . assertRedirects ( response , "/other/login/?next=/sekrit/" ) \n\n\nmodify_settings ( * args ** kwargs ) Link to this definition # \n \n\n同様に、Django には modify_settings()
\nCode Copy
from django.test import TestCase , modify_settings \n\n\nclass MiddlewareTestCase ( TestCase ): \n @modify_settings ( \n MIDDLEWARE = { \n "append" : "django.middleware.cache.FetchFromCacheMiddleware" , \n "prepend" : "django.middleware.cache.UpdateCacheMiddleware" , \n } \n ) \n def test_cache_middleware ( self ): \n response = self . client . get ( "/" ) \n # ... \nこのデコレータはテストケースクラスにも適用できます:
\nCode Copy
from django.test import TestCase , modify_settings \n\n\n@modify_settings ( \n MIDDLEWARE = { \n "append" : "django.middleware.cache.FetchFromCacheMiddleware" , \n "prepend" : "django.middleware.cache.UpdateCacheMiddleware" , \n } \n) \nclass MiddlewareTestCase ( TestCase ): \n def test_cache_middleware ( self ): \n response = self . client . get ( "/" ) \n # ... \n\n注釈
\nクラスが渡されると、これらのデコレータはそのクラスを直接変更して返します。変更したコピーを作成して返すわけではありません。そのため、上記の例を微調整して LoginTestCase MiddlewareTestCase modify_settings() override_settings()
\n \n\n警告
\n設定ファイルには、Django の内部の初期化時にだけ参照されるいくつかの設定が含まれています。設定ファイルを override_settings django.conf.settings override_settings() modify_settings()
\nDATABASES CACHES django.contrib.sessions CACHES
\n最後に、設定をモジュールレベルの定数としてエイリアスすることは避けてください。なぜなら、override_settings()
\n \n下記のように、設定が上書きされた後にその設定を削除することで、設定がない状態をシミュレートすることもできます:
\nCode Copy
@override_settings () \ndef test_something ( self ): \n del settings . LOGIN_URL \n ... \n設定を上書きする場合、アプリのコードが、キャッシュや設定が変更されても状態を保持するような機能を使用しているケースにも対処してください。Django には django.test.signals.setting_changed
\nDjango 自身は、このシグナルを使って様々なデータをリセットします:
\n\n \n\n\n\n\nutils. isolate_apps ( * app_labels attr_name = None kwarg_name = None ) Link to this definition # \nラップされたコンテキスト内で定義されたモデルを、独自の隔離された apps
\n隔離されたレジストリが含む必要があるアプリラベルは、個別の引数として渡す必要があります。isolate_apps()
\nCode Copy
from django.db import models \nfrom django.test import SimpleTestCase \nfrom django.test.utils import isolate_apps \n\n\nclass MyModelTests ( SimpleTestCase ): \n @isolate_apps ( "app_label" ) \n def test_model_definition ( self ): \n class TestModel ( models . Model ): \n pass \n\n ... \nあるいは、次のようにします。
\nCode Copy
with isolate_apps ( "app_label" ): \n\n class TestModel ( models . Model ): \n pass \n\n ... \nデコレータ形式は、クラスにも適用できます。
\n2つのオプション引数が指定できます。
\n\nモデル登録を隔離するために使用される一時的な Apps attr_name
\nCode Copy
@isolate_apps ( "app_label" , attr_name = "apps" ) \nclass TestModelDefinition ( SimpleTestCase ): \n def test_model_definition ( self ): \n class TestModel ( models . Model ): \n pass \n\n self . assertIs ( self . apps . get_model ( "app_label" , "TestModel" ), TestModel ) \nあるいは、kwarg_name
\nCode Copy
class TestModelDefinition ( SimpleTestCase ): \n @isolate_apps ( "app_label" , kwarg_name = "apps" ) \n def test_model_definition ( self , apps ): \n class TestModel ( models . Model ): \n pass \n\n self . assertIs ( apps . get_model ( "app_label" , "TestModel" ), TestModel ) \n \n\n \n\nDjango のカスタムの TestCase
\nテスト中のメールサービスの詳細については、以下の Email services を参照してください。
\n \n\nPython の通常の unittest.TestCase assertTrue() assertEqual() TestCase
\nこれらのアサーションメソッドで出力される失敗メッセージは、 msg_prefix
\n\n\nSimpleTestCase. assertRaisesMessage ( expected_exception expected_message callable * args ** kwargs ) Link to this definition # \n\nSimpleTestCase. assertRaisesMessage ( expected_exception expected_message ) \ncallable expected_exception expected_message unittest.TestCase.assertRaisesRegex() expected_message
\nexpected_exception expected_message
\nCode Copy
with self . assertRaisesMessage ( ValueError , "invalid literal for int()" ): \n int ( "a" ) \n \n\n\n\nSimpleTestCase. assertWarnsMessage ( expected_warning expected_message callable * args ** kwargs ) Link to this definition # \n\nSimpleTestCase. assertWarnsMessage ( expected_warning expected_message ) \nこれは SimpleTestCase.assertRaisesMessage() assertRaisesRegex() assertWarnsRegex()
\n \n\n\n\nSimpleTestCase. assertFieldOutput ( fieldclass valid invalid field_args = None field_kwargs = None empty_value = '' ) Link to this definition # \n様々な入力に対してフォームフィールドが正しく動作することをアサートします。
\n\nパラメータ: \n\nfieldclass -- テストされるフィールドのクラス。
valid -- 有効な入力をそれらの期待されるクリーンな値にマッピングする辞書。
invalid -- 無効な入力を一つ以上の発生したエラーメッセージにマッピングする辞書。
field_args -- フィールドをインスタンス化するために渡される引数。
field_kwargs -- フィールドをインスタンス化するために渡されるキーワード引数。
empty_value -- empty_values
\n \nたとえば、以下のコードは EmailField a@a.com aaa
\nCode Copy
self . assertFieldOutput ( \n EmailField , { "a@a.com" : "a@a.com" }, { "aaa" : [ "Enter a valid email address." ]} \n) \n \n\n\n\nSimpleTestCase. assertFormError ( form field errors msg_prefix = '' ) Link to this definition # \nフォーム上のフィールドが提供されたエラーのリストを発生させることをアサートします。
\nform Form バインドされている (bound である) assertFormError() full_clean()
\nfield 特定のフィールドに関連付けられていないエラー field=None
\nerrors errors='error message' errors=['error message']
\n \n\n\n\nSimpleTestCase. assertFormSetError ( formset form_index field errors msg_prefix = '' ) Link to this definition # \nレンダリング時に formset
\nformset FormSet assertFormSetError() full_clean()
\nform_index FormSet formset.non_form_errors() form_index=None field=None
\nfield errors assertFormError()
\n \n\n\n\nSimpleTestCase. assertContains ( response text count = None status_code = 200 msg_prefix = '' html = False ) Link to this definition # \nAsserts that an HttpResponse status_code text content count text count
\ntext html True assertHTMLEqual()
\n \n\n\n\nSimpleTestCase. assertNotContains ( response text status_code = 200 msg_prefix = '' html = False ) Link to this definition # \nAsserts that an HttpResponse status_code text not appear in its content
\ntext html True assertHTMLEqual()
\n \n\n\n\nSimpleTestCase. assertTemplateUsed ( response template_name msg_prefix = '' count = None ) Link to this definition # \n指定された名前のテンプレートがレスポンスのレンダリングに使われたことをアサートします。
\nresponse Response
\ntemplate_name 'admin/index.html'
\ncount None
\nこのようにコンテキストマネージャとして使用できます:
\nCode Copy
with self . assertTemplateUsed ( "index.html" ): \n render_to_string ( "index.html" ) \nwith self . assertTemplateUsed ( template_name = "index.html" ): \n render_to_string ( "index.html" ) \n \n\n\n\nSimpleTestCase. assertTemplateNotUsed ( response template_name msg_prefix = '' ) Link to this definition # \n指定された名前のテンプレートがレスポンスのレンダリングに使われて いない ことをアサートします。
\nassertTemplateUsed()
\n \n\n\n\nSimpleTestCase. assertURLEqual ( url1 url2 msg_prefix = '' ) Link to this definition # \n同じ名前のパラメータを除いて、クエリ文字列パラメータの順序を無視して、2つのURLが同じであることをアサートします。例えば、 /path/?x=1&y=2 /path/?y=2&x=1 /path/?a=1&a=2 /path/?a=2&a=1
\n \n\n\n\nSimpleTestCase. assertRedirects ( response expected_url status_code = 302 target_status_code = 200 msg_prefix = '' fetch_redirect_response = True ) Link to this definition # \nAsserts that the HttpResponse status_code expected_url GET target_status_code
\nリクエストが follow expected_url target_status_code
\nfetch_redirect_response False expected_url
\nスキームは、2つのURL間の比較を行う際に正しく処理されます。リダイレクト先にスキームが指定されていない場合、元のリクエストのスキームが使われます。もし存在すれば、 expected_url
\n \n\n\n\nSimpleTestCase. assertHTMLEqual ( html1 html2 msg = None ) Link to this definition # \n文字列 html1 html2
\n\nHTMLタグの前後の空白は無視されます。
すべての種類の空白は同等とみなされます。
すべての開いたタグは暗黙的に閉じられます。例えば、周囲のタグが閉じられるかHTMLドキュメントが終了したときなど。
空のタグは自己終了 (self-closing) タグと等価です。
HTML要素の属性の順序は重要ではありません。
引数を持たないブール属性 (例: checked
同じ文字を参照するテキスト、文字参照、およびエンティティ参照は等価です。
\n以下の例は有効なテストであり、どれも AssertionError
\nCode Copy
self . assertHTMLEqual ( \n "<p>Hello <b>'world'!</p>" , \n """<p> \n Hello <b>'world'! </b> \n </p>""" , \n) \nself . assertHTMLEqual ( \n '<input type="checkbox" checked="checked" id="id_accept_terms" />' , \n '<input id="id_accept_terms" type="checkbox" checked>' , \n) \nhtml1 html2 AssertionError
\nエラー時の出力は msg
\n \n\n\n\nSimpleTestCase. assertHTMLNotEqual ( html1 html2 msg = None ) Link to this definition # \n文字列 html1 html2 ない ことをアサートします。比較はHTMLのセマンティクスに基づいて行われます。詳細は assertHTMLEqual()
\nhtml1 html2 AssertionError
\nエラー時の出力は msg
\n \n\n\n\nSimpleTestCase. assertXMLEqual ( xml1 xml2 msg = None ) Link to this definition # \n文字列 xml1 xml2 assertHTMLEqual() AssertionError
\nXML宣言、ドキュメントタイプ、処理命令、コメントは無視されます。比較されるのはルート要素とその子要素だけです。
\nエラー時の出力は msg
\n \n\n\n\nSimpleTestCase. assertXMLNotEqual ( xml1 xml2 msg = None ) Link to this definition # \n文字列 xml1 xml2 ない ことをアサートします。比較はXMLセマンティクスに基づいて行われます。詳細は assertXMLEqual()
\nエラー時の出力は msg
\n \n\n\n\nSimpleTestCase. assertInHTML ( needle haystack count = None msg_prefix = '' ) Link to this definition # \nHTML フラグメント needle haystack
\nもし count needle
\nほとんどの場合、空白は無視され、属性の順序は重要ではありません。詳細は assertHTMLEqual()
\n \n\n\n\nSimpleTestCase. assertNotInHTML ( needle haystack msg_prefix = '' ) Link to this definition # \nHTMLフラグメント needle haystack いない ことをアサートします。
\nほとんどの場合、空白は無視され、属性の順序は重要ではありません。詳細は assertHTMLEqual()
\n \n\n\n\nSimpleTestCase. assertJSONEqual ( raw expected_data msg = None ) Link to this definition # \nJSON フラグメント raw expected_data json
\nエラー時の出力は msg
\n \n\n\n\nSimpleTestCase. assertJSONNotEqual ( raw expected_data msg = None ) Link to this definition # \nJSON フラグメント raw expected_data ない ことをアサートします。詳細は assertJSONEqual()
\nエラー時の出力は msg
\n \n\n\n\nTransactionTestCase. assertQuerySetEqual ( qs values transform = None ordered = True msg = None ) Link to this definition # \nクエリセット qs values
\ntransform values qs transform
\nデフォルトでは、比較は順序に依存します。もし qs ordered False collections.Counter qs ValueError
\nエラー時の出力は msg
\n \n\n\n\nTransactionTestCase. assertNumQueries ( num func * args ** kwargs ) Link to this definition # \nfunc *args **kwargs num
\nもし kwargs "using"
\nCode Copy
self . assertNumQueries ( 7 , my_function , using = "non_default_db" ) \nもし using lambda
\nCode Copy
self . assertNumQueries ( 7 , lambda : my_function ( using = 7 )) \nコンテキストマネージャとしても使えます。
\nCode Copy
with self . assertNumQueries ( 2 ): \n Person . objects . create ( name = "Aaron" ) \n Person . objects . create ( name = "Daniel" ) \n \n\n \n\nテストにタグをつけることで、特定のサブセットを簡単に実行できるようになります。たとえば、速いテストや遅いテストにラベルをつけることができます。
\nCode Copy
from django.test import tag \n\n\nclass SampleTestCase ( TestCase ): \n @tag ( "fast" ) \n def test_fast ( self ): ... \n\n @tag ( "slow" ) \n def test_slow ( self ): ... \n\n @tag ( "slow" , "core" ) \n def test_slow_but_core ( self ): ... \nテストケースクラスにタグを付けることもできます。
\nCode Copy
@tag ( "slow" , "core" ) \nclass SampleTestCase ( TestCase ): ... \nサブクラスは基底クラスからタグを継承し、メソッドはそのクラスからタグを継承します。以下の例を考えてみましょう。
\nCode Copy
@tag ( "foo" ) \nclass SampleTestCaseChild ( SampleTestCase ): \n @tag ( "bar" ) \n def test ( self ): ... \nSampleTestCaseChild.test 'slow' 'core' 'bar' 'foo'
\nその後、どのテストを実行するか選択できます。例えば、速いテストのみを実行するには、次にようにします。
\nLinux / macOS
Shell Copy
$ ./manage.py test --tag= fast\n\n
Windows
Windows Copy
...\\> manage.py test --tag=fast\nまたは、速いテストとコアなテスト (それが遅いとしても) を実行することもできます。
\nLinux / macOS
Shell Copy
$ ./manage.py test --tag= fast --tag= core\n\n
Windows
Windows Copy
...\\> manage.py test --tag=fast --tag=core\nタグによってテストを除外することもできます。遅くない場合にコアテストを実行するには、次にようにします。
\nLinux / macOS
Shell Copy
$ ./manage.py test --tag= core --exclude-tag= slow\n\n
Windows
Windows Copy
...\\> manage.py test --tag=core --exclude-tag=slow\ntest --exclude-tag test --tag
\n \n \n\n単に非同期ビューの出力をテストしたいだけであれば、標準のテストクライアントが非同期ループの中で実行するので、追加の作業は必要ありません。
\nしかし、Django プロジェクトで完全な非同期テストを書きたい場合、いくつかの点を考慮する必要があります。
\nまず、テストはテストクラスの async def async def
\n非同期関数からテストする場合は、非同期テストクライアントも使用する必要があります。これは django.test.AsyncClient self.async_client
\n\n\nclass AsyncClient ( enforce_csrf_checks = False raise_request_exception = True * headers = None query_params = None ** defaults ) Link to this definition # \n \n\nAsyncClient
\n\nAsyncClient
\nCode Copy
async def test_my_thing ( self ): \n response = await self . async_client . get ( "/some-url/" ) \n self . assertEqual ( response . status_code , 200 ) \n非同期クライアントは同期ビューを呼び出すこともできます。Django の 非同期のリクエスト経路 AsyncClient WSGIRequest ASGIRequest request
\n\n警告
\nテストデコレータを使う場合、正しく動作するためには非同期対応でなければなりません。Django のビルトインデコレータは正しく動作しますが、サードパーティ製のデコレータは実行されないように見えるかもしれません (実行フローの間違った部分を「ラップ」してしまい、あなたのテストは実行されません)。
\nこれらのデコレータを使用する必要がある場合は、テストメソッドをそれらの 内部で async_to_sync()
\nCode Copy
from asgiref.sync import async_to_sync \nfrom django.test import TestCase \n\n\nclass MyTests ( TestCase ): \n @mock . patch ( ... ) \n @async_to_sync \n async def test_my_thing ( self ): ... \n \n \n\nIf any of your code sends email using Django's email functionality
\nThe test runner accomplishes this by transparently replacing the\nBACKEND MAILERS 'locmem' memory email backend
\n\n\ndjango.core.mail. outbox Link to this definition # \n \n\nDuring test running, each outgoing email is saved in\ndjango.core.mail.outbox EmailMessage outbox only when the\nlocmem django.core.mail
\n以下は django.core.mail.outbox
\nCode Copy
from django.core import mail \nfrom django.test import TestCase \n\n\nclass EmailTest ( TestCase ): \n def test_send_email ( self ): \n # Send message. \n mail . send_mail ( \n "Subject here" , \n "Here is the message." , \n "from@example.com" , \n [ "to@example.com" ], \n ) \n\n # Test that one message has been sent. \n self . assertEqual ( len ( mail . outbox ), 1 ) \n\n # Verify that the subject of the first message is correct. \n self . assertEqual ( mail . outbox [ 0 ] . subject , "Subject here" ) \n\n # Verify the message was sent with the "default" mailer. \n self . assertEqual ( mail . outbox [ 0 ] . sent_using , "default" ) \n前述の *TestCase mail.outbox
\nCode Copy
from django.core import mail \n\n# Empty the test outbox \nmail . outbox = [] \n \n\nunittest ライブラリは @skipIf @skipUnless
\n例えば、テストを成功させるために特定のオプションライブラリが必要な場合に、テストケースを @skipIf
\nこれらのテストスキップ動作を補うために、 Django はさらに 2 つのスキップデコレータを提供しています。一般的な真偽値をテストする代わりに、これらのデコレータはデータベースの機能をチェックし、データベースが特定の機能をサポートしていなければテストをスキップします。
\nデコレータは、データベース機能を表す文字列識別子を使用します。この文字列はデータベース接続の features クラスの属性に対応します。 django.db.backends.base.features.BaseDatabaseFeatures クラス に、テストをスキップするベースとして使用できるデータベース機能の完全なリストがあります。
\n\n\nskipIfDBFeature ( * feature_name_strings ) Link to this definition # \n \n\n指定したデータベース機能がすべてサポートされている場合は、デコレートされたテストや TestCase
\n例えば、データベースがトランザクションをサポートしている場合、以下のテストは実行されません (例えば、PostgreSQLでは実行 されません が、MyISAMテーブルを持つMySQLでは実行されます)。
\nCode Copy
class MyTests ( TestCase ): \n @skipIfDBFeature ( "supports_transactions" ) \n def test_transaction_behavior ( self ): \n # ... conditional test code \n pass \n\n\nskipUnlessDBFeature ( * feature_name_strings ) Link to this definition # \n \n\n指定したデータベース機能がサポートされていない場合は、デコレートされたテストや TestCase
\n例えば、以下のテストはデータベースがトランザクションをサポートしている場合だけ実行されます (たとえば、PostgreSQLでは実行されますが、MyISAMテーブルを持つMySQLでは実行 されません )。
\nCode Copy
class MyTests ( TestCase ): \n @skipUnlessDBFeature ( "supports_transactions" ) \n def test_transaction_behavior ( self ): \n # ... conditional test code \n pass \n ","rootId":"testing-tools","toc":[{"title":"テストクライアント","anchor":"the-test-client","children":[{"title":"概要と簡単な例","anchor":"overview-and-a-quick-example","children":[]},{"title":"リクエストの作成","anchor":"making-requests","children":[]},{"title":"レスポンスのテスト","anchor":"testing-responses","children":[]},{"title":"例外","anchor":"exceptions","children":[]},{"title":"永続的なステート","anchor":"persistent-state","children":[]},{"title":"言語の設定","anchor":"setting-the-language","children":[]},{"title":"カスタマイズ例","anchor":"example","children":[]}]},{"title":"提供されるテストケースのクラス","anchor":"provided-test-case-classes","children":[{"title":"SimpleTestCase","anchor":"simpletestcase","children":[]},{"title":"TransactionTestCase","anchor":"transactiontestcase","children":[]},{"title":"TestCase","anchor":"testcase","children":[]},{"title":"LiveServerTestCase","anchor":"liveservertestcase","children":[]}]},{"title":"テストケースの機能","anchor":"test-cases-features","children":[{"title":"デフォルトのテストクライアント","anchor":"default-test-client","children":[]},{"title":"テストクライアントをカスタムする","anchor":"customizing-the-test-client","children":[]},{"title":"フィクスチャのロード","anchor":"fixture-loading","children":[]},{"title":"URLconf の設定","anchor":"urlconf-configuration","children":[]},{"title":"マルチデータベースのサポート","anchor":"multi-database-support","children":[]},{"title":"設定のオーバーライド","anchor":"overriding-settings","children":[]},{"title":"アプリの隔離","anchor":"isolating-apps","children":[]},{"title":"テスト用の送信トレイを空にする","anchor":"emptying-the-test-outbox","children":[]},{"title":"アサーション","anchor":"assertions","children":[]},{"title":"テストにタグをつける","anchor":"tagging-tests","children":[]}]},{"title":"非同期コードをテストする","anchor":"testing-asynchronous-code","children":[]},{"title":"メールサービス","anchor":"email-services","children":[]},{"title":"管理コマンド","anchor":"management-commands","children":[]},{"title":"テストのスキップ","anchor":"skipping-tests","children":[]}],"breadcrumbs":[{"docname":"topics/index","title":"Django を使う","url":"/ja/6.1/topics/"},{"docname":"topics/testing/index","title":"Django におけるテスト","url":"/ja/6.1/topics/testing/"}],"prev":{"docname":"topics/testing/overview","title":"テストを書いて実行する","url":"/ja/6.1/topics/testing/overview/"},"next":{"docname":"topics/testing/advanced","title":"テストに関する高度なトピック","url":"/ja/6.1/topics/testing/advanced/"},"formats":{"html":"/ja/6.1/topics/testing/tools/","markdown":"/ja/6.1/topics/testing/tools.md","json":"/ja/6.1/topics/testing/tools.json"},"source":"https://github.com/django/django/blob/stable/6.1.x/docs/topics/testing/tools.txt","official":"https://docs.djangoproject.com/ja/6.1/topics/testing/tools/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9"],"inLocales":["en","sv","zh-hans","ga","fr","ja","id","it","pt-br","ko","es","el","pl"]}![\"Django](\"../../../../../../_images/django_unittest_classes_hierarchy.svg\")
\n\n