Power-assert 编译器插件

Power-assert 编译器插件是实验性的。 它可能随时更改。仅将其用于评估目的。 我们非常感谢您在 YouTrack 中提供反馈。

Kotlin Power-assert 编译器插件通过提供包含上下文信息的详细失败消息，改善了调试体验。它通过在失败消息中自动生成中间值来简化测试编写过程。它帮助您无需复杂的断言库即可理解测试失败的原因。

这是插件提供的示例消息：

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

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

// 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：一个完全限定函数路径的 list。Power-assert 插件将转换对这些函数的调用。如果未指定，默认情况下仅转换 kotlin.assert() 调用。
• includedSourceSets：一个 Gradle 源代码集 list，Power-assert 插件将转换这些源代码集。如果未指定，默认情况下将转换所有 测试源代码集。

要定制行为，请将 powerAssert {} 代码块添加到您的构建脚本文件：

KotlinGroovy

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

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

由于该插件是实验性的，每次构建您的应用时都会看到警告。要排除这些警告，请在声明 powerAssert {} 代码块之前添加 @OptIn 注解：

import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi

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

使用插件

本节提供了使用 Power-assert 编译器插件的示例。

关于所有这些示例，请参见构建脚本文件 build.gradle.kts 的完整代码：

import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi

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

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() 函数的测试：

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() 测试，您将获得显式的失败消息：

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

要获取更完整的错误消息，请始终将变量内联到测试函数的形参中。考虑以下测试函数：

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)
    }
}

执行代码的输出没有提供足够的信息来找到问题的原因：

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

将变量内联到 assert() 函数中：

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)
    }
}

执行后，您将获得关于出了什么问题的更显式的信息：

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() 函数：

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

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

添加函数后，您可以在测试中使用它：

class RequireExampleTest {

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

此示例的输出使用 Power-assert 插件提供关于失败测试的详细信息：

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

该消息显示了导致失败的中间值，从而使调试更容易。

软断言

Power-assert 插件支持软断言，它不会立即使测试失败，而是收集断言失败并在测试运行结束时报告。当您希望在单次运行中查看所有断言失败而不会在第一次失败时停止时，这会很有用。

要启用软断言，请实现您将收集错误消息的方式：

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 插件使用：

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

您应该指定声明 AssertScope.assert() 函数的包的完整名称。

之后，您可以在您的测试代码中使用它：

// 导入 assertSoftly() 函数
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() 函数的错误消息将逐一打印：

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)

接下来

• 查阅一个已启用插件的简单项目 和一个包含多个源代码集的更复杂项目。