Go テストパターン (Testing Patterns)

テスト駆動開発（TDD）方法論に従い、信頼性が高く保守しやすい Go テストの包括的なパターン。

いつ使うか

• 新しい Go 関数またはメソッドを作成する場合
• 既存コードのテストカバレッジを追加する場合
• パフォーマンス関連コードのベンチマークテスト（Benchmarks）を作成する場合
• 入力検証のためのファジングテスト（Fuzz tests）を実装する場合
• Go プロジェクトで TDD ワークフローを実践する場合

Go における TDD ワークフロー

RED-GREEN-REFACTOR サイクル

RED      → 失敗するテストを最初に作成する
GREEN    → テストを通すための最小限のコードを作成する
REFACTOR → テストを通す状態で、コードを改善する
REPEAT   → 次の要件に進む

Go での段階的な TDD

// ステップ 1：インターフェースまたはシグネチャを定義
// calculator.go
package calculator

func Add(a, b int) int {
    panic("not implemented") // プレースホルダー
}

// ステップ 2：失敗するテストを作成 (RED)
// calculator_test.go
package calculator

import "testing"

func TestAdd(t *testing.T) {
    got := Add(2, 3)
    want := 5
    if got != want {
        t.Errorf("Add(2, 3) = %d; want %d", got, want)
    }
}

// ステップ 3：テストを実行 - 失敗を確認 (FAIL)
// $ go test
// --- FAIL: TestAdd (0.00s)
// panic: not implemented

// ステップ 4：最小限のコードを実装 (GREEN)
func Add(a, b int) int {
    return a + b
}

// ステップ 5：テストを実行 - 成功を確認 (PASS)
// $ go test
// PASS

// ステップ 6：必要に応じてリファクタリングし、テストが引き続き通ることを確認

テーブル駆動テスト (Table-Driven Tests)

Go テストの標準パターン。最小限のコードで包括的なカバレッジを実現します。

func TestAdd(t *testing.T) {
    tests := []struct {
        name     string
        a, b     int
        expected int
    }{
        {"positive numbers", 2, 3, 5},
        {"negative numbers", -1, -2, -3},
        {"zero values", 0, 0, 0},
        {"mixed signs", -1, 1, 0},
        {"large numbers", 1000000, 2000000, 3000000},
    }

    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            got := Add(tt.a, tt.b)
            if got != tt.expected {
                t.Errorf("Add(%d, %d) = %d; want %d",
                    tt.a, tt.b, got, tt.expected)
            }
        })
    }
}

エラーケースを含むテーブル駆動テスト

func TestParseConfig(t *testing.T) {
    tests := []struct {
        name    string
        input   string
        want    *Config
        wantErr bool
    }{
        {
            name:  "valid config",
            input: `{"host": "localhost", "port": 8080}`,
            want:  &Config{Host: "localhost", Port: 8080},
        },
        {
            name:    "invalid JSON",
            input:   `{invalid}`,
            wantErr: true,
        },
        {
            name:    "empty input",
            input:   "",
            wantErr: true,
        },
        {
            name:  "minimal config",
            input: `{}`,
            want:  &Config{}, // ゼロ値設定
        },
    }

    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            got, err := ParseConfig(tt.input)

            if tt.wantErr {
                if err == nil {
                    t.Error("expected error, got nil")
                }
                return
            }

            if err != nil {
                t.Fatalf("unexpected error: %v", err)
            }

            if !reflect.DeepEqual(got, tt.want) {
                t.Errorf("got %+v; want %+v", got, tt.want)
            }
        })
    }
}

サブテストとサブベンチマーク (Subtests and Sub-benchmarks)

関連するテストの組織化

func TestUser(t *testing.T) {
    // すべてのサブテストで共有される設定
    db := setupTestDB(t)

    t.Run("Create", func(t *testing.T) {
        user := &User{Name: "Alice"}
        err := db.CreateUser(user)
        if err != nil {
            t.Fatalf("CreateUser failed: %v", err)
        }
        if user.ID == "" {
            t.Error("expected user ID to be set")
        }
    })

    t.Run("Get", func(t *testing.T) {
        user, err := db.GetUser("alice-id")
        if err != nil {
            t.Fatalf("GetUser failed: %v", err)
        }
        if user.Name != "Alice" {
            t.Errorf("got name %q; want %q", user.Name, "Alice")
        }
    })

    t.Run("Update", func(t *testing.T) {
        // ...
    })

    t.Run("Delete", func(t *testing.T) {
        // ...
    })
}

