selectIf

クラス: matlab.unittest.TestSuite
名前空間: matlab.unittest

条件を満たすテストスイート要素を選択する

構文

filteredSuite = selectIf(suite,selector)

filteredSuite = selectIf(suite,Name,Value)

説明

filteredSuite = selectIf(suite,selector) は、指定されたテストスイートから、指定されたセレクターで設定されている条件を満たす要素を選択します。このメソッドは、選択された要素をフィルター処理された TestSuite 配列として返します。

例

filteredSuite = selectIf(suite,Name,Value) は、1 つ以上の名前と値の引数で指定されたオプションを使用してテストスイートをフィルター処理します。たとえば、filteredSuite = selectIf(suite,"Name","featureA_*") は、名前が "featureA_" で始まる suite の要素を選択します。

例

入力引数

すべて展開する

`suite` — テストスイート
`matlab.unittest.TestSuite` 配列

テストスイート。matlab.unittest.TestSuite 配列として指定します。

`selector` — セレクター
`matlab.unittest.selectors.Selector` オブジェクト

セレクター。matlab.unittest.selectors.Selector オブジェクトとして指定します。

例: matlab.unittest.selectors.HasTag

名前と値の引数

すべて展開する

オプションの引数のペアを Name1=Value1,...,NameN=ValueN として指定します。ここで、Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後に指定しなければなりませんが、ペアの順序は重要ではありません。

例: filteredSuite = selectIf(suite,Name="featureA_*")

R2021a より前では、コンマを使用して名前と値をそれぞれ区切り、Name を引用符で囲みます。

例: filteredSuite = selectIf(suite,"Name","featureA_*")

`BaseFolder` — ベースフォルダー名
string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

テストファイルを含むベースフォルダーの名前。string 配列、文字ベクトル、または文字ベクトルの cell 配列として指定します。この引数はテストスイートをフィルター処理します。テストフレームワークがフィルター処理されたスイートにテストを含めるためには、Test 要素が BaseFolder によって指定されたベースフォルダーの 1 つに含まれていなければなりません。Test 要素がいずれもベースフォルダーと一致しない場合、空のテストスイートが返されます。ワイルドカード文字 (*) を使用すると任意の数の文字と一致します。疑問符 (?) を使用すると単一の文字と一致します。

名前空間で定義したテストファイルでは、ベースフォルダーは最上位の名前空間フォルダーの親です。

`DependsOn` — ソースコードが含まれるファイルおよびフォルダーの名前
string ベクトル | 文字ベクトル | 文字ベクトルの cell ベクトル

ソースコードが含まれているファイルおよびフォルダーの名前。string ベクトル、文字ベクトル、または文字ベクトルの cell ベクトルとして指定します。この引数は、指定されたソースコードに依存するテストのみを含めてテストスイートをフィルター処理します。いずれのテストもソースコードに依存していない場合は、空のテストスイートが返されます。

指定する値は、1 つ以上の既存のファイルを表している必要があります。フォルダーを指定した場合は、そのフォルダー内のファイルのパスがフレームワークで抽出されます。

DependsOn を使用するには、MATLAB^® Test™ のライセンスが必要です。ソースコードの依存関係によるテストの選択の詳細については、matlabtest.selectors.DependsOn (MATLAB Test) を参照してください。

例: DependsOn=["myFile.m" "myFolder"]

例: DependsOn=["folderA" "C:\work\folderB"]

`Name` — テストの名前
string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

テストの名前。string 配列、文字ベクトル、または文字ベクトルの cell 配列として指定します。この引数はテストスイートをフィルター処理します。テストフレームワークがフィルター処理されたスイートにテストを含めるためには、Test 要素の Name プロパティが Name によって指定された名前の 1 つと一致しなければなりません。Test 要素がいずれも一致する名前をもたない場合、空のテストスイートが返されます。ワイルドカード文字 (*) を使用すると任意の数の文字と一致します。疑問符 (?) を使用すると単一の文字と一致します。

特定のテストファイルにおいて、テストの名前はテスト内容のうち実行可能な最小部分を一意に識別します。テストの名前には、名前空間名、ファイル名 (拡張子を除く)、プロシージャ名、およびパラメーター化に関する情報が含まれます。

`ParameterProperty` — パラメーター化プロパティ名
string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

