Questo documento spiega come completare le attività di test automatici comuni utilizzando l'API Espresso.
L'API Espresso incoraggia gli autori dei test a pensare in termini di ciò che un utente potrebbe fare durante l'interazione con l'applicazione: individuare gli elementi UI e interagire con loro. Allo stesso tempo, il framework impedisce l'accesso diretto alle attività e alle visualizzazioni dell'applicazione, perché conservare questi oggetti e utilizzarli al di fuori del thread dell'interfaccia utente è una delle principali cause di instabilità dei test. Pertanto, non vedrai metodi come getView() e getCurrentActivity() nell'API Espresso.
Puoi comunque operare in sicurezza sulle visualizzazioni implementando le tue sottoclassi di ViewAction e ViewAssertion.
Componenti API
I componenti principali di Espresso includono:
- Espresso: punto di accesso alle interazioni con le visualizzazioni (tramite
onView()eonData()). Espone anche API che non sono necessariamente legate a una visualizzazione, comepressBack(). - ViewMatchers: una raccolta di oggetti che implementano l'interfaccia
Matcher<? super View>. Puoi passare uno o più di questi elementi al metodoonView()per individuare un oggetto View all'interno della gerarchia di oggetti View corrente. - ViewActions: una raccolta di oggetti
ViewActionche possono essere passati al metodoViewInteraction.perform(), ad esempioclick(). - ViewAssertions: una raccolta di oggetti
ViewAssertionche possono essere passati al metodoViewInteraction.check(). Nella maggior parte dei casi, utilizzerai l'asserzione matches, che utilizza un matcher di visualizzazione per confermare lo stato della visualizzazione attualmente selezionata.
Esempio:
// withId(R.id.my_view) is a ViewMatcher. // click() is a ViewAction. // matches(isDisplayed()) is a ViewAssertion. onView(withId(R.id.my_view)) .perform(click()) .check(matches(isDisplayed()))
Trova una vista
Nella stragrande maggioranza dei casi, il metodo onView() accetta un matcher Hamcrest che dovrebbe corrispondere a una, e una sola, visualizzazione all'interno della gerarchia di visualizzazione corrente. I matcher sono potenti e saranno familiari a chi li ha utilizzati con Mockito o JUnit. Se non hai dimestichezza con i matcher Hamcrest, ti consigliamo di iniziare con una rapida occhiata a questa presentazione.
Spesso la visualizzazione desiderata ha un R.id univoco e un semplice matcher withId restringe la ricerca della visualizzazione. Tuttavia, esistono molti casi legittimi in cui non è possibile determinare R.id al momento dello sviluppo del test. Ad esempio, la vista specifica potrebbe non avere un R.id o il R.id non è univoco. Questo può rendere i normali test di instrumentazione fragili e complicati da scrivere, perché il modo normale di accedere alla visualizzazione, con findViewById(), non funziona. Pertanto, potresti dover accedere ai membri privati dell'attività o del frammento che contiene la visualizzazione o trovare un contenitore con un R.id noto e accedere ai relativi contenuti per la visualizzazione specifica.
Espresso gestisce questo problema in modo pulito consentendoti di restringere la visualizzazione utilizzando oggetti ViewMatcher esistenti o personalizzati.
Trovare una visualizzazione in base al relativo R.id è semplice come chiamare onView():
onView(withId(R.id.my_view))
A volte, i valori R.id sono condivisi tra più visualizzazioni. In questo caso, un tentativo di utilizzare un determinato R.id genera un'eccezione, ad esempio AmbiguousViewMatcherException. Il messaggio di eccezione fornisce una rappresentazione testuale della gerarchia di oggetti View corrente, in cui puoi cercare e trovare gli oggetti View che corrispondono all'ID R.id non univoco:
java.lang.RuntimeException:
androidx.test.espresso.AmbiguousViewMatcherException
This matcher matches multiple views in the hierarchy: (withId: is <123456789>)
...
+----->SomeView{id=123456789, res-name=plus_one_standard_ann_button,
visibility=VISIBLE, width=523, height=48, has-focus=false, has-focusable=true,
window-focus=true, is-focused=false, is-focusable=false, enabled=true,
selected=false, is-layout-requested=false, text=,
root-is-layout-requested=false, x=0.0, y=625.0, child-count=1}
****MATCHES****
|
+------>OtherView{id=123456789, res-name=plus_one_standard_ann_button,
visibility=VISIBLE, width=523, height=48, has-focus=false, has-focusable=true,
window-focus=true, is-focused=false, is-focusable=true, enabled=true,
selected=false, is-layout-requested=false, text=Hello!,
root-is-layout-requested=false, x=0.0, y=0.0, child-count=1}
****MATCHES****
Esaminando i vari attributi delle visualizzazioni, potresti trovare proprietà identificabili in modo univoco. Nell'esempio precedente, una delle visualizzazioni contiene il testo "Hello!". Puoi utilizzarlo per restringere la ricerca utilizzando i matcher di combinazione:
onView(allOf(withId(R.id.my_view), withText("Hello!")))
Puoi anche scegliere di non invertire nessuno dei matcher:
onView(allOf(withId(R.id.my_view), not(withText("Unwanted"))))
Per i matcher di visualizzazione comuni forniti da Espresso, controlla
androidx.test.espresso.matcher.ViewMatchers nel tuo IDE o consulta la
scheda di riferimento di Espresso.
Considerazioni
- In un'applicazione che funziona correttamente, tutte le visualizzazioni con cui un utente può interagire devono contenere un testo descrittivo o avere una descrizione dei contenuti. Per maggiori dettagli, consulta Rendere le app più accessibili. Se non riesci a restringere una ricerca utilizzando
withText()owithContentDescription(), considera la possibilità di trattarla come un bug di accessibilità. - Utilizza il matcher meno descrittivo che trova la singola visualizzazione che stai cercando. Non specificare eccessivamente, in quanto ciò costringerà il framework a eseguire più lavoro del necessario. Ad esempio, se una visualizzazione è identificabile in modo univoco dal suo testo, non è necessario specificare che la visualizzazione è anche assegnabile da
TextView. Per molte visualizzazioni, l'elementoR.iddella visualizzazione dovrebbe essere sufficiente. - Se la vista di destinazione si trova all'interno di un
AdapterView, ad esempioListView,GridViewoSpinner, il metodoonView()potrebbe non funzionare. In questi casi, devi utilizzareonData().
Esegui un'azione su una visualizzazione
Una volta trovato un matcher adatto per la visualizzazione di destinazione, è possibile eseguire istanze di ViewAction su di esso utilizzando il metodo perform.
Ad esempio, per fare clic sulla visualizzazione:
onView(...).perform(click())
Puoi eseguire più azioni con una sola chiamata di esecuzione:
onView(...).perform(typeText("Hello"), click())
Se la visualizzazione con cui stai lavorando si trova all'interno di un ScrollView (verticale o orizzontale), valuta la possibilità di far precedere le azioni che richiedono la visualizzazione, ad esempio click() e typeText(), da scrollTo(). In questo modo, la visualizzazione viene mostrata prima di procedere con l'altra azione:
onView(...).perform(scrollTo(), click())
Per le azioni di visualizzazione comuni fornite da Espresso, controlla
androidx.test.espresso.action.ViewActions nel tuo IDE o consulta il
foglio di riferimento di Espresso.
Controlla le asserzioni di visualizzazione
Le asserzioni possono essere applicate alla vista attualmente selezionata con il metodo check(). L'asserzione più utilizzata è l'asserzione matches(). Utilizza un oggetto ViewMatcher per confermare lo stato della vista attualmente selezionata.
Ad esempio, per verificare che una visualizzazione contenga il testo "Hello!":
onView(...).check(matches(withText("Hello!")))
Se vuoi dichiarare che "Hello!" è il contenuto della visualizzazione, la seguente è considerata una prassi scorretta:
// Don't use assertions like withText inside onView. onView(allOf(withId(...), withText("Hello!"))).check(matches(isDisplayed()))
D'altra parte, se vuoi verificare che una visualizzazione con il testo "Hello!" sia visibile, ad esempio dopo una modifica del flag di visibilità delle visualizzazioni, il codice va bene.
Visualizza il test semplice dell'asserzione
In questo esempio, SimpleActivity contiene un Button e un TextView. Quando si fa clic sul pulsante, i contenuti di TextView cambiano in "Hello Espresso!".
Ecco come testarlo con Espresso:
Fai clic sul pulsante
Il primo passaggio consiste nel cercare una proprietà che aiuti a trovare il pulsante. Il pulsante nella SimpleActivity ha un R.id univoco, come previsto.
onView(withId(R.id.button_simple))
Ora, per eseguire il clic:
onView(withId(R.id.button_simple)).perform(click())
Verifica il testo della TextView
Anche l'elemento TextView con il testo da verificare ha un elemento R.id univoco:
onView(withId(R.id.text_simple))
Ora, per verificare il testo dei contenuti:
onView(withId(R.id.text_simple)).check(matches(withText("Hello Espresso!")))
Controlla il caricamento dei dati nelle visualizzazioni dell'adattatore
AdapterView è un tipo speciale di widget che carica i dati in modo dinamico da un adattatore. L'esempio più comune di AdapterView è ListView. A differenza dei widget statici come LinearLayout, solo un sottoinsieme degli elementi secondari di AdapterView può essere caricato nella gerarchia di oggetti View corrente. Una semplice ricerca di onView() non troverebbe le visualizzazioni che non sono attualmente caricate.
Espresso gestisce questo problema fornendo un punto di accesso onData() separato in grado di caricare prima l'elemento dell'adattatore in questione, mettendolo in primo piano prima di operare su di esso o su uno dei suoi elementi secondari.
Avviso: le implementazioni personalizzate di AdapterView possono presentare problemi con il metodo onData() se violano i contratti di ereditarietà, in particolare l'API getItem(). In questi casi, la soluzione migliore è rifattorizzare il codice dell'applicazione. Se non puoi farlo, puoi implementare un AdapterViewProtocol personalizzato corrispondente. Per saperne di più, consulta
DataInteraction.usingAdapterViewProtocol()
e ispeziona androidx.test.espresso.action.AdapterViewProtocols in
androidx.test.espresso:espresso-core.
Test semplice della visualizzazione dell'adattatore
Questo semplice test mostra come utilizzare onData(). SimpleActivity contiene un elemento Spinner con alcuni elementi che rappresentano i tipi di bevande a base di caffè. Quando un elemento viene selezionato, viene visualizzato un TextView che cambia in "One %s a day!", dove %s rappresenta l'elemento selezionato.
L'obiettivo di questo test è aprire Spinner, selezionare un elemento specifico e verificare che TextView contenga l'elemento. Poiché la classe Spinner si basa su AdapterView, è consigliabile utilizzare onData() anziché onView() per la corrispondenza dell'elemento.
Apri la selezione degli elementi
onView(withId(R.id.spinner_simple)).perform(click())
Selezionare un elemento
Per la selezione degli elementi, Spinner crea un ListView con i relativi contenuti.
Questa visualizzazione può essere molto lunga e l'elemento potrebbe non essere aggiunto alla gerarchia di oggetti View. Utilizzando onData(), forziamo l'elemento desiderato nella gerarchia di oggetti View. Gli elementi in Spinner sono stringhe, quindi vogliamo trovare un elemento uguale alla stringa "Americano":
onData( allOf( `is`(instanceOf(String::class.java)), `is`("Americano") ) ).perform(click())
Verifica che il testo sia corretto
onView(withId(R.id.spinnertext_simple)) .check(matches(withText(containsString("Americano"))))
Debug
Espresso fornisce informazioni di debug utili quando un test non va a buon fine:
Logging
Espresso registra tutte le azioni di visualizzazione in logcat. Ad esempio:
ViewInteraction: Performing 'single click' action on view with text: Espresso
Visualizza gerarchia
Espresso stampa la gerarchia di oggetti View nel messaggio di eccezione quando onView()
non va a buon fine.
- Se
onView()non trova la visualizzazione di destinazione, viene generato unNoMatchingViewException. Puoi esaminare la gerarchia di oggetti View nella stringa dell'eccezione per analizzare il motivo per cui l'oggetto di corrispondenza non ha trovato corrispondenze con nessuna visualizzazione. - Se
onView()trova più visualizzazioni che corrispondono al matcher specificato, viene generata un'eccezioneAmbiguousViewMatcherException. La gerarchia di oggetti View viene stampata e tutte le visualizzazioni corrispondenti vengono contrassegnate con l'etichettaMATCHES:
java.lang.RuntimeException:
androidx.test.espresso.AmbiguousViewMatcherException
This matcher matches multiple views in the hierarchy: (withId: is <123456789>)
...
+----->SomeView{id=123456789, res-name=plus_one_standard_ann_button,
visibility=VISIBLE, width=523, height=48, has-focus=false, has-focusable=true,
window-focus=true, is-focused=false, is-focusable=false, enabled=true,
selected=false, is-layout-requested=false, text=,
root-is-layout-requested=false, x=0.0, y=625.0, child-count=1}
****MATCHES****
|
+------>OtherView{id=123456789, res-name=plus_one_standard_ann_button,
visibility=VISIBLE, width=523, height=48, has-focus=false, has-focusable=true,
window-focus=true, is-focused=false, is-focusable=true, enabled=true,
selected=false, is-layout-requested=false, text=Hello!,
root-is-layout-requested=false, x=0.0, y=0.0, child-count=1}
****MATCHES****
Quando si ha a che fare con una gerarchia di oggetti View complicata o un comportamento imprevisto dei widget, è sempre utile utilizzare il visualizzatore gerarchia in Android Studio per una spiegazione.
Avvisi della visualizzazione dell'adattatore
Espresso avvisa gli utenti della presenza di widget AdapterView. Quando un'operazione onView() genera un'eccezione NoMatchingViewException e i widget AdapterView sono presenti nella gerarchia di oggetti View, la soluzione più comune è utilizzare onData().
Il messaggio di eccezione includerà un avviso con un elenco delle visualizzazioni dell'adattatore.
Puoi utilizzare queste informazioni per richiamare onData() per caricare la visualizzazione di destinazione.
Risorse aggiuntive
Per saperne di più sull'utilizzo di Espresso nei test Android, consulta le seguenti risorse.
Esempi
- CustomMatcherSample:
mostra come estendere Espresso in modo che corrisponda alla proprietà hint di un oggetto
EditText. - RecyclerViewSample:
azioni
RecyclerViewper Espresso. - (more…)