Testing coroutines with runTest in Kotlin - Mini Project: Build & Apply

Testing coroutines with runTest

📖 Scenario: You are writing a simple Kotlin function that uses coroutines to simulate a delayed greeting. You want to test this function properly using runTest from the Kotlin coroutines testing library.

🎯 Goal: Build a coroutine function that returns a greeting after a delay, then write a test using runTest to verify it returns the expected greeting.

📋 What You'll Learn

Create a suspend function called delayedGreeting that returns a String after a 100ms delay

Use delay(100) inside the function to simulate work

Write a test function called testDelayedGreeting using runTest

Inside the test, call delayedGreeting and assert the returned value is exactly "Hello, Coroutine!"

Print the test result string to the console

💡 Why This Matters

🌍 Real World

Testing coroutine functions is important in Android apps and backend services where asynchronous code is common.

💼 Career

Knowing how to test coroutines with <code>runTest</code> is a valuable skill for Kotlin developers working on reliable, maintainable asynchronous code.

1

Create the suspend function with delay

Write a suspend function called delayedGreeting that returns a String. Inside it, use delay(100) to pause for 100 milliseconds, then return the string "Hello, Coroutine!".

Kotlin

# Your code here

Hint

Use suspend fun to define a coroutine function. Use delay(100) to pause inside the coroutine.

2

Set up the test function with runTest

Add a test function called testDelayedGreeting. Inside it, use runTest from kotlinx.coroutines.test to run coroutine code. For now, just call runTest { } with an empty block.

Kotlin

import kotlinx.coroutines.test.runTest

// Your code here

Hint

Import runTest and create a function that calls it with a coroutine block.

3

Call delayedGreeting and check the result

Inside the runTest block in testDelayedGreeting, call delayedGreeting() and store the result in a variable called result. Then check if result equals "Hello, Coroutine!" using an if statement.

Kotlin

fun testDelayedGreeting() = runTest {
    // Call delayedGreeting and check result
    // Your code here
}

Hint

Store the call result in result. Use if to compare and print the test outcome.

4

Run the test and print the output

Call the testDelayedGreeting() function in the main program to run the test and print the result to the console.

Kotlin

fun main() {
    // Call the test function here
    // Your code here
}

Hint

Call testDelayedGreeting() inside main() to run the test and print the result.

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