游戏循环测试使用入门 (iOS)

借助游戏循环测试，您可以编写游戏引擎的原生测试，然后在所选设备上的 Test Lab 中运行这些测试。这样，您就无需费心为不同的界面或测试框架编写代码。游戏循环测试会模拟真实玩家的操作，当您在 Test Lab 中运行游戏循环测试时，它能提供一种快速且可扩缩的方式来验证该游戏能否给用户带来性能良好的体验。

本页面将向您介绍如何运行游戏循环测试，以及如何在 Firebase 控制台的“Test Lab”页面中查看和管理测试结果。您还可以使用可选功能（例如写入自定义测试结果或提前结束测试）进一步自定义测试。

什么是游戏循环测试？

一个循环是针对您的游戏应用运行的一轮完整或部分测试。您可以在模拟器本地运行游戏循环测试，也可以在 Test Lab 中的一组设备上运行游戏循环测试。游戏循环测试可用于如下目的：

  • 以最终用户玩游戏的方式运行游戏。您可以通过脚本来模拟用户输入、让用户挂机，或者用 AI 来代替用户（例如，假设您已在一款赛车游戏中实现了 AI，那么就可以轻松设置一个 AI 驾驶员作为用户的输入）。

  • 以最高画质设置运行游戏，看看哪些设备能支持这种设置。

  • 运行技术测试，例如编译多个着色器并加以执行，检查输出结果是否符合预期。

第 1 步：注册 Test Lab 的自定义网址架构

首先，您必须在应用中注册 Firebase Test Lab 的自定义网址架构：

  1. 在 Xcode 中选择一个项目目标。

  2. 点击 Info（信息）标签页，然后添加新的 URL type（网址类型）。

  3. 在 URL Schemes（网址方案）字段中，输入 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 步（可选）：将您的应用配置为运行多个循环

如果您的应用注册了多个自定义网址方案，并且您打算在测试中运行多个循环（也就是场景），则必须在启动时指定要在应用中运行哪些循环。

在您的应用委托 (app delegate) 中，用以下代码替换 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”页面上，点击运行首个测试 > 运行 iOS 游戏循环。

  3. 在上传应用部分中，点击浏览，然后选择应用的 IPA 文件（如果尚未为您的应用生成 IPA 文件，请先生成）。

  4. 可选：如果要同时运行多个循环（也就是场景）或要选择运行特定循环，请在场景字段中输入循环编号。

    例如，当您输入“1-3, 5”时，Test Lab 会运行循环 1、2、3 和 5。默认情况下（如果您未在场景字段中输入任何内容），Test Lab 仅运行循环 1。

  5. 在设备部分，选择您要在其上测试应用的一个或多个实体设备，然后点击开始测试。

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

提前结束测试

默认情况下，即便所有循环都已执行完毕，在达到 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];
    }
}