Test Gru

🚀 忘掉单元测试

忘掉单元测试相关的烦恼吧。

🚀 快速开始

准备步骤

1. 访问 Gru.ai。
2. 选择仓库。
3. 启用自动触发设置。

自动触发

• 当提交 PR 时，会自动添加单元测试。
• Gru 会添加单元测试代码，若能正常运行，会向原 PR 提交一个附带测试代码的 PR。

手动触发

1. 访问 Gru.ai。
2. 选择「手动触发」。
3. 选择所需文件并执行触发操作。

📦 配置文件 grutest.yaml

# 忽略的模拟库配置
mockIgnore: ["lodash", "ajv"]

测试代码的放置策略

集中式

说明

集中式中，测试代码会放置在专用目录中。

示例

目录结构：

.
├── package.json
├── src
│   └── sum.ts
└── test
    └── sum.test.ts

grutest.yaml 配置：

testPlacementStrategies:
  - type: centralized
     testDir: test
     testFilePattern: "{{sourceFileName}}.test.ts"

同目录式

说明

同目录式中，测试代码会和源代码放置在同一目录中。

示例

目录结构：

.
├── package.json
└── src
    ├── sum.test.ts
    └── sum.ts

grutest.yaml 配置：

testPlacementStrategies:
    - type: co-located
      testFilePattern: "{{sourceFileName}}.test.ts"

🔧 触发方式

PR 自动触发

• 提交 PR 时，Gru 会自动添加单元测试。
• 若测试代码能正常运行，会向原 PR 提交一个附带测试代码的 PR。

手动触发

1. 访问 Gru.ai。
2. 选择仓库并点击「手动触发」。

触发规则

• 提交 PR 时会自动添加单元测试。
• 也可以在任意时间手动触发。