orbit-test/org.orbitmvi.orbit.test/OrbitTestContext

OrbitTestContext

class OrbitTestContext<STATE : Any, SIDE_EFFECT : Any, CONTAINER_HOST : ContainerHost<STATE, SIDE_EFFECT>>(val containerHost: CONTAINER_HOST, resolvedInitialState: STATE, emissions: ReceiveTurbine<Item<STATE, SIDE_EFFECT>>, settings: TestSettings)(source)

Constructors

OrbitTestContext

constructor(containerHost: CONTAINER_HOST, resolvedInitialState: STATE, emissions: ReceiveTurbine<Item<STATE, SIDE_EFFECT>>, settings: TestSettings)

Properties

containerHost

val containerHost: CONTAINER_HOST

Functions

awaitItem

suspend fun awaitItem(): Item<STATE, SIDE_EFFECT>

Return the next item 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.

awaitState

suspend fun awaitState(): STATE

Return the next state received. This function will suspend if no states 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.

expectInitialState

suspend fun ~~expectInitialState~~()

Sanity check assertion. Checks if the initial state is emitted and matches the initial state defined for the production container (or the one specified in the test).

expectNoItems

suspend 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

expectState

suspend fun expectState(expected: STATE)

Awaits for a state and checks if it matches the expected state.

suspend fun expectState(expectedChange: STATE.() -> STATE)

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

expectStateOn

inline suspend fun <LAST_STATE : STATE> expectStateOn(expectedChange: LAST_STATE.() -> STATE)

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

runOnCreate

fun runOnCreate(): Job

Invoke onCreate lambda for the ContainerHost.

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.