fatalAssertWarning

Class: matlab.unittest.qualifications.FatalAssertable
Package: matlab.unittest.qualifications

Fatally assert function issues specified warnings

Syntax

fatalAssertWarning(fatalAssertable,actual,warningIDs)
fatalAssertWarning(fatalAssertable,actual,warningIDs,diagnostic)
[output1,...,outputN] = fatalAssertWarning(___)

Description

fatalAssertWarning(fatalAssertable,actual,warningIDs) fatally asserts that actual issues warnings with the identifiers warningIDs.

fatalAssertWarning(fatalAssertable,actual,warningIDs,diagnostic) also displays the diagnostic information in diagnostic upon a failure.

[output1,...,outputN] = fatalAssertWarning(___) also returns the output arguments output1,...,outputN that are produced when invoking actual.

Input Arguments

fatalAssertable

The matlab.unittest.TestCase instance which is used to pass or fail the fatal assertion in conjunction with the test running framework.

actual

The function handle to test.

warningIDs

Warning identifiers, specified as a character vector, cell array of character vectors, or string array.

diagnostic

Diagnostic information related to the qualification, specified as one of the following:

  • string array

  • character array

  • function handle

  • matlab.unittest.diagnostics.Diagnostic object

Diagnostic values can be nonscalar. For more information, see matlab.unittest.diagnostics.Diagnostic.

Output Arguments

output1,...,outputN

Output arguments, 1 through n (if any), from actual, returned as any type. The argument type is specified by the actual argument list.

Examples

See examples for verifyWarning, and replace calls to verifyWarning with fatalAssertWarning.

Tips

  • This method is functionally equivalent to:

    import matlab.unittest.constraints.IssuesWarnings;
fatalAssertable.fatalAssertThat(actual,IssuesWarnings(cellstr(warningIDs)));

    There exists more functionality when using the IssuesWarnings constraint directly via fatalAssertThat.

  • Use fatal assertion qualifications to abort the test session upon failure. These qualifications are useful when the failure mode is so fundamental that there is no point in continuing testing. These qualifications are also useful when fixture teardown does not restore the MATLAB® state correctly and it is preferable to abort testing and start a fresh session. Alternatively,

    • Use assertion qualifications when the failure condition invalidates the remainder of the current test content, but does not prevent proper execution of subsequent test methods. A failure at the assertion point renders the current test method as failed and incomplete. For more information, see matlab.unittest.qualifications.Assertable.

    • Use verification qualifications to produce and record failures without throwing an exception. Since verifications do not throw exceptions, all test content runs to completion even when verification failures occur. Typically verifications are the primary qualification for a unit test since they typically do not require an early exit from the test. Use other qualification types to test for violation of preconditions or incorrect test setup. For more information, see matlab.unittest.qualifications.Verifiable.

    • Use assumption qualifications to ensure that the test environment meets preconditions that otherwise do not result in a test failure. Assumption failures result in filtered tests, and the testing framework marks the tests as Incomplete. For more information, see matlab.unittest.qualifications.Assumable.

See Also

| | |

Topics

Introduced in R2013a

MATLAB Documentation

Support