ackpine-test/ru.solrudev.ackpine.test/TestProgressSession

TestProgressSession

class TestProgressSession<F : Failure> @JvmOverloads constructor(script: TestSessionScript<F> = TestSessionScript.auto(Session.State.Succeeded), id: UUID = UUID.randomUUID(), initialState: Session.State<F> = Pending, initialProgress: Progress = Progress()) : TestSession<F> , ProgressSession<F>

A controllable ProgressSession test double.

Progress listeners are invoked on the calling thread, and the current progress is delivered immediately when a listener is added. Use controller to drive progress updates alongside state transitions.

Constructors

TestProgressSession

constructor(script: TestSessionScript<F> = TestSessionScript.auto(Session.State.Succeeded), id: UUID = UUID.randomUUID(), initialState: Session.State<F> = Pending, initialProgress: Progress = Progress())

constructor(initialProgress: Progress)

Returns a TestProgressSession with the provided initialProgress, a random id, Pending initial state and TestSessionScript.auto completing with Session.State.Succeeded.

constructor(id: UUID)

Returns a TestProgressSession with the provided id, Pending initial state, default initial progress and TestSessionScript.auto completing with Session.State.Succeeded.

constructor(id: UUID, initialState: Session.State<F>)

Returns a TestProgressSession with the provided id and initialState, default initial progress and TestSessionScript.auto completing with Session.State.Succeeded.

Properties

open override val controller: TestProgressSessionController<F>

Returns the controller used to drive this session in tests.

open override val id: UUID

open override val isActive: Boolean

open override val isCancelled: Boolean

open override val isCompleted: Boolean

var progress: Progress

Returns the current progress of this session.

progressHistory

val progressHistory: List<Progress>

Returns a snapshot of progress updates for this session.

var state: Session.State<F>

Returns the current state of this session.

val stateHistory: List<Session.State<F>>

Returns a snapshot of state transitions for this session.

Functions

addProgressListener

open override fun addProgressListener(subscriptionContainer: DisposableSubscriptionContainer, listener: ProgressSession.ProgressListener): DisposableSubscription

addStateListener

open override fun addStateListener(subscriptionContainer: DisposableSubscriptionContainer, listener: Session.StateListener<F>): DisposableSubscription

open override fun cancel()

open override fun commit(): Boolean

open override fun launch(): Boolean

removeProgressListener

open override fun removeProgressListener(listener: ProgressSession.ProgressListener)

removeStateListener

open override fun removeStateListener(listener: Session.StateListener<F>)

open override fun reset(state: Session.State<F>, notifyListeners: Boolean)

Resets state and state history to the provided state.

fun resetProgress(progress: Progress = initialProgress, notifyListeners: Boolean = false)

Resets progress and progress history to the provided progress.