Main Content

verifyNotSameHandle

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

Verify value is not handle to specified instance

Syntax

verifyNotSameHandle(verifiable,actual,notExpectedHandle)
verifyNotSameHandle(___,diagnostic)

Description

verifyNotSameHandle(verifiable,actual,notExpectedHandle) verifies that actual is a different size and/or does not contain the same instances as the notExpectedHandle handle array.

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

notExpectedHandle

The handle array to compare.

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;

Handles point to different objects.

verifyNotSameHandle(testCase, h1, h2);
Interactive verification passed.

Show matching handle combinations.

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

---------------------
Framework Diagnostic:
---------------------
verifyNotSameHandle failed.
--> The two handles must not refer to the same handle, or should have 
different sizes.

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

Test failed.

The order of the handle arguments matters.

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

Test a handle with itself.

verifyNotSameHandle(testCase, h1, h1);
Interactive verification failed.

---------------------
Framework Diagnostic:
---------------------
verifyNotSameHandle failed.
--> The two handles must not refer to the same handle, or should have 
different sizes.

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

Test failed.

Variables are not same size.

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

Variables are the same size.

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

---------------------
Framework Diagnostic:
---------------------
verifyNotSameHandle failed.
--> The two handles must not refer to the same handle, or should have 
different sizes.

Actual Value:
      1x2 ExampleHandle array with no properties.
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(notExpectedHandle));

    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