matlab.unittest.fixtures.Fixture クラス

名前空間: matlab.unittest.fixtures

テスト フィクスチャの基本的なインターフェイス

説明

matlab.unittest.fixtures.Fixture クラスは、テスト フィクスチャのインターフェイスを提供します。テスト環境を設定するセットアップ コードと、テストの実行後にそれを元の状態に戻す破棄コードをフィクスチャで指定します。

Fixture サブクラスで、テスト フレームワークでフィクスチャをセットアップするときに環境に変更を加える setup メソッドを実装する必要があります。フレームワークでフィクスチャを破棄するときに環境を復元するには、setup メソッド内で addTeardown メソッドを呼び出すか、teardown メソッドを実装します。

Fixture サブクラスでのセットアップ アクションと破棄アクションの指定に加え、構成可能なフィクスチャの場合 (たとえば、そのクラス コンストラクターが入力引数を受け入れる場合) は isCompatible メソッドを実装する必要があります。テスト フレームワークは isCompatible を呼び出して、同じ Fixture サブクラスのインスタンスが同一の共有テスト フィクスチャの状態と対応しているかどうかを判別します。

matlab.unittest.fixtures.Fixture クラスは handle クラスです。

クラスの属性

抽象型

true

クラス属性の詳細については、クラスの属性を参照してください。

プロパティ

SetupDescription — セットアップ アクションの説明

文字ベクトル

セットアップ アクションの説明。文字ベクトルとして返されます。このプロパティは、テスト フレームワークが setup メソッドを呼び出したときにフィクスチャで実行されるアクションを記述するために Fixture の実装で設定します。フィクスチャを共有テスト フィクスチャとして使用する場合、フレームワークでフィクスチャをセットアップするときにこのプロパティの値が表示されます。

属性:

GetAccess	public
SetAccess	protected

TeardownDescription — 破棄アクションの説明

文字ベクトル

破棄アクションの説明。文字ベクトルとして返されます。このプロパティは、テスト フレームワークが teardown メソッドを呼び出すか addTeardown メソッドに渡された関数ハンドルを呼び出したときにフィクスチャで実行されるアクションを記述するために Fixture の実装で設定します。フィクスチャを共有テスト フィクスチャとして使用する場合、フレームワークでフィクスチャを破棄するときにこのプロパティの値が表示されます。

属性:

GetAccess	public
SetAccess	protected

メソッド

パブリック メソッド

addTeardown	破棄コードをフィクスチャに動的に追加
applyAndRun	Run function in environment provided by fixture
setup	フィクスチャのセットアップ
teardown	フィクスチャの破棄

保護されたメソッド

applyFixture	作業を他のフィクスチャに委ねるフィクスチャのセットアップ
isCompatible	2 つのフィクスチャに互換性があるかどうかを判別
log	フィクスチャのセットアップと破棄の処理中に診断情報を記録する
needsReset	共有テスト フィクスチャをリセットする必要があるかどうかの判別
onFailure	フィクスチャのセットアップおよび破棄におけるエラーの診断情報を動的に追加する

検定に基づく保護されたメソッド

Assumable クラス、Assertable クラス、および FatalAssertable クラスと同様に、Fixture クラスは、値をテストしてエラーに対応するための複数の検定メソッドを提供します。たとえば、それらの保護されたメソッドを Fixture サブクラスでの setup メソッドや teardown メソッドの実装に使用できます。

Fixture クラスでは、仮定、アサーション、および致命的なアサーションがサポートされます。これらの検定タイプには、同じタイプのテストに対応する同様のメソッドがあります。これらのメソッドでは共通の命名規則を使用します。たとえば、等価性についてテストするメソッドでは <qualify>Equal という形式を使用し、<qualify> が assume、assert、または fatalAssert のいずれかになります。すなわち、以下のようになります。

• assumeEqual — 2 つの値が等しいものと仮定する。

• assertEqual — 2 つの値が等しいことをアサートする。

• fatalAssertEqual — 2 つの値が等しいことを致命的にアサートする。

一般的な目的

