matlab.unittest.plugins.CodeCoveragePlugin class

Пакет: matlab.unittest.plugins

Плагин, который представляет отчет покрытия кода

Описание

Чтобы представить отчет покрытия линии для исходного кода MATLAB^®, добавьте CodeCoveragePlugin к TestRunner. Среда тестирования запускает тесты, и получившийся отчет покрытия указывает на выполняемые строки кода. Отчет покрытия основан на исходном коде, расположенном в одной или нескольких папках или пакетах. Исходный код должен быть на пути MATLAB и остаться на пути во время тестового прогона.

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

Конструкция

Инстанцируйте CodeCoveragePlugin использование одного из его статических методов.

Чтобы сообщить относительно исходного кода в одном или нескольких файлах, используйте forFile статический метод. Чтобы сообщить относительно исходного кода в одной или нескольких папках, используйте forFolder статический метод. Чтобы сообщить относительно исходного кода в одном или нескольких пакетах, используйте forPackage статический метод.

Методы

forFile	Создайте `CodeCoveragePlugin` для файлов
forFolder	Создайте `CodeCoveragePlugin` для папок
forPackage	Создайте `CodeCoveragePlugin` для пакетов

Копировать семантику

Указатель. Чтобы узнать, как классы Handle влияют на операции копирования, см. раздел "Копирование объектов".

Примеры

свернуть все

Генерация отчета покрытия кода

В новом файле, quadraticSolver.m, в вашей рабочей папке создайте следующую функцию.

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

checkInputs

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

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

Создайте тест для квадратичного решателя. В tests пакет (+tests подпапка), создайте SolverTest.m содержа следующий тестовый класс.

classdef SolverTest < matlab.unittest.TestCase
    % SolverTest tests solutions to the quadratic equation
    % a*x^2 + b*x + c = 0
    
    methods (Test)
        function testRealSolution(testCase)
            actSolution = quadraticSolver(1,-3,2);
            expSolution = [2,1];
            testCase.verifyEqual(actSolution,expSolution)
        end
        function testImaginarySolution(testCase)
            actSolution = quadraticSolver(1,2,10);
            expSolution = [-1+3i, -1-3i];
            testCase.verifyEqual(actSolution,expSolution)
        end
    end
    
end

В командной строке из вашей исходной рабочей папки создайте тестовый набор из tests пакет.

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

suite = TestSuite.fromPackage('tests');

Создайте исполнителя тестов.

runner = TestRunner.withTextOutput;

Добавьте CodeCoveragePlugin бегуну и запущенный тесты. Укажите, что папка исходного кода является вашей текущей рабочей папкой. Если у вас есть другие файлы исходного кода в вашей текущей рабочей папке, они обнаруживаются в отчете покрытия. Папка, которая содержит исходный код (quadraticSolver.m) должен быть на пути поиска файлов MATLAB.

runner.addPlugin(CodeCoveragePlugin.forFolder(pwd))
result = runner.run(suite);

Running tests.SolverTest
..
Done tests.SolverTest
__________

MATLAB создает отчет покрытия кода для квадратичной функции решателя во временной папке.

Code coverage report for quadraticSolver

checkinputs вложенная функция не имеет полного покрытия кода. Начиная с тестов в SolverTest.m не передавайте нечисловой вход quadraticSolver, MATLAB не осуществляет код, который выдает ошибку, если входные параметры не являются числовыми. Чтобы обратиться к недостающему покрытию, добавьте метод тестирования протестировать состояние ошибки.

Генерация отчета в формате Cobertura

В вашей рабочей папке создайте файл quadraticSolver.m со следующей функцией.

function roots = quadraticSolver(a,b,c)
    % quadraticSolver returns solutions to the
    % quadratic equation a*x^2 + b*x + c = 0.
    checkInputs
    roots(1) = (-b + sqrt(b^2 - 4*a*c)) / (2*a);
    roots(2) = (-b - sqrt(b^2 - 4*a*c)) / (2*a);
    
    function checkInputs
        if ~isa(a,'numeric') || ~isa(b,'numeric') || ~isa(c,'numeric')
            error('quadraticSolver:InputMustBeNumeric', ...
                'Coefficients must be numeric.')
        end
    end
end

Создайте тестовый класс для квадратичного решателя в ForFileSolverTest.m.

classdef ForFileSolverTest < matlab.unittest.TestCase
    % SolverTest tests solutions to the quadratic equation
    % a*x^2 + b*x + c = 0
    
    methods (Test)
        function testRealSolution(testCase)
            actSolution = quadraticSolver(1,-3,2);
            expSolution = [2,1];
            testCase.verifyEqual(actSolution,expSolution)
        end
        function testImaginarySolution(testCase)
            actSolution = quadraticSolver(1,2,10);
            expSolution = [-1+3i, -1-3i];
            testCase.verifyEqual(actSolution,expSolution)
        end
    end
end

В командной строке создайте тестовый набор для ForFileSolverTest.m, и создайте исполнителя тестов.

import matlab.unittest.TestRunner

testFile = 'ForFileSolverTest.m';
suite = testsuite(testFile);
runner = TestRunner.withTextOutput;

Создайте плагин, который выводит отчет покрытия кода для исходного кода в формате Cobertura.

import matlab.unittest.plugins.CodeCoveragePlugin
import matlab.unittest.plugins.codecoverage.CoberturaFormat

sourceCodeFile = 'quadraticSolver.m';
reportFile = 'CoverageResults.xml';
reportFormat = CoberturaFormat(reportFile);
plugin = CodeCoveragePlugin.forFile(sourceCodeFile,'Producing',reportFormat);

Добавьте плагин в исполнителя тестов и запустите тесты.

runner.addPlugin(plugin);
result = runner.run(suite);

Running ForFileSolverTest
..
Done ForFileSolverTest
__________

Отобразите содержимое файла результатами покрытия кода.

disp(fileread(reportFile))

<?xml version="1.0" encoding="utf-8"?>
<coverage branch-rate="NaN" branches-covered="NaN" branches-valid="NaN" complexity="NaN" line-rate="0.8" lines-covered="4" lines-valid="5" timestamp="737000.4343" version="NaN">
   <sources>
      <source>C:\work\</source>
   </sources>
   <packages>
      <package branch-rate="NaN" complexity="NaN" line-rate="0.8" name="">
         <classes>
            <class branch-rate="NaN" complexity="NaN" filename="quadraticSolver.m" line-rate="0.8" name="quadraticSolver">
               <methods/>
               <lines>
                  <line branch="NaN" condition-coverage="NaN" hits="2" number="4"/>
                  <line branch="NaN" condition-coverage="NaN" hits="2" number="5"/>
                  <line branch="NaN" condition-coverage="NaN" hits="2" number="6"/>
                  <line branch="NaN" condition-coverage="NaN" hits="2" number="9"/>
                  <line branch="NaN" condition-coverage="NaN" hits="0" number="10"/>
               </lines>
            </class>
         </classes>
      </package>
   </packages>
</coverage>

Введенный в R2014b

Документация