在 VS Code 中试用

测试

Visual Studio Code 为您的代码测试提供了丰富的功能集。您可以自动发现项目中的测试、运行和调试测试,并获取测试覆盖率结果。VS Code 中的 GitHub Copilot 可以帮助您设置项目的测试框架,并帮助您生成测试代码和修复失败的测试。

在本文中,您将学习如何在 VS Code 中开始测试,查找流行的测试扩展,并探索测试功能。您还将了解 VS Code 中的 Copilot 如何帮助您更快地编写测试,以及帮助您修复失败的测试。

提示

如果您还没有 Copilot 订阅,可以通过注册 Copilot 免费计划 免费使用 Copilot。您将获得每月完成次数和聊天交互的限制。

关于 VS Code 中的测试

VS Code 中的测试支持是特定于语言的,并取决于您安装的测试扩展。语言扩展或独立扩展可以为特定语言或测试框架实现测试功能。

VS Code 具有以下代码测试功能:

  • 支持多种测试框架:语言扩展和独立测试扩展支持各种语言和测试运行器,例如 Jest、Mocha、Pytest、JUnit 等。

  • 集中式测试管理测试资源管理器提供了一个集中位置来管理和运行项目中的测试。测试资源管理器可能会根据测试扩展自动发现项目中的测试。

  • 集成测试结果:在编辑器中与测试代码并行查看测试状态,或在测试资源管理器中查看所有测试。详细的测试结果可在“测试结果”面板中查看。

  • 调试调试您的测试以诊断测试失败。利用 VS Code 中丰富的调试支持,例如断点、监视变量等。

  • 测试覆盖率运行覆盖率测试以查看您的代码有多少被测试覆盖。

  • AI 辅助测试:在 VS Code 中使用 GitHub Copilot 帮助您设置测试框架、生成测试代码和修复失败的测试。

  • 任务集成:通过创建任务来运行测试,使您的测试工作更轻松。您还可以在更改代码时在后台运行测试。

在 VS Code 中开始测试

要在 VS Code 中开始测试,请按照以下步骤操作:

  1. 打开“扩展”视图并为您的项目安装测试扩展。按“测试”类别 (@category:"testing") 筛选扩展。

  2. 选择活动栏中的烧杯图标 () 以打开“测试资源管理器”并发现项目中的测试。

  3. 从“测试资源管理器”或直接从编辑器运行和调试测试。

测试扩展

您可以通过查看 Visual Studio Marketplace 找到支持测试的扩展。您还可以转到“扩展”视图 (⇧⌘X (Windows、Linux Ctrl+Shift+X)),并按“测试”类别进行筛选。

提示

Copilot 可以帮助设置测试框架并推荐相关的测试扩展。打开“聊天”视图 (⌃⌘I (Windows、Linux Ctrl+Alt+I)),输入 /setupTests 命令,Copilot 将引导您完成项目配置过程。

测试视图中的自动测试发现

“测试”视图提供了一个集中位置来管理和运行您的测试。您可以通过选择活动栏中的烧杯图标 () 来进入“测试”视图。您还可以使用命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 中的“测试: 聚焦测试资源管理器视图”命令。

如果您的项目包含测试,“测试资源管理器”视图将发现并列出工作区中的测试。默认情况下,发现的测试以树状视图显示在“测试资源管理器”中。树状视图与测试的层次结构匹配,使您能够轻松导航和运行测试。

Screenshot that shows VS Code with the Test Explorer showing the tests, matching the test code that is shown in the editor.

您可以从“测试资源管理器”中选择播放按钮来运行测试。在运行和调试测试部分了解有关运行和调试测试的更多信息。

提示

通过双击“测试资源管理器”视图中的测试来导航到测试代码。如果选择失败的测试,编辑器将打开测试文件,突出显示失败的测试,并显示错误消息。

