Test Scripts

Create and run tests using command-line functions and scripts, set test preferences

You can use the Simulink^® Test™ programmatic interface to:

Create test scripts and functions.
Run tests from the command line.
Set up and standardize your testing environment.

You can use scripts and functions to repeat the same test strategy on multiple systems, or perform regression testing. These functions and classes cover test authoring, execution, and results in Simulink Test. If you want to combine existing Simulink tests with MATLAB^® tests, or run tests with continuous integration, use the MATLAB Unit Test Framework. See Continuous Integration. If you want to run tests on third-party test benches, see ASAM XIL Tests.

Simulink Test also provides graphical user interfaces to help you create and run tests. For more information, see Test Authoring, Test Execution, and Results, Reporting, and Test File Management.

Functions

expand all

Test Authoring

Test Files

`sltest.testmanager.TestFile`	Create or modify test file
`sltest.testmanager.TestSuite`	Create or modify test suite
`sltest.testmanager.TestCase`	Create or modify test case
`sltest.testmanager.createTestForComponent`	Create test cases and test harnesses for model or model components
`sltest.testmanager.createTestsFromModel`	Generate test cases from a model
`sltest.testmanager.copyTests`	Copy test cases or test suites to another location
`sltest.testmanager.moveTests`	Move test cases or test suites to a new location
`sltest.testmanager.load`	Load a test file in the Simulink Test manager
`sltest.testmanager.getTestFiles`	Get test files open in the Test Manager
`sltest.testmanager.clear`	Clear test files from the Test Manager

Inputs

`sltest.testmanager.TestInput`	Add or modify test input
`sltest.import.sldvData`	Create test cases from Simulink Design Verifier results
`sltest.io.SimulinkTestSpreadsheet`	Read spreadsheet in format used by Simulink Test
`sltest.testmanager.registerTestAdapter`	Register adapter to convert test data

Outputs

`sltest.testmanager.BaselineCriteria`	Add or modify baseline criteria
`sltest.testmanager.EquivalenceCriteria`	Add or modify equivalence criteria
`sltest.testmanager.SignalCriteria`	Add or modify signal criteria
`sltest.testmanager.CustomCriteria`	Add or modify custom criteria
`sltest.testmanager.LoggedSignal`	Create or modify logged signals for use as simulation outputs
`sltest.testmanager.LoggedSignalSet`	Create or modify a set of logged signals
`sltest.testmanager.OutputTrigger`	Signal logging output start and stop triggers
`sltest.testmanager.OutputTriggerResult`	Signal logging output trigger results
`sltest.testmanager.TriggerMode`	Output trigger type

Iterations

`sltestiteration`	Create test iteration
`sltest.testmanager.TestIteration`	Create or modify test iteration
`sltest.testmanager.ParameterSet`	Add or modify parameter set
`sltest.testmanager.ParameterOverride`	Add or modify parameter override

MATLAB-Based Simulink Tests

`sltest.TestCase`	Test case class for MATLAB-based Simulink tests
`loadSystem`	Load model for MATLAB-based Simulink test
`simulate`	Simulate model or `Simulink.SimulationInput` for MATLAB-based Simulink test
`sltest.TestCase.forInteractiveUse`	Create test case for interactive use
`createTemporaryFolder`	Create temporary folder
`assumeSignalsMatch`	Assume two data sets are equivalent
`assertSignalsMatch`	Assert two data sets are equivalent
`fatalAssertSignalsMatch`	Fatally assert two data sets are equivalent
`verifySignalsMatch`	Verify two sets of data are equivalent
`sltest.harness.SimulationInput`	Create test harness simulation input for MATLAB-based Simulink tests
`createSimulationInput`	Create simulation input object
`addModelCoverage`	Enable model coverage collection for Simulink tests
`addSimulinkTestResults`	Enable pushing test results to Simulink Test Manager
`sltest.plugins.MATLABTestCaseIntegrationPlugin`	Add simulation and test results for MATLAB-based Simulink tests to Test Manager
`sltest.plugins.ToTestManagerLog`	Output stream to write text to Test Manager result Logs for MATLAB-based Simulink tests
`sltest.plugins.ModelCoveragePlugin`	Collect model coverage using the MATLAB Unit Test framework

