С помощью тестов Game Loop вы можете писать тесты, разработанные специально для вашего игрового движка, а затем запускать их в Test Lab на выбранных вами устройствах. Таким образом, вам не придётся беспокоиться о написании тестов для разных пользовательских интерфейсов или тестовых фреймворков. Тест Game Loop имитирует действия реального игрока, и при запуске в Test Lab он обеспечивает быстрый и масштабируемый способ проверки производительности вашей игры для пользователей.
На этой странице показано, как запустить тест Game Loop, а затем просматривать и управлять результатами теста на странице Test Lab консоли Firebase . Вы также можете дополнительно настроить тесты, используя дополнительные функции, такие как создание собственных результатов теста или досрочное завершение теста .
Что такое тест игрового цикла?
Цикл — это полное или частичное выполнение теста в вашем игровом приложении. Вы можете запустить тест игрового цикла локально на симуляторе или на наборе устройств в Test Lab . Тесты игрового цикла можно использовать для:
Проходите игру так, как это делает конечный пользователь. Вы можете либо запрограммировать действия пользователя, либо позволить ему бездействовать, либо заменить его искусственным интеллектом (например, если вы реализовали искусственный интеллект в гоночной игре, то можете поручить водителю-ИИ управлять действиями пользователя).
Запустите игру с максимальными настройками качества, чтобы узнать, какие устройства ее поддерживают.
Запустите технический тест, например, скомпилируйте несколько шейдеров, выполните их и проверьте, соответствует ли результат ожидаемому.
Шаг 1: Зарегистрируйте пользовательскую схему URL Test Lab
Во-первых, необходимо зарегистрировать пользовательскую схему URL Firebase Test Lab в своем приложении:
В Xcode выберите целевой проект.
Откройте вкладку «Информация» , затем добавьте новый тип URL .
В поле «Схемы 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
}
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:).
}
}
При запуске нескольких циклов в тесте текущий цикл передаётся в качестве параметра 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 . Если вы ещё этого не сделали, сгенерируйте IPA-файл для своего приложения (вам понадобится найти его позже).
Запустите тест в консоли Firebase
Если вы еще этого не сделали, откройте консоль Firebase и создайте проект.
На странице Test Lab консоли Firebase нажмите Run Your First Test > Run an iOS Game Loop .
В разделе «Загрузить приложение» нажмите «Обзор» , затем выберите файл IPA вашего приложения (если вы еще этого не сделали, создайте файл IPA для своего приложения).
Необязательно : если вы хотите запустить несколько циклов (т. н. сценариев) одновременно или выбрать определенные циклы для запуска, введите номера циклов в поле «Сценарии» .
Например, если ввести «1-3, 5», Test Lab запустит циклы 1, 2, 3 и 5. По умолчанию (если вы ничего не введете в поле «Сценарии ») Test Lab запустит только цикл 1.
В разделе «Устройства» выберите одно или несколько физических устройств, на которых вы хотите протестировать свое приложение, затем нажмите «Начать тесты» .
Запустите тест с помощью gcloud beta CLI
Если вы еще этого не сделали, настройте локальную среду gcloud SDK, а затем обязательно установите бета-компонент gcloud .
Запустите команду
gcloud beta firebase test ios runи используйте следующие флаги для настройки запуска:
| Флаги для тестов игрового цикла | |
|---|---|
--type | Обязательно : указывает тип теста iOS, который вы хотите запустить. Можно указать типы тестов |
--app | Обязательно : абсолютный путь ( Google Cloud Storage или файловой системе) к IPA-файлу вашего приложения. Этот флаг действителен только при запуске тестов игрового цикла. |
--scenario-numbers | Циклы (или сценарии), которые вы хотите запустить в приложении. Вы можете указать один цикл, список циклов или диапазон циклов. Цикл по умолчанию — 1. Например, |
--device-model | Физическое устройство, на котором вы хотите запустить тест (узнайте, какие доступные устройства вы можете использовать). |
--timeout | Максимальная продолжительность выполнения теста. Вы можете ввести целое число, чтобы обозначить продолжительность в секундах, или целое число и перечисление, чтобы обозначить продолжительность в более длительной единице времени. Например:
|
Например, следующая команда запускает тест игрового цикла, который выполняет циклы 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=1xcrun simctl openurl SIMULATOR_UDID firebase-game-loop://?scenario=2xcrun 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)
}
Objective-C
- (void)finishLoop {
UIApplication *app = [UIApplication sharedApplication];
[app openURL:[NSURL URLWithString:@"firebase-game-loop-complete://"]
options:@{}
completionHandler:^(BOOL success) {}];
}
Тест игрового цикла завершает текущий цикл и выполняет следующий. Когда циклов для выполнения больше нет, тест завершается.
Напишите пользовательские результаты теста
Вы можете настроить тест Game Loop для записи результатов в файловую систему вашего устройства. Таким образом, при запуске теста Test Lab сохранит файлы результатов в каталоге GameLoopsResults на вашем тестовом устройстве (который вам необходимо создать самостоятельно). По завершении теста Test Lab переместит все файлы из каталога GameLoopResults в контейнер вашего проекта. При настройке теста учитывайте следующее:
Все файлы результатов загружаются независимо от типа, размера или количества файлов.
Test Lab не обрабатывает результаты теста, пока все циклы в нём не завершатся. Поэтому, если ваш тест содержит несколько циклов, записывающих выходные данные, убедитесь, что вы добавляете их в отдельный файл результатов или создаете отдельный файл результатов для каждого цикла. Это позволит избежать перезаписи результатов предыдущего цикла.
Чтобы настроить тест для записи пользовательских результатов теста:
В каталоге
Documentsвашего приложения создайте каталог с именемGameLoopResults.В любом месте кода вашего приложения (например, в делегате приложения) добавьте следующее:
Быстрый
/// 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]; } }