test/pro.respawn.flowmvi.test/StoreTestScope

StoreTestScope

class StoreTestScope<S : MVIState, I : MVIIntent, A : MVIAction> : Store<S, I, A> , Provider<S, I, A>

A class which implements a dsl for testing Store.

Properties

open override val actions: Flow<A>

open override val name: String?

val provider: Provider<S, I, A>

open override val state: S

open override val states: StateFlow<S>

val store: Store<S, I, A>

val timeoutMs: Long = 3000

Functions

expect open override fun close()

open suspend override fun emit(intent: I)

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun intent(intent: I)

inline suspend fun <S> I.resultsIn()

Assert that Provider.state's state is of type S

infix inline suspend fun I.resultsIn(action: A)

Assert that intent this results in action

infix inline suspend fun I.resultsIn(state: S)

Assert that Provider.state is equal to state

infix inline suspend fun I.resultsIn(assertion: () -> Unit)

Assert that intent this passes checks defined in assertion

open override fun start(scope: CoroutineScope): Job

open override fun CoroutineScope.subscribe(block: suspend Provider<S, I, A>.() -> Unit): Job

subscribeAndTest

inline suspend fun <S : MVIState, I : MVIIntent, A : MVIAction> Store<S, I, A>.subscribeAndTest(crossinline block: suspend StoreTestScope<S, I, A>.() -> Unit): Job

Call Store.start, then call Store.subscribe and execute block inside that scope. Unsubscribe and stop the store afterwards

inline suspend fun <S : MVIState, I : MVIIntent, A : MVIAction> Store<S, I, A>.test(crossinline block: suspend Store<S, I, A>.(job: Job) -> Unit): Job

Call Store.start and then execute block, cancelling the store afterwards