verifyFalse

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

Verify value is false

expand all in page

Syntax

verifyFalse(verifiable,actual)
verifyFalse(___,diagnostic)

Description

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

verifyFalse(___,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.

verifyFalse(testCase, true);

Interactive verification failed.

---------------------
Framework Diagnostic:
---------------------
verifyFalse failed.
--> The value must evaluate to "false".

Actual Value:
         1

Test failed.

Test false.

verifyFalse(testCase, false);

Interactive verification passed.

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

testCase = matlab.unittest.TestCase.forInteractiveUse;
verifyFalse(testCase, 0);

Interactive verification failed.

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

Actual Value:
         0

Test failed.

To be false, the value must be scalar.

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

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

Actual Value:
         0     0     0

Test failed.

Test an array of mixed logical values.

verifyFalse(testCase, [false true false], ...
    'A mixed array of logicals is not the one false value');

Interactive verification failed.

----------------
Test Diagnostic:
----------------
A mixed array of logicals is not the one false value

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

Actual Value:
         0     1     0

Test failed.

Tips

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

  • This method is functionally equivalent to: 

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

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

  • Unlike verifyTrue, this method may create a new constraint for each call. For performance critical uses, consider using verifyTrue.

  • 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