ユニットテストでgo-cmpが便利だった話/recommend-go-cmp-for-ut

Golangでユニットテストを書く際にgo-cmpが役立ったので、LTで紹介しました。

Let's Go Talk #10 で発表した資料になります。
https://connehito.connpass.com/event/290692/
#Go #Golang #LT #Let'sGoTalk

Transcript

1. 蔭山幸太 ユニットテストでgo-cmpが 便利だった話
2. 2 蔭山幸太(22) かげちゃん 経歴 ▷ 淡路島に生まれる ▷ 人事SaaSの23卒 バックエンドエンジニア 趣味 ▷ 旅行 ▷ カクテル作り GitHub: @Kotakageyama X: @kota_3_kota_3
3. 今日話すこと ▷ ユニットテストを書いた ▷ go-cmpとその使用例 ▷ まとめ 3
4. 1. ユニットテストの話 4
5. 皆さん、ユニットテスト 最近書きましたか？ 5
6. 僕も書きました 6
7. 書いたテストケース ▷ 計算式の実行結果が等しいことを担保するテストケース ◦ 文字列、日付、SUM, MINのような関数、配列やMapも使用できる 7
8. 問題が発生！ 実行結果の比較で失敗。。 8
9. 実行時に困ったこと ▷ 数値計算でNaN同士の比較ができない ◦ NaN == NaN // false math.IsNaN()の使用必須 ▷ 現在時刻の取得等でミリ秒誤差によるエラー ▷ 配列の並び順が異なるとエラー ▷ 実行環境に起因する数値誤差でエラー ◦ 1.8371173070873836 != 1.8371173070873834 9
10. 思ったこと ▷ 数値計算でNaN同士の比較ができない ◦ NaN == NaN // false math.IsNaN()の使用必須 ▷ 現在時刻の取得等でミリ秒誤差によるエラー ▷ 配列の並び順が異なるとエラー ▷ 実行環境に起因する数値誤差でエラー ◦ 1.8371173070873836 != 1.8371173070873834 10 Golangの仕様もあるし仕方ない。 比較用の特別な処理関数書くか。。 ↓ やっぱめんどくさいし、コードがめちゃくちゃ増える。 testパッケージ探そう！
11. 沢山あるtestライブラリ抜粋 ▷ reflect.DeepEqual() ◦ 標準パッケージ。型比較でよく使うreflect ▷ stretchr/testify ◦ 人気のtestパッケージ。新しくv2出るらしい ▷ go-cmp ◦ 今回使用したtestパッケージ 11
12. 2. go-cmpの話 12
13. go-cmpとは ▷ 標準のreflect.DeepEqual()に代わる比較パッケージ ▷ Googleが開発している ▷ オプション機能が用意されており拡張性高め ◦ 構造体の特定Fieldに対して比較除外する ◦ 特定の型でのみ別で比較処理をする ◦ 許容誤差を設定する etc… 13
14. NaN同士の比較をreflect.DeepEqual()で書くと 14 ▷ 型アサーションで逐一書く必要がある
15. go-cmpで表すと 15 ▷ オプションを追加するだけで済む
16. go-cmpで使えるオプション抜粋 ▷ NaN同士を等価とする ◦ cmpopts.EqualNaNs() ▷ 日付の誤差を許容する ◦ cmpopts.EquateApproxTime(time.Duration) ▷ 配列の並び順を揃える ◦ cmpopts.SortSlices(SortFunc() bool) ▷ 数値誤差を許容する ◦ cmpopts.EquateApprox(fraction, margin) 16
17. ちょっと複雑な比較を したい 17
18. JSONで比較したい ▷ 結果が大規模のstructの場合に アロケートを防ぐため、 期待する結果を[]structではなく 一つののJSONで保持したい。 ▷ 比較する際は、JSONから戻して 比較したい。 18
19. go-cmpの場合 ▷ FilterValues: func(T, T) boolでtrueのみ後続処理実行 Transformer: func(T) R である型を別の型に変換する 19
20. 3. まとめ 20
21. まとめ ▷ Go-cmpを使うと複雑な構造体やエラーの比較が 簡単に出来る ◦ オプションが豊富で毎回複雑な処理を書かなくても良い ◦ レイアウトが整っており、Diffが見やすい ▷ あくまで比較特化であり、Mock等は別パッケージに 頼る必要がある。(gomock, testifyとか) 21
22. 楽しいテスト作成を！ ありがとうございました！ 22 GitHub: @Kotakageyama Twitter: @kota_3_kota_3