Main Content

matlab.unittest.plugins.codecoverage.CoverageReport Class

Namespace: matlab.unittest.plugins.codecoverage
Superclasses: matlab.unittest.plugins.codecoverage.CoverageFormat

Format for interactive HTML code coverage report

expand all in page

Description

The matlab.unittest.plugins.codecoverage.CoverageReport class provides a way to generate interactive code coverage reports in HTML format. To generate a code coverage report in this format, create a CodeCoveragePlugin instance using a CoverageReport object, and then add the plugin to the test runner.

An interactive code coverage report lets you customize the displayed information by selecting options in the report. For example, you can choose from the list of included coverage metrics, or control the highlighting for covered or missed executables.

Creation

Description

format = matlab.unittest.plugins.codecoverage.CoverageReport creates a CoverageReport object that instructs CodeCoveragePlugin to generate an interactive report in HTML format and save it to a temporary folder. By default, the main file of the report is index.html.

format = matlab.unittest.plugins.codecoverage.CoverageReport(folderName) specifies the name of the code coverage report folder.

example

format = matlab.unittest.plugins.codecoverage.CoverageReport(___,Name,Value) specifies options using one or more name-value arguments in addition to any of the input argument combinations in previous syntaxes. For example, format = matlab.unittest.plugins.codecoverage.CoverageReport("MainFile","main.html") creates a CoverageReport object for generating a code coverage report whose main file is main.html.

Input Arguments

expand all

Name of the code coverage report folder, specified as a string scalar or character vector. The value can be a relative path, but the relative path must be in the current folder. Otherwise, the value must be a full path. If the folder does not exist, CoverageReport creates it.

Example: "myCoverageReport"

Example: "C:\work\myCoverageReport"

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: format = matlab.unittest.plugins.codecoverage.CoverageReport(MainFile="main.html")

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: format = matlab.unittest.plugins.codecoverage.CoverageReport("MainFile","main.html")

Name of the main HTML file, specified as a string scalar or character vector ending in .html or .htm. If you do not specify a name, the plugin names the main file of the report index.html.

This argument sets the MainFile property.

Example: MainFile="main.html"

Since R2024a

Title of the HTML document, specified as a string scalar or character vector. The specified title appears in a tab when the code coverage report opens in the browser.

Example: DocumentTitle="My Coverage Report"

Properties

expand all

Name of the main HTML file, returned as a character vector ending in .html or .htm. By default, the main file of the report is index.html.

This property is set by the MainFile name-value argument.

Example: 'main.html'

Attributes:

GetAccess
public
SetAccess
immutable

Examples

collapse all

Open Script

Run a suite of tests and generate an interactive code coverage report in HTML format for your source code.

In a folder named sourceFolder in your current folder, create the quadraticSolver function. The function takes as inputs the coefficients of a quadratic polynomial and returns the roots of that polynomial. If the coefficients are specified as nonnumeric values, the function throws an error.

function r = quadraticSolver(a,b,c)
% quadraticSolver returns solutions to the
% quadratic equation a*x^2 + b*x + c = 0.

if ~isa(a,"numeric") || ~isa(b,"numeric") || ~isa(c,"numeric")
    error("quadraticSolver:InputMustBeNumeric", ...
        "Coefficients must be numeric.")
end

r(1) = (-b + sqrt(b^2 - 4*a*c)) / (2*a);
r(2) = (-b - sqrt(b^2 - 4*a*c)) / (2*a);

end

To test the quadraticSolver function, create the SolverTest class in a folder named testsFolder in your current folder. Define three Test methods that test the function against real solutions, imaginary solutions, and nonnumeric inputs.

classdef SolverTest < matlab.unittest.TestCase
    methods(Test)
        function realSolution(testCase)
            actSolution = quadraticSolver(1,-3,2);
            expSolution = [2 1];
            testCase.verifyEqual(actSolution,expSolution)
        end
        function imaginarySolution(testCase)
            actSolution = quadraticSolver(1,2,10);
            expSolution = [-1+3i -1-3i];
            testCase.verifyEqual(actSolution,expSolution)
        end
        function nonnumericInput(testCase)
            testCase.verifyError(@()quadraticSolver(1,"-3",2), ...
                "quadraticSolver:InputMustBeNumeric")
        end
    end
end

To run the tests and generate a code coverage report, first add sourceFolder to the path.

addpath("sourceFolder")

Create a test suite from testsFolder.

suite = testsuite("testsFolder");

Create a test runner and customize it using a plugin that generates an interactive code coverage report for the code in sourceFolder. Specify that the plugin writes its output to a folder named coverageReport in your current folder.

import matlab.unittest.plugins.CodeCoveragePlugin
import matlab.unittest.plugins.codecoverage.CoverageReport
runner = testrunner("textoutput");
reportFormat = CoverageReport("coverageReport");
p = CodeCoveragePlugin.forFolder("sourceFolder","Producing",reportFormat);
runner.addPlugin(p)

Run the tests. In this example, all the tests pass and the source code receives full coverage. The plugin generates an interactive code coverage report in the specified folder coverageReport, created in your current folder. By default, the main file of the report is index.html.

results = runner.run(suite);

Running SolverTest
...
Done SolverTest
__________

MATLAB code coverage report has been saved to:
 C:\work\coverageReport\index.html

Open the main file of the report.

open(fullfile("coverageReport","index.html"))

Version History

Introduced in R2019a

expand all

See Also

Functions

Classes

Topics