Inizia con i test della strumentazione

Questa guida descrive come preparare ed eseguire un test di strumentazione utilizzando Firebase Test Lab. Per utilizzare questa guida, avrai bisogno di un test di strumentazione (scritto da te o dal tuo team) che utilizzi i framework di test Android Espresso o UI Automator . I test di strumentazione possono durare fino a 45 minuti su dispositivi fisici e fino a 60 minuti su dispositivi virtuali .

Nei passaggi successivi, caricherai l'APK della tua app e l'APK del tuo test su Firebase.

(Facoltativo) Aggiungi la libreria di screenshot alla tua app

Firebase Test Lab include una libreria (testlab-instr-lib) che puoi utilizzare per elaborare qualsiasi screenshot acquisito con ScreenCapture di AndroidX durante l'esecuzione di test di strumentazione, ad esempio test scritti utilizzando il framework di test Espresso . Questa sezione descrive come creare oggetti ScreenCapture con la libreria AndroidX e come elaborarli utilizzando testlab-instr-lib.

Dopo l'esecuzione del test della strumentazione, puoi visualizzare gli screenshot acquisiti nella console Firebase.

Prova un'app di esempio

Scarica l' app di esempio Blocco note per provare questa funzionalità. La possibilità di acquisire schermate è già incorporata nel progetto NotePad.

