orbit-test/org.orbitmvi.orbit.test/OrbitScopedTestContextInternal

OrbitScopedTestContextInternal

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

Constructors

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

Properties

containerHost

val containerHost: CONTAINER_HOST

Functions

awaitInternalState

suspend fun awaitInternalState(): INTERNAL_STATE

Return the next internal state received. This function will suspend if no items have been received.

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.

expectInternalState

suspend fun expectInternalState(expected: INTERNAL_STATE)

Awaits for an internal state and checks if it matches the expected internal state.

suspend fun expectInternalState(expectedChange: INTERNAL_STATE.() -> INTERNAL_STATE)

Awaits for an internal state and checks if it matches the expected internal state change from the previous internal state.

expectInternalStateOn

inline suspend fun <LAST_STATE : INTERNAL_STATE> expectInternalStateOn(expectedChange: LAST_STATE.() -> INTERNAL_STATE)

Awaits for an internal state and checks if it matches the expected internal state change from the previous internal state, ensuring the last internal state is of the expected type.

expectNoItems

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

runOnCreate

fun runOnCreate(): Job

Invoke onCreate lambda for the OrbitContainerHost.

skipItems

suspend fun skipItems(count: Int)

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