test-utils-base/com.splendo.kaluga.test.base

Package-level declarations

Types

typealias ActionBlock = suspend () -> Unit

abstract class BaseFlowTest<Configration, Context : BaseUIThreadTest.TestContext, T, F : Flow<T>>(val scope: CoroutineScope = MainScope(), val logger: Logger? = null) : BaseUIThreadTest<Configration, Context> , CoroutineScope

actual open class BaseTest

actual open class BaseTest

expect open class BaseTest

actual open class BaseTest

actual open class BaseTest

BaseUIThreadTest

abstract class BaseUIThreadTest<Configuration, Context : BaseUIThreadTest.TestContext> : BaseTest

This class allows a test block to be run on the UI thread inside a custom context that is also created in the UI Thread using a configuration.

abstract class FlowableTest<T> : BaseTest

abstract class FlowTest<T, F : Flow<T>>(scope: CoroutineScope = MainScope()) : BaseFlowTest<Unit, BaseUIThreadTest.EmptyTestContext, T, F>

typealias FlowTestBlock<T, F> = suspend FlowTest<T, F>.(F) -> Unit

FlowTestBlockWithContext

typealias FlowTestBlockWithContext<Configuration, Context, T, F> = suspend BaseFlowTest<Configuration, Context, T, F>.(F) -> Unit

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

actual annotation class IgnoreJs

Marks a test or test class to be skipped on the JS target.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

actual annotation class IgnoreJs

Marks a test or test class to be skipped on the JS target.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

expect annotation class IgnoreJs

Marks a test or test class to be skipped on the JS target.

actual typealias IgnoreJs = Ignore

typealias IgnoreJs = Ignore

Marks a test or test class to be skipped on the JS target.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

actual annotation class IgnoreJs

Marks a test or test class to be skipped on the JS target.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

actual annotation class IgnoreJs

Marks a test or test class to be skipped on the JS target.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

actual annotation class IgnoreWasm

Marks a test or test class to be skipped on the Kotlin/Wasm target.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

actual annotation class IgnoreWasm

Marks a test or test class to be skipped on the Kotlin/Wasm target.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

expect annotation class IgnoreWasm

Marks a test or test class to be skipped on the Kotlin/Wasm target.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

actual annotation class IgnoreWasm

Marks a test or test class to be skipped on the Kotlin/Wasm target.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

actual annotation class IgnoreWasm

Marks a test or test class to be skipped on the Kotlin/Wasm target.

actual typealias IgnoreWasm = Ignore

typealias IgnoreWasm = Ignore

Marks a test or test class to be skipped on the Kotlin/Wasm target.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

actual annotation class IgnoreWeb

Marks a test or test class to be skipped on both web targets (Kotlin/JS and Kotlin/Wasm) — a shortcut for applying both IgnoreJs and IgnoreWasm.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

actual annotation class IgnoreWeb

Marks a test or test class to be skipped on both web targets (Kotlin/JS and Kotlin/Wasm) — a shortcut for applying both IgnoreJs and IgnoreWasm.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

expect annotation class IgnoreWeb

Marks a test or test class to be skipped on both web targets (Kotlin/JS and Kotlin/Wasm) — a shortcut for applying both IgnoreJs and IgnoreWasm.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

actual annotation class IgnoreWeb

Marks a test or test class to be skipped on both web targets (Kotlin/JS and Kotlin/Wasm) — a shortcut for applying both IgnoreJs and IgnoreWasm.

actual typealias IgnoreWeb = Ignore

typealias IgnoreWeb = Ignore

Marks a test or test class to be skipped on both web targets (Kotlin/JS and Kotlin/Wasm) — a shortcut for applying both IgnoreJs and IgnoreWasm.

ScopeActionBlock

typealias ScopeActionBlock<Context> = suspend Context.() -> Unit

abstract class SimpleFlowTest<T>(scope: CoroutineScope = MainScope()) : FlowTest<T, Flow<T>>

SimpleUIThreadTest

open class SimpleUIThreadTest : UIThreadTest<SimpleUIThreadTest.SimpleTestContext>

typealias TestBlock<Context, T> = suspend Context.(T) -> Unit

abstract class UIThreadTest<Context : UIThreadTest.TestContext> : BaseUIThreadTest<Unit, Context>

This class allows a test block to be run on the UI thread inside a custom context that is also created in the UI Thread.

Properties

DEFAULT_MULTIPLE_TIMES_YIELDS

const val DEFAULT_MULTIPLE_TIMES_YIELDS: Int = 10

Functions

