Как обеспечить вызов ViewModel # onCleared в модульном тесте Android?

TL; DR

В этом ответе Robolectric используется для того, чтобы фреймворк Android вызывал onCleared на вашем ViewModel. Этот способ тестирования медленнее, чем использование отражения (как в вопросе), и зависит как от Robolectric, так и от платформы Android. Этот компромисс зависит от вас.

Глядя на исходный код Android ...

... вы можете видеть, что ViewModel#onCleared вызывается только в ViewModelStore (для вашего собственного ViewModels). Это класс хранения для моделей представлений и принадлежит классам ViewModelStoreOwner, например. FragmentActivity. Итак, когда ViewModelStore вызывает onCleared на вашем ViewModel?

В нем должен храниться ваш ViewModel, затем его нужно очистить (что вы не можете сделать самостоятельно).

Ваша модель представления сохраняется в ViewModelProvider, когда вы get на ViewModel с помощью ViewModelProviders.of(FragmentActivity activity).get(Class<T> modelClass), где T - это класс вашей модели представления. Он хранит его в ViewModelStoreFragmentActivity.

Хранилище ясно, например, когда ваша активность фрагмента уничтожена. Это куча связанных вызовов, которые встречаются повсюду, но в основном это:

1. У вас есть FragmentActivity.
2. Получите его ViewModelProvider, используя ViewModelProviders#of.
3. Получите свой ViewModel с помощью ViewModelProvider#get.
4. Разрушьте свою деятельность.

Теперь onCleared должен быть вызван в вашей модели представления. Давайте протестируем это с помощью Robolectric 4, JUnit 4, MockK 1.9:

1. Добавьте @RunWith(RobolectricTestRunner::class) в свой тестовый класс.
2. Создайте контроллер активности с помощью Robolectric.buildActivity(FragmentActivity::class.java)
3. Инициализируйте действие с помощью setup на контроллере, это позволяет его уничтожить.
4. Получите активность с помощью метода контроллера get.
5. Получите свою модель представления, выполнив шаги, описанные выше.
6. Уничтожьте активность с помощью destroy на контроллере.
7. Проверьте поведение onCleared.

Полный пример класса ...

... на основе примера вопроса:

@RunWith(RobolectricTestRunner::class)
class ViewModelOnClearedTest {
    @Test
    fun `MyViewModel#onCleared calls Object#function`() = mockkObject(Object) {
        val controller = Robolectric.buildActivity(FragmentActivity::class.java).setup()

        ViewModelProviders.of(controller.get()).get(MyViewModel::class.java)

        controller.destroy()

        verify { Object.function() }
    }
}

class MyViewModel : ViewModel() {
    override fun onCleared() = Object.function()
}

object Object {
    fun function() {}
}

Я только что создал это расширение для ViewModel:

/**
 * Will create new [ViewModelStore], add view model into it using [ViewModelProvider]
 * and then call [ViewModelStore.clear], that will cause [ViewModel.onCleared] to be called
 */
fun ViewModel.callOnCleared() {
    val viewModelStore = ViewModelStore()
    val viewModelProvider = ViewModelProvider(viewModelStore, object : ViewModelProvider.Factory {

        @Suppress("UNCHECKED_CAST")
        override fun <T : ViewModel?> create(modelClass: Class<T>): T = this@callOnCleared as T
    })
    viewModelProvider.get(this@callOnCleared::class.java)

    //Run 2
    viewModelStore.clear()//To call clear() in ViewModel
}

В kotlin вы можете переопределить защищенную видимость с помощью public, а затем вызвать ее из теста.

class MyViewModel: ViewModel() {
    public override fun onCleared() {
        ///...
    }
}

Для Java, если вы создаете свой тестовый класс в том же пакете (в тестовом каталоге), что и класс ViewModel (здесь MyViewModel), то вы можете вызвать метод onCleared из тестового класса; поскольку защищенные методы также являются частными для пакета.