アプリテストフレームワークの概要

MATLAB^® アプリテストフレームワークを使用し、App Designer のアプリや関数 uifigure を用いてプログラムによってビルドしたアプリをテストします。アプリテストフレームワークでは、ボタン押下やスライダーのドラッグなどの UI コンポーネント上での動作をプログラムから実行するテストクラスの作成、およびアプリの動作検証を行うことができます。

アプリのテスト

テストの作成 – クラスベースのテストでは、matlab.uitest.TestCase をサブクラス化することによってアプリテストフレームワークを使用できます。matlab.uitest.TestCase は matlab.unittest.TestCase のサブクラスであるため、検定、フィクスチャ、およびプラグインなどのユニットテストフレームワークの機能にテストがアクセスすることができます。コマンドプロンプトでアプリテストフレームワークを試すには、matlab.uitest.TestCase.forInteractiveUse を使用してテストケースインスタンスを作成します。

テストの内容 – 通常、アプリのテストでは matlab.uitest.TestCase の press、type などの動作メソッドを使用してアプリコンポーネントをプログラム的に操作してから、その結果の検定を実行します。たとえば、チェックボックスを 1 つクリックし、その他のチェックボックスが無効になることを検証するテストなどがあります。あるいは、テキストボックスに数値を入力し、アプリでその結果が正しく計算されることを検証するテストもあります。このタイプのテストでは、テストするアプリのプロパティを理解している必要があります。ボタン押下を検証するには、MATLAB がアプリオブジェクトのどこにボタンのステータスを格納するかを把握していなければなりません。計算の結果を検証するには、アプリ内の結果にアクセスする方法を把握していなければなりません。

テストのクリーンアップ – ベストプラクティスとしては、テストの後にアプリを削除する破棄アクションを含めます。通常、テストメソッドは matlab.unittest.TestCase の addTeardown メソッドを使用してこのアクションを追加します。

アプリのロック – アプリテストで Figure が作成されると、フレームワークはコンポーネントと外部の相互作用を防ぐためにその Figure を直ちにロックします。コマンドプロンプトで試すために matlab.uitest.TestCase.forInteractiveUse のインスタンスを作成する場合、アプリテストフレームワークは UI コンポーネントをロックしません。

デバッグの目的で Figure のロックを解除するには、関数 matlab.uitest.unlock を使用します。

警告の消去 – 場合によっては、アプリによってモーダル警告ダイアログボックスが表示され、アプリコンポーネントを操作できなくなります。ダイアログボックスの背後にある Figure にアクセスするには、このダイアログボックスを閉じなければならない場合があります。Figure ウィンドウで警告ダイアログボックスをプログラムにより閉じるには、dismissAlertDialog メソッドを使用します。

UI コンポーネントの動作のサポート

matlab.uitest.TestCase の動作メソッドはさまざまな UI コンポーネントをサポートしています。

コンポーネント	一般的な作成関数	`matlab.uitest.TestCase` の動作メソッド
コンポーネント	一般的な作成関数	`press`	`choose`	`drag`	`type`	`hover`	`chooseContextMenu`
座標軸	`axes`	✔		✔		✔	✔
ボタン	`uibutton`	✔					✔
ボタングループ	`uibuttongroup`		✔
チェックボックス	`uicheckbox`	✔	✔				✔
日付ピッカー	`uidatepicker`				✔		✔
離散型ノブ	`uiknob`		✔				✔
ドロップダウン	`uidropdown`		✔		✔		✔
編集フィールド (数値、テキスト)	`uieditfield`				✔		✔
イメージ	`uiimage`	✔					✔
ノブ	`uiknob`		✔	✔			✔
リストボックス	`uilistbox`		✔				✔
メニュー	`uimenu`	✔
パネル	`uipanel`	✔				✔	✔
極座標軸	`polaraxes`	✔				✔	✔
プッシュツール	`uipushtool`	✔
ラジオボタン	`uiradiobutton`	✔	✔				✔
スライダー	`uislider`		✔	✔			✔
スピナー	`uispinner`	✔			✔		✔
状態ボタン	`uibutton`	✔	✔				✔
スイッチ (ロッカー、スライダー、トグル)	`uiswitch`	✔	✔				✔
タブ	`uitab`		✔
タブグループ	`uitabgroup`		✔
テーブル	`uitable`		✔		✔		✔
テキストエリア	`uitextarea`				✔		✔
トグルボタン	`uitogglebutton`	✔	✔				✔
トグルツール	`uitoggletool`	✔	✔
ツリーノード	`uitreenode`		✔				✔
UI 座標軸	`uiaxes`	✔		✔		✔	✔
UI Figure	`uifigure`	✔				✔	✔

