Erste Schritte mit Spielschleifentests für iOS

Mit Spielschleifentests können Sie Tests schreiben, die nativ für Ihre Spiel-Engine sind, und sie dann in Test Lab auf den von Ihnen ausgewählten Geräten ausführen. So müssen Sie sich keine Gedanken darüber machen, für verschiedene UI- oder Test-Frameworks zu schreiben. Ein Spielschleifentest simuliert die Aktionen eines echten Spielers. Wenn Sie ihn in Test Lab ausführen, können Sie schnell und skalierbar prüfen, ob Ihr Spiel für Ihre Nutzer gut funktioniert.

Auf dieser Seite erfahren Sie, wie Sie einen Spielschleifentest ausführen und die Testergebnisse auf der Seite Test Lab der Firebase Console ansehen und verwalten. Sie können Ihre Tests auch mit optionalen Funktionen weiter anpassen, z. B. benutzerdefinierte Testergebnisse schreiben oder den Test vorzeitig beenden.

Hinweis: Sie können Test Lab im Rahmen des Spark-Preismodells kostenlos nutzen. Es gilt jedoch ein begrenztes tägliches Kontingent. Weitere Informationen zu anderen Preismodellen und Nutzungslimits finden Sie unter Firebase-Preismodelle.

Was ist ein Spielschleifentest?

Eine Schleife ist ein vollständiger oder teilweiser Durchlauf des Tests in Ihrer Gaming-App. Sie können einen Spielschleifentest lokal in einem Simulator oder auf einer Reihe von Geräten in Test Lab ausführen. Spielschleifentests können für Folgendes verwendet werden:

• Spielen Sie Ihr Spiel so, wie es ein Endnutzer tun würde. Sie können entweder die Eingabe des Nutzers per Skript festlegen, den Nutzer inaktiv lassen oder den Nutzer durch eine KI ersetzen. Wenn Sie beispielsweise KI in einem Autorennspiel implementiert haben, können Sie einen KI-Fahrer für die Eingabe des Nutzers verantwortlich machen.

• Führe dein Spiel mit der höchsten Qualitätseinstellung aus, um herauszufinden, welche Geräte es unterstützen können.

• Führe einen technischen Test durch, z. B. das Kompilieren mehrerer Shader, das Ausführen dieser Shader und das Prüfen, ob die Ausgabe wie erwartet ist.

Schritt 1: Benutzerdefiniertes URL-Schema von Test Lab registrieren

Zuerst müssen Sie das benutzerdefinierte URL-Schema von Firebase Test Lab in Ihrer App registrieren:

1. Wählen Sie in Xcode ein Projektziel aus.

2. Klicken Sie auf den Tab Info und fügen Sie einen neuen URL-Typ hinzu.

3. Geben Sie im Feld URL-Schemas firebase-game-loop ein. Sie können das benutzerdefinierte URL-Schema auch registrieren, indem Sie es an einer beliebigen Stelle innerhalb des <dict>-Tags in die Info.plist-Konfigurationsdatei Ihres Projekts einfügen:

   <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>
   

Ihre App ist jetzt so konfiguriert, dass ein Test mit Test Lab ausgeführt wird.

Schritt 2 (optional): App für die Ausführung mehrerer Schleifen konfigurieren

Wenn für Ihre App mehrere benutzerdefinierte URL-Schemas registriert sind und Sie mehrere Schleifen (auch Szenarien genannt) in Ihrem Test ausführen möchten, müssen Sie beim Start angeben, welche Schleifen in Ihrer App ausgeführt werden sollen.

Überschreiben Sie im App-Delegat die Methode 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 <UIApplicationOpenURLOptionsKey, id> *)options {
  if ([url.scheme isEqualToString:(@"firebase-game-loop")]) {
      // ...Enter Game Loop Test logic to override application(_:open:options:).
  }
}

Wenn Sie mehrere Schleifen in Ihrem Test ausführen, wird die aktuelle Schleife als Parameter an die URL übergeben, die zum Starten der App verwendet wird. Sie können die aktuelle Schleifennummer auch abrufen, indem Sie das URLComponents-Objekt parsen, das zum Abrufen des benutzerdefinierten URL-Schemas verwendet wird:

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).
        }
    }
}

Schritt 3: Test erstellen und ausführen

