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'

Имя файла и путь к Microsoft® Файл шаблона Word для индивидуальной настройки отчета, заданный как вектор символов. Дополнительные сведения об использовании файлов шаблонов см. в разделе Создание отчетов с использованием шаблонов. Использование этого аргумента допустимо только при наличии MATLAB® Сообщить 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'

Заголовок стиля шрифта title, заданное как вектор символов.

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

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

Пример: '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

Simulink Test документация

Поддержка

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