Main Content

assumeAccessed

Class: matlab.mock.TestCase
Namespace: matlab.mock

Assume that a property was accessed

expand all in page

Syntax

assumeAccessed(testcase,behavior)
assumeAccessed(testcase,behavior,diagnostic)

Description

assumeAccessed(testcase,behavior) assumes that a property was accessed.

example

assumeAccessed(testcase,behavior,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.

example

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.automation.diagnostics.Diagnostic object. Diagnostic values can be nonscalar. For more information, see matlab.automation.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. Access PropertyFoo by storing its value.

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

Assume that PropertyFoo was accessed.

testCase.assumeAccessed(behavior.PropertyFoo);
An assumption was met.

Create a mock with an implicit interface for interactive use. The interface includes the PropertyFoo and PropertyBar properties. Access PropertyFoo by storing its value.

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

Assume that PropertyBar was accessed. Display the diagnostic information upon failure.

testCase.assumeAccessed(behavior.PropertyBar, ...
    'PropertyBar should have been accessed.');
An assumption was not met.
    ----------------
    Test Diagnostic:
    ----------------
    PropertyBar should have been accessed.
    ---------------------
    Framework Diagnostic:
    ---------------------
    assumeAccessed failed.
    --> Property 'PropertyBar' was never accessed.
    
    Specified property access operation:
    PropertyGetBehavior
        <Mock>.PropertyBar
Assumption failed.

Tips

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

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

Alternatives

Using the assumeAccessed method is functionally equivalent to using the matlab.mock.constraints.WasAccessed constraint with the assumeThat method of the Assumable class. For example, the following code blocks are functionally equivalent.

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

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

Version History

Introduced in R2017a

See Also