例による Go: テストとベンチマーク

単体テストは、原則に基づく 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)
    }
}

テストの記述は単調になり得るため、テスト入力と想定される出力がテーブルにリストされ、単一のループがそれらを処理してテスト ロジックを実行する「テーブル駆動型スタイル」を利用することが慣例です。

 
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 は、テーブルのエントリごとに「サブテスト」を実行できます。これらは 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)
    }
}

詳細モードで現在のプロジェクトのすべてのテストを実行します。

 
$ 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

次の例: コマンドライン引数。

著: マーク・マクグラナハン と イーライ・ベンダーキー | ソース | ライセンス