Schémas courants

Vous pouvez tester votre application Compose avec des approches et des modèles bien établis.

Effectuer un test isolé

ComposeTestRule vous permet de lancer une activité affichant n'importe quel composable : votre application complète, un seul écran ou un petit élément. Il est également recommandé de vérifier que vos composables sont correctement encapsulés et fonctionnent de manière autonome afin de tester l'interface utilisateur plus facilement et plus précisément.

Cela ne signifie pas que vous devez uniquement créer des tests d'interface utilisateur. Il est également très important de tester la portée de plus grandes parties de votre interface utilisateur.

Accédez à l'activité et aux ressources après avoir défini votre propre contenu

Vous devez souvent configurer le contenu testé à l'aide de composeTestRule.setContent et accéder aux ressources d'activité, par exemple pour affirmer qu'un texte affiché correspond à une ressource de chaîne. Toutefois, vous ne pouvez pas appeler setContent sur une règle créée avec createAndroidComposeRule() si l'activité l'appelle déjà.

Pour ce faire, il est courant de créer une AndroidComposeTestRule à l'aide d'une activité vide telle que ComponentActivity.

class MyComposeTest {

    @get:Rule
    val composeTestRule = createAndroidComposeRule<ComponentActivity>()

    @Test
    fun myTest() {
        // Start the app
        composeTestRule.setContent {
            MyAppTheme {
                MainScreen(uiState = exampleUiState, /*...*/)
            }
        }
        val continueLabel = composeTestRule.activity.getString(R.string.next)
        composeTestRule.onNodeWithText(continueLabel).performClick()
    }
}

Notez que ComponentActivity doit être ajouté au fichier AndroidManifest.xml de votre application. Pour ce faire, ajoutez la dépendance suivante à votre module :

debugImplementation("androidx.compose.ui:ui-test-manifest:$compose_version")

Propriétés de la sémantique personnalisée

Vous pouvez créer des propriétés sémantiques personnalisées pour soumettre des informations aux tests. Pour ce faire, définissez une nouvelle SemanticsPropertyKey et rendez-la disponible à l'aide de SemanticsPropertyReceiver.

// Creates a semantics property of type Long.
val PickedDateKey = SemanticsPropertyKey<Long>("PickedDate")
var SemanticsPropertyReceiver.pickedDate by PickedDateKey

Utilisez maintenant cette propriété dans le modificateur semantics :

val datePickerValue by remember { mutableStateOf(0L) }
MyCustomDatePicker(
    modifier = Modifier.semantics { pickedDate = datePickerValue }
)

À partir des tests, utilisez SemanticsMatcher.expectValue pour réclamer la valeur de la propriété :

composeTestRule
    .onNode(SemanticsMatcher.expectValue(PickedDateKey, 1445378400)) // 2015-10-21
    .assertExists()

Vérifier la restauration d'état

Vérifiez que l'état de vos éléments Compose est correctement restauré lorsque l'activité ou le processus est recréé. Effectuez ces vérifications sans dépendre de la recréation d'activité avec la classe StateRestorationTester.

Cette classe vous permet de simuler la recréation d'un composable. Elle s'avère particulièrement utile pour vérifier l'implémentation de rememberSaveable.


class MyStateRestorationTests {

    @get:Rule
    val composeTestRule = createComposeRule()

    @Test
    fun onRecreation_stateIsRestored() {
        val restorationTester = StateRestorationTester(composeTestRule)

        restorationTester.setContent { MainScreen() }

        // TODO: Run actions that modify the state

        // Trigger a recreation
        restorationTester.emulateSavedInstanceStateRestore()

        // TODO: Verify that state has been correctly restored.
    }
}

Tester différentes configurations d'appareil

Les applications Android doivent s'adapter à de nombreuses conditions changeantes : taille des fenêtres, paramètres régionaux, taille des polices, thèmes clairs et sombres, etc. La plupart de ces conditions sont dérivées de valeurs au niveau de l'appareil contrôlées par l'utilisateur et exposées avec l'instance Configuration actuelle. Il est difficile de tester différentes configurations directement dans un test, car le test doit configurer les propriétés au niveau de l'appareil.

DeviceConfigurationOverride est une API réservée aux tests qui vous permet de simuler différentes configurations d'appareil de manière localisée pour le contenu @Composable en cours de test.

L'objet associé de DeviceConfigurationOverride comporte les fonctions d'extension suivantes, qui remplacent les propriétés de configuration au niveau de l'appareil :

Pour appliquer un forçage spécifique, encapsulez le contenu testé dans un appel à la fonction de niveau supérieur DeviceConfigurationOverride(), en transmettant le forçage à appliquer en tant que paramètre.

Par exemple, le code suivant applique le remplacement DeviceConfigurationOverride.ForcedSize() pour modifier la densité localement, ce qui force le composable MyScreen à être affiché dans une grande fenêtre en mode paysage, même si l'appareil sur lequel le test est exécuté ne prend pas directement en charge cette taille de fenêtre :

composeTestRule.setContent {
    DeviceConfigurationOverride(
        DeviceConfigurationOverride.ForcedSize(DpSize(1280.dp, 800.dp))
    ) {
        MyScreen() // Will be rendered in the space for 1280dp by 800dp without clipping.
    }
}
DeviceConfigurationOverrideSnippets.kt

Pour appliquer plusieurs forçages en même temps, utilisez DeviceConfigurationOverride.then() :

composeTestRule.setContent {
    DeviceConfigurationOverride(
        DeviceConfigurationOverride.FontScale(1.5f) then
            DeviceConfigurationOverride.FontWeightAdjustment(200)
    ) {
        Text(text = "text with increased scale and weight")
    }
}
DeviceConfigurationOverrideSnippets.kt

Autres ressources

  • Tester des applications sur Android : la page d'accueil principale des tests Android offre une vue plus large des principes fondamentaux et des techniques de test.
  • Principes de base des tests : découvrez les concepts fondamentaux des tests d'une application Android.
  • Tests locaux : vous pouvez exécuter certains tests en local, sur votre propre poste de travail.
  • Tests instrumentés : il est recommandé d'exécuter également des tests instrumentés. Autrement dit, des tests qui s'exécutent directement sur l'appareil.
  • Intégration continue : l'intégration continue vous permet d'intégrer vos tests à votre pipeline de déploiement.
  • Testez différentes tailles d'écran : les utilisateurs ont accès à de nombreux appareils. Vous devez donc tester différentes tailles d'écran.
  • Espresso : bien qu'il soit destiné aux UI basées sur les vues, la connaissance d'Espresso peut toujours être utile pour certains aspects des tests Compose.