Main Content

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

verifyWarningFree

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

関数が警告を表示しないことを検証する

説明

verifyWarningFree(testCase,actual) は、actual が警告を表示しない関数ハンドルであることを検証します。

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

[output1,...,outputN] = verifyWarningFree(___) は、関数ハンドルが呼び出されるときに生成されるすべての出力も返します。前述の構文にある任意の入力引数を組み合わせて使用できます。

入力引数

すべて展開する

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

テストする値。任意のデータ型の値として指定します。任意のデータ型の値を指定できますが、actual が関数ハンドルではない場合、テストは失敗します。

例: @() myFunction(1,2)

例: @() mkdir("myFolder")

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

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

例: "My Custom Diagnostic"

例: @dir

属性

Sealedtrue

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

すべて展開する

実際の値が、警告を発行しない関数ハンドルであるかをテストします。

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

testCase = matlab.unittest.TestCase.forInteractiveUse;

true の呼び出しで警告が発生しないことを検証します。

verifyWarningFree(testCase,@true)
Verification passed.

関数 false を使用して、テストをもう一度実行します。関数の出力を調べます。

f = verifyWarningFree(testCase,@false)
Verification passed.

f =

  logical

   0

空の配列を指定した size の呼び出しで警告が発生しないことを検証します。

verifyWarningFree(testCase,@() size([]))
Verification passed.

実際の値が関数ハンドルでない場合、テストが失敗することを検証します。

verifyWarningFree(testCase,5,"Value must be a function handle.")
Verification failed.
    ----------------
    Test Diagnostic:
    ----------------
    Value must be a function handle.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyWarningFree failed.
    --> The value must be an instance of the expected type.
        
        Actual Class:
            double
        Expected Type:
            function_handle
    
    Actual Value:
         5
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestForWarningsExample.m (TestForWarningsExample) at 27

警告を出力する関数をテストします。テストは失敗します。

verifyWarningFree(testCase,@() warning("SOME:warning:id","Warning!"))
Warning: Warning! 
Verification failed.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyWarningFree failed.
    --> The function issued warnings.
        
        Warnings Issued:
            --> Identifier: "SOME:warning:id"
                   Message: Warning!
    
    Evaluated Function:
      function_handle with value:
    
        @()warning("SOME:warning:id","Warning!")
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestForWarningsExample.m (TestForWarningsExample) at 31

ヒント

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

    import matlab.unittest.constraints.IssuesNoWarnings
    testCase.verifyThat(actual,IssuesNoWarnings)

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

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

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

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

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

バージョン履歴

R2013a で導入