MENU
  1. ホーム
  2. Go
  3. Goのhttptestパッケージを使ったHTTPハンドラのテスト方法

Goのhttptestパッケージを使ったHTTPハンドラのテスト方法

Go
目次

導入文章

Go言語のhttptestパッケージは、HTTPサーバーのユニットテストを行うための便利なツールです。HTTPハンドラのテストは、Webアプリケーションの品質を確保するために非常に重要です。httptestを使用すると、実際にサーバーを立てることなく、ハンドラ関数の動作を検証できます。本記事では、httptestパッケージを使ってHTTPハンドラをテストする方法を、具体的なコード例を交えながら解説します。テストの基本から応用までを学ぶことで、Go言語のテスト技法を効果的に習得できるでしょう。

`httptest`パッケージの基本概念

Goのhttptestパッケージは、HTTPリクエストとレスポンスを模擬するための便利なツールです。このパッケージを使用することで、実際のHTTPサーバーを立てることなく、ハンドラ関数の動作をテストできます。httptestは、特にユニットテストや自動化テストで有用で、HTTPエンドポイントが正しく機能するかを確認するための非常に簡単で効果的な方法を提供します。

`httptest`を使う利点

  • リソースを節約: 実際のサーバーを立てずに、リクエストとレスポンスを模倣することができるため、テストの実行が高速で効率的です。
  • エラーの早期発見: サーバーを立てる必要がなく、開発段階でのエラーを早期に発見できるため、デバッグがしやすくなります。
  • 簡単に統合テストを実行可能: HTTPハンドラを簡単にモックできるので、複雑なシステム間のインタラクションをテストする際にも有用です。

httptestを使用することで、HTTPリクエストを簡単に模倣し、レスポンスをキャプチャすることができるため、ハンドラの動作確認やエラー処理のテストが非常に簡単になります。

`httptest.NewRecorder`の使い方

httptest.NewRecorderは、HTTPレスポンスをキャプチャするためのResponseRecorderを生成します。このResponseRecorderは、HTTPハンドラが生成するレスポンスを内部で保持し、テストの中でそのレスポンス内容を確認できるようにします。これにより、実際のサーバーを起動せずに、HTTPレスポンスを模倣し、ハンドラが正しく動作しているかを検証できます。

`httptest.NewRecorder`の基本的な使い方

httptest.NewRecorderを使用することで、HTTPリクエストを送信した際のレスポンスをキャプチャできます。このレスポンスを利用して、ステータスコードやレスポンスボディ、ヘッダなどをテストできます。

コード例

以下は、httptest.NewRecorderを使ってHTTPハンドラをテストする簡単な例です。

package main

import (
    "fmt"
    "net/http"
    "net/http/httptest"
    "testing"
)

func handler(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintln(w, "Hello, World!")
}

func TestHandler(t *testing.T) {
    // 新しいレスポンスレコーダーを作成
    rr := httptest.NewRecorder()

    // 新しいHTTPリクエストを作成
    req := httptest.NewRequest("GET", "/", nil)

    // ハンドラ関数を呼び出して、レスポンスをレコーダーに記録
    handler(rr, req)

    // ステータスコードを確認
    if status := rr.Code; status != http.StatusOK {
        t.Errorf("handler returned wrong status code: got %v want %v", status, http.StatusOK)
    }

    // レスポンスボディを確認
    expected := "Hello, World!\n"
    if rr.Body.String() != expected {
        t.Errorf("handler returned unexpected body: got %v want %v", rr.Body.String(), expected)
    }
}

解説

  • httptest.NewRecorderでResponseRecorderを作成し、このオブジェクトがHTTPレスポンスをキャプチャします。
  • httptest.NewRequestを使用してテスト用のHTTPリクエストを生成します。このリクエストは、実際のサーバーを立てることなく、ハンドラに渡すことができます。
  • ハンドラを呼び出し、ResponseRecorderにレスポンスを記録します。
  • 最後に、ResponseRecorderのCodeやBodyフィールドを使って、期待したレスポンスが返されるかを確認します。

このように、httptest.NewRecorderを使うことで、HTTPリクエストとレスポンスの詳細を簡単にテストすることができ、サーバーを立てずに効率的にテストを実行できます。

`http.NewRequest`を使ったリクエストの作成

