Check out what’s new from Firebase@ Google I/O 2021, and join our alpha program for early access to the new Remote Config personalization feature. Learn more

Commencez les tests avec la CLI gcloud

Ce guide explique comment exécuter un test d'instrumentation, Robo ou Game Loop à l'aide de la CLI gcloud .

Pour obtenir une liste complète des commandes gcloud vous pouvez utiliser avec votre application Android dans Test Lab, consultez la documentation de référence pour gcloud firebase test android .

Avant que tu commences

Si vous ne l'avez pas déjà fait, ajoutez Firebase à votre projet Android .

Étape 1. Configurer la CLI gcloud

  1. Téléchargez le SDK Google Cloud.
  2. Cela inclut l'outil CLI gcloud.

  3. Assurez-vous que votre installation est à jour :
    gcloud components update
    
  4. Connectez-vous à la CLI gcloud à l'aide de votre compte Google :
    gcloud auth login
    
  5. Définissez votre projet Firebase dans gcloud, où PROJECT_ID est l'ID de votre projet Firebase :
    gcloud config set project PROJECT_ID
    

Étape 2. Vérifiez les appareils de test disponibles

Utilisez les commandes gcloud suivantes pour afficher les appareils de test et les paramètres régionaux disponibles pour votre test.

En option, vous pouvez également télécharger l'exemple d' application Bloc-notes pour commencer à exécuter les commandes immédiatement. Utilisez le fichier binaire app-debug-unaligned.apk et le fichier de tests d'instrumentation app-debug-test-unaligned.apk , qui se trouvent dans NotePad/app/build/outputs/apk/ .

  • models list : obtenez une liste actuelle des appareils Android disponibles pour que vous puissiez les tester.

    gcloud firebase test android models list
    

    Dans la sortie de la commande :

    • La colonne MODEL_ID contient l'identifiant que vous pouvez utiliser ultérieurement pour exécuter des tests sur le modèle d'appareil.
    • La colonne OS_VERSION_ID contient les versions du système d'exploitation prises en charge par l'appareil.

    Exemple de sortie

    gcloud firebase test android models list output

  • models describe : Obtenez plus d'informations sur un MODEL_ID Android MODEL_ID .

    gcloud firebase test android models describe MODEL_ID
    

    La sortie contient la marque du modèle d'appareil, le fabricant, les versions du système d'exploitation, les niveaux d'API pris en charge, les dates de sortie et si l'appareil est physique ou virtuel.

  • versions list : obtenez une liste des versions du système d'exploitation actuellement disponibles à tester.

    gcloud firebase test android versions list
    

    Vous pouvez utiliser un identifiant de l'une des deux premières colonnes de sortie de la commande ( OS_VERSION_ID et VERSION ) pour exécuter ultérieurement des tests sur une version du système d'exploitation Android. Si vous ne spécifiez pas les versions du système d'exploitation Android à tester, la valeur par défaut notée dans la colonne TAGS est utilisée.

    Exemple de sortie

    gcloud android versions list

  • locales list : obtient la liste actuelle des locales disponibles pour le test.

    gcloud firebase test android versions list
    

    La première colonne de la sortie de la commande, LOCALE , contient l'identifiant que vous pouvez utiliser ultérieurement pour exécuter des tests sur un paramètre régional. Si vous ne spécifiez pas les paramètres régionaux à tester, l'anglais est utilisé comme paramètre régional par défaut.

Exécuter des tests

Maintenant que vous connaissez la gamme de modèles d'appareils, de paramètres régionaux et de versions de système d'exploitation disponibles pour tester votre application, vous pouvez spécifier des appareils à l'aide de la commande gcloud firebase test android run et de l'indicateur --device pour exécuter des tests Robo ou d'instrumentation.

Exécution du test Robo

