フレームワークが生み出す負債や複雑さに対して、PHPUnitと付き合っていく

万人を虜にし、数多くのエンジニアを型に嵌めたフレームワークという存在。某WordPressをはじめ、全世界のアプリケーションインフラを支える大黒柱ではあるが、彼らも時代とともに変わっていく。

自分自身も毎年脱皮を繰り返す彼らを業務上で付き合っていく中で、四苦八苦することがあるが、果たしてどのように関係を保てばいいものだろうか。

コントリビューターたちの軌跡を常にキャッチアップするほど、我々に時間は与えられていないし、業務は待ってくれない。

業務を通して、かつ、フレームワークの複雑さや進化と付き合ってきた、僕なりの方法をお話します。

・Laravelを使った開発における注意点
・PHPUnitを用いた設計・実装における勘所

Transcript

1. 2023 年 6 月 24 日 (土) PHPカンファレンス福岡 @stwile871 フレームワークが生み出す 負債や複雑さに対して、 PHPUnitと付き合っていく
2. 自己紹介 スタヰル(@stwile871) • PHPer歴・TDD歴6年目 • 名古屋在住ですが、2･3ヶ月毎に東京に出張 • 筋トレ🏋とウヰスキー🥃を嗜 • ロックマンエグゼ好きを拗らせてWeb業界に入門 • 好きな関数は sprintf()
3. Q. ところで皆さんご存知ですか？
4. FWのバージョンを上げるとどうなるのか
5. どうなるのか？
6. 何もしてないのに壊れた ＼(^o^)／ ＼(^o^)／
7. もう二度と＼(^o^)／らないために…！！
8. アジェンダ 1. FWのアップデート事故からの考察 2. テストクラスの罠
9. とある架空のアプリケーション • FWのバージョンアップ
10. 具体的な事故 ソート機能が 期待するものではなくなっていた
11. 要件 TODOのリストを返す • 更新日時 • 降順
12. 要件 TODOのリストを返す • 更新日時 • 降順 昇順
13. ちょっと待ってください。
14. 悔しいポイント 🦁テストは書いていた🦁
15. どんなテストだったのか？
16. テストの概要 • API（Integration）のテスト • モジュール（Unit）のテスト
17. 事実確認 • モジュールのテスト ＞ APIのテスト • APIのテストはMockを多用
18. 原因と考察 • モジュールのテスト ＞ APIのテスト • APIのテストはMockを多用 • 機能を担保するテストではなかった • ライブラリの依存に対処できていなかった
19. つまり？
20. 原因と考察 要件を満たして品質を担保するテスト
21. 原因と考察 要件を満たして品質を担保するテスト 開発速度とカバレッジだけ高いテスト
22. テストピラミッドを信じてテストを書いていた E2E Integration Unit
23. Unit ＞ Integration E2E Integration Unit 本来のテストピラミッド
24. TODOアプリのテストピラミッド E2E Integration Unit Unit ＞ Integration
25. 原因と考察に基づく比較 E2E Integration Unit • 機能を担保するテストではなかった • ライブラリの依存に対処できていなかった
26. 原因と考察に基づく比較 E2E Integration Unit • 機能を担保するテストではなかった • ライブラリの依存に対処できていなかった 間違ってなさそう💧
27. もう少し図解
28. 僕らが作っていたテスト • プロダクトコード • FW内の処理 • 依存ライブラリの処理の 振る舞い(mock) • 入力 ブラックボックスが 処理を振る舞うテスト
29. 品質を担保できるテスト • プロダクトコード • FW内の処理 • 依存ライブラリの処理 • 入力 ブラックボックスが 処理を行うテスト
30. 結論 FWのアップデートには Integrationテストを書こう
31. ！！！！！！！！！！ ！ここから本題です！ ！！！！！！！！！！
32. 残る疑問 E2E Integration Unit ユニットテストをたくさん書いていたのに 品質を担保できなかったのはなぜ❓❓❓
33. ？？？ 「一体いつから 　Unitテストがクラス単位だと 　錯覚していた？」 ？？？
35. Unit（単体）テストは難しい
36. Unit（単体）テストは文脈ごとに意味が変わる から難しい
37. 各テスト定義（文脈）を比較
38. Laravelのテスト 引用: https://laravel.com/docs/10.x/testing#main-content
39. Laravelのテスト UnitTest • 一つのメソッドに焦点を当てる • DBや依存ライブラリにアクセスしない UnitTest • 一つのメソッドに焦点を当てる • DBや依存ライブラリにアクセスしない Feature Test • APIとしての機能テスト
40. TODOアプリのテスト構成と似ている E2E Integration Unit
41. 『単体テストの考え方 / 使い方』のテスト 単体テスト • 1単位の振る舞いを検証 • 実行時間が短い • 他のテストから隔離されている
42. 1単位とは？？？
43. 1単位とは？？？ Contextによって単位が変わる
44. 1単位とは？？？ 担保したい価値の最小単位
45. 定義がないので チームで話し合って定義してみた
46. Unit • TODOを作成できる 担保したい価値
47. Unit • TODOを作成できる Integration • TODOを管理（作成・編集・削除）でき る 担保したい価値
48. • プロダクトとしての機能をテストで担保しよう • 依存しているブラックボックスも通そう • 自分たちの1単位は何なのか見直そう まとめ
49. おわり