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

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

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

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

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

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

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

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

Шаг 1: Зарегистрируйте пользовательскую схему URL Test Lab

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

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

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

  3. В поле URL Schemes введите 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
}

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

При запуске нескольких циклов в тесте текущий цикл передается в качестве параметра 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).
}

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

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

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

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

  2. На странице Test Lab консоли Firebase нажмите Run Your First Test > Run an iOS Game Loop .

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

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

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

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

Запустите тест с помощью gcloud beta CLI

  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 принудительно завершает тест по истечении часа.

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

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

Проведите тест локально

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

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

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

По умолчанию тест Game Loop продолжает работать до тех пор, пока не достигнет тайм-аута в пять минут, даже если все циклы выполнены. Когда тайм-аут достигнут, тест завершается и отменяет все ожидающие циклы. Вы можете ускорить свой тест или завершить его раньше, вызвав пользовательскую схему 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)
}

Objective-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 в контейнер вашего проекта. При настройке теста помните следующее:

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

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

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

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

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