Test dalla riga di comando

Questo documento descrive come eseguire i test direttamente dalla riga di comando. Questo documento presuppone che tu sappia già come creare un'app per Android e scrivere test per la tua app. Per ulteriori informazioni su come creare test per la tua app, consulta Testare le app su Android.

Gli strumenti a riga di comando e le attività Gradle descritti in questa pagina sono indipendenti dal toolkit UI. Se vuoi scrivere test UI per Compose, consulta Testare il layout di Compose. Dopo aver scritto i test, continua con questa guida per eseguirli dal terminale o dall'ambiente di integrazione continua remoto.

Quando crei la tua app utilizzando il sistema di compilazione Gradle, il plug-in Android Gradle ti consente di eseguire i test dal tuo progetto Gradle utilizzando la riga di comando. Per un controllo più granulare, puoi scegliere di eseguire i test tramite una shell Android Debug Bridge (adb). Questa opzione può essere utile quando si eseguono test in un ambiente di integrazione continua.

Per scoprire come eseguire test strumentati automatici dalla riga di comando utilizzando dispositivi virtuali gestiti da Gradle, consulta Scalare i test con i dispositivi gestiti da Gradle.

Eseguire test con Gradle

Il plug-in Android per Gradle ti consente di eseguire test dal tuo progetto Gradle utilizzando la riga di comando.

La tabella seguente riassume come eseguire i test con Gradle:

Tabella 1. Diversi modi per eseguire i test con Gradle

Tipo di test delle unità Comando da eseguire Posizione del risultato del test
Test delle unità locale Esegui l'attività test: 

./gradlew test
File dei risultati del test HTML:
directory path_to_your_project/module_name/build/reports/tests/.

File dei risultati del test XML:
path_to_your_project/module_name/build/test-results/ directory.

Test delle unità strumentato Esegui l'attività connectedAndroidTest: 

./gradlew connectedAndroidTest
File dei risultati del test HTML:
directory path_to_your_project/module_name/build/reports/androidTests/connected/.

File dei risultati del test XML:
path_to_your_project/module_name/build/outputs/androidTest-results/connected/ directory.

Gradle supporta le abbreviazioni dei nomi delle attività. Ad esempio, puoi avviare l'attività connectedAndroidTest inserendo questo comando:

./gradlew cAT

Puoi anche scegliere di eseguire le attività Gradle check e connectedCheck. Questi task eseguono rispettivamente i test locali o strumentati, ma includono altri controlli aggiunti da altri plug-in Gradle.

Esegui test su un modulo

Le attività test e connectedAndroidTest eseguono test su ogni modulo del tuo progetto. Puoi eseguire test su un modulo specifico anteponendo il nome del modulo e i due punti (:) all'attività test o connectedAndroidTest. Ad esempio, il seguente comando esegue test strumentati solo per il modulo mylibrary:

./gradlew mylibrary:connectedAndroidTest

Eseguire test su una variante di compilazione

Le attività test e connectedAndroidTest eseguono test su ogni variante di build nel tuo progetto. Puoi scegliere come target una variante di compilazione specifica utilizzando la seguente sintassi:

  • Per i test delle unità locali: 
    ./gradlew testVariantNameUnitTest
  • Per i test strumentati: 
    ./gradlew connectedVariantNameAndroidTest

Eseguire metodi o classi di test specifici

Quando esegui test delle unità locali, Gradle ti consente di scegliere come target test specifici utilizzando il flag --tests. Ad esempio, il seguente comando esegue solo i test sampleTestMethod per la variante di compilazione specificata. Per scoprire di più sull'utilizzo del flag --tests, leggi la documentazione di Gradle sul filtraggio dei test.


./gradlew testVariantNameUnitTest --tests '*.sampleTestMethod'

Eseguire test con adb

Quando esegui i test dalla riga di comando con Android Debug Bridge (adb), hai più opzioni per scegliere i test da eseguire rispetto a qualsiasi altro metodo. Puoi selezionare singoli metodi di test, filtrare i test in base a un'annotazione personalizzata o specificare le opzioni di test. Poiché l'esecuzione del test è controllata interamente dalla riga di comando, puoi personalizzare il test con script shell in vari modi.

