测试
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 等)提供支持。
-
集中化测试管理:测试资源管理器提供了一个集中的位置来管理和运行项目中的测试。根据测试扩展的不同,测试资源管理器可能会自动发现你项目中的测试。
-
集成的测试结果:在编辑器中与测试代码并排查看测试状态,或在测试资源管理器中查看所有测试。详细的测试结果可在“测试结果”面板中查看。
-
测试覆盖率:运行带覆盖率的测试,以查看你的代码有多少被测试所覆盖。
-
AI 辅助测试:在 VS Code 中使用 GitHub Copilot 协助你设置测试框架、生成测试代码和修复失败的测试。
-
任务集成:通过创建任务来运行你的测试,使你的测试工作更轻松。你还可以在更改代码时在后台运行测试。
开始在 VS Code 中进行测试
要在 VS Code 中开始测试,请按照以下步骤操作:
-
打开“扩展”视图并为你的项目安装一个测试扩展。按测试 (Testing) 类别 (@category:"testing") 筛选扩展。
-
在活动栏中选择烧杯图标 () 以打开测试资源管理器并发现项目中的测试。
-
从测试资源管理器或直接从编辑器中运行和调试你的测试。
用于测试的扩展
你可以在 Visual Studio Marketplace 中查找支持测试的扩展。你也可以转到“扩展”视图 (⇧⌘X (Windows、Linux Ctrl+Shift+X)),并按测试 (Testing) 类别进行筛选。
Copilot 可以协助设置测试框架并建议相关的测试扩展。打开“聊天”视图 (⌃⌘I (Windows、Linux Ctrl+Alt+I)),输入 /setupTests
命令,Copilot 将引导你完成配置项目的过程。
在测试视图中自动发现测试
“测试”视图提供了一个集中的位置来管理和运行你的测试。你可以通过选择活动栏中的烧杯图标 () 来进入“测试”视图。你也可以在命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 中使用 Testing: Focus on Test Explorer View (测试: 聚焦于测试资源管理器视图) 命令。
如果你有一个包含测试的项目,“测试资源管理器”视图会发现并列出工作区中的测试。默认情况下,发现的测试会在测试资源管理器中以树状视图显示。树状视图与测试的层次结构相匹配,使导航和运行测试变得容易。
你可以通过选择播放按钮从测试资源管理器中运行测试。在运行和调试测试部分了解更多关于运行和调试测试的信息。
双击“测试资源管理器”视图中的测试,可以导航到测试代码。如果你选择一个失败的测试,编辑器会打开测试文件,高亮显示失败的测试,并显示错误信息。
如果你有很多测试,可以使用筛选选项快速找到你感兴趣的测试。你可以使用筛选 (Filter) 按钮按状态筛选测试,或只显示当前文件的测试。你也可以使用搜索框按名称搜索特定测试,或使用 @
符号按状态搜索。
在更多操作 (More Actions) 菜单中,你可以访问更多功能,如排序和显示选项。
如果你添加了新测试或更改了测试,请使用刷新测试 (Refresh Tests) 按钮来刷新测试资源管理器中的测试列表。你也可以在命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 中使用 Test Explorer: Reload tests (测试资源管理器: 重新加载测试) 命令。
根据测试扩展的不同,你可能首先需要配置测试框架或测试运行器才能发现项目中的测试。有关更多信息,请查阅测试扩展的文档。你可以在 Copilot 聊天视图中使用 setupTests
命令来获取有关为你的项目设置测试框架的帮助。
使用 AI 编写测试
编写测试可能很耗时,而且常常被忽略。Copilot 可以通过为你的应用程序创建测试代码来加快编写测试的过程。你可以用它来编写单元测试、集成测试、端到端测试等等。
要在 VS Code 中使用 Copilot 编写测试,你可以使用以下任一方法:
-
编辑器智能操作
-
(可选)选择一段应用程序代码
-
在编辑器中右键单击,然后选择 Copilot > 生成测试 (Generate Tests)
-
-
聊天提示
-
打开你想要为其生成测试的应用程序代码文件
-
打开 Copilot 编辑 ()、聊天视图 (⌃⌘I (Windows、Linux Ctrl+Alt+I)) 或编辑器内联聊天 (⌘I (Windows、Linux Ctrl+I))
-
输入一个生成测试的提示,例如“为这段代码生成测试。也包括边缘情况的测试。”
通过在提示中输入
#file
来为你的提示添加额外的上下文。例如,“为这段代码 #file:calculator.js 生成测试”
-
Copilot 将为你的应用程序代码生成测试用例代码。如果你已经有一个测试文件,Copilot 会将测试添加到那里,或者在需要时创建一个新文件。你可以通过向 Copilot 提供更多提示来进一步自定义生成的测试。例如,你可以要求 Copilot 使用另一个测试框架。
你可以给 Copilot 你自己的用于生成代码的特殊指令。例如,你可以告诉 Copilot 使用特定的测试框架、命名约定或代码结构。
了解更多关于在 VS Code 中使用 Copilot 的信息。
运行和调试测试
在发现项目中的测试后,你可以直接在 VS Code 中运行和调试你的测试,并查看测试结果。
在测试资源管理器中,使用区域标题中的控件来运行或调试所有测试。你也可以通过选择特定节点上的运行/调试图标来运行或调试树状视图中的特定测试。
当你在编辑器中查看测试代码时,使用编辑器边栏中的播放控件来运行该位置的测试。
右键单击边栏控件以查看其他操作,例如调试测试。
通过使用 testing.defaultGutterClickAction 设置来配置边栏控件的默认测试操作。
在你运行一个或多个测试后,编辑器边栏和测试资源管理器中的树状视图会显示相应的测试状态(通过/失败)。当一个测试失败时,请注意测试错误信息会作为浮层显示在编辑器中。
使用测试资源管理器中的显示输出 (Show Output) 按钮,在测试结果 (Test Results) 面板中查看测试输出。
Copilot 可以帮助你修复失败的测试。在测试资源管理器中,将鼠标悬停在树状视图上,然后选择修复测试失败 (Fix Test Failure) 按钮 (火花),Copilot 将为失败的测试建议一个修复方案。或者,在 Copilot 聊天中输入 /fixTestFailure
命令。
测试覆盖率
测试覆盖率是衡量你的代码有多少被测试所覆盖的指标。它帮助你识别代码中未被测试的区域。如果相应的测试扩展支持测试覆盖率,VS Code 支持运行带覆盖率的测试并查看覆盖率结果。
你可以运行带覆盖率的测试,就像你可以运行和调试测试一样。在测试资源管理器视图、编辑器边栏或命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 中使用相应的操作。
在你运行带覆盖率的测试后,你可以在不同位置查看覆盖率结果:
-
在“测试覆盖率”视图中
一个树状视图显示了测试及其覆盖率百分比。颜色指示器也提供了关于覆盖率百分比的视觉提示。将鼠标悬停在每一行上以查看有关覆盖率结果的更多详细信息。
-
作为编辑器中的浮层
对于具有测试覆盖率的代码文件,编辑器会在边栏中显示一个颜色浮层,以指示哪些行被测试覆盖或未被覆盖。当你将鼠标悬停在边栏上时,你会注意到对于被覆盖的行,还有一个指示器显示该行被执行的次数。你也可以选择编辑器标题栏中的显示内联覆盖率 (Show Inline Coverage) 按钮或使用 Test: Show Inline Coverage (测试: 显示内联覆盖率) 命令 (⌘; ⇧⌘I (Windows、Linux Ctrl+; Ctrl+Shift+I)) 来切换覆盖率浮层。
-
在“资源管理器”视图中,它显示你代码文件的覆盖率百分比
“资源管理器”视图显示你代码文件的覆盖率百分比。将鼠标悬停在资源管理器中的文件或节点上,可以查看有关覆盖率结果的更多详细信息。
-
在差异编辑器中
如果你打开了差异编辑器,覆盖率结果也会显示在差异编辑器中,类似于它们在编辑器中的显示方式。
任务集成
VS Code 中的任务可以配置为在 VS Code 内部运行脚本和启动进程,而无需输入命令行或编写新代码。在 VS Code 中,你可以定义一个运行测试的默认测试任务,并可选地创建运行测试的键盘快捷键。
使用 Tasks: Configure Default Test Task (任务: 配置默认测试任务) 命令来配置默认测试任务。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"
}
]
}
要运行测试任务,请使用 Tasks: Run Test Task (任务: 运行测试任务) 命令或为该命令创建一个键盘快捷键。
了解更多关于使用和配置任务的信息。
目前,任务与 VS Code 的测试功能没有特殊的集成,因此在任务中运行测试不会更新用户界面。个别的测试扩展可以提供与 UI 集成的特定测试自动化功能。
测试配置设置
你可以配置多个设置来自定义 VS Code 中的测试体验。每个语言扩展可能提供特定于该语言测试的额外设置。以下是一些你可以配置的常用设置:
设置 ID | 详细信息 |
---|---|
testing.countBadge | 控制活动栏上“测试”图标的计数徽章 |
testing.gutterEnabled | 配置是否在编辑器边栏中显示测试控件 |
testing.defaultGutterClickAction | 配置选择边栏测试控件时的默认操作 |
testing.coverageBarThresholds | 为“测试覆盖率”视图配置覆盖率条阈值的颜色 |
testing.displayedCoveragePercent | 配置在“测试覆盖率”视图中显示的百分比值(总计、语句或最小) |
testing.showCoverageInExplorer | 配置是否在“资源管理器”视图中显示覆盖率百分比 |
你可以在设置编辑器 (⌘, (Windows、Linux Ctrl+,)) 中找到所有与测试相关的设置。
后续步骤
-
了解更多关于 Copilot 和 VS Code 中的 AI 辅助测试
-
了解更多关于使用和配置任务的信息