ユニットテスト環境改善/improve-unit-test-environment

2024/1/19 若手・学生サーバーサイドエンジニアLT会 ラクーンホールディングス x ゆめみ のコラボLT会
https://yumemi.connpass.com/event/301942/

Transcript

1. ユニットテスト環境改善 yamashita.kiyoshi 若手・学生サーバーサイドエンジニアLT会 2024/01/19
2. まずは自己紹介
 名前：山下 清史
 所属：株式会社ラクーンホールディングス 技術戦略部 開発チーム
 主な仕事：BtoB卸売りサイト スーパーデリバリーの開発
 趣味：ISUCON(前回 上位25%)
 vuejs-jpのコアスタッフしてます
3. Javaのユニットテスト環境が辛かった🥵
 - FWはSpring
 - テストの実行が遅い
 - 1000ケースしかないのに15分程度かかる
 - masterにmerge後テストを待たずにリリース... 
 - テストを書くモチベーションが湧かない
 - カバレッジが可視化されていないので達成感が無い
 - テストの網羅性を注目されていなかった
 - テスティングライブラリのVersionが古い
 - JUnit 4, JMockit 1.33
 - Java11の文法に対応していない
 - 複数の振る舞いをテストするときの記述量が増える

4. この一年でやったこと
 - JUnit4から5へリプレース
 - 遅いテストケースの原因探して修正
 - カバレッジの可視化

5. JUnit4から5へリプレース
6. JUnitのVersionアップ
 移行で辛かったポイント①
 - パッケージが変更されていた
 - org.junit.Test => org.junit.jupiter.api.Test
 - 一部機能が変わっておりコンパイルできない👼
 - 例外が投げられることのテストでは
 - @Test(expected = NullPointerException.class)が
 Assertions.assertThrows(NullPointerException.class
 根気よく空き時間を見つけて修正💪

7. JUnitのVersionアップ
 移行で辛かったポイント②
 - JUnitのVersionをあげたことでMockライブラリ(JMockit)もVersionを上げる必要 が出てきた
 - JMockitはマイナーバージョンアップでも後方互換性がないので
 最新Versionにすると全て書き換える必要あり　
 - 開発は2019年で止まっている
 
 
 JMockitで書かれている箇所をMockito🍷に書き換え なんとかJUnit5に移行できた...
8. Mockitoの選定理由
 - JUnit5に対応している
 - 開発が今も続いている
 - 毎月リリースされている
 - 学習コストが低い
 - 弊社の新卒研修で使われているので知っている人が多い
 - 日本語のドキュメントがある

9. JUnit5にリプレースした結果
 - JUnitが最新バージョンになった
 - Java8以降の文法（ラムダ関数など）が使用可能
 - JUnitの便利な機能
 - パラメータ化テスト
 - @DisplayName
 - テストを階層化して整理

10. テストが遅い問題
11. テストが遅い問題①
 遅いテストを確認すると...
 1つのテストクラスだけで約50秒！！

12. テストが遅い問題①
 巨大な画像（6000px×6000px）の画像をリサイズしていた
 テスト対象のコード内でpropertyファイルから取得する
 リサイズの上限が6000px×6000pxであるため
 
 リフレクションでテスト時のみ縦横ピクセルのリサイズの上限を変更
13. テストが遅い問題①
 約50秒速くした
 他にも遅いテストを見つけては原因調査...

14. テストが遅い問題②
 問題：
 複数のテストクラスで同じDIコンテナ使用していたが、
 テスト毎に生成しては破棄を繰り返していた。
 クラスＡ クラスＣ クラスＢ キャッシュ済みのDIコンテナが使えないとテストクラスごとに DIコンテナ生成コストがかかる
15. テストが遅い問題②
 クラスＡ クラスＣ クラスＢ 全てのテストクラスでキャッシュ済みのDIコンテナを 利用出来るように修正 問題：
 複数のテストクラスで同じDIコンテナ使用していたが、
 テスト毎に生成しては破棄を繰り返していた。

16. カバレッジ可視化
17. カバレッジ可視化
 - カバレッジが計測されていない状況だったので、
 テスト作成モチベーションがわかなかった
 
 - MR時にどの行がテストでカバーされていないか表示 - MR時にカバレッジの割合変化を表示 - READMEにバッジを張る - gitlab pagesにカバレッジレポートをホスティング
18. カバレッジ可視化
 - カバレッジが計測されていない状況だったので、
 テスト作成モチベーションがわかなかった
 
 - MR時にどの行がテストでカバーされていないか表示 - MR時にカバレッジの割合変化を表示 - READMEにバッジを張る - gitlab pagesにカバレッジレポートをホスティング
19. カバレッジ可視化
 コードレビュー時の指標の1つ、モチベーションアップに繋がりそう！？
20. カバレッジ可視化
 - カバレッジが計測されていない状況だったので、
 テストの品質が低い状況だった...
 
 - MR時にどの行がテストでカバーされていないか表示 - MR時にカバレッジの割合変化を表示 - READMEにバッジを張る - gitlab pagesにカバレッジレポートをホスティング
21. カバレッジ可視化
 カバレッジを簡単に確認できる💪
22. まとめ
 - JUnitのVersionをあげたことでテストの書きやすさ↗
 - 遅いテストを修正、キャッシュ済みのDIコンテナを使用
 - テスト速度↗（約15分⇒約6分）
 - カバレッジレポートをgitlab-pagesにホスティングさせた
 - MR時にカバーされていないコードを分かるようにした
 - テストへのモチベーション↗
 - まだまだ改善できる余地があるのでこれからもやっていき！

23. 参考
 - Spring コンテキストキャッシング
 - GitLab テストカバレッジの可視化