Readable test code

テストにおける読みやすさの重要性や、なぜ読みやすく書かなければならないのかといった話です。

(本スライドは ジュニア層エンジニア向けLT会
にて発表したスライドです)
https://tsumiage.connpass.com/event/221065/

Transcript

1. リーダブル"テスト"コード より良いテストを書くためのシンプルで実践的なテクニック
2. 自己紹介 - 名前: 幾野直人(いくの なおと) - 年齢: 24歳、 新卒3年目 - 趣味: 合気道、ルービックキューブ、料理 四ツ谷の某企業でフロントエンジニアしてます (ググれば出ます) Twitter: @le_panda_noir
3. 今日する話 • 読みづらいテストは何がいけな いのか? • 読みやすいテストの書き方 • そもそもテスト自体をなぜ書く必 要があるのか? 今日やらない話
4. テスト、書いていますか? 僕はたくさん書いてます
5. Q. なんでリーダブルなテストを書く必要があるの? A. テストを他の人が変更しやすくするため。
 仕様変更でコードとテストを書き直すとき、そのテストを理解する必要がある 
 
 理解できないテストは変更できない。そのため、読解コストを限りなく下げる必要 がある。

6. 読みづらいテストコードの実際の例 (jest) 👈 何を保証するテストなのかタイトルで分からない 👈 なぜエラーが期待されているか不明 👈 なぜエラーが期待されているか不明
7. 「テストが落ちた！」 
 
 
 • 変えたコードにバグがあってテストが落ちたのか？
 • 仕様が変わったからテストを書き直す必要があるのか?
 ◦ 書き直すとして、どう書き直せばいいのか? 
 • そもそもこのテストは何を検証しているのか？

8. 読みやすいテストコードの例 (jest) https://www.youtube.com/watch?v=-Z3ZZTLIj_U
9. 読みやすいテストコードの例 (jest) ✅ 仕様についてのテストである (もしテストが落ちたら問題があると一目で分か る) ✅ 仕様に合わせてテストを変えな きゃいけないと明白
10. リーダブルに書くテクニック • 仕様についてテストしよう • why を書こう • 1つのテストは1つだけ保証しよう
11. テクニック1: 仕様についてテストしよう 「〇〇は××という仕様を満たす」というタイトルで書こう 現在のセッションがリストの最後のときにユーザーがセッションを追加したら、追加したセッションを現在のセッ ションに設定する ✅ アプリの仕様をテストしている
12. 「〇〇は××である。なぜなら〜」と書こう テクニック2: why を書こう ✅ .inverse() になぜエラーを投げ て欲しいかわかる ❌ .inverse() にエラーを投げて欲 しい理由がわからない
13. テクニック3: 1テスト1保証 ` • テストが落ちたときに分かりづらい • 読むのも書くのも面倒 👇inverse がちゃんと逆行列を返しているかのテスト 👆 逆行列がないときに例外が出るかのテスト
14. テクニック3: 1テスト1保証 ✅保証する事柄が1つに絞ってある (※assertion が1つかどうかは関係ない )
15. まとめ: リーダブルなテストコードを書こう リーダブルであれば : コードが誤って変更されたとき、開発者がバグに気づける 仕様変更でコードを変えたとき、テストを変えるべきと判断できる コードもテストも読みやすく書いて、良いエンジニアライフを！