Flute - Golang HTTP Client testing framework (Go Conference'19 Summer in Fukuoka)

Go Conference'19 Summer in Fukuoka で LT枠で発表したスライドです。
元々発表予定ではなかったのですが、LT枠があるということで急遽発表させていただきました。
スライドは発表当時のものに若干加筆修正をしています。

Go で API クライアントのテストを楽に(宣言的に)記述するためのフレームワークをOSS として自作したので、それの紹介です。
https://github.com/suzuki-shunsuke/flute

---

2019-07-16 追記
※ プロジェクト名が変わりました(旧Fagott)
https://github.com/suzuki-shunsuke/flute/issues/20

Transcript

1. Flute ‒ Go HTTP Client Testing Framework 2019-07-13 Go Conference'19 Summer in Fukuoka Shunsuke Suzuki 1
2. ⾃⼰紹介 https://github.com/suzuki-shunsuke/profile 東京から来ました 社内システムやOSSをGoで開発してます 2
3. 元々発表する予定はなかったのですが、LT枠があるということを当⽇知り、 折⾓のチャンスなので急遽発表させていただきました 3
4. 今⽇話すこと ⾃作のOSS (HTTP Client Testing Framework) の紹介 いかに API クライアントのテストを楽に書くか 4
5. 皆さん、APIクライアント書いてますか？ 5
6. APIクライアントのテスト書いてますか？ 6
7. APIクライアントのテスト 正しいリクエストを送っているか • method, リクエストパス, クエリ, ヘッダ • リクエストボディ、etc 正しくレスポンスを処理しているか • レスポンスボディのパース 7
8. APIクライアントのテスト 正しいリクエストを送っているか • method, リクエストパス, クエリ, ヘッダ • リクエストボディ、etc 正しくレスポンスを処理しているか • レスポンスボディのパース 8 どのAPIでもやってることは同じ フレームワーク化して楽したい
9. 既存のライブラリ 他に使えそうなライブラリは⾊々ある • https://github.com/avelino/awesome-go#testing • https://github.com/h2non/gock • https://github.com/seborama/govcr • https://github.com/jarcoal/httpmock • https://github.com/tv42/mockhttp • https://github.com/gavv/httpexpect • https://github.com/dnaeon/go-vcr • https://github.com/h2non/baloo 9
10. • モック化出来るものは多いが、リクエストパラメータのテスト できるものは少ない • 今まで gock を使ってたが、リクエストがマッチしなくてテス トに失敗しても理由がわからないので不便 • ニーズに合うのが⾒つからない 10
11. • モック化出来るものは多いが、リクエストパラメータのテスト できるものは少ない • 今まで gock を使ってたが、リクエストがマッチしなくてテス トに失敗しても理由がわからないので不便 • ニーズに合うのが⾒つからない 11 なければ⾃作しよう
12. Go でいかにモックを書くか • httptest で簡単なモックサーバを起動 • http.RoundTripper を実装 12
13. Go でいかにモックを書くか • httptest で簡単なモックサーバを起動 • テストまで含めると実装が⾯倒 • client のエンドポイントを修正できないとモック化が難しい • http.RoundTripper を実装 13
14. Go でいかにモックを書くか • httptest で簡単なモックサーバを起動 • http.RoundTripper を実装: 今回はこっち 14
15. 作ったやつ: Flute • https://github.com/suzuki-shunsuke/flute • Go の HTTP client のテスティングフレームワーク 15
16. 作ったやつ: Flute • https://github.com/suzuki-shunsuke/flute • Go の HTTP client のテスティングフレームワーク 16 プロジェクト名が変わりました(旧 Fagott) https://github.com/suzuki-shunsuke/flute/issues/20 2019-07-16 追記
17. Flute で出来ること • リクエストパラメータのテスト • リクエストボディ、method, リクエストパス, クエリ, ヘッダ, ユーザー定義関数 • HTTPサーバのモック化 17
18. サンプル: ユーザー作成の簡単なクライアント 18
19. 19 https://github.com/suzuki-shunsuke/flute/blob/master/examples/create_user.go
20. 20 *http.Client.Transport に *flute.Transport を渡す
22. 22 1. Matcher にマッチしたリクエストを 2. Tester でテストし 3. Response で指定したレスポンスを返す
23. 23 テストケースを宣⾔的に記述するだけでよい
24. リクエストパラメータのテスト • 内部で testify の assert を使っている • テストにコケたときに原因が分かりやすい 24
25. 25 例: ヘッダが期待通りじゃなかった場合
26. まとめ • APIクライアントのテストのフレームワークを作りました • HTTPサーバのモック化だけでなく、 リクエストパラメータのテストも出来ます • 基本的なテストはテストケースを宣⾔的に書くだけ • Goではhttp.RoundTripper を活⽤すると簡単にモック化出来ます 26