Extend Unit Testing Framework

Customize testing environment; author constraints, diagnostics, fixtures, and plugins

The MATLAB^® unit testing framework provides test tool authors the ability to customize the testing environment. You can extend test writing through custom constraints, diagnostics, and fixtures, and extend test running and result reporting through custom plugins for the test runner.

Classes

expand all

Constraints

`matlab.unittest.constraints.Constraint`	Fundamental interface for constraints
`matlab.unittest.constraints.BooleanConstraint`	Fundamental interface for constraints that support Boolean operations
`matlab.unittest.constraints.Tolerance`	Fundamental interface for tolerances

Diagnostics

`matlab.automation.diagnostics.Diagnostic`	Fundamental interface for diagnostics
`matlab.unittest.diagnostics.ConstraintDiagnostic`	Diagnostic with fields common to most constraints

Fixtures

matlab.unittest.fixtures.Fixture Fundamental interface for test fixtures

Plugins

`matlab.unittest.plugins.TestRunnerPlugin`	Plugin interface for extending test runner
`matlab.unittest.plugins.Parallelizable`	Interface for plugins that support running tests in parallel (Since R2019b)
`matlab.unittest.plugins.QualifyingPlugin`	Interface for plugins that perform system-wide qualifications

Data Type Behavior Tests

matlab.test.behavior.Missing Test if class satisfies contract for missing values

Packages

`matlab.unittest.constraints Package`	Summary of classes in MATLAB Constraints Interface
`matlab.unittest.fixtures Package`	Summary of classes in MATLAB Fixtures Interface
`matlab.unittest.plugins Package`	Summary of classes in MATLAB Plugins Interface

Topics

Constraints

Create Custom Constraint
Create a custom constraint to determine if a given value is the same size as an expected value.
Create Custom Boolean Constraint
Create a custom Boolean constraint to determine if a given value is the same size as an expected value.

Fixtures

Create Basic Custom Fixture
Create a basic custom fixture that changes the display format to hexadecimal representation.
Create Advanced Custom Fixture
Create a configurable fixture that changes the output display format for numeric values.

Plugins

Write Plugins to Extend TestRunner
Use the TestRunnerPlugin class to extend the test runner. You can implement methods to extend the creation, setup, running, and teardown of tests or test fixtures.
Create Custom Plugin
Create a custom plugin that counts the number of passing and failing assertions.
Run Tests in Parallel with Custom Plugin
Create a custom plugin that counts the number of passing and failing assertions when tests run in parallel.
Write Plugin to Add Data to Test Results
Create a plugin that adds the actual and expected values in an assertion to the TestResult object.
Write Plugin to Save Diagnostic Details
This example shows how to create a custom plugin to save diagnostic details. The plugin listens for test failures and saves diagnostic information so you can access it after the framework completes the tests.
Plugin to Generate Custom Test Output Format
Create a plugin that uses a custom format to write finalized test results to an output stream.