test/pro.respawn.flowmvi.test.plugin/PluginTestScope

PluginTestScope

class PluginTestScope<S : MVIState, I : MVIIntent, A : MVIAction> : PipelineContext<S, I, A> , ShutdownContext<S, I, A> , StorePlugin<S, I, A>

A class which provides DSL for testing a StorePlugin.

Contains:

ctx or this - a mock pipeline context configured specifically for testing.
TestPipelineContext.plugin - the plugin being tested
timeTravel embedded time travel plugin to track any side effects that the plugin produces.

See StorePlugin.test for a function that allows to test the plugin

Constructors

PluginTestScope

constructor(configuration: StoreConfiguration<S>, plugin: LazyPlugin<S, I, A>, timeTravel: TimeTravel<S, I, A>)

Properties

config

open override val config: StoreConfiguration<S>

coroutineContext

open override val coroutineContext: CoroutineContext

isActive

open override val isActive: Boolean

isStarted

open override val isStarted: Boolean

key

open override val key: CoroutineContext.Key<*>

name

open override val name: String?

states

open override val states: StateFlow<S>

timeTravel

val timeTravel: TimeTravel<S, I, A>

Functions

action

open suspend override fun action(action: A)

awaitStartup

open suspend override fun awaitStartup()

awaitUntilClosed

open suspend override fun awaitUntilClosed()

expect open override fun close()

closeAndWait

open suspend override fun closeAndWait()

compareAndSet

open override fun compareAndSet(old: S, new: S): Boolean

consume

open suspend override fun <T> Flow<T>.consume(context: CoroutineContext)

emit

open suspend override fun emit(intent: I)

ensureStarted

fun StoreLifecycle.ensureStarted()

equals

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

fold

open override fun <R> fold(initial: R, operation: (R, CoroutineContext.Element) -> R): R

get

open operator override fun <E : CoroutineContext.Element> get(key: CoroutineContext.Key<E>): E?

hashCode

open override fun hashCode(): Int

intent

open override fun intent(intent: I)

invoke

open operator override fun invoke(config: StoreConfiguration<S>): StorePlugin<S, I, A>

minusKey

open override fun minusKey(key: CoroutineContext.Key<*>): CoroutineContext

onAction

open suspend override fun PipelineContext<S, I, A>.onAction(action: A): A?

onException

open suspend override fun PipelineContext<S, I, A>.onException(e: Exception): Exception?

onIntent

open suspend override fun PipelineContext<S, I, A>.onIntent(intent: I): I?

onStart

open suspend override fun PipelineContext<S, I, A>.onStart()

onState

open suspend override fun PipelineContext<S, I, A>.onState(old: S, new: S): S?

onStop

open override fun ShutdownContext<S, I, A>.onStop(e: Exception?)

onSubscribe

open suspend override fun PipelineContext<S, I, A>.onSubscribe(newSubscriberCount: Int)

onUndeliveredAction

open override fun ShutdownContext<S, I, A>.onUndeliveredAction(action: A)

onUndeliveredIntent

open override fun ShutdownContext<S, I, A>.onUndeliveredIntent(intent: I)

onUnsubscribe

open suspend override fun PipelineContext<S, I, A>.onUnsubscribe(newSubscriberCount: Int)

plus

open operator override fun plus(context: CoroutineContext): CoroutineContext

send

open override fun send(action: A)

test

inline suspend fun <S : MVIState, I : MVIIntent, A : MVIAction> LazyPlugin<S, I, A>.test(initial: S, timeTravel: TimeTravel<S, I, A> = TimeTravel(), crossinline configuration: StoreConfigurationBuilder.() -> Unit = { debuggable = true }, crossinline block: suspend PluginTestScope<S, I, A>.() -> Unit)

A function that runs a test on a StorePlugin.

toString

open override fun toString(): String

updateState

open suspend override fun updateState(transform: suspend S.() -> S)

withState

open suspend override fun withState(block: suspend S.() -> Unit)