Même si vous n'avez pas de tests d'instrumentation, vous pouvez toujours rechercher des bogues dans votre application. Utilisez le test Robo pour effectuer un examen automatisé de l'interface utilisateur de votre application. Le test Robo teste l'application en effectuant une analyse statique des différents chemins via l'interface utilisateur de l'application, puis en parcourant l'application pour rechercher les plantages et autres problèmes potentiels.

Commençons par exécuter un exemple de commande :

gcloud firebase test android run \
  --type robo \
  --app app-debug-unaligned.apk \
  --device model=Nexus6,version=21,locale=en,orientation=portrait  \
  --device model=Nexus7,version=19,locale=fr,orientation=landscape \
  --timeout 90s

Le paramètre --type robo est implicite si aucune valeur --type n'est spécifiée. Vous pouvez voir l'ensemble complet des options de ligne de commande pour exécuter des tests en tapant : gcloud help firebase test android run . Au lieu de spécifier tous ces arguments sur la ligne de commande, vous pouvez éventuellement spécifier vos arguments dans un fichier d'arguments au format YAML. Exécutez gcloud topic arg-files pour apprendre à utiliser cette fonctionnalité.

Consultez la section Analyser les résultats de votre test pour savoir comment examiner les résultats du test Robo.

Exécuter vos tests d'instrumentation

Utilisez maintenant l'outil de ligne de commande gcloud pour exécuter les tests Espresso de l'application Notepad sur les configurations d'appareil Android spécifiées, en utilisant le type de test d' instrumentation pour exécuter les tests dans app-debug-test-unaligned.apk comme suit :

gcloud firebase test android run \
  --type instrumentation \
  --app app-debug-unaligned.apk \
  --test app-debug-test-unaligned.apk \
  --device model=Nexus6,version=21,locale=en,orientation=portrait  \
  --device model=Nexus7,version=19,locale=fr,orientation=landscape

Le paramètre --type instrumentation est implicite si un APK de test a été spécifié avec --test . Au lieu de spécifier tous ces arguments sur la ligne de commande, vous pouvez éventuellement spécifier vos arguments dans un fichier d'arguments au format YAML. Exécutez gcloud topic arg-files pour apprendre à utiliser cette fonctionnalité.

La CLI gcloud prend en charge Android Test Orchestrator . Orchestrator nécessite AndroidJUnitRunner v1.0 ou supérieur. Pour l'activer, utilisez gcloud firebase test android run avec le
--use-orchestrator indicateur. Pour le désactiver, utilisez l'indicateur --no-use-orchestrator .

Remarque : vous pouvez également contrôler la manière dont Test Lab exécute vos tests d'instrumentation à l'aide d'indicateurs supplémentaires qui ne sont pas affichés ci-dessus. Par exemple, vous pouvez utiliser l' --test-targets pour tester une seule classe ou une méthode de classe utilisée par votre APK de test. Vous pouvez également savoir si votre test qui a échoué était réellement irrégulier ou non en utilisant l'indicateur '--num-flaky-test-attempts', qui spécifie le nombre de fois qu'une exécution de test doit être retentée si un ou plusieurs de ses les cas de test échouent pour une raison quelconque. Pour en savoir plus, consultez gcloud firebase test android run .

Rapports de couverture de code pour les tests d'instrumentation

Test Lab prend en charge les outils de rapport de couverture de code EMMA et JaCoCo . Si l'un ou l'autre de ces outils est intégré à la compilation de votre application, vous pouvez obtenir un rapport de couverture de code pour les tests Test Lab en exécutant la commande gcloud firebase test android run avec les arguments suivants :

gcloud firebase test android run \
  --type instrumentation \
  --app your-app.apk \
  --test your-app-test.apk \
  --device model=TestDevice,version=AndroidVersion  \
  --environment-variables coverage=true,coverageFile="/sdcard/coverage.ec" \
  --directories-to-pull /sdcard

