matlab.unittest.TestRunner.withTextOutput

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

コマンドウィンドウ出力用の TestRunner オブジェクトの作成

構文

runner = matlab.unittest.TestRunner.withTextOutput runner = matlab.unittest.TestRunner.withTextOutput(Name,Value)

説明

runner = matlab.unittest.TestRunner.withTextOutput は、TestRunner オブジェクトを作成します。このオブジェクトは MATLAB^® コマンドウィンドウからテストを実行するように設定され、runner に返されます。生成される出力には、テストの進行状況と、テスト失敗時の診断情報が含まれます。

runner = matlab.unittest.TestRunner.withTextOutput(Name,Value) は、1 つ以上の Name,Value のペア引数で指定された追加オプションをもつ TestRunner を作成します。たとえば、診断ログを除外する TestRunner を作成するには、matlab.unittest.TestRunner.withTextOutput('LoggingLevel',0) を指定します。

名前と値の引数

すべて展開する

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

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

例: matlab.unittest.TestRunner.withTextOutput('OutputDetail',4) は、イベント詳細を最も詳細なレベルで表示します。

`LoggingLevel` — 診断ログの最大詳細レベル
1 (既定値) | 0 | 2 | 3 | 4 | `matlab.automation.Verbosity` 列挙 | string または char ベクトルとしての列挙名

TestRunner インスタンスに含まれる診断ログの最大詳細レベル。0 ～ 4 の整数値、matlab.automation.Verbosity 列挙オブジェクト、事前定義された列挙メンバー名のいずれかに対応する string スカラーまたは文字ベクトルとして指定します。この TestRunner には、このレベル以下でログが作成された診断情報が含まれます。整数値は matlab.automation.Verbosity 列挙のメンバーに対応します。

既定では、TestRunner には matlab.automation.Verbosity.Terse レベル (レベル 1) でログが作成された診断情報が含まれます。診断ログを除外するには、LoggingLevel を Verbosity.None (レベル 0) に指定します。

診断ログとは、log (TestCase) メソッドまたは log (Fixture) メソッドの呼び出しによってテストフレームワークに送る診断です。

数値表現	列挙型メンバー名	詳細レベルの説明
`0`	`None`	情報なし
`1`	`Terse`	最小限の情報
`2`	`Concise`	中程度の情報量
`3`	`Detailed`	ある程度の補足的な情報
`4`	`Verbose`	多くの補足的な情報

`OutputDetail` — 表示するイベントの詳細レベル
0 | 1 | 2 | 3 | 4 | `matlab.automation.Verbosity` 列挙 | string または char ベクトルとしての列挙名

イベント詳細の表示レベル。0 ～ 4 の整数値、または matlab.automation.Verbosity 列挙オブジェクトとして指定します。matlab.automation.Verbosity 列挙値のメンバーに対応する整数値、または事前定義された列挙メンバー名のいずれかに対応する string スカラーまたは文字ベクトル。

TestRunner は、失敗したイベントとログが作成されたイベントを OutputDetail で指定された詳細情報とともに表示します。既定では、TestRunner は失敗したイベントとログが作成されたイベントを matlab.automation.Verbosity.Detailed レベル (レベル 3) で表示し、テスト実行の進行状況を matlab.automation.Verbosity.Concise レベル (レベル 2) で表示します。

数値表現	列挙型メンバー名	詳細レベルの説明
`0`	`None`	情報なし
`1`	`Terse`	最小限の情報
`2`	`Concise`	中程度の情報量
`3`	`Detailed`	ある程度の補足的な情報
`4`	`Verbose`	多くの補足的な情報

属性

Static true

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

例

すべて展開する

コマンドウィンドウでのテスト結果の表示

現在のインポートリストに matlab.unittest クラスを追加します。

import matlab.unittest.TestRunner
import matlab.unittest.TestSuite

TestSuite 配列を作成します。

suite = TestSuite.fromClass(?myNamespace.MyTestClass);

コマンドウィンドウへの出力を生成する TestRunner オブジェクトを作成します。

runner = TestRunner.withTextOutput;

% Run the suite
result = run(runner,suite)

診断ログの詳細の指定

現在の作業フォルダー ExampleLogTest.m 内のファイルに次のテストクラスを作成します。

classdef ExampleLogTest < matlab.unittest.TestCase
    methods(Test)
        function testOne(testCase)
            log(testCase,'Detailed','Starting Test')
            log(testCase,'Testing 5==5')
            testCase.verifyEqual(5,5)
            log(testCase,'Verbose','Test Complete')
        end
    end
end

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

result = run(ExampleLogTest);

Running ExampleLogTest
.
Done ExampleLogTest
__________

詳細レベル 4 以下でログに記録されたメッセージを表示するテストランナーを作成し、テストを実行します。

import matlab.unittest.TestRunner
import matlab.unittest.TestSuite
suite = TestSuite.fromClass(?ExampleLogTest);
runner = TestRunner.withTextOutput('LoggingLevel',4);

results = runner.run(suite);

Running ExampleLogTest

[Detailed] Diagnostic logged (2022-10-15 18:39:59): Starting Test

[Concise] Diagnostic logged (2022-10-15 18:39:59): Testing 5==5

[Verbose] Diagnostic logged (2022-10-15 18:39:59): Test Complete
.
Done ExampleLogTest
__________

バージョン履歴

R2013a で導入

参考

run (TestSuite) | matlab.automation.Verbosity | log (Fixture) | log (TestCase)