matlab.unittest.plugins.plugindata.TestSuiteRunPluginData Class

Namespace: matlab.unittest.plugins.plugindata
Superclasses: matlab.unittest.plugins.plugindata.PluginData, matlab.unittest.plugins.plugindata.RunPluginData

Plugin data describing TestSuite portion being run

Description

The matlab.unittest.plugins.plugindata.TestSuiteRunPluginData class defines the data passed by the test runner to plugin methods that extend the running of TestSuite portions.

The testing framework instantiates this class. You cannot create an object of the matlab.unittest.plugins.plugindata.TestSuiteRunPluginData class directly.

The matlab.unittest.plugins.plugindata.TestSuiteRunPluginData class is a handle class.

Properties

Name — Name of TestSuite portion

character vector

Name of the TestSuite portion being run by the test runner, returned as a character vector. You can use the Name property for informational, labeling, and display purposes. You cannot inspect the test content using this property.

Attributes:

GetAccess	public
SetAccess	immutable

TestSuite — Elements in TestSuite portion

matlab.unittest.TestSuite array

Elements in the TestSuite portion being run, returned as a matlab.unittest.TestSuite array.

Attributes:

GetAccess	public
SetAccess	immutable

TestResult — Results from TestSuite portion

matlab.unittest.TestResult array

Results from the TestSuite portion being run, returned as a matlab.unittest.TestResult array.

Attributes:

GetAccess	public
SetAccess	Restricts access

NumGroups — Number of groups

positive integer scalar

Number of groups into which the entire TestSuite is divided, returned as a positive integer scalar. NumGroups is equal to 1 when tests run in serial mode and can be greater than 1 when tests run in parallel.

Attributes:

GetAccess	public
SetAccess	immutable

Group — Identifier of TestSuite portion

positive integer scalar

Identifier of the TestSuite portion being run, returned as a positive integer scalar from 1 to NumGroups.

Attributes:

GetAccess	public
SetAccess	immutable

CommunicationBuffer — Data buffer for storing and retrieving data

matlab.unittest.plugins.plugindata.CommunicationBuffer object

Data buffer for storing and retrieving data related to the TestSuite portion being run, returned as a matlab.unittest.plugins.plugindata.CommunicationBuffer object. Use CommunicationBuffer with the storeIn and retrieveFrom methods of the matlab.unittest.plugins.Parallelizable interface.

The CommunicationBuffer property is useful when running tests in parallel with custom plugins (requires Parallel Computing Toolbox™).

Attributes:

GetAccess	public
SetAccess	private

ResultDetails — Test result details modifier

matlab.unittest.plugins.plugindata.ResultDetails object

Test result details modifier, returned as a matlab.unittest.plugins.plugindata.ResultDetails object. Use ResultDetails when you need to modify the Details property of TestResult objects.

Attributes:

GetAccess	public
SetAccess	private

Version History

Introduced in R2014a

R2020a: Modify test result details with custom plugins

To support modifying the Details property of a TestResult array, the matlab.unittest.plugins.plugindata.TestSuiteRunPluginData class has a new property ResultDetails. For more information, see Write Plugin to Add Data to Test Results.

R2019b: Run tests in parallel with custom plugins

To support running tests in parallel with custom plugins (requires Parallel Computing Toolbox), the matlab.unittest.plugins.plugindata.TestSuiteRunPluginData class has three new properties: NumGroups, Group, and CommunicationBuffer. For more information, see Run Tests in Parallel with Custom Plugin.