orbit-test/org.orbitmvi.orbit.test/OrbitScopedTestContextBase

OrbitScopedTestContextBase

abstract class OrbitScopedTestContextBase<INTERNAL_STATE : Any, EXTERNAL_STATE : Any, SIDE_EFFECT : Any, CONTAINER_HOST : OrbitContainerHost<INTERNAL_STATE, EXTERNAL_STATE, SIDE_EFFECT>>(val containerHost: CONTAINER_HOST, emissions: ReceiveTurbine<ItemWithInternalAndExternalState<INTERNAL_STATE, EXTERNAL_STATE, SIDE_EFFECT>>)(source)

Inheritors

OrbitScopedTestContextExternal

OrbitScopedTestContextInternal

OrbitScopedTestContextInternalAndExternal

Constructors

OrbitScopedTestContextBase

constructor(containerHost: CONTAINER_HOST, emissions: ReceiveTurbine<ItemWithInternalAndExternalState<INTERNAL_STATE, EXTERNAL_STATE, SIDE_EFFECT>>)

Properties

val containerHost: CONTAINER_HOST

Functions

awaitSideEffect

suspend fun awaitSideEffect(): SIDE_EFFECT

Return the next side effect received. This function will suspend if no side effects have been received.

cancelAndIgnoreRemainingItems

suspend fun cancelAndIgnoreRemainingItems()

Finish this test and ignore any events which have already been received. This also cancels any in-progress intents.

fun expectNoItems()

Assert there are no unconsumed items

expectSideEffect

suspend fun expectSideEffect(expected: SIDE_EFFECT)

Awaits for a side effect and checks if it matches the expected side effect

fun runOnCreate(): Job

Invoke onCreate lambda for the OrbitContainerHost.

suspend fun skipItems(count: Int)

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