httptestパッケージを使用してHTTPハンドラをテストする際、リクエストを模倣するためにhttp.NewRequestを使用します。この関数を使って、任意のHTTPメソッド（GET、POST、PUTなど）やヘッダ、ボディを指定したリクエストを作成できます。作成したリクエストは、httptestのResponseRecorderと一緒に使用することで、ハンドラがどのようにレスポンスを生成するかをテストできます。

`http.NewRequest`の基本的な使い方

http.NewRequestを使うことで、リクエストを手軽に作成でき、その後、作成したリクエストをテスト対象のハンドラ関数に渡すことができます。この方法により、実際にブラウザを使用してリクエストを送信することなく、プログラム内でリクエストの内容を細かく制御することができます。

コード例

以下は、http.NewRequestを使用してGETリクエストを作成し、それをhttptestでテストする例です。

package main

import (
    "fmt"
    "net/http"
    "net/http/httptest"
    "testing"
)

func handler(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintln(w, "Request Method: ", r.Method)
}

func TestHandlerWithRequest(t *testing.T) {
    // 新しいHTTPリクエストを作成 (GETメソッド)
    req, err := http.NewRequest("GET", "/", nil)
    if err != nil {
        t.Fatal(err)
    }

    // 新しいレスポンスレコーダーを作成
    rr := httptest.NewRecorder()

    // ハンドラ関数を呼び出してレスポンスをレコーダーに記録
    handler(rr, req)

    // ステータスコードを確認
    if status := rr.Code; status != http.StatusOK {
        t.Errorf("handler returned wrong status code: got %v want %v", status, http.StatusOK)
    }

    // レスポンスボディを確認
    expected := "Request Method: GET\n"
    if rr.Body.String() != expected {
        t.Errorf("handler returned unexpected body: got %v want %v", rr.Body.String(), expected)
    }
}

解説

  • http.NewRequestで、リクエストメソッド（この例ではGET）、URL、リクエストボディを指定して新しいリクエストを作成します。
  • リクエストのメソッドやURL、ヘッダ、ボディなどは、テストに応じてカスタマイズできます。
  • httptest.NewRecorderでレスポンスをキャプチャし、作成したリクエストをハンドラに渡して処理します。
  • 最後に、レスポンスコードやレスポンスボディを検証して、ハンドラが期待通りに動作するか確認します。

http.NewRequestを使うことで、リクエストの詳細を柔軟に設定でき、テストケースに合わせて様々なシナリオを模倣できます。これにより、さまざまなHTTPメソッドやパラメータをテストすることが可能になります。

ハンドラ関数のテスト例

Goのhttptestパッケージを使用してHTTPハンドラをテストする際、具体的なコード例を通じてそのテスト方法を理解することが重要です。以下では、シンプルなHTTPハンドラを例に、httptestを使ったテストの実践方法を紹介します。この例では、特定のリクエストに対して適切なレスポンスが返されるかを確認します。

テストするハンドラ関数の例

まず、テスト対象となる簡単なHTTPハンドラを作成します。このハンドラは、リクエストを受け取ると「Hello, World!」というメッセージを返します。

package main

import (
    "fmt"
    "net/http"
)

// ハンドラ関数
func helloHandler(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintln(w, "Hello, World!")
}

テストケースの作成

次に、このハンドラをテストするために、httptest.NewRecorderとhttp.NewRequestを使ってリクエストを作成し、レスポンスを検証するテストケースを作成します。

package main

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

func TestHelloHandler(t *testing.T) {
    // 新しいHTTPリクエストを作成 (GETメソッド)
    req := httptest.NewRequest("GET", "/hello", nil)

    // 新しいレスポンスレコーダーを作成
    rr := httptest.NewRecorder()

    // ハンドラ関数を呼び出してレスポンスをレコーダーに記録
    helloHandler(rr, req)

    // ステータスコードを確認
    if status := rr.Code; status != http.StatusOK {
        t.Errorf("handler returned wrong status code: got %v want %v", status, http.StatusOK)
    }

    // レスポンスボディを確認
    expected := "Hello, World!\n"
    if rr.Body.String() != expected {
        t.Errorf("handler returned unexpected body: got %v want %v", rr.Body.String(), expected)
    }
}

