testBalloon-framework-core/de.infix.testBalloon.framework.core

Package-level declarations

Types

Test

class Test : TestElement, AbstractTest

A test containing a test action which raises assertion errors on failure. The action may suspend.

TestBalloonExperimentalApi

annotation class TestBalloonExperimentalApi

Marker for an experimental TestBalloon API, which is not stable and may be changed or removed.

TestCompartment

open class TestCompartment(name: String, testConfig: TestConfig) : TestSuite

A compartment isolating a number of tests from those belonging to other compartments.

TestConfig

open class TestConfig

A test element's configuration, modifying the execution of tests and suites.

TestElement

sealed class TestElement : AbstractTestElement

TestElementEvent

sealed class TestElementEvent

An event occurring as part of a test element's setup or execution.

TestElementExecutionWrappingAction

typealias TestElementExecutionWrappingAction = suspend TestElement.(elementAction: suspend TestElement.() -> Unit) -> Unit

An action wrapping a TestElement's execution.

TestExecutionReport

abstract class TestExecutionReport

A report containing a sequence of test events, each of which will be added during execution.

TestExecutionScope

class TestExecutionScope : AbstractTest, CoroutineScope

TestExecutionTraversal

interface TestExecutionTraversal

A traversal following the execution across all TestElements of a (partial) test element hierarchy.

TestInvocation

enum TestInvocation : Enum<TestInvocation>

The mode in which a TestSuite executes its child TestElements.

TestPermit

@TestBalloonExperimentalApi

enum TestPermit : Enum<TestPermit>

The permit to accept a situation which would otherwise trigger an error in TestBalloon.

TestPlatform

interface TestPlatform

The platform executing tests.

TestPlatformAndroid

object TestPlatformAndroid : TestPlatform

TestPlatformJs

object TestPlatformJs : TestPlatformJsHosted

TestPlatformJsHosted

interface TestPlatformJsHosted : TestPlatform

TestPlatformJvm

object TestPlatformJvm : TestPlatform

TestPlatformNative

object TestPlatformNative : TestPlatform

TestPlatformWasmJs

object TestPlatformWasmJs : TestPlatformJsHosted

TestPlatformWasmWasi

object TestPlatformWasmWasi : TestPlatform

TestSession

open class TestSession : TestSuite, AbstractTestSession

A compilation module's root test suite, holding the module-wide default configuration.

TestSuite

open class TestSuite : TestElement, AbstractTestSuite

A test suite containing child TestElements (tests and/or suites). A suite may not contain test logic.

TestSuiteExecutionWrappingAction

typealias TestSuiteExecutionWrappingAction = suspend (testSuiteAction: suspend TestSuite.() -> Unit) -> Unit

An action wrapping the actions of a TestSuite.

Properties

jUnit4Description

@TestBalloonExperimentalApi

val TestExecutionScope.jUnit4Description: Description

The JUnit 4 description for this Test.

testPlatform

actual val testPlatform: TestPlatform

expect val testPlatform: TestPlatform

The TestPlatform currently used to execute tests.

actual val testPlatform: TestPlatform

Functions

addPermits

@TestBalloonExperimentalApi

fun TestConfig.addPermits(vararg permits: TestPermit): TestConfig

Returns a test configuration which adds permits for all TestSuites of a TestElement hierarchy.

aroundAll

fun TestConfig.aroundAll(executionWrappingAction: TestElementExecutionWrappingAction): TestConfig

Returns a test configuration which wraps executionWrappingAction around a single test element.

aroundEach

fun TestConfig.aroundEach(executionWrappingAction: TestElementExecutionWrappingAction): TestConfig

Returns a test configuration which wraps executionWrappingAction around each element of a TestElement hierarchy.

aroundEachTest

fun TestConfig.aroundEachTest(executionWrappingAction: TestElementExecutionWrappingAction): TestConfig

Returns a test configuration which wraps executionWrappingAction around each Test of a TestElement hierarchy.

coroutineContext

fun TestConfig.coroutineContext(context: CoroutineContext): TestConfig

Returns a test configuration which wraps a coroutine context around the TestElement's execution.

disable

fun TestConfig.disable(): TestConfig

Returns a test configuration which disables test execution for a TestElement hierarchy.

dispatcherWithParallelism

