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

先生と生徒の会話形式で理解しよう

生徒

「先生、Go言語でテストを書くときに名前のルールとかありますか？」

先生

「はい、Go言語の単体テストでは関数名をTestで始める必要があります。このルールを守ると、go testコマンドで自動的にテストが実行されます。」

生徒

「具体的にはどう書けばいいんですか？」

先生

「では、簡単な例を見ながら解説しましょう。」

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の命名ルール

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

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

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

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

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