解説

  • httptest.NewRequestを使って、GETメソッドで/helloというパスのリクエストを作成します。このリクエストは、実際にサーバーを立てることなくテスト内で使用されます。
  • httptest.NewRecorderを使用して、ハンドラからのレスポンスをキャプチャするためのResponseRecorderを生成します。
  • 作成したリクエストをhelloHandler関数に渡し、そのレスポンスをResponseRecorderに記録します。
  • テストでは、レスポンスのステータスコードが期待通りhttp.StatusOK（200 OK）であること、およびレスポンスボディが「Hello, World!」という文字列であることを確認します。

テストの結果

テストが成功すれば、HTTPハンドラが正しくリクエストを処理し、期待したレスポンスを返していることが確認できます。httptestを使用することで、HTTPリクエストとレスポンスを簡単に模倣し、ハンドラが適切に動作するかを効率的にテストできます。

このような基本的なテストを行うことで、Webアプリケーションの品質を保ちながら、開発を進めることができます。

ステータスコードのテスト

HTTPレスポンスのステータスコードは、リクエストの結果を示す重要な指標です。httptestパッケージを使うことで、ハンドラが正しいステータスコードを返しているかどうかを簡単にテストできます。ステータスコードは、例えばリクエストが成功した場合は200 OK、リソースが見つからなかった場合は404 Not Foundなど、リクエストの結果に応じて異なります。

ステータスコードのテスト方法

テストでは、ハンドラが返すべきステータスコードが期待通りであるかを確認します。これを確認するためには、httptest.NewRecorderでキャプチャしたレスポンスのCodeフィールドを検証します。

コード例

以下の例では、helloHandlerというシンプルなハンドラが200 OKを返すことをテストしています。

package main

import (
    "fmt"
    "net/http"
    "net/http/httptest"
    "testing"
)

// ハンドラ関数
func helloHandler(w http.ResponseWriter, r *http.Request) {
    w.WriteHeader(http.StatusOK) // ステータスコードを明示的に設定
    fmt.Fprintln(w, "Hello, World!")
}

func TestHelloHandlerStatusCode(t *testing.T) {
    // 新しいHTTPリクエストを作成 (GETメソッド)
    req := httptest.NewRequest("GET", "/hello", nil)

    // 新しいレスポンスレコーダーを作成
    rr := httptest.NewRecorder()

    // ハンドラ関数を呼び出してレスポンスをレコーダーに記録
    helloHandler(rr, req)

    // ステータスコードを確認
    if status := rr.Code; status != http.StatusOK {
        t.Errorf("handler returned wrong status code: got %v want %v", status, http.StatusOK)
    }
}

解説

  • helloHandlerでは、w.WriteHeader(http.StatusOK)を使ってステータスコード200（OK）をレスポンスに設定しています。
  • httptest.NewRequestを使って、GETメソッドでリクエストを作成します。
  • httptest.NewRecorderでレスポンスをキャプチャし、ハンドラを呼び出します。
  • テストでは、レスポンスコードがhttp.StatusOK（200）であることを確認します。もし異なるステータスコードが返された場合、テストは失敗します。

エラー処理と異常系のテスト

エラーハンドリングを行う場合、例えばリソースが見つからなかった場合に404 Not Foundを返すことが期待されます。こうしたエラーケースもテストを通じて確認することが重要です。

コード例

以下は、リソースが見つからない場合に404ステータスコードを返すハンドラの例です。

package main

import (
    "fmt"
    "net/http"
    "net/http/httptest"
    "testing"
)

// ハンドラ関数
func resourceHandler(w http.ResponseWriter, r *http.Request) {
    // 存在しないリソースへのリクエストが来た場合、404を返す
    if r.URL.Path != "/resource" {
        http.NotFound(w, r)
        return
    }
    fmt.Fprintln(w, "Resource found")
}

func TestResourceHandlerStatusCode(t *testing.T) {
    // 存在しないURLへのリクエスト
    req := httptest.NewRequest("GET", "/invalid", nil)

    // 新しいレスポンスレコーダーを作成
    rr := httptest.NewRecorder()

    // ハンドラ関数を呼び出してレスポンスをレコーダーに記録
    resourceHandler(rr, req)

    // ステータスコードが404であることを確認
    if status := rr.Code; status != http.StatusNotFound {
        t.Errorf("handler returned wrong status code: got %v want %v", status, http.StatusNotFound)
    }
}

解説

  • resourceHandlerでは、http.NotFound(w, r)を使用して、リクエストされたリソースが見つからない場合に404ステータスコードを返しています。
  • テストでは、存在しないURLに対してリクエストを送信し、http.StatusNotFound（404）が返されることを確認します。

