circuit-test/com.slack.circuit.test

Package-level declarations

Types

actual interface BaseTestEventSinkType<UiEvent> : Function1<UiEvent, Unit>

expect sealed interface BaseTestEventSinkType<UiEvent>

Base expect type for TestEventSink. This layer of indirection is necessary because Kotlin/JS does not allow extension of function types. To work around it, we make this interface extend (UiEvent) -> Unit on all platforms except JS, and then expose an asEventSinkFunction() extension function on TestEventSink in JS that returns a function wrapper around it.

actual interface BaseTestEventSinkType<UiEvent>

actual interface BaseTestEventSinkType<UiEvent> : Function1<UiEvent, Unit>

actual interface BaseTestEventSinkType<UiEvent>

CircuitReceiveTurbine

interface CircuitReceiveTurbine<UiState : CircuitUiState> : ReceiveTurbine<UiState>

A Circuit-specific extension to ReceiveTurbine with extra helper functions for Circuit testing.

ExperimentalForInheritanceCircuitTestApi

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class ExperimentalForInheritanceCircuitTestApi

FakeNavigator

class FakeNavigator : Navigator

A fake Navigator that can be used in tests to record and assert navigation events.

TestEventSink

class TestEventSink<UiEvent : CircuitUiEvent> : BaseTestEventSinkType<UiEvent>

A test event sink that records events from a Circuit UI and allows making assertions about them.

Functions

asEventSinkFunction

fun <UiEvent : CircuitUiEvent> TestEventSink<UiEvent>.asEventSinkFunction(): (UiEvent) -> Unit

A helper function for creating a function wrapper around this TestEventSink for use in tests as an event sink function. We have to do this workaround in JS due to Kotlin/JS not allowing function type extension directly.

fun <UiEvent : CircuitUiEvent> TestEventSink<UiEvent>.asEventSinkFunction(): (UiEvent) -> Unit

presenterTestOf

suspend fun <UiState : CircuitUiState> presenterTestOf(presentFunction: @Composable () -> UiState, timeout: Duration? = null, name: String? = null, policy: SnapshotMutationPolicy<UiState> = structuralEqualityPolicy(), block: suspend CircuitReceiveTurbine<UiState>.() -> Unit)

Presents this presentFunction and invokes a suspend CircuitReceiveTurbine that can be used to assert state emissions from it.

test

suspend fun <UiState : CircuitUiState> Presenter<UiState>.test(timeout: Duration? = null, name: String? = null, policy: SnapshotMutationPolicy<UiState> = structuralEqualityPolicy(), block: suspend CircuitReceiveTurbine<UiState>.() -> Unit)

Presents this Presenter and invokes a suspend ReceiveTurbine that can be used to assert state emissions from this presenter.