Go言語のテスト関数の書き方と基本ルール（TestXxx）

1. テスト関数の基本構造

1. テスト関数の基本構造

Go言語のテスト関数は、Testで始まる名前にして、引数にt *testing.Tを受け取ります。t *testing.Tはテストの状態を管理したり、失敗した場合にエラーを出力するために使います。

package main

import "testing"

func Multiply(a, b int) int {
    return a * b
}

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

この例では、Multiply関数が正しく掛け算できるかをチェックしています。結果が期待値と違う場合、t.Errorfでエラーを出力します。

2. TestXxxの命名ルール

2. TestXxxの命名ルール

テスト関数は必ずTestで始め、続けてアルファベットや数字を使った名前をつけます。例えばTestAddやTestCalculateSumなどです。このルールを守らないとgo testが関数を認識せず、テストが実行されません。

3. テストファイルの名前

3. テストファイルの名前

テストを書くファイルは、xxx_test.goという名前にします。例えばmath.goというファイルのテストはmath_test.goとするのが一般的です。このルールにより、Goはどのファイルにテストがあるかを自動的に判断します。

4. 複数のテストケースを効率よく書く

4. 複数のテストケースを効率よく書く

一つの関数に対して複数の入力をテストしたい場合、テーブル駆動テストという方法が便利です。テーブル駆動テストでは、入力と期待値を配列にまとめ、ループで順番にチェックします。

func TestMultiplyTable(t *testing.T) {
    tests := []struct {
        a, b int
        want int
    }{
        {2, 3, 6},
        {4, 5, 20},
        {0, 10, 0},
    }

    for _, tt := range tests {
        result := Multiply(tt.a, tt.b)
        if result != tt.want {
            t.Errorf("Multiply(%d,%d) = %d; want %d", tt.a, tt.b, result, tt.want)
        }
    }
}

この方法で、たくさんのパターンを効率的にテストできます。どの入力で失敗したかもわかりやすく表示されます。

5. テスト実行の基本

5. テスト実行の基本

テストを実行するには、ターミナルでgo testを使います。テストファイルが正しい名前で保存されていれば、自動的に全てのTestXxx関数を実行します。

go test

テストが全て成功すれば「ok」と表示され、失敗があればエラーの詳細が表示されます。これにより、関数が期待通りに動作しているかを簡単に確認できます。

6. 初心者向けのポイント

6. 初心者向けのポイント

初心者はまず、関数ごとに一つずつ簡単なテストを書き、結果を確認することから始めると良いです。関数が増えてきたら、テーブル駆動テストを活用して効率よくテストを行いましょう。エラーメッセージには、どの入力で失敗したかを明確に書くと、原因の特定がしやすくなります。

Go言語のTestXxxルールとxxx_test.goファイル名のルールを守ることで、テストの自動化と効率化が簡単にできます。これにより、プログラムの品質を高めることができます。