run

Class: sltest.testmanager.TestFile
Package: sltest.testmanager

Run test cases in test file

Syntax

resultObj = run(tf)
resultObj = run(tf,Name,Value)


Description

resultObj = run(tf) runs the enabled test cases in the test file.

resultObj = run(tf,Name,Value) uses additional options specified by one or more name-value arguments.

Input Arguments

tf — Test file

sltest.testmanager.TestFile object

Test file with the test cases you want to run, specified as an sltest.testmanager.TestFile object.

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: Parallel=true,Tags=["safety","regression"]

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: "Parallel",true,"Tags",["safety","regression"]

Parallel — Whether to run with parallel computing

false (default) | true

Whether to run tests with Parallel Computing Toolbox™ or MATLAB^® Parallel Server™, specified as either false or true. Requires Parallel Computing Toolbox or MATLAB Parallel Server license, respectively.

Example: run(tf,"Parallel",true)

Data Types: logical

Tags — Run only tests with specified tags

string array | cell array of character vectors

Specifies test tags for execution. For more information, see Tags.

Example: run(tf,"Tags",["safety"])

Example: run(tf,"Tags",["safety","regression"])

Data Types: cell | char | string

Output Arguments

resultObj — Results set object

sltest.testmanager.ResultSet object

Test results, returned as a results set object, sltest.testmanager.ResultSet.

Examples

Run a Test File

Open the model for this example.

openExample('sldemo_autotrans');

Create the test file, test suite, and test case structure.

tf = sltest.testmanager.TestFile("API Test File");
ts = createTestSuite(tf,"API Test Suite");
tc = createTestCase(ts,"simulation","Simulation Test Case");

Remove the default test suite.

tsDel = getTestSuiteByName(tf,"New Test Suite 1");
remove(tsDel);

Assign the system under test to the test case.

setProperty(tc,"Model","sldemo_autotrans");

Run the test file and return the results data.

ro = run(tf);

Run the Test File with Parallel Computing Toolbox

Open the model for this example.

openExample('sldemo_autotrans');

Create the test file, test suite, and test case structure.

tf = sltest.testmanager.TestFile("API Test File");
ts = createTestSuite(tf,"API Test Suite");
tc = createTestCase(ts,"simulation","Simulation Test Case");

Remove the default test suite.

tsDel = getTestSuiteByName(tf,"New Test Suite 1");
remove(tsDel);

Assign the system under test to the test case.

setProperty(tc,"Model","sldemo_autotrans");

Run the test file with Parallel Computing Toolbox and return the results data.

ro = run(tf,"Parallel",true);

Version History

Introduced in R2015b