orbit-test/org.orbitmvi.orbit

Package org.orbitmvi.orbit

Types

Link copied to clipboard
class LiveTestSettingsBuilder
Content copied to clipboard
Link copied to clipboard
class OrbitVerification<STATE : Any, SIDE_EFFECT : Any>
Content copied to clipboard
Link copied to clipboard
class RegularTestContainerHost<STATE : Any, SIDE_EFFECT : Any, CONTAINER_HOST>(actual: CONTAINER_HOST, initialState: STATE?) : TestContainerHost<STATE, SIDE_EFFECT, CONTAINER_HOST>
Content copied to clipboard
Link copied to clipboard
class SuspendingTestContainerHost<STATE : Any, SIDE_EFFECT : Any, CONTAINER_HOST>(actual: CONTAINER_HOST, initialState: STATE?, isolateFlow: Boolean) : TestContainerHost<STATE, SIDE_EFFECT, CONTAINER_HOST>
Content copied to clipboard
Link copied to clipboard
sealed class TestContainerHost<STATE : Any, SIDE_EFFECT : Any, CONTAINER_HOST>
Content copied to clipboard
Link copied to clipboard
class TestFlowObserver<T>(flow: <ERROR CLASS><T>)
Content copied to clipboard

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

Link copied to clipboard
class TestSettingsBuilder
Content copied to clipboard

Functions

Link copied to clipboard
fun <STATE : Any, SIDE_EFFECT : Any, CONTAINER_HOST> CONTAINER_HOST.liveTest(initialState: STATE? = null, settings: <ERROR CLASS>): RegularTestContainerHost<STATE, SIDE_EFFECT, CONTAINER_HOST>
Content copied to clipboard

Puts your ContainerHost into live test mode. This mode uses a real Orbit container.

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

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.

Link copied to clipboard
fun <T> <ERROR CLASS><T>.test(): TestFlowObserver<T>
Content copied to clipboard

Allows you to put a Flow into test mode.

fun <STATE : Any, SIDE_EFFECT : Any, CONTAINER_HOST> CONTAINER_HOST.test(initialState: STATE? = null, buildSettings: TestSettingsBuilder.() -> Unit = {}): SuspendingTestContainerHost<STATE, SIDE_EFFECT, CONTAINER_HOST>
Content copied to clipboard
fun <STATE : Any, SIDE_EFFECT : Any, CONTAINER_HOST> CONTAINER_HOST.test(initialState: STATE? = null, isolateFlow: Boolean = true, settings: <ERROR CLASS>): SuspendingTestContainerHost<STATE, SIDE_EFFECT, CONTAINER_HOST>
Content copied to clipboard
fun <STATE : Any, SIDE_EFFECT : Any, CONTAINER_HOST> CONTAINER_HOST.test(initialState: STATE? = null, isolateFlow: Boolean = true, buildSettings: TestSettingsBuilder.() -> Unit = {}): SuspendingTestContainerHost<STATE, SIDE_EFFECT, CONTAINER_HOST>
Content copied to clipboard

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