並列サブテスト

func TestParallel(t *testing.T) {
    tests := []struct {
        name  string
        input string
    }{
        {"case1", "input1"},
        {"case2", "input2"},
        {"case3", "input3"},
    }

    for _, tt := range tests {
        tt := tt // ループ変数をキャプチャ
        t.Run(tt.name, func(t *testing.T) {
            t.Parallel() // サブテストを並列実行
            result := Process(tt.input)
            // アサーション...
            _ = result
        })
    }
}

テストヘルパー (Test Helpers)

ヘルパー関数

func setupTestDB(t *testing.T) *sql.DB {
    t.Helper() // この関数をテストヘルパーとしてマーク

    db, err := sql.Open("sqlite3", ":memory:")
    if err != nil {
        t.Fatalf("failed to open database: %v", err)
    }

    // テスト終了時にクリーンアップ
    t.Cleanup(func() {
        db.Close()
    })

    // マイグレーションを実行
    if _, err := db.Exec(schema); err != nil {
        t.Fatalf("failed to create schema: %v", err)
    }

    return db
}

func assertNoError(t *testing.T, err error) {
    t.Helper()
    if err != nil {
        t.Fatalf("unexpected error: %v", err)
    }
}

func assertEqual[T comparable](t *testing.T, got, want T) {
    t.Helper()
    if got != want {
        t.Errorf("got %v; want %v", got, want)
    }
}

一時ファイルとディレクトリ

func TestFileProcessing(t *testing.T) {
    // 一時ディレクトリを作成 - 自動クリーンアップされます
    tmpDir := t.TempDir()

    // テストファイルを作成
    testFile := filepath.Join(tmpDir, "test.txt")
    err := os.WriteFile(testFile, []byte("test content"), 0644)
    if err != nil {
        t.Fatalf("failed to create test file: %v", err)
    }

    // テストを実行
    result, err := ProcessFile(testFile)
    if err != nil {
        t.Fatalf("ProcessFile failed: %v", err)
    }

    // アサーション...
    _ = result
}

Golden Files (ゴールデンファイルテスト)

testdata/ に保存された予期されたアウトプットファイルと比較してテストします。

var update = flag.Bool("update", false, "update golden files")

func TestRender(t *testing.T) {
    tests := []struct {
        name  string
        input Template
    }{
        {"simple", Template{Name: "test"}},
        {"complex", Template{Name: "test", Items: []string{"a", "b"}}},
    }

    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            got := Render(tt.input)

            golden := filepath.Join("testdata", tt.name+".golden")

            if *update {
                // ゴールデンファイルを更新: go test -update
                err := os.WriteFile(golden, got, 0644)
                if err != nil {
                    t.Fatalf("failed to update golden file: %v", err)
                }
            }

            want, err := os.ReadFile(golden)
            if err != nil {
                t.Fatalf("failed to read golden file: %v", err)
            }

            if !bytes.Equal(got, want) {
                t.Errorf("output mismatch:\ngot:\n%s\nwant:\n%s", got, want)
            }
        })
    }
}

インターフェースを使ったモック (Mocking with Interfaces)

インターフェースベースのモック

// 依存関係のインターフェースを定義
type UserRepository interface {
    GetUser(id string) (*User, error)
    SaveUser(user *User) error
}

// 本番環境の実装
type PostgresUserRepository struct {
    db *sql.DB
}

func (r *PostgresUserRepository) GetUser(id string) (*User, error) {
    // 実際のデータベースクエリ
}

// テスト用のモック実装
type MockUserRepository struct {
    GetUserFunc  func(id string) (*User, error)
    SaveUserFunc func(user *User) error
}

func (m *MockUserRepository) GetUser(id string) (*User, error) {
    return m.GetUserFunc(id)
}

func (m *MockUserRepository) SaveUser(user *User) error {
    return m.SaveUserFunc(user)
}

// モックを使ってテスト
func TestUserService(t *testing.T) {
    mock := &MockUserRepository{
        GetUserFunc: func(id string) (*User, error) {
            if id == "123" {
                return &User{ID: "123", Name: "Alice"}, nil
            }
            return nil, ErrNotFound
        },
    }

    service := NewUserService(mock)

    user, err := service.GetUserProfile("123")
    if err != nil {
        t.Fatalf("unexpected error: %v", err)
    }
    if user.Name != "Alice" {
        t.Errorf("got name %q; want %q", user.Name, "Alice")
    }
}

