Настройка отчетов о результатах тестирования

Можно выбрать способ форматирования и агрегирования результатов тестирования путем настройки отчетов. Используйте sltest.testmanager.TestResultReport класс, чтобы создать подкласс, а затем использовать свойства и методы, чтобы настроить, как диспетчер тестов создает отчет о результатах. Можно изменять стили шрифтов, добавлять графики, упорядочивать результаты в таблицы, включать изображения модели и многое другое. Для использования пользовательского класса требуется лицензия MATLAB ® Report Generator™.

Наследование класса отчета

Чтобы настроить созданный отчет, необходимо наследовать от sltest.testmanager.TestResultReport класс. После наследования из класса можно изменить свойства и методы. Чтобы наследовать класс, добавьте раздел определения класса к новому или существующему сценарию MATLAB. Подкласс - это пользовательское имя класса, а надкласс, от которого вы наследуете, - sltest.testmanager.TestResultReport. Дополнительные сведения о создании подклассов см. в разделе Конструирование конструкторов подклассов. Затем добавьте код к наследуемому классу или методам для создания настроек.

% class definition
classdef CustomReport < sltest.testmanager.TestResultReport
    %
    % Report customization code here
    %
end

Иерархия методов

При создании подкласса производный класс наследует методы из sltest.testmanager.TestResultReport класс. Основная часть отчета разделена на три основные группы: блок набора результатов, блок результатов набора тестов и блок результатов тестов.

Блок результирующего набора содержит таблицу результирующего набора, таблицу покрытия и ссылки на оглавление.

Блок результатов набора тестов содержит таблицу результатов набора тестов, таблицу покрытия, ссылки на требования и ссылки на оглавление.

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

Изменение класса

Чтобы вставить собственное содержимое отчета или изменить формат созданного отчета, измените унаследованные методы класса. Общие сведения об изменении методов см. в разделе Изменение унаследованных методов.

Простым изменением в созданном отчете может быть добавление некоторого текста на титульную страницу. Используемый здесь метод: addTitlePage.

% class definition
classdef CustomReport < sltest.testmanager.TestResultReport
    methods
        function this = CustomReport(resultObjects, reportFilePath)
            this@sltest.testmanager.TestResultReport(resultObjects,...
            reportFilePath);
        end
    end
    
    methods(Access=protected)
        function addTitlePage(obj)
            import mlreportgen.dom.*;
            
            % Add a custom message
            label = Text('Some custom content can be added here');
            append(obj.TitlePart,label);
            
            % Call the superclass method to get the default behavior
            addTitlePage@sltest.testmanager.TestResultReport(obj);
        end
    end
end

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

Более сложным изменением созданного отчета является включение снимка проверенной модели.

% class definition
classdef CustomReport < sltest.testmanager.TestResultReport
    methods
        function this = CustomReport(resultObjects,reportFilePath)
            this@sltest.testmanager.TestResultReport(resultObjects,reportFilePath);
        end
    end
    
    methods(Access=protected)
        % Method to customize test case/iteration result section in the report
        function docPart = genTestCaseResultBlock(obj,result)
            % result: A structure containing test case or iteration result
            import mlreportgen.dom.*;
            
            % Call the superclass method to get the default behavior
            docPart = genTestCaseResultBlock@sltest.testmanager.TestResultReport(...
                                                                      obj,result);
            
            % Get the test case result data for putting in the report
            tcrObj = result.Data;
            
            % Insert model screenshot at the test case result level
            if isa(tcrObj, 'sltest.testmanager.TestCaseResult')
                
                % Initialize model name
                modelName = '';
                
                % Check in the test case result if it has model information. If
                % not, it means there were iterations in the test case or a
                % model was not used.
                testSimMetaData = tcrObj.SimulationMetaData;
                
                if (~isempty(testSimMetaData))
                    modelName = testSimMetaData.modelName;
                end
                
                % Get iteration results
                iterResults = getIterationResults(tcrObj);
                
                % Get the model name in case test case had iterations
                if (~isempty(iterResults))
                    modelName = iterResults(1).SimulationMetaData.modelName;
                end
                
                % Insert model snapshot. This will not work for harnesses. With
                % minimal changes we can also open the harness used for
                % testing.
                if (~isempty(modelName))
                    try
                        open_system(modelName);
                        outputFileName = [tempdir, modelName, '.png'];
                        if exist(outputFileName,'file')
                            delete(outputFileName);
                        end
                        print(outputFileName, '-s', '-dpng');
                        para = sltest.testmanager.ReportUtility.genImageParagraph(...
                            outputFileName,...
                            '5.2in','3.7in');
                        append(docPart,para);
                    catch
                    end
                end
            end
        end
    end
end

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

Создание отчета с помощью пользовательского класса

После настройки класса и методов используйте sltest.testmanager.report для создания отчета. Необходимо использовать 'CustomReportClass' пара имя-значение для пользовательского класса, заданная как строка. Например:

% Generate the result set from imported data
result = sltest.testmanager.importResults('demoResults.mldatx');

% Specify the report file name and path
filePath = 'testreport.zip';

% Generate the report using the custom class
sltest.testmanager.report(result,filePath, ...
            'Author','MathWorks',...
            'Title','Test',...
            'IncludeMLVersion',true,...
            'IncludeTestResults',int32(0),...
            'CustomReportClass','CustomReport',...
            'LaunchReport', true);

Можно также создать пользовательский отчет с помощью диалогового окна Test Manager report. Выберите результат теста, нажмите кнопку «Отчет» на панели инструментов и укажите пользовательский класс отчета в диалоговом окне «Создание отчета о результатах теста». Чтобы диспетчер тестов мог использовать пользовательский класс отчетов, класс должен находиться в пути MATLAB.

См. также

sltest.testmanager.report | sltest.testmanager.TestResultReport

Связанные темы

Конструкторы подкласса проектирования

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