Turbine/app.cash.turbine

Package-level declarations

Types

Event

sealed interface Event<out T>

ReceiveTurbine

interface ReceiveTurbine<T>

Turbine

interface Turbine<T> : ReceiveTurbine<T>

A standalone Turbine suitable for usage in fakes or other external test components.

TurbineContext

interface TurbineContext : CoroutineScope

TurbineTestContext

interface TurbineTestContext<T> : TurbineContext, ReceiveTurbine<T>

Functions

awaitComplete

suspend fun <T> ReceiveChannel<T>.awaitComplete(name: String? = null)

Assert that attempting to read from the ReceiveChannel yields ClosedReceiveChannelException, indicating that it was closed without an exception.

awaitError

suspend fun <T> ReceiveChannel<T>.awaitError(name: String? = null): Throwable

Assert that attempting to read from the ReceiveChannel yields an exception, indicating that it was closed with an exception.

awaitEvent

suspend fun <T> ReceiveChannel<T>.awaitEvent(name: String? = null): Event<T>

Assert that an event was received and return it. This function will suspend if no events have been received.

awaitItem

suspend fun <T> ReceiveChannel<T>.awaitItem(name: String? = null): T

Assert that the next event received was an item and return it. This function will suspend if no events have been received.

expectMostRecentItem

fun <T> ReceiveChannel<T>.expectMostRecentItem(name: String? = null): T

Returns the most recent item that has already been received. If channel was closed with no item being received previously, this function will throw an AssertionError. If channel was closed with an exception, this function will throw the underlying exception.

expectNoEvents

fun <T> ReceiveChannel<T>.expectNoEvents(name: String? = null)

Assert that there are no unconsumed events which have already been received.

plusAssign

operator fun <T> Turbine<T>.plusAssign(value: T)

skipItems

suspend fun <T> ReceiveChannel<T>.skipItems(count: Int, name: String? = null)

Assert that count item events were received and ignore them. This function will suspend if no events have been received.

takeComplete

fun <T> ReceiveChannel<T>.takeComplete(name: String? = null)

Assert that the next event received is Event.Complete. This function will not suspend. On JVM and Android, it will attempt to throw if invoked in a suspending context.

takeError

fun <T> ReceiveChannel<T>.takeError(name: String? = null): Throwable

Assert that the next event received is Event.Error, and return the error. This function will not suspend. On JVM and Android, it will attempt to throw if invoked in a suspending context.

takeEvent

fun <T> ReceiveChannel<T>.takeEvent(name: String? = null): Event<T>

Assert that the next event received was non-null and return it. This function will not suspend. On JVM and Android, it will attempt to throw if invoked in a suspending context.

takeItem

fun <T> ReceiveChannel<T>.takeItem(name: String? = null): T

Assert that the next event received was an item and return it. This function will not suspend. On JVM and Android, it will attempt to throw if invoked in a suspending context.

test

suspend fun <T> Flow<T>.test(timeout: Duration? = null, name: String? = null, validate: suspend TurbineTestContext<T>.() -> Unit)

Terminal flow operator that collects events from given flow and allows the validate lambda to consume and assert properties on them in order. If any exception occurs during validation the exception is rethrown from this method.

testIn

fun <T> Flow<T>.testIn(scope: CoroutineScope, timeout: Duration? = null, name: String? = null): ReceiveTurbine<T>

Terminal flow operator that collects events from given flow and returns a ReceiveTurbine for consuming and asserting properties on them in order. If any exception occurs during validation the exception is rethrown from this method.

Turbine

fun <T> Turbine(timeout: Duration? = null, name: String? = null): Turbine<T>

Construct a standalone Turbine.

turbineScope

suspend fun turbineScope(timeout: Duration? = null, validate: suspend TurbineContext.() -> Unit)

Run a validation block that catches and reports all unhandled exceptions in flows run by Turbine.

withTurbineTimeout

suspend fun <T> withTurbineTimeout(timeout: Duration, block: suspend CoroutineScope.() -> T): T

Sets a timeout for all Turbine instances within this context. If this timeout is not set, the default value is 3sec.