Testing coroutines with runTest in Kotlin - Step-by-Step Execution

Concept Flow - Testing coroutines with runTest

Start runTest

↓

Launch coroutine

↓

Execute coroutine code

↓

Advance virtual time if needed

↓

Check assertions

↓

End runTest

runTest starts a coroutine test, runs coroutine code with virtual time control, then checks assertions before finishing.

Execution Sample

Kotlin

import kotlinx.coroutines.test.runTest
import kotlin.test.assertEquals

suspend fun suspendFunction(): Int {
    return 42
}

runTest {
  val result = suspendFunction()
  assertEquals(42, result)
}

This code runs a coroutine test that calls a suspend function and asserts its result equals 42.

Execution Table

Step	Action	Evaluation	Result
1	Start runTest block	runTest starts coroutine test environment	Coroutine test environment ready
2	Call suspendFunction()	Suspend function executes	Returns 42
3	Assert result == 42	Check if result equals 42	Assertion passes
4	End runTest	Test completes successfully	Test passed

💡 Test ends after assertions pass and runTest block completes

Variable Tracker

Variable	Start	After Step 2	After Step 3	Final
result	undefined	42	42	42

Key Moments - 2 Insights

Why does runTest allow testing suspend functions without blocking?

runTest creates a special coroutine environment with virtual time, so suspend functions run without real delays, as shown in Step 2 of the execution_table.

What happens if the assertion fails inside runTest?

If the assertion fails (Step 3), runTest throws an error and the test stops immediately, indicating failure.

Visual Quiz - 3 Questions

Look at the execution_table, what is the value of 'result' after Step 2?

A undefined

B 42

C null

D 0

💡 Hint

Check the variable_tracker row for 'result' after Step 2

At which step does the assertion check happen in the execution_table?

A Step 1

B Step 2

C Step 3

D Step 4

💡 Hint

Look for the row where 'Assert result == 42' is the action

If suspendFunction() returned 10 instead of 42, what would happen in the execution_table?

A Assertion fails at Step 3

B Assertion passes at Step 3

C Test ends at Step 2

D runTest never starts

💡 Hint

Refer to Step 3 where the assertion compares result to 42

Concept Snapshot

runTest {
  // coroutine test code
}

- Runs suspend functions in a test coroutine
- Uses virtual time to avoid delays
- Allows assertions inside coroutine
- Ends when block completes or assertion fails

Full Transcript

This visual execution shows how runTest runs coroutine tests in Kotlin. First, runTest starts a special coroutine environment. Then, the suspend function is called and returns a value. Next, an assertion checks the result. Finally, runTest ends the test. Variables like 'result' update as the code runs. If assertions fail, the test stops immediately. This helps test asynchronous code easily without real delays.

Practice

1. What is the main purpose of using runTest in Kotlin coroutine testing?

easy

A. To run coroutine tests quickly and safely

B. To create new threads for coroutines

C. To convert coroutines into blocking calls

D. To disable coroutine dispatchers

Solution

1. Step 1: Understand the role of runTest

   runTest is designed to run coroutine tests in a controlled environment that is fast and safe.

2. Step 2: Compare options with runTest purpose

   Options A, B, and D describe unrelated or incorrect behaviors. Only To run coroutine tests quickly and safely correctly states the purpose.

3. Final Answer:

   To run coroutine tests quickly and safely -> Option A

4. Quick Check:

   runTest purpose = run coroutine tests quickly and safely [OK]

Hint: Remember: runTest runs coroutine tests safely and fast [OK]

Common Mistakes:

• Thinking runTest creates new threads
• Confusing runTest with blocking calls
• Assuming runTest disables dispatchers

2. Which of the following is the correct syntax to start a coroutine test using runTest?

easy

A. runTest[] { val result = suspendFunction() }

B. runTest() => { val result = suspendFunction() }

C. runTest { val result = suspendFunction() }

D. runTest -> { val result = suspendFunction() }

Solution

1. Step 1: Recall the correct runTest syntax

   The correct syntax uses parentheses with a lambda block: runTest { ... }.

