kotlinx-coroutines-test/kotlinx.coroutines.test/TestCoroutineScope

TestCoroutineScope

@ExperimentalCoroutinesApi
interface TestCoroutineScope : CoroutineScope
Content copied to clipboard

A scope which provides detailed control over the execution of coroutines for tests.

This scope is deprecated in favor of TestScope. Please see the migration guide for an instruction on how to update the code for the new API.

Functions

cleanupTestCoroutines
Link copied to clipboard
@ExperimentalCoroutinesApi
abstract fun cleanupTestCoroutines()
Content copied to clipboard

Called after the test completes.

Properties

testScheduler
Link copied to clipboard
@ExperimentalCoroutinesApi
abstract val testScheduler: TestCoroutineScheduler
Content copied to clipboard

The delay-skipping scheduler used by the test dispatchers running the code in this scope.

Extensions

advanceTimeBy
Link copied to clipboard
@ExperimentalCoroutinesApi
fun TestCoroutineScope.advanceTimeBy(delayTimeMillis: Long)
Content copied to clipboard

Advances the testScheduler by delayTimeMillis and runs the tasks up to that moment (inclusive).

advanceUntilIdle
Link copied to clipboard
@ExperimentalCoroutinesApi
fun TestCoroutineScope.advanceUntilIdle()
Content copied to clipboard

Advances the testScheduler to the point where there are no tasks remaining.

currentTime
Link copied to clipboard
@ExperimentalCoroutinesApi
val TestCoroutineScope.currentTime: Long
Content copied to clipboard

The current virtual time on testScheduler.

pauseDispatcher
Link copied to clipboard
@ExperimentalCoroutinesApi
suspend fun TestCoroutineScope.pauseDispatcher(block: suspend () -> Unit)
Content copied to clipboard
@ExperimentalCoroutinesApi
fun TestCoroutineScope.pauseDispatcher()
Content copied to clipboard
resumeDispatcher
Link copied to clipboard
@ExperimentalCoroutinesApi
fun TestCoroutineScope.resumeDispatcher()
Content copied to clipboard
runBlockingTest
Link copied to clipboard
fun TestCoroutineScope.runBlockingTest(block: suspend TestCoroutineScope.() -> Unit)
Content copied to clipboard

Convenience method for calling runBlockingTest on an existing TestCoroutineScope.

runCurrent
Link copied to clipboard
@ExperimentalCoroutinesApi
fun TestCoroutineScope.runCurrent()
Content copied to clipboard

Run any tasks that are pending at the current virtual time, according to the testScheduler.

runTest
Link copied to clipboard
@ExperimentalCoroutinesApi
fun TestCoroutineScope.runTest(dispatchTimeoutMs: Long = DEFAULT_DISPATCH_TIMEOUT_MS, block: suspend TestCoroutineScope.() -> Unit): TestResult
Content copied to clipboard

Runs a test in a TestCoroutineScope based on this one.

uncaughtExceptions
Link copied to clipboard
val TestCoroutineScope.uncaughtExceptions: List<Throwable>
Content copied to clipboard

List of uncaught coroutine exceptions, for backward compatibility.