Lorsque Test Lab a terminé d'exécuter vos tests, recherchez vos rapports de couverture de code dans Google Cloud Storage :

  1. Ouvrez le lien de la console Firebase que l'outil gcloud imprimé au-dessus du tableau des résultats du test dans votre terminal.
  2. Cliquez sur une exécution de test dans la liste sur ce lien pour ouvrir la page de détails de cette exécution.
  3. Cliquez sur Résultats du test pour accéder au bucket Cloud Storage avec les résultats du test de cette exécution.
  4. Ouvrez artifacts/coverage.ec pour voir votre rapport de couverture de code.

Analysez les résultats de vos tests

Après quelques minutes, un résumé de base de vos résultats de test est imprimé par l'outil gcloud :

Command test results

La sortie de votre test de ligne de commande comprend également un lien pour afficher les résultats du test. Pour en savoir plus sur l'interprétation de ces résultats, consultez Analyse des résultats du laboratoire de test Firebase pour Android .

Connexion personnalisée et saisie de texte avec test Robo

Le test Robo complète automatiquement les écrans de connexion qui utilisent un compte Google pour l'authentification, sauf si vous utilisez le paramètre --no-auto-google-login . Il peut également remplir des écrans de connexion personnalisés à l'aide des informations d'identification de compte de test que vous fournissez. Vous pouvez également utiliser ce paramètre pour fournir un texte de saisie personnalisé pour d'autres champs de texte utilisés par votre application.

Pour compléter les champs de texte dans votre application, utilisez le paramètre --robo-directives et fournissez une liste de paires key-value séparées par des virgules, où la key est le nom de ressource Android de l'élément d'interface utilisateur cible et la value est la chaîne de texte . Vous pouvez également utiliser cet indicateur pour indiquer à Robo d'ignorer des éléments spécifiques de l'interface utilisateur (par exemple, le bouton « déconnexion »). EditText champs EditText sont pris en charge, mais pas les champs de texte dans les éléments de l'interface utilisateur WebView .

Par exemple, vous pouvez utiliser le paramètre suivant pour une connexion personnalisée :

--robo-directives username_resource=username,password_resource=password

Commandes et indicateurs disponibles

La CLI Test Lab gcloud dispose de plusieurs commandes et indicateurs qui vous permettent d'exécuter des tests avec différentes spécifications :

Scripter des commandes gcloud avec Test Lab

Vous pouvez utiliser des scripts shell ou des fichiers batch pour automatiser les commandes de test d'applications mobiles que vous exécuteriez autrement à l'aide de la ligne de commande gcloud. L'exemple de script bash suivant exécute un test d'instrumentation avec un délai d'attente de deux minutes et signale si l'exécution du test s'est terminée avec succès :

if gcloud firebase test android run --app my-app.apk --test my-test.apk --timeout 2m
then
    echo "Test matrix successfully finished"
else
    echo "Test matrix exited abnormally with non-zero exit code: " $?
fi

Codes de sortie de script

Test Lab fournit plusieurs codes de sortie que vous pouvez utiliser pour mieux comprendre les résultats des tests que vous exécutez à l'aide de scripts ou de fichiers batch.

Scripting des codes de sortie pour Test Lab

Code de sortie Remarques
0 Toutes les exécutions de test ont réussi.
1 Une panne générale s'est produite. Les causes possibles incluent : un nom de fichier qui n'existe pas ou une erreur HTTP/réseau.
2 Le test s'est terminé car des commandes ou des arguments inconnus ont été fournis.
dix Un ou plusieurs cas de test (classes testées ou méthodes de classe) au sein d'une exécution de test n'ont pas réussi.
15 Firebase Test Lab n'a pas pu déterminer si la matrice de test a réussi ou échoué, en raison d'une erreur inattendue.
18 L'environnement de test pour cette exécution de test n'est pas pris en charge en raison de dimensions de test incompatibles. Cette erreur peut se produire si le niveau d'API Android sélectionné n'est pas pris en charge par le type d'appareil sélectionné.
19 La matrice de test a été annulée par l'utilisateur.
20 Une erreur d'infrastructure de test s'est produite.