Può essere difficile automatizzare i test dei giochi quando le app di gioco sono basate su framework UI diversi. I test Game Loop ti consentono di integrare i test nativi con Test Lab ed eseguirli facilmente sui dispositivi che selezioni. Un test del ciclo di gioco esegue il test tramite l'app di gioco simulando le azioni di un giocatore reale. Questa guida mostra come eseguire un test del ciclo di gioco, quindi visualizzare e gestire i risultati del test nella console Firebase.
Che cos'è un test del ciclo di gioco?
Poiché le app di gioco vengono visualizzate in diversi framework e motori UI, come Unity, Unreal o codice C++ OpenGL/Vulkan, gli strumenti di automazione standard non possono ispezionare o interagire con gli elementi della UI. Un test del ciclo di gioco ti consente di integrare i test del motore nativo con Test Lab avviando il gioco con un intent contenente un numero di scenario specifico. Questo numero di scenario richiede all'app di eseguire logica pre-scriptata, simulazioni di AI o controlli delle prestazioni direttamente nel motore grafico.
Una volta avviato, Test Lab non interagisce ulteriormente con la UI del gioco. Test Lab funge invece da ambiente e trasporto di test: avvia lo scenario specifico, monitora eventuali arresti anomali e timeout e raccoglie i log dei risultati personalizzati al termine dell'esecuzione del ciclo da parte dell'app.
Differenze tra i loop di gioco e i test di strumentazione
- I test di strumentazione (come Espresso o UI Automator) si basano su framework esterni per gestire le interazioni dell'interfaccia utente, fare clic sui pulsanti e verificare lo stato dell'applicazione nell'intera gerarchia di oggetti View di Android dall'esterno dell'app.
- I test del ciclo di gioco delegano la logica di test alla tua app. La tua app esegue il proprio ciclo di test interno o la propria simulazione senza interazione con la UI esterna, mentre Test Lab attiva lo scenario e raccoglie l'output del test.
Esempi
Supponiamo che tu voglia verificare che il tuo gioco mantenga almeno 60 frame al
secondo su vari dispositivi fisici. Puoi implementare lo scenario 1 all'interno del codice del gioco per caricare il livello più complesso dal punto di vista visivo e lasciare che un giocatore AI o uno script automatizzato lo completi in due minuti.
Quando lo scenario Test Lab attiva lo scenario 1, il gioco avvia la partita con l'AI, monitora i tempi di rendering dei frame e la memoria utilizzata, trasmette queste metriche a un file di log di output personalizzato (logFile) e chiama finish() al termine.
Test Lab acquisisce il file di log e lo rende disponibile in Cloud Storage e nella console Firebase.
Casi d'uso
A seconda del tuo motore grafico, puoi implementare test con uno o più cicli. Un ciclo è un'esecuzione completa o parziale del test sull'app di gioco. I cicli di gioco possono essere utilizzati per:
- Esegui un livello del gioco nello stesso modo in cui lo farebbe un utente finale. Puoi scrivere lo script dell'input dell'utente, lasciare che l'utente sia inattivo o sostituire l'utente con un'IA se ha senso nel tuo gioco (ad esempio, se hai un'app di giochi di auto da corsa e hai già implementato un'IA, puoi mettere un pilota di IA al posto dell'input dell'utente).
- Esegui il gioco con l'impostazione di qualità più alta per verificare se i dispositivi la supportano.
- Esegui un test tecnico (compila più shader, eseguili, verifica che l'output sia quello previsto e così via).
Puoi eseguire un test Ciclo di gioco su un singolo dispositivo di test, su un insieme di dispositivi di test o su Test Lab. Tuttavia, non consigliamo di eseguire test del ciclo di gioco su dispositivi virtuali perché hanno frequenze fotogrammi grafiche inferiori rispetto ai dispositivi fisici.
Prima di iniziare
Per implementare un test, devi prima configurare l'app per i test del ciclo di gioco.
Nel manifest dell'app, aggiungi un nuovo filtro per intent alla tua attività:
<activity android:name=".MyActivity"> <intent-filter> <action android:name="com.google.intent.action.TEST_LOOP"/> <category android:name="android.intent.category.DEFAULT"/> <data android:mimeType="application/javascript"/> </intent-filter> <intent-filter> ... (other intent filters here) </intent-filter> </activity>In questo modo, Test Lab può avviare il tuo gioco attivandolo con un intent specifico.
Nel codice (ti consigliamo di aggiungerlo all'interno della dichiarazione del metodo
onCreate), aggiungi quanto segue:Kotlin
val launchIntent = intent if (launchIntent.action == "com.google.intent.action.TEST_LOOP") { val scenario = launchIntent.getIntExtra("scenario", 0) // Code to handle your game loop here }
Java
Intent launchIntent = getIntent(); if(launchIntent.getAction().equals("com.google.intent.action.TEST_LOOP")) { int scenario = launchIntent.getIntExtra("scenario", 0); // Code to handle your game loop here }
In questo modo, la tua attività può controllare l'intent che la avvia. Puoi anche aggiungere questo codice in un secondo momento, se preferisci (ad es. dopo aver caricato inizialmente il motore di gioco).
Consigliato: al termine del test, aggiungi:
Kotlin
yourActivity.finish()
Java
yourActivity.finish();
L'app viene chiusa al termine del test del ciclo di gioco. Il test si basa sul framework UI della tua app per avviare il ciclo successivo e la chiusura dell'app indica che il test è terminato.
Crea ed esegui un test Ciclo di gioco
Dopo aver configurato l'app per i test Game Loop, puoi creare immediatamente un test ed eseguirlo nell'app di gioco. Puoi scegliere di eseguire un test in Test Lab utilizzando la console Firebase o l'interfaccia a riga di comando (CLI) gcloud oppure su un dispositivo locale utilizzando Test Loop Manager.
Esegui su un dispositivo locale
Test Loop Manager di Test Lab è un'app open source che ti aiuta a integrare i test ciclo di gioco ed eseguirli sui tuoi dispositivi locali. Consente inoltre al tuo team di controllo qualità di eseguire gli stessi loop di gioco sui propri dispositivi.
Per eseguire un test su un dispositivo locale utilizzando Test Loop Manager:
- Scarica Test Loop Manager
su uno smartphone o tablet e installalo eseguendo:
adb install testloopmanager.apk
- Sul dispositivo, apri l'app Test Loop Apps sullo smartphone o sul tablet. L'app mostra un elenco di app sul tuo dispositivo che possono essere eseguite con i cicli di gioco. Se non vedi la tua app di gioco qui, assicurati che il filtro per intent corrisponda a quello descritto nel primo passaggio della sezione Prima di iniziare.
- Seleziona l'app di gioco, poi seleziona il numero di loop che vuoi eseguire. Nota: in questo passaggio puoi scegliere di eseguire un sottoinsieme di loop anziché un solo loop. Per saperne di più sull'esecuzione di più loop contemporaneamente, consulta la sezione Funzionalità facoltative.
- Fai clic su Esegui test. Il test inizia immediatamente.
Corri in Test Lab
Puoi eseguire un test del ciclo di gioco in Test Lab utilizzando la console Firebase o gcloud CLI. Prima di iniziare, se non l'hai ancora fatto, apri la console Firebase e crea un progetto.
Utilizzare la console Firebase
- Nella console Firebase, fai clic su Test Lab nel riquadro a sinistra.
- Fai clic su Esegui il tuo primo test (o Esegui un test se il progetto ha già eseguito un test).
- Seleziona ciclo di gioco come tipo di test e poi fai clic su Continua.
- Fai clic su Sfoglia e poi cerca il file
.apkdella tua app. Nota: in questo passaggio puoi scegliere di eseguire un sottoinsieme di loop anziché un solo loop. Per saperne di più sull'esecuzione di più loop contemporaneamente, consulta Funzionalità opzionali. - Fai clic su Continua.
- Seleziona i dispositivi fisici da utilizzare per testare la tua app.
- Fai clic su Avvia test.
Per saperne di più su come iniziare a utilizzare la console Firebase, consulta Inizia a eseguire test con la console Firebase.
Utilizza la riga di comando (CLI) gcloud
Se non l'hai ancora fatto, scarica e installa Google Cloud SDK.
Accedi a gcloud CLI utilizzando il tuo Account Google:
gcloud auth loginImposta il progetto Firebase in gcloud, dove
PROJECT_IDè l'ID del tuo progetto Firebase:gcloud config set project PROJECT_ID
Esegui il tuo primo test:
gcloud firebase test android run \ --type=game-loop --app=<var>path-to-apk</var> \ --device model=herolte,version=23
Per saperne di più su come iniziare a utilizzare gcloud CLI, consulta Inizia a eseguire i test dalla riga di comando gcloud.
Funzionalità facoltative
Test Lab offre diverse funzionalità opzionali che ti consentono di personalizzare ulteriormente i test, tra cui la possibilità di scrivere dati di output, il supporto di più cicli di gioco e le etichette per i cicli correlati.
Scrivi i dati di output
Quando Test Lab avvia il gioco, specifica un URL che rimanda a un file di risultati locale sul dispositivo di test, accessibile tramite launchIntent.getData(). Durante l'esecuzione del test, il tuo gioco può scrivere direttamente in questa posizione i risultati del test, le metriche di rendimento e i log (logFile).
Puoi scrivere qualsiasi contenuto arbitrario in logFile, ad esempio testo normale,
dati CSV, tempi di rendering dei frame o report diagnostici personalizzati. Non sono previste restrizioni o requisiti di formattazione per i contenuti che scrivi. Il file viene acquisito al termine del test e caricato nel bucket Cloud Storage insieme agli altri artefatti di test.
Test Lab segue le best practice consolidate per la condivisione di un file tra app
descritte in Condividere un file.
Nel metodo onCreate() dell'attività, in cui si trova l'intent, puoi
recuperare e controllare il file di output dei dati eseguendo il seguente codice:
Kotlin
val launchIntent = intent val logFile = launchIntent.data logFile?.let { Log.i(TAG, "Log file ${it.encodedPath}") // ... }
Java
Intent launchIntent = getIntent(); Uri logFile = launchIntent.getData(); if (logFile != null) { Log.i(TAG, "Log file " + logFile.getEncodedPath()); // ... }
Se vuoi scrivere nel file dal lato C++ della tua app di gioco, puoi passare il descrittore del file anziché il percorso del file:
Kotlin
val launchIntent = intent val logFile = launchIntent.data var fd = -1 logFile?.let { Log.i(TAG, "Log file ${it.encodedPath}") fd = try { contentResolver .openAssetFileDescriptor(logFile, "w")!! .parcelFileDescriptor .fd } catch (e: FileNotFoundException) { e.printStackTrace() -1 } catch (e: NullPointerException) { e.printStackTrace() -1 } } // C++ code invoked here. // native_function(fd);
Java
Intent launchIntent = getIntent(); Uri logFile = launchIntent.getData(); int fd = -1; if (logFile != null) { Log.i(TAG, "Log file " + logFile.getEncodedPath()); try { fd = getContentResolver() .openAssetFileDescriptor(logFile, "w") .getParcelFileDescriptor() .getFd(); } catch (FileNotFoundException e) { e.printStackTrace(); fd = -1; } catch (NullPointerException e) { e.printStackTrace(); fd = -1; } } // C++ code invoked here. // native_function(fd);
C++
#include <unistd.h> JNIEXPORT void JNICALL Java_my_package_name_MyActivity_native_function(JNIEnv *env, jclass type, jint log_file_descriptor) { // The file descriptor needs to be duplicated. int my_file_descriptor = dup(log_file_descriptor); }
Esempio di file di output
Sebbene Test Lab non richieda un formato specifico per logFile,
la strutturazione dell'output come JSON corrispondente allo schema riportato di seguito consente alla
console Firebase (https://console.firebase.google.com/project/_/testlab) di analizzare e visualizzare le metriche
di riepilogo per il test del ciclo di gioco.
Dettagli chiave di questo esempio:
- Chi fornisce i dati:tu (lo sviluppatore del test) sei responsabile del calcolo e della scrittura di tutte le metriche in questo file dal codice del gioco. Test Lab non raccoglie o genera automaticamente questi punti dati per te.
- Aggiunta di campi personalizzati:le aree contrassegnate come
/.../indicano dove puoi aggiungere coppie chiave-valore personalizzate arbitrarie (ad esempio"rendered_vertices": 12000o"ai_error_count": 0). Puoi aggiungere qualsiasi proprietà JSON valida all'output durante la scrittura del file dall'app, a condizione che i nomi dei campi non siano in conflitto con i campi dello schema, ad esempionameostart_timestamp. - Dove trovare il file di output:al termine del test, il file di output non elaborato
viene archiviato e può essere scaricato nel bucket dei risultati di Cloud Storage (
GCS) del tuo progetto all'interno della directory degli artefatti dell'esecuzione del test. Puoi anche visualizzare e ispezionare l'output analizzato nella pagina Test Lab della console Firebase.
Di seguito è riportato un esempio di file di output JSON strutturato:
{
"name": "test name",
"start_timestamp": 0, // Timestamp of the test start (in us).
Can be absolute or relative
"driver_info": "...",
"frame_stats": [
{
"timestamp": 1200000, // Timestamp at which this section was written
It contains value regarding the period
start_timestamp(0) -> this timestamp (1200000 us)
"avg_frame_time": 15320, // Average time to render a frame in ns
"nb_swap": 52, // Number of frame rendered
"threads": [
{
"name": "physics",
"Avg_time": 8030 // Average time spent in this thread per frame in us
},
{
"name": "AI",
"Avg_time": 2030 // Average time spent in this thread per frame in us
}
],
/.../ // Any custom field you want (vertices display on the screen, nb units …)
},
{
// Next frame data here, same format as above
}
],
"loading_stats": [
{
"name": "assets_level_1",
"total_time": 7850, // in us
/.../
},
{
"name": "victory_screen",
"total_time": 554, // in us
/.../
}
],
/.../, // You can add custom fields here
}
Più loop di gioco
Potresti trovare utile eseguire più cicli di gioco nella tua app. Un ciclo è un'esecuzione completa dell'app di gioco dall'inizio alla fine. Ad esempio, se il tuo gioco ha più livelli, potresti voler avere un ciclo di gioco per avviare ogni livello anziché un ciclo che li scorra tutti. In questo modo, se l'app si arresta in modo anomalo al livello 32, puoi avviare direttamente il ciclo di gioco per riprodurre l'arresto anomalo e testare le correzioni dei bug.
Per consentire all'app di eseguire più loop contemporaneamente:
Se esegui un test con Test Loop Manager:
Aggiungi la seguente riga al manifest dell'app, all'interno dell'elemento
<application>:<meta-data android:name="com.google.test.loops" android:value="5" />
Questo intent di avvio contiene il ciclo di destinazione come parametro intero. Nel campo
android:value, puoi specificare un numero intero da 1 a 1024 (il numero massimo di loop consentiti per un singolo test). Nota che i loop sono indicizzati a partire da 1, non da 0.Nell'app Test Loop Manager viene visualizzata una schermata di selezione che ti consente di scegliere i loop da eseguire. Se selezioni più loop, ogni loop viene avviato in sequenza dopo il completamento del loop precedente.
Se esegui un test con la console Firebase, inserisci un elenco o un intervallo di numeri di loop nel campo Scenari.
Se esegui un test con gcloud CLI, specifica un elenco di numeri di loop utilizzando il flag
--scenario-numbers. Ad esempio,--scenario-numbers=1,3,5esegue i loop 1, 3 e 5.Se stai scrivendo in C++ e vuoi modificare il comportamento del ciclo, passa il seguente extra al tuo codice C++ nativo:
Kotlin
val launchIntent = intent val scenario = launchIntent.getIntExtra("scenario", 0)
Java
Intent launchIntent = getIntent(); int scenario = launchIntent.getIntExtra("scenario", 0);
Ora puoi modificare il comportamento del ciclo in base al valore
intrisultante.
Etichettare i game loop
Quando etichetti i game loop con una o più etichette di scenario, tu e il tuo team di controllo qualità potete avviare facilmente un insieme di game loop correlati (ad es. "tutti i game loop di compatibilità") e testarli in una singola matrice. Puoi creare le tue etichette o utilizzare quelle predefinite offerte da Test Lab:
com.google.test.loops.player_experience: Per i loop utilizzati per riprodurre l'esperienza di un utente reale durante il gioco. Lo scopo dei test con questi loop è trovare problemi che un utente reale potrebbe riscontrare durante il gioco.com.google.test.loops.gpu_compatibility: Cicli for utilizzati per testare problemi relativi alla GPU. Lo scopo dei test con questi loop è eseguire codice GPU che potrebbe non essere eseguito correttamente in produzione, per esporre problemi con hardware e driver.com.google.test.loops.compatibility: cicli for utilizzati per testare un'ampia gamma di problemi di compatibilità, inclusi problemi di I/O e OpenSSL.com.google.test.loops.performance: Cicli for utilizzati per testare le prestazioni del dispositivo. Ad esempio, un gioco potrebbe essere eseguito con le impostazioni grafiche più complesse per vedere come si comporta un nuovo dispositivo.
Per consentire all'app di eseguire loop con la stessa etichetta:
Se esegui un test con Test Loop Manager:
Nel manifest dell'app, aggiungi la seguente riga di metadati e sostituisci LABEL_NAME con un'etichetta a tua scelta:
<meta-data android:name="com.google.test.loops.LABEL_NAME" android:value="1,3-5" />
Nel campo
android:value, puoi specificare un intervallo o un insieme di numeri interi da 1 a 1024 (il numero massimo di cicli consentiti per un singolo test) che rappresentano i cicli che vuoi etichettare. Tieni presente che i loop sono indicizzati a partire da 1, non da 0. Ad esempio,android:value="1,3-5"applica LABEL_NAME ai loop 1, 3, 4 e 5.Nell'app Test Loop Manager, inserisci una o più etichette nel campo Etichette.
Se esegui un test con la console Firebase, inserisci una o più etichette nel campo Etichette.
Se esegui un test con gcloud CLI, specifica una o più etichette di scenario utilizzando il flag
--scenario-labels(ad es.--scenario-labels=performance,gpu).
Assistenza per le licenze delle app
Test Lab supporta le app che utilizzano il servizio Licenze app offerto da Google Play. Per verificare correttamente la licenza durante il test dell'app con Test Lab, devi pubblicare l'app nel canale di produzione nel Play Store. Per testare la tua app nel canale alpha o beta utilizzando Test Lab, rimuovi il controllo della licenza prima di caricare l'app su Test Lab.
Problemi noti
I test Ciclo di gioco in Test Lab presentano i seguenti problemi noti:
- Alcuni arresti anomali non supportano le backtrace. Ad esempio, alcune build di rilascio potrebbero
eliminare l'output del processo
debuggerdutilizzandoprctl(PR_SET_DUMPABLE, 0). Per saperne di più, vedidebuggerd. - Il livello API 19 non è attualmente supportato a causa di errori di autorizzazione dei file.