[2021/12/16]テストコードのないレガシーアプリケーションとの向き合い方

ソフトウェアテストシンポジウム 2021 九州
https://www.jasst.jp/symposium/jasst21kyushu.html

Transcript

1. テストコードのない
 レガシーアプリケーション
 との向き合い方
 in JaSST'21 Kyushu
 2021-12-18 Sat

2. はじめまして
 ＼の方もそうでない方も／ 

3. はじめまして
 3

4. はじめまして
 4
 GMOペパボ株式会社 ホスティング事業部 バックエンドエンジニア 趣味: インターネットJK・ キャンプ @tosite / まおちゃ / 手島 尚人

5. はい
 ＼会社紹介／

6. はじめまして
 6

7. はじめまして
 7
 ドメイン・レンタルサーバー
 ご用命の際はぜひ弊社サービスを
 よろしくお願いいたします！

8. はじめまして
 8

9. はじめまして
 9
 コミュニティでステッカーやファングッズ・
 ノベルティなどを作成したい場合は
 ご利用ください！

10. ここから本題
 ＼いい仕事した／

11. 突然ですが皆さん
 テストは
 書いていますか？
 ＼かの有名な方もこうおっしゃっていますよね／ 

12. 突然ですが皆さん
 テストは
 書いていますか？
 著者: @mty_mno 「テスターちゃん番外編『ヤツが来る!!』の巻＆メイキングオブジョジョ風の絵 」

13. と言っても
 テストが不十分な
 アプリケーションが
 あるのも現実…
 ＼理想と現実ってやつ／ 

14. 前提
 14
 今年のテーマは「歴史から学ぶ」

15. 前提
 15
 歴史の話をしよう

16. 前提
 16

17. 前提
 17
 ホスティング事業部のサービスは
 20年もの長い歴史があります
 
 今も一部リポジトリでは
 次のようなレガシーな構成を
 目にすることがあります
 ＼今回担当したのはムームードメインのPHPで書かれたアプリケーションコードでした／ 

18. 前提
 18
 レガシーなアプリケーションではまれに
 次のような構成を目にすることがあります
 ＼ちなみに案件はPHPでした／ 

19. 前提
 19
 コントローラーロジック(数百行) 
 関数群(数百〜数千行) 
 ビューファイル(数百〜数千行) 

20. 前提
 20
 コントローラーロジック(数百行) 
 関数群(数百〜数千行) 
 ビューファイル(数百〜数千行) 
 1ファイルで全ての処理を実行している
 
 コントローラー・ビュー・
 ビジネスロジックが密結合している
 ためテストが難しい
 
 当然、既存のテストコードは
 ほとんどない状態

21. 前提
 21
 1ファイル(数千行)
 コントローラーロジック(数百行) 
 関数群(数百〜数千行) 
 ビューファイル(数百〜数千行) 
 ・1ファイルで全ての処理を実行
 ・コントローラー・ビュー・
 　ビジネスロジックが密結合
 　しているためテストが難しい
 ・当然、既存のテストコードは
 　ほとんどない状態

22. 前提
 22
 リファクタリングしたいが 
 テストコードも仕様書もなく 
 「動いているコードが正しい」
 という状態

23. 前提
 23
 要件は
 振る舞いを変えつつ
 変更後の挙動を担保した状態で
 かつバグが混入しないこと
 というもの

24. 前提
 24
 つまり
 リアーキテクティング
 した上で振る舞いを変える
 必要があるということ

25. 前提
 25
 リアーキテクティングするための
 テストがない
 
 コードが密結合しているため
 ユニットテストが書けない
 ＼鶏卵問題ですね／ 

26. 前提
 26
 その状況でいきなり
 振る舞いを変えるのは
 自殺行為

27. 前提
 27
 リファクタリングするためのテストがなく、
 テストを書こうにも密結合しているため
 そのままではテストできない
 
 とは言えいきなりリファクタリングするのも
 エンバグする危険性が極めて高い
 ＼鶏卵問題ですね／ 

28. 皆さんなら
 どうしますか？
 ＼一緒に考えてみましょう／ 

