使用 C# Dev Kit 进行测试

在 Visual Studio Code 中使用 C# 进行测试需要 C# Dev Kit 扩展的支持。这是一个旨在提升您 C# 开发体验的轻量级扩展。

概述

该扩展支持以下测试框架:

C# Dev Kit 扩展提供以下功能

  • 运行/调试测试用例
  • 查看测试报告
  • 在测试资源管理器中查看测试

要求

项目设置

注意:如果您已经在项目中设置了 C# 测试框架,可以直接跳至“功能”部分。

启用测试并将测试框架包添加到您的项目

您只需在“解决方案资源管理器”中通过几个简单的步骤,即可为您的项目启用测试框架

xUnit

打开命令面板并选择 .NET:New Project..,然后选择 xUnit Test Project 并输入新项目的名称和位置。这将创建一个使用 xUnit 作为测试库的新项目和目录,并通过向项目文件添加以下 <PackageReference /> 元素来配置测试运行程序。

  • Microsoft.NET.Test.Sdk
  • xunit
  • xunit.runner.visualstudio
  • coverlet.collector

在终端中运行以下命令

dotnet add [location of your test csproj file] reference [location of the csproj file for project to be tested]

NUnit

打开命令面板并选择 .NET:New Project..,然后选择 NUnit3 Test Project 并输入新项目的名称和位置。这将创建一个使用 NUnit 作为测试库的新项目和目录,并通过向项目文件添加以下 <PackageReference /> 元素来配置测试运行程序。

  • Microsoft.NET.Test.Sdk
  • nunit
  • NUnit3TestAdapter

在终端中运行以下命令

dotnet add [location of your test csproj file] reference [location of the csproj file for project to be tested]

MSTest

打开命令面板并选择 .NET:New Project..,然后选择 MSTest Test Project 并输入新项目的名称和位置。这将创建一个使用 MSTest 作为测试库的新项目和目录,并通过向项目文件添加以下 <PackageReference /> 元素来配置测试运行程序。

  • Microsoft.NET.Test.Sdk
  • MSTest.TestAdapter
  • MSTest.TestFramework
  • coverlet.collector

在终端中运行以下命令

dotnet add [location of your test csproj file] reference [location of the csproj file for project to be tested]

功能

运行/调试测试用例

编写完测试用例后,您需要对测试项目执行构建,以便它们被识别为测试。打开命令面板并选择 .NET: Build。这将构建您的项目。

C# Dev Kit 将在类和方法定义的左侧生成快捷方式(绿色播放按钮)。要运行目标测试用例,请选择绿色播放按钮。您也可以右键点击它以查看更多选项。

测试资源管理器

测试资源管理器(Test Explorer)是一个树状视图,用于显示工作区中的所有测试用例。您可以点击 Visual Studio Code 左侧活动栏上的烧杯图标来打开它。您也可以在此处运行/调试测试用例并查看测试结果。如果您尚未构建项目,请选择刷新测试按钮以执行构建并发现所有测试。

C# Dev Kit 中的代码覆盖率

C# Dev Kit 现在通过 VS Code 代码覆盖率 API 支持代码覆盖率。此功能允许您通过显示测试期间执行和未执行的代码行来衡量测试的有效性。

代码覆盖率是一个指标,用于跟踪自动化测试所执行的代码库百分比。它有助于识别未测试的代码段,并通过确保全面覆盖来提高测试质量。

注意:要启用代码覆盖率,请确保安装了最新版本的 C# Dev Kit。

要通过代码覆盖率运行测试,请按照以下步骤操作

    1. 从活动栏打开测试资源管理器。
    1. 选择并运行带有覆盖率的测试:选择要运行的测试,并以覆盖率模式执行它们。
    1. 查看覆盖率数据:代码覆盖率数据会自动生成,并与测试结果一起显示在测试资源管理器中。

如果您已经生成了覆盖率报告并想在 VS Code 中查看结果

    1. 使用命令面板:打开命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))并搜索 "Test: Show Coverage" 以访问覆盖率数据。
    1. 在编辑器中查看高亮显示的代码覆盖率
    • 绿色行:表示已测试的代码。
    • 红色行:表示未测试的代码。
    1. 测试资源管理器摘要:测试资源管理器提供总体覆盖率摘要,并允许您浏览需要额外测试的特定文件或方法。

提高代码的测试覆盖率

  • 检查覆盖率报告(在测试资源管理器或编辑器中)以识别标记为红色的区域,这些区域表示未测试的代码。
  • 创建新测试以覆盖报告中高亮显示的未测试区域。
  • 重新运行测试并查看更新后的覆盖率,以确保您的代码已得到充分测试。

查看测试结果

在运行/调试测试用例后,相关测试项的状态将在编辑器装饰和测试资源管理器中更新。

View test results

您可以点击堆栈跟踪中的链接导航到源代码位置。

VS Code 测试命令

可以通过在命令面板中搜索 Test: 来找到各种测试命令(例如 Run All Tests)(⇧⌘P (Windows, Linux Ctrl+Shift+P))。

Testing command in Command Palette

VS Code 测试设置

可以通过在设置编辑器中搜索 Testing 来找到特定于测试的 VS Code 设置(⌘, (Windows, Linux Ctrl+,))。

Testing settings

© . This site is unofficial and not affiliated with Microsoft.