2. Step 2: Check each option's syntax

   runTest { val result = suspendFunction() } matches the correct syntax. Options B, C, and D use invalid Kotlin syntax for lambdas.

3. Final Answer:

   runTest { val result = suspendFunction() } -> Option C

4. Quick Check:

   Correct runTest syntax = runTest { ... } [OK]

Hint: Use curly braces {} after runTest for coroutine tests [OK]

Common Mistakes:

• Using parentheses with arrow syntax incorrectly
• Using square brackets instead of braces
• Using arrow (->) instead of braces for lambda

3. What will be the output of this Kotlin test code using runTest?

import kotlinx.coroutines.test.runTest
import kotlinx.coroutines.delay

fun suspendFunction(): String {
    delay(100)
    return "Done"
}

fun main() {
    println(suspendFunction())
}

medium

A. Done

B. Compilation error

C. Runtime exception

D. No output

Solution

1. Step 1: Analyze the suspend function usage

   suspendFunction contains delay(100) call, which requires a suspend function context, but suspendFunction itself is not marked as suspend.

2. Step 2: Check for compilation errors

   Calling suspend functions like delay inside a non-suspend function causes a compilation error.

3. Final Answer:

   Compilation error -> Option B

4. Quick Check:

   Calling delay requires suspend context = compilation error if missing [OK]

Hint: delay must be called from suspend context [OK]

Common Mistakes:

• Assuming suspend functions like delay can be called from normal functions
• Expecting output without suspend keyword
• Ignoring suspend function rules

4. Identify the error in this coroutine test code using runTest and how to fix it:

import kotlinx.coroutines.test.runTest
import kotlinx.coroutines.delay

fun suspendFunction(): String {
    delay(100)
    return "Done"
}

fun main() = runTest {
    val result = suspendFunction()
    println(result)
}

medium

A. suspendFunction should be marked suspend

B. runTest cannot be called inside main

C. delay cannot be used inside runTest

D. println cannot be used inside runTest

Solution

1. Step 1: Check suspendFunction declaration

   suspendFunction calls delay(100) but is not marked as suspend, which is incorrect for coroutine code.

2. Step 2: Fix by marking suspendFunction as suspend

   Marking suspendFunction as suspend allows it to be called inside runTest properly.

3. Final Answer:

   suspendFunction should be marked suspend -> Option A

4. Quick Check:

   suspendFunction missing suspend keyword = error [OK]

Hint: Mark functions calling coroutines as suspend [OK]

Common Mistakes:

• Not marking suspendFunction as suspend
• Thinking runTest can't be in main
• Believing delay is disallowed in runTest

5. You want to test a suspend function fetchData() that returns a string after a delay. Which is the best way to write a test using runTest to verify it returns "Success"?

hard

A. runTest { val result = fetchData(); assert(result == "Success") }

B. runTest { val result = fetchData(); println(result) }

C. runBlocking { val result = fetchData(); assert(result == "Success") }

D. runTest { val result = fetchData(); assertEquals("Success", result) }

Solution

1. Step 1: Choose correct test function and assertion

   runTest is the recommended coroutine test runner. Using assertEquals is the standard way to check expected results in tests.

2. Step 2: Compare options for best practice

   runTest { val result = fetchData(); assertEquals("Success", result) } uses runTest and assertEquals, making it the best choice. runTest { val result = fetchData(); assert(result == "Success") } uses assert but not the standard function. runTest { val result = fetchData(); println(result) } only prints result. runBlocking { val result = fetchData(); assert(result == "Success") } uses runBlocking which is less preferred for coroutine tests.

3. Final Answer:

   runTest { val result = fetchData(); assertEquals("Success", result) } -> Option D

4. Quick Check:

   Use runTest + assertEquals for coroutine tests [OK]

Hint: Use runTest with assertEquals to verify coroutine results [OK]

Common Mistakes:

• Using runBlocking instead of runTest
• Using print instead of assertions
• Using assert instead of assertEquals