このように、httptestを使うことで、HTTPレスポンスのステータスコードが期待通りであるかを簡単に確認することができ、アプリケーションの品質向上に役立ちます。

レスポンスボディのテスト

HTTPレスポンスのボディは、クライアントに返されるデータそのものです。httptestパッケージを使用して、ハンドラが期待するレスポンスを正しく生成しているかをテストするために、レスポンスボディの内容を確認することは非常に重要です。特に、文字列やJSONなどの形式で返されるデータの正確性を検証できます。

レスポンスボディのテスト方法

httptest.NewRecorderでキャプチャしたレスポンスのボディは、Bodyフィールドに格納されます。このBodyフィールドは、String()メソッドを使ってレスポンスの内容を文字列として取得することができます。これを使って、ハンドラが返すレスポンスの内容が期待通りであるかをテストします。

コード例

以下は、helloHandlerが「Hello, World!」というメッセージをレスポンスとして返すことを確認するテストの例です。

package main

import (
    "fmt"
    "net/http"
    "net/http/httptest"
    "testing"
)

// ハンドラ関数
func helloHandler(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintln(w, "Hello, World!")
}

func TestHelloHandlerBody(t *testing.T) {
    // 新しいHTTPリクエストを作成 (GETメソッド)
    req := httptest.NewRequest("GET", "/hello", nil)

    // 新しいレスポンスレコーダーを作成
    rr := httptest.NewRecorder()

    // ハンドラ関数を呼び出してレスポンスをレコーダーに記録
    helloHandler(rr, req)

    // レスポンスボディを確認
    expected := "Hello, World!\n"
    if rr.Body.String() != expected {
        t.Errorf("handler returned unexpected body: got %v want %v", rr.Body.String(), expected)
    }
}

解説

  • helloHandler関数では、fmt.Fprintln(w, "Hello, World!")を使ってレスポンスボディとして「Hello, World!」という文字列を返しています。
  • テストケース内で、httptest.NewRecorderを使用してレスポンスをキャプチャし、rr.Body.String()を使ってレスポンスボディの内容を取得します。
  • 期待するレスポンス内容と実際の内容を比較し、一致しない場合にはエラーが発生するようにしています。

JSONレスポンスのテスト

Webアプリケーションでは、APIレスポンスとしてJSONデータを返すことが多いです。httptestを使用して、JSONレスポンスが正しく生成されているかをテストする方法を紹介します。

コード例

以下は、JSONデータをレスポンスとして返すハンドラの例です。

package main

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

// ハンドラ関数
func jsonHandler(w http.ResponseWriter, r *http.Request) {
    data := map[string]string{"message": "Hello, World!"}
    w.Header().Set("Content-Type", "application/json")
    json.NewEncoder(w).Encode(data)
}

func TestJsonHandlerBody(t *testing.T) {
    // 新しいHTTPリクエストを作成 (GETメソッド)
    req := httptest.NewRequest("GET", "/json", nil)

    // 新しいレスポンスレコーダーを作成
    rr := httptest.NewRecorder()

    // ハンドラ関数を呼び出してレスポンスをレコーダーに記録
    jsonHandler(rr, req)

    // レスポンスボディを確認
    expected := `{"message":"Hello, World!"}` + "\n"
    if rr.Body.String() != expected {
        t.Errorf("handler returned unexpected body: got %v want %v", rr.Body.String(), expected)
    }
}

解説

  • jsonHandlerでは、map[string]stringを使ってJSONデータを作成し、json.NewEncoder(w).Encode(data)でレスポンスボディとしてJSONデータを返しています。
  • テストケース内で、httptest.NewRecorderを使ってレスポンスをキャプチャし、rr.Body.String()でJSONデータを文字列として取得します。
  • 期待するJSONレスポンスと実際のレスポンスを比較して、一致することを確認します。

このように、レスポンスボディをテストすることで、ハンドラが正しいデータを返しているかを確認できます。特にAPI開発では、レスポンスの形式が重要なので、しっかりとテストを行うことが求められます。

リクエストヘッダとレスポンスヘッダのテスト

HTTPリクエストとレスポンスのヘッダは、クライアントとサーバー間での通信において重要な役割を果たします。リクエストヘッダにはクライアントの情報や要求内容、レスポンスヘッダにはサーバーからの情報（例えばコンテンツタイプやキャッシュ制御）などが含まれます。httptestパッケージを使って、リクエストとレスポンスのヘッダを検証することは、HTTPハンドラのテストにおいて非常に重要です。

