KotestのLifecycle hooksについてまとめてみた

Mar 29 2025 · 10min · Kotlin,Kotest,自動テスト

はじめに

Kotestに限らず、テストコードを書く際にはbefore/afterといった前後処理関数を使うことがあります。ただ、Kotestではそれらの関数が非常に多く用意されており、結局どれを使えば良いのか迷うことがあるかと思います。

そこで今回は、Kotestで使えるライフサイクル系のbefore/after関数について、実際のコード例を交えてまとめてみました。 どのように活用できるかを実際のコードを交えながら解説していくので、是非、Kotestを使ったテストコードを書く際の参考にしていただけたら嬉しいです！

version

Kotest: ver 5.9.1

対象者

• Kotlinでテストを書く際にbefore/afterの使い方を学びたい方
• Kotestを使いこなしたい初心者〜中級者向け
• テストの前後処理を効率的に行いたい方

Kotestのbefore/afterの種類

Kotestには多くのライフサイクル関数が用意されており、以下のようなものがあります（公式：Lifecycle hooks）：

公式ドキュメントではprepareSpecというメソッドが記載されていますが、Sanitize prepareSpec and finalizeSpec behavior でDeprecatedになり、現在は使用できないです。

前提

今回はKotestの中でもDescribeSpecを使って解説してきますが、他のKotestの書き方を使っても基本的には動作に変わりはありません。 DescribeSpecを使ったことがない方のために簡単な使い方を解説します。慣れている方は読み飛ばしてください。

DescribeSpecは、テストケースを階層構造で整理しやすいBDDスタイルのSpecです。 テスト対象の機能や振る舞いをdescribe {} ブロックで表現し、その中で条件ごとの前提をcontext{}で区切り、個別の動作確認をit{}で記述するのが特徴です。 簡単に説明すると、describeにテスト対象のクラスや関数名を記述、contextでテスト条件を指定、itで結果を記述し、個別のテストを行なっていきます。

class SampleTest : DescribeSpec({
    describe("ユーザー登録機能") {
        context("入力が正しい場合") {
            it("登録に成功すること") {
                // アサーション
            }
        }

        context("メールアドレスが無効な場合") {
            it("登録に失敗すること") {
                // アサーション
            }
        }
    }
})

このように、describe→context→itの構造にすることで、テストの意図を自然な言葉で表現でき、可読性の高いテストを書くことができます。

1. Spec単位で1回だけ実行される関数

class KotestLifecycleDemo : DescribeSpec({
    beforeSpec {
        println("[beforeSpec] Specの最初に1回だけ実行")
    }

    afterSpec {
        println("[afterSpec] Specの最後に1回だけ実行")
    }

    finalizeSpec {
        println("[finalizeSpec] Spec終了後のクリーンアップ処理")
    }

    describe("ライフサイクルテスト") {

        it("テストケース1") {
            println("→ テストケース1 実行中")
        }

        it("テストケース2") {
            println("→ テストケース2 実行中")
        }
    }
})

[beforeSpec] Specの最初に1回だけ実行
→ テストケース1 実行中
→ テストケース2 実行中
[afterSpec] Specの最後に1回だけ実行
[finalizeSpec] Spec終了後のクリーンアップ処理

SpecとはKotestにおけるテストクラスのインスタンスのことを指します。 つまり、今回のケースだとKotestLifecycleDemoインスタンスが作成された際にbeforeSpecが実行され、すべてのテストケースが終了した際にafterSpecが実行されます。 finalizeSpecはあまり使う機会はないかもしれませんが、afterSpecが実行された後に実行されます。

上記の用途としては、beforeSpecでDBのインスタンスを立ち上げて、afterSpecでDBの接続を切るといった使い方ができると思います。

2. 各テスト関数の前後で実行される関数

class KotestLifecycleDemo : DescribeSpec({
    beforeEach {
        println("[beforeEach] 各テスト単位の前に実行")
    }

    afterEach {
        println("[afterEach] 各テスト単位の後に実行")
    }

    describe("ライフサイクルテスト") {

        it("テストケース1") {
            println("→ テストケース1 実行中")
        }

        it("テストケース2") {
            println("→ テストケース2 実行中")
        }
    }
})

