Testing coroutines with runTest in Kotlin

Introduction

We use runTest to check if coroutine code works correctly without waiting for real time delays.

When you want to test a function that uses coroutines.

When your coroutine code has delays or suspensions.

When you want fast and reliable tests for asynchronous code.

Syntax

Kotlin

import kotlinx.coroutines.test.runTest

runTest {
    // coroutine test code here
}

runTest runs coroutine code in a special test environment.

You can call suspend functions inside runTest directly.

Examples

This example shows a delay inside runTest. The delay does not slow the test.

Kotlin

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

runTest {
    delay(1000) // This delay is virtual and fast
    println("Test done")
}

You can call suspend functions inside runTest and check their results.

Kotlin

import kotlinx.coroutines.test.runTest

suspend fun fetchData(): String {
    return "Data"
}

runTest {
    val result = fetchData()
    println(result)
}

Sample Program

This program tests the getGreeting suspend function using runTest. The delay is virtual, so the test runs fast. It checks the returned string and prints a success message.

Kotlin

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

suspend fun getGreeting(): String {
    delay(500) // pretend to do work
    return "Hello, World!"
}

fun main() = runTest {
    val greeting = getGreeting()
    assertEquals("Hello, World!", greeting)
    println("Test passed")
}

Important Notes

runTest helps avoid flaky tests caused by real delays.

Use assertEquals or other assertions inside runTest to verify results.

Remember to import kotlinx.coroutines.test.runTest to use it.

Summary

runTest runs coroutine tests quickly and safely.

You can call suspend functions and check their results inside runTest.

This makes testing asynchronous code easier and more reliable.