Catch up on highlights from Firebase at Google I/O 2023. Learn more

Cette page a été traduite par l'API Cloud Translation.

Démarrez avec les tests Game Loop

Il peut être difficile d'automatiser les tests de jeu lorsque les applications de jeu sont construites sur différents frameworks d'interface utilisateur. Les tests Game Loop vous permettent d'intégrer vos tests natifs à Test Lab et de les exécuter facilement sur les appareils que vous sélectionnez. Un test Game Loop exécute votre test via votre application de jeu tout en simulant les actions d'un vrai joueur. Ce guide vous montre comment exécuter un test Game Loop, puis afficher et gérer vos résultats de test dans la console Firebase.

Selon votre moteur de jeu, vous pouvez implémenter des tests avec une ou plusieurs boucles . Une boucle est un parcours complet ou partiel 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 soit scripter l'entrée de l'utilisateur, laisser l'utilisateur inactif ou remplacer l'utilisateur par une IA si cela a du sens dans votre jeu (par exemple, disons que vous avez une application de jeu de voiture de course et qu'une IA est déjà implémentée. Vous pouvez mettre facilement un pilote d'IA en charge de l'entrée de l'utilisateur).
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 shaders, exécutez-les, vérifiez que la sortie est comme prévu, etc.).

Vous pouvez exécuter un test Game Loop sur un seul appareil de test, un ensemble d'appareils de test ou sur Test Lab. Cependant, 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 que tu commences

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

Dans le manifeste de votre application, ajoutez un nouveau filtre d'intention à 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 le déclenchant avec une intention spécifique.
Remarque : les boucles de jeu nécessitent un filtre d'intention distinct et dédié qui n'est pas utilisé à d'autres fins. Votre activité peut inclure d'autres filtres d'intention. Pour en savoir plus sur les filtres d'intention, consultez la page de référence <intent-filter>.

Dans votre code (nous recommandons dans la déclaration de la méthode onCreate ), ajoutez ce qui suit :

Kotlin+KTX

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 plus tard si vous préférez (par exemple, après le chargement initial de votre moteur de jeu).

Recommandé : À la fin du test, ajoutez :
Kotlin+KTX
```
yourActivity.finish()MainActivity.kt
```
Java
```
yourActivity.finish();MainActivity.java
```
Cela ferme votre application lorsque le test Game Loop est terminé. Le test s'appuie sur le framework d'interface utilisateur de votre application pour démarrer la boucle suivante, et la fermeture de votre application lui indique que le test est terminé.

Créer et exécuter un test Game Loop

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 les tests Game Loop 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 leurs appareils.

Pour exécuter un test sur un appareil local à l'aide de Test Loop Manager :

Téléchargez le Test Loop Manager sur un téléphone ou une tablette et installez-le en exécutant :
```
adb install testloopmanager.apk
```
Sur votre appareil, ouvrez l'application Test Loop Apps sur votre téléphone ou votre tablette. L'application affiche une liste d'applications sur votre appareil qui peuvent être exécutées avec des boucles de jeu. Si vous ne voyez pas votre application de jeu ici, assurez-vous que votre filtre d'intention correspond à celui décrit dans la première étape de la section Avant de commencer .
Sélectionnez votre application de jeu, puis sélectionnez 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 boucle. Pour plus d'informations sur l'exécution simultanée de plusieurs boucles, consultez Fonctionnalités facultatives.
Cliquez sur Exécuter le test . Votre test démarre immédiatement.

Exécuter dans le laboratoire de test

Vous pouvez exécuter un test Game Loop dans Test Lab à l'aide de la console Firebase ou de la CLI gcloud. 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

Dans la console Firebase, cliquez sur Test Lab dans le panneau de gauche.
Cliquez sur Exécuter votre premier test (ou Exécuter un test si votre projet a déjà exécuté un test).
Sélectionnez Game Loop comme type de test, puis cliquez sur Continuer .
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 boucle. Pour plus d'informations sur l'exécution simultanée de plusieurs boucles, consultez Fonctionnalités facultatives.
Cliquez sur Continuer .
Sélectionnez les appareils physiques à utiliser pour tester votre application.
Cliquez sur Démarrer les tests .

Pour plus d'informations sur la prise en main de la console Firebase, consultez Commencer les tests avec la console Firebase.

Utiliser la ligne de commande gcloud (CLI)

Si vous ne l'avez pas déjà fait, téléchargez et installez le SDK Google Cloud.
Connectez-vous à l'interface de ligne de commande gcloud à l'aide de votre compte Google :
gcloud auth login
Définissez votre projet Firebase dans gcloud, où PROJECT_ID est l'ID de votre projet Firebase :
```
gcloud config set project PROJECT_ID
```
Exécutez votre premier test :
```
gcloud firebase test android run \
 --type=game-loop --app=<var>path-to-apk</var> \
 --device model=herolte,version=23
```
Remarque : à cette étape, vous pouvez choisir d'exécuter un sous-ensemble de boucles au lieu d'une seule boucle. Pour plus d'informations sur l'exécution simultanée de plusieurs boucles, consultez Fonctionnalités facultatives.

