Coverlet

驱动程序	当前版本	下载量
coverlet.collector
coverlet.msbuild
coverlet.console

Coverlet 是一个跨平台的 .NET 代码覆盖率框架，支持行覆盖、分支覆盖和方法覆盖。它可以在 Windows 上的 .NET Framework 和所有支持平台上的 .NET Core 中使用。

Coverlet 文档反映了功能的当前存储库状态，而不是已发布的版本。 请查看更新日志以了解您想使用的文档化功能是否已正式发布。

主要内容

• 快速入门
• 工作原理
• 驱动程序功能差异
• 确定性构建支持
• 已知问题
• 使用每日构建版本
• 功能示例
• Cake 插件
• Visual Studio 插件
• 更新日志
• 路线图

快速入门

Coverlet 可以通过三种不同的驱动程序使用

• VSTest 引擎集成
• MSBuild 任务集成
• 作为 .NET 全局工具（支持独立集成测试）

Coverlet 仅支持 SDK 风格的项目 https://docs.microsoft.com/en-us/visualstudio/msbuild/how-to-use-project-sdk?view=vs-2019

VSTest 集成（由于已知问题，推荐使用）

安装 (coverlet.collector)

dotnet add package coverlet.collector

注意：您必须仅将包添加到测试项目中。如果您创建 xunit 测试项目（dotnet new xunit），您会发现在 csproj 文件中已经存在引用，因为 Coverlet 是每个 .NET Core 和 >= .NET 6 应用程序的默认覆盖率工具，您只需在需要时更新到最新版本。请勿在测试项目中同时添加 coverlet.collector 和 coverlet.msbuild 包。

使用方法 (coverlet.collector)

Coverlet 作为数据收集器集成到 Visual Studio 测试平台中。要获取覆盖率，只需运行以下命令：

dotnet test --collect:"XPlat Code Coverage"

运行上述命令后，一个包含结果的 coverage.cobertura.xml 文件将作为附件发布到 TestResults 目录中。

高级用法请参阅文档。

要求 (coverlet.collector)

• 您需要运行 .NET 6.0 SDK v6.0.316 或更新版本
• 您需要引用 Microsoft.NET.Test.Sdk 的 17.5.0 及以上版本

<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />

MSBuild 集成（可能受到已知问题的影响）

安装 (coverlet.msbuild)

dotnet add package coverlet.msbuild

注意：通常你必须只在测试项目中添加包。不要在测试项目中同时添加coverlet.msbuild和coverlet.collector包。

使用 (coverlet.msbuild)

Coverlet还集成了构建系统，可以在测试后运行代码覆盖率。启用代码覆盖率非常简单，只需将CollectCoverage属性设置为true即可

dotnet test /p:CollectCoverage=true

运行上述命令后，将在测试项目的根目录中生成一个包含结果的coverage.json文件。结果摘要也会显示在终端中。

高级用法请参阅文档。

要求 (coverlet.msbuild)

需要支持_.NET Standard 2.0及以上版本_的运行时

.NET 全局工具（指南，可能存在已知问题）

安装 (coverlet.console)

dotnet tool install --global coverlet.console

使用 (coverlet.console)

coverlet工具通过指定包含单元测试的程序集路径来调用。你还需要使用--target和--targetargs选项分别指定测试运行器和传递给测试运行器的参数。使用提供的参数调用测试运行器不得涉及单元测试程序集的重新编译，否则将无法生成覆盖率结果。

以下示例展示了如何使用常见的dotnet test工具链：

coverlet /path/to/test-assembly.dll --target "dotnet" --targetargs "test /path/to/test-project --no-build"

注意：指定--no-build标志是为了确保不会重新构建/path/to/test-assembly.dll程序集

高级用法请参阅文档。

要求 (coverlet.console)

.NET全局工具依赖于安装在你机器上的.NET Core运行时 https://docs.microsoft.com/zh-cn/dotnet/core/tools/global-tools#what-could-go-wrong

.NET Coverlet全局工具需要_.NET Core 2.2及以上版本_

工作原理

Coverlet通过以下过程生成代码覆盖率信息：

测试运行前

• 定位单元测试程序集并选择所有具有PDB的引用程序集。
• 通过插入代码来记录序列点命中到临时文件，从而对所选程序集进行插桩。

测试运行后

• 恢复原始的未插桩程序集文件。
• 从临时文件读取记录的命中信息。
• 从命中信息生成覆盖率结果并将其写入文件。

确定性构建支持

Coverlet支持确定性构建的覆盖率。目前的解决方案并不理想，需要一个变通方法。 请查看文档。

遇到某些功能的问题？查看示例！

已知问题

很遗憾，我们有一些已知问题，请在这里查看

Cake 插件

如果你使用Cake Build作为构建脚本，可以使用Cake.Coverlet插件为dotnet test提供扩展，以强类型方式传递Coverlet参数。

Visual Studio 插件

如果你想在编码时在Visual Studio内部可视化Coverlet输出，可以根据你的平台使用以下插件。

Windows

如果你在Windows上使用Visual Studio，可以使用Fine Code Coverage扩展。 当你在Visual Studio内运行单元测试时，可视化会更新。

Mac OS

如果你使用Visual Studio for Mac，可以使用VSMac-CodeCoverage扩展。

使用每晚构建版本

我们为所有包提供master分支的每晚构建版本。 查看文档

问题与贡献

如果你发现bug或有功能请求，请在本仓库的issues部分报告。有关构建和贡献此项目的详细信息，请参阅贡献指南。

Coverlet 团队

作者和所有者

• Toni Solarin-Sodara

共同维护者

• David Müller
• Bert
• Peter Liljenberg
• Marco Rossignoli

行为准则

本项目采用了Contributor Covenant定义的行为准则，以明确我们社区中的预期行为。

有关更多信息，请参阅.NET Foundation行为准则。

致谢

部分代码基于OpenCover团队的工作 https://github.com/OpenCover

许可证

本项目采用MIT许可证。有关更多信息，请参阅LICENSE文件。

由.NET Foundation支持