orbit-test/org.orbitmvi.orbit.test

Package-level declarations

Types

sealed class Item<STATE : Any, SIDE_EFFECT : Any>

interface OrbitTestContext<STATE : Any, SIDE_EFFECT : Any, CONTAINER_HOST : ContainerHost<STATE, SIDE_EFFECT>>

class RealOrbitTestContext<STATE : Any, SIDE_EFFECT : Any, CONTAINER_HOST : ContainerHost<STATE, SIDE_EFFECT>>(val containerHost: CONTAINER_HOST, initialState: STATE?, emissions: ReceiveTurbine<Item<STATE, SIDE_EFFECT>>) : OrbitTestContext<STATE, SIDE_EFFECT, CONTAINER_HOST>

TestSettings

data class TestSettings(val dispatcherOverride: CoroutineDispatcher? = null, val exceptionHandlerOverride: CoroutineExceptionHandler? = null)

Functions

test

suspend fun <STATE : Any, SIDE_EFFECT : Any, CONTAINER_HOST : ContainerHost<STATE, SIDE_EFFECT>> CONTAINER_HOST.test(testScope: TestScope, initialState: STATE? = null, timeout: Duration? = null, settings: TestSettings = TestSettings(), validate: suspend OrbitTestContext<STATE, SIDE_EFFECT, CONTAINER_HOST>.() -> Unit)

Run tests on your ContainerHost. This mode uses a real Orbit container, but the container's CoroutineDispatcher is set to the TestScope's background dispatcher.