matlabtest.coder.plugins.GeneratedCodeCoveragePlugin class

Package: matlabtest.coder.plugins
Superclasses: matlab.unittest.plugins.TestRunnerPlugin, matlab.unittest.plugins.Parallelizable

Plugin for code coverage information for generated C/C++ code equivalence tests

Since R2023a

Description

Add an instance of the matlabtest.coder.plugins.GeneratedCodeCoveragePlugin class to the test runner to collect and access code coverage information for generated C/C++ code in an equivalence test. When the test suite runs, the plugin collects information that shows the parts of the generated C/C++ code that were executed. You can access this information programmatically or in the code coverage report.

The matlabtest.coder.plugins.GeneratedCodeCoveragePlugin class is a handle class.

Creation

Description

p = matlabtest.coder.plugins.GeneratedCodeCoveragePlugin creates a plugin that provides access to code coverage information when you run a generated C/C++ code equivalence test.

p = matlabtest.coder.plugins.GeneratedCodeCoveragePlugin(___,Name=Value) specifies options using one or more name-value arguments in addition to the input arguments in previous syntaxes.

Input Arguments

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: MetricLevel="mcdc"

MetricLevel — Coverage type to use

"statement" (default) | "condition" | "decision" | "mcdc"

Coverage type to use, specified as "statement", "condition", "decision", or "mcdc". For more information, see Types of Coverage for Generated C/C++ Code in Equivalence Tests.

Example: MetricLevel="mcdc"

Producing — Format of coverage information

matlab.unittest.plugins.codecoverage.CoverageReport object (default) | matlab.unittest.plugins.codecoverage.CoverageResult object

Format of coverage information, specified as a matlab.unittest.plugins.codecoverage.CoverageReport or matlab.unittest.plugins.codecoverage.CoverageResult object.

Example: Producing=CoverageResult

Properties

MetricLevel — Coverage type to use

"statement" (default) | "condition" | "decision" | "mcdc"

Coverage type to use, specified as "statement", "condition", "decision", or "mcdc". For more information, see Types of Coverage for Generated C/C++ Code in Equivalence Tests.

Attributes:

GetAccess	public
SetAccess	immutable

Examples

Collect Coverage and Generate Report for Equivalence Tests

This example shows how to collect coverage and generate a report for a generated C/C++ code equivalence test.

The function myMath takes two numeric inputs and an operation string to indicate if the inputs are added or subtracted.

function y = myMath(a,b,operation) %#codegen
if operation == "add"
    y = a+b;
elseif operation == "subtract"
    y = b-a;
else
    y = [];
end
end

The equivalence test tMyMathSIL uses class properties and class-level setup to generate a static library and specifies that the operation argument can be a variable-sized string. The test uses parameterization to execute and verify the generated C code twice, with different inputs each time.

classdef tMyMathSIL < matlabtest.coder.TestCase
    properties
        buildResults;
    end

    methods (TestClassSetup)        
        function generateCode(testCase)           
            operationSize = coder.typeof("add");
            operationSize.StringLength = inf;
            buildInputs = {1,2,operationSize};
            testCase.buildResults = build(testCase,"myMath", ...
                Inputs=buildInputs,Configuration="lib");
        end        
    end

    properties (TestParameter)
        runInputs = {{1,2,"add"},{1,2,"subtract"}};
    end
    
    methods(Test)
        function testSILVsMATLAB(testCase,runInputs)                        
            executionResults = execute(testCase,testCase.buildResults, ...
                Inputs=runInputs);
            verifyExecutionMatchesMATLAB(testCase,executionResults);
        end        
    end
end

Create a test runner with text output.

runner = matlab.unittest.TestRunner.withTextOutput;

Create an instance of the generated code coverage plugin.

plugin = matlabtest.coder.plugins.GeneratedCodeCoveragePlugin;

Add the plugin to the test runner.

addPlugin(runner,plugin)

Create a test suite from tMyMath.m.

suite = testsuite("tMyMath.m");

Run the test suite with the test runner, which generates the coverage report.

results = run(runner,suite);

Running tMyMath
..
Done tMyMath
__________

C/C++ code coverage report has been saved to:
 C:\Users\jdoe\AppData\Local\Temp\tpc5f66fd8_ae86_433c_8749_20e2b5ecd810\index.html
results = 
  1×2 TestResult array with properties:

    Name
    Passed
    Failed
    Incomplete
    Duration
    Details

Totals:
   2 Passed, 0 Failed, 0 Incomplete.
   23.7352 seconds testing time.

Collect MC/DC Coverage and Generate Report for Equivalence Tests

This example shows how to collect MC/DC coverage and generate a report with a specified name and file path for a generated C/C++ code equivalence test.

The function myMath takes two numeric inputs and an operation string to indicate if the inputs are added or subtracted.

function y = myMath(a,b,operation) %#codegen
if operation == "add"
    y = a+b;
elseif operation == "subtract"
    y = b-a;
else
    y = [];
end
end

Th equivalence test tMyMathSIL uses class properties and class-level setup to generate a static library and specifies that the operation argument can be a variable-sized string. The test uses parameterization to execute and verify the generated C code twice, with different inputs each time.

classdef tMyMathSIL < matlabtest.coder.TestCase
    properties
        buildResults;
    end

    methods (TestClassSetup)        
        function generateCode(testCase)           
            operationSize = coder.typeof("add");
            operationSize.StringLength = inf;
            buildInputs = {1,2,operationSize};
            testCase.buildResults = build(testCase,"myMath", ...
                Inputs=buildInputs,Configuration="lib");
        end        
    end

    properties (TestParameter)
        runInputs = {{1,2,"add"},{1,2,"subtract"}};
    end
    
    methods(Test)
        function testSILVsMATLAB(testCase,runInputs)                        
            executionResults = execute(testCase,testCase.buildResults, ...
                Inputs=runInputs);
            verifyExecutionMatchesMATLAB(testCase,executionResults);
        end        
    end
end

Create a test runner with text output.

runner = matlab.unittest.TestRunner.withTextOutput;

Create an instance of the coverage report plugin and specify the name and output path for the report.

outputPath = "myArtifacts";
reportName = "myCoverageReport.html";
reportFormat = matlab.unittest.plugins.codecoverage.CoverageReport( ...
    outputPath,MainFile=reportName);

Create an instance of the generated code coverage plugin.

plugin = matlabtest.coder.plugins.GeneratedCodeCoveragePlugin( ...
    Producing=reportFormat,MetricLevel="mcdc");

Add the plugin to the test runner.

addPlugin(runner,plugin)

Create a test suite from tMyMath.m.

suite = testsuite("tMyMath.m");

Run the test suite with the test runner, which generates the coverage report.

results = run(runner,suite);

Running tMyMath
..
Done tMyMath
__________

C/C++ code coverage report has been saved to:
 C:\Users\jdoe\MATLAB\myArtifacts\myCoverageReport.html
results = 
  1×2 TestResult array with properties:

    Name
    Passed
    Failed
    Incomplete
    Duration
    Details

Totals:
   2 Passed, 0 Failed, 0 Incomplete.
   18.9304 seconds testing time.

Version History

Introduced in R2023a