Power-assert コンパイラプラグイン

DANGER

Power-assert コンパイラプラグインは実験的です。

これはいつでも変更される可能性があります。評価目的のみで使用してください。

YouTrackでのフィードバックをお待ちしております。

Kotlin Power-assert コンパイラプラグインは、コンテキスト情報を含む詳細な失敗メッセージを提供することで、デバッグ体験を向上させます。失敗メッセージに中間値を自動生成することで、テスト記述のプロセスを簡素化します。複雑なアサーションライブラリを必要とせずに、テストが失敗した理由を理解するのに役立ちます。

以下は、プラグインによって提供されるメッセージの例です。

text

Incorrect length
assert(hello.length == world.substring(1, 4).length) { "Incorrect length" }
       |     |      |  |     |               |
       |     |      |  |     |               3
       |     |      |  |     orl
       |     |      |  world!
       |     |      false
       |     5
       Hello

Power-assert プラグインの主な機能は次のとおりです。

強化されたエラーメッセージ: プラグインは、アサーション内の変数やサブ式の値をキャプチャして表示し、失敗の原因を明確に特定します。
テストの簡素化: 有益な失敗メッセージを自動的に生成し、複雑なアサーションライブラリの必要性を減らします。
複数の関数をサポート: デフォルトでは、assert() 関数の呼び出しを変換しますが、require()、check()、assertTrue() などの他の関数も変換できます。

プラグインの適用

Power-assert プラグインを有効にするには、build.gradle(.kts) ファイルを次のように設定します。

KotlinGroovy

kotlin

// build.gradle.kts
plugins {
    kotlin("multiplatform") version "2.0.0"
    kotlin("plugin.power-assert") version "2.0.0"
}

groovy

// build.gradle
plugins {
    id 'org.jetbrains.kotlin.multiplatform' version '2.0.0'
    id 'org.jetbrains.kotlin.plugin.power-assert' version '2.0.0'
}

プラグインの設定

Power-assert プラグインは、その動作をカスタマイズするためのいくつかのオプションを提供します。

functions: 完全修飾関数パスのリストです。Power-assert プラグインは、これらの関数への呼び出しを変換します。指定しない場合、デフォルトで kotlin.assert() 呼び出しのみが変換されます。
includedSourceSets: Power-assert プラグインが変換するGradleソースセットのリストです。指定しない場合、デフォルトで すべてのテストソースセット が変換されます。

動作をカスタマイズするには、powerAssert {} ブロックをビルドスクリプトファイルに追加します。

KotlinGroovy

kotlin

// build.gradle.kts
powerAssert {
    functions = listOf("kotlin.assert", "kotlin.test.assertTrue", "kotlin.test.assertEquals", "kotlin.test.assertNull")
    includedSourceSets = listOf("commonMain", "jvmMain", "jsMain", "nativeMain")
}

groovy

// build.gradle
powerAssert {
    functions = ["kotlin.assert", "kotlin.test.assertTrue", "kotlin.test.assertEquals", "kotlin.test.assertNull"]
    includedSourceSets = ["commonMain", "jvmMain", "jsMain", "nativeMain"]
}

このプラグインは実験的であるため、アプリをビルドするたびに警告が表示されます。これらの警告を除外するには、powerAssert {} ブロックを宣言する前にこの @OptIn アノテーションを追加します。

kotlin

import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi

@OptIn(ExperimentalKotlinGradlePluginApi::class)
powerAssert {
    ...
}

プラグインの使用

このセクションでは、Power-assert コンパイラプラグインの使用例を説明します。

これらのすべての例のビルドスクリプトファイル build.gradle.kts の完全なコードについては、以下を参照してください。

kotlin

import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi

plugins {
    kotlin("jvm") version "2.1.21"
    kotlin("plugin.power-assert") version "2.1.21"
}

group = "org.example"
version = "1.0-SNAPSHOT"

repositories {
    mavenCentral()
}

