verifyNotEqual

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

Verify value is not equal to specified value

Syntax

verifyNotEqual(testCase,actual,prohibited)

verifyNotEqual(testCase,actual,prohibited,diagnostic)

Description

verifyNotEqual(testCase,actual,prohibited) verifies that actual is not equal to prohibited.

verifyNotEqual(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

any value

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

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

Compare Numeric Values

Create a test case for interactive testing.

testCase = matlab.unittest.TestCase.forInteractiveUse;

Compare a numeric value to itself. The test fails.

verifyNotEqual(testCase,5,5,"Values must be different.")

Verification failed.
    ----------------
    Test Diagnostic:
    ----------------
    Values must be different.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyNotEqual failed.
    --> The numeric values are equal using "isequaln".
    
    Actual Value:
         5
    Prohibited Value:
         5
    ------------------
    Stack Information:
    ------------------
    In C:\work\CompareNumericValuesExample.m (CompareNumericValuesExample) at 12

Verify that different numeric scalars are not equal.

verifyNotEqual(testCase,4.95,5)

Verification passed.

Verify that values of different sizes are not equal.

verifyNotEqual(testCase,[5 5],5)

Verification passed.

Compare Classes

Create a test case for interactive testing.

testCase = matlab.unittest.TestCase.forInteractiveUse;

Compare two numeric values of different classes. The test passes.

verifyNotEqual(testCase,int8(5),int16(5))

Verification passed.

Compare Cell Arrays

Create a test case for interactive testing.

testCase = matlab.unittest.TestCase.forInteractiveUse;

Test if two cell arrays are not equal.

verifyNotEqual(testCase,{'cell',struct,5},{'cell',struct,4.95})

Verification passed.

Tips

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

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

  More functionality is available when using the IsEqualTo constraint directly via verifyThat.

• Use verification qualifications to produce and record failures without throwing an exception. Because 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 because 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

R2022b: Compare dictionaries in tests

You can use the verifyNotEqual method to compare MATLAB^® dictionaries.

R2019a: Table variables are consistently compared

The verifyNotEqual method now consistently compares the size and type of table variables. For example, this test passes because the actual and expected table variables have different types.

testCase = matlab.unittest.TestCase.forInteractiveUse;
act = table(zeros(0,2));
exp = table({});
testCase.verifyNotEqual(act,exp)

Verification passed.

In previous releases, the test fails because the method does not compare the table variables when the tables have no rows.