matlab.unittest.plugins.TestRunnerPlugin Class

Namespace: matlab.unittest.plugins

Plugin interface for extending test runner

Description

The TestRunnerPlugin interface enables extension of the matlab.unittest.TestRunner class. To customize a test run, create a subclass of TestRunnerPlugin and override select methods. TestRunnerPlugin provides you with a default implementation. Override only the methods that are required to achieve your customization. Every method you implement must invoke its corresponding superclass method, passing along the same instance of the PluginData class that it receives.

To run tests with this extension, add the custom TestRunnerPlugin instance to the test runner by using the addPlugin method.

The matlab.unittest.plugins.TestRunnerPlugin class is a handle class.

Methods

Protected Methods

createSharedTestFixture	Extend creation of shared test fixtures
createTestClassInstance	Extend creation of class-level TestCase instances
createTestMethodInstance	Extend creation of method-level TestCase instances
reportFinalizedResult	Extend reporting of finalized test results
reportFinalizedSuite	Extend reporting of finalized TestSuite array
runSession	Extend running of test session
runTest	Extend running of single Test element
runTestClass	Extend running of Test elements from same class or function
runTestMethod	Extend running of single Test method
runTestSuite	Extend running of TestSuite array
setupSharedTestFixture	Extend setting up shared test fixture
setupTestClass	Extend setting up test class
setupTestMethod	Extend setting up Test method
teardownSharedTestFixture	Extend tearing down shared test fixture
teardownTestClass	Extend tearing down test class
teardownTestMethod	Extend tearing down Test method

Tips

• To run tests in parallel with a TestRunnerPlugin instance, your plugin should subclass the matlab.unittest.plugins.Parallelizable interface. Running tests in parallel requires Parallel Computing Toolbox™.

Version History

Introduced in R2014a

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.TestRunnerPlugin class has two new methods: runSession and reportFinalizedSuite. For more information, see Run Tests in Parallel with Custom Plugin.