テスト駆動開発
哲学
コア原則: テストは実装の詳細ではなく、公開インターフェースを通じて振る舞いを検証すべきです。コードは完全に変更される可能性がありますが、テストは変更されるべきではありません。
良いテストは結合テストスタイルです。公開APIを通じて実際のコードパスを実行します。システムが何を行うかを記述し、どのように行うかは記述しません。良いテストは仕様書のように読み取れます。「ユーザーは有効なカートでチェックアウトできる」は、どのような機能が存在するかを正確に示します。これらのテストは内部構造に関係しないため、リファクタリング後も有効です。
悪いテストは実装に結合されています。内部の協力者をモックし、プライベートメソッドをテストし、または外部手段(インターフェースの代わりにデータベースに直接クエリするなど)で検証します。警告サイン:リファクタリング時にテストが壊れるが、振る舞いは変わっていない場合です。内部関数の名前を変更してテストが失敗した場合、そのテストは振る舞いではなく実装をテストしていました。
例についてはtests.mdを、モックのガイドラインについてはmocking.mdを参照してください。
アンチパターン:水平スライス
すべてのテストを先に書き、その後ですべての実装を行うのは避けてください。 これは「水平スライス」と呼ばれ、REDを「すべてのテストを書く」、GREENを「すべてのコードを書く」と扱うものです。
これは粗悪なテストを生み出します:
- 一括で書かれたテストは、実際の 振る舞いではなく、想像上の 振る舞いをテストします
- 結果として、ユーザー向けの振る舞いではなく、データ構造や関数シグネチャなどの「形状」をテストすることになります
- テストは実際の変更に鈍感になります。振る舞いが壊れてもパスし、振る舞いが正常でも失敗します
- 実装を理解する前にテスト構造にコミットし、視野が狭くなります
正しいアプローチ: トレーサーブレットによる垂直スライス。1テスト→1実装→繰り返し。各テストは前のサイクルから学んだことに基づいて応答します。コードを書いたばかりなので、どの振る舞いが重要で、それをどのように検証するかを正確に把握できます。
間違い(水平):
RED: test1, test2, test3, test4, test5
GREEN: impl1, impl2, impl3, impl4, impl5
正しい(垂直):
RED→GREEN: test1→impl1
RED→GREEN: test2→impl2
RED→GREEN: test3→impl3
...
ワークフロー
1. 計画
コードベースを探索する際は、CONTEXT.md(存在する場合)を読んで、テスト名とインターフェースの語彙がプロジェクトのドメイン言語と一致するようにし、触れている領域のADRを尊重してください。
コードを書く前に:
- 必要なインターフェース変更についてユーザーと確認する
- テストする振る舞い(優先順位付け)についてユーザーと確認する
- 深いモジュール(小さなインターフェース、深い実装)の機会を特定する —
/codebase-designスキルを実行して語彙とテスト容易性チェックを得る - テストする振る舞い(実装手順ではない)をリスト化する
- 計画についてユーザーの承認を得る
質問:「公開インターフェースはどのようにあるべきですか?どの振る舞いが最もテストすべきですか?」
すべてをテストすることはできません。 ユーザーとどの振る舞いが最も重要かを正確に確認してください。テストの労力をクリティカルパスと複雑なロジックに集中させ、すべての可能なエッジケースには対応しないでください。
2. トレーサーブレット
システムについて1つのことを確認する1つのテストを書きます:
RED: 最初の振る舞いのテストを書く → テスト失敗
GREEN: パスするための最小限のコードを書く → テスト成功
これがトレーサーブレットです。パスがエンドツーエンドで機能することを証明します。
3. インクリメンタルループ
残りの各振る舞いに対して:
RED: 次のテストを書く → 失敗
GREEN: パスするための最小限のコード → 成功
ルール:
- 一度に1テストのみ
- 現在のテストをパスするのに十分なコードだけ
- 将来のテストを予測しない
- テストは観察可能な振る舞いに焦点を当てる
4. リファクタ
すべてのテストがパスしたら、リファクタ候補を探します:
- 重複を抽出する
- モジュールを深くする(複雑さを単純なインターフェースの背後に移動)
- 自然な箇所にSOLID原則を適用する
- 新しいコードが既存のコードについて何を明らかにするかを検討する
- 各リファクタステップ後にテストを実行する
REDの状態では絶対にリファクタしないでください。 まずGREENに到達してください。
各サイクルのチェックリスト
[ ] テストは振る舞いを記述しており、実装ではない
[ ] テストは公開インターフェースのみを使用している
[ ] テストは内部リファクタ後も有効である
[ ] コードはこのテストに対して最小限である
[ ] 推測による機能は追加されていない