sltest.testmanager.report

生成测试结果报告

语法

sltest.testmanager.report(resultObj,filePath,"IncludeTestResults",testResults)

sltest.testmanager.report(___,Name=Value)

说明

sltest.testmanager.report(resultObj,filePath,"IncludeTestResults",testResults) 根据 resultObj 指定的结果生成一份报告，并将报告保存到 filePath 指定的位置.使用 IncludeTestResults 参量指定是否包含通过、失败或所有结果。

示例

sltest.testmanager.report(___,Name=Value) 除了前面语法中的输入参量外，还使用一个或多个名称-值参量指定选项。

示例

全部折叠

生成包含通过结果的测试报告

生成一个仅包含通过结果的 PDF 报告。

filePath = 'testReport.pdf';
sltest.testmanager.report(resultObj,filePath,...
	'IncludeTestResults',1);

生成测试报告

生成包含测试作者、测试标题以及运行测试用例所使用的 MATLAB^® 版本的报告。该报告仅包含失败的结果。

filePath = 'test.pdf';
sltest.testmanager.report(resultObj,filePath,...
	'Author','TestAuthor',...
	'Title','Test',...
	'IncludeMLVersion',true,...
	'IncludeTestResults',2);

使用自定义报告类生成报告

如果您创建自定义类来自定义如何使用 sltest.testmanager.TestResultReport 类生成报告，则使用以下命令生成报告：

% 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),...
	'IncludeSimulationSignalPlots',true,...
	'NumPlotColumnsPerPage',2,...
	'CustomReportClass','CustomReport',...
	'LaunchReport',true);

输入参数

全部折叠

`resultObj` — 结果集对象
对象

从结果集对象获取结果，指定为 sltest.testmanager.ResultSet、sltest.testmanager.TestFileResult、sltest.testmanager.TestSuiteResult、sltest.testmanager.TestCaseResult 或 sltest.testmanager.TestIterationResult 对象。

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

生成的报告的文件名和路径，指定为字符向量。文件路径必须具有 pdf、docx 或 zip 文件扩展名，这些是唯一支持的文件类型。

`testResults` — 包括全部或部分测试结果
`2` (默认) | `0` | `1`

在报告中包括全部或部分测试结果。您可以选择通过和失败的结果（指定为整数值 0），仅选择通过的结果（指定为值 1），或者仅选择失败的结果（指定为值 2）。

名称-值参数

全部折叠

以 Name1=Value1,...,NameN=ValueN 的形式指定可选参量对组，其中 Name 是参量名称，Value 是对应的值。名称-值参量必须出现在其他参量之后，但对各个参量对组的顺序没有要求。

示例: 'IncludeTestRequirement',true

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

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

示例: 'Test Engineer'

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

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

示例: 'Test_Report_1'

`IncludeMLVersion` — 包含 MATLAB 版本
`true` (默认) | `false`

选择包含用于运行测试用例的 MATLAB 版本，指定为布尔值，true 或 false。

`IncludeTestRequirement` — 包括测试需求
`true` (默认) | `false`

选择在测试用例中包含需求下定义的测试需求链接，指定为布尔值，true 或 false。

`IncludeSimulationSignalPlots` — 包括仿真输出图
`false` (默认) | `true`

选择包含每个信号的仿真输出图，指定为布尔值，true 或 false。

`NumPlotRowsPerPage` — 报告页面上要包含的图行数
2 (默认)

报告页面上要包含的图的行数，指定为 1 至 4 之间的整数。仅当 IncludeSimulationSignalPlots 属性为 true 时才使用此属性。

`NumPlotColumnsPerPage` — 报告页面上包含的图列数
1 (默认)

报告页面上要包含的图的列数，指定为 1 到 4 之间的整数。仅当 IncludeSimulationSignalPlots 属性为 true 时才使用此属性。

`IncludeComparisonSignalPlots` — 包括比较图
`false` (默认) | `true`

选择包含在测试用例中使用 verify 运算等效性的准则或基线准则下定义的信号比较评估，指定为布尔值 true 或 false。

`IncludeMATLABFigures` — 包含图片的选项
`false` (默认) | `true`

包含从回调脚本、自定义准则或报告中的模型打开的数字的选项，指定为 true 或 false。

`IncludeErrorMessages` — 包含错误消息
`true` (默认) | `false`

选择包含来自测试用例仿真的错误消息，指定为布尔值，true 或 false。

`LaunchReport` — 完成后打开报告
`true` (默认) | `false`

报告生成完成后打开报告，指定为布尔值 true 或不打开报告 false。

`CustomTemplateFile` — 文档模板路径
字符向量

