Main Content

verifySameHandle

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

Verify two handle arrays are the same

Description

example

verifySameHandle(testCase,actual,expected) verifies that actual is the same as the expected handle array. Two handle arrays are the same if they have the same size and their corresponding elements refer to the same handle object.

example

verifySameHandle(testCase,actual,expected,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 a value of any data type. Although you can provide a value of any data type, the test fails if actual is not a handle array.

Expected value, specified as a handle array.

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 is the same as the specified handle array.

In a file in your current folder, create the ExampleHandle handle class.

classdef ExampleHandle < handle
    properties
        Number = 1;
    end
end

Create two ExampleHandle objects assigned to the variables h1 and h2. Then, assign the value of h2 to another variable h3. The variables h1 and h2 point to different objects, but the variables h2 and h3 point to the same object.

h1 = ExampleHandle;
h2 = ExampleHandle;
h3 = h2;

Create a test case for interactive testing.

testCase = matlab.unittest.TestCase.forInteractiveUse;

Test if h1 and h2 point to the same object. The test fails.

verifySameHandle(testCase,h1,h2,"Values must point to the same object.")
Verification failed.
    ----------------
    Test Diagnostic:
    ----------------
    Values must point to the same object.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifySameHandle failed.
    --> Values do not refer to the same handle.
    
    Actual Value:
      ExampleHandle with properties:
    
        Number: 1
    Expected Handle Object:
      ExampleHandle with properties:
    
        Number: 1
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestHandlesForEqualityExample.m (TestHandlesForEqualityExample) at 29

Verify that h2 and h3 point to the same object.

verifySameHandle(testCase,h2,h3)
Verification passed.

Verify that [h2 h3] and [h3 h2] are the same. The test passes because the corresponding vector elements point to the same object.

verifySameHandle(testCase,[h2 h3],[h3 h2])
Verification passed.

Test if [h1 h2] and [h2 h1] are the same. The test fails because the corresponding vector elements point to different objects.

verifySameHandle(testCase,[h1 h2],[h2 h1])
Verification failed.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifySameHandle failed.
    --> Some elements in the handle array refer to the wrong handle.
    
    Actual Value:
      1×2 ExampleHandle array with properties:
    
        Number
    Expected Handle Object:
      1×2 ExampleHandle array with properties:
    
        Number
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestHandlesForEqualityExample.m (TestHandlesForEqualityExample) at 43

Test if two handle arrays of different shapes are the same. The test fails.

verifySameHandle(testCase,[h1 h1 h2 h3],[h1 h1; h2 h3])
Verification failed.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifySameHandle failed.
    --> Sizes do not match.
        	Actual Value Size           : [1  4]
        	Expected Handle Object Size : [2  2]
    
    Actual Value:
      1×4 ExampleHandle array with properties:
    
        Number
    Expected Handle Object:
      2×2 ExampleHandle array with properties:
    
        Number
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestHandlesForEqualityExample.m (TestHandlesForEqualityExample) at 48

Tips

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

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