matlab.unittest.plugins.codecoverage.CoverageReport class

Пакет: matlab.unittest.plugins.codecoverage

Формат отчета о покрытии кода

Описание

Отображение метрик покрытия кода в MATLAB® браузер, используйте образец CoverageReport класс с плагином CodeCoveragePlugin.

Создание

Описание

reportFormat = CoverageReport создает CoverageReport формат. Используйте этот формат отчета с matlab.unittest.plugins.CodeCoveragePlugin для создания HTML файла во временной папке, содержащей отчет о покрытии кода.

пример

reportFormat = CoverageReport(reportFolder) создает CoverageReport формат. Используйте этот формат отчета с matlab.unittest.plugins.CodeCoveragePlugin для создания HTML файла в указанной папке, содержащей отчет о покрытии кода. Генерация отчета перезаписывает содержимое папки, заданной как reportFolder.

пример

reportFormat = CoverageReport(___,'MainFile',mainFileName) создает CoverageReport формат с mainFileName как имя основного HTML файла содержащего отчет о покрытии кода.

Входные параметры

расширить все

Папка, содержащая файлы отчетов о покрытии кода, заданная как путь к папке относительно текущей папки или как абсолютный путь. Если папка не существует, CoverageReport создает его.

Имя основного HTML, содержащего отчет о покрытии кода, заданное как имя файла с .html расширение.

Свойства

расширить все

Имя основного HTML, содержащего отчет о покрытии кода, заданное как имя файла с .html расширение. Чтобы задать свойство, передайте имя файла конструктору как 'MainFile', 'fileName' пара.

Пример: myReport.html

Атрибуты:

GetAccess
public
SetAccess
immutable

Типы данных: char | string

Примеры

свернуть все

Создайте отчет о тесте с помощью CoverageReport формат. Укажите папку и HTML имя файла для отчета.

Создайте тест для этой функции.

function res = add5(x)
% Increment input by 5
if ~isa(x,'numeric')
    error('add5:InputMustBeNumeric','Input must be numeric.')
end
res = x + 5;
end

Выведите класс из matlab.unittest.TestCase для реализации методов тестирования.

classdef Add5Test < matlab.unittest.TestCase
    methods (Test)
        function testDoubleOut(testCase)
            actOutput = add5(1);
            testCase.verifyClass(actOutput,'double')
        end
        function testNonNumericInput(testCase)
            testCase.verifyError(@()add5('0'),'add5:InputMustBeNumeric')
        end
    end
end

Этот тестовый скрипт создает тестовый набор для одного файла, добавляет CodeCoveragePlugin с CoverageReport Формат к исполнителю тестов и запускам тесты. Формат плагина задает имя результатов основного теста HTML файла и папку, содержащую результаты.

import matlab.unittest.TestSuite
import matlab.unittest.TestRunner
import matlab.unittest.plugins.CodeCoveragePlugin
import matlab.unittest.plugins.codecoverage.CoverageReport

suite = TestSuite.fromFile('Add5Test.m');
runner = TestRunner.withNoPlugins;
runner.addPlugin(CodeCoveragePlugin.forFile('add5.m', ...
   'Producing',CoverageReport('Add5Results', ...
   'MainFile','Add5TestResults.html')))
runner.run(suite)
Code coverage report has been saved to:
 C:\myWorkingFolder\Add5Results\Add5TestResults.html
Введенный в R2019a