sltest.testmanager.TestSpecReport

生成测试规范报告

全页折叠

语法

sltest.testmanager.TestSpecReport(testObj,filePath,Name,Value)

说明

sltest.testmanager.TestSpecReport(testObj,filePath,Name,Value) 生成指定 testObj 的测试规范报告，并将报告保存到指定 filePath 位置。

示例

全部折叠

生成测试规范报告

打开脚本

生成使用默认模板的 PDF 报告。此示例报告来自 AutopilotTestFile 模型的测试文件的测试用例。报告中指定了测试作者和报告标题。它从报告中排除自定义准则并在报告生成后启动报告。其他属性默认为 true，因此它们的信息包含在报告中。

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

tfile = sltest.testmanager.TestFile(testfile);
tsuites = getTestSuites(tfile);
tcases = getTestCases(tsuites);

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

sltest.testmanager.clear;
sltest.testmanager.clearResults;

生成自定义的测试规范报告

此示例使用:

打开脚本

创建自定义测试用例模板。根据需要编辑模板后，生成报告时使用该模板。对自定义模板的编辑示例包括重新排序报告部分和更改报告字体。此示例展示如何生成自定义的 TestCaseReporter。生成自定义的 TestSuiteReporter 模板类似，用于生成测试套件和测试文件报告部分。自定义模板需要 MATLAB Report Generator 和 Simulink Report Generator 许可证。

创建并解压缩 PDF 模板文件

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

编辑模板文件

然后，根据需要编辑 MyCustomTemplate 文件夹中的模板文件。

压缩模板文件

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.clear;
sltest.testmanager.clearResults;

输入参数

全部折叠

`testObj` — 测试对象
`sltest.testmanager.TestFile` 对象数组 | `sltest.testmanager.TestSuite` 对象数组 | `sltest.testmanager.TestCase` 对象数组

用于生成测试规范报告的测试对象，指定为 sltest.testmanager.TestFile、sltest.testmanager.TestSuite 或 sltest.testmanager.TestCase 对象的数组。不能在同一个数组中包含不同类型的对象。

`filePath` — 报告的文件名和路径
字符向量

生成的报告的文件名和路径，指定为字符串或字符数组。文件路径必须具有以下文件扩展名之一：

pdf - PDF 报告
docx - 文字报告
zip - .zip 文件中的 HTML 报告

示例: “报告/测试规格/新报告.pdf”

名称-值参数

全部折叠

将可选的参量对组指定为 Name1=Value1,...,NameN=ValueN，其中 Name 是参量名称，Value 是对应的值。名称-值参量必须出现在其他参量之后，但参量对组的顺序无关紧要。

在 R2021a 之前，使用逗号分隔每个名称和值，并用引号将 Name 引起来。

示例: 'IncludeCallbackScripts',false

`Author` — 报告作者
空字符串或字符向量 (默认)

报告作者的姓名，指定为字符串或字符向量。

示例: 'Author','J. Smith'

`Title` — 报告标题
`'Test Specification Report'` (默认) | 字符串 | 字符向量

报告的标题，指定为字符向量。

`IncludeTestDetails` — 包括测试详细信息
`true` (默认) | `false`

选择在报告中包含测试详细信息，指定为逻辑。如果是 true，报告中包含的测试详细信息是测试标签、发布、描述和需求。

`IncludeTestFileOptions` — 包括测试文件选项
`true` (默认) | `false`

在报告中包含测试文件选项的选项，指定为逻辑。如果是 true，报告中包含的测试文件选项是：

是否关闭开放图形
是否存储 MATLAB 数字
执行后是否生成报告
结果报告生成选项
- 报告标题
- 作者
- 是否包含 MATLAB 版本
- 包含的测试结果类型（全部、仅失败或仅通过）
- 报告中要包括的其他项目 - 测试需求、仿真元数据、错误和日志消息、仿真输出和基线图、准则和评估图、MATLAB^® 图和覆盖率结果
- 输出文件格式
- 输出文件名
- 自定义报表类

`IncludeCoverageSettings` — 包括覆盖率设置
`true` (默认) | `false`

