verifyNotSameHandle

Class: matlab.unittest.qualifications.Verifiable
Namespace: matlab.unittest.qualifications

Verify two handle arrays are different

Syntax

verifyNotSameHandle(testCase,actual,prohibited)

verifyNotSameHandle(testCase,actual,prohibited,diagnostic)

Description

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

verifyNotSameHandle(testCase,actual,prohibited,diagnostic) also associates the diagnostic information in diagnostic with the qualification.

Input Arguments

testCase — Test case

matlab.unittest.qualifications.Verifiable object

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

actual — Value to test

any value

Value to test, specified as a value of any data type.

prohibited — Value to compare against

handle array

Value to compare against, specified as a handle array.

diagnostic — Diagnostic information to display

string array | character array | function handle | array of matlab.automation.diagnostics.Diagnostic objects

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

Depending on the test runner configuration, the testing framework can 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

Sealed

true

To learn about attributes of methods, see Method Attributes.

Examples

Test Handles for Inequality

Test if the actual value is not 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;

Verify that h1 and h2 point to different objects.

verifyNotSameHandle(testCase,h1,h2)

Verification passed.

Test if h2 and h3 point to different objects. The test fails.

verifyNotSameHandle(testCase,h2,h3, ...
    "Values must point to different objects.")

Verification failed.
    ----------------
    Test Diagnostic:
    ----------------
    Values must point to different objects.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyNotSameHandle failed.
    --> The two handles must not refer to the same handle, or should have different sizes.
    
    Actual Value:
      ExampleHandle with properties:
    
        Number: 1
    Prohibited Handle Object:
      ExampleHandle with properties:
    
        Number: 1
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestHandlesForInequalityExample.m (TestHandlesForInequalityExample) at 33

Verify that [h1 h2] is not the same as [h2 h1]. The test passes because the corresponding vector elements point to different objects.

verifyNotSameHandle(testCase,[h1 h2],[h2 h1])

Verification passed.

Test if [h2 h3] is not the same as [h3 h2]. The test fails because the corresponding vector elements point to the same object.

verifyNotSameHandle(testCase,[h2 h3],[h3 h2])

Verification failed.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyNotSameHandle failed.
    --> The two handles must not refer to the same handle, or should have different sizes.
    
    Actual Value:
      1×2 ExampleHandle array with properties:
    
        Number
    Prohibited Handle Object:
      1×2 ExampleHandle array with properties:
    
        Number
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestHandlesForInequalityExample.m (TestHandlesForInequalityExample) at 44

Verify that two handle arrays of different shapes are not the same.

verifyNotSameHandle(testCase,[h1 h1 h2 h3],[h1 h1; h2 h3])

Verification passed.

Tips

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

  import matlab.unittest.constraints.IsSameHandleAs
  testCase.verifyThat(actual,~IsSameHandleAs(prohibited))

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

Version History

Introduced in R2013a

R2019b: Character vectors are no longer equivalent to enumerations

In qualifications, character vectors are no longer equivalent to enumerations of a handle class. For example, consider this enumeration class.

classdef MyClass < handle
    enumeration
        X
        Y
    end
end

This test passes because 'X' does not represent the enumeration MyClass.X. In previous releases, the test fails.

testCase = matlab.unittest.TestCase.forInteractiveUse;
testCase.verifyNotSameHandle('X',MyClass.X)

Verification passed.