assumeEqual assertEqual fatalAssertEqual	<qualify>Equal(fixture,actual,expected,diagnostic,Name,Value) actual が expected と厳密に等しいかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 expected — 期待される値。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。 名前と値の引数 AbsTol — 絶対許容誤差。数値配列として指定します。 RelTol — 相対許容誤差。数値配列として指定します。
assumeFail assertFail fatalAssertFail	<qualify>Fail(fixture,diagnostic) 無条件の検定エラーを生成します。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。
assumeFalse assertFalse fatalAssertFalse	<qualify>False(fixture,actual,diagnostic) actual の値が logical 0 (false) であるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。
assumeNotEqual assertNotEqual fatalAssertNotEqual	<qualify>NotEqual(fixture,actual,prohibited,diagnostic) actual が prohibited と等しくないかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 prohibited — 比較する値。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。
assumeNotSameHandle assertNotSameHandle fatalAssertNotSameHandle	<qualify>NotSameHandle(fixture,actual,prohibited,diagnostic) actual が禁止されているハンドル配列と同じでないかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 prohibited — 比較する値。ハンドル配列として指定します。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。
assumeReturnsTrue assertReturnsTrue fatalAssertReturnsTrue	<qualify>ReturnsTrue(fixture,actual,diagnostic) actual が logical スカラー 1 (true) を返す関数ハンドルであるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。
assumeSameHandle assertSameHandle fatalAssertSameHandle	<qualify>SameHandle(fixture,actual,expected,diagnostic) actual が期待されるハンドル配列と同じであるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 expected — 期待される値。ハンドル配列として指定します。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。
assumeThat assertThat fatalAssertThat	<qualify>That(fixture,actual,constraint,diagnostic) actual が指定された制約を満たす値であるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 constraint — 実際の値が満たす必要のある制約。matlab.unittest.constraints.Constraint クラスのインスタンスとして指定します。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。
assumeTrue assertTrue fatalAssertTrue	<qualify>True(fixture,actual,diagnostic) actual の値が logical 1 (true) であるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。

エラーと警告

assumeError assertError fatalAssertError	[output1,...,outputN] = <qualify>Error(fixture,actual,identifier,diagnostic) actual が identifier で指定される例外をスローする関数ハンドルであるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 identifier — エラー識別子。string スカラー、文字ベクトル、または matlab.metadata.Class インスタンスとして指定します。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。 出力引数 (オプション) output1,...,outputN — actual から要求される 1 ～ N 番目の出力引数 (存在する場合)。
assumeWarning assertWarning fatalAssertWarning	[output1,...,outputN] = <qualify>Warning(fixture,actual,identifier,diagnostic) actual が identifier で指定される警告を表示する関数ハンドルであるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 identifier — 警告識別子。文字ベクトル、文字ベクトルの cell 配列、または string 配列として指定します。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。 出力引数 (オプション) output1,...,outputN — actual で生成される 1 ～ N 番目の出力引数 (存在する場合)。
assumeWarningFree assertWarningFree fatalAssertWarningFree	[output1,...,outputN] = <qualify>WarningFree(fixture,actual,diagnostic) actual が警告を表示しない関数ハンドルであるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。 出力引数 (オプション) output1,...,outputN — actual で生成される 1 ～ N 番目の出力引数 (存在する場合)。

不等式

assumeGreaterThan assertGreaterThan fatalAssertGreaterThan	<qualify>GreaterThan(fixture,actual,floor,diagnostic) actual のすべての要素が floor のすべての要素より大きいかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 floor — 最小値。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。
assumeGreaterThanOrEqual assertGreaterThanOrEqual fatalAssertGreaterThanOrEqual	<qualify>GreaterThanOrEqual(fixture,actual,floor,diagnostic) actual のすべての要素が floor のすべての要素以上であるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 floor — 最小値。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。
assumeLessThan assertLessThan fatalAssertLessThan	<qualify>LessThan(fixture,actual,ceiling,diagnostic) actual のすべての要素が ceiling のすべての要素より小さいかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 ceiling — 最大値。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。
assumeLessThanOrEqual assertLessThanOrEqual fatalAssertLessThanOrEqual	<qualify>LessThanOrEqual(fixture,actual,ceiling,diagnostic) actual のすべての要素が ceiling のすべての要素以下であるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 ceiling — 最大値。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。