如果测试数量很多,可以使用筛选选项快速找到感兴趣的测试。您可以使用“筛选”按钮按状态筛选测试或仅显示当前文件的测试。您还可以使用搜索框按名称搜索特定测试,或使用 @ 符号按状态搜索。

Test Explorer view with filtering options

在“更多操作”菜单中,您可以访问更多功能,例如排序和显示选项。

如果添加新测试或更改现有测试,请使用“刷新测试”按钮刷新“测试资源管理器”中的测试列表。您还可以使用命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 中的“测试资源管理器: 重新加载测试”命令。

注意

根据测试扩展的不同,您可能首先需要配置测试框架或测试运行器来发现项目中的测试。有关更多信息,请查阅测试扩展的文档。您可以使用 Copilot 聊天视图中的 setupTests 命令来获取有关为项目设置测试框架的帮助。

使用 AI 编写测试

编写测试可能很耗时,而且通常被忽视。Copilot 可以通过为您的应用程序创建测试代码来加快编写测试的过程。您可以使用它来编写单元测试、集成测试、端到端测试等。

要在 VS Code 中使用 Copilot 编写测试,您可以使用以下任一方法:

  • 编辑器智能操作

    1. (可选)选择一段应用程序代码

    2. 在编辑器中右键单击,然后选择“Copilot”>“生成测试

  • 聊天提示

    1. 打开要生成测试的应用程序代码文件

    2. 打开 Copilot 编辑 ()、聊天视图 (⌃⌘I (Windows、Linux Ctrl+Alt+I)),或编辑器内联聊天 (⌘I (Windows、Linux Ctrl+I))

    3. 输入一个提示来生成测试,例如为此代码生成测试。同时包括边缘情况的测试。

      通过在提示中输入 #file 为您的提示添加额外上下文。例如,为此代码生成测试 #file:calculator.js

      提示

      在 GitHub Copilot 文档中获取更多生成单元测试模拟对象端到端测试的示例提示。

Copilot 将为您的应用程序代码生成测试用例代码。如果您已有测试文件,Copilot 将在那里添加测试,或者在需要时创建新文件。您可以通过向 Copilot 提供更多提示来进一步自定义生成的测试。例如,您可以要求 Copilot 使用另一个测试框架。

提示

您可以向 Copilot 提供您自己的生成代码的特殊说明。例如,您可以告诉 Copilot 使用特定的测试框架、命名约定或代码结构。

了解有关在 VS Code 中使用 Copilot 的更多信息。

运行和调试测试

发现项目中的测试后,您可以运行和调试测试,并直接在 VS Code 中查看测试结果。

在“测试资源管理器”中,使用部分标题中的控件来运行或调试所有测试。您还可以通过选择特定节点上的运行/调试图标来运行或调试树状视图中的特定测试。

Run and debug tests in Test Explorer

在编辑器中查看测试代码时,使用编辑器边栏中的播放控件在该位置运行测试。

Run and debug tests in editor gutter

右键单击边栏控件以查看其他操作,例如调试测试。

提示

使用 testing.defaultGutterClickAction 设置来配置边栏控件的默认测试操作。

运行一个或多个测试后,编辑器边栏和“测试资源管理器”中的树状视图会显示相应的测试状态(通过/失败)。当测试失败时,请注意测试错误消息会以覆盖层形式显示在编辑器中。

Screenshot that shows a test error message overlay in the editor.

使用“测试资源管理器”中的“显示输出”按钮在“测试结果”面板中查看测试输出。

Test Results panel

提示

Copilot 可以帮助您修复失败的测试。在“测试资源管理器”中,将鼠标悬停在树状视图上,然后选择“修复测试失败”按钮 (星光),Copilot 将为失败的测试提供修复建议。或者,在 Copilot 聊天中输入 /fixTestFailure 命令。

Screenshot showing the Test Explorer, highlighting the "Fix Test Failure" button, and the editor that shows a suggestion from Copilot on how to fix the failing test.

测试覆盖率

