run

R2026b

Class: matlab.unittest.TestCase
Namespace: matlab.unittest

Run tests corresponding to test case

Syntax

results = run(testCase)

results = run(testCase,method)

Description

results = run(testCase) runs all the Test methods of the class defining testCase and returns the test results.

The run method is a convenience method for interactive experimentation with TestCase subclasses. It runs the tests by using a TestRunner instance that is configured for text output. The text output includes test run progress as well as diagnostics in the event of test failures.

results = run(testCase,method) runs the specified Test method of testCase.

Input Arguments

testCase — Test case

matlab.unittest.TestCase object

Test case, specified as a matlab.unittest.TestCase object.

method — Identifier of Test method

string scalar | character vector | matlab.metadata.Method instance

Identifier of the Test method of testCase to run, specified as a string scalar, character vector, or matlab.metadata.Method instance.

Output Arguments

results — Test results

matlab.unittest.TestResult array

Test results, returned as a matlab.unittest.TestResult array. Each TestResult object in the array corresponds to a Test method in testCase.

Attributes

Sealed

true

To learn about attributes of methods, see Method Attributes.

Examples

Create and Run a Test Class

Test the properties of a figure by creating and running a test class.

In a file named FigurePropertiesTest.m in your current folder, create the FigurePropertiesTest test class by:

• Subclassing the matlab.unittest.TestCase class

• Adding a property to represent the figure to test

• Adding setup and teardown code for each test in a TestMethodSetup methods block

• Adding tests in a Test methods block

classdef FigurePropertiesTest < matlab.unittest.TestCase
    properties
        TestFigure
    end

    methods (TestMethodSetup)
        function createFigure(testCase)
            testCase.TestFigure = figure;
            testCase.addTeardown(@close,testCase.TestFigure)
        end
    end

    methods (Test)
        function defaultCurrentPoint(testCase)
            cp = testCase.TestFigure.CurrentPoint;
            testCase.verifyEqual(cp,[0 0], ...
                "Default current point must be [0 0].")
        end

        function defaultCurrentObject(testCase)
            import matlab.unittest.constraints.IsEmpty
            co = testCase.TestFigure.CurrentObject;
            testCase.verifyThat(co,IsEmpty, ...
                "Default current object must be empty.")
        end
    end
end

To run the tests interactively, create a test case from the test class. You also can use the forInteractiveUse static method to create a test case.

testCase = FigurePropertiesTest;

Run the tests corresponding to the test case. Both of the tests pass.

result1 = run(testCase)

Running FigurePropertiesTest

.

.
Done FigurePropertiesTest
__________

result1 = 
  1×2 TestResult array with properties:

    Name
    Passed
    Failed
    Incomplete
    Duration
    Details

Totals:
   2 Passed, 0 Failed, 0 Incomplete.
   0.10772 seconds testing time.

Now, run the defaultCurrentPoint Test method.

result2 = run(testCase,"defaultCurrentPoint")

Running FigurePropertiesTest

.
Done FigurePropertiesTest
__________

result2 = 
  TestResult with properties:

          Name: 'FigurePropertiesTest/defaultCurrentPoint'
        Passed: 1
        Failed: 0
    Incomplete: 0
      Duration: 0.0553
       Details: [1×1 struct]

Totals:
   1 Passed, 0 Failed, 0 Incomplete.
   0.055328 seconds testing time.

Version History

Introduced in R2013a

R2026b: Rerunning failed tests uses a default test runner instead of the original runner

When you run tests using the run method and then rerun failed tests using the rerun link in the test summary, the testing framework reruns the failed tests using a default test runner, which is equivalent to the runner that the testing framework configures by default when you call the runtests function.

In previous releases, the framework reruns failed tests using the original test runner.