runtests - Run set of tests - MATLAB (original) (raw)

Syntax

Description

[testResults](#mw%5Fccbac464-285a-4a54-a87f-d7eb3d3e811d) = runtests runs all the tests in your current folder and returns the test results.

example

[testResults](#mw%5Fccbac464-285a-4a54-a87f-d7eb3d3e811d) = runtests([tests](#btzwrop-tests)) runs the specified tests.

example

[testResults](#mw%5Fccbac464-285a-4a54-a87f-d7eb3d3e811d) = runtests(___,[Name=Value](#namevaluepairarguments)) specifies options using one or more name-value arguments in addition to any of the input argument combinations in previous syntaxes. For example, testResults = runtests(IncludeSubfolders=true) runs all the tests in the current folder and any of its subfolders.

example

[[testResults](#mw%5Fccbac464-285a-4a54-a87f-d7eb3d3e811d),[coverageResults](#mw%5F7afac245-79ef-42a5-8e37-d974bd882a5b)] = runtests(___) also returns the results of the code coverage analysis when you specify theReportCoverageFor name-value argument. (since R2023b)

example

Examples

collapse all

Create a folder myExample in your current working folder, and change into that folder.

In the myExample folder, create a test script, typeTest.m.

%% Test double class exp = 'double'; act = ones; assert(isa(act,exp))

%% Test single class exp = 'single'; act = ones('single'); assert(isa(act,exp))

%% Test uint16 class exp = 'uint16'; act = ones('uint16'); assert(isa(act,exp))

In the myExample folder, create a test script, sizeValueTest.m.

%% Test size exp = [7 13]; act = ones([7 13]); assert(isequal(size(act),exp))

%% Test values act = ones(42); assert(unique(act) == 1)

Run all tests in the current folder.

Running sizeValueTest .. Done sizeValueTest

Running typeTest ... Done typeTest

ans =

1x5 TestResult array with properties:

Name
Passed
Failed
Incomplete
Duration
Details

Totals: 5 Passed, 0 Failed, 0 Incomplete. 0.038077 seconds testing time.

MATLAB® ran 5 tests. There are 2 passing tests from sizeValueTest and 3 passing tests from typeTest.

Create the test file shown below, and save it as runtestsExampleTest.m on your MATLAB path.

function tests = runtestsExampleTest tests = functiontests(localfunctions);

function testFunctionOne(testCase)

Run the tests.

results = runtests('runtestsExampleTest.m');

Running runtestsExampleTest . Done runtestsExampleTest

If it does not exist, create the runtestsExampleTest.m test file from the previous example.

Create a subfolder, tmpTest, and, in that folder, create this runtestsExampleSubfolderTest.m test file.

function tests = runtestsExampleSubfolderTest tests = functiontests(localfunctions);

function testFunctionTwo(testCase)

Run the tests from the folder above tmpTest by specifying IncludeSubfolders astrue. The runtests function runs the tests in both the current folder and the subfolder.

results = runtests(pwd,IncludeSubfolders=true);

Running runtestsExampleTest . Done runtestsExampleTest

Running runtestsExampleSubFolderTest . Done runtestsExampleSubFolderTest

If you do not specify the IncludeSubfolders name-value argument, runtests does not run the test in the subfolder.

Running runtestsExampleTest . Done runtestsExampleTest

When your current folder is a project root folder or when you pass the path to a project root folder to the runtests function, runtests runs all test files contained in the specified project that are labeled with the Test classification.

This example assumes that a project folder atC:\projects\project1 contains test files that are labeled with the Test classification. Change your current folder to the project root folder and run the tests in the project.

cd 'C:\projects\project1' runtests

Alternatively, you can run the tests by openingproject1. Close the project when you are finished.

proj = openProject('C:\projects\project1'); runtests close(proj)

As another alternative, run the tests in the project by passing the full path to the project root folder to runtests.

runtests('C:\projects\project1')

Create this function-based test in a file namedrunInParallelTest.m in your current folder.

function tests = runInParallelTest tests = functiontests(localfunctions);

function testA(testCase) verifyEqual(testCase,5,5);

function testB(testCase) verifyTrue(testCase,logical(1));

function testC(testCase) verifySubstring(testCase,'SomeLongText','Long');

function testD(testCase) verifySize(testCase,ones(2,5,3),[2 5 3]);

function testE(testCase) verifyGreaterThan(testCase,3,2);

function testF(testCase) verifyEmpty(testCase,{},'Cell array is not empty.');

function testG(testCase) verifyMatches(testCase,'Some Text','Some [Tt]ext');

Run the tests in parallel. Running tests in parallel requires Parallel Computing Toolbox™. The testing framework might vary the order and number of groups or which tests it includes in each group.

results = runtests("runInParallelTest.m",UseParallel=true);