このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。
matlab.unittest.TestSuite.fromProject
クラス: matlab.unittest.TestSuite
名前空間: matlab.unittest
プロジェクト内のテストからテスト スイートを作成する
構文
説明
は、suite
= matlab.unittest.TestSuite.fromProject(project
)Test
の分類ラベルが付けられた、指定されたプロジェクトに含まれるすべてのテスト ファイルから TestSuite
配列を作成します。project
の入力は、読み込まれた matlab.project.Project
オブジェクトかプロジェクトのルート フォルダーのいずれかとなります。このメソッドは再帰的なものではありません。指定されたプロジェクトのテストのみが含まれます。参照プロジェクトのテストを含めるには、名前と値の引数 IncludingReferencedProjects
を true
として指定します。プロジェクトの詳細については、プロジェクトを参照してください。
は、suite
= matlab.unittest.TestSuite.fromProject(project
,selector
)Test
の分類ラベルが付けられ、selector
を満たす、指定されたプロジェクトに含まれるすべてのテスト ファイルから TestSuite
配列を作成します。セレクターの詳細については、matlab.unittest.selectors
を参照してください。
は、suite
= matlab.unittest.TestSuite.fromProject(___,Name,Value
)Test
の分類ラベルが付けられ、1 つ以上の名前と値の引数によって指定された条件を満たす、指定されたプロジェクトに含まれるすべてのテスト ファイルから TestSuite
配列を作成します。前述の任意の構文で、すべての引数の後に名前と値の引数を指定します。
入力引数
project
— テスト ファイルが含まれるプロジェクト
プロジェクトのルート フォルダーのパス | 開かれている Project
オブジェクト
テスト ファイルが含まれるプロジェクト。プロジェクトのルート フォルダーのパス、または開かれている Project
オブジェクトとして指定します。テスト ファイルは、Test
ラベルを追加することでテストとして分類された、プロジェクト内のファイルです。
例: 'C:\MyProjects\ThisProject'
データ型: char
| string
selector
— TestSuite
配列要素のフィルター
セレクター クラスのインスタンス
TestSuite
配列要素のフィルター。matlab.unittest.selectors
名前空間のクラスのインスタンスとして指定します。MATLAB® Test™ のライセンスがある場合、selector
を matlabtest.selectors.DependsOn
オブジェクトとして指定することもできます。
例: matlab.unittest.selectors.HasBaseFolder(fullfile(pwd,'MyTests','Feature1'))
名前と値の引数
引数のオプションのペアを Name1=Value1,...,NameN=ValueN
として指定します。ここで Name
は引数名で、Value
は対応する値です。名前と値の引数は他の引数の後になければなりませんが、ペアの順序は重要ではありません。
R2021a より前では、コンマを使用してそれぞれの名前と値を区切り、Name
を引用符で囲みます。
IncludingReferencedProjects
— 参照プロジェクトのテストを含めるオプション
false (既定値) | true | 0
| 1
TestSuite
に参照プロジェクトのテストを含めるオプション。logical true
または false
として指定します。既定では、fromProject
は、入力で指定されたプロジェクトのテスト ファイルのみを含めます。IncludingReferencedProjects
に true
の値を渡した場合、TestSuite
配列には、入力で指定されたプロジェクトと、親プロジェクトによって参照されるプロジェクトのテストが含まれます。参照プロジェクトの詳細については、大規模なプロジェクトのコンポーネント化を参照してください。
例: suite = matlab.unittest.TestSuite.fromProject(project,'IncludingReferencedProjects',true);
データ型: logical
ExternalParameters
— テストで使用する外部パラメーター
matlab.unittest.parameters.Parameter
オブジェクトの配列
テストで使用する外部パラメーター。matlab.unittest.parameters.Parameter
オブジェクトの配列として指定します。この引数を使用して、パラメーター化されたテスト内の既存のパラメーターの代わりに外部パラメーターを指定します。詳細については、パラメーター化されたテストでの外部パラメーターの使用を参照してください。
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
要素がいずれも一致するタグ名をもたない場合、空のテスト スイートが返されます。ワイルドカード文字 (*
) を使用すると任意の数の文字と一致します。疑問符 (?
) を使用すると単一の文字と一致します。
出力引数
suite
— 一連のテスト
テスト スイート
一連のテスト。matlab.unittest.Test
配列として返されます。
例
プロジェクト ファイルからのテスト スイートの作成
Test
ファイルとしてラベルが付けられたプロジェクト ファイルからテスト スイートを作成します。この例では、C:/projects/project1
のプロジェクト フォルダーに Test
の分類ラベルが付けられたテスト ファイルが含まれていると仮定します。matlab.unittest.TestSuite.fromProject
静的メソッドを使用して、これらのテストを使用したテスト スイートを作成します。
project1
を開き、matlab.project.Project
オブジェクトを fromProject
に渡します。テスト スイートを実行し、結果を取得します。
import matlab.unittest.TestSuite project = openProject('C:/projects/project1/'); suite = TestSuite.fromProject(project); result = run(suite)
参照プロジェクトのテストを含める
プロジェクトおよびすべての参照プロジェクト内で Test
ファイルとしてラベルが付けられているプロジェクト ファイルからテスト スイートを作成します。
import matlab.unittest.TestSuite project = openProject('C:/projects/project1/'); suite = TestSuite.fromProject(project,'IncludingReferencedProjects',true); result = run(suite)
バージョン履歴
R2019a で導入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
をわかりやすいパラメーター名に置き換えて更新します。
R2021b: テスト スイート作成時のテスト プロシージャを定義しないファイルは matlab.unittest.TestSuite.fromProject
で無視される
Test
の分類が付けられたファイルがプロジェクトに含まれている場合、テスト スイート作成時のテスト プロシージャを定義しないファイルは matlab.unittest.TestSuite.fromProject
で無視されます。たとえば、抽象 TestCase
クラス定義ファイルに Test
の分類ラベルが付けられている場合、そのファイルは fromProject
で無視されます。以前のリリースでは、具象テスト ファイル以外のファイルに Test
の分類が使用されているプロジェクトで fromProject
が呼び出されると、MATLAB でエラーが発生します。この変更により、fromProject
が matlab.unittest.TestSuite.fromFolder
メソッドと一貫した動作になります。どちらのメソッドでも、テスト スイートが具象テスト ファイルのみから作成され、フォルダー内のそれ以外のファイルは無視されます。
この動作の変更は、プロジェクト内のファイルとフォルダーに編成されたコードに対する関数 testsuite
、runtests
、および runperf
の動作にも適用されます。
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)