dependencies {
    testImplementation(kotlin("test"))
}

tasks.test {
    useJUnitPlatform()
}

@OptIn(ExperimentalKotlinGradlePluginApi::class)
powerAssert {
    functions = listOf("kotlin.assert", "kotlin.test.assertEquals", "kotlin.test.assertTrue", "kotlin.test.assertNull", "kotlin.require", "org.example.AssertScope.assert")
}

`assert`関数

assert() 関数を使用した次のテストを考えてみましょう。

kotlin

import kotlin.test.Test

class SampleTest {

    @Test
    fun testFunction() {
        val hello = "Hello"
        val world = "world!"
        assert(hello.length == world.substring(1, 4).length) { "Incorrect length" }
    }
}

Power-assert プラグインを有効にして testFunction() テストを実行すると、明示的な失敗メッセージが表示されます。

text

Incorrect length
assert(hello.length == world.substring(1, 4).length) { "Incorrect length" }
       |     |      |  |     |               |
       |     |      |  |     |               3
       |     |      |  |     orl
       |     |      |  world!
       |     |      false
       |     5
       Hello

より完全なエラーメッセージを取得するには、常に変数をテスト関数の引数にインライン化してください。次のテスト関数を考えてみましょう。

kotlin

class ComplexExampleTest {

    data class Person(val name: String, val age: Int)
 
    @Test
    fun testComplexAssertion() {
        val person = Person("Alice", 10)
        val isValidName = person.name.startsWith("A") && person.name.length > 3
        val isValidAge = person.age in 21..28
        assert(isValidName && isValidAge)
    }
}

実行されたコードの出力は、問題の原因を見つけるのに十分な情報を提供しません。

text

Assertion failed
assert(isValidName && isValidAge)
       |              |
       |              false
       true

変数を assert() 関数にインライン化します。

kotlin

class ComplexExampleTest {

    data class Person(val name: String, val age: Int)

    @Test
    fun testComplexAssertion() {
        val person = Person("Alice", 10)
        assert(person.name.startsWith("A") && person.name.length > 3 && person.age > 20 && person.age < 29)
    }
}

実行後、何が問題だったかについてのより明示的な情報が得られます。

text

Assertion failed
assert(person.name.startsWith("A") && person.name.length > 3 && person.age > 20 && person.age < 29)
       |      |    |                  |      |    |      |      |      |   |
       |      |    |                  |      |    |      |      |      |   false
       |      |    |                  |      |    |      |      |      10
       |      |    |                  |      |    |      |      Person(name=Alice, age=10)
       |      |    |                  |      |    |      true
       |      |    |                  |      |    5
       |      |    |                  |      Alice
       |      |    |                  Person(name=Alice, age=10)
       |      |    true
       |      Alice
       Person(name=Alice, age=10)

`assert`関数以外のサポート

Power-assert プラグインは、デフォルトで変換される assert 以外のさまざまな関数を変換できます。 require()、check()、assertTrue()、assertEqual() などの関数も、最後の引数として String または () -> String の値を取る形式であれば変換できます。

テストで新しい関数を使用する前に、ビルドスクリプトファイルの powerAssert {} ブロックでその関数を指定します。たとえば、require() 関数を考えます。

kotlin

// build.gradle.kts
import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi

@OptIn(ExperimentalKotlinGradlePluginApi::class)
powerAssert {
    functions = listOf("kotlin.assert", "kotlin.require")
}

関数を追加した後、テストで使用できます。

kotlin

class RequireExampleTest {

    @Test
    fun testRequireFunction() {
        val value = ""
        require(value.isNotEmpty()) { "Value should not be empty" }
    }
}

この例の出力では、Power-assert プラグインが失敗したテストに関する詳細情報を提供します。

text

Value should not be empty
require(value.isNotEmpty()) { "Value should not be empty" }
        |     |
        |     false

このメッセージは、失敗につながった中間値を示しており、デバッグを容易にします。

