Main Content

fatalAssertError

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

Fatally assert function throws specified exception

Syntax

fatalAssertError(fatalAssertable,actual,identifier)
fatalAssertError(fatalAssertable,actual,metaClass)
fatalAssertError(___,diagnostic)
[output1,...,outputN] = fatalAssertError(___)

Description

fatalAssertError(fatalAssertable,actual,identifier) fatally asserts that actual is a function handle that throws an exception with an error identifier that is equal to identifier.

fatalAssertError(fatalAssertable,actual,metaClass) fatally asserts that actual is a function handle that throws an exception whose type is defined by the meta.class instance specified in metaClass. This method does not require the instance to be an exact class match, but rather it must be in the specified class hierarchy, and that hierarchy must include the MException class..

fatalAssertError(___,diagnostic) also associates the diagnostic information in diagnostic with the qualification. Depending on the test runner configuration, the testing framework might display diagnostics when the qualification passes or fails. By default, the framework displays diagnostics only when the qualification fails. You can override the default behavior by customizing the test runner. For example, use a DiagnosticsOutputPlugin instance to display both failing and passing event diagnostics.

[output1,...,outputN] = fatalAssertError(___) returns multiple output arguments from the invocation of the function handle actual. Use this syntax to control the number of output arguments requested from the function handle. If the function handle errors, all outputs are of type missing. Otherwise, output1,...,outputN are output values from actual. You can use this syntax with any of the input arguments of the previous syntaxes.

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 value to test.

identifier

Error identifier, specified as a character vector.

metaClass

An instance of meta.class.

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.

Examples

See examples for verifyError, and replace calls to verifyError with fatalAssertError.

Tips

  • This method is functionally equivalent to:

    import matlab.unittest.constraints.Throws;
    fatalAssertable.fatalAssertThat(actual, Throws(identifier));
    fatalAssertable.fatalAssertThat(actual, Throws(metaClass));
    

    There exists more functionality when using the Throws 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.

Introduced in R2013a