Comment s'assurer que ViewModel # onCleared est appelé dans un test unitaire Android?

TL; DR

Dans cette réponse, Robolectric est utilisé pour que le framework Android appelle onCleared sur votre ViewModel . Cette méthode de test est plus lente que l'utilisation de la réflexion (comme dans la question) et dépend à la fois de Robolectric et du framework Android. Ce compromis dépend de vous.

---

En regardant la source d'Android ...

... vous pouvez voir que ViewModel # onCleared n'est appelé que dans ViewModelStore (pour vos propres ViewModels ). Il s'agit d'une classe de stockage pour les modèles de vue et appartient aux classes ViewModelStoreOwner , par exemple FragmentActivity . Alors, quand est-ce que ViewModelStore appelle onCleared sur votre ViewModel?

Il doit stocker votre ViewModel code>, alors le magasin doit être effacé (ce que vous ne pouvez pas faire vous-même).

Votre modèle de vue est stocké par le ViewModelProvider lorsque vous obtenez votre ViewModel en utilisant ViewModelProviders.of (FragmentActivity activity) .get (Class modelClass) , où T est votre classe de modèle de vue. Il le stocke dans le ViewModelStore du FragmentActivity.

Le magasin est vide par exemple lorsque votre activité de fragment est détruite. C'est un tas d'appels enchaînés qui vont partout, mais en gros c'est:

1. Avoir une FragmentActivity .
2. Obtenez son ViewModelProvider en utilisant ViewModelProviders # of .
3. Obtenez votre ViewModel à l'aide de ViewModelProvider # get .
4. Détruisez votre activité.

Maintenant, onCleared devrait être appelé sur votre modèle de vue. Testons-le en utilisant Robolectric 4, JUnit 4, MockK 1.9:

1. Ajoutez @RunWith (RobolectricTestRunner :: class) à votre classe de test.
2. Créez un contrôleur d'activité à l'aide de Robolectric.buildActivity(FragmentActivity::class.java)
3. Initialisez l'activité en utilisant setup sur le contrôleur, cela permet de la détruire.
4. Obtenez l'activité avec la méthode get du contrôleur.
5. Obtenez votre modèle de vue en suivant les étapes décrites ci-dessus.
6. Détruisez l'activité en utilisant destroy sur le contrôleur.
7. Vérifiez le comportement de onCleared .

Exemple de classe complet ...

... basé sur l'exemple de la question:

@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() {}
}

Je viens de créer cette extension pour 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
}

Dans kotlin, j'ai trouvé que je pouvais remplacer la visibilité protégée en utilisant public , puis je peux l'appeler à partir d'un test.

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