23.3.2 テストの構成

単体テストの基礎となる構築要素は、テストケース -- セットアップと正しさのチェックを行う、独立したシナリオ -- です。unittestでは、テストケースはunittestモジュールのTestCaseクラスのインスタンスで示します。テストケースを作成するにはTestCaseのサブクラスを記述するか、またはFunctionTestCaseを使用します。

TestCaseから派生したクラスのインスタンスは、このオブジェクトだけで一件のテストと初期設定・終了処理を行います。

TestCaseインスタンスは外部から完全に独立し、単独で実行する事も、他の任意のテストと一緒に実行する事もできなければなりません。

以下のように、TestCaseのサブクラスはrunTest()をオーバライドし、必要なテスト処理を記述するだけで簡単に書くことができます:

import unittest

class DefaultWidgetSizeTestCase(unittest.TestCase):
    def runTest(self):
        widget = Widget('The widget')
        self.assertEqual(widget.size(), (50,50), 'incorrect default size')

何らかのテストを行う場合、ベースクラスTestCaseの assert*() か fail*()メソッドを使用してください。テストが失敗すると例外が送出され、unittestはテスト結果を failureとします。その他の例外はerrorとなります。これによりどこに問題があるかが判ります。failureは間違った結果 (6 になるはずが 5 だった)で発生します。errorは間違ったコード (たとえば間違った関数呼び出しによるTypeError)で発生します。

テストの実行方法については後述とし、まずはテストケースインスタンスの作成方法を示します。テストケースインスタンスは、以下のように引数なしでコンストラクタを呼び出して作成します。

testCase = DefaultWidgetSizeTestCase()

似たようなテストを数多く行う場合、同じ環境設定処理を何度も必要となります。例えば上記のようなWidgetのテストが100種類も必要な場合、それぞれのサブクラスでWidgetオブジェクトを生成する処理を記述するのは好ましくありません。

このような場合、初期化処理はsetUp()メソッドに切り出し、テスト実行時にテストフレームワークが自動的に実行するようにすることができます:

import unittest

class SimpleWidgetTestCase(unittest.TestCase):
    def setUp(self):
        self.widget = Widget('The widget')

class DefaultWidgetSizeTestCase(SimpleWidgetTestCase):
    def runTest(self):
        self.failUnless(self.widget.size() == (50,50),
                        'incorrect default size')

class WidgetResizeTestCase(SimpleWidgetTestCase):
    def runTest(self):
        self.widget.resize(100,150)
        self.failUnless(self.widget.size() == (100,150),
                        'wrong size after resize')

テスト中にsetUp()メソッドで例外が発生した場合、テストフレームワークはテストを実行することができないとみなし、runTest()を実行しません。

同様に、終了処理をtearDown()メソッドに記述すると、 runTest()メソッド終了後に実行されます:

import unittest

class SimpleWidgetTestCase(unittest.TestCase):
    def setUp(self):
        self.widget = Widget('The widget')

    def tearDown(self):
        self.widget.dispose()
        self.widget = None

setUp()が正常終了した場合、runTest()が成功したかどうかに従って tearDown()が実行されます。

JUnitでは、多数の小さなテストケースを同じテスト環境で実行する場合、全てのテストについてDefaultWidgetSizeTestCaseのような SimpleWidgetTestCaseのサブクラスを作成する必要があります。これは時間のかかる、うんざりする作業ですので、unittestではより簡単なメカニズムを用意しています:

import unittest

class WidgetTestCase(unittest.TestCase):
    def setUp(self):
        self.widget = Widget('The widget')

    def tearDown(self):
        self.widget.dispose()
        self.widget = None

    def testDefaultSize(self):
        self.failUnless(self.widget.size() == (50,50),
                        'incorrect default size')

    def testResize(self):
        self.widget.resize(100,150)
        self.failUnless(self.widget.size() == (100,150),
                        'wrong size after resize')

この例ではrunTest()がありませんが、二つのテストメソッドを定義しています。このクラスのインスタンスはtest*()メソッドのどちらか一方の実行と、self.widgetの生成・解放を行います。この場合、テストケースインスタンス生成時に、コンストラクタの引数として実行するメソッド名を指定します:

defaultSizeTestCase = WidgetTestCase('testDefaultSize')
resizeTestCase = WidgetTestCase('testResize')

unittestではテストスイートによってテストケースインスタンスをテスト対象の機能によってグループ化することができます。テストスイート は、unittestのTestSuiteクラスで作成します。

widgetTestSuite = unittest.TestSuite()
widgetTestSuite.addTest(WidgetTestCase('testDefaultSize'))
widgetTestSuite.addTest(WidgetTestCase('testResize'))

各テストモジュールで、テストケースを組み込んだテストスイートオブジェクトを作成する呼び出し可能オブジェクトを用意しておくと、テストの実行や参照が容易になります:

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

def suite():
    tests = ['testDefaultSize', 'testResize']

    return unittest.TestSuite(map(WidgetTestCase, tests))

一般的には、TestCaseのサブクラスには良く似た名前のテスト関数が複数定義されますので、unittestではテストスイートを作成して個々のテストで満たすプロセスを自動化するのに使う TestLoaderを用意しています。たとえば、

suite = unittest.TestLoader().loadTestsFromTestCase(WidgetTestCase)

はWidgetTestCase.testDefaultSize()とWidgetTestCase.testResize を走らせるテストスイートを作成します。 TestLoaderは自動的にテストメソッドを識別するのに'test'というメソッド名の接頭辞を使います。

いろいろなテストケースが実行される順序は、テスト関数名を組み込み関数cmp() でソートして決定されます。

システム全体のテストを行う場合など、テストスイートをさらにグループ化したい場合がありますが、このような場合、TestSuiteインスタンスには TestSuiteと同じようにTestSuiteを追加する事ができます。

suite1 = module1.TheTestSuite()
suite2 = module2.TheTestSuite()
alltests = unittest.TestSuite([suite1, suite2])

テストケースやテストスイートは (widget.py のような) テスト対象のモジュール内にも記述できますが、テストは (test_widget.py のような) 独立したモジュールに置いた方が以下のような点で有利です: