exponenta event banner

matlab.unittest.plugins. TestReportPlugin.producingHTML

Класс: matlab.unittest.plugins.
Пакет: matlab.unittest.plugins

Создает подключаемый модуль .html отчет

Описание

matlab.unittest.plugins.TestReportPlugin.producingHTML создает плагин, который создает .html отчет о результатах теста во временной папке. В этой папке основным файлом отчета является index.html. При повторном запуске набора тестов с помощью этого подключаемого модуля MATLAB ® перезаписывает содержимое папки.

Этот синтаксис эквивалентен matlab.unittest.plugins.TestReportPlugin.producingHTML(tempname).

пример

matlab.unittest.plugins.TestReportPlugin.producingHTML(htmlFolder) сохраняет отчет в htmlFolder папка.

matlab.unittest.plugins.TestReportPlugin.producingHTML(___,Name,Value) создает плагин с дополнительными параметрами, заданными одним или несколькими Name,Value аргументы пары. Этот синтаксис можно использовать с любым из аргументов предыдущих синтаксисов.

Входные аргументы

развернуть все

Папка вывода, заданная как вектор символа или скаляр строки. htmlFolder может быть относительным или абсолютным путем. По умолчанию в папке основным файлом отчета является index.html. Чтобы изменить имя основного файла, используйте 'MainFile' аргумент пары имя-значение.

Пример: 'TestRunOutput'

Пример: 'C:\myWork\testResults'

Аргументы пары «имя-значение»

Укажите дополнительные пары, разделенные запятыми Name,Value аргументы. Name является именем аргумента и Value - соответствующее значение. Name должен отображаться внутри кавычек. Можно указать несколько аргументов пары имен и значений в любом порядке как Name1,Value1,...,NameN,ValueN.

Пример: TestReportPlugin.producingHTML('myTestOutput','MainFile','main.html') создает подключаемый модуль, который выводит результаты в myTestOutput с основным файлом с именем main.html вместо index.html.

Главный HTML имя файла, указанное как вектор символов или строковый скаляр.

Пример: 'main.html'

Включить текст окна команд в отчет, указанный как false или true. По умолчанию IncludingCommandWindowText является false и вывод текста из окна команд исключается из отчета. Чтобы включить текст окна команд в отчет, укажите IncludingCommandWindowText как true.

Типы данных: logical

Включить диагностику проходящего события, указанное как false или true. По умолчанию IncludingPassingDiagnostics является false и диагностику от проходящих событий исключают из отчета. Чтобы включить в отчет диагностику по проходящим событиям, укажите IncludingPassingDiagnostics как true.

Типы данных: logical

Максимальный уровень, на котором регистрируемая диагностика включается экземпляром плагина, задаваемый как целое значение от 0 до 4, a matlab.unittest.Verbosity объект перечисления или строковый скалярный или символьный вектор, соответствующий одному из предопределенных имен элементов перечисления. Плагин включает диагностику, которая регистрируется на этом уровне и ниже. Целочисленные значения соответствуют членам matlab.unittest.Verbosity перечисление.

Числовое представлениеИмя элемента перечисленияПодробное описание
0None

Нет информации

1Terse

Минимальная информация

2Concise

Умеренный объем информации

3Detailed

Некоторая дополнительная информация

4Verbose

Много дополнительной информации

По умолчанию плагин включает диагностику, зарегистрированную в matlab.unittest.Verbosity.Terse уровень (уровень 1). Чтобы исключить диагностику в журнале, укажите LoggingLevel как Verbosity.None (уровень 0).

Диагностика в журнале - это диагностика, поставляемая в среду тестирования с вызовом log (TestCase) или log (Fixture) способ.

Примеры

развернуть все

Создайте тестовый пакет из двух тестовых файлов, запустите пакет и создайте .html отчет о результатах.