リクエストヘッダのテスト方法

http.NewRequestを使って、リクエストにヘッダを追加することができます。httptest.NewRecorderを使用してレスポンスをキャプチャし、リクエストヘッダが正しく処理されているかを確認するテストが可能です。

コード例

以下は、リクエストヘッダにContent-Typeを設定して、サーバー側でそのヘッダを確認するテストの例です。

package main

import (
    "fmt"
    "net/http"
    "net/http/httptest"
    "testing"
)

// ハンドラ関数
func headerHandler(w http.ResponseWriter, r *http.Request) {
    contentType := r.Header.Get("Content-Type")
    fmt.Fprintf(w, "Content-Type: %s", contentType)
}

func TestHeaderHandler(t *testing.T) {
    // 新しいHTTPリクエストを作成 (GETメソッド) そしてヘッダを追加
    req := httptest.NewRequest("GET", "/header", nil)
    req.Header.Set("Content-Type", "application/json")

    // 新しいレスポンスレコーダーを作成
    rr := httptest.NewRecorder()

    // ハンドラ関数を呼び出してレスポンスをレコーダーに記録
    headerHandler(rr, req)

    // レスポンスボディを確認
    expected := "Content-Type: application/json"
    if rr.Body.String() != expected {
        t.Errorf("handler returned unexpected body: got %v want %v", rr.Body.String(), expected)
    }
}

解説

  • headerHandler関数では、リクエストヘッダからContent-Typeを取得し、レスポンスボディとしてその値を返しています。
  • テスト内で、httptest.NewRequestを使ってContent-Typeヘッダを設定し、httptest.NewRecorderでレスポンスをキャプチャします。
  • 最後に、レスポンスボディが期待通り「Content-Type: application/json」であることを確認します。

レスポンスヘッダのテスト方法

レスポンスヘッダを検証することも重要です。サーバーが適切なレスポンスヘッダ（例えば、Content-TypeやCache-Control）を返しているかを確認します。ResponseRecorderを使ってレスポンスヘッダを検証することができます。

コード例

以下は、レスポンスヘッダにContent-Typeを設定して、その値を確認するテストの例です。

package main

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

// ハンドラ関数
func responseHeaderHandler(w http.ResponseWriter, r *http.Request) {
    w.Header().Set("Content-Type", "application/json")
    w.Write([]byte(`{"message": "Hello, World!"}`))
}

func TestResponseHeaderHandler(t *testing.T) {
    // 新しいHTTPリクエストを作成 (GETメソッド)
    req := httptest.NewRequest("GET", "/response-header", nil)

    // 新しいレスポンスレコーダーを作成
    rr := httptest.NewRecorder()

    // ハンドラ関数を呼び出してレスポンスをレコーダーに記録
    responseHeaderHandler(rr, req)

    // レスポンスヘッダを確認
    if contentType := rr.Header().Get("Content-Type"); contentType != "application/json" {
        t.Errorf("handler returned wrong Content-Type header: got %v want %v", contentType, "application/json")
    }
}

解説

  • responseHeaderHandler関数では、w.Header().Set("Content-Type", "application/json")を使用して、レスポンスヘッダにContent-Typeを設定しています。
  • httptest.NewRecorderでレスポンスをキャプチャし、rr.Header().Get("Content-Type")で実際のレスポンスヘッダを取得します。
  • テストでは、レスポンスヘッダのContent-Typeが期待通り"application/json"であることを確認します。

まとめ

リクエストヘッダとレスポンスヘッダは、HTTP通信において重要な情報を保持しているため、正しく設定されていることを確認することが不可欠です。httptestを使うことで、これらのヘッダの値を簡単に検証でき、HTTPハンドラの挙動を正確にテストできます。

テストの自動化と組み込み

HTTPハンドラのテストを自動化することは、ソフトウェアの品質向上に非常に重要です。テストの自動化により、開発者はコードを変更するたびに手動でテストを実行する必要がなくなり、バグを早期に発見できます。特に、CI/CD（継続的インテグレーション／継続的デリバリー）パイプラインに組み込むことで、コードの変更が行われるたびに自動的にテストを実行し、品質を保つことができます。

CI/CDパイプラインにテストを組み込む方法