Per eseguire un test dalla riga di comando, esegui adb shell per avviare una shell della riga di comando sul dispositivo o sull'emulatore. All'interno di questa shell puoi interagire con Activity Manager utilizzando il comando am e il relativo sottocomando instrument per eseguire i test.

Come scorciatoia, puoi avviare una shell adb, chiamare am instrument e specificare i flag della riga di comando in un'unica riga di input. La shell si apre sul dispositivo o sull'emulatore, esegue i test, produce l'output e poi torna alla riga di comando sul computer.

Per eseguire un test con am instrument:

  1. Crea o ricrea l'applicazione principale e il pacchetto di test.
  2. Installa il pacchetto di test e i file del pacchetto Android (APK) dell'applicazione principale sul tuo attuale dispositivo o emulatore Android.

  3. Nella riga di comando, inserisci:

    adb shell am instrument -w <test_package_name>/<runner_class>

    dove <test_package_name> è il nome del pacchetto Android dell'applicazione di test e <runner_class> è il nome della classe di esecuzione dei test Android che stai utilizzando. Il nome del pacchetto Android è il valore dell'attributo package dell'elemento manifest nel file manifest del pacchetto di test (AndroidManifest.xml).

    La classe Android Test Runner è in genere AndroidJUnitRunner:

    adb shell am instrument -w com.android.example/androidx.test.runner.AndroidJUnitRunner

I risultati del test vengono visualizzati in STDOUT.

am instrument flags

Per trovare un elenco di tutti i flag da utilizzare con il comando am instrument, esegui adb shell am help. Alcuni flag importanti sono descritti nella tabella seguente:

Tabella 2. Flag am instrument importanti

Flag Valore Descrizione
-w (nessuno) Forza am instrument ad attendere il termine dell'instrumentazione prima di terminare. In questo modo la shell rimane aperta fino al termine dei test. Questo flag è necessario per visualizzare i risultati dei test.
-r (nessuno) Restituisce i risultati in formato non elaborato. Utilizza questo flag quando vuoi raccogliere misurazioni del rendimento in modo che non vengano formattate come risultati del test. Questo flag è progettato per essere utilizzato con il flag -e perf true (documentato nella sezione Opzioni dello strumento am).
-e <test_options> Fornisce opzioni di test come coppie chiave-valore. Lo strumento am instrument li passa alla classe di strumentazione specificata utilizzando il metodo onCreate(). Puoi specificare più occorrenze di -e <test_options>. Le chiavi e i valori sono descritti nella sezione Opzioni dello strumento am. Puoi utilizzare queste coppie chiave-valore solo con AndroidJUnitRunner. L'utilizzo con altre classi non ha effetto.
--no-hidden-api-checks (nessuno) Disattiva le limitazioni all'utilizzo delle API nascoste. Per maggiori informazioni su cosa sono le API nascoste e su come possono influire sulla tua app, leggi Limitazioni relative alle interfacce non SDK.

am instrument options

Lo strumento am instrument passa le opzioni di test a AndroidJUnitRunner o InstrumentationTestRunner sotto forma di coppie chiave-valore, utilizzando il flag -e, con questa sintassi:

-e <key> <value>

Alcune chiavi accettano più valori. Specifichi più valori in un elenco separato da virgole. Ad esempio, questa chiamata di AndroidJUnitRunner fornisce più valori per la chiave package:

adb shell am instrument -w -e package com.android.test.package1,com.android.test.package2 \
> com.android.test/androidx.test.runner.AndroidJUnitRunner

La seguente tabella elenca le coppie chiave-valore che puoi utilizzare con il test runner:

Tabella 3. -e flag key-value pairs to use with your test runner

