[Goのはじめ方] Part27: ユニットテストの書き方（testingパッケージ）

ソフトウェア開発において、書いたコードが期待通りに動作するかを確認することは非常に重要です。手動で確認することもできますが、コードが複雑になったり、変更が頻繁に発生したりすると、手動テストだけでは限界があります。

そこで登場するのがユニットテストです。ユニットテストは、プログラムの比較的小さな単位（関数やメソッドなど）が、個々に正しく機能するかどうかを検証するテストです。Go言語では、標準パッケージとして testing が提供されており、これを使って簡単にユニットテストを記述できます。

ユニットテストを書くことには、以下のようなメリットがあります。

• バグの早期発見： コードを書いた直後にテストを実行することで、バグを早期に発見し、修正コストを抑えることができます。
• リファクタリングの安心感： テストがあれば、コードの内部構造を変更（リファクタリング）する際に、意図しない動作変更（デグレード）が発生していないかをすぐに確認できます。
• コードの品質向上： テストしやすいコードを書こうと意識することで、自然とモジュール性が高く、疎結合な設計になります。
• 仕様のドキュメント化： テストコードは、その関数やメソッドがどのように動作すべきかを示す生きたドキュメントにもなります。

このセクションでは、testing パッケージを使った基本的なユニットテストの書き方を学んでいきましょう！✨

Goでユニットテストを書く際の基本的なルールを見ていきましょう。

1. テストファイルの命名規則

テストコードは、テスト対象のコードと同じディレクトリに配置し、ファイル名の末尾を _test.go とします。例えば、calc.go というファイルのテストは calc_test.go というファイルに記述します。

2. テスト関数の命名規則とシグネチャ

テスト関数は、以下のルールに従って定義します。

• 関数名は Test で始まり、その後にテスト対象の関数名などを続けます（例: TestAdd）。
• 引数には *testing.T 型のポインタを一つだけ取ります。
• 戻り値はありません。

*testing.T 型は、テストの失敗を報告したり、ログを出力したりするためのメソッドを提供します。

package mypackage

import "testing"

// Add関数をテストする例
func TestAdd(t *testing.T) {
    // テスト対象の関数を呼び出す
    result := Add(1, 2)
    expected := 3

    // 結果が期待通りか検証する
    if result != expected {
        // エラーを報告 (テストは続行される)
        t.Errorf("Add(1, 2) = %d; want %d", result, expected)
    }
}

// このテストに対応するAdd関数（例）
func Add(a, b int) int {
    return a + b
}

3. `*testing.T` の主なメソッド

*testing.T 型の変数（慣例的に t）を使って、テストの結果を報告します。よく使われるメソッドには以下のようなものがあります。

Error/Errorf はテストを失敗とマークした後も処理を続行するため、一つのテスト関数内で複数のチェックを行いたい場合に便利です。一方、Fatal/Fatalf は致命的なエラーが発生し、それ以降のチェックが無意味な場合（例：期待したオブジェクトがnilだった場合など）に使用します。

テストコードを記述したら、ターミナルで go test コマンドを実行してテストを走らせます。

基本的な実行

テストを実行したいパッケージのディレクトリに移動し、以下のコマンドを実行します。

go test

テストがすべて成功すると、通常は以下のようなシンプルなメッセージが表示されます。

PASS
ok      your/package/name   0.123s

テストが失敗した場合は、失敗したテスト関数名と t.Error や t.Fatal で指定したメッセージが表示されます。

--- FAIL: TestAdd (0.00s)
    calc_test.go:13: Add(1, 2) = 4; want 3
FAIL
exit status 1
FAIL    your/package/name   0.456s

詳細なログの表示 (Verbose)

各テスト関数の実行結果や t.Log で出力したメッセージを確認したい場合は、-v オプションを付けます。

go test -v

これにより、成功したテストも含めて、各テストの実行状況が詳細に表示されます。

=== RUN   TestAdd
--- PASS: TestAdd (0.00s)
PASS
ok      your/package/name   0.789s

特定のテストを実行

特定のテスト関数だけを実行したい場合は、-run オプションに正規表現でテスト関数名を指定します。

# TestAdd 関数のみを実行
go test -v -run ^TestAdd$

# Test で始まるすべての関数を実行（基本と同じ）
go test -v -run Test

# Add に関連するテスト（TestAdd, TestAddMultiple など）を実行
go test -v -run Add

他の多くのテストフレームワークとは異なり、Goの testing パッケージには、assert.Equal(t, expected, actual) のような組み込みのアサーション関数は提供されていません。

Goでは、標準的な if 文を使って結果を検証し、期待通りでない場合に t.Error, t.Errorf, t.Fatal, t.Fatalf を呼び出すのが基本的なスタイルです。

func TestAdd(t *testing.T) {
    result := Add(1, 2)
    expected := 3
    if result != expected {
        // これがGo標準のアサーションスタイル
        t.Errorf("got %d, want %d", result, expected)
    }

    result2 := Add(-1, -2)
    expected2 := -3
    if result2 != expected2 {
        t.Errorf("got %d, want %d", result2, expected2)
    }
}