Pour plus d'informations sur la prise en main de l'interface de ligne de commande gcloud, consultez Commencer les tests à partir de la ligne de commande gcloud.

Caractéristiques optionnelles

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

Écrire les données de sortie

Votre test Game Loop peut écrire une 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 l'exemple de fichier de sortie de test Game Loop ).

Test Lab suit les meilleures pratiques pour partager un fichier entre les applications décrites dans Partage d'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+KTX

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 du fichier :

Kotlin+KTX

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 affichées sous la forme /.../ peuvent contenir tous les champs personnalisés dont vous avez besoin, tant qu'ils n'entrent 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

Vous trouverez peut-être utile d'exécuter plusieurs boucles de jeu dans votre application. Une boucle est un parcours complet de votre application de jeu du début à la fin. Par exemple, si vous avez plusieurs niveaux dans votre jeu, vous souhaiterez peut-être avoir une boucle de jeu pour lancer chaque niveau au lieu d'avoir une boucle qui les parcourt tous. De cette façon, si votre application plante au niveau 32, vous pouvez lancer directement cette boucle de jeu pour reproduire le plantage et tester les corrections de bogues.

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

Si vous exécutez un test avec Test Loop Manager :
1. Ajoutez la ligne suivante au manifeste de votre application, dans l'élément <application> :
```
<meta-data
  android:name="com.google.test.loops"
  android:value="5" />
```
  Cette intention de lancement contient la boucle cible en tant que paramètre entier. Dans le champ android:value , vous pouvez spécifier un entier de 1 à 1024 (le nombre maximum 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 apparaît qui vous permet de sélectionner la ou les boucles que vous souhaitez exécuter. Si vous sélectionnez plusieurs boucles, chaque boucle est lancée dans l'ordre 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 l'interface de ligne de commande gcloud, spécifiez une liste de numéros de boucle à l'aide de l'indicateur --scenario-numbers . Par exemple, --scenario-numbers=1,3,5 exécute les boucles 1, 3 et 5.
Si vous écrivez en C++ et souhaitez modifier le comportement de votre boucle, transmettez le supplément suivant à votre code C++ natif :
Kotlin+KTX
```
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 maintenant modifier le comportement de votre boucle en fonction de la valeur int résultante.

Boucles de jeu d'étiquettes

Lorsque vous étiquetez vos boucles de jeu avec une ou plusieurs étiquettes de scénario, vous et votre équipe QA pouvez facilement lancer un ensemble de boucles de jeu associées (par exemple, "toutes les boucles de jeu de compatibilité") et les tester dans une seule matrice. Vous pouvez créer vos propres étiquettes ou utiliser les étiquettes prédéfinies proposées par Test Lab :

com.google.test.loops.player_experience : pour les boucles utilisées pour reproduire l'expérience d'un utilisateur réel lors de la lecture du jeu. Le but des tests avec ces boucles est de trouver les problèmes auxquels un vrai utilisateur serait confronté en jouant au jeu.
com.google.test.loops.gpu_compatibility : pour les boucles 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 d'exposer les problèmes liés au matériel et aux pilotes.
com.google.test.loops.compatibility : pour les boucles utilisées pour tester un large éventail de problèmes de compatibilité, y compris les problèmes d'E/S et les problèmes OpenSSL.
com.google.test.loops.performance : pour les boucles 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 un nouvel appareil se comporte.

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

Si vous exécutez un test avec Test Loop Manager :
1. Dans le manifeste de votre application, ajoutez la ligne de métadonnées suivante et remplacez LABEL_NAME par un 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 de 1 à 1024 (le nombre maximum de boucles autorisées 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" applique LABEL_NAME aux boucles 1, 3, 4 et 5.
2. Dans l'application Test Loop Manager, saisissez une ou plusieurs étiquettes dans le champ Étiquettes .
Si vous exécutez un test avec la console Firebase, saisissez un ou plusieurs libellés dans le champ Libellés .
Si vous exécutez un test avec l'interface de ligne de commande gcloud, spécifiez un ou plusieurs libellés de scénario à l'aide de l'indicateur --scenario-labels (par exemple, --scenario-labels=performance,gpu ).

Prise en charge des licences d'application

Test Lab prend en charge les applications qui utilisent le service de licence d'application proposé par Google Play. Pour vérifier avec succès la licence lors du test de 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 la vérification des licences avant de télécharger votre application sur Test Lab.

Problèmes connus

Les tests Game Loop dans Test Lab présentent les problèmes connus suivants :

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