run

Class: sltest.testmanager.TestFile
Namespace: sltest.testmanager

Run test cases in test file

expand all in page

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

expand all

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

Name-Value Arguments

expand all

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,SimulationMode="Accelerator"

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

Example: "Parallel",true,"SimulationMode","Accelerator"

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

Simulation mode to use for running a test file in the Test Manager, specified as "Normal", "Accelerator", "Rapid Accelerator", "Software-in-the-Loop", or "Processor-in-the-Loop". When you specify this name-value argument, the setting overrides the simulation mode set in the Test Manager. You do not need to update the test parameters or settings when running the test file in the new mode.

The SimulationMode value

  • Applies to both simulations in an equivalence test.

  • Applies to all iterations in a test case.

  • Applies to multirelease tests.

  • Does not apply to baseline captures.

  • Does not apply to real-time tests or MATLAB-based Simulink® tests.

If you set SimulationMode to "Software-in-the-Loop" or "Processor-in-the-Loop", and select Override model blocks in SIL/PIL mode to normal mode in the System Under Test section of the Test Manager, the Test Manager uses the SimulationMode value to run the test.

Example: "SimulationMode","Accelerator"

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

expand all

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

Examples

expand all

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);

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

expand all

See Also

Topics