【完全ガイド】初心者のためのGo言語のテスト

こんにちは！今回は、Go言語（Golang）におけるテストについて、初心者の方にもわかりやすく解説していきます。ソフトウェアテストは、プログラムの品質を確保し、バグを早期に発見するために非常に重要です。Go言語には、テストを簡単に書くための組み込みのテストフレームワークがあります。この記事では、Goのテストの基本から応用まで、段階的に理解を深めていきましょう。

目次非表示

1. Goのテストの基本
- テスト関数の基本構造
2. テーブル駆動テスト
3. サブテスト
4. テストのセットアップとティアダウン
5. モック（Mock）とスタブ（Stub）
6. ベンチマーク
7. カバレッジ
8. HTTPテスト
9. テストのベストプラクティス
まとめ

1. Goのテストの基本

Goのテストは、testingパッケージを使用して行います。テストファイルは通常、テスト対象のファイルと同じディレクトリに置かれ、ファイル名の末尾に_test.goを付けます。

例えば、calculator.goというファイルをテストする場合、テストファイルはcalculator_test.goとなります。

テスト関数の基本構造

テスト関数は以下の条件を満たす必要があります：

関数名がTestで始まる
*testing.T型の引数を1つ取る

基本的なテストの例を見てみましょう。

// calculator.go
package calculator

func Add(a, b int) int {
    return a + b
}

// calculator_test.go
package calculator

import "testing"

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

このテストを実行するには、ターミナルで以下のコマンドを使用します。

bash

go test

2. テーブル駆動テスト

多くのケースを効率的にテストするために、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},
        {"mixed numbers", -1, 5, 4},
    }

    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)
            }
        })
    }
}

この方法を使うと、多くのケースを簡潔に記述でき、新しいテストケースの追加も容易になります。

3. サブテスト

Go 1.7以降では、t.Run()を使用してサブテストを作成できます。これにより、テストをより構造化し、特定のテストのみを実行することが可能になります。

func TestMath(t *testing.T) {
    t.Run("Addition", func(t *testing.T) {
        if Add(2, 3) != 5 {
            t.Error("Expected 2 + 3 to equal 5")
        }
    })

    t.Run("Subtraction", func(t *testing.T) {
        if Subtract(5, 3) != 2 {
            t.Error("Expected 5 - 3 to equal 2")
        }
    })
}

特定のサブテストのみを実行するには。

bash

go test -run TestMath/Addition

4. テストのセットアップとティアダウン

テストの前後に特定の処理を行いたい場合、TestMain関数を使用できます。

func TestMain(m *testing.M) {
    // テストの前の設定
    setup()

    // すべてのテストを実行
    code := m.Run()

    // テスト後のクリーンアップ
    teardown()

    // テスト結果のステータスコードで終了
    os.Exit(code)
}

func setup() {
    // テスト環境のセットアップ
}

func teardown() {
    // テスト環境のクリーンアップ
}

5. モック（Mock）とスタブ（Stub）

外部依存がある関数やメソッドをテストする際、モックやスタブを使用することがあります。Goには組み込みのモックライブラリはありませんが、インターフェースを活用することで簡単にモックを作成できます。

type DataStore interface {
    GetUser(id int) (string, error)
}

type MockDataStore struct{}

func (m MockDataStore) GetUser(id int) (string, error) {
    return "Mock User", nil
}

func TestUsingDataStore(t *testing.T) {
    mock := MockDataStore{}
    name, err := mock.GetUser(1)
    if err != nil {
        t.Errorf("Expected no error, got %v", err)
    }
    if name != "Mock User" {
        t.Errorf("Expected 'Mock User', got %s", name)
    }
}

6. ベンチマーク

Goは、コードのパフォーマンスを測定するためのベンチマーク機能も提供しています。ベンチマーク関数はBenchmarkで始まり、*testing.B型の引数を取ります。

func BenchmarkAdd(b *testing.B) {
    for i := 0; i < b.N; i++ {
        Add(2, 3)
    }
}

ベンチマークを実行するには次を実行します。

bash

go test -bench=.

7. カバレッジ

テストカバレッジは、コードのどの部分がテストされているかを示す指標です。Goには組み込みのカバレッジツールがあります。

カバレッジを計測してテストを実行するには -cover を使います。

go test -cover

詳細なカバレッジレポートを生成する事もできます。

bash

go test -coverprofile=coverage.out
go tool cover -html=coverage.out

これにより、ブラウザでカバレッジレポートを視覚的に確認できます。

8. HTTPテスト

Goの標準ライブラリには、HTTPハンドラをテストするためのツールが含まれています。

func TestHTTPHandler(t *testing.T) {
    req, err := http.NewRequest("GET", "/hello", nil)
    if err != nil {
        t.Fatal(err)
    }

    rr := httptest.NewRecorder()
    handler := http.HandlerFunc(HelloHandler)

    handler.ServeHTTP(rr, req)

    if status := rr.Code; status != http.StatusOK {
        t.Errorf("handler returned wrong status code: got %v want %v",
            status, http.StatusOK)
    }

    expected := `{"message":"hello"}`
    if rr.Body.String() != expected {
        t.Errorf("handler returned unexpected body: got %v want %v",
            rr.Body.String(), expected)
    }
}