sltest.testmanager.TestSuiteResult class

Package: sltest.testmanager
Superclasses: sltest.testmanager.ResultSet

Access test suite results data

Description

Instances of sltest.testmanager.TestSuiteResult enable you to access the results from test execution performed by the Test Manager at a test-suite level.

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

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

The function sltest.testmanager.run creates a sltest.testmanager.ResultSet object, which contains the test suite result object. You can also create a test suite result directly if you use run to execute tests in an individual test suite.

Properties

Duration — Length of time the test suite ran, in seconds

duration

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

Attributes:

SetAccess	public
GetAccess	public
Dependent	true
NonCopyable	true

NumDisabled — Number of disabled tests

integer

The number of test cases that were disabled in the test suite result.

Attributes:

SetAccess	public
GetAccess	public
Dependent	true
NonCopyable	true

NumFailed — Number of failed tests

integer

The number of failed tests contained in the test suite result.

Attributes:

SetAccess	public
GetAccess	public
Dependent	true
NonCopyable	true

NumPassed — Number of passed tests

integer

The number of passed tests contained in the test suite result.

Attributes:

SetAccess	public
GetAccess	public
Dependent	true
NonCopyable	true

NumTestCaseResults — Number of test case result children

integer

The number of test case results that are direct children of the test suite result.

Attributes:

SetAccess	public
GetAccess	public
Dependent	true
NonCopyable	true

NumTestSuiteResults — Number of test suite result children

integer

The number of test suite results that are direct children of the test suite result.

Attributes:

SetAccess	public
GetAccess	public
Dependent	true
NonCopyable	true

NumTotal — Total number of tests

integer

The total number of tests in the test suite result.

Attributes:

SetAccess	public
GetAccess	public
Dependent	true
NonCopyable	true

Parent — Parent of the result object

object

Parent of the result. The parent of a test suite result is another test suite result, test file result, or result set object.

Attributes:

SetAccess	private
GetAccess	public
Dependent	true
NonCopyable	true

Release — Release in which the test was run

character vector

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

Attributes:

SetAccess	protected
GetAccess	public
Dependent	true
NonCopyable	true

StartTime — Time the test suite began to run

datetime

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

Attributes:

SetAccess	public
GetAccess	public
Dependent	true
NonCopyable	true

StopTime — Time the test suite completed

datetime

Time the test suite completed, returned as a datetime.

Attributes:

SetAccess	public
GetAccess	public
Dependent	true
NonCopyable	true

Tags — Tags to filter test file results

string array

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

Attributes:

SetAccess	public
GetAccess	public
Dependent	true
NonCopyable	true

TestFilePath — Test file path

character vector

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

Attributes:

SetAccess	private
GetAccess	public
Dependent	true
NonCopyable	true

TestSuitePath — Result hierarchy path

character vector

The hierarchy path in the parent result set.

Attributes:

SetAccess	private
GetAccess	public
Dependent	true
NonCopyable	true

UserData — Custom data stored with test suite results

any data type

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

Attributes:

SetAccess	public
GetAccess	public
Dependent	true
NonCopyable	true

Methods

Public Methods

getCleanupPlots	Get plots from cleanup callbacks of test suite
getCoverageResults	Get coverage results
getSetupPlots	Plots from setup callbacks
getTestCaseResults	Get test case results object
getTestSuiteResults	Get test suite results object

Examples

Get Test Suite Result From Results Set

% Run test file in Test Manager and output results set
resultset = sltest.testmanager.run;

% Get test file result object
tfr = getTestFileResults(resultset);

% Get test suite result object
tsr = getTestSuiteResults(tfr);

Version History

Introduced in R2015a