Premiers pas avec les tests de boucle de jeu pour iOS

Les tests de boucle de jeu vous permettent d'écrire des tests natifs pour votre moteur de jeu, puis de les exécuter dans Test Lab sur les appareils de votre choix. Ainsi, vous n'avez pas à vous soucier d'écrire pour différentes interfaces utilisateur ou frameworks de test. Un test de boucle de jeu simule les actions d'un vrai joueur. Lorsque vous l'exécutez sur Test Lab, il vous permet de vérifier rapidement et de manière évolutive que votre jeu fonctionne correctement pour vos utilisateurs.

Cette page vous explique comment exécuter un test de boucle de jeu, puis afficher et gérer les résultats de vos tests sur la page Test Lab de la console Firebase. Vous pouvez également personnaliser davantage vos tests avec des fonctionnalités facultatives, comme l'écriture de résultats de test personnalisés ou l'arrêt anticipé de votre test.

Qu'est-ce qu'un test de boucle de jeu ?

Une boucle est une exécution complète ou partielle de votre test sur votre application de jeu. Vous pouvez exécuter un test de boucle de jeu localement sur un simulateur ou sur un ensemble d'appareils dans Test Lab. Les tests de boucle de jeu peuvent être utilisés pour :

  • Parcourez votre jeu comme le ferait un utilisateur final. Vous pouvez soit scripter l'entrée de l'utilisateur, soit laisser l'utilisateur inactif, soit remplacer l'utilisateur par une IA (par exemple, si vous avez implémenté l'IA dans un jeu de course automobile, vous pouvez confier l'entrée de l'utilisateur à un pilote IA).

  • Exécutez votre jeu avec le paramètre de qualité le plus élevé pour identifier les appareils compatibles.

  • Exécutez un test technique, par exemple en compilant plusieurs nuanceurs, en les exécutant et en vérifiant que le résultat est conforme aux attentes.

Étape 1 : Enregistrez le schéma d'URL personnalisé de Test Lab

Vous devez d'abord enregistrer le schéma d'URL personnalisé de Firebase Test Lab dans votre application :

  1. Dans Xcode, sélectionnez une cible de projet.

  2. Cliquez sur l'onglet Info, puis ajoutez un nouveau type d'URL.

  3. Dans le champ Schémas d'URL, saisissez firebase-game-loop. Vous pouvez également enregistrer le schéma d'URL personnalisé en l'ajoutant au fichier de configuration Info.plist de votre projet, n'importe où dans la balise <dict> :

    <key>CFBundleURLTypes</key>
     <array>
         <dict>
             <key>CFBundleURLName</key>
             <string></string>
             <key>CFBundleTypeRole</key>
             <string>Editor</string>
             <key>CFBundleURLSchemes</key>
             <array>
                 <string>firebase-game-loop</string>
             </array>
         </dict>
     </array>
    

Votre application est maintenant configurée pour exécuter un test à l'aide de Test Lab.

Étape 2 (facultative) : Configurez votre application pour qu'elle exécute plusieurs boucles

Si votre application comporte plusieurs schémas d'URL personnalisés enregistrés et que vous prévoyez d'exécuter plusieurs boucles (ou scénarios) dans votre test, vous devez spécifier les boucles que vous souhaitez exécuter dans votre application au moment du lancement.

Dans le délégué de votre application, remplacez la méthode application(_:open:options:) :

Swift

func application(_app: UIApplication,
                 open url: URL
                 options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    let components = URLComponents(url: url, resolvingAgainstBaseURL: true)!
    if components.scheme == "firebase-game-loop" {
        // ...Enter Game Loop Test logic to override application(_:open:options:).
    }
    return true
}

Objective-C

- (BOOL)application:(UIApplication *)app
            openURL:(NSURL *)url
            options:(NSDictionary &lt;UIApplicationOpenURLOptionsKey, id&gt; *)options {
  if ([url.scheme isEqualToString:(@"firebase-game-loop")]) {
      // ...Enter Game Loop Test logic to override application(_:open:options:).
  }
}

Lorsque vous exécutez plusieurs boucles dans votre test, la boucle actuelle est transmise en tant que paramètre à l'URL utilisée pour lancer l'application. Vous pouvez également obtenir le numéro de boucle actuel en analysant l'objet URLComponents utilisé pour récupérer le schéma d'URL personnalisé :

Swift

if components.scheme == "firebase-game-loop" {
    // Iterate over all parameters and find the one with the key "scenario".
    let scenarioNum = Int(components.queryItems!.first(where: { $0.name == "scenario" })!.value!)!
    // ...Write logic specific to the current loop (scenarioNum).
}

Objective-C

if ([url.scheme isEqualToString:(@"firebase-game-loop")]) {
    // Launch the app as part of a game loop.
    NSURLComponents *components = [NSURLComponents componentsWithURL:url
                                             resolvingAgainstBaseURL:YES];
    for (NSURLQueryItem *item in [components queryItems]) {
        if ([item.name isEqualToString:@"scenario"]) {
            NSInteger scenarioNum = [item.value integerValue];
            // ...Write logic specific to the current loop (scenarioNum).
        }
    }
}

Étape 3 : Créez et exécutez un test

Après avoir enregistré le schéma d'URL personnalisé de Test Lab, vous pouvez exécuter votre test dans la console Firebase ou avec la gcloud beta CLI. Si vous ne l'avez pas déjà fait, générez un fichier IPA pour votre application (vous devrez le localiser plus tard).

Exécuter un test dans la console Firebase

  1. Dans la console Firebase, accédez à DevOps et engagement > Test Lab.

  2. Cliquez sur Run Your First Test > Run an iOS Game Loop (Exécuter votre premier test > Exécuter une boucle de jeu iOS).

  3. Dans la section Importer l'application, cliquez sur Parcourir, puis sélectionnez le fichier IPA de votre application (si vous ne l'avez pas déjà fait, générez un fichier IPA pour votre application).

  4. (Facultatif) Si vous souhaitez exécuter plusieurs boucles (ou scénarios) à la fois ou sélectionner des boucles spécifiques à exécuter, saisissez les numéros de boucle dans le champ Scénarios.

    Par exemple, lorsque vous saisissez 1-3, 5, Test Lab exécute les boucles 1, 2, 3 et 5. Par défaut (si vous ne saisissez rien dans le champ Scénarios), Test Lab n'exécute que la boucle 1.

  5. Dans la section Appareils, sélectionnez un ou plusieurs appareils physiques sur lesquels vous souhaitez tester votre application, puis cliquez sur Lancer les tests.

