exponenta event banner

класс sltest.testmanager.StartResultReport

Пакет: sltest.testmanager
Суперклассы:

Настроить созданный отчет о результатах

Описание

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

Дополнительные сведения и примеры настройки отчетов см. в разделе Настройка отчетов о результатах тестирования.

Строительство

Obj = sltest.testmanager.TestResultReport(resultObjects,reportFilePath) создает объект создания отчета.

Чтобы использовать этот класс, необходимо унаследовать от него. Используйте следующий код в качестве первых строк в коде определения класса для наследования от класса.

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

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

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

Объект набора результатов для получения результатов, указанный как sltest.testmanager.ResultSet объект.

Имя файла и путь к созданному отчету. Путь к файлу должен иметь расширение pdf, docx или zip, которые являются единственными поддерживаемыми типами файлов.

Пример: 'C:\MATLAB\Report.pdf'

Свойства

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

Имя автора или созданного отчета, указанное как символьный вектор.

Пример: 'Test Engineer'

Цвет шрифта текста основного абзаца, заданный как символьный вектор.

Пример: 'Red'

Имя шрифта текста основного абзаца, указанное как символьный вектор.

Пример: 'Times New Roman'

Размер шрифта текста основного абзаца, указанный в точках как символьный вектор.

Пример: '14pt'

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

Пример: '5mm'

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

Пример: '8mm'

Ширина отступа третьего уровня, заданная в миллиметрах в качестве символьного вектора.

Пример: '10mm'

Имя файла и путь к файлу шаблона Microsoft ® Word для настройки отчета, указанные как символьный вектор. Дополнительные сведения об использовании файлов шаблонов см. в разделе Создание отчетов с помощью шаблонов. Этот аргумент допустим только при наличии лицензии MATLAB ® Report Generator™.

Пример: 'C:\MATLAB\CustomReportTemplate.dotx'

Цвет шрифта текста заголовка раздела, заданный как символьный вектор.

Пример: 'Blue'

Имя текстового шрифта заголовка раздела, указанное как символьный вектор.

Пример: 'Times New Roman'

Цвет шрифта текста заголовка раздела, заданный в точках как символьный вектор.

Пример: '16pt'

Имя файла и путь к изображению значка для отключенного результата теста, заданного как символьный вектор. Указанный файл значка заменяет изображение значка по умолчанию. Изображение значка уменьшено до 16x16 пикселей.

Пример: 'C:\MATLAB\disabled_test_icon.png'

Имя файла и путь к изображению значка для неудачного результата теста, заданного как символьный вектор. Указанный файл значка заменяет изображение значка по умолчанию. Изображение значка уменьшено до 16x16 пикселей.

Пример: 'C:\MATLAB\failed_test_icon.png'

Имя файла и путь к изображению значка для неполного результата теста, заданного как символьный вектор. Указанный файл значка заменяет изображение значка по умолчанию. Изображение значка уменьшено до 16x16 пикселей.

Пример: 'C:\MATLAB\incomplete_test_icon.png'

Имя файла и путь к изображению значка для несовпадающего результата теста, заданного как символьный вектор. Указанный файл значка заменяет изображение значка по умолчанию. Изображение значка уменьшено до 16x16 пикселей.

Пример: 'C:\MATLAB\misaligned_test_icon.png'

Имя файла и путь к изображению значка для пройденного теста, заданного как символьный вектор. Указанный файл значка заменяет изображение значка по умолчанию. Изображение значка уменьшено до 16x16 пикселей.

Пример: 'C:\MATLAB\passed_test_icon.png'

Имя файла и путь к изображению значка для результата теста, заданного как символьный вектор. Указанный файл значка заменяет изображение значка по умолчанию. Изображение значка уменьшено до 16x16 пикселей.

Пример: 'C:\MATLAB\test_case_result_icon.png'

Имя файла и путь к изображению значка для результата тестирования, заданного как вектор символов. Указанный файл значка заменяет изображение значка по умолчанию. Изображение значка уменьшено до 16x16 пикселей.

Пример: 'C:\MATLAB\test_file_result_icon.png'

Имя файла и путь к изображению значка для результата итерации, заданного как символьный вектор. Указанный файл значка заменяет изображение значка по умолчанию. Изображение значка уменьшено до 16x16 пикселей.

Пример: 'C:\MATLAB\iteration_result_icon.png'

Имя файла и путь к изображению значка для результата набора тестов, заданного как вектор символов. Указанный файл значка заменяет изображение значка по умолчанию. Изображение значка уменьшено до 16x16 пикселей.

Пример: 'C:\MATLAB\test_suite_result_icon.png'

Имя файла и путь к изображению значка для ссылки на модель в отчете о покрытии, указанный как символьный вектор. Указанный файл значка заменяет изображение значка по умолчанию. Изображение значка уменьшено до 16x16 пикселей.

