23.3.4 クラスと関数

クラス TestCase( [methodName])

TestCaseクラスのインスタンスは、unittestの世界におけるテストの最小実行単位を示します。このクラスをベースクラスとして使用し、必要なテストを具象サブクラスに実装します。TestCaseクラスでは、テストランナーがテストを実行するためのインターフェースと、各種のチェックやテスト失敗をレポートするためのメソッドを実装しています。

それぞれのTestCaseクラスのインスタンスはただ一つのテストメソッド、 methodNameという名のメソッドを実行します。既に次のような例を扱ったことを憶えているでしょうか。

  def suite():
      suite = unittest.TestSuite()
      suite.addTest(WidgetTestCase('testDefaultSize'))
      suite.addTest(WidgetTestCase('testResize'))
      return suite

ここでは、それぞれが一つずつのテストを実行するようなWidgetTestCaseの二つのインスタンスを作成しています。

methodNameのデフォルトは'runTest'です。

クラス FunctionTestCase( testFunc[, setUp[, tearDown[, description]]]): このクラスではTestCaseインターフェースの内、テストランナーがテストを実行するためのインターフェースだけを実装しており、テスト結果のチェックやレポートに関するメソッドは実装していません。既存のテストコードをunittestによるテストフレームワークに組み込むために使用します。

クラス TestSuite( [tests]): このクラスは、個々のテストケースやテストスイートの集約を示します。通常のテストケースと同じようにテストランナーで実行するためのインタフェースを備えています。TestSuiteインスタンスを実行することはスイートの繰り返しを使って個々のテストを実行することと同じです。
引数testsが与えられるならば、それはテストケースに亘る繰り返し可能オブジェクトまたは内部でスイートを組み立てるための他のテストスイートでなければなりません。後からテストケースやスイートをコレクションに付け加えるためのメソッドも提供されています。

クラス TestLoader( ): モジュールまたはTestCaseクラスから、指定した条件に従ってテストをロードし、TestSuiteにラップして返します。このクラスは与えられたモジュールまたはTestCaseのサブクラスの中から全てのテストをロードできます。

クラス TestResult( ): このクラスはどのテストが成功しどのテストが失敗したかの情報を集積するのに使います。

defaultTestLoader: TestLoaderのインスタンスで、共用することが目的です。 TestLoaderをカスタマイズする必要がなければ、新しい TestLoaderオブジェクトを作らずにこのインスタンスを使用します。

クラス TextTestRunner( [stream[, descriptions[, verbosity]]]): 実行結果を標準エラーに出力する、単純なテストランナー。いくつかの設定項目がありますが、非常に単純です。グラフィカルなテスト実行アプリケーションでは、独自のテストランナーを作成してください。

main( [module[, defaultTest[, argv[, testRunner[, testRunner]]]]])

テストを実行するためのコマンドラインプログラム。この関数を使えば、簡単に実行可能なテストモジュールを作成する事ができます。一番簡単なこの関数の使い方は、以下の行をテストスクリプトの最後に置くことです。

if __name__ == '__main__':
    unittest.main()

場合によっては、doctest モジュールを使って書かれた既存のテストがあります。その場合、モジュールは既存のdoctestに基づいたテストコードから unittest.TestSuite インスタンスを自動的に構築できる DocTestSuite クラスを提供します。バージョン 2.3 で新たに追加された仕様です。

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