verifyTrue

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

Verify value is true

expand all in page

Syntax

verifyTrue(verifiable,actual)
verifyTrue(___,diagnostic)

Description

verifyTrue(verifiable,actual) verifies that actual is a scalar logical with the value of true.

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

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.

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

Create a TestCase object for interactive testing.

testCase = matlab.unittest.TestCase.forInteractiveUse;

Test true.

verifyTrue(testCase, true);

Interactive verification passed.

Test false.

verifyTrue(testCase, false);

Interactive verification failed.

---------------------
Framework Diagnostic:
---------------------
verifyTrue failed.
--> The value must evaluate to "true".

Actual Value:
         0

Test failed.

The number 1 is a double value, not a logical value.

A double value of 1 is not true.

testCase = matlab.unittest.TestCase.forInteractiveUse;
verifyTrue(testCase, 1);

Interactive verification failed.

---------------------
Framework Diagnostic:
---------------------
verifyTrue failed.
--> The value must be logical. It is of type "double".

Actual Value:
         1

Test failed.

To be true, the value must be scalar.

testCase = matlab.unittest.TestCase.forInteractiveUse;
verifyTrue(testCase, [true true true]);
Interactive verification failed.

---------------------
Framework Diagnostic:
---------------------
verifyTrue failed.
--> The value must be scalar. It has a size of [1  3].

Actual Value:
         1     1     1

Test failed.

Tips

  • This method passes if and only if the actual value is a scalar logical with a value of true. Therefore, entities such as true valued arrays and nonzero doubles produce qualification failures when used in this method, despite these entities exhibiting "true-like" behavior such as triggering the execution of code inside of "if" statements.

  • This method is functionally equivalent to:

    import matlab.unittest.constraints.IsTrue;
verifiable.verifyThat(actual, IsTrue());

    There exists more functionality when using the IsTrue constraint directly via verifyThat.

    Use of this method for performance benefits can come at the expense of less diagnostic information, and may not provide the same level of strictness adhered to by other constraints such as IsEqualTo. A similar approach that is generally less performant but can provide slightly better diagnostic information is the use of verifyReturnsTrue, which at least shows the display of the function evaluated to generate the failing result.

  • 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