Создание нового файла в рабочей папке с именем ScriptBasedTest.m содержащий следующий тестовый сценарий. Сценарий включает в себя два неуспешных и незавершенных теста.

%% Test double class
expSolution = 'double';
actSolution = ones;
assert(isa(actSolution,expSolution))

%% Test single class
expSolution = 'single';
actSolution = ones('single');
assert(isa(actSolution,expSolution))

%% Test uint16 class
expSolution = 'uint16';
actSolution = ones('uint16');
assert(isa(actSolution,expSolution))

%% Test that fails
assert(false==true);

%% Another test that fails
assert(strcmp('correlation','causation'))

Создание файла с именем ClassBasedTest.m содержит следующий класс теста. Класс включает неуспешный тест, который с помощью параметризации приводит к девяти неуспешным тестам.

classdef ClassBasedTest < matlab.unittest.TestCase
    properties (ClassSetupParameter)
        generator = {'twister','combRecursive','multFibonacci'};
    end
    properties (MethodSetupParameter)
        seed = {0,123,4294967295};
    end
    properties (TestParameter)
        dim1 = struct('small',1,'medium',2,'large',3);
        dim2 = struct('small',2,'medium',3,'large',4);
        dim3 = struct('small',3,'medium',4,'large',5);
        type = {'single','double'};
    end
    methods (TestClassSetup)
        function ClassSetup(testCase,generator)
            orig = rng;
            testCase.addTeardown(@rng,orig)
            rng(0, generator)
        end
    end
    methods (TestMethodSetup)
        function MethodSetup(testCase,seed)
            orig = rng;
            testCase.addTeardown(@rng,orig)
            rng(seed)
        end
    end
    methods (Test, ParameterCombination='sequential')
        function testSize(testCase,dim1,dim2,dim3)
            testCase.verifySize(rand(dim1,dim2,dim3),[dim1 dim2 dim3])
        end 
    end
    methods (Test, ParameterCombination='pairwise')
        function testRepeatable(testCase,dim1,dim2,dim3)
            state = rng;
            firstRun = rand(dim1,dim2,dim3);
            rng(state)
            secondRun = rand(dim1,dim2,dim3);
            testCase.verifyEqual(firstRun,secondRun);
        end
    end
    methods (Test)
        function testClass(testCase,dim1,dim2,type)
            testCase.verifyClass(rand(dim1,dim2,type),type)
        end
    end
end

В командной строке создайте набор тестов из обоих тестовых файлов.

import matlab.unittest.TestRunner;
import matlab.unittest.TestSuite;
import matlab.unittest.plugins.TestReportPlugin;

suite = testsuite({'ScriptBasedTest','ClassBasedTest'})
suite = 

  1×284 Test array with properties:

    Name
    ProcedureName
    TestClass
    BaseFolder
    Parameterization
    SharedTestFixtures
    Tags

Tests Include:
   17 Unique Parameterizations, 0 Shared Test Fixture Classes, 0 Tags.

Создайте тестовый питатель в автоматическом режиме, чтобы информация не выводилась в командное окно. Создать TestReportPlugin который генерирует .html отчет о тестировании в папке с именем myResults.

runner = TestRunner.withNoPlugins;
htmlFolder = 'myResults';
plugin = TestReportPlugin.producingHTML(htmlFolder);

Добавьте подключаемый модуль в TestRunner и запустить люкс.

runner.addPlugin(plugin);
result = runner.run(suite)
Generating report. Please wait.
    Preparing content for the report.
    Adding content to the report.
    Writing report to file.
Report has been saved to: C:\work\myResults\index.html

result = 

  1×284 TestResult array with properties:

    Name
    Passed
    Failed
    Incomplete
    Duration
    Details

Totals:
   282 Passed, 2 Failed, 2 Incomplete.
   1.6712 seconds testing time.

Откройте отчет о тестировании, щелкнув имя сохраненного файла. В этом примере имя файла: C:\work\myResults\index.html.

Представлен в R2017b