sltest.testmanager.TestResultReport class

Пакет: 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'

Имя файла и путь к файлу шаблона Word Microsoft® для настройки отчетов в виде вектора символов. Для получения дополнительной информации об использовании файлов шаблона смотрите, Генерируют Отчеты Используя Шаблоны. Использование этого аргумента допустимо только доступное, если у вас есть лицензия 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®, версия модели, автор модели, дата, идентификатор пользователя модели, модель path, имя машины, имя решателя, тип решателя, зафиксированный размер шага, время начала симуляции, время остановки симуляции и платформа.

Включайте сигнал симуляции выходные графики в отчете в виде 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

Для просмотра документации необходимо авторизоваться на сайте