matlab.unittest.plugins.plugindata.RunPluginData Class

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

Plugin data describing Test elements being run

Description

The RunPluginData class defines the data passed by the TestRunner to plugin methods that extend the running of tests related to a method, class, or function. The TestRunner instantiates this class, so you are not required to create an object of the class directly.

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

Properties

Name — Name of Test elements

character vector

Name of the Test elements being run within the scope of a plugin method, specified as a character vector. The Name property is for informational, labeling, and display purposes. You cannot use this property to inspect the content of the Test elements being run.

TestSuite — Specification of Test elements

matlab.unittest.TestSuite array

Specification of the Test elements being run within the scope of a plugin method, specified as a matlab.unittest.TestSuite array.

TestResult — Results from running Test elements

matlab.unittest.TestResult array

Results from running the Test elements of the TestSuite property, specified as a matlab.unittest.TestResult array.

ResultDetails — Modifier of test result details

matlab.unittest.plugins.plugindata.ResultDetails object

Modifier of the test result details, specified as an instance of the matlab.unittest.plugins.plugindata.ResultDetails class. Use ResultDetails when you need to modify the Details property of TestResult objects.

Version History

Introduced in R2019b

R2020a: Modify test result details with custom plugins

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