クラスベースのユニットテスト

matlab.unittest.TestCase クラスから継承するテストクラス内でユニットテストを作成することで、MATLAB^® ソースコードをテストできます。TestCase クラスは、MATLAB 内のすべてのテストクラスのスーパークラスであり、テストフィクスチャのセットアップルーチンや破棄ルーチンを含む、テスト内容を記述および識別するためのインターフェイスを提供します。

テストクラス定義ファイル内に Test メソッドとしてクラスベースのユニットテストを記述します。Test メソッドは、Test 属性をもつ methods ブロックで定義されたメソッドです。Test メソッドでは、値をテストしてエラーに対応するための検定を使用できます。TestCase サブクラスは、Test 属性に加えて、さまざまなフレームワーク固有の属性を活用して、テストおよびテストフィクスチャを指定できます。たとえば、TestMethodSetup および TestMethodTeardown メソッド属性を使用して、テストクラス内の各テストのセットアップコードおよび破棄コードを指定できます。

テストクラスの定義

クラスベースのテストを記述するには、まず matlab.unittest.TestCase クラスから派生するクラスを作成します。次に、テストクラス内で Test 属性をもつ methods ブロックにメソッドを追加して、ユニットテストを指定します。たとえば、MyTestClass クラスには 2 つのテスト (test1 と test2) が含まれています。Test メソッドへの最初の入力は TestCase オブジェクトでなければなりませんが、テストのロジックで必要ない場合は無視できます。Test メソッドに渡される TestCase オブジェクトは、対応するテストにテスト環境固有の情報を提供します。

さらに、MyTestClass クラスはフレームワーク固有のメソッド属性を使用して、setup メソッドと teardown メソッドを定義します。テストフレームワークでは、各テストの前と後に、これらのメソッドをそれぞれ実行します。テストクラスのセットアップコードおよび破棄コードの詳細については、クラスを使用するセットアップコードと破棄コードの記述を参照してください。

classdef MyTestClass < matlab.unittest.TestCase
    methods (TestMethodSetup)
        function setup(testCase)
            % Setup code
        end
    end

    methods (TestMethodTeardown)
        function teardown(testCase)
            % Teardown code
        end
    end

    methods (Test)
        function test1(testCase)
            % Test code
        end

        function test2(testCase)
            % Test code
        end
    end
end

ユニットテストには通常、値をテストしてエラーに対応するための検定が含まれます。たとえば、関数をテストする場合、Test メソッドでは関数の実際の戻り値と予期される戻り値を指定し、検定メソッドを使用してそれらの等価性をテストできます。説明のために、PlusTest テストクラスには、plus 関数をテストするための Test メソッドが含まれています。(実際には、テストクラスはユーザー定義のコードをテストします。)myTest メソッドは、verifyEqual 検定メソッドを呼び出して、plus(2,3) で予期される値 5 が生成されるかを検証します。独自のテストクラスを作成する際に、matlab.unittest.qualifications 名前空間内の検定ライブラリ全体にアクセスできます。使用する検定を決定するには、検証、アサーション、その他の検定の表を参照してください。

classdef PlusTest < matlab.unittest.TestCase
    methods (Test)
        function myTest(testCase)
            actual = plus(2,3);
            expected = 5;
            testCase.verifyEqual(actual,expected)
        end
    end
end

クラスベースのユニットテストを作成して実行する方法の簡単な例については、クラスを使用する単純なテストケースの記述を参照してください。

テストクラスの実行の仕組み

クラスベースのテスト (たとえば、results = runtests(["TestClassA" "TestClassB" "TestClassC"])) を実行すると、テストフレームワークはまず、共有テストフィクスチャに基づいてテストクラスをグループに分割します。(共有テストフィクスチャは、TestCase サブクラスの SharedTestFixtures 属性を使用して指定されたフィクスチャです。)各グループには、まったく同じ共有テストフィクスチャをもつテストクラスが含まれます。必要なセットアップアクションと破棄のアクションを最小限に抑えるために、フレームワークは、共有テストフィクスチャを 1 回セットアップおよび破棄することで、各グループ内のテストクラスを実行します。つまり、グループごとにフレームワークは以下を行います。

グループ内のテストクラスを実行する前に、共有テストフィクスチャを設定します。
グループ内の各テストクラスを実行します。
グループ内のすべてのテストクラスを実行した後、共有テストフィクスチャを破棄します。

次の図に、手順 2 でテストフレームワークが各テストクラスを実行する方法を示します。

フレームワークは、テストクラスを実行するときに次の手順に従います。

