23.3.7 TestResultオブジェクト

23.3.7 TestResultオブジェクト

TestResultは、複数のテスト結果を記録します。TestCaseクラスとTestSuiteクラスのテスト結果を正しく記録しますので、テスト開発者が独自にテスト結果を管理する処理を開発する必要はありません。

unittestを利用したテストフレームワークでは、 TestRunner.run()が返すTestResultインスタンスを参照し、テスト結果をレポートします。

以下の属性は、テストの実行結果を検査する際に使用することができます:

errors: TestCaseと例外のトレースバック情報をフォーマットした文字列の 2要素タプルからなるリスト。それぞれのタプルは予想外の例外を送出したテストに対応します。バージョン 2.2 で変更された仕様: sys.exc_info()の結果ではなく、フォーマットしたトレースバックを保存

failures: TestCaseと例外のトレースバック情報をフォーマットした文字列の 2要素タプルからなるリスト。それぞれのタプルはTestCase.fail*()や TestCase.assert*()メソッドを使って見つけ出した失敗に対応します。バージョン 2.2 で変更された仕様: sys.exc_info()の結果ではなく、フォーマットしたトレースバックを保存

testsRun: これまでに実行したテストの総数。

wasSuccessful( ): これまでに実行したテストが全て成功していればTrueを、それ以外ならFalseを返す。

stop( ): このメソッドを呼び出してTestResultのshouldStop属性にTrueをセットすることで、実行中のテストは中断しなければならないというシグナルを送ることができます。TestRunnerオブジェクトはこのフラグを尊重してそれ以上のテストを実行することなく復帰しなければなりません。
たとえばこの機能は、ユーザのキーボード割り込みを受け取ってTextTestRunnerクラスがテストフレームワークを停止させるのに使えます。TestRunnerの実装を提供する対話的なツールでも同じように使用することができます。

以下のメソッドは内部データ管理用のメソッドですが、対話的にテスト結果をレポートするテストツールを開発する場合などにはサブクラスで拡張することができます。

startTest( test): testを実行する直前に呼び出されます。
デフォルトの実装では単純にインスタンスのtestRunカウンタをインクリメントします。

stopTest( test): testの実行直後に、テスト結果に関わらず呼び出されます。
デフォルトの実装では何もしません。

addError( test, err): テストtest実行中に、想定外の例外が発生した場合に呼び出されます。 errはsys.exc_info()が返すタプル(type, value, traceback)です。
デフォルトの実装ではインスタンスのerrors属性に(test, err)を追加します。

addFailure( test, err): テストが失敗した場合に呼び出されます。errは sys.exc_info()が返すタプル(type, value, traceback)です。
デフォルトの実装ではインスタンスのfailures属性に(test, err)を追加します。

addSuccess( test): テストケースtestが成功した場合に呼び出されます。
デフォルトの実装では何もしません。

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