Main Content

verifySize

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

Verify value has specified size

Description

example

verifySize(testCase,actual,expectedSize) verifies that actual is a MATLAB® array with the expected size.

example

verifySize(testCase,actual,expectedSize,diagnostic) also associates the diagnostic information in diagnostic with the qualification.

Input Arguments

expand all

Test case object, specified as an instance of the matlab.unittest.qualifications.Verifiable class. Because the matlab.unittest.TestCase class subclasses matlab.unittest.qualifications.Verifiable and inherits its methods, testCase is typically a matlab.unittest.TestCase instance.

Value to test, specified as an array of any data type.

Expected array size, specified as a row vector of nonnegative integers. Each element of expectedSize represents the expected length of the corresponding dimension of actual.

Diagnostic information to display when the qualification passes or fails, specified as a string array, character array, function handle, or array of matlab.unittest.diagnostics.Diagnostic objects.

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: "My Custom Diagnostic"

Example: @dir

Attributes

Sealedtrue

To learn about attributes of methods, see Method Attributes.

Examples

expand all

Test if the actual value has the specified size.

Create a test case for interactive testing.

testCase = matlab.unittest.TestCase.forInteractiveUse;

Verify that the size of the row vector [1 3 5] is [1 3].

verifySize(testCase,[1 3 5],[1 3])
Verification passed.

Test the size of a 2-by-5-by-3 array.

verifySize(testCase,rand(2,5,3),[2 5 3])
Verification passed.

Test if the size of a 2-by-2 matrix is [4 1]. The test fails.

verifySize(testCase,eye(2),[4 1],"Value must be a 4-by-1 vector.")
Verification failed.
    ----------------
    Test Diagnostic:
    ----------------
    Value must be a 4-by-1 vector.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifySize failed.
    --> The value had an incorrect size.
        
        Actual Size:
             2     2
        Expected Size:
             4     1
    
    Actual Value:
         1     0
         0     1
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestForArraySizesExample.m (TestForArraySizesExample) at 21

Test the size of a cell array of character vectors.

actual = {'Mercury','Gemini','Apollo'};
verifySize(testCase,actual,[1 3])
Verification passed.

Tips

  • verifySize is a convenience method. For example, verifySize(testCase,actual,expectedSize) is functionally equivalent to the following code.

    import matlab.unittest.constraints.HasSize
    testCase.verifyThat(actual,HasSize(expectedSize))
  • 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:

    • 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 tests. A failure at the assertion point renders the current test 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 is so fundamental that continuing testing does not make sense. Fatal assertion qualifications are also useful when fixture teardown does not restore the environment state correctly, and aborting testing and starting a fresh session is preferable. For more information, see matlab.unittest.qualifications.FatalAssertable.

Introduced in R2013a