sltest.testmanager.TestCaseResult - Access test case results data - MATLAB (original) (raw)

Namespace: sltest.testmanager
Superclasses: sltest.testmanager.TestIterationResult

Access test case results data

Description

An sltest.testmanager.TestCaseResult enables you to access results from executing test cases or test files.

The sltest.testmanager.TestCaseResult class is a handle class.

Creation

`tcr` = getTestCaseResults(`ResultSet`) returns tcr a test case result from a ResultSet.

Properties

expand all

The total number of tests in an individual test case result, returned as an integer.

Attributes:

The number of passed tests in an individual test case result, returned as an integer.

Attributes:

The number of failed tests in an individual test case result, returned as an integer.

Attributes:

The number of disabled tests in an individual test case result, returned as an integer.

Attributes:

The number of incomplete tests in an individual test case result, returned as an integer.

Attributes:

Outcome of an individual test case result, returned as an enumerated value. Valid values are:

• Disabled
• Failed
• Incomplete
• Passed
• Running
• Scheduled
• Untested

Attributes:

Test case name, returned as a string.

Attributes:

Path of the input data file, returned as a string.

Attributes:

The path of the test file used to create the test case result.

Attributes:

The hierarchy path in the parent result set.

Attributes:

The type of test case from the three available test cases in the Test Manager: simulation, baseline, and equivalence.

Attributes:

Indicates if the simulation runs on a target, returned as a cell array of Booleans.

Attributes:

Time the test case began to run, returned as a datetime.

Attributes:

Time the test case completed, returned as a datetime.

Attributes:

Length of time the test case ran, in seconds, returned as a duration.

Attributes:

Requirements associated with the test case, returned as an array of strings.

Attributes:

Error messages produced by the test case, returned as a struct. The struct contains two fields, TestCase andSimulation. The TestCase field is a string array that contains the names of the test cases. TheSimulation field is a struct with two fields,simulationIndex and messages. Themessages field is a string array that contains the text of the error messages.

Attributes:

Log messages produced by the test case, returned as a struct. The struct contains two fields, TestCase andSimulation. The TestCase field is a string array that contains the names of the test cases. TheSimulation field is a struct with two fields,simulationIndex and messages. Themessages field is a string array that contains the text of the log messages.

Attributes:

Cause of the test case failure, returned as an array of strings.

Attributes:

Description text for why the test case was disabled, returned as a string.

Attributes:

Name of the baseline file used in the test case, returned as a string.

Attributes:

Name of external input and external input file, returned as a struct.

Attributes:

Test case parameters that can override model parameters, returned as a struct containing the name of the sltest.testmanager.ParameterSet object, path to the object, and a structure that lists the parameter overrides.

Attributes:

Fault set information, returned as a struct. The structure has two fields:

• FaultSetName — The names of the fault set, returned as a character vector.
• SpecifiedFaults — The enabled faults in the fault set, returned as a struct. Each element of this struct is a struct that contains three fields:
  • ModelElement — The model element path of the fault, returned as a character vector.
  • FaultName — The fault name, returned as a character vector.
  • Trigger — The fault trigger type, returned as a character vector.
    For more information on these fault properties, see Specify Fault Properties (Simulink Fault Analyzer).

If you do not have Simulink® Fault Analyzer™, this property is empty.

Attributes:

Name of Signal Editor scenario used in the test case, returned as a string.

Attributes:

Test sequence scenario used in the test case, returned as a struct. The struct contains two fields, TestSequenceBlock andTestSequenceScenario. TheTestSequenceBlock field is the path of the Test Sequence block that contains the scenario. TheTestSequenceScenario is the name of the scenario that ran during the test. The test sequence information is returned in theTestCaseResult object only if the test case did not include iterations. If iterations were included, theTestSequenceScenario is returned in aTestIterationResults object.

Attributes:

Since R2024a

Variant configuration applied to the model before running the test case, specified as a struct with Name,Description, and ControlVariables fields.

This property applies to models that have variant configurations created using Variant Manager for Simulink, and if the VariantConfiguration property is specified on the test case object.

For an example, see Run Tests for Variant Models Using Variant Configurations.

Example: "LinInterExpNoNoise"

Attributes:

Data Types: struct

Metadata of the simulation, returned as a Simulink.SimulationMetadata object.

Attributes:

Release in which the test was run, returned as a character vector.

Attributes:

Description of the test case, returned as a character vector.

Attributes:

Test coverage results, returned as a character array.

Attributes:

Tags to filter the test file results. Use tags to view a subset of the test results. See Tags for more information.

Attributes:

Parent of the result. The parent of a test case result is a test suite result or result set object.

Attributes:

Custom data stored with the test case results, specified as any type of data. Use this field to add custom information, such as the settings used to obtain the results.

Attributes:

RoadRunner settings used to produce the test case results, returned as a structure that contains these fields:

• RoadRunnerProjectPath — Path to RoadRunner project
• RoadRunnerInstallationPath — Path to RoadRunner application
• RoadRunnerScenarioPath — Path to RoadRunner scenario
• RunInConsoleMode — Whether the scenario ran in console or graphical mode
• TurnOffPacing — Whether the scenario ran with pacing turned off or on

This property applies only to RoadRunner test cases.

Attributes:

Platform on which test case ran, returned as a string This property applies only to RoadRunner test cases.

Attributes:

Methods

Examples

collapse all

This example shows how to run a test file from the test manager and obtain a results set. In this example, the Outcome of the first test case is Failed because a model is not specified.

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

tf = sltest.testmanager.TestFile('My Test File'); ts = createTestSuite(tf,'Baseline Test Suite'); tc = createTestCase(ts,'baseline','Baseline Test Case');

Run the test file and obtain the output results set.

resultset = sltest.testmanager.run;

Get the test file, test suite, and test case result objects.

tfr = getTestFileResults(resultset); tsr = getTestSuiteResults(tfr); tcr = getTestCaseResults(tsr);

Get the error messages corresponding to the test case.

msg = tcr.ErrorMessages; msg.Simulation.messages

ans = "No model specified. Test did not run."

View the Outcome field of the first test case.

ans = TestResultOutcomes enumeration

Failed

Version History

Introduced in R2015a

expand all

The VariantConfiguration property is a struct withName, Description, andControlVariables fields..

For variant models, the VariantConfiguration property contains the name of the variant configuration used in the test case.

These properties have been added for the RoadRunner test case:

• RoadRunnerSetup
• RunOnPlatform