此仓库已弃用 - 我们正在开发 GPT Pilot

Pythagora 致力于让自动化测试
🤖 完全自主 🤖

只需运行一条命令，即可观看 GPT-4 自动生成测试用例

以下内容用于生成单元测试。如需查看关于如何生成集成测试的文档，请点击这里。

Visual Studio Code 扩展

如果您想通过 Visual Studio Code 扩展试用 Pythagora，可以在此处下载。

🏃💨️ 快速入门

要安装 Pythagora，请运行：

npm i pythagora --save-dev

然后，添加您的 API 密钥，您就可以开始生成测试了。之后，只需在您的仓库根目录下运行以下命令：

npx pythagora --unit-tests --func <FUNCTION_NAME>

其中 <FUNCTION_NAME> 是您想要为其生成单元测试的函数名称。请确保该函数已从文件中导出。您可以在下方的“选项”部分查看更多选项，例如为多个文件或文件夹生成测试。

如果您希望扩展当前的测试套件以获得更好的代码覆盖率，可以运行：

npx pythagora --expand-unit-tests --path <PATH_TO_YOUR_TEST_SUITE>

有关扩展现有测试的更多详细信息，请参阅下方的“扩展现有测试”部分。

注意： 在 Windows 系统上，请务必使用 Git Bash 运行所有命令，而不是 PowerShell 或其他类似工具。

🎞 演示

以下是一些可以帮助您入门的演示视频。

Pythagora 单元测试演示（2 分钟）

🔎 示例

以下是一些我们分叉并使用 Pythagora 生成测试的开源仓库示例，方便您直观地了解其实际效果。

• Lodash

  • 📝 生成 1604 个测试用例
  • 🐞 发现 11 个缺陷（1 个边界条件和 10 个 bug）
  • ⏳️ 运行时长 4 小时

  

• node-fs-extra

  • 📝 生成 98 个测试用例
  • 🐞 发现 2 个缺陷
  • ⏳️ 运行时长 30 分钟

  

🔬 工作原理

当 Pythagora 生成单元测试时，它采用以下流程：

1. 找到您想要测试的函数
2. 查找该函数内部调用的所有其他函数

• 这一步通过 AST（抽象语法树）解析完成

3. 将您想要测试的函数及其相关函数发送到 Pythagora 服务器，由服务器利用 GPT-4 生成单元测试

• Pythagora 服务器也是开源的，可在此处找到
• 您可以在 Pythagora 服务器上的此文件夹中找到相关提示词

📈 扩展现有测试

如果您已经为代码库生成了测试，但只是想提高代码覆盖率或覆盖更多边界条件，只需运行：

npx pythagora --expand-unit-tests --path <PATH_TO_YOUR_TEST_SUITE>

运行此命令时，PATH_TO_YOUR_TEST_SUITE 可以是单个测试文件的路径，也可以是文件夹的路径，文件夹内的所有测试文件都将被处理并扩展。

就这样，尽情享受您提升后的代码覆盖率吧！

📖 选项

• 要为单个函数生成单元测试，请运行：

  npx pythagora --unit-tests --func <FUNCTION_NAME>
  

• 要为特定文件中的单个函数生成单元测试，请运行：

  npx pythagora --unit-tests --func <FUNCTION_NAME> --path ./path/to/file.js
  

• 要为文件中的所有函数生成单元测试，请运行：

  npx pythagora --unit-tests --path ./path/to/file.js
  

• 要为文件夹中所有文件中的所有函数生成单元测试，请运行：

  npx pythagora --unit-tests --path ./path/to/folder/
  

⚙️ 配置

Pythagora 使用 GPT-4 生成测试，因此您需要拥有 OpenAI API 密钥或 Pythagora API 密钥。您可以在此处获取 Pythagora API 密钥，或在此处获取 OpenAI API 密钥。获取密钥后，可通过以下命令将其添加到 Pythagora 中：

npx pythagora --config --pythagora-api-key <API_KEY>

或者

npx pythagora --config --openai-api-key <API_KEY>

▶️ 如何运行单元测试

