Начало работы с тестами Game Loop для iOS

С помощью тестов Game Loop вы можете писать тесты, встроенные в ваш игровой движок, а затем запускать их в Test Lab на выбранных вами устройствах. Таким образом, вам не нужно беспокоиться о написании для разных UI или платформ тестирования. Тест Game Loop имитирует действия реального игрока, и когда вы запускаете его в Test Lab, он обеспечивает быстрый и масштабируемый способ убедиться, что ваша игра работает хорошо для ваших пользователей.

На этой странице показано, как запустить тест Game Loop, а затем просматривать результаты теста и управлять ими на странице Test Lab консоли Firebase. Вы также можете дополнительно настроить свои тесты с помощью дополнительных функций, таких как запись пользовательских результатов теста или досрочное завершение теста .

Что такое тест игрового цикла?

Цикл – это полный или частичный запуск теста игрового приложения. Вы можете запустить тест Game Loop локально на симуляторе или на наборе устройств в Test Lab. Тесты игрового цикла можно использовать для:

  • Проходите игру так, как в нее играл бы конечный пользователь. Вы можете либо запрограммировать ввод пользователя, либо позволить пользователю бездействовать, либо заменить пользователя ИИ (например, если вы реализовали ИИ в автогоночной игре, вы можете поручить ИИ-драйверу отвечать за ввод пользователя). .

  • Запустите игру с настройками самого высокого качества, чтобы узнать, какие устройства ее поддерживают.

  • Запустите технический тест, например скомпилируйте несколько шейдеров, запустите их и проверьте, что выходные данные соответствуют ожиданиям.

Шаг 1. Зарегистрируйте собственную схему URL-адресов Test Lab.

Сначала вы должны зарегистрировать собственную схему URL-адресов Firebase Test Lab в своем приложении:

  1. В Xcode выберите цель проекта.

  2. Откройте вкладку «Информация» , затем добавьте новый тип URL-адреса .

  3. В поле «Схемы URL-адресов» введите firebase-game-loop . Вы также можете зарегистрировать собственную схему URL-адресов, добавив ее в файл конфигурации 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 (необязательно). Настройте приложение для запуска нескольких циклов.

Если в вашем приложении зарегистрировано несколько пользовательских схем URL-адресов и вы планируете запускать несколько циклов (т. е. сценариев) в тесте, вы должны указать, какие циклы вы хотите запускать в своем приложении во время запуска.

В делегате вашего приложения переопределите метод application(_:open:options:) :

Быстрый

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
}

Цель-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:).
  }
}

Когда вы запускаете несколько циклов в тесте, текущий цикл передается в качестве параметра URL-адресу, используемому для запуска приложения. Вы также можете получить текущий номер цикла, проанализировав объект URLComponents , используемый для получения пользовательской схемы URL-адресов:

Быстрый

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

Цель-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. Создайте и запустите тест

После регистрации пользовательской схемы URL-адресов Test Lab вы можете запустить тест в консоли Firebase или с помощью бета-версии CLI gcloud . Если вы еще этого не сделали, создайте файл IPA для своего приложения (вам нужно будет найти его позже).

Запустите тест в консоли Firebase

  1. Если вы еще этого не сделали, откройте консоль Firebase и создайте проект.

  2. На странице «Тестовая лаборатория» консоли Firebase нажмите «Запустить первый тест» > «Запустить игровой цикл iOS» .

  3. В разделе «Загрузить приложение» нажмите «Обзор» , затем выберите IPA-файл вашего приложения (если вы еще этого не сделали, создайте IPA-файл для вашего приложения).

  4. Необязательно : если вы хотите запустить несколько циклов (т. е. сценариев) одновременно или выбрать для запуска определенные циклы, введите номера циклов в поле «Сценарии» .

    Например, когда вы вводите «1-3, 5», Test Lab запускает циклы 1, 2, 3 и 5. По умолчанию (если вы ничего не вводите в поле «Сценарии» ) Test Lab запускает только цикл 1.

  5. В разделе «Устройства» выберите одно или несколько физических устройств, на которых вы хотите протестировать свое приложение, затем нажмите «Начать тесты» .