Test Harnesses

`sltest.harness.check`	Compare component under test between harness model and main model
`sltest.harness.clone`	Copy test harness
`sltest.harness.close`	Close test harness
`sltest.harness.convert`	Convert test harnesses between internal and external storage
`sltest.harness.create`	Create test harnesses
`sltest.harness.setHarnessCreateDefaults`	Customize default property values for test harness creation
`sltest.harness.getHarnessCreateDefaults`	Get harness creation default values
`sltest.harness.delete`	Delete test harness
`sltest.harness.export`	Export test harness to Simulink model
`sltest.harness.find`	Find test harnesses in model
`sltest.harness.import`	Import Simulink model to test harness
`sltest.harness.load`	Load test harness
`sltest.harness.move`	Move test harness from linked instance to library block or to a different harness owner
`sltest.harness.open`	Open test harness
`sltest.harness.push`	Push test harness workspace entries and configuration set to model
`sltest.harness.rebuild`	Rebuild test harness and update workspace entries and configuration parameter set based on main model
`sltest.harness.set`	Change test harness property
`sltest.harness.showDialog`	Show test harness dialog box

Test Sequences

Steps, Transitions, and Symbols

`sltest.testsequence.addStep`	Add test sequence step
`sltest.testsequence.addStepAfter`	Add test sequence step after existing step
`sltest.testsequence.addStepBefore`	Add test sequence step before existing step
`sltest.testsequence.addSymbol`	Add symbol to test sequence
`sltest.testsequence.addTransition`	Add new transition to test sequence step
`sltest.testsequence.deleteStep`	Delete test sequence step
`sltest.testsequence.deleteSymbol`	Delete test sequence block symbol
`sltest.testsequence.deleteTransition`	Delete test sequence transition
`sltest.testsequence.editStep`	Edit test sequence step
`sltest.testsequence.editSymbol`	Edit symbol in Test Sequence block
`sltest.testsequence.editTransition`	Edit test sequence step transition
`sltest.testsequence.find`	Find Test Sequence blocks
`sltest.testsequence.findStep`	Find test sequence steps
`sltest.testsequence.findSymbol`	Find Test Sequence block symbols
`sltest.testsequence.getProperty`	Get Test Sequence block properties
`sltest.testsequence.newBlock`	Create Test Sequence block
`sltest.testsequence.readStep`	Read Test Sequence block steps
`sltest.testsequence.readSymbol`	Read Test Sequence block symbol properties
`sltest.testsequence.readTransition`	Read properties of test sequence transition
`sltest.testsequence.setProperty`	Set Test Sequence block properties

Scenarios

`sltest.testsequence.activateScenario`	Set Test Sequence block scenario as active
`sltest.testsequence.addScenario`	Add new scenario to Test Sequence block
`sltest.testsequence.deleteScenario`	Delete scenario from Test Sequence block
`sltest.testsequence.editScenario`	Edit Test Sequence block test scenario properties
`sltest.testsequence.getActiveScenario`	Get Test Sequence block active scenario
`sltest.testsequence.getAllScenarios`	Get names of all Test Sequence block scenarios
`sltest.testsequence.getScenarioControlSource`	Get source that controls Test Sequence active scenario
`sltest.testsequence.isUsingScenarios`	Determine whether Test Sequence block uses scenarios
`sltest.testsequence.setScenarioControlSource`	Set source controlling Test Sequence active scenario
`sltest.testsequence.useScenario`	Convert Test Sequence block to scenario mode

Test Assessments

`sltest.Assessment`	Access assessment from set
`sltest.AssessmentSet`	Access a set of assessments from a simulation
`sltest.getAssessments`	Returns test assessment set object
`sltest.testmanager.Assessment`	Logical or temporal assessment object
`sltest.testmanager.AssessmentSymbol`	Symbol used in assessment