ベンチマークテスト (Benchmarks)

基本的なベンチマークテスト

func BenchmarkProcess(b *testing.B) {
    data := generateTestData(1000)
    b.ResetTimer() // 準備時間を計測対象外にします

    for i := 0; i < b.N; i++ {
        Process(data)
    }
}

// 実行: go test -bench=BenchmarkProcess -benchmem
// 出力: BenchmarkProcess-8   10000   105234 ns/op   4096 B/op   10 allocs/op

異なるサイズでのベンチマークテスト

func BenchmarkSort(b *testing.B) {
    sizes := []int{100, 1000, 10000, 100000}

    for _, size := range sizes {
        b.Run(fmt.Sprintf("size=%d", size), func(b *testing.B) {
            data := generateRandomSlice(size)
            b.ResetTimer()

            for i := 0; i < b.N; i++ {
                // すでにソート済みのデータをソートするのを避けるためにコピーを作成
                tmp := make([]int, len(data))
                copy(tmp, data)
                sort.Ints(tmp)
            }
        })
    }
}

メモリ割り当てベンチマークテスト

func BenchmarkStringConcat(b *testing.B) {
    parts := []string{"hello", "world", "foo", "bar", "baz"}

    b.Run("plus", func(b *testing.B) {
        for i := 0; i < b.N; i++ {
            var s string
            for _, p := range parts {
                s += p
            }
            _ = s
        }
    })

    b.Run("builder", func(b *testing.B) {
        for i := 0; i < b.N; i++ {
            var sb strings.Builder
            for _, p := range parts {
                sb.WriteString(p)
            }
            _ = sb.String()
        }
    })

    b.Run("join", func(b *testing.B) {
        for i := 0; i < b.N; i++ {
            _ = strings.Join(parts, "")
        }
    })
}

ファジングテスト (Fuzzing) (Go 1.18+)

基本的なファジングテスト

func FuzzParseJSON(f *testing.F) {
    // シードコーパスを追加
    f.Add(`{"name": "test"}`)
    f.Add(`{"count": 123}`)
    f.Add(`[]`)
    f.Add(`""`)

    f.Fuzz(func(t *testing.T, input string) {
        var result map[string]interface{}
        err := json.Unmarshal([]byte(input), &result)

        if err != nil {
            // ランダム入力の場合は、無効な JSON が想定されます
            return
        }

        // パース成功時は、再エンコードも有効である必要があります
        _, err = json.Marshal(result)
        if err != nil {
            t.Errorf("Marshal failed after successful Unmarshal: %v", err)
        }
    })
}

// 実行: go test -fuzz=FuzzParseJSON -fuzztime=30s

複数入力のファジングテスト

func FuzzCompare(f *testing.F) {
    f.Add("hello", "world")
    f.Add("", "")
    f.Add("abc", "abc")

    f.Fuzz(func(t *testing.T, a, b string) {
        result := Compare(a, b)

        // プロパティ: Compare(a, a) は常に 0 に等しいはず
        if a == b && result != 0 {
            t.Errorf("Compare(%q, %q) = %d; want 0", a, b, result)
        }

        // プロパティ: Compare(a, b) と Compare(b, a) の符号は反対のはず
        reverse := Compare(b, a)
        if (result > 0 && reverse >= 0) || (result < 0 && reverse <= 0) {
            if result != 0 || reverse != 0 {
                t.Errorf("Compare(%q, %q) = %d, Compare(%q, %q) = %d; inconsistent",
                    a, b, result, b, a, reverse)
            }
        }
    })
}

テストカバレッジ (Test Coverage)

カバレッジの実行

# 基本的なカバレッジ
go test -cover ./...

# カバレッジプロファイルを生成
go test -coverprofile=coverage.out ./...

# ブラウザでカバレッジを表示
go tool cover -html=coverage.out

# 関数ごとのカバレッジを表示
go tool cover -func=coverage.out

# レースディテクターを使用したカバレッジ
go test -race -coverprofile=coverage.out ./...

カバレッジの目標

コードタイプ	目標
重要なビジネスロジック	100%
パブリック API	90%+
汎用コード	80%+
生成されたコード	除外

