Kotlinのパラメータ化テストをJUnitで実装する方法|初心者向けガイド
生徒
「テストって毎回似たようなコードを書くのが面倒なんですが、何か良い方法はないですか?」
先生
「それなら、KotlinとJUnitでパラメータ化テストを使うと便利ですよ。繰り返しのテストコードを簡潔にまとめられます。」
生徒
「パラメータ化テストって何ですか?」
先生
「では、具体的にKotlinでJUnitを使ったパラメータ化テストのやり方を見ていきましょう!」
1. パラメータ化テストとは?
Kotlin(ことりん)でのパラメータ化テストとは、同じテストを複数の値で繰り返し実行する方法です。たとえば、「1+1=2」「2+2=4」など、似たような計算を何度もテストしたいときに、一つのテストコードでまとめて書ける便利な機能です。
JUnit(じぇいゆーにっと)というテストライブラリの機能を使うと、このパラメータ化テストを簡単に実装できます。
2. 必要な依存関係を追加しよう
KotlinでJUnitを使うには、ビルドツール(Gradle)に依存関係を追加する必要があります。JUnit5のパラメータ化テスト機能は、junit-jupiter-paramsというライブラリに含まれています。
build.gradle.kts ファイルに次のように記述します:
dependencies {
testImplementation("org.junit.jupiter:junit-jupiter:5.9.3")
testImplementation("org.junit.jupiter:junit-jupiter-params:5.9.3")
}
3. パラメータ化テストの基本構文
JUnit5では、@ParameterizedTestというアノテーション(注釈)を使います。このアノテーションは、1つのテストメソッドを複数のデータで繰り返し実行する機能です。
さらに、@ValueSourceや@CsvSourceを使うことで、データを渡すことができます。
例として、「整数が偶数かどうかを判定する関数」をテストしてみましょう。
import org.junit.jupiter.params.ParameterizedTest
import org.junit.jupiter.params.provider.ValueSource
import org.junit.jupiter.api.Assertions.assertTrue
class NumberUtilsTest {
fun isEven(number: Int): Boolean {
return number % 2 == 0
}
@ParameterizedTest
@ValueSource(ints = [2, 4, 6, 8])
fun `偶数であることをテストする`(number: Int) {
assertTrue(isEven(number))
}
}
この例では、2、4、6、8の4つの値が順番にテストされます。
4. 複数の引数を使いたいときは?
複数のパラメータを一緒にテストしたいときは、@CsvSource(CSV形式で値を渡す)を使います。
import org.junit.jupiter.params.ParameterizedTest
import org.junit.jupiter.params.provider.CsvSource
import org.junit.jupiter.api.Assertions.assertEquals
class CalculatorTest {
fun add(a: Int, b: Int): Int {
return a + b
}
@ParameterizedTest
@CsvSource(
"1, 2, 3",
"2, 3, 5",
"10, 20, 30"
)
fun `加算の結果をテストする`(a: Int, b: Int, expected: Int) {
assertEquals(expected, add(a, b))
}
}
このように書くと、「1+2=3」「2+3=5」「10+20=30」の3つのテストが自動で実行されます。
5. テストの実行結果を確認してみよう
テストを実行すると、各パターンごとに結果が表示されます。Kotlin+JUnitを使えば、まとめてテストできるので効率的です。
CalculatorTest > 加算の結果をテストする(int, int, int)[1] PASSED
CalculatorTest > 加算の結果をテストする(int, int, int)[2] PASSED
CalculatorTest > 加算の結果をテストする(int, int, int)[3] PASSED
6. よくある質問とつまずきポイント
初心者の方がパラメータ化テストでつまずきやすい点をいくつか紹介します:
- アノテーションの書き忘れ:
@ParameterizedTestや@CsvSourceを忘れると、ただの通常テストとして動作してしまいます。 - データ型のミスマッチ: 引数の型(IntやStringなど)が一致していないとエラーになります。
- JUnit4とJUnit5の混在: 古いJUnit4と一緒に使うと動作しないことがあるので注意が必要です。
7. どんなときに使うと便利?
次のような場面でパラメータ化テストは特に便利です:
- 同じロジックに対して、さまざまな値を試したいとき
- 表形式のデータを使って検証したいとき
- ミスを減らしてテストの保守性を高めたいとき
たとえば、割り算、文字列の変換、日付のフォーマット、税金計算など、複数のパターンが存在する処理に最適です。
8. Kotlin初心者でも使える理由
KotlinでJUnitのパラメータ化テストを使うと、繰り返し作業を減らしつつ、コードも見やすくなります。
「繰り返す処理はまとめよう」という考え方は、プログラミングの基本でもあります。初心者にとっても理解しやすく、実践しやすいテスト方法です。
初めてのテストでも、この記事のようにテンプレートから始めればすぐに取り入れられるでしょう。