配列サイズ

assumeEmpty assertEmpty fatalAssertEmpty	<qualify>Empty(fixture,actual,diagnostic) actual が空の MATLAB® 配列であるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。
assumeLength assertLength fatalAssertLength	<qualify>Length(fixture,actual,expectedLength,diagnostic) actual が期待される長さの MATLAB 配列であるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 expectedLength — 期待される配列の長さ。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。
assumeNotEmpty assertNotEmpty fatalAssertNotEmpty	<qualify>NotEmpty(fixture,actual,diagnostic) actual が空でない MATLAB 配列であるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。
assumeNumElements assertNumElements fatalAssertNumElements	<qualify>NumElements(fixture,actual,expectedNumElements,diagnostic) actual が期待される要素数の MATLAB 配列であるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 expectedNumElements — 期待される要素数。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。
assumeSize assertSize fatalAssertSize	<qualify>Size(fixture,actual,expectedSize,diagnostic) actual が期待されるサイズの MATLAB 配列であるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 expectedSize — 期待される配列のサイズ。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。

型

assumeClass assertClass fatalAssertClass	<qualify>Class(fixture,actual,class,diagnostic) actual のクラスが指定されたクラスであるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 class — 想定されるクラス。string スカラー、文字ベクトル、または matlab.metadata.Class インスタンスとして指定します。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。
assumeInstanceOf assertInstanceOf fatalAssertInstanceOf	<qualify>InstanceOf(fixture,actual,class,diagnostic) actual が指定されたクラスのインスタンスであるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 class — 想定されるクラス。string スカラー、文字ベクトル、または matlab.metadata.Class インスタンスとして指定します。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。

文字列

assumeMatches assertMatches fatalAssertMatches	<qualify>Matches(fixture,actual,expression,diagnostic) actual が指定された正規表現と一致する string スカラーまたは文字ベクトルであるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 expression — 一致させる正規表現。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。
assumeSubstring assertSubstring fatalAssertSubstring	<qualify>Substring(fixture,actual,substring,diagnostic) actual が substring を含む string スカラーまたは文字ベクトルであるかどうかをテストします。<qualify> を assume、assert、または fatalAssert に置き換えます。 入力引数 fixture — フィクスチャ。 actual — テストする値。 substring — 実際の値に含まれるテキスト。 diagnostic — (オプション) 検定にパスしたときか失敗したときに表示する診断情報。詳細については、診断を参照してください。

イベント

イベント名	トリガー	イベント データ	イベントの属性
AssumptionFailed	仮定の失敗時にトリガーされます。QualificationEventData オブジェクトがリスナー コールバック関数に渡されます。	matlab.unittest.qualifications.QualificationEventData	NotifyAccess: private ListenAccess: public
AssumptionPassed	仮定の成功時にトリガーされます。QualificationEventData オブジェクトがリスナー コールバック関数に渡されます。	matlab.unittest.qualifications.QualificationEventData	NotifyAccess: private ListenAccess: public
AssertionFailed	アサーションの失敗時にトリガーされます。QualificationEventData オブジェクトがリスナー コールバック関数に渡されます。	matlab.unittest.qualifications.QualificationEventData	NotifyAccess: private ListenAccess: public
AssertionPassed	アサーションの成功時にトリガーされます。QualificationEventData オブジェクトがリスナー コールバック関数に渡されます。	matlab.unittest.qualifications.QualificationEventData	NotifyAccess: private ListenAccess: public
FatalAssertionFailed	致命的なアサーションの失敗時にトリガーされます。QualificationEventData オブジェクトがリスナー コールバック関数に渡されます。	matlab.unittest.qualifications.QualificationEventData	NotifyAccess: private ListenAccess: public
FatalAssertionPassed	致命的なアサーションの成功時にトリガーされます。QualificationEventData オブジェクトがリスナー コールバック関数に渡されます。	matlab.unittest.qualifications.QualificationEventData	NotifyAccess: private ListenAccess: public
ExceptionThrown	テスト内容で例外をキャッチしたときにテスト ランナーによってトリガーされます。ExceptionEventData オブジェクトがリスナー コールバック関数に渡されます。	matlab.unittest.qualifications.ExceptionEventData	NotifyAccess: private ListenAccess: public
DiagnosticLogged	log メソッドの呼び出し時にトリガーされます。LoggedDiagnosticEventData オブジェクトがリスナー コールバック関数に渡されます。	matlab.unittest.diagnostics.LoggedDiagnosticEventData	NotifyAccess: private ListenAccess: public

