23.3.5 TestCase オブジェクト

TestCaseクラスのインスタンスは個別のテストをあらわすオブジェクトですが、TestCaseの具象サブクラスには複数のテストを定義する事ができます -- 具象サブクラスは、特定のfixture(テスト設備)を示している、と考えてください。fixtureは、それぞれのテストケースごとに作成・解放されます。

TestCaseインスタンスには、次の3種類のメソッドがあります:テストを実行するためのメソッド・条件のチェックやテスト失敗のレポートのためのメソッド・テストの情報収集に使用する問い合わせメソッド。

テストを実行するためのメソッドを以下に示します:

setUp( ): テストを実行する直前に、fixtureを作成する為に呼び出されます。このメソッドを実行中に例外が発生した場合、テストの失敗ではなくエラーとされます。デフォルトの実装では何も行いません。

tearDown( ): テストを実行し、結果を記録した直後に呼び出されます。テスト実行中に例外が発生しても呼び出されますので、内部状態に注意して処理を行ってください。メソッドを実行中に例外が発生した場合、テストの失敗ではなくエラーとみなされます。このメソッドは、setUp()が正常終了した場合にはテストメソッドの実行結果に関わり無く呼び出されます。デフォルトの実装では何も行いません。

run( [result]): テストを実行し、テスト結果をresultに指定されたテスト結果オブジェクトに収集します。resultがNoneか省略された場合、一時的な結果オブジェクトを(defaultTestCase()メソッドを呼んで)生成して使用しますがrun()の呼び出し元には渡されません。
このメソッドは、TestCaseインスタンスの呼び出しと等価です。

debug( ): テスト結果を収集せずにテストを実行します。例外が呼び出し元に通知されるため、テストをデバッガで実行することができます。

テスト結果のチェックとレポートには、以下のメソッドを使用してください。

assert_( expr[, msg])
failUnless( expr[, msg]): exprが偽の場合、テスト失敗を通知します。msgにはエラーの説明を指定するか、またはNoneを指定してください。

assertEqual( first, second[, msg])
failUnlessEqual( first, second[, msg]): firstとsecondexprが等しくない場合、テスト失敗を通知します。エラー内容はmsgに指定された値か、またはNoneとなります。failUnlessEqual()ではmsgのデフォルト値は firstとsecondを含んだ文字列となりますので、 failUnless()の第一引数に比較の結果を指定するよりも便利です。

assertNotEqual( first, second[, msg])
failIfEqual( first, second[, msg]): firstとsecondexprが等しい場合、テスト失敗を通知します。エラー内容はmsgに指定された値か、またはNoneとなります。failUnlessEqual()ではmsgのデフォルト値はfirst とsecondを含んだ文字列となりますので、failUnless()の第一引数に比較の結果を指定するよりも便利です。

assertAlmostEqual( first, second[, places[, msg]])
failUnlessAlmostEqual( first, second[, places[, msg]]): first と second を places で与えた小数位で値を丸めて差分を計算し、ゼロと比較することで、近似的に等価であるかどうかをテストします。指定小数位の比較というものは指定有効桁数の比較ではないので注意してください。値の比較結果が等しくなかった場合、テストは失敗し、msg で指定した説明か、None を返します。

assertNotAlmostEqual( first, second[, places[, msg]])
failIfAlmostEqual( first, second[, places[, msg]]): first と second を places で与えた小数位で値を丸めて差分を計算し、ゼロと比較することで、近似的に等価でないかどうかをテストします。指定小数位の比較というものは指定有効桁数の比較ではないので注意してください。値の比較結果が等しかった場合、テストは失敗し、msg で与えた説明か、None を返します。

assertRaises( exception, callable, ...)
failUnlessRaises( exception, callable, ...): callableを呼び出し、発生した例外をテストします。 assertRaises()には、任意の位置パラメータとキーワードパラメータを指定する事ができます。exceptionで指定した例外が発生した場合はテスト成功とし、それ以外の例外が発生するか例外が発生しない場合にテスト失敗となります。複数の例外を指定する場合には、例外クラスのタプルを exceptionに指定します。

failIf( expr[, msg]): failIf()はfailUnless()の逆で、exprが真の場合、テスト失敗を通知します。エラー内容はmsgに指定された値か、または Noneとなります。

fail( [msg]): 無条件にテスト失敗を通知します。エラー内容はmsgに指定された値か、またはNoneとなります。

failureException: test()メソッドが送出する例外を指定するクラス属性。テストフレームワークで追加情報を持つ等の特殊な例外を使用する場合、この例外のサブクラスとして作成します。この属性の初期値はAssertionError です。

テストフレームワークは、テスト情報を収集するために以下のメソッドを使用します:

countTestCases( ): テストオブジェクトに含まれるテストの数を返します。TestCaseインスタンスは常に1を返します。

defaultTestResult( ): このテストケースクラスで使われるテスト結果クラスのインスタンスを(もしrun()メソッドに他の結果インスタンスが提供されないならば)返します。
TestCaseインスタンスに対しては、いつもTestResultのインスタンスですので、TestCaseのサブクラスでは必要に応じてこのメソッドをオーバライドしてください。

id( ): テストケースを特定する文字列を返します。通常、idはモジュール名・クラス名を含む、テストメソッドのフルネームを指定します。

shortDescription( ): テストの説明を一行分、または説明がない場合にはNoneを返します。デフォルトでは、テストメソッドのdocstringの先頭の一行、または Noneを返します。

ご意見やご指摘をお寄せになりたい方は、 このドキュメントについて... をご覧ください。