聲明:本系列文章是對 Android Testing Support Library官方文檔的翻譯,水平有限,歡迎批評指正。
1. Espresso 概覽
2. Espresso 設置說明
3. Espresso 基礎
4. Espresso 備忘錄
5. Espresso 意圖
6. Espresso 高級示例
7. Espresso Web
8. AndroidJUnitRunner
9. ATSL 中的 JUnit4 規則
10. UI Automator
11. 可訪問性檢查
Espresso API 鼓勵測試者以用戶會怎樣與應用交互的方式進行思考來定位 UI 元素并與它們交互。同時,框架不允許直接使用應用的活動和視圖,因為在非 UI 線程持有此類對象并對它們操作是造成測試花屏的主要原因。因此,你不會在 Espresso API 中看到諸如 getView 或 getCurrentActivity 等方法。但你仍然可以通過實現 ViewAction
和 ViewAssertion
來對視圖進行安全操作。
以下是 Espresso 主要組件的概覽:
-
Espresso - 與視圖交互的切入點(參考
onView
和onData
)。也暴露了與任何視圖都沒有必然聯系的 API(如?pressBack
)。 -
ViewMatchers - 實現了
?Matcher<? super View>
? 接口的對象集合。你可以在?onView
? 方法中傳入一個或多個此類對象來在當前的視圖結構中定位一個視圖。 -
ViewActions - 可以作為參數傳入
?ViewInteraction.perform()
? 方法中的ViewAction
的集合(如?click()
)。 -
ViewAssertions - 可以作為參數傳入
?ViewInteraction.check()
? 方法中的ViewAssertion
的集合。通常,你會使用帶有視圖匹配器的匹配斷言來判斷當前被選中視圖的狀態。
例如:
onView(withId(R.id.my_view)) // withId(R.id.my_view) is a ViewMatcher
.perform(click()) // click() is a ViewAction
.check(matches(isDisplayed())); // matches(isDisplayed()) is a ViewAssertion
使用 onView 查找視圖
多數情況下,onView 方法使用 hamcrest 匹配器以期望在當前視圖結構里匹配一個(唯一的)視圖。該匹配器十分強大而且對用過 Mockito 或 JUnit 的人而言并不陌生。如果你對 hamcrest 匹配器不熟悉,我們建議你先快速瀏覽一下此報告。(譯注:譯者本人表示打不開)
想要查找的視圖一般會有唯一的 ?R.id
? 值,使用簡單的 ?withId
? 匹配器可以縮小搜索范圍。然而,當你在測試開發階段,無法確定 ?R.id
值是合理的?。例如,指定的視圖可能沒有 R.id
? 值或該值不唯一。這將使一般的 instrumentation 測試變得脆弱而復雜,因為通用的獲取視圖方式(通過 findViewById()
)已經不適用了。因此,你可能需要獲取持有視圖的私有對象 Activity 或 Fragment,或者找到一個已知其 ?R.id
? 值的父容器,然后在其中定位到特定的視圖。
Espresso 處理該問題的方式很干脆,它允許你使用已存在的或自定義的 ViewMatcher 來限定視圖查找。
通過 ?R.id
? 查找視圖:
onView(withId(R.id.my_view))
有時,?R.id
?值會被多個視圖共享。此時,如果嘗試使用該 ?R.id
? 值將會拋出類似 ?AmbiguousViewMatcherException
?的異常。異常信息會給你提供文字描述形式的當前視圖結構,你可以搜索并找出所有使用非唯一 ?R.id
? 值的視圖:
java.lang.RuntimeException:
com.google.android.apps.common.testing.ui.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****
通過查看視圖豐富的屬性,你興許可以找到唯一可確認的屬性(上例中,其中一個視圖有一個“Hello!”文本)。你可以通過使用組合匹配器結合該屬性來縮小搜索范圍:
onView(allOf(withId(R.id.my_view), withText("Hello!")))
你也可以使用 ?not
? 反轉匹配:
onView(allOf(withId(R.id.my_view), not(withText("Unwanted"))))
你可以在 ViewMatchers 類中查看 Espresso 提供的視圖匹配器。
注意:在一個良態的應用中,所有用戶可與之交互的視圖都應該包含說明文字或有一個內容描述(參考 Android 可訪問性指導)。如果你不能通過使用 ‘withText’ 或 ‘withContentDescripiton’ 來縮小 onView 的搜索范圍,可以認為這是一個可訪問性的 bug。
注意:請使用最少的匹配器來定位視圖。不要過指定,因為這將強制框架做無用功。例如,如果一個視圖可以通過它的文字唯一確定,你不需要說明該視圖也可以通過 ?TextView
? 指定。對許多視圖而言,使用它的 ?R.id
? 值就足夠了。
注意:如果目標視圖在一個 ?AdapterView
?(如 ?ListView
?,?GridView
?,?Spinner
?)中,將不能使用 onView
? 方法,推薦使用 ?onData
? 方法。
在視圖上執行操作
當為目標視圖找到了合適的適配器后,你將可以通過 ?perform
? 方法在該視圖上執行 ?ViewAction
?。
例如,點擊該視圖:
onView(…).perform(click());
你可以在一個 perform 方法中執行多個操作:
onView(…).perform(typeText("Hello"), click());
如果操作的視圖在 ?ScrollView
?(水平或垂直方向)中,需要考慮在對該視圖執行操作(如 ?click()
? 或 ?typeText()
?)之前通過 ?scrollTo()
? 方法使其處于顯示狀態。這樣就保證了視圖在執行其他操作之前是顯示著的。
onView(…).perform(scrollTo(), click());
注意:如果視圖已經是顯示狀態,* *?scrollTo()
? 將不會對界面有影響。因此,當視圖的可見性取決于屏幕的大小時(例如,同時在大屏和小屏上執行測試時),你可以安全的使用該方法。
你可以在 ViewActions 類中產看 Espresso 提供的視圖操作。
檢查一個視圖是否滿足斷言
斷言可以通過 ?check()
? 方法應用在當前選中的視圖上。最常用的是 ?matches()
? 斷言,它使用一個 ?ViewMatcher
? 來判斷當前選中視圖的狀態。
例如,檢查一個視圖擁有 “Hello!”文本:
onView(…).check(matches(withText("Hello!")));
注意:不要將 “assertions” 作為 onView 的參數傳入,而要在檢查代碼塊中明確指定你檢查的內容,例如:
如果你想要斷言視圖的內容是 “Hello!” ,以下做法是反面教材:
// Don't use assertions like withText inside onView.
onView(allOf(withId(...), withText("Hello!"))).check(matches(isDisplayed()));
從另一個角度講,如果你想要斷言一個包含 “Hello!” 文本的視圖是可見的(例如,在修改了該視圖的可見性標志之后),這段代碼是正確的。
注意:請留意斷言一個視圖沒有顯示和斷言一個視圖不在當前視圖結構之間的區別。
使用 onView 編寫一個簡單的測試
在此示例中,?SimpleActivity
? 包含一個 ?Button
? 和一個 ?TextView
?。當點擊按鈕時,?TextView
? 的內容更改為 “Hello Espresso!”。以下是如何使用 Espresso 執行此測試的講解:
1. 點擊按鈕
第一步是檢索一個能定位這個按鈕的屬性。?SimpleActivity
? 中的這個按鈕擁有唯一的 ?R.id
?,贊!
onView(withId(R.id.button_simple))
然后執行點擊操作:
onView(withId(R.id.button_simple)).perform(click());
2. 檢查 ?TextView
? 中是否包含 “Hello Espresso!”
待驗證的 ?TextView
? 也包含唯一的 ?R.id
?:
onView(withId(R.id.text_simple))
然后驗證文本內容:
onView(withId(R.id.text_simple)).check(matches(withText("Hello Espresso!")));
在 ?AdapterView
? 控制器(ListView
, GridView
, ...)中使用 onData
?AdapterView
? 是一個從適配器中動態加載數據的特殊控件。最常見的 ?AdapterView
? 是 ListView
?。與像 ?LinearLayout
? 這樣的靜態控件相反,在當前視圖結構中,可能只加載了 ?AdapterView
? 子控件的一部分, 簡單的 ?onview()
? 搜索不能找到當前沒有被加載的視圖。Espresso 通過提供單獨的 onData()
? 切入點處理此問題,它可以在操作適配器中有該問題的條目或該條目的子項之前將其加載(使其獲取焦點)。
注意:你可能不會對初始狀態就顯示在屏幕上的適配器條目執行 ?onData()
? 加載操作,因為它們已經被加載了。然而,一直使用 ?onData()
? 會更安全。
警告:對于 AdapterView
? 的自定義實現,如果他們打破了繼承契約(尤其是 ?getItem()
? API),使用 ?onData()
? 方法時會出現問題。此種情況,最好是重構你的應用代碼。如果不能這樣做,你可以實現一個匹配的自定義 ?AdapterViewProtocol
?。查看 Espresso 提供的默認的 AdapterViewProtocols 獲取供多信息。
使用 onData 編寫一個簡單的測試
這個簡單的測試演示了如何使用? onData()
?。
?SimpleActivity
? 包含一個 ?Spinner
? ,該 Spinner
? 中有幾個條目——代表咖啡類型的字符串。當選中其中一個條目時,?TextView
? 內容會變成 ?“One %s a day!”
?,其中 %s 代表選中的條目。此測試的目標是打開 ?Spinner
?,選中一個條目然后驗證 ?TextView
? 中包含該條目。由于 ?Spinner
? 類基于 ?AdapterView
?,建議使用 ?onData()
? 而不是 ?onView()
? 來匹配條目。
1. 點擊 Spinner 打開條目選擇框
onView(withId(R.id.spinner_simple)).perform(click());
2. 點擊 “Americano” 條目
為了條目可供選擇,Spinner 用它的內容創建了一個 ?ListView
?。該 ListView
可能會很長,而且它的元素不會出現在視圖結構中。通過使用 ?onData()
? 我們強制將想要得到的元素加入到視圖結構中。Spinner 中的元素是字符串,我們想要匹配的條目是字符串類型并且值是 “Americano”。
onData(allOf(is(instanceOf(String.class)), is("Americano"))).perform(click());
3. 驗證 TextView
? 包含 “Americano” 字符串
onView(withId(R.id.spinnertext_simple).check(matches(withText(containsString("Americano"))));
調試
當測試失敗時,Espresso 會提供有用的調試信息:
日志
Espresso 將所有視圖操作記錄到 logcat 中。例如:
ViewInteraction: Performing ‘single click’ action on view with text: Espresso
視圖結構
當 onView()
? 執行失敗時,Espresso 會在異常字符串里打印視圖結構。
- 如果
?onView
? 沒有找到目標視圖,會拋出?NoMatchingViewException
?。你可以檢查異常字符串中的視圖結構來分析為什么匹配器沒有匹配到視圖。 - 如果
?onView()
? 根據給出的匹配器找到了多個視圖,會拋出?AmbiguousViewMatcherException
?。視圖結構會被打印出來,并且所有被匹配的視圖都會帶有 MATCHES 標簽:
java.lang.RuntimeException:
com.google.android.apps.common.testing.ui.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****
當處理一個完整的視圖結構或控件異常行為時,使用 Android 視圖結構查看器有利于你給出說明。
?AdapterView
? 提醒
Espresso 會提醒用戶 AdapterView
控件的出現。當 ?onView
? 操作拋出 ?NoMatchingViewException
? 異常而且 ?AdapterView
? 控件在視圖結構中時,最常見的解決方法是使用 onData()
。異常信息中將會包含一個帶有一列適配器視圖的提醒。你可以通過此信息來調用 onData 加載目標視圖。