TestRunner を拡張するためのプラグインの書き込み

カスタムプラグインの概要

TestRunnerPlugin メソッドには、テストセッション、テストスイート、テストクラス、テストの 4 つのレベルがあります。各レベルで、テストの実行を拡張するメソッドを実装します。さらに、テストスイート、テストクラス、テストの各レベルで、テストまたはテストフィクスチャの作成、セットアップ、破棄を拡張するメソッドを実装します。

テストスイート、テストクラス、テストの各レベルでは、reportFinalizedResult メソッドを使うと、確定したテスト結果を TestRunner によってレポートできるようになります。テスト結果は、残りのテスト内容でそれ以上結果が変更されなくなると確定します。TestRunner は、各レベルで reportFinalizedResult メソッドを呼び出すかどうかを決定します。テストセッションレベルでは、テストスイートが確定すると、reportFinalizedSuite メソッドによって TestRunner がテスト結果をレポートできるようになります。

TestRunner は、さまざまなメソッドを次の図のように実行します。

TestRunnerPlugin methods organized into the test session, test suite, test class, and test levels

作成メソッドは、TestRunnerPlugin メソッド内で、出力引数を使用する唯一のセットです。通常、対応するレベルのテスト内容からのさまざまなイベントをリスニングするために作成メソッドを拡張します。 TestCase と Fixture のどちらのインスタンスも handle クラスから継承するので、addlistener メソッドを使用してリスナーを追加します。テスト内容のセットアップ、実行、破棄を行うメソッドは、TestRunner がテスト内容を評価する方法を拡張します。

テストセッションレベルのプラグインメソッドの拡張

テストセッションレベルの TestRunnerPlugin メソッドは、TestRunner に渡されるテストスイートの実行とレポートを拡張します。これらのメソッドは、runSession メソッドのスコープに入ります。

このレベルの実行メソッド runTestSuite は、テストフレームワークが TestRunner に渡す配列 TestSuite 全体の一部の実行を拡張します。reportFinalizedSuite メソッドは、runTestSuite によって確定されたテストスイートのレポートを拡張します。

テストスイートレベルプラグインメソッドの拡張

テストスイートレベルの TestRunnerPlugin メソッドは、共有テストフィクスチャの作成、セットアップ、実行、および破棄を拡張します。これらのメソッドは、runTestSuite メソッドのスコープに入ります。

メソッドのタイプ	テストレベルの範囲: `runTestSuite`
作成メソッド	`createSharedTestFixture`
セットアップメソッド	`setupSharedTestFixture`
実行メソッド	`runTestClass`
破棄メソッド	`teardownSharedTestFixture`

このレベルでは、createSharedTestFixture メソッドは出力引数を使用する唯一のプラグインメソッドです。これは、テストクラスが必要とする共有フィクスチャごとに Fixture インスタンスを返します。これらのフィクスチャのインスタンスは、TestCase の getSharedTestFixtures メソッドからテストできます。

このレベルの実行メソッド runTestClass は、同じテストクラスまたは同じ関数ベースのテストに属するテストの実行を拡張し、テストレベルのプラグインメソッドとして記述された機能を組み込みます。

テストクラスレベルプラグインメソッドの拡張

テストクラスレベルの TestRunnerPlugin メソッドは、同じテストクラスまたは同じ関数ベースのテストに属するテストスイート要素の作成、セットアップ、実行、および破棄を拡張します。これらのメソッドは、TestRunner が実行する配列 TestSuite 全体のサブセットに適用されます。

メソッドのタイプ	テストレベルの範囲: `runTestClass`
作成メソッド	`createTestClassInstance`
セットアップメソッド	`setupTestClass`
実行メソッド	`runTest`
破棄メソッド	`teardownTestClass`

このレベルでは、createTestClassInstance メソッドは出力引数を使用する唯一のプラグインメソッドです。これは、クラスレベルで作成された TestCase インスタンスを返します。それぞれのクラスで、テストフレームワークはインスタンスを属性 TestClassSetup または TestClassTeardown をもつ任意のメソッドに渡します。

属性 ClassSetupParameter をもつプロパティがある場合は、テストクラスのセットアップはパラメーター化されます。この場合、テストフレームワークは、クラスセットアップのパラメーター化が決定する回数に応じて setupTestClass メソッドと teardownTestClass メソッドを評価します。

このレベルの実行メソッド runTest は、1 つの TestSuite 要素の実行を拡張し、テストレベルのプラグインメソッドとして記述された機能を組み込みます。

テストフレームワークは、runTestClass メソッドのスコープ内のテストクラスレベルでメソッドを評価します。TestClassSetup コードが正常に終了すると、runTest メソッドが配列 TestSuite の各要素につき 1 回呼び出されます。それぞれの TestClassSetup パラメーター化は、作成、セットアップおよび破棄メソッドを 1 回呼び出します。

テストレベルのプラグインメソッドの拡張

テストレベルの TestRunnerPlugin メソッドは、1 つのテストスイート要素の作成、セットアップ、実行、および破棄を拡張します。1 つの Test 要素は 1 つのテストメソッドで構成されるか、または、テストがパラメーター化されている場合は、テストのパラメーター化の 1 つのインスタンスで構成されます。

メソッドのタイプ	テストレベルの範囲: `runTest`
作成メソッド	`createTestMethodInstance`
セットアップメソッド	`setupTestMethod`
実行メソッド	`runTestMethod`
破棄メソッド	`teardownTestMethod`

このレベルでは、createTestMethodInstance メソッドは出力引数を使用する唯一のプラグインメソッドです。これは、Test 要素ごとに作成された TestCase インスタンスを返します。テストフレームワークは、これらのインスタンスそれぞれを、対応する Test メソッドおよび属性 TestMethodSetup または TestMethodTeardown をもつ任意のメソッドに渡します。

テストフレームワークは、runTest メソッドのスコープ内のテストレベルでメソッドを評価します。フレームワークがすべての TestMethodSetup 作業を終了すると、このレベルのプラグインメソッドを Test 要素につき 1 回呼び出します。

参考