在报告中包含覆盖率设置的选项，指定为逻辑。如果是 true，报告中包含的覆盖率设置包括要收集的覆盖率、覆盖率过滤器文件名和覆盖率度量。报告中包含的覆盖率度量示例包括决策、信号范围、关系边界、整数溢出饱和度和查找表。有关收集覆盖率的更多信息，请参阅收集测试覆盖率。

`IncludeSystemUnderTest` — 包括在测系统
`true` (默认) | `false`

选择将在测系统在报告中，指定为逻辑。如果是 true，则报告中包含的在测系统信息是：

型号名称和图像
框架名称和图像
测试序列和评估数据（如果它们存在于测试框架中）
仿真设置 - 仿真模式、开始时间（如果被覆盖）、停止时间（如果被覆盖）和初始状态（如果被覆盖）
目标设置 - 实时测试用例的目标信息

`IncludeConfigSettingsOverrides` — 包括配置设置覆盖
`true` (默认) | `false`

包含配置设置覆盖的选项，指定为逻辑。如果是 true，则报告包含与模型配置设置不同的设置。

`IncludeCallbackScripts` — 包括回调脚本
`true` (默认) | `false`

在报告中包含回调脚本的选项，指定为逻辑。

`IncludeParameterOverrides` — 包括参数覆盖
`true` (默认) | `false`

在报告中包含参数覆盖的选项，指定为逻辑。如果是 true，报告将包括参数集或工作区变量的名称、覆盖值、变量的来源、模型元素以及变体配置（如果使用）。

`IncludeExternalInputs` — 包括外部输入
`true` (默认) | `false`

在报告中包含外部输入的选项，指定为逻辑。如果是 true，报告将包括外部输入的名称、文件路径和映射状态。

`IncludeLoggedSignals` — 包括记录的信号
`true` (默认) | `false`

包括记录信号的选项，指定为逻辑。如果是 true，报告将包括每个记录信号的名称、来源、端口索引和绘图索引。

`IncludeBaselineCriteria` — 包括基线准则
`true` (默认) | `false`

选择在报告中包含基线准则信息，指定为逻辑。如果是 true，报告将包括基线测试的信号名称、绝对容差、相对容差、超前容差和滞后容差。

`IncludeEquivalenceCriteria` — 包括等效性准则
`true` (默认) | `false`

在报告中包含等效性准则信息的选项，指定为逻辑。如果是 true，报告将包括等效性检验的信号名称、绝对容差、相对容差、超前容差和滞后容差。

`IncludeIterations` — 包括迭代
`true` (默认) | `false`

在报告中包含迭代信息的选项，指定为逻辑。如果是 true，报告将包括迭代名称和每次迭代的外部输入、参数集、记录信号集和变体配置的值。它还包括来自测试管理器的迭代脚本部分的内容。

`IncludeLogicalAndTemporalAssessments` — 包括逻辑和时序评估
`true` (默认) | `false`

选择在报告中包含逻辑和时序评估，指定为逻辑。如果是 true，报告则包括来自测试用例的评估回调、评估定义和符号。

`IncludeCustomCriteria` — 包括自定义准则
`true` (默认) | `false`

选择在报告中包含自定义通过/失败准则脚本，指定为逻辑。

`LaunchReport` — 打开生成的报告
`false` (默认) | `true`

报告生成后打开该报告的选项，指定为逻辑。

`TestCaseReporterTemplate` — 测试用例报告模板的路径
`character vector`

测试用例报告模板的路径，指定为字符向量。模板路径文件名必须分别使用 pdftx、html 或 dotx 扩展名（代表 PDF、HTML 或 Word 模板）。使用指定的模板代替默认的 TestCaseReporter 模板。仅当您拥有 Simulink^® Report Generator™ 许可证时才可以使用非默认模板。

`TestSuiteReporterTemplate` — 测试套件报告模板的路径
`character vector`

测试套件报告器模板的路径，指定为字符向量。模板路径中的文件名必须分别使用 pdftx、html 或 dotx 扩展名（代表 PDF、HTML 或 Word 模板）。TestSuiteReporter 模板用于测试套件和测试文件。使用指定的模板代替默认的 TestSuiteReporter 模板。仅当您拥有 Simulink Report Generator 许可证时才可以使用非默认模板。

