Può essere difficile automatizzare i test dei giochi quando le app di gioco sono basate su framework UI diversi. I test Ciclo di gioco ti consentono di integrare i test nativi con Test Lab ed eseguirli facilmente sui dispositivi che selezioni. Un test Ciclo di gioco esegue il test nell'app di gioco simulando le azioni di un giocatore reale. Questa guida mostra come eseguire un test Ciclo di gioco, quindi visualizzare e gestire i risultati dei test nella Firebase console.
Che cos'è un test Ciclo di gioco?
Poiché le app di gioco eseguono il rendering su 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 UI. Un test 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 la logica pre-scripted, le simulazioni AI o i controlli delle prestazioni direttamente all'interno del motore grafico.
Una volta avviato, Test Lab non interagisce ulteriormente con l'UI del gioco. Invece, Test Lab funge da trasporto e ambiente di test: avvia lo scenario specifico, monitora eventuali arresti anomali e timeout e raccoglie tutti i log dei risultati personalizzati al termine dell'esecuzione del ciclo da parte dell'app.
Differenze tra i cicli 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 UI, fare clic sui pulsanti e verificare lo stato dell'applicazione nella gerarchia di oggetti View Android dall'esterno dell'app.
- I test Ciclo di gioco delegano la logica di test all'app. L'app esegue il proprio ciclo di test o simulazione interno senza interazione UI esterna, mentre Test Lab attiva lo scenario e raccoglie l'output del test.
Esempi
Supponiamo che tu voglia verificare che il 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 visivamente più complesso e consentire a un giocatore AI o a uno script automatizzato di giocarci per due minuti.
Quando Test Lab attiva lo scenario 1, il gioco avvia la riproduzione 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 quindi il file di log e lo rende disponibile in Cloud
Storage e nella Firebase console.
Casi d'uso
A seconda del 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:
- Eseguire un livello del gioco nello stesso modo in cui lo farebbe un utente finale. Puoi scrivere lo script dell'input dell'utente, lasciare l'utente inattivo o sostituirlo con un'AI, se ha senso nel tuo gioco (ad esempio, se hai un'app di gioco di auto da corsa e hai già implementato un'AI, puoi mettere un pilota AI a capo dell'input dell'utente).
- Eseguire il gioco con l'impostazione di qualità più elevata per verificare se i dispositivi la supportano.
- Eseguire un test tecnico (compilare più shader, eseguirli, verificare 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 è consigliabile eseguire test Ciclo di gioco su dispositivi virtuali perché hanno frame rate grafici inferiori rispetto ai dispositivi fisici.
Prima di iniziare
Per implementare un test, devi prima configurare l'app per i test Ciclo di gioco.
Nel file manifest dell'app, aggiungi un nuovo filtro per intent all'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 gioco attivandolo con un intent specifico.
Nel codice (ti consigliamo di farlo 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, l'attività può controllare l'intent che la avvia. Se preferisci, puoi aggiungere questo codice anche in un secondo momento (ad es. dopo aver caricato inizialmente il motore di gioco).
Consigliato: alla fine del test, aggiungi:
Kotlin
yourActivity.finish()
Java
yourActivity.finish();
In questo modo, l'app viene chiusa al termine del test Ciclo di gioco. Il test si basa sul framework UI dell'app per avviare il ciclo successivo e la chiusura dell'app indica che il test è terminato.
Creare ed eseguire un test Ciclo di gioco
Dopo aver configurato l'app per i test Ciclo di gioco, puoi creare immediatamente un test ed eseguirlo nell'app di gioco. Puoi scegliere di eseguire un test in Test Lab utilizzando la Firebase console o l'interfaccia a riga di comando (CLI) gcloud, oppure su un dispositivo locale utilizzando Test Loop Manager.
Eseguire su un dispositivo locale
Test Lab Test Loop Manager di è un'app open source che ti aiuta a integrare i test Ciclo di gioco ed eseguirli sui tuoi dispositivi locali. Consente inoltre al team di controllo qualità di eseguire gli stessi cicli 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 dispositivo che possono essere eseguite con i cicli di gioco. Se non vedi la tua app di gioco, assicurati che il filtro per intent corrisponda a quello descritto nel primo passaggio della sezione Prima di iniziare.
- Seleziona l'app di gioco, quindi seleziona il numero di cicli che vuoi eseguire. Nota: in questo passaggio puoi scegliere di eseguire un sottoinsieme di cicli anziché un solo ciclo. Per ulteriori informazioni sull' esecuzione di più cicli contemporaneamente, consulta Funzionalità facoltative.
- Fai clic su Esegui test. Il test inizia immediatamente.
Eseguire in Test Lab
Puoi eseguire un test Ciclo di gioco in Test Lab utilizzando la Firebase console o la gcloud CLI. Prima di iniziare, se non l'hai già fatto, apri la Firebase console e crea un progetto.
Utilizzare la console Firebase
- Nella Firebase console, 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 vai al file
.apkdell'app. Nota: in questo passaggio puoi scegliere di eseguire un sottoinsieme di cicli anziché un solo ciclo. Per ulteriori informazioni sull' esecuzione di più cicli contemporaneamente, consulta Funzionalità facoltative. - Fai clic su Continua.
- Seleziona i dispositivi fisici da utilizzare per testare l'app.
- Fai clic su Avvia test.
Per ulteriori informazioni su come iniziare a utilizzare la console Firebase, consulta Iniziare a eseguire test con la console Firebase.
Utilizzare la riga di comando gcloud (CLI)
Se non l'hai già fatto, scarica e installa il 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 ulteriori informazioni su come iniziare a utilizzare gcloud CLI, consulta Iniziare a eseguire test dalla riga di comando gcloud.
Funzionalità facoltative
Test Lab offre diverse funzionalità facoltative che ti consentono di personalizzare ulteriormente i test, tra cui la possibilità di scrivere dati di output, il supporto per più cicli di gioco e le etichette per i cicli correlati.
Scrivere 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 utilizzando launchIntent.getData(). Il gioco può scrivere risultati dei test, metriche di rendimento e log (logFile) direttamente in questa posizione durante l'esecuzione del test.
Puoi scrivere qualsiasi contenuto arbitrario nel logFile, ad esempio testo normale, dati CSV, tempi di rendering dei frame o report diagnostici personalizzati. Non esistono 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 le 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++ dell'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 il logFile,
la strutturazione dell'output come JSON corrispondente allo schema riportato di seguito consente alla
Firebase console (https://console.firebase.google.com/project/_/testlab) di analizzare e visualizzare le metriche di riepilogo
per il test Ciclo di gioco.
Dettagli chiave su 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 né genera automaticamente questi punti dati per te.
- Aggiungere 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 quando scrivi il file dall'app, a condizione che i nomi dei campi non siano in conflitto con i campi dello schema comenameostart_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 Cloud Storage (
GCS) del progetto all'interno della directory degli artefatti di 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ù cicli di gioco
Potrebbe essere utile eseguire più cicli di gioco nell'app. Un ciclo è un'esecuzione completa dell'app di gioco dall'inizio alla fine. Ad esempio, se il gioco ha più livelli, potresti voler avere un ciclo di gioco per avviare ogni livello anziché un ciclo che li scorre tutti. In questo modo, se l'app si arresta in modo anomalo al livello 32, puoi avviare direttamente quel ciclo di gioco per riprodurre l'arresto anomalo e testare le correzioni dei bug.
Per consentire all'app di eseguire più cicli contemporaneamente:
Se esegui un test con Test Loop Manager:
Aggiungi la seguente riga al file 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 cicli consentiti per un singolo test). Tieni presente che i cicli sono indicizzati a partire da 1, non da 0.Nell'app Test Loop Manager viene visualizzata una schermata di selezione che ti consente di selezionare i cicli che vuoi eseguire. Se selezioni più cicli, ogni ciclo viene avviato in sequenza al termine del ciclo precedente.
Se esegui un test con la Firebase console, inserisci un elenco o un intervallo di numeri di ciclo nel campo Scenari.
Se esegui un test con gcloud CLI, specifica un elenco di numeri di ciclo utilizzando il flag
--scenario-numbers. Ad esempio,--scenario-numbers=1,3,5esegue i cicli 1, 3 e 5.Se scrivi in C++ e vuoi modificare il comportamento del ciclo, passa il seguente extra al 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 cicli di gioco
Quando etichetti i cicli di gioco con una o più etichette di scenario, tu e il tuo team di controllo qualità potete avviare facilmente un insieme di cicli di gioco correlati (ad es. "tutti i cicli di gioco di compatibilità") e testarli in una singola matrice. Puoi creare le tue etichette o utilizzare le etichette predefinite offerte da Test Lab:
com.google.test.loops.player_experience: per i cicli utilizzati per riprodurre l'esperienza di un utente reale durante il gioco. L'obiettivo dei test con questi cicli è trovare problemi che un utente reale riscontrerebbe durante il gioco.com.google.test.loops.gpu_compatibility: per i cicli utilizzati per testare i problemi relativi alla GPU. L'obiettivo dei test con questi cicli è eseguire codice GPU che potrebbe non essere eseguito correttamente in produzione, per esporre problemi con hardware e driver.com.google.test.loops.compatibility: per i cicli utilizzati per testare un'ampia gamma di problemi di compatibilità, inclusi problemi di I/O e OpenSSL.com.google.test.loops.performance: per i cicli utilizzati per testare il rendimento 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 cicli con la stessa etichetta:
Se esegui un test con Test Loop Manager:
Nel file 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 cicli sono indicizzati a partire da 1, non da 0. Ad esempio,android:value="1,3-5"applica LABEL_NAME ai cicli 1, 3, 4 e 5.Nell'app Test Loop Manager, inserisci una o più etichette nel campo Etichette.
Se esegui un test con la Firebase console, inserisci una o più etichette nel campo Etichette.
Se esegui un test con gcloud CLI, specifica una o più etichette di scenario utilizzando il
--scenario-labelsflag (ad es.--scenario-labels=performance,gpu).
Supporto per le licenze delle app
Test Lab supporta le app che utilizzano il servizio di gestione licenze delle app offerto da Google Play. Per controllare correttamente le licenze durante il test della tua app con Test Lab, devi pubblicare l'app nel canale di produzione nel Play Store. Per testare l'app nel canale alfa o beta utilizzando Test Lab, rimuovi il controllo delle licenze prima di caricare l'app in Test Lab.
Problemi noti
I test Ciclo di gioco in Test Lab presentano i seguenti problemi noti:
- Alcuni arresti anomali non supportano i backtrace. Ad esempio, alcune build di release potrebbero sopprimere l'output del processo
debuggerdutilizzandoprctl(PR_SET_DUMPABLE, 0). Per saperne di più, consultadebuggerd. - Il livello API 19 non è attualmente supportato a causa di errori di autorizzazione dei file.