良いテストとは何か:持続可能で保守性の高いテストを書く

PHPカンファレンス2023の登壇資料です。
https://fortee.jp/phpcon-2023/proposal/10143d00-ca44-4db1-aeb6-b618c423b646

1. 良いテストとは何か: 持続可能で保守性の⾼いテストを書く @picopico_dev
2. テスト、書いていますか？
3. 「良い」テスト、書いていますか？
4. 4 会社 ピクシブ株式会社 経歴 2023年4⽉ 新卒⼊社 業務 Web API設計/PHP . 移⾏ picopico @picopico_dev
5. ⽬次 1. なぜ良いテストが必要なのか 2. 良いテストの指標 3. 良いテストの書き⽅
6. ⽬次 1. なぜ良いテストが必要なのか 2. 良いテストの指標 3. 良いテストの書き⽅
7. 前提：テストは書くべき
8. テストを書く恩恵 • 機能変更‧リファクタリングしやすい • 素早いフィードバックによる⾼速な開発 • 優れたドキュメンテーション • etc…
9. テストの質が悪いと‧‧‧？ • テストを修正しづらい • すぐテストが壊れる • テストの実⾏が終わらない • たまに原因不明で落ちる • etc…
10. コードは資産ではなく負債 コードが多いほど、保守‧運⽤コストがかかる ＝書かれたテストはゼロコストではない
11. ⽬次 1. なぜ良いテストが必要なのか 2. 良いテストの指標 3. 良いテストの書き⽅
12. 「良い単体テストを構成する4本の柱」 • リグレッションへのセーフティネット • リファクタリング耐性 • 迅速なフィードバック • 保守のしやすさ 「単体テストの考え⽅/使い⽅」p.96
13. 「単体テストを早期に⾏う利点」 • 瞬間的な満⾜感 • モジュール性‧再利⽤性の向上 • リファクタリング‧セーフネット • ドキュメンテーション 「The Advantages of Unit Testing Early」- Google Testing Blog (https://testing.googleblog.com/2009/07/by-shyam-seshadri-nowadays-when-i-talk.html)
14. 良いテスト ＝価値の⾼いテスト シンプルに‧‧‧
15. 価値＝機能÷コスト
16. 価値＝機能÷コスト
17. コードが正しいことを保証すること 半分間違い
18. テストの機能 フィードバックループの構築 ドキュメンテーション +
19. テストの機能 フィードバックループの構築 ドキュメンテーション +
20. フィードバックループの構築 コードの変更 テスト リリース
21. シフトレフト
22. 低い⽋陥コストでバグを修正できる →素早いリリースが可能になる →持続可能で保守性の⾼いプロダクトに
23. テストの機能 フィードバックループの構築 ドキュメンテーション +
24. ドキュメンテーション • 信頼度が⾼い • Howをコードで⽰している
25. 信頼度が⾼い システム ⽂書 コメント テスト
26. 価値＝機能÷コスト
27. テストのコスト 実装コスト 保守コスト 運⽤コスト + +
28. テストのコスト 実装コスト 保守コスト 運⽤コスト + +
29. 実装コスト • フレームワークの導⼊ • テストの作成 • CIへの組み込み • 学習
30. 実装コスト テストコードはプロダクションコードより多い
31. テストのコスト 実装コスト 保守コスト 運⽤コスト + +
32. 保守コスト • フレームワークのアップデート • コード変更時のテストの修正
33. テストのコスト 実装コスト 保守コスト 運⽤コスト + +
34. 運⽤コスト • テストの実⾏ • CIサーバーの運⽤
35. 価値＝機能÷コスト
36. フィードバックループの構築 実装コスト ドキュメンテーション 運⽤コスト 保守コスト 価値 ＝ ÷
37. ⽬次 1. なぜ良いテストが必要なのか 2. 良いテストの指標 3. 良いテストの書き⽅
38. 良いテストを書くには • 正確なフィードバック • ⾼速なフィードバック • 理解しやすいテスト • テストする価値の⾼いシステムをテストする
39. 良いテストを書くには • 正確なフィードバック • ⾼速なフィードバック • 理解しやすいテスト • テストする価値の⾼いシステムをテストする
40. 正確なフィードバック • 機能が正しく実装されているとき →テストが通る • 機能が正しく実装されていないとき →テストが落ちる
41. 正確なフィードバック 機能が正しくない 機能が正しい テストが通らない 真陰性 偽陽性 テストが通る 偽陰性 真陽性
42. 正確なフィードバック コードの変更 テスト リリース 偽陽性
43. ホワイトボックステスト • ソフトウェアが内部的に⾏っていることを検証する • Howに依存するため、リファクタリング耐性が低い
44. ブラックボックステスト • ソフトウェアの振る舞いのみを検証する • Whatに依存するため、リファクタリング耐性が⾼い
45. 正確なフィードバック コードの変更 テスト リリース 偽陰性
46. 偽陰性を減らす • ロジックが正しく動くか • コンポーネントが結合された状態で動くか
47. テストピラミッド E2E Integration Unit
48. 良いテストを書くには • 正確なフィードバック • ⾼速なフィードバック • 理解しやすいテスト • テストする価値の⾼いシステムをテストする
49. ⾼速なフィードバック コードの変更 テスト リリース できるだけ速く
50. テストピラミッド E2E Integration Unit
51. テストサイズ 機能 Small Medium Large ネットワークアクセス No localhost only Yes データベース No Yes Yes ファイルシステムアクセス No Yes Yes 外部システムの利用 No Discouraged Yes マルチスレッド No Yes Yes スリープ文 No Yes Yes システムプロパティ No Yes Yes 時間制限 (秒) 60 300 900+ 「Test Sizes」- Google Testing Blog (https://testing.googleblog.com/2010/12/test-sizes.html)
52. 良いテストを書くには • 正確なフィードバック • ⾼速なフィードバック • 理解しやすいテスト • テストする価値の⾼いシステムをテストする
53. 理解しやすいテスト • AAAパターン ◦ Arrange - 準備 ◦ Act - 実⾏ ◦ Assert - 確認 • テストケースと振る舞いを対応させる • ⼀度に⼀つの振る舞いを検証する
54. 良いテストを書くには • 正確なフィードバック • ⾼速なフィードバック • 理解しやすいテスト • テストする価値の⾼いシステムをテストする
55. テストする価値の⾼いシステム • コアドメインに近い • ロジックが複雑である
56. テストする価値の低いシステム • 単発のスクリプト • 書き直した⽅が早い • ロジックをほぼ持たない
57. テスタビリティについて
58. フィードバックループの構築 実装コスト ドキュメンテーション 運⽤コスト 保守コスト 価値 ＝ ÷
59. 実装コスト ＝テスト対象システムで決まる
60. Class A Class C Class B Class D
61. DIとテストダブル • 依存をコンストラクタで注⼊する • テスト時には依存クラスをテストダブルに置き換える
62. おわり