Go言語のtestingパッケージでユニットテスト入門！初心者でもわかる基本とベストプラクティス

元のファイル名: calculator.go
テストファイル名: calculator_test.go

func TestFunction(t *testing.T) {
    // テストのコードをここに書く
}

// math.go
package main

// Add は2つの整数を足し算して結果を返す関数
func Add(a, b int) int {
    return a + b
}

// Multiply は2つの整数を掛け算して結果を返す関数  
func Multiply(a, b int) int {
    return a * b
}

// IsEven は整数が偶数かどうかを判定する関数
func IsEven(n int) bool {
    return n%2 == 0
}

// math_test.go
package main

import "testing"

// TestAdd はAdd関数のテスト
func TestAdd(t *testing.T) {
    // テストケース1: 正の数同士の足し算
    result := Add(2, 3)
    expected := 5
    if result != expected {
        t.Errorf("Add(2, 3) = %d; want %d", result, expected)
    }
    
    // テストケース2: 負の数を含む足し算
    result2 := Add(-1, 1)
    expected2 := 0
    if result2 != expected2 {
        t.Errorf("Add(-1, 1) = %d; want %d", result2, expected2)
    }
}

// TestMultiply はMultiply関数のテスト
func TestMultiply(t *testing.T) {
    result := Multiply(3, 4)
    expected := 12
    if result != expected {
        t.Errorf("Multiply(3, 4) = %d; want %d", result, expected)
    }
}

// TestIsEven はIsEven関数のテスト
func TestIsEven(t *testing.T) {
    // 偶数のテスト
    if !IsEven(4) {
        t.Error("IsEven(4) should be true")
    }
    
    // 奇数のテスト
    if IsEven(5) {
        t.Error("IsEven(5) should be false")
    }
}

go test

PASS
ok      your-project    0.002s

func TestAddTable(t *testing.T) {
    // テストケースをテーブルとして定義
    tests := []struct {
        name     string
        a, b     int
        expected int
    }{
        {"正の数同士", 2, 3, 5},
        {"負の数を含む", -1, 1, 0},
        {"両方とも負の数", -2, -3, -5},
        {"ゼロを含む", 0, 5, 5},
        {"大きな数", 1000, 2000, 3000},
    }

    // 各テストケースを実行
    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            result := Add(tt.a, tt.b)
            if result != tt.expected {
                t.Errorf("Add(%d, %d) = %d; want %d", 
                    tt.a, tt.b, result, tt.expected)
            }
        })
    }
}

// math.go に追加
func Divide(a, b int) (int, error) {
    if b == 0 {
        return 0, fmt.Errorf("division by zero")
    }
    return a / b, nil
}

// math_test.go に追加
func TestDivide(t *testing.T) {
    tests := []struct {
        name        string
        a, b        int
        expected    int
        expectError bool
    }{
        {"正常な割り算", 10, 2, 5, false},
        {"ゼロ除算", 10, 0, 0, true},
        {"負の数の割り算", -10, 2, -5, false},
    }

    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            result, err := Divide(tt.a, tt.b)
            
            if tt.expectError {
                if err == nil {
                    t.Errorf("Divide(%d, %d) expected error, but got none", tt.a, tt.b)
                }
            } else {
                if err != nil {
                    t.Errorf("Divide(%d, %d) unexpected error: %v", tt.a, tt.b, err)
                }
                if result != tt.expected {
                    t.Errorf("Divide(%d, %d) = %d; want %d", tt.a, tt.b, result, tt.expected)
                }
            }
        })
    }
}

// テスト用のヘルパー関数
func assertEqual(t *testing.T, got, want int) {
    t.Helper() // この関数がヘルパーであることを示す
    if got != want {
        t.Errorf("got %d; want %d", got, want)
    }
}

func TestAddWithHelper(t *testing.T) {
    result := Add(2, 3)
    assertEqual(t, result, 5)
}

# カバレッジを測定しながらテストを実行
go test -cover

# より詳細なカバレッジレポートを生成
go test -coverprofile=coverage.out
go tool cover -html=coverage.out

PASS
coverage: 85.7% of statements
ok      your-project    0.003s

// ベンチマーク関数は Benchmark で始まる
func BenchmarkAdd(b *testing.B) {
    for i := 0; i < b.N; i++ {
        Add(2, 3)
    }
}

func BenchmarkMultiply(b *testing.B) {
    for i := 0; i < b.N; i++ {
        Multiply(3, 4)
    }
}

// より複雑な例：文字列の結合のベンチマーク
func BenchmarkStringConcat(b *testing.B) {
    for i := 0; i < b.N; i++ {
        _ = "Hello" + "World"
    }
}

go test -bench=.

BenchmarkAdd-8              1000000000    0.25 ns/op
BenchmarkMultiply-8         1000000000    0.25 ns/op
BenchmarkStringConcat-8     500000000     3.02 ns/op

func TestMathOperations(t *testing.T) {
    t.Run("Addition", func(t *testing.T) {
        t.Parallel() // 並列実行を有効にする
        result := Add(2, 3)
        if result != 5 {
            t.Errorf("Add(2, 3) = %d; want 5", result)
        }
    })
    
    t.Run("Multiplication", func(t *testing.T) {
        t.Parallel() // 並列実行を有効にする
        result := Multiply(3, 4)
        if result != 12 {
            t.Errorf("Multiply(3, 4) = %d; want 12", result)
        }
    })
}

// ❌ 悪い例 外部APIを呼び出すテスト
func TestGetUserFromAPI(t *testing.T) {
    // 実際のAPIを呼び出すと遅い
    user, err := getUserFromAPI("user123")
    // ...
}

// ✅ 良い例 モックを使用
func TestGetUserFromAPI(t *testing.T) {
    // モックサーバーや固定データを使用
    mockResponse := `{"id": "user123", "name": "John"}`
    // ...
}

// ❌ 悪い例 グローバル変数に依存
var counter int

func TestIncrement(t *testing.T) {
    counter++
    if counter != 1 {
        t.Errorf("Expected 1, got %d", counter)
    }
}

// ✅ 良い例 独立したテスト
func TestIncrement(t *testing.T) {
    var counter int
    counter++
    if counter != 1 {
        t.Errorf("Expected 1, got %d", counter)
    }
}

// ❌ 悪い例 現在時刻に依存
func TestIsWorkingHours(t *testing.T) {
    now := time.Now()
    result := IsWorkingHours(now)
    // 実行時刻によって結果が変わる
}

// ✅ 良い例 固定の時刻を使用
func TestIsWorkingHours(t *testing.T) {
    testTime := time.Date(2023, 12, 25, 10, 0, 0, 0, time.UTC)
    result := IsWorkingHours(testTime)
    if !result {
        t.Error("10:00 should be working hours")
    }
}

// ✅ 良い命名例
func TestAdd_PositiveNumbers_ReturnsSum(t *testing.T) { }
func TestDivide_DivisionByZero_ReturnsError(t *testing.T) { }
func TestIsEven_OddNumber_ReturnsFalse(t *testing.T) { }

// ❌ 悪い命名例
func TestFunc1(t *testing.T) { }
func TestSomething(t *testing.T) { }

project/
├── main.go
├── math/
│   ├── calculator.go
│   ├── calculator_test.go
│   ├── geometry.go
│   └── geometry_test.go
└── utils/
    ├── string.go
    └── string_test.go