测试覆盖率衡量您的代码有多少被测试覆盖。它有助于您识别代码中未被测试的区域。如果相应的测试扩展支持测试覆盖率,VS Code 支持运行覆盖率测试并查看覆盖率结果。

您可以运行覆盖率测试,就像运行和调试测试一样。在“测试资源管理器”视图、编辑器边栏或命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 中使用相应的操作。

Run tests with coverage

运行覆盖率测试后,您可以在不同位置查看覆盖率结果:

  • 在“测试覆盖率”视图中

    树状视图显示测试及其覆盖率百分比。颜色指示器也提供了覆盖率百分比的视觉提示。将鼠标悬停在每行上可查看有关覆盖率结果的更多详细信息。

    Test Coverage view

  • 作为编辑器中的覆盖层

    对于具有测试覆盖率的代码文件,编辑器会在边栏中显示颜色覆盖层,以指示哪些行被测试覆盖或未被覆盖。当您将鼠标悬停在边栏上时,请注意对于已覆盖的行,还会有一个指示器显示该行执行的次数。您还可以选择编辑器标题栏中的“显示内联覆盖率”按钮,或使用“测试: 显示内联覆盖率”命令 (⌘; ⇧⌘I (Windows、Linux Ctrl+; Ctrl+Shift+I)) 来切换覆盖层。

    View coverage in editor

  • 在“资源管理器”视图中,它显示代码文件的覆盖率百分比

    “资源管理器”视图显示代码文件的覆盖率百分比。将鼠标悬停在“资源管理器”中的文件或节点上可查看有关覆盖率结果的更多详细信息。

    View coverage in Explorer view

  • 在差异编辑器中

    如果您打开了差异编辑器,覆盖率结果也会显示在差异编辑器中,类似于它们在编辑器中的显示方式。

任务集成

VS Code 中的任务可以配置为在 VS Code 中运行脚本和启动进程,而无需输入命令行或编写新代码。在 VS Code 中,您可以定义一个默认测试任务来运行测试,并可以选择创建键盘快捷方式来运行测试。

使用命令“任务: 配置默认测试任务”来配置默认测试任务。VS Code 会尝试自动检测测试任务,例如根据您的 package.json 文件。选择默认测试任务后,tasks.json 文件将打开供您自定义任务。

以下代码片段显示了一个 tasks.json 文件,该文件将 node --test 命令指定为默认测试任务。

{
  "version": "2.0.0",
  "tasks": [
    {
      "type": "npm",
      "script": "test",
      "group": {
        "kind": "test",
        "isDefault": true
      },
      "problemMatcher": [],
      "label": "npm: test",
      "detail": "node --test src/tests/**.js"
    }
  ]
}

要运行测试任务,请使用命令“任务: 运行测试任务”或为该命令创建键盘快捷方式

了解有关使用和配置任务的更多信息。

注意

目前,任务没有特殊集成到 VS Code 的测试功能中,因此在任务中运行测试不会更新用户界面。各个测试扩展可以提供集成到 UI 中的特定测试自动化功能。

测试配置设置

您可以配置多个设置来自定义 VS Code 中的测试体验。每个语言扩展都可能提供特定于该语言测试的附加设置。以下是一些您可以配置的常见设置:

设置 ID 详细信息
testing.countBadge 控制活动栏上“测试”图标上的计数徽章
testing.gutterEnabled 配置是否在编辑器边栏中显示测试控件
testing.defaultGutterClickAction 配置选择边栏测试控件时的默认操作
testing.coverageBarThresholds 配置“测试覆盖率”视图中覆盖率条阈值的颜色
testing.displayedCoveragePercent 配置在“测试覆盖率”视图中显示哪个百分比值(总计、语句或最小值)
testing.showCoverageInExplorer 配置是否在“资源管理器”视图中显示覆盖率百分比

您可以在“设置”编辑器 (⌘, (Windows、Linux Ctrl+,)) 中找到所有与测试相关的设置。

后续步骤