addModelCoverage

为 TestTask 实例启用模型覆盖率收集

自 R2024a 起

语法

task = addModelCoverage(task,results) task = addModelCoverage(___,Name=Value)

说明

task = addModelCoverage(task,results) 使 task 指定的测试任务产生指定模型覆盖率结果文件中的覆盖率结果。您必须拥有 Simulink^® Coverage™ 许可证才能使用 addModelCoverage 方法。addModelCoverage 是 matlab.buildtool.tasks.TestTask 类的方法。

要使用 addModelCoverage，请使用单个命令创建 TestTask 并添加模型覆盖率。当您创建 matlab.buildtool.tasks.TestTask 实例时，请指定 Simulink Test™ 或基于 MATLAB^® 的 Simulink 测试。例如，

task = TestTask("myTestFolder").addModelCoverage...
   ("model-coverage/report.html", CoverageMetrics=...
   ["MCDC","SignalRange"]);

task = addModelCoverage(___,Name=Value) 启用模型覆盖率收集，并通过一个或多个 Name,Value 对参量指定附加选项。

输入参数

全部展开

`task` — 用于配置模型覆盖率收集的测试任务
`matlab.buildtool.tasks.TestTask` 对象

用于配置模型覆盖率收集的测试任务，指定为 matlab.buildtool.tasks.TestTask 对象。addModelCoverage 方法输出一个启用了模型覆盖率收集的对象。

`results` — 模型覆盖率结果文件
字符串向量 | 特征向量 | 特征向量的细胞向量 | `matlab.buildtool.io.File` 对象的向量

模型覆盖率结果文件，指定为字符串向量、字符向量、字符向量的单元格向量或 matlab.buildtool.io.File 对象的向量。要指定文件格式，请在文件名中包含以下文件扩展名之一：

.html — 生成 HTML 模型覆盖率报告。
.xml — 以 Cobertura XML 格式生成模型覆盖率结果。

默认格式是 HTML。

示例: "myModelCovReport.xml"

名称-值参数

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

示例: CoverageMetrics=["MCDC","SignalRange"]

`CoverageMetrics` — 可获得的覆盖率类型
字符串向量 | 特征向量 | 特征向量的细胞向量

要收集的覆盖率类型，指定为字符串、字符向量或与 sltest.plugins.coverage.CoverageMetrics 类的属性相对应的字符向量的单元格向量。如果指定多种覆盖率类型，请使用字符串向量或字符向量的单元格向量。如果您未指定 CoverageMetrics，则 TestTask 输出对象将包括应用于相应的基于 Simulink Test 和 MATLAB 的 Simulink 测试的覆盖率度量。

示例: CoverageMetrics=["MCDC","SignalRange"]

`IncludeReferencedModels` — 是否在模型覆盖率分析中包含引用模型
`true` 或 `1` (默认) | `false` 或 `0`

是否在模型覆盖率分析中包含引用的模型，指定为数字或逻辑 1 (true) 或 0 (false)。

示例: IncludeReferencedModels=false

示例

全部展开

以 HTML 格式生成模型覆盖率结果

要为构建文件中的 TestTask 对象生成模型覆盖率结果，请使用 addModelCoverage 方法。

当您运行 myTestFolder 中的测试时，此示例 buildfile.m 文件会生成 MCDC 和信号范围覆盖率，这是 TestTask 类的 Tests 属性的设置。

function plan = buildfile
   import matlab.buildtool.tasks.TestTask
   plan = buildplan();

   plan("test") = TestTask("myTestFolder").addModelCoverage...
     ("model-coverage/report.html",...
     CoverageMetrics=["MCDC" "SignalRange"]);
end

使用 test 任务运行测试并为被测模型生成模型覆盖率报告。