Плагин для генерации пользовательского тестового выходного формата

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

Создайте плагин
Создайте тестовый класс
Добавьте плагин к Исполнитель Тестов и запустите тесты

Создайте плагин

В файле в рабочей папке создайте класс, ExampleCustomPlugin, который наследует от matlab.unittest.plugins.TestRunnerPlugin класс. В классе плагина:

Задайте Stream свойство на плагине, который хранит OutputStream образец. По умолчанию плагин записывает в стандартный выход.
Переопределите runTestSuite по умолчанию метод TestRunnerPlugin для вывода текста, указывающего на то, что исполнитель тестов запускает новый сеанс тестирования. Эта информация особенно полезна, если вы записываете в один файл журнала, так как она позволяет дифференцировать тестовые запуски.
Переопределите reportFinalizedResult по умолчанию метод TestRunnerPlugin для записи окончательных результатов тестирования в выходной поток. Можно изменить print метод для вывода результатов тестирования в формате, который работает для ваших тестовых журналов или системы непрерывного интегрирования.

classdef ExampleCustomPlugin < matlab.unittest.plugins.TestRunnerPlugin
    properties (Access=private)
        Stream
    end
    
    methods
        function p = ExampleCustomPlugin(stream)
            if ~nargin
                stream = matlab.unittest.plugins.ToStandardOutput;
            end
            validateattributes(stream,...
                {'matlab.unittest.plugins.OutputStream'},{})
            p.Stream = stream;
        end
    end
    
    methods (Access=protected)
        function runTestSuite(plugin,pluginData)
            plugin.Stream.print('\n--- NEW TEST SESSION at %s ---\n',...
                char(datetime))
            runTestSuite@...
                matlab.unittest.plugins.TestRunnerPlugin(plugin,pluginData);
        end
        
        function reportFinalizedResult(plugin,pluginData)
            thisResult = pluginData.TestResult;
            if thisResult.Passed
                status = 'PASSED';
            elseif thisResult.Failed
                status = 'FAILED';
            elseif thisResult.Incomplete
                status = 'SKIPPED';
            end
            plugin.Stream.print(...
                '### YPS Company - Test %s ### - %s in %f seconds.\n',...
                status,thisResult.Name,thisResult.Duration)
            
            reportFinalizedResult@...
                matlab.unittest.plugins.TestRunnerPlugin(plugin,pluginData)
        end
    end
end

Создайте тестовый класс

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

classdef ExampleTest < matlab.unittest.TestCase
    methods(Test)
        function testOne(testCase)
            testCase.assertGreaterThan(5,1)
        end
        function testTwo(testCase)
            wrongAnswer = 'wrong';
            testCase.verifyEmpty(wrongAnswer,'Not Empty')
            testCase.verifyClass(wrongAnswer,'double','Not double')
        end
        function testThree(testCase)
            testCase.assumeEqual(7*2,13,'Values not equal')
        end
        function testFour(testCase)
            testCase.verifyEqual(3+2,5);
        end
    end
end

Добавьте плагин к Исполнитель Тестов и запустите тесты

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

import matlab.unittest.TestSuite
import matlab.unittest.TestRunner

suite = TestSuite.fromClass(?ExampleTest);
runner = TestRunner.withNoPlugins;

Создайте образец ExampleCustomPlugin и добавьте его к исполнителю тестов. Запустите тесты.

import matlab.unittest.plugins.ToFile
fname = 'YPS_test_results.txt';
p = ExampleCustomPlugin(ToFile(fname));

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

Просмотрите содержимое выходного файла.

type(fname)

--- NEW TEST SESSION at 26-Jan-2015 10:41:24 ---
### YPS Company - Test PASSED ### - ExampleTest/testOne in 0.123284 seconds.
### YPS Company - Test FAILED ### - ExampleTest/testTwo in 0.090363 seconds.
### YPS Company - Test SKIPPED ### - ExampleTest/testThree in 0.518044 seconds.
### YPS Company - Test PASSED ### - ExampleTest/testFour in 0.020599 seconds.

Перезапустите Incomplete тесты с использованием того же исполнителя тестов. Просмотрите содержимое выходного файла.

suiteFiltered = suite([result.Incomplete]);
result2 = runner.run(suiteFiltered);

type(fname)

--- NEW TEST SESSION at 26-Jan-2015 10:41:24 ---
### YPS Company - Test PASSED ### - ExampleTest/testOne in 0.123284 seconds.
### YPS Company - Test FAILED ### - ExampleTest/testTwo in 0.090363 seconds.
### YPS Company - Test SKIPPED ### - ExampleTest/testThree in 0.518044 seconds.
### YPS Company - Test PASSED ### - ExampleTest/testFour in 0.020599 seconds.

--- NEW TEST SESSION at 26-Jan-2015 10:41:58 ---
### YPS Company - Test SKIPPED ### - ExampleTest/testThree in 0.007892 seconds.

См. также

matlab.unittest.plugins.OutputStream | matlab.unittest.plugins.TestRunnerPlugin | ToFile | ToStandardOutput

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