verifyMatches

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

Verify string matches specified regular expression

Syntax

verifyMatches(testCase,actual,expression)

verifyMatches(testCase,actual,expression,diagnostic)

Description

verifyMatches(testCase,actual,expression) verifies that actual is a string scalar or character vector that matches the specified regular expression.

verifyMatches(testCase,actual,expression,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. Although you can provide a value of any data type, the test fails if actual is not a string scalar or character vector.

expression — Regular expression to match

string scalar | character vector

Regular expression that the actual value must match, specified as a string scalar or character vector.

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 if Actual Value Matches Regular Expression

Create a test case for interactive testing.

testCase = matlab.unittest.TestCase.forInteractiveUse;

Define the actual value.

actual = "Some Text";

Verify that the actual value matches "^Som".

verifyMatches(testCase,actual,"^Som")

Verification passed.

Show that case matters. The following test fails because the actual value does not start with a lowercase letter.

verifyMatches(testCase,actual,"^som","Test is case sensitive.")

Verification failed.
    ----------------
    Test Diagnostic:
    ----------------
    Test is case sensitive.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyMatches failed.
    --> The value does not match the regular expression.
    
    Actual Value:
        "Some Text"
    Regular Expression:
        "^som"
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestIfActualValueMatchesRegularExpressionExample.m (TestIfActualValueMatchesRegularExpressionExample) at 21

Define another regular expression. The [Tt]? contained in the expression indicates that either "T" or "t" matches at that location 0 times or 1 time.

expression = "Some [Tt]?ext";

Verify that the actual value matches the specified expression.

verifyMatches(testCase,actual,expression)

Verification passed.

Tips

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

  import matlab.unittest.constraints.Matches
  testCase.verifyThat(actual,Matches(expression))
  

  More functionality is available when using the Matches 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