使用 GitHub Copilot 进行测试
编写和维护测试是软件开发中至关重要但通常耗时的部分。GitHub Copilot 通过帮助您在 Visual Studio Code 中更高效地编写、调试和修复测试,从而简化此过程。本文向您展示如何利用 Copilot 的测试功能来改进您的测试工作流程并提高项目中的测试覆盖率。
Copilot 可以帮助完成以下测试任务
- 设置测试框架:获取关于为您的项目和语言配置正确的测试框架和 VS Code 扩展的帮助。
- 生成测试代码:创建单元测试、集成测试和端到端测试,以覆盖您的应用程序代码。
- 处理边缘情况:生成全面的测试套件,以覆盖边缘情况和错误条件。
- 修复失败的测试:接收有关修复测试失败的建议。
- 保持一致性:个性化 Copilot 以生成符合您项目编码实践的测试。
如果您还没有 Copilot 订阅,您可以注册 Copilot Free 计划,每月获得有限数量的补全和 Chat 交互,从而免费使用 Copilot。
设置测试框架
为了加速您的测试工作流程,Copilot 可以帮助设置您项目的测试框架和 VS Code 扩展。Copilot 会根据您的项目类型建议合适的测试框架。
- 打开 Chat 视图 (⌃⌘I (Windows, Linux Ctrl+Alt+I))。
- 在 Chat 输入字段中输入
/setupTests
命令。 - 按照 Copilot 的指导配置您的项目。
使用 Copilot 编写测试
Copilot 可以通过生成覆盖您代码库的测试代码来帮助您为应用程序代码编写测试。这包括单元测试、端到端测试和边缘情况测试。
使用 Chat 提示
-
打开您的应用程序代码文件。
-
打开以下视图之一
- Copilot 编辑 (⇧⌘I (Windows Ctrl+Shift+I, Linux Ctrl+Shift+Alt+I))
- Chat 视图 (⌃⌘I (Windows, Linux Ctrl+Alt+I))
- Inline Chat (⌘I (Windows, Linux Ctrl+I))
-
输入如下提示
- “为此代码生成测试”
- “编写包含边缘情况的单元测试”
- “为此模块创建集成测试”
在 GitHub 文档中获取关于使用 GitHub Copilot 编写测试的更多指导。
使用编辑器智能操作
要在不编写提示的情况下为您的应用程序代码生成测试,您可以使用编辑器智能操作。
-
打开您的应用程序代码文件。
-
(可选)选择您要测试的代码。
-
右键单击并选择 Copilot > 生成测试。
Copilot 在现有测试文件中生成测试代码,如果不存在测试文件,则创建一个新的测试文件。
-
(可选)通过在 Inline Chat 提示中提供额外的上下文来优化生成的测试。
修复失败的测试
Copilot 与 VS Code 中的 Test Explorer 集成,可以帮助修复失败的测试。
- 在 Test Explorer 中,将鼠标悬停在失败的测试上
- 选择 修复测试失败 按钮(闪光图标)
- 查看并应用 Copilot 建议的修复
或者,您可以
- 打开 Chat 视图
- 输入
/fixTestFailure
命令 - 按照 Copilot 的建议修复测试
Copilot 编辑代理模式(预览版)在运行测试时监视测试输出,并自动尝试修复和重新运行失败的测试。
个性化测试生成
如果您的组织有特定的测试要求,您可以自定义 Copilot 生成测试的方式,以确保它们符合您的标准。您可以通过提供自定义指令来个性化 Copilot 生成测试的方式。例如
- 指定首选的测试框架
- 定义测试的命名约定
- 设置代码结构偏好
- 请求特定的测试模式或方法
获取关于个性化 Copilot 以生成测试的更多信息。
改进测试生成的技巧
为了在使用 Copilot 生成测试时获得最佳结果,请遵循以下提示
- 在您的提示中提供关于您首选的测试框架的上下文
- 指定您是否需要特定类型的测试(单元测试、集成测试、端到端测试)
- 询问特定的测试用例或边缘情况
- 请求符合您项目编码标准的测试
后续步骤
- 了解更多关于 VS Code 中的 Copilot。
- 探索 VS Code 中的通用测试功能。
- 查看 生成单元测试的示例提示