sltest.testmanager.TestSpecReport

Сгенерируйте отчет о тестовых спецификациях

Описание

пример

sltest.testmanager.TestSpecReport(testObj,filePath,Name,Value) генерирует отчет о тестовых спецификациях для заданного testObj и сохраняет отчет в указанном filePath расположение.

Примеры

свернуть все

Сгенерируйте PDF отчет, который использует шаблон по умолчанию. Этот пример сообщает о тестовых случаях из файла менеджера тестов AutopilotTestFile модель. В отчете указывается автор теста и заголовок отчета. Он исключает из отчета пользовательские критерии и запускает отчет после его создания. Другие свойства по умолчанию true и, таким образом, их информация включена в доклад.

testmgrFile = 'AutopilotTestFile.mldatx';
sltest.testmanager.load(testmgrFile);

tfiles = sltest.testmanager.getTestFiles;
tcases = tfiles.getTestSuites.getTestCases;

sltest.testmanager.TestSpecReport(tcases,'testReport.pdf',...
	'Author','Test File Author',...
	'Title','Test Specification Details',...
	'IncludeCustomCriteria',false,...
    'LaunchReport',true);

Создайте пользовательский шаблон теста. После редактирования шаблона при необходимости используйте этот шаблон при генерации отчета. Примеры правок пользовательского шаблона включают переупорядочение разделов отчета и изменение шрифтов отчета. В этом примере показано, как сгенерировать настроенный TestCaseReporter. Создание настраиваемого шаблона TestSuiteReporter аналогично и используется для создания разделов отчета Тестовый набор и Тестовый Файл. Для настройки шаблонов требуются лицензии MATLAB Report Generator и Simulink Report Generator.

Создайте и разархивируйте файл шаблона PDF

sltest.testmanager.TestCaseReporter.createTemplate(...
   'MyCustomTemplate','pdf');
unzipTemplate('MyCustomTemplate.pdftx');

Редактирование файлов шаблонов

Затем отредактируйте файлы шаблонов в папке MyCustomTemplate по желанию.

ZIP- Файлов шаблона

zipTemplate('MyCustomTemplate.pdftx');

Используйте свой пользовательский файл шаблона для отчета

testmgrFile = 'AutopilotTestFile.mldatx';
sltest.testmanager.load(testmgrFile);

tfiles = sltest.testmanager.getTestFiles;
tcases = tfiles.getTestSuites.getTestCases;

sltest.testmanager.TestSpecReport(tcases,'testReport.pdf',...
   'Author','Test Author','Title','Test',...
   'LaunchReport',true,...
   'TestCaseReporterTemplate','MyCustomTemplate.pdftx');

Входные параметры

свернуть все

Тестовые объекты, из которых можно сгенерировать отчет о тестовых спецификациях, заданный как массив sltest.testmanager.TestFile, sltest.testmanager.TestSuite, или sltest.testmanager.TestCase объекты. Вы не можете включать другие типы объектов в один и тот же массив.

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

  • pdf - отчет PDF

  • docx - Word-отчет

  • zip - HTML в zip-файле.

Пример: «reports/test_specs/new_report.pdf»

Аргументы в виде пар имя-значение

Задайте необязательные разделенные разделенными запятой парами Name,Value аргументы. Name - имя аргумента и Value - соответствующее значение. Name должны находиться внутри кавычек. Можно задать несколько аргументов в виде пар имен и значений в любом порядке Name1,Value1,...,NameN,ValueN.

Пример: 'IncludeCallbackScripts',false

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

Пример: 'Author','J. Smith'

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

Опция включения сведений о тесте в отчет, заданный как логический. Если true, подробные данные теста, включенные в отчет, являются тестовыми тегами, релизами, описанием и требованиями.

