Main Content

verifySameHandle

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

Verify two values are handles to same instance

Syntax

verifySameHandle(verifiable,actual,expectedHandle)
verifySameHandle(___,diagnostic)

Description

verifySameHandle(verifiable,actual,expectedHandle) verifies that actual is the same size and contains the same instances as the expectedHandle handle array.

verifySameHandle(___,diagnostic) also associates the diagnostic information in diagnostic with the qualification. 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.

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.

expectedHandle

The expected handle array.

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;

Create a handle class, ExampleHandle.

classdef ExampleHandle < handle
end

Create two handle variables.

h1 = ExampleHandle;
h2 = ExampleHandle;

Show matching handle combinations.

verifySameHandle(testCase, h1, h1);
Interactive verification passed.
verifySameHandle(testCase, [h1 h1], [h1 h1]);
Interactive verification passed.
verifySameHandle(testCase, [h1 h2 h1], [h1 h2 h1]);
Interactive verification passed.

Handles must point to same object.

verifySameHandle(testCase, h1, h2);
Interactive verification failed.

---------------------
Framework Diagnostic:
---------------------
verifySameHandle failed.
--> Values do not refer to the same handle.

Actual Value:
      ExampleHandle with no properties.
Expected Handle Object:
      ExampleHandle with no properties.

Test failed.

Size of handle objects must match.

verifySameHandle(testCase, [h1 h1], h1);
Interactive verification failed.

---------------------
Framework Diagnostic:
---------------------
verifySameHandle failed.
--> Sizes do not match.
    	Actual Value Size           : [1  2]
    	Expected Handle Object Size : [1  1]

Actual Value:
      1x2 ExampleHandle array with no properties.
Expected Handle Object:
      ExampleHandle with no properties.

Test failed.

Order of arguments is important.

verifySameHandle(testCase, [h1 h2], [h2 h1]);
Interactive verification failed.

---------------------
Framework Diagnostic:
---------------------
verifySameHandle failed.
--> Some elements in the handle array refer to the wrong handle.

Actual Value:
      1x2 ExampleHandle array with no properties.
Expected Handle Object:
      1x2 ExampleHandle array with no properties.

Test failed.

Tips

  • This method is functionally equivalent to:

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

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

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

Introduced in R2013a