[beforeEach] 各テスト単位の前に実行
→ テストケース1 実行中
[afterEach] 各テスト単位の後に実行
[beforeEach] 各テスト単位の前に実行
→ テストケース2 実行中
[afterEach] 各テスト単位の後に実行

beforeEach/afterEachはシンプルで、各テスト（it）が実行される前後に実行されます。

3. describe/contextブロックの前後で実行される関数

class KotestLifecycleDemo : DescribeSpec({
    beforeContainer {
        println("[beforeContainer] Containerの前に実行")
    }

    afterContainer {
        println("[afterContainer] Containerの後に実行")
    }

    describe("ライフサイクルテスト - describe ブロック") {

        it("テストケース1") {
            println("→ テストケース1 実行中")
        }

        it("テストケース2") {
            println("→ テストケース2 実行中")
        }

        context("ライフサイクルテスト - context ブロック") {

            it("テストケース3") {
                println("→ テストケース3 実行中")
            }

            it("テストケース4") {
                println("→ テストケース4 実行中")
            }
        }
    }

    describe("テストケース5") {
        it("テストケース5") {
            println("→ テストケース5 実行中")
        }
    }

    describe("テストケース6") {}
})

[beforeContainer] Containerの前に実行
→ テストケース1 実行中
→ テストケース2 実行中
[beforeContainer] Containerの前に実行
→ テストケース3 実行中
→ テストケース4 実行中
[afterContainer] Containerの後に実行
[afterContainer] Containerの後に実行
[beforeContainer] Containerの前に実行
→ テストケース5 実行中
[afterContainer] Containerの後に実行

beforeContainer/afterContainerは、各describeやcontextブロックの中に実行対象となるテスト（it）がある場合に限り、そのブロックの実行前後に1回ずつ実行されます。
注意点として、ブロック内に有効なテストが1つもない場合（すべてスキップなど）には呼ばれません。

4. すべてのTestTypeに対して実行される関数

class KotestLifecycleDemo : DescribeSpec({

    beforeAny { testCase: TestCase ->
        println("[beforeAny] 実行前: ${testCase.name.testName} - type: ${testCase.type.name}")
    }

    afterAny { (testCase, result) ->
        println("[afterAny] 実行後: ${testCase.name.testName} - type: ${testCase.type.name} - result: ${result.status}")
    }

    describe("ライフサイクルテスト - describe ブロック") {

        it("テストケース1") {
            println("→ テストケース1 実行中")
        }

        it("テストケース2") {
            println("→ テストケース2 実行中")
        }

        context("ライフサイクルテスト - context ブロック") {

            it("テストケース3") {
                println("→ テストケース3 実行中")
            }

            it("テストケース4") {
                println("→ テストケース4 実行中")
            }
        }
    }
})

[beforeAny] 実行前: ライフサイクルテスト - describe ブロック - type: Container
[beforeAny] 実行前: テストケース1 - type: Test
→ テストケース1 実行中
[afterAny] 実行後: テストケース1 - type: Test - result: Success
[beforeAny] 実行前: テストケース2 - type: Test
→ テストケース2 実行中
[afterAny] 実行後: テストケース2 - type: Test - result: Success
[beforeAny] 実行前: ライフサイクルテスト - context ブロック - type: Container
[beforeAny] 実行前: テストケース3 - type: Test
→ テストケース3 実行中
[afterAny] 実行後: テストケース3 - type: Test - result: Success
[beforeAny] 実行前: テストケース4 - type: Test
→ テストケース4 実行中
[afterAny] 実行後: テストケース4 - type: Test - result: Success
[afterAny] 実行後: ライフサイクルテスト - context ブロック - type: Container - result: Success
[afterAny] 実行後: ライフサイクルテスト - describe ブロック - type: Container - result: Success

beforeAny/afterAnyはbeforeEach/afterEachと違って全てのTestTypeの前後で実行されます。 そもそもTestTypeとは何かについて、TestTypeはKotest内部で定義されているenumで、このTestCaseがどういう種類かを区別するために使われます。

2章で各テスト毎に実行されるbeforeEach/afterEachについて説明しましたが、これらはTestType.Testの時のみ実行され、beforeAny/afterAnyは全てのTestTypeの前後において実行されるということになります。