Опция включения опций тестового файла в отчет, заданный как логический. Если true, опции тестового файла, включенные в отчет:

  • Закрывать ли открытые рисунки

  • Хранить ли фигуры MATLAB

  • Сгенерировать ли отчет после выполнения

  • Опции генерации отчетов о результатах

    • Заголовок отчета

    • Автор

    • Будет ли включать версию MATLAB

    • Типы результатов тестирования, которые нужно включить (все, только неудачные или только пройденные)

    • Другие элементы для включения в отчет - требования к тестам, метаданные симуляции, сообщения об ошибках и журналах, графики выхода и базового уровня симуляции, графики критериев и оценок, MATLAB® рисунки и результаты покрытия

    • Выход файла

    • Выход файла

    • Пользовательский класс отчета

Опция включения параметров покрытия в отчет, заданный как логический. Если trueпараметры покрытия, включенные в отчет, включают покрытие для сбора, имя файла фильтра покрытия и метрики покрытия. Примеры метрик покрытия, включенных в отчет, включают решения, диапазон сигнала, реляционные контуры, насыщение при целочисленном переполнении и интерполяционные таблицы. Для получения дополнительной информации о сборе покрытия см. Раздел «Сбор покрытия в тестах».

Опция включения тестируемой системы в отчет, заданная как логическая. Если trueв отчет включена следующая тестовая информация:

  • Имя и изображение модели

  • Имя и изображение обвязки

  • Тестовая последовательность и данные оценки (если они существуют в тестовой обвязке)

  • Настройки симуляции - режим симуляции, время запуска (если переопределено), время остановки (если переопределено) и начальное состояние (если переопределено)

  • Целевые настройки - целевая информация для тестов в реальном времени

Опция включения переопределений настроек строения, заданная как логическая. Если true, отчет включает настройки, которые отличаются от настроек конфигурации модели.

Опция включения скриптов коллбэка в отчет, заданный как логический.

Опция для включения переопределений параметров в отчет, заданный как логический. Если trueотчет включает имя набора параметров или переменной рабочей области, значение переопределения, источник переменной и элемент модели.

Опция включения внешних входов в отчет, заданная как логический. Если trueотчет включает имя, путь к файлу и состояние отображения внешних входов.

Опция включения записанных сигналов, заданная как логическая. Если trueотчет включает имя, источник, индекс порта и индекс графика для каждого записанного сигнала.

Опция включения информации о критериях базового уровня в отчет, заданная как логическая. Если true, отчет включает имя сигнала, абсолютную погрешность, относительную погрешность, ведущий допуск и запаздывающий допуск для базового теста.

Опция включения информации о критериях эквивалентности в отчет, заданная как логическая. Если true, отчет включает имя сигнала, абсолютную погрешность, относительную погрешность, ведущий допуск и запаздывающий допуск для теста эквивалентности.

Опция включения информации о итерациях в отчет, заданная как логическая. Если trueотчет включает имя итерации и значения внешних входов, набора параметров и набора записанных сигналов для каждой итерации. Он также включает содержимое раздела Iterations Script из Диспетчера тестов.

Опция включения логических и временных оценок в отчет, заданная как логическая. Если trueотчет включает коллбэки оценки, определения оценки и символы из теста.

Опция включения в отчет пользовательского скрипта критериев прохождения/непрохождения, заданная как логический.

Опция открытия отчета после его генерации, заданная как логическая.

Путь к шаблону репортера теста, заданный как вектор символов. В имени файла пути шаблона необходимо использовать pdftx, html, или dotx расширение для шаблона PDF, HTML или Word, соответственно. Указанный шаблон используется вместо стандартного TestCaseReporter шаблон. Использование шаблонов, не являющихся шаблонами по умолчанию, доступно только при наличии Simulink® Сообщить Generator™ лицензии.

Путь к тестовому набору репортера, заданный как вектор символов. Имя файла в пути шаблона должно использовать pdftx, html, или dotx расширение для шаблона PDF, HTML или Word, соответственно. The TestSuiteReporter шаблон используется как для тестовых наборов, так и для тестовых файлов. Указанный шаблон используется вместо стандартного TestSuiteReporter шаблон. Использование шаблонов, отличных от шаблонов по умолчанию, доступно только при наличии лицензии Simulink Report Generator.

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