orbit-test/org.orbitmvi.orbit

Package-level declarations

Types

class OrbitVerification<STATE : Any, SIDE_EFFECT : Any>

class RegularTestContainerHost<STATE : Any, SIDE_EFFECT : Any, CONTAINER_HOST : ContainerHost<STATE, SIDE_EFFECT>>(actual: CONTAINER_HOST, initialState: STATE?) : TestContainerHost<STATE, SIDE_EFFECT, CONTAINER_HOST>

SuspendingTestContainerHost

class SuspendingTestContainerHost<STATE : Any, SIDE_EFFECT : Any, CONTAINER_HOST : ContainerHost<STATE, SIDE_EFFECT>>(actual: CONTAINER_HOST, initialState: STATE?, isolateFlow: Boolean) : TestContainerHost<STATE, SIDE_EFFECT, CONTAINER_HOST>

TestContainerHost

sealed class TestContainerHost<STATE : Any, SIDE_EFFECT : Any, CONTAINER_HOST : ContainerHost<STATE, SIDE_EFFECT>>

TestFlowObserver

class TestFlowObserver<T>(flow: Flow<T>)

Allows you to record all observed values of a flow for easy testing.

TestSettingsBuilder

class TestSettingsBuilder

Functions

liveTest

fun <STATE : Any, SIDE_EFFECT : Any, CONTAINER_HOST : ContainerHost<STATE, SIDE_EFFECT>> CONTAINER_HOST.~~liveTest~~(initialState: STATE? = null, buildSettings: LiveTestSettingsBuilder.() -> Unit = {}): RegularTestContainerHost<STATE, SIDE_EFFECT, CONTAINER_HOST>

Puts your ContainerHost into live test mode. This mode uses a real Orbit container with some basic test settings. Orbit dispatchers are overridden with UnconfinedTestDispatcher by default.

test

fun <STATE : Any, SIDE_EFFECT : Any, CONTAINER_HOST : ContainerHost<STATE, SIDE_EFFECT>> CONTAINER_HOST.~~test~~(initialState: STATE? = null, buildSettings: TestSettingsBuilder.() -> Unit = {}): SuspendingTestContainerHost<STATE, SIDE_EFFECT, CONTAINER_HOST>

fun <STATE : Any, SIDE_EFFECT : Any, CONTAINER_HOST : ContainerHost<STATE, SIDE_EFFECT>> CONTAINER_HOST.~~test~~(initialState: STATE? = null, isolateFlow: Boolean = true, buildSettings: TestSettingsBuilder.() -> Unit = {}): SuspendingTestContainerHost<STATE, SIDE_EFFECT, CONTAINER_HOST>

Puts your ContainerHost into suspending test mode. Intents are intercepted and executed as suspending functions.

testFlowObserver

fun <T> Flow<T>.testFlowObserver(): TestFlowObserver<T>

Allows you to put a Flow into test mode.