Nachdem Sie das benutzerdefinierte URL-Schema von Test Lab registriert haben, können Sie den Test in der Firebase-Console oder mit der gcloud Beta CLI ausführen. Falls noch nicht geschehen, generieren Sie eine IPA-Datei für Ihre App. Sie müssen sie später finden.

Tipp: Bevor du Test Lab verwendest, kannst du zuerst prüfen, ob deine Spielschleifen wie vorgesehen funktionieren, indem du den Test lokal auf einem Simulator ausführst.

IPA für Ihre App generieren

1. Wählen Sie in Xcode ein Bereitstellungsprofil für die Ziel-App aus.
   Hinweis: Test Lab signiert Ihre App mit einem eigenen Bereitstellungsprofil und Zertifikat neu.
2. Klicken Sie im Drop-down-Menü auf Produkt > Archivieren. Wählen Sie das neueste Archiv aus und klicken Sie dann auf Distribute App (App verteilen).
3. Klicken Sie im eingeblendeten Fenster auf Entwicklung > Weiter.
4. Optional:Wenn Sie einen schnelleren Build wünschen, deaktivieren Sie die Option Rebuild from Bitcode (Aus Bitcode neu erstellen) und klicken Sie dann auf Next (Weiter). Test Lab erfordert kein Thinning oder Neuerstellen Ihrer App, um einen Test auszuführen. Sie können diese Option also bedenkenlos deaktivieren.
5. Klicken Sie auf Exportieren und geben Sie ein Verzeichnis ein, in das Sie die IPA-Datei Ihrer App herunterladen möchten.

Test in der Firebase-Konsole ausführen

1. Rufen Sie in der Firebase Console DevOps & Engagement > Test Lab auf.

2. Klicken Sie auf Ersten Test ausführen > iOS-Spielschleife ausführen.

3. Klicken Sie im Bereich App hochladen auf Durchsuchen und wählen Sie die IPA-Datei Ihrer App aus. Falls Sie noch keine IPA-Datei für Ihre App haben, erstellen Sie eine.

4. (Optional) Wenn Sie mehrere Schleifen (auch Szenarien genannt) gleichzeitig ausführen oder bestimmte Schleifen auswählen möchten, geben Sie die Schleifennummern in das Feld Szenarien ein.

   Wenn Sie beispielsweise 1-3, 5 eingeben, führt Test Lab die Schleifen 1, 2, 3 und 5 aus. Wenn Sie im Feld Szenarien nichts eingeben, führt Test Lab standardmäßig nur die Schleife 1 aus.

5. Wählen Sie im Bereich Geräte ein oder mehrere physische Geräte aus, auf denen Sie Ihre App testen möchten, und klicken Sie dann auf Tests starten.

Test mit der gcloud Beta CLI ausführen

Beta: Der gcloud-Beta-CLI-Befehl für iOS-Spielschleifentests ist ein Beta-Release. Das bedeutet, dass sich die Funktionalität auf nicht abwärtskompatible Weise ändern kann. Eine Betaversion unterliegt weder einem SLA noch einer Richtlinie zur Einstellung von Produkten und Diensten und wird möglicherweise nur eingeschränkt oder gar nicht unterstützt.

1. Konfigurieren Sie Ihre lokale gcloud SDK-Umgebung, falls noch nicht geschehen, und installieren Sie die gcloud-Betakomponente.

2. Führen Sie den Befehl gcloud beta firebase test ios run aus und verwenden Sie die folgenden Flags, um die Ausführung zu konfigurieren:

Flags für Spielschleifentests
--type	Erforderlich: Gibt den Typ des iOS-Tests an, den Sie ausführen möchten. Sie können die Testtypen xctest (Standard) oder game-loop eingeben.
--app	Erforderlich: Absoluter Pfad (Google Cloud Storage oder Dateisystem) zur IPA-Datei Ihrer App. Dieses Flag ist nur gültig, wenn Spielschleifentests ausgeführt werden.
--scenario-numbers	Die Schleifen (auch Szenarien genannt), die Sie in Ihrer App ausführen möchten. Sie können eine Schleife, eine Liste von Schleifen oder einen Bereich von Schleifen eingeben. Der Standardwert ist 1. --scenario-numbers=1-3,5 führt beispielsweise die Schleifen 1, 2, 3 und 5 aus.
--device-model	Das physische Gerät, auf dem Sie den Test ausführen möchten (hier finden Sie eine Liste der verfügbaren Geräte).
--timeout	Die maximale Dauer des Tests. Sie können eine Ganzzahl eingeben, um die Dauer in Sekunden darzustellen, oder eine Ganzzahl und eine Aufzählung, um die Dauer als längere Zeiteinheit darzustellen. Beispiel: --timeout=200 erzwingt, dass der Test beendet wird, wenn er bis zu 200 Sekunden dauert. --timeout=1h erzwingt, dass der Test nach einer Stunde beendet wird.