例

テスト フィクスチャの作成と使用

数値の出力表示形式を小数点以下 2 桁の通貨形式に変更するカスタム フィクスチャを作成して使用します。

現在のフォルダー内の CurrencyFormatFixture.m という名前のファイルで、matlab.unittest.fixtures.Fixture インターフェイスをサブクラス化して CurrencyFormatFixture クラスを作成します。クラスで setup メソッドを実装して、フィクスチャによって数値の表示形式が通貨形式に変更されるようにします。テスト後に表示形式を元の状態に戻すために、setup メソッド内で addTeardown メソッドを呼び出します。

classdef CurrencyFormatFixture < matlab.unittest.fixtures.Fixture
    methods
        function setup(fixture)
            originalFormat = format;
            fixture.addTeardown(@format,originalFormat)
            format bank
        end
    end
end

現在のフォルダー内の ExampleTest.m という名前のファイルで、カスタム フィクスチャを適用し、数値が想定される形式で表示されることを検証する ExampleTest クラスを作成します。この例では、簡略化するために、関数 formattedDisplayText の呼び出しで実際の値を生成しています。実際には、ユーザー定義のコードをテストします。

classdef ExampleTest < matlab.unittest.TestCase
    methods (Test)
        function formatTest(testCase)
            testCase.applyFixture(CurrencyFormatFixture)
            actual = strtrim(formattedDisplayText(pi));
            expected = "3.14";
            testCase.verifyEqual(actual,expected)
        end
    end
end

ExampleTest クラスを実行します。テスト フレームワークでフィクスチャがセットアップされ、表示形式が通貨形式に変更されます。テストの実行が完了すると、フレームワークでフィクスチャが破棄され、元の表示形式に戻ります。この例では、テストはパスします。

runtests("ExampleTest");

Running ExampleTest
.
Done ExampleTest
__________

詳細

診断

テスト ランナーの構成に応じて、テスト フレームワークは検定にパスしたときまたは失敗したときに診断を表示できます。既定では、フレームワークは検定に失敗したときにのみ診断を表示します。この既定の動作はテスト ランナーをカスタマイズしてオーバーライドできます。たとえば、失敗したイベントとパスしたイベントの両方の診断を表示するには、DiagnosticsOutputPlugin インスタンスを使用できます。

診断メッセージをテスト ケースに追加するには、いずれかの検定メソッドでオプションの diagnostic 引数を使用します。diagnostic を string 配列、文字配列、関数ハンドル、または matlab.automation.diagnostics.Diagnostic オブジェクトの配列として指定できます。

バージョン履歴

R2014a で導入

R2024b: フィクスチャによって提供される環境での関数の実行

matlab.unittest.fixtures.Fixture クラスには、1 つ以上のフィクスチャによって提供される環境で関数を実行できる新しいメソッド applyAndRun があります。

R2020b: 共有テスト フィクスチャの有効性のレポート

matlab.unittest.fixtures.Fixture クラスには、共有テスト フィクスチャの有効性をテスト フレームワークにレポートできるようにする新しいメソッド needsReset があります。共有テスト フィクスチャは、フィクスチャで構成されたテスト環境の状態がテスト セッション全体にわたり維持される場合は有効です。

参考

getSharedTestFixtures | addTeardown

トピック

• 基本的なカスタム フィクスチャの作成
• 高度なカスタム フィクスチャの作成
• 共有フィクスチャを使用するテストの記述