Main Content

このページの翻訳は最新ではありません。ここをクリックして、英語の最新版を参照してください。

verifySubstring

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

値に指定文字列が含まれていることを検証する

説明

verifySubstring(testCase,actual,substring) は、actualsubstring を含む string スカラーまたは文字ベクトルであることを検証します。

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

入力引数

すべて展開する

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

テストする値。任意のデータ型の値として指定します。任意のデータ型の値を指定できますが、actual が string スカラーまたは文字ベクトルではない場合、テストは失敗します。

実際の値に含まれなければならないテキスト。空でない string スカラーまたは文字ベクトルとして指定します。

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

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

例: "My Custom Diagnostic"

例: @dir

属性

Sealedtrue

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

すべて展開する

実際の値が指定された部分文字列を含むかテストします。

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

testCase = matlab.unittest.TestCase.forInteractiveUse;

実際の値を定義します。

actual = "This is a long message.";

actual にテキスト "long" が含まれていることを検証します。

verifySubstring(testCase,actual,"long")
Verification passed.

大文字と小文字の区別が重要であることを示します。"Long"actual に含まれていないため、このテストは失敗します。

verifySubstring(testCase,actual,"Long","Test is case sensitive.")
Verification failed.
    ----------------
    Test Diagnostic:
    ----------------
    Test is case sensitive.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifySubstring failed.
    --> The value does not contain the substring.
    
    Actual Value:
        "This is a long message."
    Expected Substring:
        "Long"
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestForSubstringsExample.m (TestForSubstringsExample) at 22

部分文字列が実際の文字列より長い場合にテストが失敗することを示します。

verifySubstring(testCase,actual,"This is a long message with extra words.")
Verification failed.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifySubstring failed.
    --> The value does not contain the substring.
    
    Actual Value:
        "This is a long message."
    Expected Substring:
        "This is a long message with extra words."
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestForSubstringsExample.m (TestForSubstringsExample) at 27

ヒント

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

    import matlab.unittest.constraints.ContainsSubstring
    testCase.verifyThat(actual,ContainsSubstring(substring))
    

    verifyThat を介して ContainsSubstring 制約を直接使用した場合、さらに多くの機能が使用できます。

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

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

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

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

バージョン履歴

R2013a で導入