Findy Team+の導入効果をレビューでご紹介(ファインディ株式会社)

参考になった

レビュー投稿日の情報になります

最終更新日2024/06/20投稿日2023/12/14

利用プラン	ツールの利用規模	ツールの利用開始時期
Free プラン	10名以下	2020年10月

利用プラン	Free プラン
ツールの利用規模	10名以下
ツールの利用開始時期	2020年10月

アーキテクチャ

アーキテクチャの意図・工夫

Postman
- Postman で作ったテストケースのコレクションを Newman で実行
- API のレスポンス結果を Postman のコールバック機能を使って local に保存
Ruby（非同期処理）
- Postman で保存したレスポンス結果を読み取って非同期処理で利用。実行結果のテストを実行
make コマンド
- 上の2つのテストツールを make コマンド化して実行

導入の背景・解決したかった問題

導入背景

初期開発において、複数のシステム（マイクロサービス）から成り立つ決済の API に対する E2E テスト環境を構築する必要がありました
この API の結果を利用した非同期処理のテストも同時に行う必要がありました
シード期のスタートアップのため、できるだけライトながら十分なテスト環境を構築する必要がありました

Postman導入前については、integration テストまでは各サービスで自動テストを作成しており、E2Eテストは実施していませんでした。そのため、テスト対象は1つの APIであるものの、決済の様々なパターンに対応した多数のテストケースを作る必要があり工数がかかっていました。

他社のブログなどでPostman を E2E テストで利用している事例を把握していたため検討を始めました。

選定理由

GUI で簡単にテストケースの作成や実行ができる
テストケース実行前・後にスクリプトを自由に挿入できるなど、拡張性が高い

導入に向けた社内への説明

上長・チームへの説明

特になし

費用対効果の算出

特になし

活用方法

よく使う機能

特になし

ツールの良い点

GUI（Postman）と CUI（Newman）の両方が用意されており、GUI でテストケースの作成や一部テストの手動実行を行いつつ、CUI で自動テストを実行することができる

ツールの課題点

スクリプトの共通化が標準でできないなど、テストケースが多くなったときの管理コストが大きい
変数やテスト実行前・後のスクリプトは、自由度が高いが故に肥大化すると、何の処理をどこで行っているか把握しずらくなりやすい
スクリプトの共通化は標準ではサポートされていないため、各テストケースでの処理の共通化がしにくい。scenarigo のようなコードベースで記述するツールの方が、共通化等は行いやすい
collections や folder をどのような単位で切るかを整理して、ある変数は特定の folder でのみ適応するなど、スコープの範囲が適切になるよう設計するとよい

ツールを検討されている方へ

API の E2E テストのカバレッジを高く保つのは、コスト観点から非常に大変です。私達がサービスのコアな機能である決済部分でのみ E2E テストを用意しているように、重要度の高い部分に絞りテストを用意するので充分な場合があるかもしれません。また、E2E テストの仕組みを構築することと、CI 環境を構築することはイコールではありません。まずは、実行環境はローカルでもよいので E2E テストを自動で行う仕組みを導入するところからスタートするなど、初期の導入コストを低くすることで導入がしやすくなるかもしれません。