fatalAssertSet

Class: matlab.mock.TestCase
Package: matlab.mock

Fatally assert that a property was set

Description

example

fatalAssertSet(testcase,behavior) fatally asserts that a property was set.

example

fatalAssertSet(testcase,behavior,diagnostic) also displays the diagnostic information in diagnostic upon a failure.

Input Arguments

expand all

Instance of the test case, specified as a matlab.mock.TestCase object.

Behavior of the mock, specified as a matlab.mock.PropertyBehavior instance. To create an instance of matlab.mock.PropertyBehavior, access a property of the behavior object.

Example: behavior.PropertyFoo

Diagnostic information to display, specified as a string array, character array, function handle, or matlab.unittest.diagnostics.Diagnostic object. Diagnostic values can be nonscalar. For more information, see matlab.unittest.diagnostics.Diagnostic.

Example: "My diagnostic message."

Example: @() datetime('now')

Examples

expand all

Create a mock with an implicit interface for interactive use. The interface includes the PropertyFoo and PropertyBar properties. Assign a value to PropertyFoo.

testCase = matlab.mock.TestCase.forInteractiveUse;
[mock,behavior] = testCase.createMock('AddedProperties', ...
    ["PropertyFoo","PropertyBar"]);
mock.PropertyFoo = 123;

Fatally assert that PropertyFoo was set.

testCase.fatalAssertSet(behavior.PropertyFoo);
Fatal assertion passed.

Create a mock with an implicit interface for interactive use. The interface includes the PropertyFoo and PropertyBar properties. Assign a value to PropertyFoo.

testCase = matlab.mock.TestCase.forInteractiveUse;
[mock,behavior] = testCase.createMock('AddedProperties', ...
    ["PropertyFoo","PropertyBar"]);
mock.PropertyFoo = 123;

Fatally assert that PropertyBar was set. Display the diagnostic information upon failure.

testCase.fatalAssertSet(behavior.PropertyBar, ...
    'PropertyBar should have been set.');
Fatal assertion failed.
    ----------------
    Test Diagnostic:
    ----------------
    PropertyBar should have been set.
    ---------------------
    Framework Diagnostic:
    ---------------------
    fatalAssertSet failed.
    --> Property 'PropertyBar' was never set.
    
    Specified property set operation:
    PropertySetBehavior
        <Mock>.PropertyBar = <IsAnything constraint>
Fatal assertion failed.

Tips

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.

  • 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 qualifications 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.

  • 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.

  • 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 marks the current test method as failed and incomplete.

Alternatives

Using the fatalAssertSet method is functionally equivalent to using the matlab.mock.constraints.WasSet constraint with the fatalAssertThat method of the FatalAssertable class. For example, the following code blocks are functionally equivalent.

% Using the fatalAssertSet method
testCase.fatalAssertSet(behavior.PropertyFoo);

% Using the WasSet constraint with fatalAssertThat method
import matlab.mock.constraints.WasSet;
testCase.fatalAssertThat(behavior.PropertyFoo, WasSet);
However, there is more functionality when you use the WasSet constraint. For instance, you can specify a property was set a certain number of times.

Introduced in R2017a