29. 私は次のような
 アプローチを取りました
 ＼一例ですが／

30. フェーズ1. 
 ロジックの分離
 ＼ローマの道も一歩から／ 

31. フェーズ1. ロジックの分離
 31

32. フェーズ1. ロジックの分離
 32
 これを

33. フェーズ1. ロジックの分離
 33
 index.php
 functions.php

34. フェーズ1. ロジックの分離
 34
 こう

35. フェーズ1. ロジックの分離
 35
 まずはファイルから
 ビジネスロジックを
 切り出すだけの作業
 を行った
 😅 

36. フェーズ2. 
 既存の関数に対して
 テストを記述
 ＼リファクタリングらしくなってきました／ 

37. フェーズ2. 既存の関数に対してテストを記述
 37

38. フェーズ2. 既存の関数に対してテストを記述
 38
 既存の仕様を満たす 
 テストケースを記載

39. フェーズ2. 既存の関数に対してテストを記述
 39
 ファイルを分割したので 
 テストが書ける！！
 😃 

40. フェーズ2. 既存の関数に対してテストを記述
 40
 とは言え全ての関数にテストを 
 追加する工数はなかったので 
 リアーキテクティング対象
 のみに留めた

41. フェーズ3. 
 リアーキテクティング
 ＼テストがあるので安全だね／ 

42. フェーズ3. リアーキテクティング
 42

43. フェーズ3. リアーキテクティング
 43
 気になる部分を
 リファクタ

44. フェーズ4. 
 落ちるテストを記述
 ＼赤より始めよ／

45. フェーズ3. 落ちるテストを記述
 45
 修正する関数のテストケース 
 既存の仕様を満たすテスト郡 
 リファクタリング後に 
 仕様を満たすようになるテスト郡 
 リファクタリング前にレッドにな ることを確認しておく リファクタリング後は グリーンになることを確認 することで安全に仕様を 変えることができる 脆弱性が混入されていないことを 
 確認するテスト郡

46. フェーズ4. 落ちるテストを記述
 46
 振る舞い変更前 => レッド
 
 振る舞い変更後 => グリーン

47. フェーズ4. 落ちるテストを記述
 47
 「既存仕様が壊れていないこと」は
 現在の仕様を満たすテストコードから確認できる 
 
 「新規仕様が実装されたこと」は
 落ちるテストが通ることで確認できる 

48. フェーズ5. 
 振る舞いを変更
 ＼さあ、コーディングの時間だ！／ 

49. フェーズ5. 振る舞いを変更
 49
 ここまで来たら安心安全に
 振る舞いを変更できる
 ようになっている

50. フェーズ5. 振る舞いを変更
 50

51. フェーズ5. 振る舞いを変更
 51
 フェーズ3で記述した 
 落ちるテストが
 通るように修正
 したら実装完了！

52. フェーズ5. 振る舞いを変更
 52
 全てグリーンで通過！ 

53. メリット
 ＼こんないいことがあったよ／ 

54. メリット1. 

55. メリット
 55
 テストがない世界からの脱却！
 
 今後機能追加や改修をやるとなった 
 ときの開発基盤が整った 

56. メリット2. 

57. メリット
 57
 コードベースだけでなく 
 テストケースベースで
 レビューできる
 ので安心感があった 

58. メリット
 58
 特に一部関数には
 正規表現が使用されており
 修正前と後で目grepで挙動を 
 担保するのはつらぽよだった 
 
 修正後の挙動を
 テストケースという仕様書
 にできた

59. メリット3. 

60. メリット
 60
 関数群を切り出すことによって 
 スコープが明確になった
 関数がある
 
 副次的にその関数の 
 リファクタを推し進められた

61. まとめ
 ＼もうこんな時間／

62. レガシーな肥大化した
 アプリケーションを
 リファクタするのは
 難しい 

63. 特にテストコードが
 ない場合はなおさら 

64. でもアプローチを
 工夫すれば必ず安全に
 やり遂げられる 

65. 皆さんもテストを書いて
 安全にリファクタして
 いきましょう！

66. ご清聴ありがとう
 ございました