ソフトアサーション

Power-assert プラグインはソフトアサーションをサポートしており、これはテストを即座に失敗させるのではなく、アサーションの失敗を収集し、テスト実行の最後にまとめて報告します。これは、最初の失敗で停止することなく、単一の実行ですべてのアサーションの失敗を確認したい場合に役立ちます。

ソフトアサーションを有効にするには、エラーメッセージを収集する方法を実装します。

kotlin

fun <R> assertSoftly(block: AssertScope.() -> R): R {
    val scope = AssertScopeImpl()
    val result = scope.block()
    if (scope.errors.isNotEmpty()) {
        throw AssertionError(scope.errors.joinToString("
"))
    }
    return result
}

interface AssertScope {
    fun assert(assertion: Boolean, message: (() -> String)? = null)
}

class AssertScopeImpl : AssertScope {
    val errors = mutableListOf<String>()
    override fun assert(assertion: Boolean, message: (() -> String)?) {
        if (!assertion) {
            errors.add(message?.invoke() ?: "Assertion failed")
        }
    }
}

これらの関数を powerAssert {} ブロックに追加して、Power-assert プラグインで使用できるようにします。

kotlin

@OptIn(ExperimentalKotlinGradlePluginApi::class)
powerAssert {
    functions = listOf("kotlin.assert", "kotlin.test.assert", "org.example.AssertScope.assert")
}

TIP

AssertScope.assert() 関数を宣言するパッケージの完全名を指定する必要があります。

その後、テストコードでそれを使用できます。

kotlin

// Import the assertSoftly() function
import org.example.assertSoftly
        
class SoftAssertExampleTest1 {

    data class Employee(val name: String, val age: Int, val salary: Int)

    @Test
    fun `test employees data`() {
        val employees = listOf(
            Employee("Alice", 30, 60000),
            Employee("Bob", 45, 80000),
            Employee("Charlie", 55, 40000),
            Employee("Dave", 150, 70000)
        )

        assertSoftly {
            for (employee in employees) {
                assert(employee.age < 100) { "${employee.name} has an invalid age: ${employee.age}" }
                assert(employee.salary > 50000) { "${employee.name} has an invalid salary: ${employee.salary}" }
            }
        }
    }
}

出力では、すべての assert() 関数のエラーメッセージが連続して出力されます。

text

Charlie has an invalid salary: 40000
assert(employee.salary > 50000) { "${employee.name} has an invalid salary: ${employee.salary}" }
       |        |      |
       |        |      false
       |        40000
       Employee(name=Charlie, age=55, salary=40000)
Dave has an invalid age: 150
assert(employee.age < 100) { "${employee.name} has an invalid age: ${employee.age}" }
       |        |   |
       |        |   false
       |        150
       Employee(name=Dave, age=150, salary=70000)

次のステップ

プラグインを有効にしたシンプルなプロジェクトと、複数のソースセットを持つより複雑なプロジェクトを参照してください。

基本型

ビルダー

Spring

Spring Boot を使用して RESTful Web サービスとデータベースを作成する

Java から Kotlin への移行ガイド

C 相互運用

Objective-C 相互運用

メモリ管理

参照とヒント

JS プラットフォーム向け Kotlin

Gradle

Dokka の実行

出力形式

Power-assert コンパイラプラグイン

プラグインの適用

プラグインの設定

プラグインの使用

`assert`関数

`assert`関数以外のサポート

ソフトアサーション

次のステップ

Spring Boot を使用して RESTful Web サービスとデータベースを作成する

Power-assert コンパイラプラグイン ​

プラグインの適用 ​

プラグインの設定 ​

プラグインの使用 ​

assert関数 ​

assert関数以外のサポート ​

ソフトアサーション ​

次のステップ ​

Power-assert コンパイラプラグイン

プラグインの適用

プラグインの設定

プラグインの使用

`assert`関数

`assert`関数以外のサポート

ソフトアサーション

次のステップ