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