Commencer les tests avec la gcloud CLI

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

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

Avant de commencer

Si ce n'est pas déjà fait, ajoutez Firebase à votre projet Android.

Étape 1 : Configurer gcloud CLI

1. Téléchargez le SDK Google Cloud.

Cela inclut l'outil gcloud CLI.

2. Assurez-vous que votre installation est à jour :

   gcloud components update
   

3. Connectez-vous à la gcloud CLI à l'aide de votre compte Google :

   gcloud auth login
   

4. 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érifier 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.

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 la liste actuelle des appareils Android disponibles pour les tests.

  gcloud firebase test android models list

  Dans le résultat de la commande :

  • La colonne MODEL_ID contient l'identifiant que vous pourrez 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 compatibles avec l'appareil.

  Exemple de résultat :

  

• models describe : obtenez plus d'informations sur un MODEL_ID Android spécifique.

  gcloud firebase test android models describe MODEL_ID

  Le résultat contient la marque, le fabricant, les versions d'OS, les niveaux d'API compatibles, les interfaces binaires d'application (ABI) compatibles, les dates de sortie et le type (physique ou virtuel) du modèle d'appareil.

• versions list : obtenez la liste des versions d'OS actuellement disponibles pour les tests.

  gcloud firebase test android versions list

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

  Exemple de résultat :

  

• locales list : récupérez la liste actuelle des paramètres régionaux disponibles pour les tests.

  gcloud firebase test android locales list

  La première colonne du résultat de la commande, LOCALE, contient l'identifiant que vous pourrez 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é par défaut.

Étape 3 : Exécuter le test

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

Exécuter un test Robo

Même si vous n'avez pas de tests d'instrumentation, vous pouvez toujours rechercher des bugs 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 d'accès via l'interface utilisateur de l'application, puis explore l'application pour détecter les plantages et autres problèmes potentiels.

Pour exécuter un test Robo, exécutez l'exemple de commande suivant :

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 \
  --client-details matrixLabel="Example matrix label"

• Le paramètre --type robo est implicite si aucune valeur --type n'est spécifiée.
• Pour vous aider à identifier et à localiser vos matrices de test dans la console Firebase, vous pouvez utiliser l'option facultative --client-details matrixLabel="Example matrix label" pour ajouter un libellé à votre matrice de test.
• Pour afficher l'ensemble des options de ligne de commande permettant d'exécuter des tests, saisissez gcloud help firebase test android run.

Au lieu de spécifier ces arguments sur la ligne de commande, vous pouvez éventuellement les spécifier dans un fichier d'arguments au format YAML. Exécutez gcloud topic arg-files pour apprendre à utiliser cette fonctionnalité.

Pour savoir comment examiner les résultats du test Robo, consultez Analyser les résultats de vos tests.

Exécuter un test 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'appareils Android que vous avez spécifiées. Utilisez le type de test 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
  --client-details matrixLabel="Example matrix label"

• Le paramètre d'instrumentation --type est implicite si un APK de test est spécifié avec --test.
• Pour vous aider à identifier et à localiser vos matrices de test dans la console Firebase, vous pouvez utiliser l'option facultative --client-details matrixLabel="Example matrix label" pour ajouter un libellé à votre matrice de test.
• Pour afficher l'ensemble des options de ligne de commande permettant d'exécuter des tests, saisissez gcloud help firebase test android run.

Au lieu de spécifier ces arguments sur la ligne de commande, vous pouvez éventuellement les spécifier dans un fichier d'arguments au format YAML. Exécutez gcloud topic arg-files pour apprendre à utiliser cette fonctionnalité.

La gcloud CLI est compatible avec Android Test Orchestrator. Orchestrator nécessite AndroidJUnitRunner v1.1 ou une version ultérieure. Pour l'activer, utilisez gcloud firebase test android run avec l'option
--use-orchestrator. Pour la désactiver, utilisez l'option --no-use-orchestrator.

