Execute with Kotlin-test

commonjsjvm

Execute Prepared tests alongside tests written using the standard test library.

Prepared tests are declared in subclasses of TestExecutor.

class FooTest : TestExecutor() {

    // Declare tests normally using the
    // @Test annotation
    @Test
    fun helloWorld() {
        assertEquals("Hello world", "Hello world")
    }

    // Declare tests using the Prepared syntax
    // in the 'register' function
    override fun SuiteDsl.register() {
        test("Hello world") {
            assertEquals("Hello world", "Hello world")
        }

        suite("A group of related tests") {
            test("Control the time") {
                println("Current time: ${time.nowMillis}ms")
            }

            test("Control randomness") {
                random.setSeed(1)

                println("Random value: ${random.nextInt()}")
            }
        }
    }
}

Configuration

JVM project

// build.gradle.kts

plugins {
    kotlin("jvm") version "…"
}

dependencies {
    implementation("dev.opensavvy.prepared:runner-kotlin-test:…")
}

tasks.withType<Test> {
    useJUnitPlatform()
}

Multiplatform project

// build.gradle.kts

plugins {
    kotlin("multiplatform") version "…"
}

kotlin {
    jvm()
    js()

    sourceSets.commonTest.dependencies {
        implementation("dev.opensavvy.prepared:runner-kotlin-test:…")
    }
}

tasks.withType<Test> {
    useJUnitPlatform()
}

Implementation notes and limitations

The kotlin-test library doesn't allow declaring tests dynamically on all platforms. This module implements test execution on each platform differently. To learn more, select a platform at the top of this page (below the title).

For this library to be usable in the long term, and in all platforms, we need JetBrains to provide a low-level way to declare tests dynamically for all platforms. If you'd like to support this, please vote for KT-46899.

Before using this runner, you may want to browse its planned work.

Execute Prepared tests alongside tests written using the standard test library.

How it works

We use the kotlin-test library's FrameworkAdapter to declare Prepared as an additional test framework.

Execute Prepared tests alongside tests written using the standard test library.

How it works

We use the JUnit5 dynamic test API to declare tests.

Limitations

This is only compatible with JUnit5, not JUnit4. To ensure your tests run, remember to configure Gradle:

// For kotlin("jvm")
tasks.test {
    useJUnitPlatform()
}

// For kotlin("multiplatform")
kotlin {
    jvm {
        testRuns.named("test") {
            executionTask.configure {
                useJUnitPlatform()
            }
        }
    }
}

Packages

opensavvy.prepared.runner.kotlin