Go テスト

クイックリファレンス

パターン	使用場面
t.Error	デフォルト — 失敗を報告し、実行を継続
t.Fatal	セットアップが失敗したか、続行が無意味な場合
cmp.Diff	構造体、スライス、マップ、proto を比較
テーブル駆動	多くのケースが同じロジックを共有
サブテスト	フィルタリング、並列実行、または命名が必要
t.Helper()	任意のテストヘルパー関数（最初のステートメントとして呼び出し）
t.Cleanup()	ヘルパー内の後始末（defer の代わり）

---

有用なテスト失敗メッセージ

規範: テスト失敗はテストソースを読まずに診断可能でなければならない。

すべての失敗メッセージには、関数名、入力、実際の値（got）、期待値（want）を含める必要があります。YourFunc(%v) = %v, want %v のフォーマットを使用してください。

// Good:
t.Errorf("Add(2, 3) = %d, want %d", got, 5)

// Bad: 関数名と入力が不足
t.Errorf("got %d, want %d", got, 5)

常に got を want の前に出力します。got %v, want %v — 逆にしてはいけません。

---

アサーションライブラリは使わない

規範: アサーションライブラリを使わない。複雑な比較には cmp.Diff を使用する。

if diff := cmp.Diff(want, got); diff != "" {
    t.Errorf("GetPost() mismatch (-want +got):\n%s", diff)
}

Protocol Buffer の場合、cmp オプションに protocmp.Transform() を追加してください。diff メッセージには常に (-want +got) の方向キーを含めてください。JSON/シリアル化出力を比較するのは避け、代わりに意味論的に比較してください。

カスタム比較ヘルパーまたはドメイン固有のテストユーティリティを書く際は、references/TEST-HELPERS.md を参照してください。

---

t.Error vs t.Fatal

規範: デフォルトとして t.Error を使用してすべての失敗を 1 回の実行で報告してください。続行が不可能な場合のみ t.Fatal を使用してください。

t.Fatal を選択する場合:

• セットアップが失敗した（DB 接続、ファイル読み込み）
• 次のアサーションが前のアサーションの成功に依存している（例：encode の後に decode）

テストゴルーチン以外のゴルーチンから t.Fatal/t.FailNow を呼び出さないでください — 代わりに t.Error を使用してください。

t.Error と t.Fatal のどちらかを選択する必要があるヘルパーを書く場合、または両方の詳細な例については、references/TEST-HELPERS.md を参照してください。

---

テーブル駆動テスト

新しいテーブル駆動テストをスキャフォールドしており、規範的な構造体、ループ、サブテストレイアウトが必要な場合は、assets/table-test-template.go を参照してください。

勧告: 多くのケースが同じロジックを共有する場合、テーブル駆動テストを使用してください。

テーブルテストを使用する場合: すべてのケースが条件付きセットアップ、モッキング、またはアサーションなしで同じコードパスを実行する場合。単一の shouldErr bool は受け入れられます。

テーブルテストを使わない場合: ケースが複雑なセットアップ、条件付きモッキング、または複数の分岐が必要な場合 — 代わりに別のテスト関数を書いてください。

主なルール:

• ケースが多くの行にまたがるか、同じ型の隣接したフィールドがある場合はフィールド名を使用
• 失敗メッセージに入力を含める — インデックスで行を識別してはいけません

テーブル駆動テスト、サブテスト、または並列テストを書く場合は、references/TABLE-DRIVEN-TESTS.md を参照してください。

検証: テストを生成または変更した後、go test -run TestXxx -v を実行してテストがコンパイルされ、合格することを確認してください。進める前にコンパイルエラーを修正してください。

---

テストヘルパー

規範: テストヘルパーは最初に t.Helper() を呼び出し、後始末には t.Cleanup() を使用する必要があります。

func setupTestDB(t *testing.T) *sql.DB {
    t.Helper()
    db, err := sql.Open("sqlite3", ":memory:")
    if err != nil {
        t.Fatalf("Could not open database: %v", err)
    }
    t.Cleanup(func() { db.Close() })
    return db
}

テストヘルパー、クリーンアップ関数、またはカスタム比較ユーティリティを書く場合は、references/TEST-HELPERS.md を参照してください。

---

テストエラーセマンティクス

勧告: エラーメッセージ文字列ではなく、テストエラーセマンティクスをテストしてください。

// Bad: 脆弱な文字列比較
if err.Error() != "invalid input" { ... }

// Good: 意味論的チェック
if !errors.Is(err, ErrInvalidInput) { ... }

特定のセマンティクスが重要でない単純な存在チェックの場合:

if gotErr := err != nil; gotErr != tt.wantErr {
    t.Errorf("f(%v) error = %v, want error presence = %t", tt.input, err, tt.wantErr)
}

---

テスト構成

テストダブル、テストパッケージの配置の選択、またはテストセットアップのスコープを扱う場合は、references/TEST-ORGANIZATION.md を参照してください。

再利用可能なテスト検証関数を設計する場合は、references/VALIDATION-APIS.md を参照してください。

---

統合テスト

TestMain、受け入れテスト、または実際の HTTP/RPC トランスポートが必要なテストを書く場合は、references/INTEGRATION.md を参照してください。

---

利用可能なスクリプト

• scripts/gen-table-test.sh — テーブル駆動テストのスキャフォールドを生成

bash scripts/gen-table-test.sh ParseConfig config > config/parse_config_test.go
bash scripts/gen-table-test.sh --parallel ParseConfig config      # t.Parallel() 付き
bash scripts/gen-table-test.sh --output config/parse_config_test.go ParseConfig config

---

関連スキル

• エラーテスト: errors.Is/errors.As またはセンチネルエラーを使用してエラーセマンティクスをテストする場合は、go-error-handling を参照してください。
• インターフェースモッキング: コンシューマー側でインターフェースを実装してテストダブルを作成する場合は、go-interfaces を参照してください。
• テスト関数の命名: テスト関数、サブテスト、またはテストヘルパーユーティリティに命名する場合は、go-naming を参照してください。
• リンター統合: CI または pre-commit フックでリンターをテストと一緒に実行する場合は、go-linting を参照してください。