suspend fun <T> Flow<T>.assertEmits(expected: T, message: String = "", timeout: Duration = defaultTimeout)

Asserts that the flow emits an element matching expected within timeout.

suspend fun <T> Flow<T>.assertEmits(message: String = "", timeout: Duration = defaultTimeout, condition: suspend (T) -> Boolean)

Asserts that the flow emits an element matching condition within timeout.

awaitAllBlocking

fun <T> awaitAllBlocking(vararg deferreds: Deferred<T>): List<T>

suspend fun <T> Flow<T>.awaitFirst(message: String = "", timeout: Duration = defaultTimeout, condition: suspend (T) -> Boolean = { true }): T

suspend fun <T> Flow<T>.captureFor(duration: Duration): List<T>

Returns a list of flow items captured for duration

fun mainBackground(args: Array<String>)

testBlockingAndCancelScope

fun testBlockingAndCancelScope(context: CoroutineContext = EmptyCoroutineContext, block: suspend CoroutineScope.() -> Unit): TestResult

Runs block as a test and then cancels any coroutines it left running in the runner's scope, so a test that deliberately launches a never-completing child (e.g. an infinite collector) does not hang.

testRunBlocking

actual fun testRunBlocking(context: CoroutineContext, block: suspend CoroutineScope.() -> Unit): TestResult

Runs block as the body of a test and returns a TestResult that the Kotlin test framework awaits: it blocks until completion on JVM/Native, and returns the backing Promise on js/wasmJs (which is single-threaded and cannot block). Returning the result from a @Test function is what lets suspending tests actually run on the JS family, rather than firing-and-forgetting as a bare com.splendo.kaluga.base.runBlocking would.

actual fun testRunBlocking(context: CoroutineContext, block: suspend CoroutineScope.() -> Unit): TestResult

Runs block as the body of a test and returns a TestResult that the Kotlin test framework awaits: it blocks until completion on JVM/Native, and returns the backing Promise on js/wasmJs (which is single-threaded and cannot block). Returning the result from a @Test function is what lets suspending tests actually run on the JS family, rather than firing-and-forgetting as a bare com.splendo.kaluga.base.runBlocking would.

expect fun testRunBlocking(context: CoroutineContext = EmptyCoroutineContext, block: suspend CoroutineScope.() -> Unit): TestResult

Runs block as the body of a test and returns a TestResult that the Kotlin test framework awaits: it blocks until completion on JVM/Native, and returns the backing Promise on js/wasmJs (which is single-threaded and cannot block). Returning the result from a @Test function is what lets suspending tests actually run on the JS family, rather than firing-and-forgetting as a bare com.splendo.kaluga.base.runBlocking would.

actual fun testRunBlocking(context: CoroutineContext, block: suspend CoroutineScope.() -> Unit): TestResult

Runs block as the body of a test and returns a TestResult that the Kotlin test framework awaits: it blocks until completion on JVM/Native, and returns the backing Promise on js/wasmJs (which is single-threaded and cannot block). Returning the result from a @Test function is what lets suspending tests actually run on the JS family, rather than firing-and-forgetting as a bare com.splendo.kaluga.base.runBlocking would.

actual fun testRunBlocking(context: CoroutineContext, block: suspend CoroutineScope.() -> Unit): TestResult

Runs block as the body of a test and returns a TestResult that the Kotlin test framework awaits: it blocks until completion on JVM/Native, and returns the backing Promise on js/wasmJs (which is single-threaded and cannot block). Returning the result from a @Test function is what lets suspending tests actually run on the JS family, rather than firing-and-forgetting as a bare com.splendo.kaluga.base.runBlocking would.

actual fun testRunBlocking(context: CoroutineContext, block: suspend CoroutineScope.() -> Unit): TestResult

Runs block as the body of a test and returns a TestResult that the Kotlin test framework awaits: it blocks until completion on JVM/Native, and returns the backing Promise on js/wasmJs (which is single-threaded and cannot block). Returning the result from a @Test function is what lets suspending tests actually run on the JS family, rather than firing-and-forgetting as a bare com.splendo.kaluga.base.runBlocking would.

suspend fun yieldMultiple(times: Int = DEFAULT_MULTIPLE_TIMES_YIELDS)

Calls yield for a number of times

suspend fun yieldUntil(timeout: Duration = Duration.INFINITE, timesPerTurn: Int = DEFAULT_MULTIPLE_TIMES_YIELDS, delayPerTurn: Duration = 10.milliseconds, constraint: () -> Boolean)

Calls yield until a constraint is met. After yielding a number of times there is a delay to prevent maxing out the CPU.