尝试以扩展 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+,))中找到所有与测试相关的设置。

后续步骤