verifyThat

Class: matlab.unittest.qualifications.Verifiable
Package: matlab.unittest.qualifications

Verify value meets given constraint

expand all in page

Syntax

verifyThat(verifiable,actual,constraint)
verifyThat(___,diagnostic)

Description

verifyThat(verifiable,actual,constraint) verifies that actual is a value that satisfies the constraint provided.

If the constraint is not satisfied, a verification failure is produced utilizing only the framework diagnostic generated by the constraint.

verifyThat(___,diagnostic) also displays the diagnostic information in diagnostic upon a failure.

When using this signature, both the diagnostic information contained within diagnostic is used in addition to the diagnostic information provided by the constraint.

Input Arguments

verifiable

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

actual

The value to test.

constraint

Constraint that the actual value must satisfy to pass the verification, specified as a matlab.unittest.constraints instance.

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

expand all

testCase = matlab.unittest.TestCase.forInteractiveUse;

% Passing scenarios
%%%%%%%%%%%%%%%%%%%%
import matlab.unittest.constraints.IsTrue
verifyThat(testCase, true, IsTrue)
 
import matlab.unittest.constraints.IsEqualTo
verifyThat(testCase, 5, IsEqualTo(5), '5 should be equal to 5')
 
import matlab.unittest.constraints.IsGreaterThan
import matlab.unittest.constraints.HasNaN
verifyThat(testCase, [5 NaN], IsGreaterThan(10) | HasNaN, ...
    'The value was not greater than 10 or NaN')
 
 
% Failing scenarios
%%%%%%%%%%%%%%%%%%%%
import matlab.unittest.constraints.AnyCellOf
import matlab.unittest.constraints.ContainsSubstring
verifyThat(testCase, AnyCellOf({'cell','of','strings'}), ...
    ContainsSubstring('char'),'Test description')
 
import matlab.unittest.constraints.HasSize
verifyThat(testCase, zeros(10,4,2), HasSize([10,5,2]), ...
    @() disp('A function handle diagnostic.'))
 
import matlab.unittest.constraints.IsEmpty
verifyThat(testCase, 5, IsEmpty)

Tips

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

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

    • 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 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. For more information, see matlab.unittest.qualifications.FatalAssertable.

See Also

| | |

Topics

Introduced in R2013a

MATLAB Documentation

Support