Test Gru

🚀 忘記UnitTestのこと

ユニットテストの手間を省き、開発をより効率的に行えるようにします。

🚀 クイックスタート

✨ 主な機能

• PR 送信時や手動でのトリガーにより自動的にユニットテストを追加します。
• テストコードを正常に実行した後、元のPR にテストコードを添付したPR を投稿します。

📦 インストール

このサービスを利用するには、以下の手順で設定を行います。

準備手順

1. Gru.ai にアクセスします。
2. リポジトリを選択します。
3. 自動トリガー設定を有効にします。

💻 使用例

基本的な使用法

自動トリガーと手動トリガーの2 通りの方法でユニットテストを追加できます。

自動トリガー

• 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 を送信する際には、自動的にユニットテストが追加されます。
• 手動でも任意のタイミングでトリガー可能です。