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

Формат и агрегирование результатов тестирования можно выбрать путем настройки отчетов. Используйте sltest.testmanager.TestResultReport Класс для создания подкласса, а затем используйте свойства и методы для настройки создания отчета о результатах диспетчером тестов. Можно изменять стили шрифта, добавлять графики, организовывать результаты в таблицы, включать изображения моделей и многое другое. Использование пользовательского класса требует MATLAB^® Сообщить 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);

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

См. также

sltest.testmanager.report | sltest.testmanager.TestResultReport

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