使用 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 可以通过生成覆盖您代码库的测试代码来帮助您为应用程序代码编写测试。这包括单元测试、端到端测试以及针对边缘情况的测试。
使用聊天提示
-
打开您的应用程序代码文件。
-
打开以下任一视图
- 聊天视图 (⌃⌘I (Windows, Linux Ctrl+Alt+I))
- 行内聊天 (⌘I (Windows, Linux Ctrl+I))
-
输入类似以下的提示
- “为这段代码生成测试”
- “编写包括边缘情况的单元测试”
- “为这个模块创建集成测试”
在 GitHub 文档中获取更多关于使用 GitHub Copilot 编写测试的指导。
使用编辑器智能操作
要为您的应用程序代码生成测试而无需编写提示，您可以使用编辑器智能操作。
-
打开您的应用程序代码文件。
-
（可选）选择您想要测试的代码。
-
右键单击并选择 生成代码 > 生成测试。
Copilot 会在现有的测试文件中生成测试代码，如果不存在测试文件，则会创建一个新的测试文件。
-
（可选）通过在行内聊天提示中提供额外的上下文来优化生成的测试。
修复失败的测试
Copilot 与 VS Code 中的测试资源管理器集成，可以帮助修复失败的测试。
- 在测试资源管理器中，将鼠标悬停在失败的测试上
- 选择 修复测试失败 按钮（星火图标）
- 审查并应用 Copilot 建议的修复
或者，您也可以
- 打开聊天视图
- 输入
/fixTestFailure命令 - 按照 Copilot 的建议修复测试
代理模式在运行测试时会监控测试输出，并自动尝试修复和重新运行失败的测试。
个性化测试生成
如果您的组织有特定的测试要求，您可以自定义 Copilot 生成测试的方式，以确保它们符合您的标准。您可以通过提供自定义指令来个性化 Copilot 生成测试的方式。例如
- 指定首选的测试框架
- 定义测试的命名约定
- 设置代码结构偏好
- 请求特定的测试模式或方法
获取更多关于个性化 Copilot 以生成测试的信息。
关于更好生成测试的技巧
要在使用 Copilot 生成测试时获得最佳结果，请遵循以下技巧
- 在提示中提供关于您首选测试框架的上下文
- 指明您是否需要特定类型的测试（单元、集成、端到端）
- 要求特定的测试用例或边缘情况
- 请求遵循您项目编码标准的测试
后续步骤
- 了解更多关于VS Code 中的 Copilot。
- 探索VS Code 中的通用测试功能。
- 查看用于生成单元测试的示例提示