関数ベースのユニットテストの記述

テスト関数の作成

テスト関数は、メイン関数と個々のローカルテスト関数を含む単一の MATLAB^® ファイルです。必要に応じて、ファイルフィクスチャ関数およびフレッシュフィクスチャ関数を含めることができます。"ファイルフィクスチャ" は、ファイル内のすべてのテストで共有されるセットアップ関数と破棄関数から構成されます。これらの関数は、テストファイルごとに 1 回ずつ実行されます。"フレッシュフィクスチャ" は、各ローカルテスト関数の前後で実行されるセットアップ関数と破棄関数から構成されます。

メイン関数の作成

メイン関数は、すべてのローカルテスト関数を 1 つのテスト配列に収集します。メイン関数の名前はテストファイル名に対応し、先頭または末尾が 'test' という語 (大文字小文字は区別されない) でなければなりません。テストファイル名の先頭または末尾が 'test' という語でない場合、特定の状況でファイル内のテストが無視されることがあります。このサンプルケースの場合、MATLAB ファイルは exampleTest.m です。メイン関数は、functiontests を呼び出してテスト配列 tests を生成する必要があります。localfunctions を functiontests への入力として使用して、ファイル内のすべてのローカル関数への関数ハンドルの cell 配列が自動的に生成されるようにします。以下は、一般的なメイン関数です。

function tests = exampleTest
tests = functiontests(localfunctions);
end

ローカルテスト関数の作成

個々のテスト関数は、メイン (テスト生成) 関数と同じ MATLAB ファイルにローカル関数として含まれます。これらのテスト関数の名前は、先頭または最後に「test」という単語 (大文字小文字の区別なし) が付いていなければなりません。それぞれのローカルテスト関数は、関数テストケースオブジェクト testCase である単一の入力を受け入れる必要があります。テストフレームワークが自動的にこのオブジェクトを生成します。テスト関数の作成方法の詳細は、関数を使用する単純なテストケースの記述および検証、アサーション、その他の検定の表を参照してください。以下は、スケルトンのローカルテスト関数の典型的な例です。

function testFunctionOne(testCase)
% Test specific code
end

function testFunctionTwo(testCase)
% Test specific code
end

オプションのフィクスチャ関数の作成

セットアップコードおよび破棄コードは、テストフィクスチャ関数とも呼ばれ、システムのテスト前の状態をセットアップし、テストの実行後にシステムを元の状態に戻します。テストフィクスチャ関数には次の 2 種類があります。テストファイルごとに 1 回実行されるファイルフィクスチャ関数と、各ローカルテスト関数の前後に実行されるフレッシュフィクスチャ関数です。これらの関数はテストの生成には必須ではありません。一般的に、ユニットテストのカプセル化を促進するため、ファイルフィクスチャよりもフレッシュフィクスチャを使用することをお勧めします。

関数テストケースオブジェクト testCase は、ファイルフィクスチャ関数およびフレッシュフィクスチャ関数への唯一の入力でなければなりません。テストフレームワークが自動的にこのオブジェクトを生成します。TestCase オブジェクトは、セットアップ関数、テスト関数および破棄関数の間で情報を渡すための手段です。TestData プロパティは、既定では struct であるため、フィールドおよびデータを簡単に追加できます。一般的に、このテストデータはパスおよびグラフィックスハンドルなどに使用されます。TestData プロパティの使用例は、セットアップ関数と破棄関数を使用したテストの記述を参照してください。

ファイルフィクスチャ関数. ファイルフィクスチャ関数を使用して、ファイル内のすべてのテストでセットアップ関数と破棄関数を共有することができます。ファイルフィクスチャ関数の名前は、それぞれ、setupOnce および teardownOnce でなければなりません。これらの関数は、ファイルごとに 1 回実行されます。ファイルフィクスチャを使用して、テスト前にパスを設定し、テスト後に元のパスにリセットします。以下は、スケルトンのファイルフィクスチャセットアップコードと破棄コードの典型的な例です。

function setupOnce(testCase)  % do not change function name
% set a new path, for example
end

function teardownOnce(testCase)  % do not change function name
% change back to original path, for example
end

フレッシュフィクスチャ関数. フレッシュフィクスチャ関数を使用して、各ローカルテスト関数の状態をセットアップおよび破棄することができます。フレッシュフィクスチャ関数の名前は、それぞれ、setup および teardown でなければなりません。フレッシュフィクスチャを使用して、テスト前に新しい Figure を取得し、テスト後に Figure を閉じることができます。以下は、スケルトンのテスト関数レベルのセットアップコードと破棄コードの典型的な例です。

function setup(testCase)  % do not change function name
% open a figure, for example
end

function teardown(testCase)  % do not change function name
% close figure, for example
end

プログラムコードテンプレート

%% Main function to generate tests
function tests = exampleTest
tests = functiontests(localfunctions);
end

%% Test Functions
function testFunctionOne(testCase)
% Test specific code
end

function testFunctionTwo(testCase)
% Test specific code
end

%% Optional file fixtures  
function setupOnce(testCase)  % do not change function name
% set a new path, for example
end

function teardownOnce(testCase)  % do not change function name
% change back to original path, for example
end

%% Optional fresh fixtures  
function setup(testCase)  % do not change function name
% open a figure, for example
end

function teardown(testCase)  % do not change function name
% close figure, for example
end

テストの実行

関数ベースのテストを実行すると、テストフレームワークが以下のタスクを実行します。

ローカルテスト関数で指定されたテストの配列を作成する。
関数 setupOnce が指定されている場合は、その関数を実行してシステムのテスト前の状態を設定する。
各テストについて、対応するローカルテスト関数を実行する。関数 setup が指定されている場合は、その関数を実行してからローカルテスト関数を実行する。関数 teardown が指定されている場合は、ローカルテスト関数の実行後にその関数を実行する。
関数 teardownOnce が指定されている場合は、その関数を実行して、システムをテスト前の状態から元の状態に戻す。

Workflow for running function-based tests