カバレッジから生成されたコードを除外

//go:generate mockgen -source=interface.go -destination=mock_interface.go

// カバレッジプロファイルで、ビルドタグを使って除外:
// go test -cover -tags=!generate ./...

HTTP ハンドラーテスト

func TestHealthHandler(t *testing.T) {
    // リクエストを作成
    req := httptest.NewRequest(http.MethodGet, "/health", nil)
    w := httptest.NewRecorder()

    // ハンドラーを呼び出す
    HealthHandler(w, req)

    // レスポンスを確認
    resp := w.Result()
    defer resp.Body.Close()

    if resp.StatusCode != http.StatusOK {
        t.Errorf("got status %d; want %d", resp.StatusCode, http.StatusOK)
    }

    body, _ := io.ReadAll(resp.Body)
    if string(body) != "OK" {
        t.Errorf("got body %q; want %q", body, "OK")
    }
}

func TestAPIHandler(t *testing.T) {
    tests := []struct {
        name       string
        method     string
        path       string
        body       string
        wantStatus int
        wantBody   string
    }{
        {
            name:       "get user",
            method:     http.MethodGet,
            path:       "/users/123",
            wantStatus: http.StatusOK,
            wantBody:   `{"id":"123","name":"Alice"}`,
        },
        {
            name:       "not found",
            method:     http.MethodGet,
            path:       "/users/999",
            wantStatus: http.StatusNotFound,
        },
        {
            name:       "create user",
            method:     http.MethodPost,
            path:       "/users",
            body:       `{"name":"Bob"}`,
            wantStatus: http.StatusCreated,
        },
    }

    handler := NewAPIHandler()

    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            var body io.Reader
            if tt.body != "" {
                body = strings.NewReader(tt.body)
            }

            req := httptest.NewRequest(tt.method, tt.path, body)
            req.Header.Set("Content-Type", "application/json")
            w := httptest.NewRecorder()

            handler.ServeHTTP(w, req)

            if w.Code != tt.wantStatus {
                t.Errorf("got status %d; want %d", w.Code, tt.wantStatus)
            }

            if tt.wantBody != "" && w.Body.String() != tt.wantBody {
                t.Errorf("got body %q; want %q", w.Body.String(), tt.wantBody)
            }
        })
    }
}

テストコマンド

# すべてのテストを実行
go test ./...

# テストを実行し、詳細情報を出力
go test -v ./...

# 特定のテストを実行
go test -run TestAdd ./...

# パターンに一致するテストを実行
go test -run "TestUser/Create" ./...

# レースディテクターでテストを実行
go test -race ./...

# カバレッジ確認でテストを実行
go test -cover -coverprofile=coverage.out ./...

# 短いテストのみを実行
go test -short ./...

# タイムアウト付きでテストを実行
go test -timeout 30s ./...

# ベンチマークテストを実行
go test -bench=. -benchmem ./...

# ファジングテストを実行
go test -fuzz=FuzzParse -fuzztime=30s ./...

# テスト実行回数を計測（不安定なテストを検出するため）
go test -count=10 ./...

ベストプラクティス

推奨事項 (DO)：

• テストを先に書く (TDD)
• テーブル駆動テストを使って包括的なカバレッジを実現
• 実装ではなく、動作をテスト
• ヘルパー関数で t.Helper() を使う
• 相互に独立したテストでは t.Parallel() を使う
• t.Cleanup() でリソースをクリーンアップ
• シナリオを説明する意味のあるテスト名を使う

避けるべき事項 (DON'T)：

• プライベート関数を直接テストする（パブリック API を経由でテスト）
• テスト内で time.Sleep() を使う（チャネルまたは条件を使う）
• 不安定なテストを無視する（修正または削除する）
• すべてをモックする（統合テストを優先する）
• エラーパステストをスキップする

CI/CD 統合

# GitHub Actions の例
test:
  runs-on: ubuntu-latest
  steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-go@v5
      with:
        go-version: '1.22'

    - name: Run tests
      run: go test -race -coverprofile=coverage.out ./...

    - name: Check coverage
      run: |
        go tool cover -func=coverage.out | grep total | awk '{print $3}' | \
        awk -F'%' '{if ($1 < 80) exit 1}'

覚えておいてください：テストはドキュメントです。コードの使い方を示します。テストを明確に作成し、最新の状態に保ちましょう。