Passaggio 1. Aggiungi la libreria di screenshot al tuo progetto

  1. Nel file Gradle delle impostazioni a livello di root del tuo progetto di test ( settings.gradle.kts o settings.gradle ), aggiungi il repository Maven di Google a ogni sezione repositories :

    pluginManagement {
    repositories {
        // Add the following line:
        google() // Google's Maven repository
        mavenCentral()
        gradlePluginPortal()
    }
}
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        // Add the following line:
        google() // Google's Maven repository
        mavenCentral()
    }
}
// ...

  2. Nel file Gradle del tuo modulo (a livello di app) (di solito <project>/<app-module>/build.gradle.kts o <project>/<app-module>/build.gradle ), aggiungi una dipendenza per Test Lab libreria di schermate.

    dependencies {
  // ...
  // Add Test Lab's instrumentation test screenshot library:
  androidTestImplementation("com.google.firebase:testlab-instr-lib:0.2")
  // ...

  3. Nel file AndroidManifest.xml del test, registra FirebaseScreenCaptureProcessor in un tag di metadati all'interno dell'elemento <instrumentation> . Puoi anche specificare il processore come argomento in AndroidJUnitRunner (consulta la documentazione di riferimento di AndroidJUnitRunner per istruzioni su come).

    <instrumentation
  // Check that you have the following line (if not, add it):
  android:name="androidx.test.runner.AndroidJUnitRunner" // Specifies AndroidJUnitRunner as the test runner
  android:targetPackage="com.your.package.name">

// Add the following:
<meta-data
  android:name="screenCaptureProcessors"
  android:value="com.google.firebase.testlab.screenshot.FirebaseScreenCaptureProcessor" />
</instrumentation>
...

  4. Nel file AndroidManifest.xml della tua app, aggiungi le seguenti righe all'interno dell'elemento <manifest> :

     <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

  5. Nel file AndroidManifest.xml , specifica le autorizzazioni di sistema per la tua app aggiungendo le righe seguenti all'interno del tag <manifest> . Se esegui il test su Android 10 (livello API 29) o superiore , ometti l'autorizzazione WRITE_EXTERNAL_STORAGE (la tua app non richiede questa autorizzazione per leggere e scrivere schermate sul dispositivo).

    <manifest ... >
    <!-- WRITE_EXTERNAL_STORAGE is not needed on Android 10 (API level 29) or higher. -->
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
    <uses-permission android:name="android.permission.INTERNET"/>
    ...
</manifest>

Passaggio 2. Acquisisci schermate durante il test

In qualsiasi momento del test in cui desideri acquisire uno screenshot, chiama il metodo Screenshot.capture() dalla libreria AndroidX. Questo produce un oggetto ScreenCapture . Quando chiami process() sull'oggetto ScreenCapture , viene elaborato utilizzando ScreenCaptureProcessor registrato nel tuo AndroidManifest.xml . Si noti che BasicScreenCaptureProcessor viene utilizzato se non sono registrati processori. Poiché hai registrato FirebaseScreenCaptureProcessor , i tuoi screenshot verranno elaborati tramite FirebaseScreenCaptureProcessor e saranno disponibili per te con i tuoi risultati quando eseguirai il test con Firebase Test Lab.

Esempi di casi d'uso per la creazione di ScreenCapture :

  • Acquisisci una schermata completa su un'API Build.VERSION_CODES.JELLY_BEAN_MR2 e versioni successive:

    Screenshot.capture()

  • Acquisisci una ScreenCapture dell'attività a qualsiasi livello di API. Tieni presente che questa è l'unica opzione per i dispositivi inferiori a Build.VERSION_CODES.JELLY_BEAN_MR2.

    @Rule
  public ActivityTestRule<MainActivity> activityRule = new ActivityTestRule<>(MainActivity.class);
...
Screenshot.capture(activityRule.getActivity());
...

Esempi di casi d'uso per l'elaborazione di ScreenCapture

  • Elabora uno ScreenCapture tramite FirebaseScreenCaptureProcessor :

    Screenshot.capture().process();

  • Elabora uno ScreenCapture tramite uno ScreenCaptureProcessor specificato (questo consente di saltare la registrazione del processore):

    Set<ScreenCaptureProcessor> processors = new HashSet<>();
processors.add(new FirebaseScreenCaptureProcessor());
Screenshot.capture().process(processors);

  • Imposta il nome e il formato di ScreenCapture ed elaboralo utilizzando il processore registrato:

    Screenshot.capture().setName("myscreenshot").setFormat(CompressFormat.JPEG).process();

Passaggio 3. Crea ed esegui il test

  1. Crea la tua app e testa gli APK (vedi Testare la tua app per le istruzioni).

  2. Carica i file APK nella dashboard Test Lab della console Firebase.

  3. Infine, esegui il test.

Passaggio 4. Visualizza gli screenshot di prova

Al termine del test, puoi visualizzare tutti gli screenshot acquisiti nella console Firebase.

  1. Nella scheda Test , seleziona il test completato, quindi fai clic sulla scheda Risultati .

  2. Seleziona di nuovo il test, quindi fai clic sulla scheda Screenshot che viene visualizzata.

(Facoltativo) Abilita funzionalità di test aggiuntive

Puoi abilitare le seguenti funzionalità nel tuo test prima di eseguirlo con Test Lab:

Abilita orchestratore

Android Test Orchestrator è uno strumento che esegue ciascuno dei test di strumentazione della tua app in modo indipendente. Test Lab utilizza sempre l'ultima versione di Orchestrator.

Per abilitare Orchestrator per Test Lab, nella configurazione del test di strumentazione, fare clic su Opzioni aggiuntive > Esegui con Orchestrator .

Quando si utilizza Orchestrator, si beneficia di quanto segue:

  • Nessuno stato condiviso. Ogni test viene eseguito nella propria istanza di strumentazione, quindi uno stato condiviso non si accumula tra i test.
  • Crash isolati. Se un test si arresta in modo anomalo, solo quella strumentazione viene terminata e gli altri test nella tua suite possono ancora essere eseguiti.

Tieni presente che quando usi Orchestrator, ogni test esegue la propria istanza di strumentazione, il che significa che il processo dell'app viene riavviato dopo ogni test case. L'aumento dei tempi di esecuzione risultanti potrebbe influire sull'utilizzo della quota o sul tempo fatturato e potrebbe causare il superamento dei limiti di timeout dei dispositivi. Se riduci il tempo di avvio dell'app, questo sovraccarico si ridurrà.

Per impostare opzioni aggiuntive per Orchestrator, specificale tramite il campo environmentVariables . Ad esempio, per utilizzare clearPackageData , utilizza questa opzione in gcloud:

--environment-variables clearPackageData=true

Abilita il partizionamento orizzontale

Lo sharding dei test divide una serie di test in sottogruppi (shard) che vengono eseguiti separatamente in modo isolato. Test Lab esegue automaticamente ogni shard in parallelo utilizzando più dispositivi e completa l'intero set di test in meno tempo.

Ad esempio, se crei N shard, per ogni dispositivo selezionato, Test Lab avvia N dispositivi identici ed esegue un sottoinsieme dei test su ciascun dispositivo. Ciò significa che i test case partizionati possono comportare più esecuzioni di test per dispositivo. Tuttavia, i casi di test non frammentati comportano un'esecuzione di test per dispositivo. Per apprendere i concetti del laboratorio di test, consulta Concetti chiave .

Per abilitare lo sharding di prova nella console Firebase, procedi nel seguente modo:

  1. Nella configurazione del test della strumentazione, fare clic su Opzioni aggiuntive .

  2. Nella sezione Sharding , inserisci il numero di shard che desideri eseguire.

Fatturazione per i frammenti di test

Test Lab implementa i tuoi frammenti sfruttando il meccanismo di sharding integrato di AndroidJUnitRunner. Per evitare l'addebito per la creazione di shard vuoti (shard senza casi di test assegnati), il numero di shard creati deve essere inferiore al numero totale di casi di test. A seconda di quanto tempo impiega ogni test case per essere eseguito, in genere è una buona idea assegnare 2-10 test case per shard.

Per ulteriori informazioni sulla fatturazione, leggi Utilizzo, quote e fatturazione .