matlabtest.compiler.TestCase Class

Namespace: matlabtest.compiler
Superclasses: matlab.unittest.TestCase

Test case for deployed code artifact equivalence tests

Since R2023a

Description

Use the matlabtest.compiler.TestCase class to generate and test MATLAB^® Compiler SDK™ deployed code artifacts for equivalence with MATLAB source code. Running equivalence tests for deployed code artifacts requires MATLAB Compiler SDK. This class inherits from matlab.unittest.TestCase.

The matlabtest.compiler.TestCase class is a handle class.

Class Attributes

Abstract true

For information on class attributes, see Class Attributes.

Creation

Create a class definition file that inherits from matlabtest.compiler.TestCase. Author test methods in a methods block to define the test case.

Methods

expand all

Public Methods

This table lists the methods of the matlabtest.compiler.TestCase class. In addition, this class inherits methods from matlab.unittest.TestCase.

`assertExecutionMatchesMATLAB`	Assert that deployed code artifact execution results match MATLAB results
`assumeExecutionMatchesMATLAB`	Assume that deployed code artifact execution results match MATLAB results
`build`	Generate deployed code artifacts in equivalence tests
`execute`	Execute deployed code artifacts in equivalence tests
`fatalAssertExecutionMatchesMATLAB`	Fatally assert that deployed code artifact execution results match MATLAB results
`verifyExecutionMatchesMATLAB`	Verify that deployed code artifact execution results match MATLAB results

Examples

collapse all

Generate and Test Python Package for Equivalence

This example shows how to generate a Python^® package from MATLAB source code and test for equivalence by using MATLAB Compiler SDK.

The function makesquare generates an n-by-n matrix:

function y = makesquare(x)
y = magic(x);
end

This class definition file defines an equivalence test case that inherits from matlabtest.compiler.TestCase. The test case in the methods block defines a test case that:

Builds the Python package from the makesquare function
Executes the Python package with input set to 5
Verifies the execution of the Python package against the execution of the MATLAB function makesquare with the same input

classdef tDeployment < matlabtest.compiler.TestCase
    methods(Test)
        function pythonEquivalence(testCase)
            buildResults = build(testCase,"makesquare.m", ...
                "pythonPackage");
            executionResults = execute(testCase,buildResults,{5});
            verifyExecutionMatchesMATLAB(testCase,executionResults);
        end
    end
end

Run the pythonEquivalence test.

runtests("tDeployment", ...
    ProcedureName="pythonEquivalence")

Running pythonEquivalence
..
Done pythonEquivalence
__________


ans = 

  TestResult with properties:

          Name: 'tDeployment/pythonEquivalence'
        Passed: 1
        Failed: 0
    Incomplete: 0
      Duration: 93.1237
       Details: [1×1 struct]

Totals:
   1 Passed, 0 Failed, 0 Incomplete.
   93.1237 seconds testing time.

Limitations

You cannot run tests that inherit from matlabtest.compiler.TestCase with parallel execution.
You cannot generate deployed code artifacts or test them for equivalence in MATLAB Online™.

Version History

Introduced in R2023a