Goのテストフレームワークは、go testコマンドを使用して簡単に実行できます。このコマンドをCIツール（例: GitHub Actions、CircleCI、GitLab CIなど）で実行することにより、コードがリポジトリにプッシュされるたびに自動でテストを実行できます。

コード例: GitHub Actionsでの自動テスト

以下は、GitHub Actionsを使ってGoのテストを自動で実行する設定例です。

name: Go Test Workflow

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  test:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Set up Go
        uses: actions/setup-go@v2
        with:
          go-version: '1.19'

      - name: Install dependencies
        run: |
          go mod tidy

      - name: Run tests
        run: |
          go test -v ./...

解説

  • GitHub Actionsは、コードがmainブランチにプッシュされたり、プルリクエストが作成されるたびに自動的にテストを実行します。
  • actions/checkoutでリポジトリのコードをチェックアウトし、actions/setup-goを使ってGoのバージョンを指定します。
  • go mod tidyで依存関係を整理し、go test -v ./...でGoのテストを実行します。

テストの結果を確認する方法

CI/CDツールでは、テストの結果をログとして表示したり、通知を送ったりすることができます。これにより、テストが失敗した場合にすぐに気づき、素早く対応できます。例えば、GitHub Actionsでは、テストが失敗した場合にPRのチェックとして表示されるため、レビュアーはテストが通るまでコードをマージしません。

テストのカバレッジの確認

テストのカバレッジ（テストがコード全体のどの程度を網羅しているか）を確認することも重要です。go testはカバレッジを出力する機能を持っており、カバレッジレポートを生成して、どのコードがテストされていないかを可視化できます。

コード例: カバレッジレポートの生成

以下のコマンドで、テストのカバレッジを生成することができます。

go test -coverprofile=coverage.out
go tool cover -html=coverage.out

解説

  • go test -coverprofile=coverage.outで、テストカバレッジ情報をcoverage.outファイルに保存します。
  • go tool cover -html=coverage.outで、HTML形式のカバレッジレポートを生成し、ブラウザで確認できます。

まとめ

テストの自動化とCI/CDパイプラインへの組み込みにより、コードの変更ごとに手動でテストを実行する手間を省き、バグを早期に発見できます。go testを使って、テストの実行、カバレッジの確認、さらにはCIツールによる自動化を行うことで、Goでの開発における品質を効率的に管理できます。

エラーハンドリングとテストの工夫

エラーハンドリングは、堅牢なWebアプリケーションを構築するために欠かせない部分です。HTTPリクエストに対して適切にエラーレスポンスを返すことは、ユーザーエクスペリエンスの向上に繋がり、システムの信頼性を高めます。httptestを使ったテストでは、異常系やエラーパスに対して適切なレスポンスが返されるかを確認することが重要です。この記事では、エラーハンドリングのテスト方法を解説します。

エラーハンドリングの基本

エラーハンドリングの基本は、クライアントからのリクエストに対して、何らかの問題が発生した場合に適切なHTTPステータスコードを返すことです。たとえば、リクエストされたリソースが見つからない場合には404（Not Found）、サーバーエラーが発生した場合には500（Internal Server Error）を返します。

エラーを返すハンドラの例

以下は、リクエストされたリソースが存在しない場合に404エラーを返すハンドラの例です。

package main

import (
    "fmt"
    "net/http"
    "net/http/httptest"
    "testing"
)

// ハンドラ関数
func errorHandler(w http.ResponseWriter, r *http.Request) {
    if r.URL.Path != "/resource" {
        http.NotFound(w, r) // リソースが見つからない場合は404を返す
        return
    }
    fmt.Fprintln(w, "Resource found")
}

func TestErrorHandler(t *testing.T) {
    // 存在しないリソースへのリクエスト
    req := httptest.NewRequest("GET", "/invalid", nil)

    // 新しいレスポンスレコーダーを作成
    rr := httptest.NewRecorder()

    // ハンドラ関数を呼び出してレスポンスをレコーダーに記録
    errorHandler(rr, req)

    // ステータスコードが404であることを確認
    if status := rr.Code; status != http.StatusNotFound {
        t.Errorf("handler returned wrong status code: got %v want %v", status, http.StatusNotFound)
    }

    // レスポンスボディを確認
    expected := "404 page not found\n"
    if rr.Body.String() != expected {
        t.Errorf("handler returned unexpected body: got %v want %v", rr.Body.String(), expected)
    }
}