beforeTest/afterTestに関してはbeforeAny/afterAnyと基本的には同じ挙動なので今回は省略します。

5. テストの繰り返し（invocation）ごとに実行される関数

注意点: 第二引数のインデックスはListのインデックスと同様に 0から始まります

class KotestLifecycleDemo : DescribeSpec({

    beforeInvocation { testCase: TestCase, iteration: Int ->
        println("  → [beforeInvocation] ${testCase.name.testName} : invocation #$iteration")
    }

    afterInvocation { testCase: TestCase, iteration: Int ->
        println("  → [afterInvocation] ${testCase.name.testName} : invocation #$iteration")
    }

    describe("ライフサイクルテスト - describe ブロック") {

        it("テストケース1（3回繰り返し）").config(invocations = 3) {
            println("→ テストケース1 実行中")
        }

        it("テストケース2（1回のみ）") {
            println("→ テストケース2 実行中")
        }

        context("ライフサイクルテスト - context ブロック") {

            it("テストケース3（2回繰り返し）").config(invocations = 2) {
                println("→ テストケース3 実行中")
            }

            it("テストケース4（1回のみ）") {
                println("→ テストケース4 実行中")
            }
        }
    }
})

  → [beforeInvocation] ライフサイクルテスト - describe ブロック : invocation #0
  → [beforeInvocation] テストケース1（3回繰り返し） : invocation #0
→ テストケース1 実行中
  → [afterInvocation] テストケース1（3回繰り返し） : invocation #0
  → [beforeInvocation] テストケース1（3回繰り返し） : invocation #1
→ テストケース1 実行中
  → [afterInvocation] テストケース1（3回繰り返し） : invocation #1
  → [beforeInvocation] テストケース1（3回繰り返し） : invocation #2
→ テストケース1 実行中
  → [afterInvocation] テストケース1（3回繰り返し） : invocation #2
  → [beforeInvocation] テストケース2（1回のみ） : invocation #0
→ テストケース2 実行中
  → [afterInvocation] テストケース2（1回のみ） : invocation #0
  → [beforeInvocation] ライフサイクルテスト - context ブロック : invocation #0
  → [beforeInvocation] テストケース3（2回繰り返し） : invocation #0
→ テストケース3 実行中
  → [afterInvocation] テストケース3（2回繰り返し） : invocation #0
  → [beforeInvocation] テストケース3（2回繰り返し） : invocation #1
→ テストケース3 実行中
  → [afterInvocation] テストケース3（2回繰り返し） : invocation #1
  → [beforeInvocation] テストケース4（1回のみ） : invocation #0
→ テストケース4 実行中
  → [afterInvocation] テストケース4（1回のみ） : invocation #0
  → [afterInvocation] ライフサイクルテスト - context ブロック : invocation #0
  → [afterInvocation] ライフサイクルテスト - describe ブロック : invocation #0

KotestのitはTestWithConfigBuilderを返します。このビルダーが持つconfig関数を用いることで、各テストケースに対して設定を追加できます。 その中でもinvocationsは、同じテストを何回繰り返すかを指定するためのオプションです。

it("Sample Test").config(invocations = 3) {
    // 3回実行される
}

このように設定した場合、beforeInvocation/afterInvocationは3回それぞれの前後で呼び出され、各回のインデックス（0, 1, 2）を受け取ることができます。

補足：スキップされたテストケースには呼ばれない

各before/after関数にもテストケースが呼ばれない例外があります。 それは、スキップされたテスト（無視・無効・非アクティブな状態のテスト）にはコールバックが呼ばれないという点です。

公式ドキュメントにも、次のように明記されています：

If a test case was skipped (ignored / disabled / inactive), then this callback will not be invoked for that particular test case.

スキップされる例

以下のようなケースでは特定のライフサイクル関数は呼び出されません。

xit("無効化されたテスト") {
}

it("無効化されたテスト").config(enabled = false) {

}

まとめ

Kotestでは、テストの実行タイミングに応じてさまざまなライフサイクル関数が用意されています。 どのタイミングでどの関数が呼ばれるのかを理解しておくことで、テストコードをより効率的かつ安全に構築することができます。 是非、before/afterを上手に活用して、テストの品質を向上させましょう！！