本指南說明如何使用 Firebase Test Lab 準備及執行檢測設備測試。如要使用本指南,您需要使用 Espresso 或 UI Automator Android 測試架構的檢測設備測試 (由您或您的團隊撰寫)。檢測設備測試在實體裝置上最多可執行 45 分鐘,在虛擬裝置上則可執行最多 60 分鐘。
在後續步驟中,您需要將應用程式 APK 和測試的 APK 上傳到 Firebase。
(選用) 在應用程式中加入螢幕截圖資料庫
Firebase Test Lab 提供程式庫 (testlab-instr-lib),您可以在執行檢測設備測試時,處理使用 AndroidX 的 ScreenCapture 擷取所有螢幕截圖,例如使用 Espresso 測試架構編寫的測試。
本節說明如何使用 AndroidX 程式庫建立 ScreenCapture
物件,以及如何使用 testlab-instr-lib 處理這些物件。
檢測設備測試執行後,即可在 Firebase 控制台中查看擷取的螢幕截圖。
試用範例應用程式
下載 NotePad 範例應用程式來試用此功能。擷取螢幕畫面的功能已併入 NotePad 專案。
步驟 1:將螢幕截圖程式庫新增至專案
在測試專案的「根層級設定」Gradle 檔案 (
settings.gradle.kts
或settings.gradle
) 中,將 Google 的 Maven 存放區新增至每個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() } } // ...
在模組 (應用程式層級) Gradle 檔案 (通常是
<project>/<app-module>/build.gradle.kts
或<project>/<app-module>/build.gradle
) 中,新增 Test Lab 螢幕截圖程式庫的依附元件。dependencies { // ... // Add Test Lab's instrumentation test screenshot library: androidTestImplementation("com.google.firebase:testlab-instr-lib:0.2") // ...
在測試的
AndroidManifest.xml
檔案中,將FirebaseScreenCaptureProcessor
註冊在<instrumentation>
元素的中繼資料標記內。您也可以改為在 AndroidJUnitRunner 中將處理器指定為引數 (操作說明請參閱 AndroidJUnitRunner 參考說明文件)。<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> ...
在應用程式的
AndroidManifest.xml
檔案中,在<manifest>
元素中加入以下幾行內容:<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
在
AndroidManifest.xml
檔案的<manifest>
標記中加入下列程式碼,即可為應用程式指定系統權限。如果您要在 Android 10 (API 級別 29) 以上版本上測試,請省略WRITE_EXTERNAL_STORAGE
權限 (應用程式不需這項權限才能讀取及寫入螢幕截圖)。<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>
步驟 2:在測試期間擷取螢幕截圖
在測試中要擷取螢幕截圖的任何時間點,從 AndroidX 程式庫呼叫 Screenshot.capture()
方法。這會產生 ScreenCapture
物件。在 ScreenCapture
物件上呼叫 process()
時,系統會使用已在 AndroidManifest.xml
中註冊的 ScreenCaptureProcessor 處理此物件。請注意,如未註冊任何處理器,則會使用 BasicScreenCaptureProcessor
。您註冊了 FirebaseScreenCaptureProcessor
,因此系統會透過 FirebaseScreenCaptureProcessor
處理螢幕截圖,並在您使用 Firebase Test Lab 執行測試時提供結果。
建立 ScreenCapture
的用途範例:
在 API Build.VERSION_CODES.JELLY_BEAN_MR2 以上版本上執行全螢幕擷取作業:
Screenshot.capture()
針對任何 API 級別,擷取 Activity 的
ScreenCapture
。請注意,只有 Build.VERSION_CODES.JELLY_BEAN_MR2 的裝置只能採用這個選項。@Rule public ActivityTestRule<MainActivity> activityRule = new ActivityTestRule<>(MainActivity.class); ... Screenshot.capture(activityRule.getActivity()); ...
處理螢幕畫面擷取的應用實例
透過
FirebaseScreenCaptureProcessor
處理ScreenCapture
:Screenshot.capture().process();
透過指定的
ScreenCaptureProcessor
處理ScreenCapture
(這可讓您略過註冊處理器的程序):Set<ScreenCaptureProcessor> processors = new HashSet<>(); processors.add(new FirebaseScreenCaptureProcessor()); Screenshot.capture().process(processors);
設定
ScreenCapture
的名稱和格式,並使用已註冊的處理器處理:Screenshot.capture().setName("myscreenshot").setFormat(CompressFormat.JPEG).process();
步驟 3:建立並執行測試
建構應用程式和測試 APK (操作說明請參閱「測試應用程式」)。
將 APK 檔案上傳到 Firebase 控制台的 Test Lab 資訊主頁。
最後,請執行測試。
步驟 4:查看測試螢幕截圖
測試完成後,您可以在 Firebase 控制台中查看所有擷取的螢幕截圖。
在「Tests」分頁中,選取已完成的測試,然後按一下「Results」分頁標籤。
再次選取測試,然後按一下顯示的「螢幕截圖」分頁標籤。
(選用) 啟用其他測試功能
使用 Test Lab 執行測試前,可以在測試中啟用下列功能:
啟用 Orchestrator
Android Test Orchestrator 是一項工具,可獨立執行各項應用程式的檢測設備測試。Test Lab 一律使用最新版的 Orchestrator。
如要啟用 Test Lab 的 Orchestrator,請在檢測設備測試設定中,依序點選「其他選項」 >「Run with Orchestrator」。
使用 Orchestrator 時,您可以享有下列好處:
- 沒有共用狀態。每項測試都會在自己的檢測執行個體中執行,因此共用狀態不會在不同的測試之間累積。
- 隔離的當機問題。如果測試停止運作,則只有檢測作業會遭到終止,而且套件中的其他測試仍可執行。
請注意,使用 Orchestrator 時,每項測試都會執行自己的檢測執行個體,這表示應用程式程序會在每次測試案例後重新啟動。上述的執行時間增加可能會影響您的配額用量或計費時間,還可能導致您超過裝置的逾時限制。如果縮短應用程式的啟動時間,則會減少這筆負荷。
如要為 Orchestrator 設定其他選項,請透過 environmentVariables
欄位指定。舉例來說,如要使用 clearPackageData
,請在 gcloud 中使用這個選項:
--environment-variables clearPackageData=true
啟用資料分割
測試資料分割會將一組測試分成獨立執行的子群組 (資料分割)。Test Lab 會自動使用多個裝置平行執行每個資料分割,並在更短的時間內完成整組測試。
舉例來說,如果您為每部所選裝置建立 N 個資料分割,Test Lab 就會啟動 N 相同的裝置,並在每部裝置上執行一部分測試。也就是說,資料分割測試案例可能會導致每部裝置多次執行測試。然而,未經資料分割的測試案例,每部裝置都會產生一次測試執行作業。如要瞭解 Test Lab 的概念,請參閱基本概念。
如要在 Firebase 控制台中啟用測試資料分割,請按照下列步驟操作:
在「檢測設備測試設定」中,按一下「其他選項」。
在「資料分割」部分中,輸入要執行的資料分割數量。
測試資料分割的計費方式
Test Lab 利用 AndroidJUnitRunner 的內建資料分割機制實作資料分割。如要避免系統針對啟用的空白資料分割 (未指派測試案例的資料分割) 收取費用,您建立的資料分割數量應小於測試案例總數。建議您根據每個測試案例的執行時間長度,為每個資料分割指派 2 到 10 個測試案例。
如要進一步瞭解計費方式,請參閱「用量、配額與計費」一文。