dispatch-test/dispatch.test/TestProvidedCoroutineScope

TestProvidedCoroutineScope

@ExperimentalCoroutinesApi

interface TestProvidedCoroutineScope : TestCoroutineScope, DefaultCoroutineScope, IOCoroutineScope, MainCoroutineScope, MainImmediateCoroutineScope, UnconfinedCoroutineScope

A polymorphic testing CoroutineScope interface.

This single interface implements: TestCoroutineScope IOCoroutineScope MainImmediateCoroutineScope

This means that it can be injected into any class or function regardless of what type of CoroutineScope is required.

Functions

abstract fun advanceTimeBy(delayTimeMillis: Long): Long

advanceUntilIdle

abstract fun advanceUntilIdle(): Long

cleanupTestCoroutines

abstract override fun cleanupTestCoroutines()

pauseDispatcher

abstract fun pauseDispatcher()

abstract suspend fun pauseDispatcher(block: suspend () -> Unit)

resumeDispatcher

abstract fun resumeDispatcher()

abstract fun runCurrent()

Properties

coroutineContext

abstract val coroutineContext: CoroutineContext

abstract val currentTime: Long

dispatcherProvider

abstract val dispatcherProvider: DispatcherProvider

single DispatcherProvider promise for the TestProvidedCoroutineScope

uncaughtExceptions

abstract val uncaughtExceptions: List<Throwable>

Extensions

@ExperimentalCoroutinesApi

fun TestProvidedCoroutineScope.testProvided(testBody: suspend TestProvidedCoroutineScope.() -> Unit)

Delegates to runBlockingTest, but injects a DispatcherProvider into the created TestCoroutineScope.

Sources