Go言語のテーブル駆動テストの書き方と応用例
生徒
「先生、Go言語のテストでたくさんのパターンをまとめて書く方法ってありますか?」
先生
「はい、それがテーブル駆動テストです。複数の入力と期待する出力をテーブルにまとめて、ループで順番にチェックできます。」
生徒
「テーブル駆動テストって、どういう書き方になるんですか?」
先生
「では、実際の例を見ながら説明しましょう。」
1. テーブル駆動テストとは
テーブル駆動テストとは、入力と期待する結果を表形式でまとめ、それをループで順番にチェックするテスト手法です。Go言語では、構造体のスライスを使ってテーブルを作ることが一般的です。これにより、同じ関数に対して複数のケースを簡潔に書けます。
2. 基本的な書き方
例えば、整数の加算関数をテストする場合、次のようにテーブル駆動テストを作ります。
package main
import "testing"
func Add(a, b int) int {
return a + b
}
func TestAddTable(t *testing.T) {
tests := []struct {
name string
a, b int
want int
}{
{"2と3の加算", 2, 3, 5},
{"0と5の加算", 0, 5, 5},
{"-1と1の加算", -1, 1, 0},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := Add(tt.a, tt.b)
if got != tt.want {
t.Errorf("Add(%d, %d) = %d; want %d", tt.a, tt.b, got, tt.want)
}
})
}
}
この例では、t.Runを使って各テストケースを名前付きで実行しています。失敗した場合、どのケースで失敗したかがわかりやすくなります。
3. t.Runでサブテストを作る理由
t.Runを使うと、テーブル内の各ケースが独立したサブテストとして実行されます。これにより、失敗したケースだけを確認でき、デバッグが容易になります。複雑な関数や多くの入力パターンをテストする場合に特に便利です。
4. 応用例:文字列操作のテスト
次は文字列の逆順関数をテストする例です。テーブル駆動テストを使うことで、複数の文字列ケースを簡単にチェックできます。
func Reverse(s string) string {
runes := []rune(s)
for i, j := 0, len(runes)-1; i < j; i, j = i+1, j-1 {
runes[i], runes[j] = runes[j], runes[i]
}
return string(runes)
}
func TestReverseTable(t *testing.T) {
tests := []struct {
input string
want string
}{
{"abc", "cba"},
{"こんにちは", "はちにんこ"},
{"", ""},
}
for _, tt := range tests {
t.Run(tt.input, func(t *testing.T) {
got := Reverse(tt.input)
if got != tt.want {
t.Errorf("Reverse(%q) = %q; want %q", tt.input, got, tt.want)
}
})
}
}
このように文字列操作の関数でもテーブル駆動テストを使えば、複数の入力パターンを効率的にテストできます。空文字や特殊文字も簡単に追加可能です。
5. テーブル駆動テストのメリット
テーブル駆動テストのメリットは、テストの可読性が高まり、同じパターンを繰り返し書かずに済むことです。また、新しいテストケースを追加するのも簡単で、既存のコードをほとんど変更せずにテストを拡張できます。大規模なプロジェクトでは、バグの早期発見や保守性向上に大きく役立ちます。
6. 初心者向けのポイント
初心者は、まず少数のケースでテーブル駆動テストを書き、テストの動作を確認することから始めましょう。次に複雑な関数や多くの入力パターンに挑戦します。サブテスト名をわかりやすくすると、どのケースが失敗したのかを簡単に特定でき、デバッグがスムーズになります。
テーブル駆動テストを習得すると、Go言語の単体テストが効率よく書けるようになり、コードの品質を高めることができます。