Пример: 'C:\MATLAB\model_reference_icon.png'

Имя файла и путь к изображению значка для модели верхнего уровня в отчете о покрытии, указанный как вектор символов. Указанный файл значка заменяет изображение значка по умолчанию. Изображение значка уменьшено до 16x16 пикселей.

Пример: 'C:\MATLAB\top_level_model_icon.png'

Включить в отчет графики сравнения сигналов, указанные как true или false.

Включить результаты покрытия в отчет, указанные как true или false.

Включить в отчет сообщения об ошибках, указанные как true или false.

Включите в отчет версию MATLAB, используемую для выполнения тестов, указанную как true или false.

Включить метаданные моделирования в отчет, указанные как true или false. Метаданные включают:  версию Simulink ®, версию модели, автора модели, дату, идентификатор пользователя модели, путь к модели, имя машины, имя решателя, тип решателя, фиксированный размер шага, время начала моделирования, время остановки моделирования и платформу.

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

Включить в отчет требования к тесту, связанные с тестовым файлом, набором тестов или тестовым случаем, указанным как true или false.

Включить все или подмножество результатов теста в отчет. Можно выбрать все пройденные и неудавшиеся результаты, указанные как значение 0, выберите только пройденные результаты, указанные в качестве значения 1или выберите только неудачные результаты, указанные в качестве значения 2.

Откройте отчет по завершении генерации, указанный как логическое значение. true или не открывать отчет, false.

Заголовок отчета, указанный как символьный вектор

Пример: 'Test Case Report'

Интервал между секциями, определяемый в миллиметрах как символьный вектор.

Пример: '5mm'

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

Пример: '500px'

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

Пример: '400px'

Цвет шрифта таблицы, заданный как символьный вектор.

Пример: 'Blue'

Имя стиля шрифта таблицы, указанное как символьный вектор.

Пример: 'Times New Roman'

Размер шрифта таблицы, указанный в точках как символьный вектор.

Пример: '10pt'

Цвет шрифта заголовка, заданный как символьный вектор.

Пример: 'Blue'

Имя стиля шрифта заголовка, указанное как символьный вектор.

Пример: 'Times New Roman'

Размер шрифта заголовка, указанный в точках как символьный вектор.

Пример: '20pt'

Методы

addReportBodyДобавить основную часть отчета
addReportTOCДобавление оглавления отчета
addTitlePageДобавить страницу заголовка отчета
genBaselineInfoTableСоздание информационной таблицы набора базовых данных
genCoverageTableСоздать таблицу сбора покрытия
genHyperLinkToToCСоздать ссылку на оглавление
genIterationSettingTableСоздать таблицу параметров итерации
genMetadataBlockForTestResultСоздать раздел метаданных результата
genParameterOverridesTableСоздать таблицу переопределений параметров тестового случая
genRequirementLinksTableСоздать таблицу связей требований
genResultSetBlockСоздать раздел набора результатов
genRunBlockForTestCaseResultСоздание конфигурации тестового случая и раздела результатов
genSignalSummaryTableФормирование выходных сигналов и данных сравнения
genSimulationConfigurationTableСоздание таблицы конфигурации моделирования тестового случая
genTableRowsForResultMetaInfoСоздать таблицу метаданных результатов теста
genTestCaseResultBlockСоздать раздел результатов теста
genTestSuiteResultBlockСоздать раздел результатов набора тестов
layoutReportВключает части отчета в один документ
plotOneSignalToFileСохранить печать сигнала в файл

Примеры

свернуть все

% class definition
classdef CustomReport < sltest.testmanager.TestResultReport
    % This custom class used by Test Manager 
    % adds a custom message in the title page

    % Class constructor
    methods
        function this = CustomReport(resultObjects, reportFilePath)
            this@sltest.testmanager.TestResultReport...
               (resultObjects,reportFilePath);
        end
    end

    methods(Access=protected)
        function addTitlePage(obj)
            import mlreportgen.dom.*;

            % Call the superclass method to get the default behavior
            addTitlePage@sltest.testmanager.TestResultReport(obj);

            % Add a custom message
            label = Text('Some custom content can be added here');
            append(obj.TitlePart,label);
        end
    end
end
% import existing results or use sltest.testmanager.run to run tests
% and collect results
result = sltest.testmanager.importResults('testResults.mldatx');
filePath = 'testreport.zip';
sltest.testmanager.report(result,filePath,...
			'Author','User',...
			'Title','Test',...
			'IncludeMLVersion',true,...
			'IncludeTestResults',int32(0),...
			'CustomReportClass','CustomReport',...
			'LaunchReport',true);
Представлен в R2016a