アプリ用テストの記述

この例では、プロットのサンプルサイズとカラーマップを変更するオプションをもつアプリ用テストの記述方法を説明します。プログラムによりアプリを操作して結果を検定するには、アプリテストフレームワークとユニットテストフレームワークを組み合わせて使用します。

コマンドプロンプトで、アプリを含むフォルダーを MATLAB 検索パスに追加して、アプリにアクセスできるようにします。

addpath(fullfile(matlabroot,'examples','matlab','main'))

テスト前にこのアプリのプロパティを確認するには、コマンドプロンプトでアプリのインスタンスを作成します。

app = ConfigurePlotAppExample;

この手順はテストには必要ありませんが、アプリテストで使用されるプロパティを確認しておくと役に立ちます。たとえば、アプリオブジェクト内の [Update Plot] ボタンにアクセスするには app.UpdatePlotButton を使用します。

matlab.uitest.TestCase から継承するテストクラスを作成します。

classdef testConfigurePlotAppExample < matlab.uitest.TestCase
    
    methods (Test)

    end
    
end

サンプルサイズをテストするテストメソッド test_SampleSize を作成します。このテストメソッドは、サンプルサイズを変更し、プロットを更新して、表面が指定のサンプルサイズを使用していることを検証します。addTeardown の呼び出しは、テストの完了後にアプリを削除します。

classdef testConfigurePlotAppExample < matlab.uitest.TestCase
    
    methods (Test)
        function test_SampleSize(testCase)
            app = ConfigurePlotAppExample;
            testCase.addTeardown(@delete,app);
            
            testCase.type(app.SampleSizeEditField,12);
            testCase.press(app.UpdatePlotButton);
            
            ax = app.UIAxes;
            surfaceObj = ax.Children;
            testCase.verifySize(surfaceObj.ZData,[12 12]);
        end
    end
    
end

カラーマップをテストする 2 番目のテストメソッド test_Colormap を作成します。このテストメソッドは、カラーマップを選択し、プロットを更新して、プロットが指定のカラーマップを使用していることを検証します。以下に完全なコードを示します。

classdef testConfigurePlotAppExample < matlab.uitest.TestCase
    
    methods (Test)
        function test_SampleSize(testCase)
            app = ConfigurePlotAppExample;
            testCase.addTeardown(@delete,app);
            
            testCase.type(app.SampleSizeEditField,12);
            testCase.press(app.UpdatePlotButton);
            
            ax = app.UIAxes;
            surfaceObj = ax.Children;
            testCase.verifySize(surfaceObj.ZData,[12 12]);
        end
        
        function test_Colormap(testCase)
            app = ConfigurePlotAppExample;
            testCase.addTeardown(@delete,app);
            
            testCase.choose(app.ColormapDropDown,'Winter');
            testCase.press(app.UpdatePlotButton);
            
            expectedMap = winter;
            ax = app.UIAxes;
            testCase.verifyEqual(ax.Colormap,expectedMap);
        end
    end
    
end

コマンドプロンプトで、テストを実行します。

results = runtests('testConfigurePlotAppExample')

Running testConfigurePlotAppExample
..
Done testConfigurePlotAppExample
__________


results = 

  1×2 TestResult array with properties:

    Name
    Passed
    Failed
    Incomplete
    Duration
    Details

Totals:
   2 Passed, 0 Failed, 0 Incomplete.
   5.0835 seconds testing time.