解説

  • errorHandler関数では、リクエストされたURLが/resourceでない場合、http.NotFound(w, r)を使用して404エラーを返しています。
  • テストケース内では、httptest.NewRequestを使って存在しないリソースにアクセスするリクエストを作成し、httptest.NewRecorderでレスポンスをキャプチャします。
  • ステータスコードがhttp.StatusNotFound（404）であること、レスポンスボディが予想されるエラーメッセージであることを確認します。

500エラーのテスト

サーバー内で予期しないエラーが発生した場合、500（Internal Server Error）を返すことが一般的です。以下は、サーバー側のエラーをシミュレートし、500エラーを返すハンドラの例です。

package main

import (
    "fmt"
    "net/http"
    "net/http/httptest"
    "testing"
)

// ハンドラ関数
func serverErrorHandler(w http.ResponseWriter, r *http.Request) {
    http.Error(w, "Internal Server Error", http.StatusInternalServerError) // サーバーエラーを返す
}

func TestServerErrorHandler(t *testing.T) {
    // 新しいHTTPリクエストを作成 (GETメソッド)
    req := httptest.NewRequest("GET", "/error", nil)

    // 新しいレスポンスレコーダーを作成
    rr := httptest.NewRecorder()

    // ハンドラ関数を呼び出してレスポンスをレコーダーに記録
    serverErrorHandler(rr, req)

    // ステータスコードが500であることを確認
    if status := rr.Code; status != http.StatusInternalServerError {
        t.Errorf("handler returned wrong status code: got %v want %v", status, http.StatusInternalServerError)
    }

    // レスポンスボディを確認
    expected := "Internal Server Error\n"
    if rr.Body.String() != expected {
        t.Errorf("handler returned unexpected body: got %v want %v", rr.Body.String(), expected)
    }
}

解説

  • serverErrorHandler関数では、http.Error(w, "Internal Server Error", http.StatusInternalServerError)を使用して、500エラーを返しています。
  • テスト内では、httptest.NewRequestを使ってリクエストを作成し、httptest.NewRecorderでレスポンスをキャプチャします。
  • ステータスコードが500（Internal Server Error）であること、レスポンスボディが適切なエラーメッセージを含んでいることを確認します。

エラーハンドリングのテストで考慮すべき点

エラーハンドリングをテストする際には、以下の点を考慮することが重要です。

  • 適切なステータスコードの確認: エラー時に適切なHTTPステータスコード（404, 500など）が返されていることを確認します。
  • エラーメッセージの検証: レスポンスボディに含まれるエラーメッセージが予想通りであることを確認します。ユーザーには詳細なエラーメッセージを返さず、一般的なエラーメッセージを返すようにしましょう。
  • 異常系のシミュレーション: サーバーエラーや404エラー以外にも、さまざまなエラーケース（400 Bad Request、403 Forbiddenなど）に対応したテストを行います。

まとめ

エラーハンドリングとそのテストは、堅牢なアプリケーションを開発するために不可欠です。httptestパッケージを使用することで、異常系のテストを簡単に行い、予期しないエラーに対する対応が適切であることを確認できます。エラーハンドリングを適切に行うことで、ユーザーにとって使いやすく、安全なアプリケーションを提供できます。

まとめ

本記事では、Go言語のhttptestパッケージを使用して、HTTPハンドラのテスト方法を詳細に解説しました。httptestを活用することで、実際のサーバーを立てることなく、効率的にHTTPリクエストとレスポンスの動作をテストできます。具体的には、リクエストの作成、レスポンスの確認、ヘッダやボディのテスト、エラーハンドリングの確認など、さまざまなテストケースを通じて、Goアプリケーションの品質を高める方法を紹介しました。

さらに、CI/CDパイプラインにテストを組み込む方法や、テストカバレッジの確認方法も解説しました。自動化されたテストにより、コード変更時に品質を保ちながら迅速に開発を進めることができます。

エラーハンドリングのテストも重要で、予期しないエラーが発生した場合でも、適切なレスポンスが返されることを確認することが、堅牢なアプリケーションを構築するためには欠かせません。

httptestパッケージを使えば、GoでのHTTPハンドラのテストが簡単になり、テスト駆動開発（TDD）の実践にも役立ちます。

Go
テスト Go httptest HTTPハンドラ

コメント

コメントする

目次