「単体テスト(UT)って、カバレッジの数字だけ埋めればいいのか、それとも細かい境界値まで全部書くべきなのか……どこまで書けばいいんだろう?」
Java・Spring Bootのバックエンド開発現場に入ると、単体テストの粒度や書く範囲について迷うことってありますよね。
僕も昔は「とりあえず正常系が通って、C0(命令網羅)が80%を超えればいいかな」くらいに考えていました。
ただ、テストをサボった結果、結合テストやリリース直前になってNullPointerExceptionなどのしょうもないバグを出してしまい、冷や汗をかいた経験が何度かあります。
そこで今回は、僕がバックエンド開発の現場で単体テストを書くときに意識している「テストを速く・楽に回すための前提」と「これだけは外さないようにしている3つのテスト観点」について書いていきます。
SpringのDIコンテナを起動するとテストが遅くてつらい
現場で単体テストを書いていると、「テストを1本動かすたびにSpring Bootが起動して毎回10秒以上待たされる、、、」という場面に出くわすことがあります。
テストクラスに @SpringBootTest を付けてDIコンテナごと立ち上げてしまうと、ちょっとしたServiceクラスのロジックを確認したいだけでも実行時間がすごく長くなるんですよね。
(1回10秒でも、実装しながら何十回もテストを回していると地味に集中力が削られていきます)
そのため、僕が単体テストを書くときは、原則としてSpringのDIコンテナを起動せず、Mockitoなどを使って軽量にテストを回すようにしています。
コンストラクタインジェクションでクラスを作っておけば、new で対象のServiceを生成してモックを渡すだけでテストが書けるので、実行も一瞬で終わります。
テストがサクッと1秒以内で終わる環境にしておくと、「念のためこのパターンも足しておこう」という心理的なハードルがかなり下がるのでおすすめです。
バックエンドの単体テストで必ず押さえている3つの観点
どんなに忙しい開発スケジュールでも、僕が単体テストのケースを作るときに外さないようにしている観点は以下の3つです。
- ① リストや配列は「null・空・1件・複数件」の4パターンを試す
- ② 境界値(0、マイナス、上限値、当日・翌日)のズレを潰す
- ③ 異常系では「例外の型」と「後続処理が呼ばれていないこと」を確認する
① リストや配列は「null・空・1件・複数件」の4パターンを試す
1つ目は、DBの検索結果や外部APIのレスポンスとして受け取る「リスト(List)や配列」のパターンです。
正常系のテストだけを書いていると、つい「2〜3件のデータが返ってくるケース」だけを用意して満足してしまいがちです。
でも、現場で実際にバグになるのは、データが存在しないときや極端な件数のときがほとんどなんですよね。
・nullが返ってきたとき(そもそもNullPointerExceptionで落ちないか)
・空リスト(0件)のとき(後続のget(0)などでIndexOutOfBoundsExceptionにならないか)
・1件だけのとき(先頭と末尾の判定や重複排除が変に動かないか)
・複数件のとき(並び順や集計結果が意図通りか)
特に「空リストなら安全だろう」と思っていても、リストの先頭要素を取り出す処理や、IN句に空リストを渡してSQLエラーになるケースは現場でもよく見かけます。
この4パターンを機械的にテストケースへ入れておくだけでも、つまらない凡ミスはかなり防げるようになりました。
② 境界値(0、マイナス、上限値、当日・翌日)のズレを潰す
2つ目は、数値や日付の「境界値」のテストです。
たとえば、「利用期間が終了日の23:59:59まで有効」「合計金額が1,000円以上なら割引適用」といった仕様があるとします。
このとき、「以上(>=)」と「より大きい(>)」の記号を1つ書き間違えるだけで、境目のデータだけ正しく動かなくなります。
(しかも、こういう境目のバグに限って、結合テストでは適当な中間値ばかり入れてテストしがちなので、本番リリース後にユーザーからの問い合わせで発覚することが多いです、、、)
そのため、単体テストの段階では「ちょうど境目の値」「境目から1だけずらした値」のペアを必ずテストデータに混ぜるようにしています。
日付の判定であれば「開始日時の1秒前」「開始日時ちょうど」「終了日時ちょうど」「終了日時の1秒後」のように、ピンポイントで境目を叩いておくと安心感が全然違います。
③ 異常系では「例外の型」と「後続処理が呼ばれていないこと」を確認する
3つ目は、エラーや例外が発生する「異常系」のテストです。
入力チェックでエラーになったり、外部APIからエラーが返ってきたりするケースをテストするとき、単に「例外が投げられること」だけを assertThrows で確認して終わることがあります。
ただ、これに加えてもう1つ確認しておきたいのが、「エラーになったあと、DBの更新処理やメール送信などの後続メソッドが呼ばれていないか」です。
たとえば、バリデーションエラーで例外を投げたつもりが、手前の処理でうっかりDB登録メソッドが走っていたら大事故になります。
Mockitoの verify を使って「この異常系ルートを通ったときは、Repositoryのsaveメソッドがtimes(0)(0回)であること」までチェックしておくと、意図しない副作用もあわせて防げます。
さいごに
今回は、Spring Bootのバックエンド開発で僕が単体テストを書くときに意識しているテスト環境と、外さないようにしている3つの観点について書きました。
単体テストは「カバレッジの数字を埋めるための作業」になってしまうと途端につらくなります。
でも、「あとで自分が結合テストや本番障害で冷や汗をかかないための保険」だと割り切って、null・空・境界値・異常系のポイントを絞って書いておくと、結果的に手戻りが減って自分の時間が守られます。
もし単体テストのケースをどこまで書くか迷ったときは、まずは今回挙げた3つの観点が入っているかをチェックしてみてください。
それでは!