actual fun dispatcherWithParallelism(parallelism: Int): CoroutineDispatcher

expect fun dispatcherWithParallelism(parallelism: Int): CoroutineDispatcher

Returns a CoroutineDispatcher providing a maximum amount of parallelism, limited by the platform's capabilities.

actual fun dispatcherWithParallelism(parallelism: Int): CoroutineDispatcher

executionReport

fun TestConfig.executionReport(report: TestExecutionReport): TestConfig

Returns a test configuration which adds a TestExecutionReport to a test element hierarchy.

failFast

fun TestConfig.failFast(maxFailureCount: Int): TestConfig

Returns a test configuration which establishes a "fail fast" strategy on a TestElement hierarchy.

invocation

fun TestConfig.invocation(mode: TestInvocation): TestConfig

Returns a test configuration which specifies an invocation mode for all TestSuites of a TestElement hierarchy.

mainDispatcher

@TestBalloonExperimentalApi

fun TestConfig.mainDispatcher(dispatcher: CoroutineDispatcher? = null): TestConfig

Returns a test configuration which specifies a main dispatcher (Dispatchers.setMain) for a TestElement hierarchy.

permits

@TestBalloonExperimentalApi

fun TestConfig.permits(vararg permits: TestPermit): TestConfig

Returns a test configuration which specifies a set of permits for all TestSuites of a TestElement hierarchy.

removePermits

@TestBalloonExperimentalApi

fun TestConfig.removePermits(vararg permits: TestPermit): TestConfig

Returns a test configuration which removes permits for all TestSuites of a TestElement hierarchy.

singleThreaded

@TestBalloonExperimentalApi

fun TestConfig.singleThreaded(): TestConfig

Returns a test configuration which wraps a single-threaded dispatcher around a TestElement's execution.

testScope

fun TestConfig.testScope(isEnabled: Boolean, timeout: Duration = 60.seconds): TestConfig

Returns a test configuration which enables/disables a kotlinx.coroutines.test.TestScope for a TestElement hierarchy.

testSuite

fun testSuite(name: String = "", displayName: String = name, testConfig: TestConfig = TestConfig, content: TestSuite.() -> Unit): Lazy<TestSuite>

fun testSuite(name: String = "", displayName: String = name, compartment: () -> TestCompartment, testConfig: TestConfig = TestConfig, content: TestSuite.() -> Unit): Lazy<TestSuite>

Registers a top-level TestSuite.

testWithJUnit4Rule

@TestBalloonExperimentalApi

fun <Rule : TestRule> TestSuite.testWithJUnit4Rule(name: String, rule: Rule, action: suspend (Rule) -> Unit)

Registers a Test wrapped by a JUnit 4 TestRule.

traversal

fun TestConfig.traversal(executionTraversal: TestExecutionTraversal): TestConfig

Returns a test configuration which applies a TestExecutionTraversal to each element of a TestElement hierarchy.

withMainDispatcher

@TestBalloonExperimentalApi

suspend fun withMainDispatcher(dispatcher: CoroutineDispatcher? = null, action: suspend () -> Unit)

Runs action with dispatcher set up as the main dispatcher, which will be reset afterward.

withSingleThreadedDispatcher

@ExperimentalCoroutinesApi

actual suspend fun withSingleThreadedDispatcher(action: suspend (dispatcher: CoroutineDispatcher) -> Unit)

@TestBalloonExperimentalApi

expect suspend fun withSingleThreadedDispatcher(action: suspend (dispatcher: CoroutineDispatcher) -> Unit)

Executes action, providing it with a single-threaded CoroutineDispatcher.

@TestBalloonExperimentalApi

actual suspend fun withSingleThreadedDispatcher(action: suspend (dispatcher: CoroutineDispatcher) -> Unit)

@TestBalloonExperimentalApi

actual suspend fun withSingleThreadedDispatcher(action: suspend (dispatcher: CoroutineDispatcher) -> Unit)

@TestBalloonExperimentalApi

actual suspend fun withSingleThreadedDispatcher(action: suspend (dispatcher: CoroutineDispatcher) -> Unit)

@TestBalloonExperimentalApi

actual suspend fun withSingleThreadedDispatcher(action: suspend (dispatcher: CoroutineDispatcher) -> Unit)