毎回 if 文を書くのが冗長だと感じる場合は、以下のような方法があります。

• テストヘルパー関数を作成する： プロジェクト内で共通のアサーション処理を行うヘルパー関数を定義する。
• 外部のアサーションライブラリを利用する： testify/assert や google/go-cmp などの人気のあるサードパーティライブラリを使う。これらは豊富なアサーション関数を提供します。
  注意： 外部ライブラリを導入すると依存関係が増えます。プロジェクトのポリシーに合わせて検討しましょう。まずは標準パッケージのスタイルに慣れることをお勧めします。

Goの標準的なアプローチはシンプルですが、テストの意図を明確にコードで表現することが求められます。

同じ関数に対して、複数の異なる入力と期待される出力の組み合わせでテストを行いたい場合、テーブル駆動テストという手法が非常に便利です。

これは、テストケース（入力値と期待値のペア）を構造体のスライス（テーブル）として定義し、ループ処理で各テストケースを実行する書き方です。

テーブル駆動テストのメリット

• テストケースの追加・削除が容易： テーブルに新しい構造体要素を追加/削除するだけで、テストケースを簡単に増やしたり減らしたりできます。
• コードの重複削減： テストの実行ロジックは共通化され、テストケースごとにコードをコピー＆ペーストする必要がなくなります。
• 可読性の向上： どのような入力に対してどのような出力が期待されるのかが、テーブルを見るだけで分かりやすくなります。
• エラーメッセージの改善： 各テストケースに名前をつけることで、どのケースで失敗したかが明確になります。

テーブル駆動テストの書き方

Add 関数をテーブル駆動テストで書き直してみましょう。

package mypackage

import "testing"

func TestAddTableDriven(t *testing.T) {
    // テストケースを定義する構造体スライス
    testCases := []struct {
        name     string // テストケース名
        inputA   int
        inputB   int
        expected int
    }{
        {"Positive numbers", 1, 2, 3},
        {"Negative numbers", -1, -2, -3},
        {"Zero", 0, 0, 0},
        {"Positive and Negative", 5, -3, 2},
    }

    // 各テストケースをループで実行
    for _, tc := range testCases {
        // t.Run を使うと、各テストケースがサブテストとして扱われ、
        // 失敗時にどのケースで失敗したか分かりやすくなる
        t.Run(tc.name, func(t *testing.T) {
            result := Add(tc.inputA, tc.inputB)
            if result != tc.expected {
                t.Errorf("Add(%d, %d) = %d; want %d", tc.inputA, tc.inputB, result, tc.expected)
            }
        })
    }
}

この例では、testCases というスライスに、各テストケースを表す無名構造体を格納しています。各構造体は、テストケース名 (name)、入力値 (inputA, inputB)、期待される結果 (expected) をフィールドとして持っています。

for ループ内で、t.Run(name, func(t *testing.T)) を使用しています。t.Run を使うと、各テストケースが個別のサブテストとして実行されます。これにより、go test -v で実行した際に各テストケース名が表示されたり、go test -run TestAddTableDriven/Positive_numbers のように特定のサブテストだけを実行したりすることが可能になります。失敗した場合も、どのテストケース（例：--- FAIL: TestAddTableDriven/Negative_numbers (0.00s)）で失敗したかが明確に分かり、デバッグが容易になります。

多くのGoプロジェクトで、このテーブル駆動テストが広く採用されています。

テストカバレッジは、テストコードによって実行されたソースコードの割合を示す指標です。カバレッジが高いほど、コードの多くの部分がテストによって検証されていることを意味します（ただし、カバレッジ100%が必ずしもバグがないことを保証するわけではありません）。

Goでは、go test コマンドに -cover オプションを付けることで、簡単にテストカバレッジを計測できます。

go test -cover

実行結果には、カバレッジのパーセンテージが表示されます。

PASS
coverage: 100.0% of statements
ok      your/package/name   0.135s

さらに詳細なカバレッジレポートを生成することも可能です。-coverprofile オプションでカバレッジ情報をファイルに出力し、go tool cover コマンドでHTML形式のレポートを生成できます。

# カバレッジプロファイルを出力
go test -coverprofile=coverage.out

# HTMLレポートを生成してブラウザで開く
go tool cover -html=coverage.out

このHTMLレポートでは、ソースコードのどの行がテストで実行され、どの行が実行されなかったかが色分けされて表示されるため、テストが不足している箇所を特定するのに役立ちます。

このセクションでは、Go言語の標準 testing パッケージを使ったユニットテストの基本的な書き方、実行方法、テーブル駆動テスト、カバレッジ計測について学びました。

ユニットテストは、コードの品質を維持し、自信を持って開発を進めるための重要なプラクティスです。最初は少し手間に感じるかもしれませんが、慣れてくるとその効果を実感できるはずです。

ぜひ、ご自身のコードにも積極的にユニットテストを取り入れてみてください！🚀