Main Content

verifyLength

クラス: matlab.unittest.qualifications.Verifiable
パッケージ: matlab.unittest.qualifications

値が指定された長さであることを検証する

説明

verifyLength(testCase,actual,expectedLength) は、actual が期待される長さの MATLAB® 配列であることを検証します。配列の長さは、その配列の最大次元の長さとして定義されます。

verifyLength(testCase,actual,expectedLength,diagnostic) は、さらに diagnostic の診断情報を検定に関連付けます。

入力引数

すべて展開する

テスト ケース。matlab.unittest.qualifications.Verifiable オブジェクトとして指定します。matlab.unittest.TestCase クラスは matlab.unittest.qualifications.Verifiable をサブクラス化してそのメソッドを継承するため、testCase は通常 matlab.unittest.TestCase オブジェクトです。

テストする値。任意のデータ型の配列として指定します。

期待される配列の長さ。非負の整数スカラーとして指定します。

検定にパスしたときか失敗したときに表示する診断情報。string 配列、文字配列、関数ハンドル、または matlab.automation.diagnostics.Diagnostic オブジェクトの配列として指定します。

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

例: "My Custom Diagnostic"

例: @dir

属性

Sealedtrue

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

すべて展開する

実際の値が指定された長さであるかテストします。

対話型テスト用にテスト ケースを作成します。

testCase = matlab.unittest.TestCase.forInteractiveUse;

行ベクトル [1 3 5] が長さ 3 であることを検証します。

verifyLength(testCase,[1 3 5],3)
Verification passed.

配列の長さが最大次元の長さであることを検証します。

verifyLength(testCase,ones(2,5,3),5)
Verification passed.

2 行 2 列の単位行列の長さが 4 であるかテストします。テストは失敗します。

verifyLength(testCase,eye(2),4,"Value must have a length of four.")
Verification failed.
    ----------------
    Test Diagnostic:
    ----------------
    Value must have a length of four.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyLength failed.
    --> The array has an incorrect length.
        
        Actual Length:
             2
        Expected Length:
             4
    
    Actual Value:
         1     0
         0     1
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestForArrayLengthsExample.m (TestForArrayLengthsExample) at 22

文字ベクトルの cell 配列の長さをテストします。

actual = {'Mercury','Gemini','Apollo'; ...
    'Skylab','Skylab B','ISS'};
verifyLength(testCase,actual,3)
Verification passed.

ヒント

  • verifyLength は便利なメソッドです。たとえば、verifyLength(testCase,actual,expectedLength) は、以下のコードと機能的に等価です。

    import matlab.unittest.constraints.HasLength
    testCase.verifyThat(actual,HasLength(expectedLength))
    
  • 検証検定を使用して、例外をスローせずにエラーを生成して記録します。検証では例外がスローされないため、すべてのテスト内容は検証エラーが発生しても最後まで実行されます。通常の場合、検証はテストを早期終了する必要がないため、ユニット テストの主な検定となります。前提条件の違反や不適切なテスト設定がないかどうかをテストするには、他の検定タイプを使用します。

    • テスト環境がテスト エラーを回避するために必要な前提条件を満たしていることを確認するには、仮定検定を使用してください。仮定エラーが発生するとテストのフィルター処理が行われ、テスト フレームワークによってテストが Incomplete としてマークされます。詳細については、matlab.unittest.qualifications.Assumable を参照してください。

    • エラー条件によって現在のテスト内容の残りが無効になっても、それ以降のテストは正しく実行される場合、アサーション検定を使用してください。アサーション地点におけるエラーによって、現在のテストが Failed および Incomplete となります。詳細については、matlab.unittest.qualifications.Assertable を参照してください。

    • エラーが発生した場合にテスト セッションを中止するには、致命的なアサーション検定を使用してください。これらの検定は、エラーがあまりに根本的なものであり、テストを続行する意義がない場合に役立ちます。致命的なアサーション検定は、フィクスチャの破棄で環境の状態が正しく復元されず、テストを中止して新しいセッションを開始する方が望ましい場合にも有益です。詳細については、matlab.unittest.qualifications.FatalAssertable を参照してください。

バージョン履歴

R2013a で導入