Vous pouvez également contrôler la façon dont Test Lab exécute vos tests d'instrumentation à l'aide d'options supplémentaires qui ne sont pas présentées ci-dessus. Par exemple, vous pouvez utiliser l'option --test-targets pour tester une seule classe ou une méthode de classe utilisée par votre APK de test. Vous pouvez également déterminer si votre test qui a échoué était irrégulier ou non à l'aide de l'option --num-flaky-test-attempts, qui spécifie le nombre de fois qu'une exécution de test doit être relancée si un ou plusieurs de ses scénarios 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 est compatible avec les outils de reporting de couverture de code EMMA et JaCoCo. Si l'un 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 gcloud firebase test android run avec des arguments supplémentaires. Si Android Test Orchestrator n'est pas activé, utilisez la commande suivante :

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/Download/coverage.ec" \
  --directories-to-pull /sdcard/Download

Si vous générez des rapports de couverture de code tout en utilisant Android Test Orchestrator, modifiez vos variables d'environnement comme suit :

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

Une fois que 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 a affiché au-dessus du tableau des résultats de test dans votre terminal.
2. Cliquez sur une exécution de test dans la liste de ce lien pour ouvrir la page d'informations de cette exécution.
3. Cliquez sur Résultats du test pour accéder au bucket Cloud Storage contenant les résultats du test de cette exécution.
4. Ouvrez artifacts/coverage.ec pour afficher votre rapport de couverture de code.

Analyser les résultats de votre test

Après quelques minutes, l'outil gcloud affiche un résumé de base des résultats de vos tests :

Le résultat de l'exécution de votre test en ligne de commande inclut également un lien permettant d'afficher les résultats du test. Pour en savoir plus sur l'interprétation de ces résultats, consultez Analyser les résultats de Firebase Test Lab pour Android.

Connexion personnalisée et saisie de texte avec le test Robo

Le test Robo remplit 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 identifiants 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 remplir les champs de texte de votre application, utilisez le paramètre --robo-directives et fournissez une liste de paires key-value séparées par une virgule, où key est le nom de la ressource Android de l'élément d'interface utilisateur cible et value est la chaîne de texte. Vous pouvez également utiliser cette option pour indiquer à Robo d'ignorer des éléments d'interface utilisateur spécifiques (par exemple, un bouton "Se déconnecter"). Les champs EditText sont acceptés, mais pas les champs de texte dans les éléments d'interface utilisateur WebView.

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

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

Commandes et options disponibles

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

• Option Android Test Orchestrator : option permettant d'activer Orchestrator,un outil qui vous permet d'exécuter chacun des tests de votre application dans son propre appel de Instrumentation. Test Lab exécute toujours la dernière version d'Orchestrator.

• Options de test de boucle de jeu : ensemble d'options de configuration qui activent et contrôlent un "mode démo" pour simuler les actions des joueurs dans les applications de jeu. En savoir plus sur l'exécution de tests de boucle de jeu avec Test Lab.

• Flag de segmentation uniforme (en version bêta) : flag qui spécifie le nombre de segments dans lesquels vous souhaitez répartir uniformément les scénarios de test. Les segments sont exécutés en parallèle sur des appareils distincts.

• Option de segmentation manuelle (en version bêta) : option qui spécifie un groupe de packages, de classes et/ou de scénarios de test à exécuter dans un segment (un groupe de scénarios de test). Les segments sont exécutés en parallèle sur des appareils distincts.

• Option de profils de trafic réseau (en version bêta) : option qui spécifie le profil réseau utilisé par vos tests avec des appareils physiques. Les profils réseau émulent différentes conditions réseau, ce qui vous permet de tester les performances de votre application sur des réseaux peu fiables ou imprévisibles.

Créer des scripts pour les commandes gcloud avec Test Lab

Vous pouvez utiliser des scripts shell ou des fichiers de commandes 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 avant expiration de deux minutes et indique si l'exécution du test s'est terminée correctement :

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 du 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 de commandes.

Codes de sortie de script pour Test Lab