sltest.testmanager.createTestForComponent
Syntax
Description
[
creates a test case and a test harness for the specified component in the test file or test
suite, tc
,status
] = sltest.testmanager.createTestForComponent('TestFile',tf
,'Component',component
)tf
. The component
must be a single
component and the test file tf
must already exist. If the test file
does not exist, you can include the CreateTestFile
,
true
Name-Value argument to create one. The returned
status
indicates whether the test case tc
was
created successfully.
[
creates a test case and test harness for each component specified in the
tc
,status
] = sltest.testmanager.createTestForComponent('TestFile',tf
,'TopModel',topModel
, 'Component',component
)component
array. If a test case was not created
successfully, the tc
array contains an
MException
object for that test case. Use this syntax to create more
than one test case and harness.
[
creates a test case or test harness for each component, with additional options specified by
one or more tc
,status
] = sltest.testmanager.createTestForComponent(___,Name,Value
)Name,Value
pair arguments. Specify name-value pair
arguments after the test file, component, and top model input arguments.
Examples
Create Baseline Test for a Model
This example shows how to create a baseline test case for the vdp
model and save the inputs in an Excel file. A test harness is created automatically.
Note that this code uses the current folder as the ExcelFileLocation
. To save the Excel file to another location, change the ExcelFileLocation
value to a different writable folder.
vdp tf = sltest.testmanager.TestFile('MyBaselineTestFile'); sltest.testmanager.createTestForComponent('TestFile',tf,... 'Component','vdp',... 'TestType','baseline',... 'ExcelFileLocation','mybaseline_inputdata.xlsx');
Create Equivalence Test for a Component
Create an equivalence (back-to-back) test case for the Controller
component of the sltestNormalSILEquivalenceExample
model.
load_system('sltestNormalSILEquivalenceExample'); tf = sltest.testmanager.TestFile('MyB2BTestFile'); sltest.testmanager.createTestForComponent("TestFile",tf,... "Component","sltestNormalSILEquivalenceExample/Controller",... "TestType","equivalence",... "Simulation1Mode","Normal",... "Simulation2Mode","Software-in-the-Loop (SIL)");
### Starting build procedure for: Controller ### Successful completion of build procedure for: Controller ### Creating SIL block ... Building with 'gcc'. MEX completed successfully. Build Summary Top model targets: Model Build Reason Status Build Duration ============================================================================================================= Controller Information cache folder or artifacts were missing. Code generated and compiled. 0h 0m 22.037s 1 of 1 models built (0 models already up to date) Build duration: 0h 0m 36.522s
Set Harness Options When Creating a Test Case
This example shows how to create a test case and test harness for a model component. It also shows how to use the HarnessOptions
property. The test case uses only a component harness and is set up with no inputs or baseline strategy. To use this test case creation strategy, the UseComponentInputs
property of createTestForComponent
function must be false, and the SLDVTestGeneration
property must be off
. The HarnessSource
property is ignored and the FunctionInterfaceName
is deduced from the argument passed to createTestForComponent
.
Once the test case is set up, you can specify the verification strategy for the component, such as importing test input data for the component into the created test case.
This code creates a test file and harness for the Contoller
component of the f14
model. The HarnessOptions specify that the harness name is myHarness
, a Signal Editor is used as the harness source, and the harness syncs with the model when the harness is opened.
f14 tcObj = sltest.testmanager.createTestForComponent(... 'CreateTestFile',true,'TestFile','MyHarnessTest', ... 'Component','f14/Controller','UseComponentInputs', ... false,'HarnessOptions',{'Name','myHarness', ... 'Source','Signal Editor','SynchronizationMode', ... 'SyncOnOpen'});
Create Baseline Tests and Harnesses for Multiple Components
load_system("sltestCruiseControl"); [result,status] = sltest.testmanager.createTestForComponent(... "CreateTestFile",true,... "TestFile","myTests.mldatx",... "TopModel","sltestCruiseControl",... "Component",[... "sltestCruiseControl/TargetSpeedThrottle",... "sltestCruiseControlMode/disableCaseDetection",... "sltestCruiseControl/DriverSwRequest",... "sltestCruiseControl"],... "CreateExcelFile",true);
Create Harnesses for Multiple Components
Create only test harnesses, not test cases, for multiple components of a model.
load_system('sltestCruiseControl'); [result, status] = sltest.testmanager.createTestForComponent(... 'CreateTestFile',true,... 'TestFile','myTests.mldatx',... 'TopModel','sltestCruiseControl',... 'Component',{... 'sltestCruiseControl/TargetSpeedThrottle',... 'sltestCruiseControlMode/disableCaseDetection',... 'sltestCruiseControl/DriverSwRequest',... 'sltestCruiseControl'},... 'UseComponentInputs',false,... 'HarnessOptions',{'SynchronizationMode','SyncOnOpen'});
Input Arguments
tf
— Test file or suite to which to add the test cases
sltest.testmanager.TestFile
object | sltest.testmanager.TestSuite
object | string | character vector
Test file or test suite to which to add the test cases, specified as an
sltest.testmanager.TestFile
or
sltest.testmanager.TestSuite
object, string, or character vector.
If CreateTestFile
is false
, the test file object
must exist. If CreateTestFile
is true
,
TestFile
is the path of a new test file, specified as a string or
character vector.
Example: 'TestFile','myTestFile'
component
— Component or components for which to create test cases and harnesses
string | character vector | Simulink.BlockPath
object | array | cell array
Component or components for which to create test cases and harnesses. To specify a
single component, use a Simulink.BlockPath
object or a string scalar
or character vector of the path to the component,. To specify more than one component,
use an array of Simulink.BlockPath
objects or a cell array of
character vectors or an array of strings where each element is the path to the
component. The components can be any block or block
diagram in the hierarchy of the top model. You can specify a component multiple times to
create multiple test cases and harnesses for that component. This input argument can be
any model or block that is supported for test
harness generation. See Test Harness and Model Relationship for a list of components for which you can build test
harnesses.
Example: 'Component','sf_car/shift_logic'
Example: 'Component',{'sldvdemo/Controller','sldvdemo/Pi
Controller'};
topModel
— Model name at top of hierarchy
string | character vector
Model name at the top of the hierarchy, specified as a string or character vector.
The top model is the name of the model whose hierarchy contains the components specified
in the component
input. You must specify the top model if your
component
input is an array with multiple components. Specifying
the top model is optional if the component
input is a single
component. If the component
input is a top model, do not use
specify the TopModel
.
Example: 'TopModel','Plant'
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.
Before R2021a, use commas to separate each name and value, and enclose
Name
in quotes.
Example: 'CreateTestFile',true
CreateTestFile
— Whether to create a new test file
false
(default) | true
Whether to create a new test file, specified as the comma-separated pair
consisting of 'CreateTestFile'
and true
or
false
.
Example: 'CreateTestFile',true
TestType
— Test case type
'baseline'
(default) | 'equivalence'
| 'simulation'
Test case type, specified as the comma-separated pair consisting of
'TestType'
and 'baseline'
,
'equivalence'
, or 'simulation'
.
Example: 'TestType','equivalence'
CreateHarness
— Whether to create test harness
true
(default) | false
Whether to create a test harness for a model, specified as the comma-separated
pair consisting of 'CreateHarness'
and true
or
false
. When component
is not a top-level
model or when you create multiple test cases and harnesses, this option is set to
true
automatically. When component
is an
export-function model and CreateHarness
is true
,
the function creates a Test Sequence block in the generated test harness.
To generate only a test harness, set SLDVTestGeneration to
off
and UseComponentInputs to
false
. Optionally specify any
desired HarnessOptions.
Example: 'CreateHarness',false
UseComponentInputs
— Option to simulate model to obtain inputs
true
(default) | false
Option to simulate the model to obtain component inputs for the created test
harness, specified as the comma-separated pair consisting of
'UseComponentInputs'
and true
or
false
. If this property is true
, the test
harness uses the inputs from the model simulation. If this property is
false
, the test harness does not use the component inputs from
the simulation, and no input signal files or
baseline criteria files are created.
Example: 'UseComponentInputs',false
FunctionInterface
— Function interface for a reusable library subsystem
string | character vector
Function interface, specified as the comma-separated pair consisting of
'FunctionInterface'
and a string or character vector. Specify
FunctionInterface
to create tests for a reusable library
subsystem. The subsystem must be at the top level of the subsystem library and must
have a function interface. This property is not supported if
component
is an array or cell array.
Example: 'FunctionInterface','single'
Simulation1Mode
— Simulation mode for simulation 1 of equivalence test
'Normal'
| 'Accelerator'
Simulation mode for simulation 1 of an equivalence test, specified as the
comma-separated pair consisting of 'Simulation1Mode'
and either
'Normal'
or 'Accelerator'
. If you do not
specify a simulation mode, the mode of the system under test is used. The required
test harness is created automatically for the simulation mode.
Example: 'Simulation1Mode','Normal'
Simulation2Mode
— Simulation mode for simulation 2 of equivalence test
'Normal'
| 'Accelerator'
| 'Rapid Accelerator'
| 'Software-in-the-Loop (SIL)'
| 'Processor-in-the-Loop (PIL)'
Simulation mode for simulation 2 of an equivalence test, specified as the
comma-separated pair consisting of 'Simulation2Mode'
and
'Normal'
, 'Accelerator'
, 'Rapid
Accelerator'
, 'Software-in-the-Loop (SIL)'
, or
'Processor-in-the-Loop (PIL)'
.. If you do not specify a
simulation mode, the mode of the system under test is used. If
TestType
is 'equivalence'
and
Simulation2Mode
is 'Software-in-the-Loop
(SIL)'
, an extra test harness is created in addition to the test case and
test harness, unless the component under test is an atomic subsystem. When equivalence
testing an atomic subsystem using normal and SIL or PIL modes, a single test harness
is created and used for both modes.
Example: 'Simulation2Mode','Software-in-the-Loop
(SIL)'
InputsLocation
— File or directory path for storing logged inputs in MAT-file
string | character vector
File or directory path for storing logged inputs in a MAT-file, specified as the
comma-separated pair consisting of 'InputsLocation'
and a character
vector or string. Include the file extension .mat
. If
component
is an array or cell array,
InputsLocation
must be an existing directory path. If you do not
specify InputsLocation
, the function creates a folder in the
current directory.
Example: 'InputsLocation','C:\MATLAB\inputs_data.mat'
BaselineLocation
— File or directory path for storing baseline logged outputs in MAT-file
string | character vector
File or directory path for storing baseline logged output data in a MAT-file,
specified as the comma-separated pair consisting of
'BaselineLocation'
and a character vector or string. Include the
file extension .mat
. If component
is an array
or cell array, BaselineLocation
must be an existing directory path.
If you do not specify BaselineLocation
, the function creates a
folder in the current directory.
Example: 'BaselineLocation','C:\MATLAB\baseline_data.mat'
CreateExcelFile
— Whether to use Excel format for inputs and outputs
false
(default) | true
Whether to use Excel® format for inputs and, for baseline tests only, outputs, specified as
the comma-separated pair consisting of 'CreateExcelFile'
and either
true
or false
. If you use the
'ExcelFileLocation'
argument to specify the filename and
location, you do not need to also use 'CreateExcelFile'
.
Example: 'CreateExcelFile',true
ExcelFileLocation
— File or directory path for Excel file
string | character vector
File path for the Excel file, specified as the comma-separated pair consisting of
'ExcelFileLocation'
and a character vector or string. Include the
file extension .xlsx
in the filename. If
component
is an array or cell array,
ExcelFileLocation
must be an existing directory path. If you
specify a location, you do not need to also use the
'CreateExcelFile'
option. If you do not specify an
ExcelFileLocation
, the function creates a folder in the current directory.
Note
If SLDVTestGeneration
is true
and
HarnessSource
is 'Signal Editor'
, you
cannot save data to an Excel file.
Example: 'ExcelFileLocation','C:\MATLAB\baseline_data.xlsx'
Sheet
— Name of Excel sheet to save data to
string | character vector
Name of Excel sheet in which to save data, specified as the comma-separated pair
consisting of 'Sheet'
and a character vector or string. If you are
creating a single test case and harness and do not specify a Sheet
,
the default sheet is used. When creating multiple test cases and harnesses, if you do
not specify a Sheet
, a default Excel sheet name is used.
Example: 'Sheet','MySubsysTest'
SLDVTestGeneration
— Whether to generate tests using Simulink® Design Verifier™
'off'
(default) | 'on'
| 'EnhancedMCDC'
Whether to generate tests using Simulink Design Verifier, specified as:
'off'
orfalse
— Do not use Simulink Design Verifier to generate tests.'on'
ortrue
— Use Simulink Design Verifier to generate tests and use the Simulink Design Verifier options from the model configuration.'EnhancedMCDC'
— Use Simulink Design Verifier to generate tests with the model coverage objectives as enhanced MCDC. TheEnhancedMCDC
option is valid only ifTestType
is'equivalence'
andSimulation2Mode
is'Software-in-the-Loop (SIL)'
or'Processor-in-the-Loop (PIL)'
.
Note
To generate tests from Simulink Design Verifier, the system under test must be an atomic subsystem.
Example: 'SLDVTestGeneration','on'
SimulateModelForSLDVTestGeneration
— Whether to simulate top model during test generation
false
(default) | true
Whether to simulate the top model during Simulink
Design Verifier test generation, specified as a logical value. When the returned tests
have model coverage lower than expected, after you analyze the possible causes and
reconfigure the default simulation, set this property to true
.
Then, rerun Simulink
Design Verifier test generation. If the coverage results are still lower than expected,
you can iterate the analysis, simulation reconfiguration, and test generation.
Example: 'SimulateModelForSLDVTestGeneration','true'
HarnessSource
— Input source block for the harness
'Inport'
(default) | 'Signal Editor'
Input source block for the test harness, specified as the comma-separated pair
consisting of 'HarnessSource'
and either
'Inport'
or 'Signal Editor'
. If you are not
generating any test input data
(UseComponentInputs
is false
), this property
is not supported. Instead, specify the value inside the
HarnessOptions
cell as {'Source','Test
Sequence'}
.
Example: 'HarnessSource','Signal Editor'
HarnessOptions
— Test harness creation options
cell array
Test harness creation options, specified as a cell array of comma-separated
name-value pairs. See sltest.harness.create
for valid
options. Do not include the harnessOwner
handle as the first
argument in the cell array. The first argument is set automatically to the
Component
value.
Only specify HarnessOptions
for either of these settings:
UseComponentInputs
isfalse
SLDVTestGeneration
ison
orEnhancedMCDC
)
If you are using Simulink
Design Verifier and need to use an external harness, use
HarnessOptions
to set only SaveExternally
to
true
. For this case, you cannot set other options at the same
time.
Example: 'UseComponentInputs',false,'HarnessOptions',{'SynchronizationMode','SyncOnOpen','Source','Test
Sequence','SeparateAssessment',true}
Example: 'SLDVTestGeneration','on','HarnessOptions',{'SaveExternally',true}
Output Arguments
tc
— Test case
sltest.testmanager.TestCase
object | cell array
Test case, returned as an sltest.testmanager.TestCase
object or a
cell array of test case objects. If a test or harness creation fails when creating
multiple test cases and harnesses, the cell array contains an
MException
or MSLException
object with failure
diagnostics. If component
is an array or cell array and one test or
harness creation fails, the function creates test cases and harnesses for other
components even if one component.
status
— Test case creation status
cell array
Test case creation status, returned as an array of true
and
false
values. true
indicates that the test case
was successfully created and
false
indicates that it failed.
Version History
Introduced in R2020bR2022a: Support for batch unit test case and harness creation
The component
input accepts a vector to support setting up unit
test cases and harnesses for multiple components at the same time. The new
status
output vector indicates whether the test creation was
successful.
R2021a: New 'EnhancedMCDC'
value for SLDVTestGeneration
property
You can now use the SLDVTestGeneration,'EnhancedMCDC'
name-value
argument to collect enhanced MCDC coverage for equivalence tests when the second simulation
is SIL or PIL.
SLDVTestGeneration
accepts 'EnhancedMCDC'
coverage collection for equivalence tests when the second simulation is SIL or PIL.
MATLAB 명령
다음 MATLAB 명령에 해당하는 링크를 클릭했습니다.
명령을 실행하려면 MATLAB 명령 창에 입력하십시오. 웹 브라우저는 MATLAB 명령을 지원하지 않습니다.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)