そのbeforeEach本当に必要? TIPSをご紹介 / beforeEach TIPS

JaSST nano vol.39(https://jasst-nano.connpass.com/event/325471/) にて発表させていただいた資料です。

縦に長いbeforeEachを見たことありませんか？私はめちゃくちゃあります。なんなら書いてます。そんな自分にも向けてTIPSを共有します。

Transcript

1. そのbeforeEach本当に 必要？TIPSをご紹介 JaSST nano vol.39 bun913
2. 自己紹介 bun913 • 職種: SDET
 ◦ Software Development Engineer in Test
 • ISTQB AL TA/TTA/TM 取得 
 • AWSと開発も少しだけできる 
 • 英語猛烈学習中

3. テストコード書いてますか？
4. きっと大好きですよね！！
5. 今日話すこと • ユニットテストの前処理の小話
 • 具体的には beforeEach などの話
 ◦ beforeAll
 ◦ beforeOnce
 ◦ など
 • 意識したいポイントを紹介します
 
 ※ どちらかというと開発者向けです

6. beforeEach とかって何なのさ
7. Jestなど様々なフレームワークで用意されている仕組み • 特定の検証の前処理、後処理などを スマートに書く方法の一つ
 • beforeEach
 ◦ グルーピングした全てのテストケースの前 に毎回実行するイメージ
 • beforeAll
 ◦ グルーピングした全てのテストケースの前 に1回だけ実行するイメージ
 引用: Jest | セットアップと破棄
8. 同じような初期化を毎回しない でいいってこと？
9. これを・・・
10. こうってこと！？
11. DRYってやつじゃない！？ いいんじゃない！？
12. ちょっと待ってください。
13. 利用時の注意点
14. 忘れがち（無視しがち）な 2つのこと beforeAll とか beforeEachを使う時に割 とあるのが・・・ • 「特定の状態」を「複数のテストケース間 で共有」してしまう場合 • 単純にスクロールの上下運動がキツく なっていくこと
15. 1: 「特定の状態」を「複数のテストケース間で共有している」場合 ・意図せず複数のテストケース間で同じ「インスタンス」や「変数」を持ち回し
 ・実は特定の関数に副作用があり、インスタンスの状態を変更してしまっていたり
 ・そのせいで特定の順番でだけテストケースがパスするようになっていたり

16. ・上にスクロールしないと「この変数って何？どこで・どんなふうに初期化された？」が分からな い
 ・（人間なので）ついbeforeEachに全ての前処理をダラダラコメント付きで書いたり 
 2: スクロールの上下運動がキツくなっていく
17. こんな風に beforeEachに書いていたのは私だけではないはず
18. ヘルパー関数がおすすめです
19. ヘルパー関数やファクトリー関数を利用する ・ヘルパー関数を用意
 ・itやtest内で完結できる記述量
 ・テストケース間で共有する状態を意識し なくていいようにする
 ・コメントではなく関数名に意図をこめる こともできる 
 ・地味だけどエディタ補完も効く 

20. コード量が最初と あまり変わってないじゃん！
21. そうですね
22. でも本来やりたかったことはできたのでは？ ・コードを意味を持った単位で共通化
 ・単純に見やすくなったり、エディターの恩恵を受けれるようになったり
 ・テストケース間での副作用の心配を減らす
 ・ヘルパー関数名で前処理の意味や意図を伝えやすく
 ・「似たようなコードを書いているから即共通化！」ではなく、
 「同じドメイン知識を書くのは一箇所にしたい 」のような考えはプロダクションコードでも同 じですよね

23. 最初の状態との比較
24. なお
25. 普通にbeforeEachやbeforeAllを使うことも勿論あります • 統合テストでメモリ外部の依存を扱う必要がある時
 • 例えば
 ◦ DBの状態を特定の状態にしないといけない時
 ◦ ユーザーがログインした状態を再現する時
 • そういう時にも適切に利用していきたい
 ◦ （そもそもの設計を工夫して）DBなどの外部への依存との接する部分を極力小さ く。多くの関数は外部から状態を注入しやすく作る。
 ◦ ヘルパー関数を使うなどbeforeEachに縦に長くダラダラ書かない

26. 書きながら自分の胸が痛い
27. ちなみにですが
28. 今回の登壇資料の元ネタ・参考書籍など ・「Zenn | ユニットテストでbeforeEachなどのセットアップを使う際の注意点と改善例」に話 の元ネタを記載
 ・参考にした書籍の情報などもありますのでご興味のある方はご覧ください

29. まとめ
30. beforeEach とかの前処理はとても便利 • だけど注意したい点もあります
 ◦ 意図せず状態を複数のテストケース間で共有していたり 
 ◦ beforeEach に全ての前処理を集めて縦に長くなり、コメントでごまかしたり 
 • ヘルパー関数やファクトリー関数で 意図が伝わりやすいテストコードを書く のはおすすめです

31. 最後に少しだけ宣伝を
32. お決まりの？ We are Hiring!
33. QAエンジニアの募集も勿論ありますよ！
34. 求人ページ
35. ご清聴ありがとうございました