開始使用 iOS 遊戲迴圈測試

透過遊戲迴圈測試,您可以為遊戲引擎編寫原生測試,然後在您選擇的裝置上透過 Test Lab 執行這些測試。這樣一來,您就不必擔心要為不同的 UI 或測試架構撰寫程式碼。遊戲迴圈測試會模擬真實玩家的動作,而您在 Test Lab 執行測試時,則可透過快速且可擴充的方式驗證遊戲是否對使用者有效。

本頁面說明如何執行 Game Loop 測試,然後在 Firebase 主控台的 Test Lab 頁面中查看及管理測試結果。您也可以使用選用功能進一步自訂測試,例如編寫自訂測試結果提前結束測試

什麼是遊戲迴圈測試?

迴圈是指在遊戲應用程式上執行完整或部分測試。您可以在本機上執行遊戲迴圈測試,或是在 Test Lab 中的一組裝置上執行。遊戲迴圈測試可用於:

  • 以使用者角度玩遊戲,您可以為使用者輸入內容編寫指令碼、讓使用者處於閒置狀態,或是以 AI 取代使用者 (例如,如果您在賽車遊戲中實作 AI,可以讓 AI 駕駛人負責處理使用者的輸入內容)。

  • 以最高畫質設定執行遊戲,找出哪些裝置可支援。

  • 執行技術測試 (例如編譯及執行多個著色器),然後檢查輸出內容是否符合預期。

步驟 1:註冊 Test Lab 的自訂網址通訊協定

首先,您必須在應用程式中註冊 Firebase Test Lab 的自訂網址通訊協定:

  1. 在 Xcode 中選取專案目標。

  2. 按一下「資訊」分頁,然後新增網址類型

  3. 在「網址配置」欄位中輸入 firebase-game-loop。您也可以將自訂網址配置新增至專案的 Info.plist 設定檔,並將其新增至 <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>
    

應用程式現已設為使用 Test Lab 執行測試。

步驟 2 (選用):設定應用程式以執行多個迴圈

如果應用程式已註冊多個自訂網址配置,且您打算在測試中執行多個迴圈 (即情境),則必須在啟動時指定要在應用程式中執行的迴圈。

在應用程式委派作業中,覆寫 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:).
  }
}

在測試中執行多個迴圈時,系統會將目前的迴圈當做參數傳遞至用於啟動應用程式的網址。您也可以剖析用於擷取自訂網址配置的 URLComponents 物件,藉此取得目前的迴圈編號:

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

步驟 3:建立並執行測試

註冊 Test Lab 的自訂網址配置後,您可以在 Firebase 控制台或搭配 gcloud beta CLI 執行測試。如果您尚未為應用程式產生 IPA 檔案,請先執行這項操作 (您稍後需要找出該檔案)。

Firebase 控制台中執行測試

  1. 如果您尚未建立專案,請開啟 Firebase 主控台並建立專案。

  2. Firebase 控制台的 Test Lab 頁面中,按一下「Run Your First Test」>「Run an iOS Game Loop」

  3. 在「Upload App」專區中,按一下「Browse」,然後選取應用程式的 IPA 檔案 (如果尚未產生,請為應用程式產生 IPA 檔案)。

  4. 選用:如要一次執行多個迴圈 (又稱為情境),或選取要執行的特定迴圈,請在「情境」欄位中輸入迴圈編號。

    舉例來說,如果您輸入「1-3, 5」,Test Lab 就會執行 1、2、3 和 5 個迴圈。根據預設 (如果您未在「情境」欄位中輸入任何內容),Test Lab 只會執行迴圈 1。

  5. 在「Devices」部分,選取一或多部要測試應用程式的實體裝置,然後按一下「Start Tests」

使用 gcloud Beta 版 CLI 執行測試

  1. 如果您尚未設定本機 gcloud SDK 環境,請務必安裝 gcloud beta 元件

  2. 執行 gcloud beta firebase test ios run 指令,並使用下列旗標設定執行作業:

遊戲迴圈測試旗標
--type

必要:指定要執行的 iOS 測試類型。您可以輸入測試類型 xctest (預設) 或 game-loop

--app

必要:應用程式 IPA 檔案的絕對路徑 (Google Cloud Storage 或檔案系統)。這個標記僅在執行遊戲迴圈測試時有效。

--scenario-numbers

您要在應用程式中執行的迴圈 (又稱情境)。您可以輸入一個迴圈、清單/迴圈,或是迴圈範圍。預設迴圈為 1。

例如,--scenario-numbers=1-3,5 會執行迴圈 1、2、3 和 5。

--device-model

您要執行測試的實體裝置 (瞭解您可以使用的可用裝置)。

--timeout

測試執行的時間上限。您可以輸入整數來表示時間長度 (以秒為單位),也可以輸入整數和列舉,以較長的時間單位表示時間長度。

例如:

  • --timeout=200 會在測試執行時間達到 200 秒時強制終止測試。
  • --timeout=1h 會在測試執行時間達一小時時強制終止測試。

舉例來說,下列指令會執行遊戲迴圈測試,在 iPhone 8 Plus 上執行 1、4、6、7 和 8 個迴圈:

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

如要進一步瞭解 gcloud CLI,請參閱參考說明文件

在本機執行測試

如要在本機執行測試,請在模擬器中載入遊戲應用程式,然後執行:

xcrun simctl openurl SIMULATOR_UDID firebase-game-loop://
  • 您可以執行 instruments -s devices 指令,找出模擬器的 UDID。

  • 如果只有一個模擬器在執行中,請輸入特殊字串 "booted" 取代 SIMULATOR_UDID

如果測試包含多個迴圈,您可以將迴圈編號傳遞至 scenario 標記,指定要執行哪個迴圈。請注意,在本機執行測試時,您一次只能執行一個迴圈。舉例來說,如果您想執行迴圈 1、2 和 5,就必須為每個迴圈執行不同的指令:

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

提早結束測試

根據預設,即使已執行所有迴圈,遊戲迴圈測試仍會持續執行,直到逾時時間達到五分鐘為止。達到逾時期限時,測試就會結束並取消任何待處理的迴圈。您可以在應用程式的 AppDelegate 中呼叫 Test Lab 的自訂網址配置 firebase-game-loop-complete,藉此加快測試速度或提早結束測試。例如:

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

遊戲迴圈測試會終止目前的迴圈,並執行下一個迴圈。當沒有要執行的迴圈時,測試就會結束。

寫入自訂測試結果

您可以設定遊戲迴圈測試,將自訂測試結果寫入裝置的檔案系統。這樣一來,當測試開始執行時,Test Lab 會將結果檔案儲存在測試裝置 (必須自行建立) 的 GameLoopsResults 目錄中。測試結束後,Test Lab 會將所有檔案從 GameLoopResults 目錄移至專案的儲存桶。設定測試時,請注意下列事項:

  • 無論檔案類型、大小或數量為何,系統都會上傳所有結果檔案。

  • Test Lab 會在測試中的所有迴圈都執行完畢後才處理測試結果,因此如果測試包含多個寫入輸出的迴圈,請務必將這些迴圈附加至不重複的結果檔案,或是為每個迴圈建立結果檔案。這樣一來,您就能避免覆寫先前迴圈的結果。

如要設定測試以寫入自訂測試結果,請按照下列步驟操作:

  1. 在應用程式的 Documents 目錄中,建立名為 GameLoopResults 的目錄。

  2. 在應用程式程式碼的任一處 (例如應用程式委派) 新增以下內容:

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