Go by Example: Testing and Benchmarking

ユニットテストは、原則にそった Go プログラムを書く上で重要です。 testing パッケージがユニットテストを書くために必要な ツールを提供し、go test コマンドでテストを実行します。

デモのため、このコードは main パッケージにありますが、 任意のパッケージにできます。通常、テストコードは テストされるコードと同じパッケージに配置します。

 
package main

import (
    "fmt"
    "testing"
)

この整数の最小値を求めるシンプルな実装をテストしたいとしましょう。 通常、テストしたいコードは intutils.go のような名前の ソースファイル中にあり、そのテストファイルは intutils_test.go のような名前になります。

 
func IntMin(a, b int) int {
    if a < b {
        return a
    }
    return b
}

テストは、Test から始まる名前の関数を書くことで作ります。

 
func TestIntMinBasic(t *testing.T) {
    ans := IntMin(2, -2)
    if ans != -2 {

t.Error* はテストの失敗を報告しますが、テストの実行は継続します。 t.Fatal* はテストの失敗を報告し、テストの実行を即座に停止します。

 
        t.Errorf("IntMin(2, -2) = %d; want -2", ans)
    }
}

テストを書くことは繰り返しになりがちなので、イディオムとして テーブル駆動スタイル (table-driven style) があります。 この方法は、テストの入力と出力の期待値をテーブルに列挙し、 1レコードずつ順番にループしてロジックをテストします。

 
func TestIntMinTableDriven(t *testing.T) {
    var tests = []struct {
        a, b int
        want int
    }{
        {0, 1, 0},
        {1, 0, 0},
        {2, -2, -2},
        {0, -1, -1},
        {-1, 0, -1},
    }

t.Run はテーブルのエントリ1つずつに対して “サブテスト” の実行を実現します。これらは、go test -v を実行したときに 個別に表示されます。

 
    for _, tt := range tests {

        testname := fmt.Sprintf("%d,%d", tt.a, tt.b)
        t.Run(testname, func(t *testing.T) {
            ans := IntMin(tt.a, tt.b)
            if ans != tt.want {
                t.Errorf("got %d, want %d", ans, tt.want)
            }
        })
    }
}

ベンチマークテストは通常 _test.go ファイルの中で定義され、 Benchmark という名前から始まります。testing ランナーは、 各ベンチマーク関数を複数回実行し、 正確な測定結果が得られるまで実行ごとに b.N を増やします。

 
func BenchmarkIntMin(b *testing.B) {

典型的なベンチマークテストでは、ベンチマークしたい 関数をループで b.N 回実行します。

 
    for i := 0; i < b.N; i++ {
        IntMin(1, 2)
    }
}

カレントプロジェクトのすべてのテストを verbose モードで実行します。

 
$ go test -v
== RUN   TestIntMinBasic
--- PASS: TestIntMinBasic (0.00s)
=== RUN   TestIntMinTableDriven
=== RUN   TestIntMinTableDriven/0,1
=== RUN   TestIntMinTableDriven/1,0
=== RUN   TestIntMinTableDriven/2,-2
=== RUN   TestIntMinTableDriven/0,-1
=== RUN   TestIntMinTableDriven/-1,0
--- PASS: TestIntMinTableDriven (0.00s)
    --- PASS: TestIntMinTableDriven/0,1 (0.00s)
    --- PASS: TestIntMinTableDriven/1,0 (0.00s)
    --- PASS: TestIntMinTableDriven/2,-2 (0.00s)
    --- PASS: TestIntMinTableDriven/0,-1 (0.00s)
    --- PASS: TestIntMinTableDriven/-1,0 (0.00s)
PASS
ok      examples/testing-and-benchmarking    0.023s

カレントプロジェクトのすべてのベンチマークを実行します。 ベンチマークの前にすべてのテストが実行されます。 bench フラグは、ベンチマーク関数の名前を正規表現で 絞り込みます。

 
$ go test -bench=.
goos: darwin
goarch: arm64
pkg: examples/testing
BenchmarkIntMin-8 1000000000 0.3136 ns/op
PASS
ok      examples/testing-and-benchmarking    0.351s

Next example: Command-Line Arguments.

by Mark McGranaghan and Eli Bendersky (translated by @oohira) | feedback | license