Mit dem folgenden Befehl wird beispielsweise ein Spielschleifentest ausgeführt, bei dem die Schleifen 1, 4, 6, 7 und 8 auf einem iPhone 8 Plus ausgeführt werden:

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

Weitere Informationen zur gcloud CLI finden Sie in der Referenzdokumentation.

Test lokal ausführen

Wenn Sie den Test lokal ausführen möchten, laden Sie Ihre Gaming-App in einen Simulator und führen Sie Folgendes aus:

xcrun simctl openurl SIMULATOR_UDID firebase-game-loop://

• Sie finden die UDID Ihres Simulators, indem Sie den Befehl instruments -s devices ausführen.

• Wenn nur ein Simulator ausgeführt wird, geben Sie anstelle von SIMULATOR_UDID den speziellen String "booted" ein.

Wenn Ihr Test mehrere Schleifen enthält, können Sie angeben, welche Schleife ausgeführt werden soll, indem Sie die Schleifennummer an das Flag scenario übergeben. Beachten Sie, dass Sie bei der lokalen Ausführung des Tests jeweils nur eine Schleife ausführen können. Wenn Sie beispielsweise die Schleifen 1, 2 und 5 ausführen möchten, müssen Sie für jede Schleife einen separaten Befehl ausführen:

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

Test vorzeitig beenden

Standardmäßig wird ein Spielschleifentest so lange ausgeführt, bis ein Zeitlimit von fünf Minuten erreicht ist, auch wenn alle Schleifen ausgeführt wurden. Wenn das Zeitlimit erreicht ist, wird der Test beendet und alle ausstehenden Schleifen werden abgebrochen. Sie können den Test beschleunigen oder vorzeitig beenden, indem Sie das benutzerdefinierte URL-Schema firebase-game-loop-complete von Test Lab im AppDelegate Ihrer App aufrufen. Beispiel:

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) {}];
}

Der Spielschleifentest beendet die aktuelle Schleife und führt die nächste Schleife aus. Wenn keine Schleifen mehr ausgeführt werden müssen, wird der Test beendet.

Benutzerdefinierte Testergebnisse schreiben

Sie können den Spielschleifentest so konfigurieren, dass benutzerdefinierte Testergebnisse in das Dateisystem Ihres Geräts geschrieben werden. So werden die Ergebnisdateien beim Start des Tests von Test Lab in einem GameLoopsResults-Verzeichnis auf Ihrem Testgerät gespeichert, das Sie selbst erstellen müssen. Wenn der Test beendet ist, verschiebt Test Lab alle Dateien aus dem Verzeichnis GameLoopResults in den Bucket Ihres Projekts. Beachten Sie beim Einrichten des Tests Folgendes:

• Alle Ergebnisdateien werden unabhängig von Dateityp, Größe oder Menge hochgeladen.

• Test Lab verarbeitet Ihre Testergebnisse erst, wenn alle Schleifen im Test abgeschlossen sind. Wenn Ihr Test also mehrere Schleifen enthält, die Ausgaben schreiben, müssen Sie sie an eine eindeutige Ergebnisdatei anhängen oder für jede Schleife eine Ergebnisdatei erstellen. So können Sie vermeiden, dass Ergebnisse aus einer vorherigen Schleife überschrieben werden.

So richten Sie Ihren Test ein, um benutzerdefinierte Testergebnisse zu schreiben:

1. Erstellen Sie im Verzeichnis Documents Ihrer Anwendung ein Verzeichnis mit dem Namen GameLoopResults.

2. Fügen Sie an einer beliebigen Stelle im Code Ihrer App (z.B. im App-Delegat) Folgendes hinzu:

   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];
       }
   }