Kotlinのテストクラスとテストメソッドの命名規則を解説！初心者でも分かる単体テストの基本

先生と生徒の会話形式で理解しよう

生徒

「Kotlinでテストを書くとき、クラス名やメソッド名ってどうやって決めればいいんですか？」

先生

「とても大事なポイントですね。命名ルールを守ることで、テストコードが読みやすくなり、メンテナンスもしやすくなりますよ。」

生徒

「ルールって具体的にどういうものですか？」

先生

「それでは、Kotlinのテストクラスとテストメソッドの命名規則について、わかりやすく解説していきましょう！」

1. テストクラスの命名規則とは？

Kotlinで単体テストを書くときは、通常「クラス名＋Test」という形式でテストクラスの名前をつけます。たとえば、UserServiceというクラスをテストするなら、テストクラスの名前はUserServiceTestにします。

これは「どのクラスをテストしているのか」が一目でわかるため、テストコードの整理がしやすくなるというメリットがあります。

命名の例：

Calculator → CalculatorTest
LoginManager → LoginManagerTest

2. テストメソッドの命名規則とは？

テストメソッドでは、「何をテストするか」がわかる名前をつけるのが大切です。よく使われるパターンは次のとおりです。

メソッド名_条件_期待結果（例：add_twoPositiveNumbers_returnsCorrectSum）
should_期待結果_when_条件（例：shouldReturnCorrectSumWhenTwoPositiveNumbersAreAdded）

英語で書くのは、国際的な開発現場で共通理解しやすくするためです。

ただし、日本語で理解したい場合は、コメントに日本語で説明を添えても構いません。

3. 実際のテストクラスとメソッドの例を見てみよう

ここでは、Calculatorというクラスのaddメソッドをテストする例を紹介します。


class Calculator {
    fun add(a: Int, b: Int): Int {
        return a + b
    }
}

このクラスに対するテストコードは次のようになります：


import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Test

class CalculatorTest {

    @Test
    fun add_twoPositiveNumbers_returnsCorrectSum() {
        val calculator = Calculator()
        val result = calculator.add(2, 3)
        assertEquals(5, result)
    }

    @Test
    fun add_negativeAndPositiveNumber_returnsCorrectSum() {
        val calculator = Calculator()
        val result = calculator.add(-2, 5)
        assertEquals(3, result)
    }
}