テストで使用されるパラメーターを定義するテストクラスプロパティの名前。string 配列、文字ベクトル、または文字ベクトルの cell 配列として指定します。この引数はテストスイートをフィルター処理します。テストフレームワークがフィルター処理されたスイートにテストを含めるためには、Test 要素の Parameterization プロパティに ParameterProperty で指定されたプロパティ名が少なくとも 1 つ含まれていなければなりません。Test 要素がいずれも一致するプロパティ名をもたない場合、空のテストスイートが返されます。ワイルドカード文字 (*) を使用すると任意の数の文字と一致します。疑問符 (?) を使用すると単一の文字と一致します。

`ParameterName` — パラメーター名
string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

テストで使用されるパラメーターの名前。string 配列、文字ベクトル、または文字ベクトルの cell 配列として指定します。MATLAB は、パラメーターを定義するテストクラスプロパティに基づいてパラメーター名を生成します。以下に例を示します。

プロパティ値が cell 配列である場合、MATLAB は、cell 配列の要素の値、型、および次元を考慮して、それらの要素からパラメーター名を生成します。
プロパティ値が構造体である場合、MATLAB はパラメーター名を構造体フィールドから生成します。

引数 ParameterName はテストスイートをフィルター処理します。テストフレームワークがフィルター処理されたスイートにテストを含めるためには、Test 要素の Parameterization プロパティに ParameterName によって指定されたパラメーター名が少なくとも 1 つ含まれていなければなりません。Test 要素がいずれも一致するパラメーター名をもたない場合、空のテストスイートが返されます。ワイルドカード文字 (*) を使用すると任意の数の文字と一致します。疑問符 (?) を使用すると単一の文字と一致します。

`ProcedureName` — テストプロシージャの名前
string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

テストプロシージャの名前。string 配列、文字ベクトルまたは文字ベクトルの cell 配列として指定します。この引数はテストスイートをフィルター処理します。テストフレームワークがフィルター処理されたスイートにテストを含めるためには、Test 要素の ProcedureName プロパティが ProcedureName によって指定されたプロシージャ名の 1 つと一致しなければなりません。Test 要素がいずれも一致するプロシージャ名をもたない場合、空のテストスイートが返されます。ワイルドカード文字 (*) を使用すると任意の数の文字と一致します。疑問符 (?) を使用すると単一の文字と一致します。

クラスベースのテストでは、テストプロシージャの名前はテストを含む Test メソッドの名前です。関数ベースのテストでは、テストを含むローカル関数の名前です。スクリプトベースのテストでは、テストセクションタイトルから生成された名前です。テストスイート要素の名前と異なり、テストプロシージャの名前には名前空間名、ファイル名、パラメーター化に関する情報は含まれません。

`Superclass` — テストクラスの派生元であるクラスの名前
string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

テストクラスの派生元であるクラスの名前。string 配列、文字ベクトル、または文字ベクトルの cell 配列として指定します。この引数はテストスイートをフィルター処理します。テストフレームワークがフィルター処理されたスイートにテストを含めるためには、Test 要素の TestClass プロパティが Superclass によって指定されたクラスの 1 つから派生するテストクラスを指していなければなりません。Test 要素がいずれもクラスに一致しない場合、空のテストスイートが返されます。

`Tag` — タグの名前
string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

テストで使用されるタグの名前。string 配列、文字ベクトル、または文字ベクトルの cell 配列として指定します。この引数はテストスイートをフィルター処理します。テストフレームワークがフィルター処理されたスイートにテストを含めるためには、Test 要素の Tags プロパティに Tag によって指定されたタグ名が少なくとも 1 つ含まれていなければなりません。Test 要素がいずれも一致するタグ名をもたない場合、空のテストスイートが返されます。ワイルドカード文字 (*) を使用すると任意の数の文字と一致します。疑問符 (?) を使用すると単一の文字と一致します。

属性

Sealed true

メソッドの属性の詳細については、メソッドの属性を参照してください。

例

すべて展開する

テストスイートのフィルター処理

selectIf メソッドを使用してテストスイートをフィルター処理します。

現在のフォルダー内の FeatureTest.m という名前のファイルで、共有テストフィクスチャを使用するテストを含む FeatureTest クラスを作成します。テストコードを簡略化するために、このテストクラスでは、実装していないテスト用のプレースホルダーとして無条件テストエラーを使用しています。

