Premiers pas avec les tests de boucles de jeu

Il peut être difficile d'automatiser les tests de jeux lorsque les applications de jeux sont conçues sur différents frameworks d'UI. Les tests Game Loop vous permettent d'intégrer vos tests natifs à Test Lab et de les exécuter facilement sur les appareils de votre choix. Un test de boucle de jeu exécute votre test dans votre application de jeu tout en simulant les actions d'un véritable joueur. Ce guide vous explique comment exécuter un test Game Loop, puis comment afficher et gérer les résultats de vos tests dans la console Firebase.

Selon votre moteur de jeu, vous pouvez implémenter des tests avec une ou plusieurs boucles. Une boucle est une exécution complète ou partielle de votre test sur votre application de jeu. Les boucles de jeu peuvent être utilisées pour :

  • Exécutez un niveau de votre jeu de la même manière qu'un utilisateur final y jouerait. Vous pouvez scripter la saisie de l'utilisateur, laisser l'utilisateur inactif ou remplacer l'utilisateur par une IA si cela a du sens dans votre jeu (par exemple, si vous avez une application de jeu de course automobile et que vous avez déjà implémenté une IA. Vous pouvez facilement confier la gestion de l'entrée utilisateur à un pilote IA.
  • Exécutez votre jeu avec le paramètre de qualité le plus élevé pour voir si les appareils le prennent en charge.
  • Exécutez un test technique (compilez plusieurs nuanceurs, exécutez-les, vérifiez que le résultat est celui attendu, etc.).

Vous pouvez exécuter un test de boucle de jeu sur un seul appareil de test, sur un ensemble d'appareils de test ou sur Test Lab. Toutefois, nous vous déconseillons d'exécuter des tests Game Loop sur des appareils virtuels, car ils ont des fréquences d'images graphiques inférieures à celles des appareils physiques.

Avant de commencer

Pour implémenter un test, vous devez d'abord configurer votre application pour les tests Game Loop.

  1. Dans le fichier manifeste de votre application, ajoutez un filtre d'intent à votre activité :

    <activity android:name=".MyActivity">
   <intent-filter>
       <action android:name="com.google.intent.action.TEST_LOOP"/>
       <category android:name="android.intent.category.DEFAULT"/>
       <data android:mimeType="application/javascript"/>
   </intent-filter>
   <intent-filter>
      ... (other intent filters here)
   </intent-filter>
</activity>

    Cela permet à Test Lab de lancer votre jeu en déclenchant une intention spécifique.

  2. Dans votre code (nous vous recommandons de l'ajouter dans la déclaration de la méthode onCreate), ajoutez ce qui suit :

    Kotlin 

    val launchIntent = intent
if (launchIntent.action == "com.google.intent.action.TEST_LOOP") {
    val scenario = launchIntent.getIntExtra("scenario", 0)
    // Code to handle your game loop here
}
    MainActivity.kt

    Java 

    Intent launchIntent = getIntent();
if(launchIntent.getAction().equals("com.google.intent.action.TEST_LOOP")) {
    int scenario = launchIntent.getIntExtra("scenario", 0);
    // Code to handle your game loop here
}
    MainActivity.java

    Cela permet à votre activité de vérifier l'intention qui la lance. Vous pouvez également ajouter ce code ultérieurement si vous le préférez (par exemple, après avoir chargé initialement votre moteur de jeu).

  3. Recommandation : à la fin du test, ajoutez :

    Kotlin 

    yourActivity.finish()
    MainActivity.kt

    Java 

    yourActivity.finish();
    MainActivity.java

    Cela ferme votre application une fois le test de boucle de jeu terminé. Le test s'appuie sur le framework d'UI de votre application pour démarrer la boucle suivante. La fermeture de votre application indique que le test est terminé.

Créer et exécuter un test de boucle de jeu

Après avoir configuré votre application pour les tests Game Loop, vous pouvez immédiatement créer un test et l'exécuter dans votre application de jeu. Vous pouvez choisir d'exécuter un test dans Test Lab à l'aide de la console Firebase ou de l'interface de ligne de commande (CLI) gcloud, ou sur un appareil local à l'aide de Test Loop Manager.

Exécuter sur un appareil local

Test Loop Manager de Test Lab est une application Open Source qui vous aide à intégrer des tests de boucle de jeu et à les exécuter sur vos appareils locaux. Cela permet également à votre équipe d'assurance qualité d'exécuter les mêmes boucles de jeu sur ses appareils.

Pour exécuter un test sur un appareil local à l'aide du gestionnaire de boucle de test :

  1. Téléchargez Test Loop Manager sur un téléphone ou une tablette, puis installez-le en exécutant la commande suivante : 
    adb install testloopmanager.apk
  2. Sur votre téléphone ou votre tablette, ouvrez l'application Test Loop Apps. L'application affiche la liste des applications sur votre appareil qui peuvent être exécutées avec des boucles de jeu. Si votre application de jeu ne s'affiche pas, assurez-vous que votre filtre d'intent correspond à celui décrit dans la première étape de la section Avant de commencer.
  3. Sélectionnez votre application de jeu, puis le nombre de boucles que vous souhaitez exécuter. Remarque : À cette étape, vous pouvez choisir d'exécuter un sous-ensemble de boucles au lieu d'une seule. Pour en savoir plus sur l'exécution de plusieurs boucles à la fois, consultez Fonctionnalités facultatives.
  4. Cliquez sur Run test (Exécuter le test). Votre test commence à s'exécuter immédiatement.

Exécuter dans Test Lab

Vous pouvez exécuter un test Game Loop dans Test Lab à l'aide de la console Firebase ou de la gcloud CLI. Avant de commencer, si vous ne l'avez pas déjà fait, ouvrez la console Firebase et créez un projet.

Utiliser la console Firebase

  1. Dans la console Firebase, cliquez sur Test Lab dans le panneau de gauche.
  2. Cliquez sur Exécuter votre premier test (ou sur Exécuter un test si votre projet a déjà exécuté un test).
  3. Sélectionnez Game Loop comme type de test, puis cliquez sur Continuer.
  4. Cliquez sur Parcourir, puis accédez au fichier .apk de votre application. Remarque : À cette étape, vous pouvez choisir d'exécuter un sous-ensemble de boucles au lieu d'une seule. Pour en savoir plus sur l'exécution de plusieurs boucles à la fois, consultez Fonctionnalités facultatives.
  5. Cliquez sur Continuer.
  6. Sélectionnez les appareils physiques à utiliser pour tester votre application.
  7. Cliquez sur Démarrer les tests.

Pour en savoir plus sur les premiers pas avec la console Firebase, consultez Commencer à tester avec la console Firebase.

Utiliser la ligne de commande gcloud (CLI)

  1. Si ce n'est pas déjà fait, téléchargez et installez le SDK Google Cloud.

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

    gcloud auth login

  3. Définissez votre projet Firebase dans gcloud, où PROJECT_ID correspond à l'ID de votre projet Firebase :

    gcloud config set project PROJECT_ID

  4. Exécutez votre premier test :

    gcloud firebase test android run \
 --type=game-loop --app=<var>path-to-apk</var> \
 --device model=herolte,version=23

Pour en savoir plus sur la gcloud CLI, consultez Commencer à tester à partir de la ligne de commande gcloud.

Fonctionnalités optionnelles

Test Lab propose plusieurs fonctionnalités facultatives qui vous permettent de personnaliser davantage vos tests, y compris la possibilité d'écrire des données de sortie, la prise en charge de plusieurs boucles de jeu et des libellés pour les boucles associées.

Écrire des données de sortie

Votre test Game Loop peut écrire la sortie dans un fichier spécifié dans la méthode launchIntent.getData(). Après avoir exécuté un test, vous pouvez accéder à ces données de sortie dans la section Test Lab de la console Firebase (voir Exemple de fichier de sortie du test de boucle de jeu).

Test Lab suit les bonnes pratiques pour le partage de fichiers entre applications décrites dans Partager un fichier. Dans la méthode onCreate() de votre activité, où se trouve votre intention, vous pouvez vérifier votre fichier de sortie de données en exécutant le code suivant :

Kotlin 

val launchIntent = intent
val logFile = launchIntent.data
logFile?.let {
    Log.i(TAG, "Log file ${it.encodedPath}")
    // ...
}
MainActivity.kt

Java 

Intent launchIntent = getIntent();
Uri logFile = launchIntent.getData();
if (logFile != null) {
    Log.i(TAG, "Log file " + logFile.getEncodedPath());
    // ...
}
MainActivity.java

Si vous souhaitez écrire dans le fichier depuis le côté C++ de votre application de jeu, vous pouvez transmettre le descripteur de fichier au lieu du chemin d'accès au fichier :

Kotlin 

val launchIntent = intent
val logFile = launchIntent.data
var fd = -1
logFile?.let {
    Log.i(TAG, "Log file ${it.encodedPath}")
    fd = try {
        contentResolver
            .openAssetFileDescriptor(logFile, "w")!!
            .parcelFileDescriptor
            .fd
    } catch (e: FileNotFoundException) {
        e.printStackTrace()
        -1
    } catch (e: NullPointerException) {
        e.printStackTrace()
        -1
    }
}

// C++ code invoked here.
// native_function(fd);
MainActivity.kt

Java 

Intent launchIntent = getIntent();
Uri logFile = launchIntent.getData();
int fd = -1;
if (logFile != null) {
    Log.i(TAG, "Log file " + logFile.getEncodedPath());
    try {
        fd = getContentResolver()
                .openAssetFileDescriptor(logFile, "w")
                .getParcelFileDescriptor()
                .getFd();
    } catch (FileNotFoundException e) {
        e.printStackTrace();
        fd = -1;
    } catch (NullPointerException e) {
        e.printStackTrace();
        fd = -1;
    }
}

// C++ code invoked here.
// native_function(fd);
MainActivity.java

C++

#include <unistd.h>
JNIEXPORT void JNICALL
Java_my_package_name_MyActivity_native_function(JNIEnv *env, jclass type, jint log_file_descriptor) {
// The file descriptor needs to be duplicated.
int my_file_descriptor = dup(log_file_descriptor);
}

Exemple de fichier de sortie

Vous pouvez utiliser des fichiers de données de sortie (formatés comme dans l'exemple ci-dessous) pour afficher les résultats des tests de boucle de jeu dans la section Test Lab de la console Firebase. Les zones indiquées par /.../ peuvent contenir tous les champs personnalisés dont vous avez besoin, à condition qu'ils ne soient pas en conflit avec les noms des autres champs utilisés dans ce fichier :

{
  "name": "test name",
  "start_timestamp": 0, // Timestamp of the test start (in us).
                           Can be absolute or relative
  "driver_info": "...",
  "frame_stats": [
    {
      "timestamp": 1200000, // Timestamp at which this section was written
                               It contains value regarding the period
                               start_timestamp(0) -> this timestamp (1200000 us)
      "avg_frame_time": 15320, // Average time to render a frame in ns
      "nb_swap": 52, // Number of frame rendered
      "threads": [
        {
          "name": "physics",
          "Avg_time": 8030 // Average time spent in this thread per frame in us
        },
        {
          "name": "AI",
          "Avg_time": 2030 // Average time spent in this thread per frame in us
        }
      ],
      /.../ // Any custom field you want (vertices display on the screen, nb units …)
    },
    {
      // Next frame data here, same format as above
    }
  ],
  "loading_stats": [
    {
      "name": "assets_level_1",
      "total_time": 7850, // in us
      /.../
    },
    {
      "name": "victory_screen",
      "total_time": 554, // in us
      /.../
    }

  ],
  /.../, // You can add custom fields here
}

Plusieurs boucles de jeu

Il peut être utile d'exécuter plusieurs boucles de jeu dans votre application. Une boucle est une exécution complète de votre application de jeu du début à la fin. Par exemple, si votre jeu comporte plusieurs niveaux, vous pouvez utiliser une boucle de jeu pour lancer chaque niveau au lieu d'une boucle qui itère sur tous les niveaux. Ainsi, si votre application plante au niveau 32, vous pouvez lancer directement cette boucle de jeu pour reproduire le plantage et tester les correctifs.

Pour permettre à votre application d'exécuter plusieurs boucles à la fois :

  • Si vous exécutez un test avec le Test Loop Manager :

    1. Ajoutez la ligne suivante au fichier manifeste de votre application, dans l'élément <application> : 

      <meta-data
  android:name="com.google.test.loops"
  android:value="5" />

      Cet intent de lancement contient la boucle cible en tant que paramètre entier. Dans le champ android:value, vous pouvez spécifier un entier compris entre 1 et 1 024 (nombre maximal de boucles autorisées pour un seul test). Notez que les boucles sont indexées à partir de 1, et non de 0.

    2. Dans l'application Test Loop Manager, un écran de sélection s'affiche et vous permet de choisir le ou les boucles à exécuter. Si vous sélectionnez plusieurs boucles, chacune d'elles est lancée séquentiellement après la fin de la boucle précédente.

  • Si vous exécutez un test avec la console Firebase, saisissez une liste ou une plage de numéros de boucle dans le champ Scénarios.

  • Si vous exécutez un test avec gcloud CLI, spécifiez une liste de numéros de boucle à l'aide de l'option --scenario-numbers. Par exemple, --scenario-numbers=1,3,5 exécute les boucles 1, 3 et 5.

  • Si vous écrivez du code C++ et que vous souhaitez modifier le comportement de votre boucle, transmettez l'extra suivant à votre code C++ natif :

    Kotlin 

    val launchIntent = intent
val scenario = launchIntent.getIntExtra("scenario", 0)
    MainActivity.kt

    Java 

    Intent launchIntent = getIntent();
int scenario = launchIntent.getIntExtra("scenario", 0);
    MainActivity.java

    Vous pouvez désormais modifier le comportement de votre boucle en fonction de la valeur int obtenue.

Ajouter des libellés aux boucles de jeu

Lorsque vous libellez vos boucles de jeu avec un ou plusieurs libellés de scénario, vous et votre équipe QA pouvez facilement lancer un ensemble de boucles de jeu associées (par exemple, "all compatibility game loops") et testez-les dans une seule matrice. Vous pouvez créer vos propres libellés ou utiliser ceux prédéfinis proposés par Test Lab :

  • com.google.test.loops.player_experience : boucles utilisées pour reproduire l'expérience d'un utilisateur réel lorsqu'il joue au jeu. L'objectif des tests avec ces boucles est d'identifier les problèmes qu'un utilisateur réel pourrait rencontrer en jouant au jeu.
  • com.google.test.loops.gpu_compatibility : boucles "for" utilisées pour tester les problèmes liés au GPU. L'objectif des tests avec ces boucles est d'exécuter du code GPU qui pourrait ne pas fonctionner correctement en production, afin de mettre en évidence les problèmes liés au matériel et aux pilotes.
  • com.google.test.loops.compatibility : boucles "for" utilisées pour tester un large éventail de problèmes de compatibilité, y compris les problèmes d'E/S et OpenSSL.
  • com.google.test.loops.performance : boucles For utilisées pour tester les performances de l'appareil. Par exemple, un jeu peut s'exécuter avec les paramètres graphiques les plus complexes pour voir comment se comporte un nouvel appareil.

Pour permettre à votre application d'exécuter des boucles avec le même libellé :

  • Si vous exécutez un test avec le Test Loop Manager :

    1. Dans le fichier manifeste de votre application, ajoutez la ligne de métadonnées suivante et remplacez LABEL_NAME par le libellé de votre choix :

      <meta-data
 android:name="com.google.test.loops.LABEL_NAME"
 android:value="1,3-5" />

      Dans le champ android:value, vous pouvez spécifier une plage ou un ensemble d'entiers compris entre 1 et 1 024 (le nombre maximal de boucles autorisé pour un seul test) qui représentent les boucles que vous souhaitez étiqueter. Notez que les boucles sont indexées à partir de 1, et non de 0. Par exemple, android:value="1,3-5" s'applique LABEL_NAME aux boucles 1, 3, 4 et 5.

    2. Dans l'application Test Loop Manager, saisissez un ou plusieurs libellés dans le champ Labels (Libellés).

  • Si vous exécutez un test avec la console Firebase, saisissez une ou plusieurs étiquettes dans le champ Étiquettes.

  • Si vous exécutez un test avec gcloud CLI, spécifiez une ou plusieurs étiquettes de scénario à l'aide de l'option --scenario-labels (par exemple, --scenario-labels=performance,gpu).

Assistance pour l'attribution de licences d'application

Test Lab est compatible avec les applications qui utilisent le service Gestion des licences d'application proposé par Google Play. Pour vérifier correctement la licence lorsque vous testez votre application avec Test Lab, vous devez publier votre application sur le canal de production du Play Store. Pour tester votre application dans le canal alpha ou bêta à l'aide de Test Lab, supprimez le contrôle de licence avant d'importer votre application dans Test Lab.

Problèmes connus

Les tests de boucle de jeu dans Test Lab présentent les problèmes connus suivants :

  • Certains plantages ne sont pas compatibles avec les backtraces. Par exemple, certaines versions peuvent supprimer la sortie du processus debuggerd à l'aide de prctl(PR_SET_DUMPABLE, 0). Pour en savoir plus, consultez debuggerd.
  • Le niveau d'API 19 n'est actuellement pas pris en charge en raison d'erreurs d'autorisation de fichier.