要运行生成的测试，您可以简单地执行：

npx jest ./pythagora_tests/

或者，如果要运行特定文件或文件夹中的测试，可以执行 npx jest <PATH_TO_FILE_OR_FOLDER>。目前，Pythagora 仅支持生成 Jest 测试，但如果您希望它能够生成其他框架的测试，请通过 hi@pythagora.ai 告知我们。

📌️ 注意事项

• Pythagora 生成的最佳单元测试是那些独立的函数（例如工具函数）。基本上，这些就是真正可以进行单元测试的代码部分。比如，请查看这个 Pythagora 文件——它包含了一些非常适合编写单元测试的工具函数。当我们运行 npx pythagora --unit-tests --path ./src/utils/common.js 时，它生成了 145 个测试，其中只有 17 个失败。令人惊喜的是，这 17 个失败中，只有 6 个是因为测试本身写得不正确，而另外 11 个则真正发现了代码中的 bug。你可以在这里查看这些测试 这里。

• 我们不会在服务器上存储你的任何代码。然而，代码会被发送到 GPT 和 OpenAI。以下是他们的 隐私政策。

• 你想要为其生成测试的函数需要从文件中导出。例如，如果你有一个这样的文件：

  function mongoObjToJson(originalObj) {
      ...
  }
  
  module.exports = {
      mongoObjToJson
  };
  

  那么，要为 mongoObjToJson 函数生成单元测试，你可以运行：

  npx pythagora --unit-tests --func mongoObjToJson
  

🤔️ 常见问题解答

• 这些测试有多准确？
  • Pythagora 生成的最佳单元测试是那些独立的函数。基本上，这些就是真正可以进行单元测试的代码部分。比如，请查看这个 Pythagora 文件——它包含了一些非常适合编写单元测试的工具函数。当我们运行 npx pythagora --unit-tests --path ./src/utils/common.js 时，它生成了 145 个测试，其中只有 17 个失败。令人惊喜的是，这 17 个失败中，只有 6 个是因为测试本身写得不正确，而另外 11 个则真正发现了代码中的 bug。你可以在这里查看这些测试 这里。
  • 在测试 Pythagora 的过程中，我们有以下几点观察：
    1. 它非常擅长测试边界情况。对于我们为许多仓库创建的测试，这些测试通过测试边界情况立即发现了 bug。
    2. 它最适合测试独立的工具函数。例如，我们尝试为 Lodash 仓库生成测试，结果生成了 1000 个测试，其中只有 40 个需要进一步审查。对于其他非独立的函数，我们计划结合集成测试的记录来生成合适的模拟对象，这样应该可以扩展 Pythagora 的测试范围。
    3. 它当然并不完美，但生成的测试让我很想保留并提交它们。因此，我鼓励你亲自试一试，看看它对你是否有效。如果你这么做了，请通过 电子邮件 或 Discord 告诉我们。我们非常期待听到你的使用体验。

• 我是否应该审查生成的测试？
  • 当然应该。如上所述，有些测试可能写得不正确，因此在提交之前最好先检查所有测试。尽管如此，我认为这会为你节省大量时间，并帮助你以不同的方式思考代码。

• 测试能帮助我思考代码——我不想自动生成它们
  • 这正是 Pythagora 最好的地方——它确实能帮助你思考代码。只不过你不需要花时间去编写测试而已。这一点对我们自己也适用：我们在开发 Pythagora 时，尽可能快速地编码，但在加入单元测试生成功能后，我们意识到有些函数无法生成测试。于是我们重构了代码，使其更加模块化，以便能够生成单元测试。

• Pythagora 是否仅限于特定的编程语言或框架？
  • Pythagora 主要为 JavaScript 代码生成单元测试。不过，它设计用于处理用 JavaScript、TypeScript 及类似语言编写的代码。如果你想看到对其他语言或框架的支持，请告知我们：hi@pythagora.ai。

• Pythagora 是否也能生成集成测试？
  • 目前，Pythagora 主要专注于生成单元测试。如果要生成集成测试，你可能需要结合集成测试的记录来生成合适的模拟对象。我们正在积极探索在未来扩展其功能的方法。

