レガシーシステムに自動テストを導入する第一歩 / 2020-phpcon-tdd-in-legacy-product

PHPカンファレンス2020で行ったLTのスライドです

Transcript

1. レガシーシステムに自動テストを 導入する第一歩 PHP Conference Japan 2020
2. 自己紹介 • 名前 ◦ 荒巻 拓哉 • 所属 ◦ 株式会社ラクス ◦ メール配信サービス「配配メール」の開発 ◦ 新卒2年目
4. 2007年サービス開始 立派なレガシープロダクト
5. 課題 • PHPUnitを約1年前から一部で導入開始 しかし • 導入はなかなか進まない • 既存機能のテストを書く時間は取れない
6. とある案件で テスト駆動開発＆ 既存ロジックのリファクタリング してみた話
7. 案件の内容 「従来の機能をAPIでも実行できるようにしたい」 API 従来：画面操作で実行 APIで同じ操作を実行
8. 対象の機能 • データの登録・更新機能 • 現状 ◦ テストコードなし ◦ コントローラにロジックをべた書き ▪ 600行超えの神メソッド……
9. 実装戦略 1. 画面のテストを作成 2. オールグリーンになるのを確認 3. コントローラのロジックを部品化 4. APIのテストを作成 5. 3.の部品でAPIを実装
10. 実装戦略 1. 画面のテストを作成 2. オールグリーンになるのを確認 3. コントローラのロジックを部品化 4. APIのテストを作成 5. 3.の部品でAPIを実装 既存ロジックの リファクタリング テスト駆動で新機能の 実装
11. 実装戦略 1. 画面のテストを作成 2. オールグリーンになるのを確認 3. コントローラのロジックを部品化 4. APIのテストを作成 5. 3.の部品でAPIを実装 • コントローラを呼び出す機能テスト ◦ in: リクエストパラメータ ◦ out: DBの更新結果
12. 実装戦略 1. 画面のテストを作成 2. オールグリーンになるのを確認 3. コントローラのロジックを部品化 4. APIのテストを作成 5. 3.の部品でAPIを実装 テストが失敗しないか確認しながら
13. 実装戦略 1. 画面のテストを作成 2. オールグリーンになるのを確認 3. コントローラのロジックを部品化 4. APIのテストを作成 5. 3.の部品でAPIを実装 • 実際にリクエストを送信 (Guzzle) • DBの更新結果を確認
14. 実装戦略 1. 画面のテストを作成 2. オールグリーンになるのを確認 3. コントローラのロジックを部品化 4. APIのテストを作成 5. 3.の部品でAPIを実装 • テスト作成と並行 • 一通り実装したら即テスト実行
15. こうして実装が完了 めでたしめでたし……
16. ＿人人人人人人人人人＿ ＞　突然の仕様変更　＜ ￣Y^Y^Y^Y^Y^Y^Y^Y^Y￣
17. 自動テストの効果 • 仕様変更に強い ◦ 開発終盤で仕様変更が発生しても、テストがあるので 安心してコードを修正できる
18. その他の効果 • スイッチングコスト低減 ◦ 実装 → 手動テスト → 修正 はスイッチングコスト高 ◦ 実装後すぐにテスト結果がわかると楽 • チームの設計力強化 ◦ テストしやすさを考慮した設計が身につく
19. まとめ • レガシープロダクトでもTDDできる • 効果 ◦ 仕様変更に強い ◦ スイッチングコスト低減 ◦ 設計力の強化