Exécuter un test avec la CLI gcloud beta

  1. Si vous ne l'avez pas déjà fait, configurez votre environnement SDK gcloud local, puis veillez à installer le composant bêta gcloud.

  2. Exécutez la commande gcloud beta firebase test ios run et utilisez les options suivantes pour configurer l'exécution :

Options pour les tests de boucle de jeu
--type

Obligatoire : spécifie le type de test iOS que vous souhaitez exécuter. Vous pouvez saisir les types de test xctest (par défaut) ou game-loop.

--app

Obligatoire : chemin absolu (Google Cloud Storage ou système de fichiers) au fichier IPA de votre application. Cette option n'est valide que lors de l'exécution de tests de boucle de jeu.

--scenario-numbers

Boucles (ou scénarios) que vous souhaitez exécuter dans votre application. Vous pouvez saisir une boucle, une liste de boucles ou une plage de boucles. La valeur par défaut est 1.

Par exemple, --scenario-numbers=1-3,5 exécute les boucles 1, 2, 3 et 5.

--device-model

L'appareil physique sur lequel vous souhaitez exécuter votre test (découvrez les appareils disponibles que vous pouvez utiliser).

--timeout

Durée maximale d'exécution du test. Vous pouvez saisir un entier pour représenter la durée en secondes, ou un entier et une énumération pour représenter la durée sous la forme d'une unité de temps plus longue.

Exemple :

  • --timeout=200 force l'arrêt de votre test lorsqu'il s'exécute pendant 200 secondes.
  • --timeout=1h force l'arrêt de votre test lorsqu'il s'exécute pendant une heure.

Par exemple, la commande suivante exécute un test de boucle de jeu qui exécute les boucles 1, 4, 6, 7 et 8 sur un iPhone 8 Plus :

gcloud beta firebase test ios run
 --type game-loop --app path/to/my/App.ipa --scenario-numbers 1,4,6-8
 --device-model=iphone8plus

Pour en savoir plus sur la gcloud CLI, consultez la documentation de référence.

Exécuter un test en local

Pour exécuter votre test localement, chargez votre application de jeu dans un simulateur et exécutez la commande suivante :

xcrun simctl openurl SIMULATOR_UDID firebase-game-loop://
  • Pour trouver l'UDID de votre simulateur, exécutez la commande instruments -s devices.

  • S'il n'y a qu'un seul simulateur en cours d'exécution, saisissez la chaîne spéciale "booted" à la place de SIMULATOR_UDID.

Si votre test contient plusieurs boucles, vous pouvez spécifier celle que vous souhaitez exécuter en transmettant le numéro de la boucle à l'option scenario. Notez que vous ne pouvez exécuter qu'une seule boucle à la fois lorsque vous exécutez votre test localement. Par exemple, si vous souhaitez exécuter les boucles 1, 2 et 5, vous devez exécuter une commande distincte pour chaque boucle :

