httptestによるHTTPハンドラのテスト

Web API のハンドラは、実サーバを起動しなくても httptest パッケージを使ってメモリ上でテストできます。テスト対象のハンドラに擬似的なリクエストを送り、レスポンスを検証する形です。

1. httptestの用途

Web API のハンドラは、実サーバを起動しなくても httptest パッケージを使ってメモリ上でテストできます。テスト対象のハンドラに擬似的なリクエストを送り、レスポンスを検証する形です。

2. 対象コードの用意

handler.go を作成し、以下を保存します。ヘルスチェック用の単純な HTTP ハンドラです。

package testdemo

import (
    "encoding/json"
    "net/http"
)

func HealthHandler(w http.ResponseWriter, r *http.Request) {
    w.Header().Set("Content-Type", "application/json")
    w.WriteHeader(http.StatusOK)
    json.NewEncoder(w).Encode(map[string]string{"status": "ok"})
}

コードを解説します。

func HealthHandler(w http.ResponseWriter, r *http.Request) {

net/http のハンドラ関数の標準シグネチャです。第1引数の w にレスポンスを書き込み、第2引数の r からリクエストを読み取ります。

w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
json.NewEncoder(w).Encode(map[string]string{"status": "ok"})

Content-Type ヘッダをJSONに設定し、ステータス 200 を返した上で、{"status": "ok"} を JSON でエンコードして書き込んでいます。

3. テストの記述

httptest を使うと、実サーバを起動せずにハンドラを呼び出してレスポンスを検証できます。書き方は以下のとおりです。

req := httptest.NewRequest(HTTPメソッド, "パス", ボディ)   // 擬似リクエストを作る
rec := httptest.NewRecorder()                             // レスポンスを記録する ResponseWriter
ハンドラ関数(rec, req)                                    // ハンドラを直接呼び出す

// 検証は rec.Code(ステータス)や rec.Body(ボディ)で行う

handler_test.go を作成し、以下を保存します。

package testdemo

import (
    "encoding/json"
    "net/http"
    "net/http/httptest"
    "testing"
)

func TestHealthHandler(t *testing.T) {
    req := httptest.NewRequest(http.MethodGet, "/health", nil)
    rec := httptest.NewRecorder()

    HealthHandler(rec, req)

    if rec.Code != http.StatusOK {
        t.Fatalf("status = %d, want %d", rec.Code, http.StatusOK)
    }

    var body map[string]string
    if err := json.NewDecoder(rec.Body).Decode(&body); err != nil {
        t.Fatalf("JSONデコード失敗: %v", err)
    }
    if body["status"] != "ok" {
        t.Errorf("status field = %q, want %q", body["status"], "ok")
    }
}

コードを解説します。

req := httptest.NewRequest(http.MethodGet, "/health", nil)

httptest.NewRequest は擬似リクエストを作るヘルパです。GET でパス /health、ボディなし、を意味します。

rec := httptest.NewRecorder()
HealthHandler(rec, req)

httptest.NewRecorder はレスポンスを記録する http.ResponseWriter の実装です。ハンドラをそのまま呼び出せば、rec にステータス・ヘッダ・ボディが記録されます。

if rec.Code != http.StatusOK { ... }

rec.Code にステータスコードが入ります。ボディは rec.Body(*bytes.Buffer)から読めます。

実行してテストが通ることを確認します。

go test -v -run TestHealthHandler

以下のような実行結果が表示されます。

=== RUN   TestHealthHandler
--- PASS: TestHealthHandler (0.00s)
PASS