Module with the Main dispatcher had failed to initialize: как починить тест

Тест ViewModel, который локально работал, в прогоне падает вот с этим:

java.lang.IllegalStateException: Module with the Main dispatcher had failed to initialize.
For tests Dispatchers.setMain from kotlinx-coroutines-test module can be used

Бывает и родственная формулировка — она означает то же самое, но в других обстоятельствах:

Module with the Main dispatcher is missing.
Add dependency providing the Main dispatcher, e.g. 'kotlinx-coroutines-android'

Что произошло

Dispatchers.Main — не часть ядра корутин. Это точка расширения: ядро объявляет, что такой диспетчер существует, а кто-то обязан предоставить реализацию. В Android её даёт библиотека kotlinx-coroutines-android, подставляя главный поток приложения.

Юнит-тест выполняется на JVM, без Android. Главного потока там нет, реализацию подставить некому — и первое же обращение к Dispatchers.Main падает.

Обратиться к нему тест может совершенно незаметно для вас. viewModelScope по умолчанию работает именно на Main. То есть любая ViewModel, которая что-то запускает, тянет за собой этот диспетчер.

Решение: подменить Main на тестовый

Библиотека kotlinx-coroutines-test даёт для этого две функции — Dispatchers.setMain() и Dispatchers.resetMain():

class ProfileViewModelTest {

    private val dispatcher = StandardTestDispatcher()

    @Before
    fun setUp() {
        Dispatchers.setMain(dispatcher)
    }

    @After
    fun tearDown() {
        Dispatchers.resetMain()
    }

    @Test
    fun `профиль загружается`() = runTest {
        val viewModel = ProfileViewModel(repository)
        viewModel.load()
        advanceUntilIdle()
        assertEquals(expected, viewModel.state.value)
    }
}

resetMain() в @After обязателен. Подмена глобальная, и если её не снять, она утечёт в соседние тесты — те начнут падать по причинам, никак не связанным с их собственным кодом. Искать такое неприятно.

Чтобы не повторять эти два метода в каждом тестовом классе, их выносят в правило JUnit и подключают одной строкой.

Если формулировка вторая

Сообщение про «missing» вместо «had failed to initialize» обычно означает одно из двух: в зависимостях нет kotlinx-coroutines-android, либо её версия разошлась с версией kotlinx-coroutines-core. Версии всех артефактов kotlinx-coroutines должны совпадать — это частая причина необъяснимых падений.

Чего делать не нужно

  • Заменять viewModelScope на собственный скоуп с Dispatchers.IO ради прохождения теста — вы почините тест и сломаете продакшен.
  • Добавлять kotlinx-coroutines-android в testImplementation: на JVM главного потока всё равно нет.
  • Вставлять Dispatchers.setMain внутрь самого теста без resetMain.

Короткий ответ

Эта ошибка почти всегда означает одно: тестируется что-то, использующее viewModelScope, а Dispatchers.Main в тесте не подменён. Два метода с @Before и @After — и тест проходит.

Как устроены диспетчеры и почему Main особенный — в руководстве по корутинам.