xcrun simctl openurl SIMULATOR_UDID firebase-game-loop://?scenario=1
xcrun simctl openurl SIMULATOR_UDID firebase-game-loop://?scenario=2
xcrun simctl openurl SIMULATOR_UDID firebase-game-loop://?scenario=5

Mettre fin à un test plus tôt que prévu

Par défaut, un test de boucle de jeu continue de s'exécuter jusqu'à ce qu'il atteigne un délai avant expiration de cinq minutes, même lorsque toutes les boucles ont été exécutées. Une fois le délai avant expiration atteint, le test se termine et annule toutes les boucles en attente. Vous pouvez accélérer votre test ou l'arrêter plus tôt en appelant le schéma d'URL personnalisé firebase-game-loop-complete de Test Lab dans l'AppDelegate de votre application. Exemple :

Swift

/// End the loop by calling our custom url scheme.
func finishLoop() {
    let url = URL(string: "firebase-game-loop-complete://")!
    UIApplication.shared.open(url)
}

Objective-C

- (void)finishLoop {
  UIApplication *app = [UIApplication sharedApplication];
  [app openURL:[NSURL URLWithString:@"firebase-game-loop-complete://"]
      options:@{}
completionHandler:^(BOOL success) {}];
}

Votre test de boucle de jeu met fin à la boucle actuelle et exécute la boucle suivante. Lorsqu'il n'y a plus de boucles à exécuter, le test se termine.

Écrire des résultats de test personnalisés

Vous pouvez configurer votre test de boucle de jeu pour écrire des résultats de test personnalisés dans le système de fichiers de votre appareil. Ainsi, lorsque le test commence à s'exécuter, Test Lab stocke les fichiers de résultats dans un répertoire GameLoopsResults sur votre appareil de test (que vous devez créer vous-même). Une fois le test terminé, Test Lab déplace tous les fichiers du répertoire GameLoopResults vers le bucket de votre projet. Tenez compte des points suivants lorsque vous configurez votre test :

  • Tous les fichiers de résultats sont importés, quels que soient leur type de fichier, leur taille ou leur quantité.

  • Test Lab ne traite pas les résultats de vos tests tant que toutes les boucles de votre test n'ont pas fini de s'exécuter. Par conséquent, si votre test inclut plusieurs boucles qui écrivent des résultats, veillez à les ajouter à un fichier de résultats unique ou à créer un fichier de résultats pour chaque boucle. De cette façon, vous pouvez éviter d'écraser les résultats d'une boucle précédente.

Pour configurer votre test afin d'écrire des résultats de test personnalisés :

  1. Dans le répertoire Documents de votre application, créez un répertoire nommé GameLoopResults.

  2. Ajoutez le code suivant n'importe où dans le code de votre application (par exemple, dans le délégué de votre application) :

    Swift

    /// Write to a results file.
    func writeResults() {
      let text = "Greetings from game loops!"
      let fileName = "results.txt"
      let fileManager = FileManager.default
      do {
    
      let docs = try fileManager.url(for: .documentDirectory,
                                     in: .userDomainMask,
                                     appropriateFor: nil,
                                     create: true)
      let resultsDir = docs.appendingPathComponent("GameLoopResults")
      try fileManager.createDirectory(
          at: resultsDir,
          withIntermediateDirectories: true,
          attributes: nil)
      let fileURL = resultsDir.appendingPathComponent(fileName)
      try text.write(to: fileURL, atomically: false, encoding: .utf8)
      } catch {
        // ...Handle error writing to file.
      }
    }
    

    Objective-C

    /// Write to a results file.
    - (void)writeResults:(NSString *)message {
        // Locate and create the results directory (if it doesn't exist already).
        NSFileManager *manager = [NSFileManager defaultManager];
        NSURL* url = [[manager URLsForDirectory:NSDocumentDirectory
                                      inDomains:NSUserDomainMask] lastObject];
        NSURL* resultsDir = [url URLByAppendingPathComponent:@"GameLoopResults"
                                                 isDirectory:YES];
        [manager createDirectoryAtURL:resultsDir
          withIntermediateDirectories:NO
                           attributes:nil
                                error:nil];
    
        // Write the result message to a text file.
        NSURL* resultFile = [resultsDir URLByAppendingPathComponent:@"result.txt"];
        if ([manager fileExistsAtPath:[resultFile path]]) {
            // Append to the existing file
            NSFileHandle *handle = [NSFileHandle fileHandleForWritingToURL:resultFile
                                                                     error:nil];
            [handle seekToEndOfFile];
            [handle writeData:[message dataUsingEncoding:NSUTF8StringEncoding]];
            [handle closeFile];
        } else {
            // Create and write to the file.
            [message writeToURL:resultFile
                     atomically:NO
                       encoding:NSUTF8StringEncoding error:nil];
        }
    }