版本历史记录

在 R2019b 中推出

另请参阅

sltest.testmanager.getTestFiles | sltest.testmanager.TestFile | sltest.testmanager.TestSuite | sltest.testmanager.TestCase

sltest.testmanager.TestSpecReport

语法

说明

示例

生成测试规范报告

生成自定义的测试规范报告

输入参数

testObj — 测试对象 sltest.testmanager.TestFile 对象数组 | sltest.testmanager.TestSuite 对象数组 | sltest.testmanager.TestCase 对象数组

filePath — 报告的文件名和路径 字符向量

名称-值参数

Author — 报告作者 空字符串或字符向量 (默认)

Title — 报告标题 'Test Specification Report' (默认) | 字符串 | 字符向量

IncludeTestDetails — 包括测试详细信息 true (默认) | false

IncludeTestFileOptions — 包括测试文件选项 true (默认) | false

IncludeCoverageSettings — 包括覆盖率设置 true (默认) | false

IncludeSystemUnderTest — 包括在测系统 true (默认) | false

IncludeConfigSettingsOverrides — 包括配置设置覆盖 true (默认) | false

IncludeCallbackScripts — 包括回调脚本 true (默认) | false

IncludeParameterOverrides — 包括参数覆盖 true (默认) | false

IncludeExternalInputs — 包括外部输入 true (默认) | false

IncludeLoggedSignals — 包括记录的信号 true (默认) | false

IncludeBaselineCriteria — 包括基线准则 true (默认) | false

IncludeEquivalenceCriteria — 包括等效性准则 true (默认) | false

IncludeIterations — 包括迭代 true (默认) | false

IncludeLogicalAndTemporalAssessments — 包括逻辑和时序评估 true (默认) | false

IncludeCustomCriteria — 包括自定义准则 true (默认) | false

LaunchReport — 打开生成的报告 false (默认) | true

TestCaseReporterTemplate — 测试用例报告模板的路径 character vector

TestSuiteReporterTemplate — 测试套件报告模板的路径 character vector

版本历史记录

另请参阅

主题

`testObj` — 测试对象
`sltest.testmanager.TestFile` 对象数组 | `sltest.testmanager.TestSuite` 对象数组 | `sltest.testmanager.TestCase` 对象数组

`filePath` — 报告的文件名和路径
字符向量

`Author` — 报告作者
空字符串或字符向量 (默认)

`Title` — 报告标题
`'Test Specification Report'` (默认) | 字符串 | 字符向量

`IncludeTestDetails` — 包括测试详细信息
`true` (默认) | `false`

`IncludeTestFileOptions` — 包括测试文件选项
`true` (默认) | `false`

`IncludeCoverageSettings` — 包括覆盖率设置
`true` (默认) | `false`

`IncludeSystemUnderTest` — 包括在测系统
`true` (默认) | `false`

`IncludeConfigSettingsOverrides` — 包括配置设置覆盖
`true` (默认) | `false`

`IncludeCallbackScripts` — 包括回调脚本
`true` (默认) | `false`

`IncludeParameterOverrides` — 包括参数覆盖
`true` (默认) | `false`

`IncludeExternalInputs` — 包括外部输入
`true` (默认) | `false`

`IncludeLoggedSignals` — 包括记录的信号
`true` (默认) | `false`

`IncludeBaselineCriteria` — 包括基线准则
`true` (默认) | `false`

`IncludeEquivalenceCriteria` — 包括等效性准则
`true` (默认) | `false`

`IncludeIterations` — 包括迭代
`true` (默认) | `false`

`IncludeLogicalAndTemporalAssessments` — 包括逻辑和时序评估
`true` (默认) | `false`

`IncludeCustomCriteria` — 包括自定义准则
`true` (默认) | `false`

`LaunchReport` — 打开生成的报告
`false` (默认) | `true`

`TestCaseReporterTemplate` — 测试用例报告模板的路径
`character vector`

`TestSuiteReporterTemplate` — 测试套件报告模板的路径
`character vector`