build

Class: matlabtest.compiler.TestCase
Package: matlabtest.compiler

Generate deployed code artifacts in equivalence tests

Since R2023a

Syntax

buildResults = build(testCase,functionsToDeploy,artifactType)

buildResults = build(testCase,buildOptions)

buildResults = build(___,PreservingOnFailure=true)

Description

buildResults = build(testCase,functionsToDeploy,artifactType) builds the deployed code artifact by using MATLAB^® Compiler SDK™ with type artifactType from the MATLAB functions functionsToDeploy in the equivalence test case testCase.

buildResults = build(testCase,buildOptions) builds the deployed code artifact with the options and type specified by buildOptions.

buildResults = build(___,PreservingOnFailure=true) preserves the build folder and its contents after a test failure.

Input Arguments

testCase — Test case

matlabtest.compiler.TestCase object

Test case, specified as a matlabtest.compiler.TestCase object.

functionsToDeploy — MATLAB functions to deploy

string scalar | string array | char vector | cell array of character vectors

MATLAB functions to deploy, specified as a:

• String scalar or character vector that contains the name of a single function

• String array or cell array of character vectors that contains the name of multiple functions

Example: "makesquare.m"

Example: ["makesquare.m","myadd.m"]

artifactType — Artifact type to build

"dotNETAssembly" | "javaPackage" | "pythonPackage"

Artifact type to build, specified as "dotNETAssembly", "javaPackage", or "pythonPackage".

buildOptions — Build options

compiler.build.DotNETAssemblyOptions object | compiler.build.JavaPackageOptions | compiler.build.PythonPackageOptions object

Build options, specified as one of these objects:

• compiler.build.DotNETAssemblyOptions (MATLAB Compiler SDK)

• compiler.build.JavaPackageOptions (MATLAB Compiler SDK)

• compiler.build.PythonPackageOptions (MATLAB Compiler SDK)

Example: buildOpts = compiler.build.PythonPackageOptions("makesquare.m");

Output Arguments

buildResults — Build results

compiler.build.Results object

Build results, returned as a compiler.build.Results (MATLAB Compiler SDK) object.

Examples

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:

1. Builds the Python package from the makesquare function

2. Executes the Python package with input set to 5

3. 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.

Generate and Test Python Package with Additional Build Options

This example shows how to generate a Python package with additional build options 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:

1. Defines a compiler.build.PythonPackageOptions (MATLAB Compiler SDK) object that specifies the function to deploy, the package name, and provides additional files to include in the package

2. Builds the Python package from the build options object

3. Executes the Python package with input set to 5

4. 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)

            buildOpts = compiler.build.PythonPackageOptions("makesquare.m");
            buildOpts.PackageName = "PackageUnderTest";
            buildOpts.AdditionalFiles = "makesquareData.mat";

            buildResults = build(testCase,buildOpts);
            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.

Generate and Test Python Package for Equivalence with Additional Customizations

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 and the function myAdd takes two inputs and adds them together:

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

function y = myAdd(a,b)
y = a + b;
end

This class definition file:

• Builds a packaged that contains makesquare and myAdd

• Saves the build results object if the test fails

• Verifies the result with an absolute tolerance

classdef tDeployment < matlabtest.compiler.TestCase
    methods(Test)
        function pythonEquivalence(testCase)
            functionsToDeploy = ["makesquare.m","myAdd.m"];
            buildResults = build(testCase,functionsToDeploy, ...
                "pythonPackage",PreservingOnFailure=true);            
            preserveOnFailure=true;
            executionResults = execute(testCase,buildResults,{5}, ...
                "makesquare",PreservingOnFailure=preserveOnFailure);
            verifyExecutionMatchesMATLAB(testCase,executionResults,AbsTol=0.0001);
        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.

Version History

Introduced in R2023a