用于生成报告的 Microsoft^® Word 模板文件的名称和路径，指定为字符向量。这是一个可选参量，仅当您拥有 MATLAB Report Generator™ 许可证时才可用。

`CustomReportClass` — 自定义报告的类名
字符向量

用于报告自定义的类的名称，指定为字符向量。这是一个可选参量，仅当您拥有 MATLAB Report Generator 许可证时才可用。

`IncludeCoverageResult` — 包括覆盖率结果度量
`false` (默认) | `true`

是否包含在测试执行时收集的覆盖率度量，作为布尔值指定，即 true 或 false 的选项。有关收集覆盖率的更多信息，请参阅收集测试覆盖率。

`IncludeSimulationMetadata` — 包括仿真元数据
`false` (默认) | `true`

是否包含每个测试用例或迭代的仿真元数据的选项，作为布尔值指定，true 或 false。元数据包括 Simulink^® 模型、模型版本、模型路径、仿真模式、覆盖 SIL 或 PIL 模式、配置集、变体配置、求解器名称和类型、最大步长、开始和停止时间、校验和、用户 ID、计算机名称、平台以及 Simulink 版本和发布版。

`IncludeSequenceDiagrams` — 选项：是否包含已执行的序列图的图像
`false` (默认) | `true`

自 R2025a 起

可选项：包含已执行的序列图的图像，格式指定为 true 或 false。当此选项设置为 false 时，报告中将包含序列图名称、结果状态以及模型和框架名称。将此选项设置为 true，以在结果报告中包含已执行的序列图的图像。

版本历史记录

在 R2015a 中推出

全部展开

R2025a: 在报告中包含序列图

使用 IncludeSequenceDiagrams 参量来指定是否在测试结果报告中包含序列图。

另请参阅

sltest.testmanager.ResultSet | sltest.testmanager.TestResultReport

sltest.testmanager.report

语法

说明

示例

生成包含通过结果的测试报告

生成测试报告

使用自定义报告类生成报告

输入参数

resultObj — 结果集对象 对象

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

testResults — 包括全部或部分测试结果 2 (默认) | 0 | 1

名称-值参数

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

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

IncludeMLVersion — 包含 MATLAB 版本 true (默认) | false

IncludeTestRequirement — 包括测试需求 true (默认) | false

IncludeSimulationSignalPlots — 包括仿真输出图 false (默认) | true

NumPlotRowsPerPage — 报告页面上要包含的图行数 2 (默认)

NumPlotColumnsPerPage — 报告页面上包含的图列数 1 (默认)

IncludeComparisonSignalPlots — 包括比较图 false (默认) | true

IncludeMATLABFigures — 包含图片的选项 false (默认) | true

IncludeErrorMessages — 包含错误消息 true (默认) | false

LaunchReport — 完成后打开报告 true (默认) | false

CustomTemplateFile — 文档模板路径 字符向量

CustomReportClass — 自定义报告的类名 字符向量

IncludeCoverageResult — 包括覆盖率结果度量 false (默认) | true

IncludeSimulationMetadata — 包括仿真元数据 false (默认) | true

IncludeSequenceDiagrams — 选项：是否包含已执行的序列图的图像 false (默认) | true

版本历史记录

R2025a: 在报告中包含序列图

另请参阅

主题

`resultObj` — 结果集对象
对象

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

`testResults` — 包括全部或部分测试结果
`2` (默认) | `0` | `1`

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

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

`IncludeMLVersion` — 包含 MATLAB 版本
`true` (默认) | `false`

`IncludeTestRequirement` — 包括测试需求
`true` (默认) | `false`

`IncludeSimulationSignalPlots` — 包括仿真输出图
`false` (默认) | `true`

`NumPlotRowsPerPage` — 报告页面上要包含的图行数
2 (默认)

`NumPlotColumnsPerPage` — 报告页面上包含的图列数
1 (默认)

`IncludeComparisonSignalPlots` — 包括比较图
`false` (默认) | `true`

`IncludeMATLABFigures` — 包含图片的选项
`false` (默认) | `true`

`IncludeErrorMessages` — 包含错误消息
`true` (默认) | `false`

`LaunchReport` — 完成后打开报告
`true` (默认) | `false`

`CustomTemplateFile` — 文档模板路径
字符向量

`CustomReportClass` — 自定义报告的类名
字符向量

`IncludeCoverageResult` — 包括覆盖率结果度量
`false` (默认) | `true`

`IncludeSimulationMetadata` — 包括仿真元数据
`false` (默认) | `true`

`IncludeSequenceDiagrams` — 选项：是否包含已执行的序列图的图像
`false` (默认) | `true`