クラスレベルの TestCase オブジェクトを作成する — フレームワークはテストクラスのオブジェクトを作成します。
クラスレベルのセットアップコードを実行する — フレームワークは、クラスレベルの TestCase オブジェクトを使用して、TestClassSetup methods ブロックで指定されたクラスレベルのセットアップコードを実行します。クラスレベルの TestCase オブジェクトは、クラスレベルのセットアップコードの結果として更新された環境を反映します。
テストのループ:
1. メソッドレベルの TestCase オブジェクトを作成する — フレームワークは、クラスレベルのセットアップコードの実行後に環境を反映するクラスレベルの TestCase オブジェクトをコピーして、メソッドレベルの TestCase オブジェクトを作成します。次に、フレームワークはこのオブジェクトをテストクラスの TestMethodSetup、Test、および TestMethodTeardown メソッドに渡します。
  メモ
  テストが他のテストの環境に影響を与えないようにするために、異なる Test メソッドに渡される TestCase インスタンスは独立したコピーです。つまり、Test メソッド内のテストケースへの変更は、そのメソッドの範囲内にとどまり、テストクラス内の他の Test メソッドには伝播されません。
2. メソッドレベルのセットアップコードを実行する — フレームワークは、メソッドレベルの TestCase オブジェクトを使用して、TestMethodSetup methods ブロックで指定されたメソッドレベルのセットアップコードを実行します。メソッドレベルの TestCase オブジェクトは、メソッドレベルのセットアップコードの結果として更新された環境を反映します。
3. テストを実行する — フレームワークは、メソッドレベルの TestCase オブジェクトを使用して、テストに対応する Test メソッドを実行します。テストがパラメーター化されている場合、フレームワークはパラメーター化情報を使用してメソッドを実行します。
4. メソッドレベルの破棄コードを実行する — フレームワークは、メソッドレベルの TestCase オブジェクトを使用して、TestMethodSetup methods ブロックまたは TestMethodTeardown methods ブロック内の addTeardown メソッドの呼び出しを使用して指定されたメソッドレベルの破棄コードを実行します。
5. メソッドレベルの TestCase オブジェクトを削除する — フレームワークは、テストの実行に使用されたメソッドレベルの TestCase オブジェクトと、それに対応するメソッドレベルのセットアップコードおよび破棄コードを破棄します。
クラスレベルの破棄コードを実行する — フレームワークは、クラスレベルの TestCase オブジェクトを使用して、TestClassSetup methods ブロックまたは TestClassTeardown methods ブロック内の addTeardown メソッドの呼び出しを使用して指定されたクラスレベルの破棄コードを実行します。
クラスレベルの TestCase オブジェクトを削除する — フレームワークは、テストクラスでテストを実行するために使用されるクラスレベルの TestCase オブジェクトを破棄します。

メモ

キャッチされないエラーや検定エラーは、テスト実行ワークフローに影響を与える可能性があります。たとえば、TestClassSetup または TestClassTeardown methods ブロックで仮定エラーが発生した場合、テストフレームワークはテストクラス全体をフィルター処理済みとしてマークし、Test メソッドのループをスキップします。

テストの独立性と反復性

matlab.unittest.TestCase サブクラス内のユニットテストは、意図しない形で相互に影響を与えることなく、独立して実行する必要があります。また、反復可能である必要があり、テストの実行が同じテストの後続の再実行に影響してはなりません。テストの独立性と反復性を確保するには、テストクラスを作成する際に次のベストプラクティスに従います。

テスト環境をセットアップするためのコードをテストクラスに追加する場合は、対応するセットアップアクションの逆の順序で対称的に破棄アクションを実行することで環境を元の状態に復元するコードも含めます。
MATLAB 検索パスや出力表示形式などのグローバル状態にアクセスするには、既定のプロパティ値ではなくメソッドを使用します。
テストパラメーター値を指定するには、ハンドルオブジェクトではなく値オブジェクトを使用します。

詳細については、Write Independent and Repeatable Testsを参照してください。

クラスベースのテストの機能

クラスベースのテストでは、複数の高度なテストオーサリング機能が用意されており、MATLAB ユニットテストフレームワークのすべての機能にアクセスできます。たとえば、クラスベースのテストでは、制約、実際値のプロキシ、許容誤差、テスト診断などの高度な検定機能を使用できます。さらに、クラスベースのテストでは、以下ができます。

テストクラス間でフィクスチャを共有する。詳細については、共有フィクスチャを使用するテストの記述を参照してください。
テストをカテゴリ別にグループ化してから、指定されたタグを使用してテストを実行する。詳細については、ユニットテストのタグ付けを参照してください。
指定されたパラメーターのリストにあるテストを組み合わせて実行するパラメーター化テストを記述する。詳細については、クラスベースのテストでのパラメーターの使用を参照してください。
サブクラス化と継承を使用して、テスト内容の共有と再利用を行う。たとえば、サブクラスを派生させることにより、テストクラスに定義されたパラメーターとメソッドを再利用できます。詳細については、クラスの階層 — 概念を参照してください。

参考

クラス

matlab.unittest.TestCase

クラス ベースのユニット テスト

テスト クラスの定義

テスト クラスの実行の仕組み

テストの独立性と反復性

クラスベースのテストの機能

参考

クラス

トピック

クラスベースのユニットテスト

テストクラスの定義

テストクラスの実行の仕組み