Dive into gomock / Go Conference 2024

Go Conference 2024
https://gocon.jp/2024/

Blog (in Japanese): https://blog.utgw.net/entry/2024/06/08/181746

Transcript

1. Dive into gomock id:utgwkk / @utgwkk (うたがわきき) 2024/06/08 Go Conference 2024
2. 自己紹介 • うたがわきき (@utgwkk) • 株式会社はてな ◦ Webアプリケーションエンジニア ◦ 京都から来ました • 好きなパッケージ ◦ reflect
3. 今日のおしながき • interfaceを使ったモックについて復習する • gomock/mockgenについて知る • gomockを使ったテストの処理の流れを知る • gomockの内部的な仕組みを知る
4. なぜinterfaceに依存するのか • 実装の詳細をドメインロジックから切り離す ◦ DBアクセス、HTTP APIコールなど ◦ モックしてテストを書きやすくする • interfaceを介して実装を差し替え可能にする ◦ 動的な言語と異なり、あらゆるメソッドが最初から モック可能なわけではない
5. interfaceを定義する type UserStore interface { FindUserById( ctx context.Context, userId model.UserId, ) (*model.User, error) }
6. interfaceのメソッドを呼ぶ func (s *BlogService) RegisterNewBlog(...) { // ログインユーザーの存在確認 user, err := s.userStore.FindUserById( ctx, session.UserId, ) // ... }
7. テストを書くには？ s := NewBlogService(...) // UserStore.FindUserById メソッドが、 // (*, model.UserId("user")) という引数で呼ばれることを期待 し、 // 呼ばれたら (&model.User{}, nil) を返す。 // もしメソッド呼び出しがなければテストは失敗する。 blog, err := s.RegisterNewBlog(...)
8. interfaceのモックを使ってテストする • さまざまなライブラリ・流派がある ◦ go.uber.org/mock (gomock, mockgen) ◦ github.com/stretchr/testify/mock (mockery) ◦ github.com/gojuno/minimock ◦ 自作する ◦ ほか
9. interfaceのモックを使ってテストする • さまざまなライブラリ・流派がある ◦ go.uber.org/mock (gomock, mockgen) ◦ github.com/stretchr/testify/mock (mockery) ◦ github.com/gojuno/minimock ◦ 自作する ◦ ほか
10. go.uber.org/mock (gomock) • https://github.com/uber-go/mock • モックフレームワーク ◦ mockgen (後述) で生成したinterfaceのモック実装と 組み合わせて使う • もともとはGoogleがメンテナンスしていた ◦ Uberがメンテナを引き継いだ
11. mockgen • gomockを使ったinterfaceのモック実装を生 成するコマンドラインツール • go generateと組み合わせて利用可能 ◦ //go:generate mockgen ...
12. gomockでテストを書く ctrl := gomock.NewController(t) m := mock_repo.NewMockUserStore(ctrl) s := NewBlogService(m, ...) m.EXPECT(). FindUserById(gomock.Any(), model.UserId("user")). Return(&model.User{}, nil) blog, err := s.RegisterNewBlog(...)
13. 簡単ですね？
14. 本当に簡単ですか？
15. gomockでテストを書く (再掲) ctrl := gomock.NewController(t) m := mock_repo.NewMockUserStore(ctrl) s := NewBlogService(m, ...) m.EXPECT(). FindUserById(gomock.Any(), model.UserId("user")). Return(&model.User{}, nil) blog, err := s.RegisterNewBlog(...)
16. 魔法を解き明かす旅に出る • さらっと書いたけど、どうやって実現されて いるのか気になる • 1つずつ明らかにしていきましょう
17. Dive into gomock id:utgwkk / @utgwkk (うたがわきき) 2024/06/08 Go Conference 2024
18. 今日のおしながき (真) • mockgenが生成するコードの様子を見る • モックに渡った引数を比較する実装を知る • 呼び出しの過不足を検知する実装を知る • リフレクションが活用されていることを知る
19. mockgen (再掲) • gomockを使ったinterfaceのモック実装を生 成するコマンドラインツール • go generateと組み合わせて利用可能 ◦ //go:generate mockgen ...
20. mockgenの実行モード • 2つの実行モードがある ◦ source mode ◦ reflect mode
21. source mode • 指定されたファイルのinterface定義を静的解 析して、モック実装を生成する ◦ 比較的高速 ◦ 生成対象はファイル単位でしか指定できない
22. reflect mode • リフレクションを用いてinterface定義を解析 し、モック実装を生成する ◦ 生成対象のinterfaceを柔軟に指定できる ▪ 他ライブラリのinterfaceも対象にできる ◦ パッケージのコンパイルが必要 ▪ source modeよりも遅くなりがち
23. interfaceのモックを生成する // 以下のinterfaceのモック実装を生成することを考える type UserStore interface { FindUserById( ctx context.Context, userId model.UserId, ) (*model.User, error) }
24. interfaceのモックを生成する //go:generate mockgen -source=user_store.go -package mock_store -destination mock_store/user.go
25. 生成されるコードの様子を見る • いったん雰囲気だけ見ていきましょう…… • あとで詳細を解説します
26. 生成されるコードの様子を見る
27. 生成されるコードの様子を見る
28. 生成されるコードの様子を見る
29. 生成されるコードの様子を見る • いったん雰囲気だけ見た • あとで詳細を解説します
30. Matcher • 引数が満たすべき「述語」に相当する • メソッドに渡された引数が正当であるかどう か検査するためのinterface
31. Matcherに要求されるメソッド type Matcher interface { Matches(x any) bool String() string }
32. Matches(x any) bool • メソッドに渡された引数が、matcherの期待 する条件を満たしているかどうか判定する • falseを返したらテストが失敗する
33. String() string • matcherが期待する引数の条件を表す文字列 表現を返す • 期待する引数が渡されず、テストが失敗した ときに印字される
34. テスト失敗時の出力例 user.go:103: Unexpected call to *user_test.MockIndex.Put([a 1]) at user.go:103 because: expected call at user_test.go:17 doesn't match the argument at index 0. Got: a (string) Want: is equal to c (string)
35. 組み込みのMatcher • Any() • Nil() • Eq(x any) • All(ms ...Matcher) • AnyOf(xs ...any) • Len(i int) • Not(x any) • Cond(fn func(x any) bool) • AssignableTypeOf(x any) • InAnyOrder(x any) • Regex(regexStr string)
36. 組み込みのMatcher • Any() ◦ 任意の引数を受理する • Nil() ◦ nilを受理する • Eq(x any) ◦ xに等しい引数を受理する
37. 組み込みのMatcher • All(ms ...Matcher) ◦ 引数に渡したMatcher全てが受理するなら受理する • AnyOf(xs ...any) ◦ 引数のいずれかに一致するなら受理する • Len(i int) ◦ 引数のlenが一致するなら受理する
38. 組み込みのMatcher • Not(x any) ◦ 引数がxでないなら受理する • Cond(fn func(x any) bool) ◦ 引数をfnに渡してtrueが返るなら受理する ◦ 任意の条件が書ける • AssignableTypeOf(x any) ◦ 引数が型xに代入可能なら受理する
39. 組み込みのMatcher • InAnyOrder(x any) ◦ 引数がxの要素の順序を無視して一致するなら受理す る • Regex(regexStr string) ◦ 引数が正規表現regexStrにマッチする文字列もしくは バイト列なら受理する
40. デフォルトのMatcher • 期待する引数をMatcherでラップしなかった 場合、gomock.Eq() でラップされる • つまり以下2つの式は等価 ◦ m.EXPECT().Foo(1).Return(2) ◦ m.EXPECT().Foo(gomock.Eq(1)).Return(2)
41. Matcherの実装例: Len(i int) • 引数のlenを確かめる Matcher • 引数をreflect.Valueに変換 する • lenが取得できるなら ◦ lenが期待した値と一致する ことを確かめる • lenが取得できないなら ◦ falseを返す
42. Matcherは合成可能 • Matcherの引数にMatcherを渡せる ◦ AnyOf(Eq(1), Nil()) とか • Matcherを組み合わせることで、複雑なマッ チ条件を表現できる
43. Matcherをラップする関数 • Matcherが表す述語は変えずに機能を足す • WantFormatter(s fmt.Stringer, m Matcher) • GotFormatterAdapter(s GotFormatter, m Matcher)
44. WantFormatter • テストに失敗したときの「期待する引数」が どのように出力されるのかを制御する
45. WantFormatterの使われ方 • 期待する引数は fmt.Sprintf("%v") でフォー マットされる ◦ fmt.Stringerを実装していたらString()メソッドが呼 ばれる
46. WantFormatter の実装 • MatcherのMatchesメ ソッドとfmt.Stringer を合成する ◦ embed struct field を駆使している ◦ テクい
47. GotFormatter • テストに失敗したときの「渡された引数」が どのように出力されるのかを制御する • 関数をGotFormatterAdapterでラップして 作るのが簡単 ◦ func(got any) string
48. GotFormatterの使われ方 • GotFormatterで文字列表現を得る ◦ デフォルトでは %v (%T) という形式になる
49. GotFormatterAd apterの実装 • 非常にシンプル
50. gomock.Controller • gomockを使ったテストの中心となる型 ◦ gomock.NewController(t) で生成する ◦ モック実装のコンストラクタに渡す
51. テストの終了を フックする • 何もしなくても勝手に フックされる ◦ t.Cleanup() ◦ Go 1.14以前は ctrl.Finish() を自分 で呼ぶ必要があった ▪ 現在は不要
52. メソッド呼び出しが足り なかったらテストを失敗 させる • ctrl.finish() の実装 • 期待する呼び出しを全 て満たしていなかった ら t.Fatalf() を呼ぶ
53. 期待するメソッド呼び出しを登録する • mock.EXPECT().MethodName(...) • ctrl.RecordCallWithMethodType() が呼ば れる ◦ 具体例で見ていきましょう
54. 期待するメソッド呼び出しを登録する m.EXPECT(). FindUserById( gomock.Any(), model.UserId("user"), ). Return(&model.User{}, nil)
55. RecordCallWithMethodType()
56. RecordCallWithMethodType() の実 装
57. ctrl.expectedCal ls.Add() • (レシーバ, メソッド名) の組をキーとして、期 待するメソッド呼び出 しの一覧を記録する
58. gomock.Call • モックinterfaceにおける「メソッド呼び出 し」を表す型
59. メソッドの呼び出し回数をテストする • Times(n) ◦ ちょうどn回呼ばれる必要がある • MaxTimes(n) ◦ 最大でn回まで呼ばれてよい • MinTimes(n) ◦ 最小でもn回呼ばれる必要がある • AnyTimes() ◦ 何度呼ばれてもよい (呼ばれなくてもよい)
60. メソッドの振る舞いを規定する • Return() • DoAndReturn() • Do() • SetArg()
61. Return() • メソッドが呼ばれたときの返り値を定義する
62. DoAndReturn() • 渡された関数をラップするような関数をリフ レクションで生成して登録する • 返り値を返せる
63. Do() • 渡された関数をラップするような関数をリフ レクションで生成して登録する • 返り値は無視される
64. SetArg(n, value) • メソッドに渡されたn番目の引数の値をvalue に代入する • 渡された引数をあとで使うことができる ◦ けど筆者は使ったことない
65. メソッドの呼び出し順を規定する • メソッドA→メソッドB の順に呼ばれることを テストで確認したい ◦ 何も指定しない場合、メソッドの呼び出し順は自由 • 実現方法は2つ ◦ call.After() メソッドを使う ◦ gomock.InOrder() 関数を使う
66. call.After() メソッド • callB.After(callA) ◦ callA が呼ばれた後に callB が呼ばれる • 呼び出し順を依存グラフとして保持 ◦ 複雑なテストパターンも表現できる
67. call.After() メソッド
68. gomock.InOrder() 関数 • gomock.InOrder(callA, callB, ...) ◦ call.After() を順に呼び出している • 典型的な場合は gomock.InOrder() の方が楽
69. gomock.InOrder() 関数
70. モックのメソッド呼び出しに応じる • 登録済みのメソッド呼び出しの処理やアサー ションに移譲する • これも具体例で見ていきましょう
71. モックのメソッド呼び出しに応じる
72. モックのメソッド 呼び出しに応じる • さすがに小さすぎて見 えない • 順を追っていきます
73. メソッド呼び出しの マッチングを行う • FindMatch() ◦ 登録済みのメソッド呼 び出しにマッチング ◦ メソッド呼び出しが見 つからなかったらテス トを失敗させる • FindMatch() の詳細は 後述
74. 呼ばれる処理を 取ってくる • 前提となるメソッド呼 び出しを解決済とする • 呼び出し回数の上限に 達していたら ◦ メソッド呼び出し一覧 から削除する
75. メソッドの処理を 実行して値を返す • マッチした処理を順に 呼び出す • 最後に呼ばれた処理の 返り値が、interfaceの モック実装のメソッド の返り値になる
76. FindMatch() の実 装 • これも小さくて見えな いと思う • 順を追っていきましょ う……
77. 期待するメソッド呼 び出しのマッチング • call.matches(args) が 本質 ◦ 後述します ◦ 覚悟してください • あとはエラーハンドリ ング ◦ human-readableなエ ラーを出す工夫
78. call.matches(args) の実装 • メソッド呼び出しのマッチング処理の本質
82. matches() の実装 • メソッド呼び出しのマッチング処理の本質 • スライド3枚使っても文字が小さすぎる ◦ コードを直接見ていきましょう…… ◦ ここでVSCodeを開きます
83. matches() の実装を読みました • おつかれさまでした
84. gomockでテストを書く (再掲) ctrl := gomock.NewController(t) m := mock_repo.NewMockUserStore(ctrl) s := NewBlogService(m, ...) m.EXPECT(). FindUserById(gomock.Any(), model.UserId("user")). Return(&model.User{}, nil) blog, err := s.RegisterNewBlog(...)
85. 分かるようになりましたね？ ctrl := gomock.NewController(t) m := mock_repo.NewMockUserStore(ctrl) s := NewBlogService(m, ...) m.EXPECT(). FindUserById(gomock.Any(), model.UserId("user")). Return(&model.User{}, nil) blog, err := s.RegisterNewBlog(...)
86. おわりに: ライブラリの実装を読む • 今回はgomockの話をしたけど、そもそもな ぜライブラリの実装を読むのか • 自分の場合は主に3つの目的がある ◦ 知的好奇心を満たす ◦ 自分の糧にする ◦ 腕力をつける
87. 知的好奇心を満たす • 隠蔽された実装は限りなく魔法に近い ◦ 十分に発達した科学技術は、魔法と見分けがつかない ◦ 「魔法」の正体を解き明かす • 仕組みが分かると嬉しい
88. 自分の糧にする • 知らないものを知らないままにしない ◦ 知らないものは知らない (怖くて触れない) ◦ 手札を増やす • 学びがどんどん出てくるはず ◦ 簡潔に・抽象度の高い形で実装するには？ ◦ 気をつけるべきポイント・落とし穴がないか？
89. 腕力をつける • ライブラリの内部実装が気になる瞬間がどう しても訪れる ◦ 生きているとさまざまなことが…… • いざというときに実装が読めないと、手が出 なくなる ◦ 普段からライブラリの実装を読んでおく
90. まとめ • interfaceのモックを使ったテスト手法を紹介 しました • gomockの内部実装について紹介しました ◦ リフレクションが活用されているのを見ました • 好きなライブラリの実装を深掘りしてみませ んか
91. hatena.co.jp/recruit