Test Execution

`sltest.testmanager.run`	Run tests with Test Manager
`sltest.testmanager.CoverageSettings`	Modify coverage settings
`sltest.plugins.coverage.CoverageMetrics`	Specify coverage metrics for tests run with MATLAB Unit Test framework
`sltest.testmanager.addTestsForMissingCoverage`	Add tests to increase coverage
`sltest.testmanager.mergeCoverage`	Merge coverage results from two or more test result sets
`sltest.testmanager.TestOptions`	Options for adding test coverage
`sltest.xil.framework.Framework`	Initialize test bench, start and stop simulation, and display test bench, variable, and task
`sltest.xil.framework.FrameworkConfiguration`	Configure test bench ports and variable mapping
`sltest.xil.framework.TestVariable`	Read and write variable mapped to test bench
`sltest.xil.framework.Stimulation`	Control external input to test bench
`sltest.xil.framework.Acquisition`	Control signal data logging on test bench and retrieve logged data
`sltest.CodeImporter`	Import C or C++ code into Simulink for testing
`sltest.CodeImporter.SandboxSettings`	Sandbox settings for C code testing

Results and Reports

`sltest.testmanager.ResultSet`	Access results set data
`sltest.testmanager.TestFileResult`	Access test file results data
`sltest.testmanager.TestSuiteResult`	Access test suite results data
`sltest.testmanager.TestCaseResult`	Access test case results data
`sltest.testmanager.TestIterationResult`	Access test iteration result data
`sltest.testmanager.ComparisonRunResult`	Access result of a comparison test
`sltest.testmanager.ComparisonSignalResult`	Access signal comparison results from a baseline or equivalence result
`sltest.testmanager.CustomCriteriaResult`	View custom criteria test result
`sltest.testmanager.importResults`	Import Test Manager results file
`sltest.testmanager.exportResults`	Export results set from Test Manager
`sltest.testmanager.getResultSets`	Returns result set objects in Test Manager
`sltest.testmanager.clearResults`	Clear results from Test Manager
`sltest.testmanager.report`	Generate report of test results
`sltest.testmanager.TestResultReport`	Customize generated results report
`sltest.testmanager.TestSpecReport`	Generate report of test specifications
`sltest.testmanager.DiagnosticRecord`	View custom criteria diagnostic information
`sltest.testmanager.TestResultContainer`	Container for MLDATX test file results from MATLAB Unit Test `run` or `runInParallel`

Operations and Preferences

`sltest.testmanager.view`	Launch the Simulink Test Manager
`sltest.testmanager.setpref`	Set Test Manager preferences
`sltest.testmanager.getpref`	Get Test Manager preferences
`sltest.testmanager.Options`	Return and specify test file options
`sltest.testmanager.close`	Close the Simulink Test Manager

Topics

Create and Run Test Cases with Scripts
Examples of how to create and run tests using the programmatic interface.
Test Models Using MATLAB-Based Simulink Tests
Write test files in MATLAB that can be used in the Test Manager.
Programmatically Create and Run Test Sequence Scenarios
Add test scenarios to Test Sequence block programmatically.

Featured Examples

Programmatically Create a Test Sequence

Create a test harness and test sequence using the programmatic interface. You create a test harness and a Test Sequence block, and author a test sequence to verify two functional attributes of a cruise control system.

Open Script

Using MATLAB-Based Simulink Tests in the Test Manager

Use MATLAB-based Simulink test to simulate a model and verify it against a baseline.

Open Script

Collect Coverage Using MATLAB-Based Simulink Tests

Collect model coverage using test scripts and load to Test Manager using MATLAB Test Framework.

Open Script

Generating a Test Results Report

Report test results for a baseline test.

Open Script

Append Code to a Test Report

Use a customization class to print integrated code in a test results report. If you test models that include handwritten code, you can print the code to a report to be reviewed with the test results.

Open Script