• Pythagora 是否兼容所有 JavaScript 测试框架？
  • 目前，Pythagora 使用 Jest 测试框架生成测试。虽然我们愿意扩展对其他测试框架的兼容性，但 Jest 是目前主要支持的框架。如果你有特定的框架需求，请随时向我们提出建议。

• Pythagora 如何处理敏感或专有代码？
  • Pythagora 不会在其服务器上存储你的代码，但它会将代码发送给 GPT 和 OpenAI 来生成测试。在将生成的测试提交到你的代码库之前，务必仔细审查，尤其是当你的代码包含敏感或专有信息时。使用 Pythagora 处理敏感代码时请务必谨慎。

• Pythagora 是否适用于所有类型的项目？
  • Pythagora 最适合用于代码结构良好且包含独立函数（如工具函数）的项目。它在为这类代码生成测试方面表现出色。对于更复杂或非独立的函数，可能需要手动审查和修改。

🏁 Alpha 版本

这是 Pythagora 的 Alpha 版本。若想获取关于 Beta 版发布的更新，或就你希望 Pythagora 支持的 技术栈（框架/数据库）提出建议，你可以 👉 在此添加你的邮箱/留言 👈 。

🔗 联系我们

💬 加入我们的 Discord 服务器参与讨论。

📨 通过 在此添加你的邮箱获取新功能和 Beta 版发布的最新消息。

🌟 作为一款开源工具，如果你能为 Pythagora 仓库点个赞，对我们来说将是莫大的鼓励 🌟

Pythagora 快速上手指南

Pythagora 是一个利用 GPT-4 自动生成 JavaScript/TypeScript 单元测试的开源工具，旨在让测试编写完全自动化。

注意：本项目（pythagora）目前已标记为弃用（deprecated），官方正在开发新一代工具 GPT Pilot。本文档仅针对当前仓库版本的使用说明。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：
  • Linux / macOS：任意终端即可。
  • Windows 用户：必须使用 Git Bash 运行命令，请勿使用 PowerShell 或 CMD，否则可能导致命令执行失败。
• 前置依赖：
  • 已安装 Node.js 和 npm。
  • 拥有 OpenAI API Key 或 Pythagora API Key。
• 代码要求：
  • 目标函数必须从文件中显式导出（例如使用 module.exports 或 export）。
  • 目前主要支持生成 Jest 框架的测试用例。

安装步骤

1. 在项目根目录下，通过 npm 安装 Pythagora 作为开发依赖：

   npm i pythagora --save-dev
   

2. 配置 API 密钥。您可以选择使用 OpenAI 密钥或 Pythagora 密钥（二选一）：

   使用 OpenAI API Key:

   npx pythagora --config --openai-api-key <YOUR_OPENAI_API_KEY>
   

   或使用 Pythagora API Key:

   npx pythagora --config --pythagora-api-key <YOUR_PYTHAGORA_API_KEY>
   

基本使用

配置完成后，即可开始生成单元测试。

1. 为指定函数生成测试

这是最常用的场景。假设您有一个名为 calculateSum 的导出函数，运行以下命令：

npx pythagora --unit-tests --func calculateSum

如果需要指定文件路径：

npx pythagora --unit-tests --func calculateSum --path ./src/utils/math.js

2. 为整个文件或文件夹生成测试

若想为某个文件中的所有导出函数，或某个文件夹下的所有文件生成测试：

针对单个文件：

npx pythagora --unit-tests --path ./src/utils/common.js

针对整个文件夹：

npx pythagora --unit-tests --path ./src/utils/

3. 扩展现有测试

如果您已有测试套件，希望增加覆盖率或补充边界情况测试：

npx pythagora --expand-unit-tests --path ./tests/

4. 运行生成的测试

Pythagora 默认生成 Jest 测试文件，通常位于 ./pythagora_tests/ 目录。运行测试的命令如下：

npx jest ./pythagora_tests/

---

提示：生成的测试代码建议先进行人工审查后再提交到代码库，以确保逻辑准确并处理潜在的敏感信息。