circuit-test/com.slack.circuit.test/FakeNavigator

FakeNavigator

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

This navigator acts as a real navigator for all intents and purposes, navigating either a given BackStack or using a simple real one under the hood if one isn't provided.

Example

val navigator = FakeNavigator(FavoritesScreen)
val presenter = FavoritesPresenter(navigator)

presenter.test {
  val state = awaitItem()
  state.eventSink(AddFavoriteClick)
  assertThat(navigator.awaitNextScreen())
    .isEqualTo(AddFavoriteScreen)
}

Constructors

FakeNavigator

constructor(backStack: BackStack<out BackStack.Record>)

constructor(root: Screen, vararg additionalScreens: Screen)

Types

GoToEvent

data class GoToEvent(val screen: Screen, val success: Boolean)

Represents a recorded Navigator.goTo event.

PopEvent

data class PopEvent(val poppedScreen: Screen?, val result: PopResult? = null)

Represents a recorded Navigator.pop event.

ResetRootEvent

data class ResetRootEvent(val newRoot: Screen, val oldScreens: ImmutableList<Screen>, val saveState: Boolean = false, val restoreState: Boolean = false)

Represents a recorded Navigator.resetRoot event.