classdef (SharedTestFixtures={ ...
        matlab.unittest.fixtures.SuppressedWarningsFixture( ...
        "MATLAB:rmpath:DirNotFound")}) ...
        FeatureTest < matlab.unittest.TestCase
    methods (Test)
        function testA(testCase)
            testCase.verifyFail("Implement the test.")
        end
        function testB(testCase)
            testCase.verifyFail("Implement the test.")
        end
        function testC(testCase)
            testCase.verifyFail("Implement the test.")
        end
    end
end

この例で使用するクラスをインポートします。

import matlab.unittest.selectors.HasName
import matlab.unittest.constraints.ContainsSubstring
import matlab.unittest.constraints.EndsWithSubstring
import matlab.unittest.selectors.HasSharedTestFixture
import matlab.unittest.fixtures.SuppressedWarningsFixture

FeatureTest クラスからテストスイートを作成し、テスト名を表示します。スイートには 3 つの Test 要素が含まれています。

suite = testsuite("FeatureTest");
disp({suite.Name}')

    {'FeatureTest/testA'}
    {'FeatureTest/testB'}
    {'FeatureTest/testC'}

名前に大文字と小文字を区別しないテキスト "TA" を含むテストを選択して、フィルター処理されたテストスイートを作成します。

suite1 = selectIf(suite,HasName(ContainsSubstring("TA","IgnoringCase",true)));
disp({suite1.Name}')

    {'FeatureTest/testA'}

名前に "A" または "B" を含むテストを選択して、フィルター処理されたテストスイートを作成します。

suite2 = selectIf(suite,"Name",["*A*" "*B*"]);
disp({suite2.Name}')

    {'FeatureTest/testA'}
    {'FeatureTest/testB'}

指定した共有テストフィクスチャを使用するテストで、名前が "C" で終わらないテストのフィルター処理されたスイートを作成します。指定したフィクスチャはすべてのテストで使用されていますが、"testC" は名前の制約を満たさないためスイートから除外されます。

suite3 = suite.selectIf(~HasName(EndsWithSubstring("C")) &  ...
    HasSharedTestFixture(SuppressedWarningsFixture( ...
    "MATLAB:rmpath:DirNotFound")));
disp({suite3.Name}')

    {'FeatureTest/testA'}
    {'FeatureTest/testB'}

パラメーター化に基づくテストの選択

パラメーター化に基づいてテストを選択して、フィルター処理されたテストスイートを作成します。

現在のフォルダー内の ZerosTest.m という名前のファイルに、関数 zeros をテストする ZerosTest クラスを作成します。クラスには 2 つのパラメーター化された Test メソッド testClass と testSize があります。

classdef ZerosTest < matlab.unittest.TestCase
    properties (TestParameter)
        type = {'single','double','uint16'};
        size = struct("s2d",[3 3],"s3d",[2 5 4]);
    end
    
    methods (Test)
        function testClass(testCase,size,type)
            testCase.verifyClass(zeros(size,type),type)
        end
        
        function testSize(testCase,size)
            testCase.verifySize(zeros(size),size)
        end
        
        function testDefaultClass(testCase)
            testCase.verifyClass(zeros,"double")
        end

        function testDefaultSize(testCase)
            testCase.verifySize(zeros,[1 1])
        end
        
        function testDefaultValue(testCase)
            testCase.verifyEqual(zeros,0)
        end
    end
end

HasParameter クラスをインポートします。

import matlab.unittest.selectors.HasParameter

ZerosTest クラスからテストスイートを作成し、テスト名を表示します。スイートには 11 個の Test 要素が含まれています。

suite = testsuite("ZerosTest");
disp({suite.Name}')

    {'ZerosTest/testClass(size=s2d,type=single)'}
    {'ZerosTest/testClass(size=s2d,type=double)'}
    {'ZerosTest/testClass(size=s2d,type=uint16)'}
    {'ZerosTest/testClass(size=s3d,type=single)'}
    {'ZerosTest/testClass(size=s3d,type=double)'}
    {'ZerosTest/testClass(size=s3d,type=uint16)'}
    {'ZerosTest/testSize(size=s2d)'             }
    {'ZerosTest/testSize(size=s3d)'             }
    {'ZerosTest/testDefaultClass'               }
    {'ZerosTest/testDefaultSize'                }
    {'ZerosTest/testDefaultValue'               }

パラメーター化されたテストをすべて選択して、フィルター処理されたテストスイートを作成します。

suite1 = suite.selectIf(HasParameter);
disp({suite1.Name}')

    {'ZerosTest/testClass(size=s2d,type=single)'}
    {'ZerosTest/testClass(size=s2d,type=double)'}
    {'ZerosTest/testClass(size=s2d,type=uint16)'}
    {'ZerosTest/testClass(size=s3d,type=single)'}
    {'ZerosTest/testClass(size=s3d,type=double)'}
    {'ZerosTest/testClass(size=s3d,type=uint16)'}
    {'ZerosTest/testSize(size=s2d)'             }
    {'ZerosTest/testSize(size=s3d)'             }

パラメーター化されていないテストをすべて選択します。

suite2 = suite.selectIf(~HasParameter);
disp({suite2.Name}')

    {'ZerosTest/testDefaultClass'}
    {'ZerosTest/testDefaultSize' }
    {'ZerosTest/testDefaultValue'}

パラメーター化プロパティが "type" でパラメーター名が "double" であるパラメーター化されたテストをすべて選択します。

suite3 = suite.selectIf(HasParameter("Property","type","Name","double"));
disp({suite3.Name}')

    {'ZerosTest/testClass(size=s2d,type=double)'}
    {'ZerosTest/testClass(size=s3d,type=double)'}

名前が "t" で始まるパラメーター化プロパティをもつパラメーター化されたテストをすべて選択します。

suite4 = suite.selectIf("ParameterProperty","t*");
disp({suite4.Name}')

    {'ZerosTest/testClass(size=s2d,type=single)'}
    {'ZerosTest/testClass(size=s2d,type=double)'}
    {'ZerosTest/testClass(size=s2d,type=uint16)'}
    {'ZerosTest/testClass(size=s3d,type=single)'}
    {'ZerosTest/testClass(size=s3d,type=double)'}
    {'ZerosTest/testClass(size=s3d,type=uint16)'}

タグに基づくテストの選択

テストタグに基づいてテストを選択して、フィルター処理されたテストスイートを作成します。

現在のフォルダー内の ExampleTest.m という名前のファイルで、メソッドレベルの TestTags 属性を使用して個々のテストにタグを付ける ExampleTest クラスを作成します。テストコードを簡略化するために、この例の Test メソッドでは、実装していないテスト用のプレースホルダーとして無条件テストエラーを使用しています。

classdef ExampleTest < matlab.unittest.TestCase
    methods (Test)
        function testA(testCase)
            testCase.verifyFail("Implement the test.")
        end
    end
    methods (Test,TestTags="Unit")
        function testB(testCase)
            testCase.verifyFail("Implement the test.")
        end
        function testC(testCase)
            testCase.verifyFail("Implement the test.")
        end
    end
    methods (Test,TestTags=["Unit" "FeatureA"])
        function testD(testCase)
            testCase.verifyFail("Implement the test.")
        end
    end
    methods (Test,TestTags=["System" "FeatureB"])
        function testE(testCase)
            testCase.verifyFail("Implement the test.")
        end
    end
end

HasTag クラスをインポートします。

import matlab.unittest.selectors.HasTag

ExampleTest クラスからテストスイートを作成し、テスト名を表示します。スイートには 5 つの Test 要素が含まれています。

suite = testsuite("ExampleTest");
disp({suite.Name}')

    {'ExampleTest/testE'}
    {'ExampleTest/testD'}
    {'ExampleTest/testB'}
    {'ExampleTest/testC'}
    {'ExampleTest/testA'}

"Unit" というタグが付いたテストをすべて選択します。

suite1 = suite.selectIf("Tag","Unit");
disp({suite1.Name}')

    {'ExampleTest/testD'}
    {'ExampleTest/testB'}
    {'ExampleTest/testC'}

"FeatureA" というタグが付いていないテストをすべて選択します。

suite2 =  suite.selectIf(~HasTag("FeatureA"));
disp({suite2.Name}')

    {'ExampleTest/testB'}
    {'ExampleTest/testC'}
    {'ExampleTest/testA'}

いずれのタグも付いていないテストをすべて選択します。

suite3 =  suite.selectIf(~HasTag);
disp({suite3.Name}')

    {'ExampleTest/testA'}

バージョン履歴

R2014a で導入

すべて展開する

R2025a: ソースコードの依存関係によるテストの選択の正確性が向上

名前と値の引数 DependsOn または matlabtest.selectors.DependsOn クラスを使用して関数ベースまたはクラスベースのテストを選択するときに (MATLAB Test が必要)、指定したソースコードに依存するテストがより正確にメソッドで選択されるようになりました。ソースコードに依存する個別のテストをテストファイル内で判別できる場合、メソッドは依存するテストのみを選択して残りは除外します。それ以外の場合、メソッドはテストファイル内のすべてのテストを含めます。

以前のリリースでは、このメソッドは、指定されたソースコードにテストファイルが依存している場合、そのソースコードに依存していないテストを除外することなく、テストファイル内にあるすべてのテストを含めます。

R2024a: ソースコードの依存関係でテストスイートをフィルター処理するときに任意のタイプのソースファイルを指定

MATLAB Test のライセンスがある場合、名前と値の引数 DependsOn または matlabtest.selectors.DependsOn クラスを使用して任意のタイプのソースファイルを指定できます。以前のリリースでは、拡張子が .m、.p、.mlx、.mlapp、.mat、または .slx のファイルのみ指定できます。

R2023a: ソースコードの依存関係によるテストスイートのフィルター処理

MATLAB Test のライセンスがある場合、指定したソースコードへのテストファイルの依存関係でテストスイートをフィルター処理できます。名前と値の引数 DependsOn または matlabtest.selectors.DependsOn クラスを使用してソースファイルおよびフォルダーを指定します。

R2022b: cell 配列からよりわかりやすいパラメーター名を生成

空でない cell 配列をパラメーター化プロパティに代入すると、テストフレームワークは cell 配列の要素の値、型、および次元を考慮して、それらの要素からパラメーター名を生成します。以前のリリースでは、プロパティ値が文字ベクトルの cell 配列である場合、フレームワークは cell 配列の値からパラメーター名を生成します。それ以外の場合、フレームワークはパラメーター名を value1、value2、…、valueN として指定します。

コードでパラメーター名を使用してテストスイートを作成したり、フィルター処理したりする場合は、古いパラメーター名をわかりやすいパラメーター名に置き換えてください。たとえば、suite = testsuite(pwd,"ParameterName","value1") の value1 をわかりやすいパラメーター名に置き換えて更新します。

参考

testsuite | matlab.unittest.TestSuite | matlab.unittest.Test | matlab.unittest.selectors

selectIf

構文

説明

入力引数

suite — テスト スイート matlab.unittest.TestSuite 配列

selector — セレクター matlab.unittest.selectors.Selector オブジェクト

名前と値の引数

BaseFolder — ベース フォルダー名 string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

DependsOn — ソース コードが含まれるファイルおよびフォルダーの名前 string ベクトル | 文字ベクトル | 文字ベクトルの cell ベクトル

Name — テストの名前 string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

ParameterProperty — パラメーター化プロパティ名 string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

ParameterName — パラメーター名 string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

ProcedureName — テスト プロシージャの名前 string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

Superclass — テスト クラスの派生元であるクラスの名前 string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

Tag — タグの名前 string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

属性

例

テスト スイートのフィルター処理

パラメーター化に基づくテストの選択

タグに基づくテストの選択

バージョン履歴

R2025a: ソース コードの依存関係によるテストの選択の正確性が向上

R2024a: ソース コードの依存関係でテスト スイートをフィルター処理するときに任意のタイプのソース ファイルを指定

R2023a: ソース コードの依存関係によるテスト スイートのフィルター処理

R2022b: cell 配列からよりわかりやすいパラメーター名を生成

参考

`suite` — テストスイート
`matlab.unittest.TestSuite` 配列

`selector` — セレクター
`matlab.unittest.selectors.Selector` オブジェクト

`BaseFolder` — ベースフォルダー名
string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

`DependsOn` — ソースコードが含まれるファイルおよびフォルダーの名前
string ベクトル | 文字ベクトル | 文字ベクトルの cell ベクトル

`Name` — テストの名前
string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

`ParameterProperty` — パラメーター化プロパティ名
string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

`ParameterName` — パラメーター名
string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

`ProcedureName` — テストプロシージャの名前
string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

`Superclass` — テストクラスの派生元であるクラスの名前
string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

`Tag` — タグの名前
string 配列 | 文字ベクトル | 文字ベクトルの cell 配列

テストスイートのフィルター処理

R2025a: ソースコードの依存関係によるテストの選択の正確性が向上

R2024a: ソースコードの依存関係でテストスイートをフィルター処理するときに任意のタイプのソースファイルを指定

R2023a: ソースコードの依存関係によるテストスイートのフィルター処理