Espresso 閒置資源

「閒置資源」代表非同步作業,其結果會影響 UI 測試中的後續作業。向 Espresso 註冊閒置資源後,您就能在測試應用程式時,更可靠地驗證這些非同步作業。

判斷何時需要閒置資源

Espresso 提供一組精密的同步功能。不過,架構的這個特性僅適用於在 MessageQueue 上張貼訊息的操作,例如在螢幕上繪製內容的 View 子類別。

由於 Espresso 不知道任何其他非同步作業 (包括在背景執行緒上執行的作業),因此在這些情況下,Espresso 無法提供同步保證。為了讓 Espresso 知道應用程式長時間執行的作業,您必須將每項作業註冊為閒置資源。

測試應用程式非同步工作的結果時,如果不使用閒置資源,可能需要採用下列其中一種不佳的解決方法,才能提高測試可靠性:

  • 新增廣告呼叫至Thread.sleep()。如果在測試中加入人工延遲,測試套件需要更長的時間才能完成執行,而且在較慢的裝置上執行時,測試仍可能失敗。此外,這些延遲時間無法妥善調整,因為應用程式可能需要在日後版本中執行更耗時的非同步工作。
  • 實作重試包裝函式:使用迴圈重複檢查應用程式是否仍在執行非同步工作,直到逾時為止。即使您在測試中指定重試次數上限,每次重新執行都會消耗系統資源,尤其是 CPU。
  • 使用 CountDownLatch 的例項,可讓一或多個執行緒等待,直到在另一個執行緒中執行的特定作業數量完成為止。這些物件需要您指定逾時長度,否則應用程式可能會無限期遭到封鎖。閂鎖也會增加程式碼不必要的複雜度,使維護工作更加困難。

Espresso 可讓您從測試中移除這些不可靠的解決方法,並將應用程式的非同步工作註冊為閒置資源。

常見用途

在測試中執行類似下列範例的操作時,建議使用閒置資源:

  • 從網際網路或本機資料來源載入資料。
  • 建立與資料庫和回呼的連線。
  • 代管服務:使用系統服務或 IntentService 執行個體。
  • 執行複雜的商業邏輯,例如點陣圖轉換。

如果這些作業會更新測試要驗證的 UI,則註冊閒置資源就特別重要。

閒置資源導入範例

以下列出幾種閒置資源的實作範例,您可以整合至應用程式:

CountingIdlingResource
:維護進行中工作的計數器。當計數器為零時,相關聯的資源會視為閒置。這項功能與 Semaphore 非常相似。在大多數情況下,這項實作足以管理測試期間應用程式的非同步工作。
UriIdlingResource
與 CountingIdlingResource 類似,但計數器必須在特定時間內為零,資源才會視為閒置。這段額外的等待時間會將連續的網路要求納入考量,因為執行緒中的應用程式可能會在收到前一個要求的回應後,立即提出新的要求。
IdlingThreadPoolExecutor
ThreadPoolExecutor 的自訂實作,可追蹤所建立執行緒集區中執行中的工作總數。
這個類別會使用 CountingIdlingResource 來維護進行中工作的計數器。
IdlingScheduledThreadPoolExecutor
ScheduledThreadPoolExecutor 的自訂實作。它提供與 IdlingThreadPoolExecutor 類別相同的功能和能力,但也可以追蹤排定在未來或定期執行的工作。

建立自己的閒置資源

在應用程式測試中使用閒置資源時,您可能需要提供自訂資源管理或記錄功能。在這些情況下,上一節列出的實作方式可能不夠。如果是這種情況,您可以擴充其中一個閒置資源實作,或自行建立。

如果您自行實作閒置資源功能,請留意下列最佳做法,尤其是第一項:

在閒置檢查以外叫用閒置狀態轉換。
應用程式進入閒置狀態後,請在 isIdleNow() 的任何實作項目外呼叫 onTransitionToIdle()。這樣一來,Espresso 就不會進行第二次不必要的檢查,判斷特定閒置資源是否閒置。

下列程式碼片段說明這項建議:

fun isIdle() {
    // DON'T call callback.onTransitionToIdle() here!
}

fun backgroundWorkDone() {
    // Background work finished.
    callback.onTransitionToIdle() // Good. Tells Espresso that the app is idle.

    // Don't do any post-processing work beyond this point. Espresso now
    // considers your app to be idle and moves on to the next test action.
}

在需要閒置資源前先註冊。

只有在 Espresso 首次叫用該資源的 isIdleNow() 方法後,與閒置資源相關聯的同步處理優點才會生效。

以下列舉這項屬性的幾個範例:

  • 如果您在含有 @Before 註解的方法中註冊閒置資源,該閒置資源會在每項測試的第一行生效。
  • 如果您在測試中註冊閒置資源,該資源會在下一個 Espresso 動作期間生效。即使下一個動作與註冊閒置資源的陳述式位於同一測試中,仍會發生這種行為。
使用完畢後,請取消註冊閒置資源。

為節省系統資源,請在不再需要閒置資源時立即取消註冊。舉例來說,如果您在加上 @Before 註解的方法中註冊閒置資源,建議您在加上 @After 註解的對應方法中取消註冊這項資源。

使用閒置資源登錄檔註冊及取消註冊閒置資源。

只要將這個容器用於應用程式的閒置資源,您就能視需要重複註冊及取消註冊閒置資源,同時仍可觀察到一致的行為。

僅在閒置資源中維護簡單的應用程式狀態。

舉例來說,您實作及註冊的閒置資源不應包含 View 物件的參照。

註冊閒置資源

Espresso 提供容器類別,可讓您放置應用程式的閒置資源。這個類別稱為 IdlingRegistry,是獨立的構件,可將應用程式的負擔降到最低。這個類別還可讓您採取下列步驟,改善應用程式的可維護性:

  • 在應用程式測試中,建立 IdlingRegistry 的參照,而非其包含的閒置資源。
  • 針對每個建構變化版本,維護所用閒置資源集合的差異。
  • 在應用程式的服務中定義閒置資源,而不是在參照這些服務的 UI 元件中定義。

將閒置資源整合至應用程式

雖然您可以透過多種方式將閒置資源新增至應用程式,但其中一種方法特別能維護應用程式的封裝,同時仍可指定特定閒置資源代表的特定作業。

在應用程式中新增閒置資源時,我們強烈建議您將閒置資源邏輯放在應用程式本身,並僅在測試中執行註冊和取消註冊作業。

雖然您採用這種方法,在實際工作環境程式碼中使用僅限測試的介面,會造成不尋常的情況,但您可以將閒置資源包裝在現有程式碼周圍,維持應用程式的 APK 大小和方法數量。

替代做法

如果您不希望應用程式的正式版程式碼中包含閒置資源邏輯,可以採用其他可行的整合策略:

  • 建立建構變化版本 (例如 Gradle 的變種版本),並僅在應用程式的偵錯版本中使用閒置資源。
  • 使用 Dagger 等依附元件插入架構,將應用程式的閒置資源依附元件圖表插入測試。如果您使用 Dagger 2,插入作業本身應來自子元件。
  • 在應用程式測試中實作閒置資源,並在這些測試中公開需要同步處理的應用程式實作部分。

    注意:雖然這項設計決策似乎會建立閒置資源的獨立參照,但也會破壞所有應用程式 (最簡單的應用程式除外) 的封裝。

其他資源

如要進一步瞭解如何在 Android 測試中使用 Espresso,請參閱下列資源。

範例