6
5

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

仕様書リポジトリにデータサンプルを入れたらテストが捗った話

Posted at

仕様を別途検討する必要があるようなプロジェクト、たとえば別システムとデータをやりとりするようなプロジェクトに使えるかもしれないテクニック

仕様書用のリポジトリを作成する

  • API仕様、jsonフォーマット仕様などを検討しそれらをドキュメント化しリポジトリに格納する。
  • 仕様変更はプルリクにより提案を行う。
  • 定期的(朝会など)に確認してプルリクがたまりすぎないようにする。

データサンプルをリポジトリに格納する

  • jsonのデータなどを実際に格納してみる。
  • 格納されたデータを元にテストを作成する。
  • 実際のプロダクトから、仕様書リポジトリを git submodule でサブモジュールとして登録しておく。

データ変換なんかが伴うようなケースとかに特に有効だった

モックをリポジトリに格納する

※これは試してない。要検討

  • 想定してるシナリオに応じた簡単なモックサーバースクリプトを作成してリポジトリに入れる
  • 想定してるシナリオに応じたアクセス用のテストを作成してリポジトリに入れる

生きたシナリオ、生きた仕様書というのが可能かもしれない。

6
5
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
6
5

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?