Chiave Valore Descrizione
package <Java_package_name> Il nome completo del pacchetto Java per uno dei pacchetti nell'applicazione di test. Viene eseguita qualsiasi classe di scenario di test che utilizza questo nome del pacchetto. Tieni presente che non si tratta di un nome di pacchetto Android; un pacchetto di test ha un solo nome di pacchetto Android, ma può contenere diversi pacchetti Java.
class <class_name> Il nome completo della classe Java per una delle classi di casi di test. Viene eseguita solo questa classe di scenari di test.
<class_name>#method name Un nome di classe di test case completo e uno dei relativi metodi. Viene eseguito solo questo metodo. Prendi nota del simbolo cancelletto (#) tra il nome della classe e il nome del metodo.
size [small | medium | large] Esegue un metodo di test annotato in base alle dimensioni. Le annotazioni sono @SmallTest, @MediumTest e @LargeTest.
debug true Esegue i test in modalità di debug.
log true Carica e registra tutti i test specificati, ma non li esegue. Le informazioni del test vengono visualizzate in STDOUT. Utilizza questo valore per verificare combinazioni di altri filtri e specifiche di test.
emma true Esegue un'analisi della copertura del codice EMMA e scrive l'output in /data/<app_package>/coverage.ec sul dispositivo. Per ignorare la posizione del file, utilizza la chiave coverageFile descritta nella voce seguente.

Nota:questa opzione richiede una build strumentata con EMMA dell'applicazione di test, che puoi generare con il target coverage.

coverageFile <filename> Esegue l'override della posizione predefinita del file di copertura EMMA sul dispositivo. Specifica questo valore come percorso e nome file in formato UNIX. Il nome file predefinito è descritto nella voce relativa alla chiave emma.

Quando utilizzi il flag -e, tieni presente quanto segue:

  • am instrument richiama onCreate(Bundle) con un Bundle contenente le coppie chiave-valore.
  • La chiave package ha la precedenza sulla chiave class. Se specifichi un pacchetto e poi separi una classe all'interno di quel pacchetto, Android esegue tutti i test nel pacchetto e ignora la chiave della classe.
  • La chiave func e la chiave unit si escludono a vicenda.

Esempi di utilizzo

Le sezioni seguenti forniscono esempi di utilizzo di am instrument per eseguire test. Si basano sulla seguente struttura:

  • Il pacchetto di test ha il nome del pacchetto Android com.android.demo.app.tests.
  • Due classi di test strumentati:
    • TestClass1, che contiene il metodo di test testMethod1.
    • TestClass2, che contiene i metodi di test testMethod2 e testMethod3.
  • L'esecutore test è AndroidJUnitRunner.

Esegui l'intero pacchetto di test

Per eseguire tutte le classi di test nel pacchetto di test, inserisci:

adb shell am instrument -w com.android.demo.app.tests/androidx.test.runner.AndroidJUnitRunner

Esegui tutti i test in una classe di scenari di test

Per eseguire tutti i test nella classe TestClass1, inserisci:

adb shell am instrument -w  \
> -e class com.android.demo.app.tests.TestClass1 \
> com.android.demo.app.tests/androidx.test.runner.AndroidJUnitRunner

Seleziona un sottoinsieme di test

Per eseguire tutti i test nella classe TestClass1 e nel metodo testMethod3 in TestClass2, inserisci:

adb shell am instrument -w \
> -e class com.android.demo.app.tests.TestClass1,com.android.demo.app.tests.TestClass2#testMethod3 \
> com.android.demo.app.tests/androidx.test.runner.AndroidJUnitRunner

Puoi trovare altri casi d'uso nel AndroidJUnitRunner riferimento dell'API.

Visualizzare i report di test unificati

Il plug-in Android per Gradle fornisce attività di test unificate, che generano dashboard HTML che uniscono i risultati dei test delle unità e dei test di instrumentazione.

Prerequisiti

  • Plug-in Android per Gradle 9.5.0-alpha05 o versioni successive.

Per testare tutte le suite di test, esegui una delle seguenti attività:

Ambito del report Comando Descrizione Posizione segnalazione
Modulo attuale ./gradlew :module_name:testAllSuites Genera un report di test unificato per il modulo corrente, unendo i risultati dei test delle unità e strumentati. path_to_your_project/module_name/build/reports/tests/test-report/
Modulo corrente e dipendenze ./gradlew :module_name:testAllSuitesWithDependencies Genera un report di test unificato per il modulo corrente e le relative dipendenze della libreria, unendo i risultati dei test delle unità e strumentati. path_to_your_project/module_name/build/reports/tests/aggregated-test-report/