Запустите тест с помощью бета-версии CLI gcloud.

  1. Если вы еще этого не сделали, настройте локальную среду gcloud SDK, а затем обязательно установите бета-компонент gcloud .

  2. Запустите команду gcloud beta firebase test ios run и используйте следующие флаги для настройки запуска:

Флаги для тестов игрового цикла
--type

Обязательно : указывает тип теста iOS, который вы хотите запустить. Вы можете ввести типы тестов xctest (по умолчанию) или game-loop .

--app

Обязательно : абсолютный путь (Google Cloud Storage или файловая система) к файлу IPA вашего приложения. Этот флаг действителен только при запуске тестов Game Loop.

--scenario-numbers

Циклы (так называемые сценарии), которые вы хотите запустить в своем приложении. Вы можете ввести один цикл, список или циклы или диапазон циклов. Цикл по умолчанию равен 1.

Например, --scenario-numbers=1-3,5 запускает циклы 1, 2, 3 и 5.

--device-model

Физическое устройство, на котором вы хотите провести тест (узнайте, какие доступные устройства вы можете использовать).

--timeout

Максимальная продолжительность выполнения теста. Вы можете ввести целое число, чтобы представить длительность в секундах, или целое число и перечисление, чтобы представить длительность как более длительную единицу времени.

Например:

  • --timeout=200 заставляет ваш тест завершиться, когда он продлится до 200 секунд.
  • --timeout=1h заставляет ваш тест завершиться, когда он продлится до часа.

Например, следующая команда запускает тест Game Loop, который выполняет циклы 1, 4, 6, 7 и 8 на 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

Дополнительную информацию о CLI gcloud смотрите в справочной документации .

Запустите тест локально

Чтобы запустить тест локально, загрузите игровое приложение в симуляторе и запустите:

xcrun simctl openurl SIMULATOR_UDID firebase-game-loop://
  • Вы можете узнать UDID вашего симулятора, выполнив команду instruments -s devices .

  • Если запущен только один симулятор, введите специальную строку "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

Завершить тест раньше времени

По умолчанию тест игрового цикла продолжает выполняться до тех пор, пока не истечет время ожидания в пять минут, даже если все циклы выполнены. По истечении времени ожидания тест завершается и все ожидающие циклы отменяются. Вы можете ускорить тестирование или завершить его раньше, вызвав собственную схему URL-адресов Test Lab firebase-game-loop-complete в AppDelegate вашего приложения. Например:

Быстрый

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

Цель-C

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

Тест Game Loop завершает текущий цикл и выполняет следующий цикл. Когда циклов для выполнения больше не остается, тест завершается.

Напишите результаты пользовательского теста

Вы можете настроить тест Game Loop для записи результатов пользовательского теста в файловую систему вашего устройства. Таким образом, когда тест запускается, Test Lab сохраняет файлы результатов в каталоге GameLoopsResults на вашем тестовом устройстве (который вы должны создать самостоятельно). По завершении теста Test Lab перемещает все файлы из каталога GameLoopResults в корзину вашего проекта. При настройке теста помните следующее:

  • Все файлы результатов загружаются независимо от типа, размера или количества файлов.

  • Лаборатория тестирования не обрабатывает результаты теста до тех пор, пока не завершится выполнение всех циклов теста, поэтому, если ваш тест включает в себя несколько циклов, записывающих выходные данные, обязательно добавьте их в уникальный файл результатов или создайте файл результатов для каждого цикла. Таким образом, вы можете избежать перезаписи результатов предыдущего цикла.

Чтобы настроить тест для записи пользовательских результатов теста:

  1. В каталоге Documents вашего приложения создайте каталог с именем GameLoopResults .

  2. В любом месте кода вашего приложения (например, в делегате приложения) добавьте следующее:

    Быстрый

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

    Цель-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];
        }
    }