🐁
Go の ogen でテストを実装する３つのパターン
はじめに
ogen 関連シリーズ第３弾です。
シリーズ化するとともに ogen がどんどん好きになっています。
第１弾
第２弾
今回は ogen でテストを実装する際に使える３つのパターンをご紹介します。
ogen
OpenAPI からコードを自動生成することができ、以下のような特徴があります。
- 生成されたコードで refrect や interface{} を使わない
- 独自のルーティング機構
- 標準の OpenAPI v3 で完結
- Optional や Nullable に対応
- OpenTelemetry に対応
３つのテストパターン
今回紹介する３つのパターンは以下の通りです。
- Handler パターン
- httptest.NewRecoder() パターン
- httptest.NewServer() パターン
メリットデメリットを記載していますが、一般論ではなく筆者体感です。あらかじめご了承ください。
Handler パターン
ogen の interface を満たすために実装したメソッドに対して直接テストを実行する方法です。
メリット
- 対象のメソッドに対して
Generate Unit Tests For Functionなどでで自動生成が行える - テーブル駆動テストが書きやすい
デメリット
-
Convenient errorsに対してテストができない
httptest.NewRecoder() パターン
net/http/httptest の NewRecorder を使ってテストを実行する方法です。
メリット
- ogen によらないリクエスト値を設定できる
- Convenient errors に対してテストができる
デメリット
- 正常系と異常系の型が異なるのでテーブル駆動テストが書きづらい（センスが必要）
httptest.NewServer() パターン
net/http/httptest の NewServer を使って実際にサーバーを起動しそこに対してテストを実行する方法です。
メリット
- ogen のクライアント生成コードを使ってテストが書ける（使い方を提示できる）
デメリット
- レスポンスの型が異なるのでテーブル駆動テストが書きづらい（センスが必要）
- クライアントの実装が必要なので少しめんどくさい
おわりに
個人的には httptest.NewRecoder を利用したパターンがお気に入りです。
（ほかにもあるかもしれません。ありましたら教えてください！）
今回実装したコードは以下に置いておきます。
Discussion