類別索引

這些是 API 類。查看所有API 包

A

解析器通過解析“aapt dump badging”的輸出從 apk 中提取信息的類。
AaptParser.Aapt版本用於解析 APK 文件的 AAPT 版本的選項枚舉。
阿比表示 ABI 的類。
格式化程序abi 的實用程序類。
能力工具用於處理設備 ABI 的實用程序類
抽象連接抽象連接表示。
抽象主機監視器主機健康監控的典型類。
抽象XML解析器用於解析 xml 文件的幫助器基類
抽象 XmlParser.ParseException如果無法解析 XML 輸入,則拋出
AcloudConfigParser解析 Acloud 配置的助手類(用於啟動雲設備實例)。
AcloudConfigParser.AcloudKeys可以從配置中搜索的鍵集。
行動進行中正在進行的一般操作。
主動跟踪幫助描述和管理活動跟踪的主類。
活動狀態檢查器在模塊末尾運行的遺留活動的狀態檢查器。
Adb根電梯一個AutoCloseable ,它在需要時在構建時啟用 adb root,並在完成時恢復 root 狀態。
AdbSsh連接通過 ssh 橋接的 Adb 連接。
AdbStopServerPreparer目標準備器在運行 adb 測試之前和之後停止主機上的 adb 服務器。
AdbTcpConnection設備的默認連接表示,假定為設備的標準 adb 連接。
AdbUtils用於 adb 操作的實用程序類。
課後信息AfterClass類似的保證,但註釋的方法必須需要一個TestInformation參數。
聚合後處理器一個度量聚合器,它為在多次迭代測試運行期間收集的數字度量提供最小值、最大值、平均值、方差、標準差、總數、計數和可選的百分位數,將它們視為雙精度數。
所有測試應用程序安裝設置IDeviceBuildInfo#getTestsDir()文件夾中的所有應用程序安裝到設備上的ITargetPreparer
AltDir行為為各種測試工件安裝程序/推送程序定義替代目錄行為的枚舉

AndroidJ單元測試使用 android.support.test.runner.AndroidJUnitRunner 在給定設備上運行儀器測試包的測試。
Aoa目標準備器ITargetPreparer使用 Android Open Accessory (AOAv2) 協議執行一系列操作(例如點擊和滑動)。
應用構建信息代表 Android 應用程序及其測試包的IBuildInfo
AppDeviceBuildInfo此類已棄用。直接使用IDeviceBuildInfo
應用設置安裝 apk 及其測試的ITargetPreparer
AppVersionFetcher用於從設備獲取應用程序版本字符串的實用程序類。
AppVersionFetcher.AppVersionInfo應用版本信息類型。
ArchModule控制器模塊控制器在不匹配任何給定架構時不運行測試。
參數選項解析器從解析的命令行參數填充Option字段。
數組工具數組的實用方法
ArtChrootPreparer為 ART 測試創建 chroot 目錄。
藝術測試
ArtRun測試運行 ART 運行測試的測試運行器。
ArtRunTest.AdbShellCommandException異常一個異常類,用於報告在執行 ADB shell 命令期間發生的錯誤。
ATestFileSystemLogSaver ATest 使用這個 LogSaver 類將日誌保存在特定路徑中。
測試跑者ITestSuite的實施
跟踪收集器在測試期間運行 atrace 並收集結果並將其記錄到調用中的IMetricCollector
AtraceRunMetricCollector從測試設備的給定目錄下的所有測試目錄中收集跟踪,記錄測試目錄併後處理測試目錄下的跟踪文件並聚合指標。
自動日誌收集器描述線束可以自動處理哪個收集器的枚舉。
自動化記者定義來自 Tradefed 自動報告程序的映射的類。
平均後處理器計算指標列表平均值的後處理器的實現。

背景設備動作在給定設備上根據需要重複運行命令,直到操作被取消。
BaseDeviceMetricCollector IMetricCollector的基本實現,允許在onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData)ERROR(/#onTestRunEnd(com.android.tradefed.device.metric.DeviceMetricData,Map))上開始和停止收集。
BaseEmulatorPreparer用於啟動本地模擬器的通用準備器。
BaseHostJUnit4Test用於運行主機 JUnit4 樣式測試的基本測試類。
基礎水平對數輸出ILeveledLogOutput的基本實現,允許根據名稱或組件過濾某些標籤。
基礎模塊控制器IModuleController的基本實現,應該實現以檢查模塊是否應該運行。
BaseMultiTargetPreparer允許禁用對象的IMultiTargetPreparer的基本實現。
基礎後處理器每個實現都應該擴展的基礎IPostProcessor
基礎重試決定IRetryDecision的基礎實現。
BaseStreamLogger <OS 擴展 OutputStream>將日誌消息定向到輸出流和標準輸出的ILeveledLogOutput
基礎目標準備者ITargetPreparer的基本實現類,允許控制對像是否被禁用。
基礎測試套件使用新套件系統運行兼容性測試套件的測試。
電池控制器允許控制設備電池充電狀態的實用程序類。
電池充電設備恢復允許在設備的電池電量低於給定閾值時觸發命令。
電池溫度
電池不可用設備恢復如果電池電量不可用,將觸發配置的恢復檢查器。
BeforeClassWithInfoBeforeClass類似的保證,但註釋的方法必須需要一個TestInformation參數。
二元狀態Enum 用於記錄 ON/OFF 狀態和 IGNORE 無操作狀態。
BluetoothConnectionLatencyCollector收集器會將預定義的 statsd 持續時間指標配置推送到設備,並收集每個配置文件的藍牙連接持續時間。
藍牙連接狀態收集器此收集器將收集 BluetoothConnectionStateChanged 指標並記錄每個配置文件的連接狀態數。
藍牙連接成功率後處理器計算藍牙配置文件成功率的後處理器的實現

使用“metric-key-match”指定包含數字數組示例 [0, 1, 2, 3, 0, 1, 2, 3] 中的藍牙連接狀態的指標。

藍牙HciSnoopLog收集器收集器,用於在 DUT 上啟用藍牙 HCI 偵聽日誌記錄並收集每個測試的日誌。
藍牙工具用於在設備上調用 BluetoothInstrumentation 的實用函數

設備端 BluetoothInstrumentation 代碼可以在 AOSP 中找到: frameworks/base/core/tests/bluetoothtests

BootstrapBuildProvider從測試設備引導構建信息的IDeviceBuildProvider

這通常用於具有外部提供構建的設備,即

BootstrapServiceFileResolverLoader使用服務加載工具加載解析器。
錯誤報告包含錯誤報告文件引用的對象,與平面錯誤報告和壓縮錯誤報告 (bugreportz) 兼容。
錯誤報告收集器一個傳遞ITestInvocationListener ,它在發生可配置事件時收集錯誤報告,然後在收集每個錯誤報告後對其子項調用ITestInvocationListener#testLog
錯誤報告收集器.過濾器
錯誤報告收集器.Freq
錯誤報告收集器.名詞
錯誤報告收集器謂詞描述何時捕獲錯誤報告的完整謂詞。
錯誤報告收集器關係
錯誤報告收集器.SubPredicate
BugreportzOnFailureCollector當測試用例失敗時收集錯誤報告。
錯誤報告 zOnTestCaseFailureCollector當運行中的測試用例失敗時收集錯誤報告。
構建錯誤如果提供的構建無法運行,則拋出。
構建信息應與ITestDevice關聯的IBuildInfo的通用實現。
BuildInfoKey與構建信息查詢相關的類持有枚舉。
BuildInfoKey.BuildInfoFileKey描述可通過IBuildInfo.getFile(com.android.tradefed.build.BuildInfoKey.BuildInfoFileKey)查詢的所有已知文件類型的枚舉。
構建信息記錄器將構建信息元數據寫入指定文件的ITargetPreparer
BuildInfoUtil幫助操作IBuildInfo實用程序類
構建檢索錯誤檢索構建以進行測試時發生致命錯誤。
構建序列化版本包含所有IBuildInfo的當前序列化版本的類。
BuildTestsZipUtils一個幫助程序類,用於與 Android 構建系統生成的測試 zip 相關的操作
群發郵件允許以下配置的電子郵件發件人實用程序:發送間隔、初始突發大小、收件人和消息總數。
捆綁工具工具使用 bundletool 命令行在設備上安裝 .apks 的實用程序類。
字節數組輸入流源
字節數組列表一個表示輕量級字節數組的類。
字節數組工具對字節數組進行操作的實用程序,例如,將字節轉換為整數。

C

汽車模塊控制器該控制器可防止在非汽車設備上執行測試用例。
攜帶DNA錯誤通過JUnit4框架攜帶DeviceNotAvailableException內部ERROR(/RuntimeException)
攜帶中斷異常當觸發測試階段超時,需要將InterruptedException從測試執行線程攜帶到調用執行線程時拋出。
CdmaDeviceFlasher在具有 CDMA 收音機的物理 Android 設備上閃爍圖像的類。
CecControllerTokenProvider消費電子控制 (CEC) 相關令牌的令牌提供商。
中央目錄信息CentralDirectoryInfo 是一個包含 zip 文件中文件/文件夾信息的類。
檢查配對準備器一個CompanionAwarePreparer ,用於驗證主要設備和配套設備之間的 BT 綁定
CircularAtraceUtil atrace 實用程序主要用於在 Monkey 測試期間識別 ANR 的根本原因。
循環字節數組用於保存作為循環緩衝區運行的固定大小數組的數據結構,並跟踪數組中所有值的總和。
ClangCodeCoverageCollector一個BaseDeviceMetricCollector ,它將從設備中提取 Clang 覆蓋測量並將它們記錄為測試工件。
類未找到配置異常ConfigurationException用於當找不到對象的類時。
類路徑掃描器在類路徑中查找條目。
ClassPathScanner.ClassNameFilter過濾和轉換 java 類名的IClassPathFilter
ClassPathScanner.ExternalClassNameFilter拒絕內部類的ClassNameFilter
類路徑掃描儀.IClassPathFilter類路徑入口路徑的過濾器

FileFilter之後模式化

發條工具用於共享多設備邏輯的發條實用程序
CloseableTraceScope允許通過 try-with-resources 報告跟踪部分的作用域類
集群構建信息用於從 TFC 通過管道傳輸的構建的IBuildInfo類。
ClusterBuildProvider用於下載 TFC 測試資源的IBuildProvider
集群客戶端用於與 TFC 後端交互的IClusterClient實現。
集群命令表示從 TF 集群中獲取的任務的類。
ClusterCommand.RequestType
ClusterCommand.State命令在 TF 集群中的狀態。
ClusterCommandConfigBuilder為集群命令構建配置文件的類。
集群命令事件封裝要上傳的集群命令事件的類。
ClusterCommandEvent.Builder
ClusterCommandEvent.類型
ClusterCommandLauncher一個IRemoteTest類,用於通過子進程 TF 從 TFC 啟動命令。
ClusterCommandScheduler支持 TFC (Tradefed Cluster) 的ICommandScheduler
集群命令狀態代表來自 TF 集群的命令的狀態和取消原因的類。
集群設備信息封裝要上傳的集群設備信息的類。
ClusterDeviceInfo.Builder
集群設備監控器向 Tradefed 集群服務報告結果的IDeviceMonitor實施。
ClusterEventUploader <T extends IClusterEvent > ClusterEventUploader類,將IClusterEvent上傳到TFC。
集群主機事件封裝要上傳的集群主機事件的類。
ClusterHostEvent.Builder
ClusterHostEvent.HostEventType不同類型的主機事件的枚舉。
ClusterHostUtil TF Cluster 的靜態 util 函數,用於獲取全局配置實例、主機信息等。
ClusterLogSaver用於將測試輸出上傳到 TFC 的ILogSaver類。
ClusterLogSaver.FilePickingStrategy文件選擇策略。
集群選項
代碼覆蓋測試在給定設備上運行儀器測試包並生成代碼覆蓋率報告的測試。
收集字節輸出接收器將整個 shell 輸出收集到byte[]中的IShellOutputReceiver
收集輸出接收器一個IShellOutputReceiver ,它將整個 shell 輸出收集到一個ERROR(/String)中。
收集測試監聽器將收集所有測試結果的ITestInvocationListener
收集助手在幾個地方需要做一些IMetricCollector操作的助手。
命令文件解析器包含命令行集的文件的解析器。
CommandFileParser.CommandLine
命令中斷器允許中斷 TradeFederation 命令或將其標記為不可中斷的服務。
CommandLineBuildInfoBuilder實用程序旨在從命令行捕獲常用的構建信息參數並從中創建IBuildInfo
命令選項ICommandOptions的實施。
命令選項獲取器返回給定調用的命令選項值的服務實現。
命令結果包含命令的結果。
命令運行器將運行命令行參數中指定的命令然後退出的備用 TradeFederation 入口點。
CommandRunner.ExitCode可能退出的錯誤代碼。
命令調度器用於在所有可用設備上運行 TradeFederation 命令的調度程序。
CommandScheduler.HostState主機不同狀態的枚舉
命令狀態表示定時操作的狀態。
命令狀態處理器幫助監視和更新調用狀態的處理程序。
CommonLogRemoteFileUtil此實用程序允許避免代碼重複跨不同的遠程設備表示常見文件的遠程日誌提取邏輯。
CommonLogRemoteFileUtil.KnownLogFileEntry遠程設備的已知日誌條目的表示。
同伴分配器負責分配和釋放配套設備的基類

應該實施getCompanionDeviceSelectionOptions()來描述分配配套設備所需的標準

CompanionAware準備者一個ITargetPreparer ,它封裝了獲取已分配的配套設備的邏輯。
同伴意識測驗封裝獲取和檢查配套設備樣板的基礎測試類

子類可以調用getCompanion()來檢索分配的同伴。

配套設備追踪器用於分配和釋放配套設備的類
CompanionRunCommandTargetPreparer在分配的配套設備上運行指定命令的ITargetPreparer
CompanionTestAppInstallSetup一個ITargetPreparer ,它將IDeviceBuildInfo#getTestsDir()文件夾中的一個或多個應用程序安裝到分配的配套設備上。
CompileBootImageWithSpeedTargetPreparer使用編譯器過濾器“speed”重新編譯引導類路徑和系統服務器。
條件故障監視器監視調用是否有任何失敗。
條件優先級阻塞隊列<T>具有類似ERROR(/PriorityBlockingQueue)的操作的線程安全類,可以檢索符合特定條件的對象。
ConditionPriorityBlockingQueue.AlwaysMatch <T>匹配任何對象的ConditionPriorityBlockingQueue.IMatcher
ConditionPriorityBlockingQueue.IMatcher <T>用於確定元素是否匹配某種條件的接口。
配置完成器為我們的 TF 配置實施Completer
配置將加載的配置對象存儲在映射中的具體IConfiguration實現。
配置定義保存配置、其關聯對象及其選項的記錄。
ConfigurationDef.ConfigObjectDef保存類名信息及其外觀編號的對象(例如,如果一個配置兩次具有相同的對象,則第一個將具有第一個外觀編號)。
配置描述符描述配置本身某些方面的配置對象。
配置描述符.LocalTestRunner用於指示本地測試運行器的枚舉。
配置異常如果無法加載配置則拋出。
配置工廠用於創建IConfiguration工廠。
配置工廠.ConfigLoader IConfigDefLoader的實現,它從一個根配置跟踪包含的配置,並在循環包含時拋出異常。
配置工廠.ExceptionLoader
配置工具處理配置文件的實用函數。
配置XmlParserSettings接受 ConfigurationXmlParser 設置的簡單類

要將設置傳遞給此類,別名是必需的。

配置 YamlParser YAML 樣式 Tradefed 配置的解析器
配置工具用於創建、交互和推送 statsd 配置文件的實用程序類。
安慰TradeFederation 主控制台為用戶提供交互界面

目前支持操作如

  • 添加命令進行測試
  • 列出設備及其狀態
  • 列出正在進行的調用
  • 列出隊列中的命令
  • 將調用日誌轉儲到文件/stdout
  • 關閉
控制台.ArgRunnable <T>帶有可以帶參數的run方法的ERROR(/Runnable)
控制台.CaptureList List<List<String>>的便利類型
ConsoleReaderOutputStream一個 OutputStream,可用於使System.out.print()與用戶的LineReader unfinishedLine 配合得很好。
控制台結果報告器結果報告器將測試結果打印到控制台。
ContentProvider處理程序抽象內容提供者交互並允許使用設備端內容提供者進行不同操作的處理程序。
計數測試結果監聽器通過TestStatus跟踪測試總數的TestResultListener
計數測試用例收集器計算並報告給定IRemoteTest測試用例數。
覆蓋測量轉發器將覆蓋測量從構建提供程序轉發到記錄器的佔位符測試。
覆蓋選項Tradefed 反對持有覆蓋選項。
CoverageOptions.工具鏈
CpuThrottlingWaiter ITargetPreparer等待所有內核的最大頻率恢復到可用的最高級別
創建AvdPreparer
創建用戶準備者用於創建用戶並在最後清理它的目標準備器。
當前調用一個跟踪並提供當前調用信息的類,該信息在調用內部的任何地方都很有用。
CurrentInvocation.InvocationInfo我們將始終為調用填充的一些特殊命名鍵。
CurrentInvocation.IsolationGrade描述隔離級別

DebugHostLogOnFailureCollector發生測試用例失敗時收集並記錄主機端日誌的收集器。
默認連接設備的默認連接表示,假定為設備的標準 adb 連接。
默認連接.ConnectionBuilder Builder 用於描述連接。
默認遠程AndroidTestRunner ddmlib RemoteAndroidTestRunner的擴展,用於為 Tradefed 用例設置一些默認值。
DefaultTestsZipInstaller測試 zip 安裝程序的默認實現。
委託調用執行InvocationExecution將執行委託給另一個 Tradefed 二進製文件。
依賴解析器一種新型提供程序,允許獲取測試的所有依賴項。
設備分配結果表示命令分配嘗試的結果。
設備分配狀態從 IDeviceManager 角度表示設備的分配狀態
設備可用檢查器檢查器以確保模塊不會使設備處於離線狀態。
設備基線檢查器在每個模塊之前設置設備基線設置。
設備基線設定器用於創建設備基線設置的抽像類。
DeviceBatteryLevelChecker IRemoteTest檢查最低電池電量,如果不存在最低電量,則等待電池達到第二個充電閾值。
DeviceBatteryResourceMetricCollector此收集器收集設備電池指標。
設備構建描述符IBuildInfo的包裝類,其中包含用於檢索設備平台構建信息的輔助方法。
設備構建信息代表完整 Android 設備構建和(可選)其測試的IBuildInfo
DeviceBuildInfoBootStrapper用從設備讀取的屬性替換構建信息字段的ITargetPreparer

這對於測試具有從外部源生成的構建的設備很有用(例如

DeviceBuildInfoInjectorDeviceBuildDescriptor元數據插入IBuildInfo ITargetPreparer
設備清理器在測試後執行重啟或格式化作為清理操作,並可選擇關閉屏幕
DeviceCleaner.CleanupAction
DeviceCleaner.PostCleanupAction
DeviceConcurrentUtil包含用於並發設備端命令執行的實用方法和類

使用ERROR(/ExecutorService)運行作為ShellCommandCallable實現的命令,並使用ERROR(/#joinFuture(String,Future,long))ERROR(/ExecutorService)返回的 ERROR ERROR(/Future)同步以執行命令。

DeviceConcurrentUtil.ShellCommandCallable <V>一個ERROR(/Callable)包裝了在ITestDevice上執行 shell 命令的細節。
設備配置持有人將加載的設備配置對象存儲在其屬性中的具體IDeviceConfiguration實現。
設備描述符包含描述被測設備的信息的類。
設備斷開異常當設備不再可通過其傳輸類型訪問時拋出,例如,如果設備不再通過 USB 或 TCP/IP 連接可見
設備錯誤標識符來自設備錯誤和設備報告錯誤的錯誤標識符。
設備啟動失敗錯誤如果設備在使用構建刷新後無法啟動,則拋出。
設備功能模塊控制器不支持某些功能時不運行測試的模塊控制器。
設備文件報告器一個實用程序類,用於檢查設備中的文件並將它們發送到ITestInvocationListener#testLog(String, LogDataType, InputStreamSource)如果找到)。
DeviceFlashPreparer在物理 Android 硬件上閃爍圖像的ITargetPreparer
設備可折疊狀態“cmd device_state print-states”返回的設備可折疊狀態的表示。
設備文件夾構建信息一個IDeviceBuildInfo ,它還包含本地文件系統目錄中包含的其他構建工件。
DeviceImageZipFlashingTargetPreparer一個目標準備器,它使用通過特定格式提供的設備映像刷新設備。
DeviceInternetAccessibilityResourceMetricCollector收集器 ping google.com 以檢查設備是否可以訪問互聯網。
DeviceJUnit4ClassRunner也適用於IDeviceTest JUnit4 測試運行器。
DeviceJUnit4ClassRunner.LogAnnotation假注意在向記者攜帶日誌。
DeviceJUnit4ClassRunner.MetricAnnotation虛假註釋意味著向記者提供指標。
DeviceJUnit4ClassRunner.TestLogData ExternalResourceTestRule的實現。
DeviceJUnit4ClassRunner.TestMetrics ExternalResourceTestRule的實現。
設備管理GrpcServer GRPC 服務器允許從 Tradefed 保留設備。
裝置經理
DeviceManager.FastbootDevice Fastboot 模式下設備的表示。
設備指標數據用於保存指標收集器收集的所有數據的對象。
DeviceMonitor多路復用器將請求傳播到多個IDeviceMonitor代理類。
DeviceNotAvailableException當設備不再可用於測試時拋出。
設備所有者目標準備者設置設備所有者組件的ITargetPreparer
設備參數化運行器JUnit4 風格的參數化運行器,用於主機端驅動的參數化測試。
設備屬性設備端屬性名稱的通用常量定義
DeviceRecoveryModeUtil
DeviceReleaseReporter處理與父進程通信的設備發布報告器處理要發布的設備。
設備重置功能設備重置的服務器端實現。
設備重置處理程序一般處理設備重置的實用程序。
設備運行時異常當設備操作未產生預期結果時拋出。
設備選擇選項設備選擇標準的容器。
DeviceSelectionOptions.DeviceRequestedType支持的不同可能類型的佔位符設備。
設備設置檢查器檢查模塊運行期間設備設置是否已更改。
設備設置一個ITargetPreparer ,它根據提供的Option配置設備進行測試。
設備狀態監視器用於監視IDevice狀態的輔助類。
DeviceStorageAgeResourceMetricCollector從 logcat 解析存儲年齡。
設備存儲填充器目標準備器填滿存儲空間,以便有一些可用空間可用。
設備存儲狀態檢查器檢查設備是否有足夠的磁盤空間用於給定的分區。
設備字符串推送器目標準備器將字符串寫入文件。
設備套件擴展 JUnit4 容器Suite ,以便為需要它的測試提供ITestDevice
設備同步助手幫助將新設備映像同步到設備的助手。
設備測試用例提供IRemoteTestIDeviceTest服務的 Helper JUnit 測試用例。
設備測試結果TestResult的特化,當DeviceNotAvailableException發生時將中止
DeviceTestResult.RuntimeDeviceNotAvailableException
設備測試運行選項與通過 BaseHostJUnit4Test 運行設備測試相關的選項的構建器類。
設備測試套件提供IRemoteTestIDeviceTest服務的 Helper JUnit 測試套件。
設備跟踪收集器收集器將在測試運行開始時啟動 perfetto trace 並在結束時記錄跟踪文件。
設備不可用監視器此偵聽器僅嘗試捕獲測試用例級別的 DNAE。
設備無響應異常DeviceNotAvailableException的特化,指示設備對 adb 可見,但沒有響應(即命令超時、無法啟動等)
設備更新目標準備器一個抽象的ITargetPreparer ,它負責使用來自外部源(與構建服務相對)的設備映像文件更新設備的常見步驟。
DeviceWifiResourceMetricCollector收集器收集當前連接的 wifi 信號強度和鏈接速度指標。
設備刮水器擦除用戶數據的ITargetPreparer
有向圖<V>有向未加權圖的實現。
禁用 SELinuxTargetPreparer如果啟用,則禁用 SELinux 的目標準備器。
DryRunKeyStore用於試運行的密鑰庫,其中始終正確替換和找到任何密鑰庫值。
幹流器透明地試運行測試而不是實際執行它們。
動態文件存根測試這是一個 tradefed 測試,用於測試 tradefed 是否可以正確解析動態文件。
動態遠程文件解析器幫助解析遠程文件路徑的類。
DynamicRemoteFileResolver.FileResolverLoader加載IRemoteFileResolver的實現。
動態系統準備器一個ITargetPreparer ,它在使用動態系統更新構建的設備之上設置系統映像。

早期設備發布功能用於早期設備發布的功能服務器實現。
電子郵件發送電子郵件的助手類。
電子郵件主機健康代理用於從主機監視器報告發送電子郵件的IHostHealthAgent實現
EmmaXml 常量解析 emma xml 報告時使用的常量。
模擬器內存CpuCapturer
結束中央目錄信息EndCentralDirectoryInfo 是一個包含 zip 文件的整體信息的類。
EnforcedSeLinuxChecker確保 Selinux 狀態的狀態檢查器。
擦除用戶數據準備者擦除設備上的用戶數據的ITargetPreparer
錯誤標識符此接口描述特定錯誤及其屬性。
錯誤存儲工具用於處理錯誤以與公共存儲對齊的輔助類。
事件記錄器監聽器將接收到的所有事件記錄到文件中的偵聽器
ExceptionThrowingRunnerWrapper
可執行基礎測試可執行測試樣式的基類。
可執行主機測試在主機上運行的可執行文件的測試運行器。
可執行目標測試在目標上運行的可執行文件的測試運行器。
執行文件測試或調用執行過程中產生的文件依賴,需要攜帶進行測試。
ExecutionFiles.FilesKey地圖已知標準鍵的枚舉。
執行屬性在執行測試或調用期間生成的屬性。
現有構建提供者返回已構建的IBuildInfo IBuildProvider
擴展文件標准文件的擴展,用於攜帶構建相關的元數據。

F

故障描述描述 Trade Federation 中的失敗信息的類。
假測試一種假測試,其目的是輕鬆生成可重複的測試結果。
假測試 Zip 文件夾一個測試裝置,它根據內容列表創建一個假的解壓縮測試文件夾。
FakeTestsZipFolder.ItemType
FastbootCommandPreparer觸發 fastboot 並發送 fastboot 命令的目標準備器。
FastbootDeviceFlasher依賴 fastboot 在物理 Android 硬件上刷新圖像的類。
快速啟動助手用於快速啟動操作的輔助類。
FastbootUpdateBootstrapPreparer一個ITargetPreparer將指定文件(引導加載程序、無線電、設備映像 zip)暫存到IDeviceBuildInfo中以使用FastbootDeviceFlasher刷新設備,然後將啟動後設備屬性注入構建信息以用於結果報告目的。
致命主機錯誤指示運行 TradeFederation 的主機上發生了致命的不可恢復錯誤的異常,應關閉 TradeFederation 實例。
FeatureFlagTargetPreparer更新 DeviceConfig(由遠程服務調整的功能標誌)。
文件下載緩存維護下載文件的本地文件系統 LRU 緩存的輔助類。
文件下載緩存工廠用於創建FileDownloadCache工廠
文件下載緩存包裝器一個包裝類,它在實現IFileDownloader接口時提供FileDownloadCache設施。
文件空閒監視器監視文件並在它們空閒時執行回調(即
文件輸入流源採用輸入文件的InputStreamSource
文件記錄器ILeveledLogOutput將日誌消息定向到文件和標準輸出。
FileProtoResultReporterTestRecord轉儲到文件中的原型記者。
FilePullerDeviceMetricCollector一個BaseDeviceMetricCollector ,它偵聽來自設備的指標鍵並將它們作為文件從設備中提取。
FilePuller日誌收集器設備端上報文件的Logger。
文件系統日誌保存器將日誌保存到文件系統。
文件工具文件相關操作的輔助類
FileUtil.HarnessIOException 異常利用有助於攜帶文件問題的異常。
FileUtil.LowDiskSpaceException如果可用磁盤空間低於最小閾值則拋出。
FilteredResultForwarder ResultForwarder的變體,它只允許報告TestDescription的白名單。
固定字節數組輸出流僅保留最大數據量的內存中ERROR(/OutputStream)
閃爍方法描述用於閃存被測設備的方法的枚舉
FlashingResourcesParser一個解析出閃存設備所需的輔助圖像文件所需版本的類。
FlashingResourcesParser.AndroidInfo A typedef for Map&lt;String, MultiMap&lt;String, String&gt;&gt; .
FlashingResourcesParser.Constraint A filtering interface, intended to allow FlashingResourcesParser to ignore some resources that it otherwise might use
FlashingResourceUtil This utility helps setting the appropriate version of artifacts so they can be flashed via DeviceFlashPreparer .
FoldableExpandingHandler A IModuleParameterHandler expanding into more for each non-primary foldable configuration.
FoldableHandler Generic foldable handler that can take the foldable parameters to create a specialized module.
FoldableModePreparer A target preparer that can switch the foldable state of a device.
FolderBuildInfo Concrete implementation of a IFolderBuildInfo .
FolderSaver A ITargetPreparer that pulls directories off device, compresses and saves it into logging backend.
FormattedGeneratorReporter Reporter that allows to generate reports in a particular format.
FreeDeviceState
FuseUtil A helper class for FUSE operations.

G

GceAvdInfo Structure to hold relevant data for a given GCE AVD instance.
GceAvdInfo.GceStatus
GceAvdInfo.LogFileEntry
GceManager Helper that manages the GCE calls to start/stop and collect logs from GCE.
GceRemoteCmdFormatter Utility class to format commands to reach a remote gce device.
GceRemoteCmdFormatter.ScpMode SCP can be used to push or pull file depending of the structure of the args.
GceSshTunnelMonitor Thread Monitor for the Gce ssh tunnel.
GcovCodeCoverageCollector A BaseDeviceMetricCollector that will pull gcov coverage measurements off of the device and log them as test artifacts.
GcovKernelCodeCoverageCollector A BaseDeviceMetricCollector that will pull gcov kernel coverage measurements out of debugfs and off of the device and then finally logs them as test artifacts.
GCSBucketUtil File manager to download and upload files from Google Cloud Storage (GCS).
GCSBucketUtil.GCSFileMetadata Simple wrapper for file info in GCS.
GCSCommon Base class for Gcs operation like download and upload.
GCSConfigurationFactory A ConfigurationFactory loads configs from Google Cloud Storage.
GCSConfigurationFactory.GCSConfigLoader Extension of ConfigurationFactory.ConfigLoader that loads config from GCS, tracks the included configurations from one root config, and throws an exception on circular includes.
GCSConfigurationServer Config server loads configs from Google Cloud Storage (GCS).
GCSDownloaderHelper Downloader for GCS bucket that takes care of caching and resolving the global config.
GCSFileDownloader File downloader to download file from google cloud storage (GCS).
GCSFileUploader File uploader to upload file data to google cloud storage (GCS).
GCSHostResourceManager Download host resource from GCS (Google cloud storage).
GcsRemoteFileResolver Implementation of IRemoteFileResolver that allows downloading from a GCS bucket.
GenericLogcatEventParser <LogcatEventType> Parse logcat input for events.
GenericLogcatEventParser.LogcatEvent Struct to hold a logcat event with the event type and triggering logcat message
GetPreviousPassedHelper Helper to get the previous passed test filters.
GkiDeviceFlashPreparer A target preparer that flash the device with android common kernel generic image.
GlobalConfiguration An IGlobalConfiguration implementation that stores the loaded config objects in a map
GlobalFilterGetter Service implementation that returns the filters of a given invocation.
GlobalTestFilter Filter options applied to the invocation.
GoogleApiClientUtil Utils for create Google API client.
GoogleBenchmarkResultParser Parses the results of Google Benchmark that run from shell, and return a map with all the results.
GoogleBenchmarkTest A Test that runs a Google benchmark test package on given device.
GranularRetriableTestWrapper A wrapper class works on the IRemoteTest to granulate the IRemoteTest in testcase level.
GranularRetriableTestWrapper.StartEndCollector Class helper to catch missing run start and end.
GsiDeviceFlashPreparer A target preparer that flashes the device with android generic system image.
GTest A Test that runs a native test package on given device.
GTestBase The base class of gTest
GTestListTestParser A result parser for gtest dry run mode with "--gtest_list_tests" parameter.
GTestResultParser Parses the 'raw output mode' results of native tests using GTest that run from shell, and informs a ITestInvocationListener of the results.
GTestXmlResultParser Parses the 'xml output mode' results of native tests using GTest that run from shell, and informs a ITestRunListener of the results.

H

HarnessException Base exception class for exception thrown within the harness.
HarnessRuntimeException
HeapHostMonitor AbstractHostMonitor implementation that monitors the heap memory on the host and log it periodically to the history log.
HelloWorldMultiTargetPreparer An example implementation of a IMultiTargetPreparer .
HistoryLogger TF History Logger,只包含一些特定事件的特殊日誌。
HostGTest A Test that runs a native test package.
HostMetric This class represents a host metric sample to be reported.
HostOptions Host options holder class.
HostStatsdMetricCollector A IMetricCollector that collects statsd metrics from host side using statsd utility commands.
HostTest A test runner for JUnit host based tests.
HostUtils Implements some useful utility methods for running host tests.
HprofAllocSiteParser Helper class to parse info from an Allocation Sites section of hprof reports.
HttpHelper Contains helper methods for making http requests
HttpHelper.RequestRunnable Runnable for making requests with IRunUtil#runEscalatingTimedRetry(long, long, long, long, IRunnableResult) .
HttpMultipartPost Helper class for making multipart HTTP post requests.
HttpRemoteFileResolver Implementation of IRemoteFileResolver that allows downloading remote file via http
HttpsRemoteFileResolver Implementation of IRemoteFileResolver that allows downloading remote file via https

I

IAbi Interface representing the ABI under test.
IAbiReceiver A test that needs the ABI under test.
IAndroidDebugBridge Interface definition for AndroidDebugBridge methods used in this package.
IAppBuildInfo This interface is deprecated. Use IBuildInfo directly.
IAutoRetriableTest Interface for an IRemoteTest that doesn't implement ITestFilterReceiver but still wishes to support auto-retry.
IBatteryInfo The interface defining the interaction with a battery of a device.
IBatteryInfo.BatteryState Describes the current battery charging state.
IBuildInfo Holds information about the build under test.
IBuildInfo.BuildInfoProperties Some properties that a IBuildInfo can have to tweak some handling of it.
IBuildProvider Responsible for providing info regarding the build under test.
IBuildReceiver A test that needs reference to the build under test.
IClusterClient An interface for interacting with the TFC backend.
IClusterEvent Interface for any cluster event to be uploaded to TFC.
IClusterEventUploader <T extends IClusterEvent > Interface for ClusterEventUploader
IClusterOptions An interface for getting cluster-related options.
ICommandOptions Container for execution options for commands.
ICommandScheduler A scheduler for running TradeFederation commands.
ICommandScheduler.IScheduledInvocationListener Listener for invocation events when invocation completes.
ICompressionStrategy An interface representing a compression algorithm that can be selected at runtime.
IConfigOptionValueTransformer An interface for manipulating config option value
IConfigurableVirtualDevice An interface to provide information about a possibly preconfigured virtual device info (host ip, host user, ports offset and etc.).
IConfiguration Configuration information for a TradeFederation invocation.
IConfigurationFactory Factory for creating IConfiguration s
IConfigurationReceiver Simple interface to represent object that accepts an IConfiguration .
IConfigurationServer An interface for config server.
ICredentialFactory An interface for credential factory to create oauth2 Credential .
IDefaultObjectLoader Interface for loading the default objects that should be part of our YAML configuration.
IDefaultObjectLoader.LoaderConfiguration The loading configuration object to pass information to the loader.
IDeviceActionReceiver Provides an API to receive device events.
IDeviceBuildInfo A IBuildInfo that represents a complete Android device build and (optionally) its tests.
IDeviceBuildProvider A IBuildProvider that uses information from a ITestDevice to retrieve a build.
IDeviceConfiguration Device Configuration Holder Interface.
IDeviceFlasher Flashes a device image on a device.
IDeviceFlasher.UserDataFlashOption Enum of options for handling the userdata image
IDeviceManager Interface for managing the set of available devices for testing.
IDeviceManager.IFastbootListener A listener for fastboot state changes.
IDeviceMonitor Interface for monitoring state of devices.
IDeviceMonitor.DeviceLister A ERROR(/Runnable) -like class that should return the known devices and their states.
IDeviceRecovery Interface for recovering a device that has gone offline.
IDeviceSelection Interface for device selection criteria.
IDeviceSelection.BaseDeviceType
IDeviceStateMonitor Provides facilities for monitoring the state of a IDevice .
IDeviceTest Interface for object that needs a reference to a ITestDevice .
IDisableable Interface that describes a Tradefed object that can be disabled.
IEmail Interface for sending email.
IEmail.Message Container for email message data.
IFileDownloader Interface for downloading a remote file.
IFileEntry Interface definition that provides simpler, mockable contract to FileEntry methods.
IFileResolverLoader Loads implementations of IRemoteFileResolver .
IFileResolverLoader.ResolverLoadingException Exception thrown if a resolver cannot be loaded or initialized.
IFlashingResourcesParser Interface for providing required versions of auxiliary image files needed to flash a device.
IFlashingResourcesRetriever Interface for retrieving auxiliary image files needed to flash a device.
IFolderBuildInfo A simple abstract IBuildInfo whose build artifacts are containing in a local filesystem directory.
IFormatterGenerator Interface describing a formatter for SuiteResultHolder .
IGlobalConfiguration A class to encompass global configuration information for a single Trade Federation instance (encompassing any number of invocations of actual configurations).
IHarnessException Description of the harness exception interface that will be implemented by harness exceptions.
IHostCleaner Cleans up the host after the test run has finished.
IHostHealthAgent An interface to emit host or device metrics.
IHostMonitor Interface to dispatch host data
IHostMonitor.HostDataPoint Generic class for data to be reported.
IHostMonitor.HostMetricType
IHostOptions Host options holder interface.
IHostOptions.PermitLimitType Enum describing the possible permit limiters
IHostResourceManager Interface to manager host resource.
IHttpHelper Helper methods for performing http requests.
IHttpHelper.DataSizeException
IInvocationContext Holds information about the Invocation for the tests to access if needed.
IInvocationContext.TimingEvent
IInvocationContextReceiver A test that needs reference to the context of the invocation.
IInvocationExecution Interface describing the actions that will be done as part of an invocation.
IKeyStoreClient Interface to access a key store for password or sensitive data.
IKeyStoreFactory Factory for creating IKeyStoreClient .
ILabPreparer Marker interface for lab preparers

See ITargetPreparer for a description of what these interfaces are intended.

ILeveledLogOutput Classes which implement this interface provides methods that deal with outputting log messages.
ILogcatReceiver A class that provides the output of a device's logcat as an InputStreamSource .
ILogRegistry An interface for a ILogOutput singleton logger that multiplexes and manages different loggers.
ILogRegistry.EventType Events that are useful to be logged
ILogSaver Classes which implement this interface provide methods for storing logs to a central location.
ILogSaverListener Allows for ITestInvocationListener s to listen for when log files are saved.
IManagedTestDevice A ITestDevice whose lifecycle is managed.
IManagedTestDevice.DeviceEventResponse Container for a response to a IManagedTestDevice#handleAllocationEvent(DeviceEvent) call
IManagedTestDeviceFactory Creator interface for IManagedTestDevice s
IMetricCollector This interface will be added as a decorator when reporting tests results in order to collect matching metrics.
IMetricCollectorReceiver Interface for IRemoteTest s to implement if they need to get the list of IMetricCollector s for the test run.
IMoblyYamlResultHandler Interface of mobly yaml result handler.
IMoblyYamlResultHandler.ITestResult Interface of mobly yaml result
IModuleController Interface for controlling if a module should be executed or not.
IModuleController.RunStrategy Enum describing how the module should be executed.
IModuleParameterHandler The interface for parameters of suites modules.
IMultiDeviceRecovery Interface for recovering multiple offline devices.
IMultiDeviceTest This interface is deprecated. This interface is kept temporarily for compatibility but is not actually used anymore. Please do not implement it.
IMultiTargetPreparer Prepares the test environment for several devices together.
INativeDevice Provides an reliable and slightly higher level API to a ddmlib IDevice .
INativeDeviceTest Interface for object that needs a reference to a INativeDevice .
InfraErrorIdentifier Error Identifiers from Trade Federation infra, and dependent infra (like Build infra).
InputStreamSource This interface basically wraps an ERROR(/InputStream) to make it clonable.
InstallAllTestZipAppsSetup A ITargetPreparer that installs all apps in a test zip.
InstallApexModuleTargetPreparer
InstallApkSetup A ITargetPreparer that installs one or more apks located on the filesystem.
InstallBuildEnvApkSetup A ITargetPreparer that installs one or more test apks from an Android platform build env.
InstalledInstrumentationsTest Runs all instrumentation found on current device.
InstantAppHandler Handler for ModuleParameters#INSTANT_APP .
InstrumentationPreparer A ITargetPreparer that runs instrumentation
InstrumentationTest A Test that runs an instrumentation test package on given device.
InvocationContext Generic implementation of a IInvocationContext .
InvocationExecution Class that describes all the invocation steps: build download, target_prep, run tests, clean up.
InvocationLocal <T> This class provides invocation-scope variables.
InvocationMetricLogger A utility class for an invocation to log some metrics.
InvocationMetricLogger.InvocationGroupMetricKey Grouping allows to log several groups under a same key.
InvocationMetricLogger.InvocationMetricKey Some special named key that we will always populate for the invocation.
InvocationStatus A class to store invocation status.
InvocationStatus A helper enum to represent the invocation status
InvocationSummaryHelper Helper class for gathering and reporting TestSummary for set of listeners
InvocationToJUnitResultForwarder A class that listens to ITestInvocationListener events and forwards them to a TestListener .
IPostProcessor Post processors is a Trade Federation object meant to allow the processing of metrics and logs AFTER the tests and BEFORE result reporting.
IRemoteFeature Interface describing a feature in Tradefed that can be executed based on the request.
IRemoteFileResolver Interface for objects that can resolve a remote file into a local one.
IRemoteFileResolver.RemoteFileResolverArgs The args passed to the resolvers
IRemoteFileResolver.ResolvedFile Class holding information about the resolved file and some metadata.
IRemoteScheduledListenersFeature Extension of IRemoteFeature to support passing in IScheduledInvocationListener s.
IRemoteTest A test that reports results directly to a ITestInvocationListener .
IReportNotExecuted In case of an incomplete execution, IRemoteTest that implements this interface may report their non-executed tests for improved reporting.
IRescheduler Interface for rescheduling a config for future execution.
IResourceMetricCollector The interface for user to implement customized resource collectors.
IRestApiHelper A helper interface for performing REST API calls.
IResumableTest This interface is deprecated. No need for this anymore
IRetryDecision Interface driving the retry decision and applying the filter on the class for more targeted retry.
IRuntimeHintProvider
IRunUtil Interface for running timed operations and system commands.
IRunUtil.EnvPriority Enum that defines whether setting or unsetting a particular env.
IRunUtil.IRunnableResult An interface for asynchronously executing an operation that returns a boolean status.
ISandbox Interface defining a sandbox that can be used to run an invocation.
ISandboxFactory Factory for creating ISandbox .
ISetOptionReceiver Implementation of this interface should have an Option with a "set-option" name linked to HostTest#SET_OPTION_NAME .
IShardableListener A ITestInvocationListener that can be sharded.
IShardableTest A IRemoteTest that can be split into separately executable sub-tests.
IShardHelper Interface of an object that describes the sharding strategy to adopt for a configuration.
IsolatedHostTest Implements a TradeFed runner that uses a subprocess to execute the tests in a low-dependency environment instead of executing them on the main process.
ISupportGranularResults Interface specifying whether a ITestInvocationListener supports receiving the granular results or not.
ISystemStatusChecker An checker that performs checks on system status and returns a boolean to indicate if the system is in an expected state.
ISystemStatusCheckerReceiver A IRemoteTest that requires access to the ISystemStatusChecker from the configuration.
ITargetCleaner This interface is deprecated. tearDown has been moved to the base ITargetPreparer interface.
ITargetPreparer Prepares the test environment for the test run.
ITerribleFailureHandler An interface to handle terrible failures from LogUtil.CLog.wtf(String, Throwable)
ITestAnnotationFilterReceiver A runner that can filter which tests to run based on annotations.
ITestCollector Provides support for test collection; when set, test runner must perform a dry run to collect test cases without actually executing them.
ITestDevice Provides an reliable and slightly higher level API to a ddmlib IDevice .
ITestDevice.ApexInfo A simple struct class to store information about a single APEX
ITestDevice.MountPointInfo A simple struct class to store information about a single mountpoint
ITestDevice.RecoveryMode
ITestFileFilterReceiver A runner that can receive a file specifying which tests to run and/or not to run.
ITestFilterReceiver A runner that can filter which tests to run.
ITestInformationReceiver Interface to receive the TestInformation for some classes.
ITestInvocation Handles one TradeFederation test invocation.
ITestInvocation.ExitInformation Represents some exit information for an invocation.
ITestInvocationListener Listener for test results from the test invocation.
ITestLifeCycleReceiver Receives event notifications during instrumentation test runs.
ITestLogger An entity that can perform logging of data streams of various types.
ITestLoggerReceiver An entity that can be injected with an ITestLogger instance so that it can be used for logging purposes.
ITestsPool Interface describing a pool of tests that we can access and run
ITestSuite Abstract class used to run Test Suite.
ITestSuite.MultiDeviceModuleStrategy
ITestSuiteResultLoader Interface describing an helper to load previous results in a way that can be re-run.
ITestSummaryListener Interface that allows ITestInvocationListener to exchange some limited information via summaries.
ITestsZipInstaller Installs tests from a tests zip file (as outputted by the build system) on a device.
ITokenProvider Interface describing an object that can provide the tokens of a particular device.
ITokenRequest Interface a IRemoteTest can implement to expose the fact that it requires a device with a special token.

J

JarHostTest Test runner for host-side JUnit tests.
JarHostTest.HostTestListener Wrapper listener that forwards all events except testRunStarted() and testRunEnded() to the embedded listener.
JavaCodeCoverageCollector A BaseDeviceMetricCollector that will pull Java coverage measurements off of the device and log them as test artifacts.
JavaCodeCoverageFlusher A utility class that resets and forces a flush of Java code coverage measurements from processes running on the device.
JSONFileKeyStoreClient A sample implementation where a local JSON file acts a key store.
JSONFileKeyStoreFactory Implementation of a JSON KeyStore Factory, which provides a JSONFileKeyStoreClient for accessing a JSON Key Store File.
JsonHttpTestResultReporter A result reporter that encode test metrics results and branch, device info into JSON and POST into an HTTP service endpoint
JUnit4ResultForwarder Result forwarder from JUnit4 Runner.
JUnit4TestFilter Helper Class that provides the filtering for JUnit4 runner by extending the Filter .
JUnitRunUtil A helper class for directing a IRemoteTest#run(TestInformation, ITestInvocationListener) call to a Test#run(TestResult) call.
JUnitToInvocationResultForwarder A class that listens to TestListener events and forwards them to an ITestInvocationListener .
JUnitXmlParser Parser that extracts test result data from JUnit results stored in ant's XMLJUnitResultFormatter and forwards it to a ITestInvocationListener.

K

KeyguardControllerState A container for the keyguard states.
KeyguardStatusChecker Checks the keyguard status after module execution.
KeyStoreException Thrown when a fatal key store error happens.
KillExistingEmulatorPreparer A ITargetPreparer that shuts down a running emulator.
KnownFailurePreparer Target preparer to skip retrying known failure.

L

LabResourceDeviceMonitor The lab resource monitor which initializes/manages the gRPC server for LabResourceService.
LargeOutputReceiver A class designed to help run long running commands collect output.
LastShardDetector When running local sharding, sometimes we only want to execute some actions when the last shard reaches invocationEnded(long) .
LaunchCvdHelper Utility helper to control Launch_cvd in the Cuttlefish VM.
LeakedThreadStatusChecker Status checker to ensure a module does not leak a running Thread.
LegacySubprocessResultsReporter A frozen implementation of the subprocess results reporter which should remain compatible with earlier versions of TF/CTS (eg 8+), despite changes in its superclass.
ListInstrumentationParser A IShellOutputReceiver that parses the output of a 'pm list instrumentation' query
ListInstrumentationParser.InstrumentationTarget
LocalAndroidVirtualDevice The class for local virtual devices running on TradeFed host.
LocalAppBuildProvider A IBuildProvider that constructs a IBuildInfo based on a provided local path
LocalDeveloper Detects and returns whether this is a local developer running Tradefed.
LocalDeviceBuildProvider A IBuildProvider that constructs a IDeviceBuildInfo based on a provided filesystem directory path.
LocalEmulatorLaunch A TargetPreparer that launches an emulator locally from an android build environment.
LocalEmulatorSnapshot A TargetPreparer intended for generating a clean emulator snapshot from a android build/development environment
LocalFileHeader LocalFileHeader is a class containing the information of a file/folder inside a zip file.
LocalFileResolver Implementation of IRemoteFileResolver that allows linking local files
LocalFolderBuildProvider A IBuildProvider that constructs a IFolderBuildInfo based on a provided local path
LocalHostResourceManager Manager host resource.
LocalPool Implementation of a pool of local tests
LocalRunInstructionBuilder Utility to compile the instruction to run test locally.
LockSettingsBaselineSetter A setter to remove screen lock settings.
LogcatCrashResultForwarder Special listener: on failures (instrumentation process crashing) it will attempt to extract from the logcat the crash and adds it to the failure message associated with the test.
LogcatEventParser
LogcatEventType Event types for LogcatEventParser .
LogcatOnFailureCollector Collector that will capture and log a logcat when a test case fails.
LogcatReceiver Class that collects logcat in background.
LogcatTimingMetricCollector A metric collector that collects timing information (eg user switch time) from logcat during one or multiple repeated tests by using given regex patterns to parse start and end signals of an event from logcat lines.
LogDataType Represents the data type of log data.
LogFile Class to hold the metadata for a saved log file.
LogFileSaver A helper for ITestInvocationListener 's that will save log data to a file
LogReceiver
LogRegistry A ILogRegistry implementation that multiplexes and manages different loggers, using the appropriate one based on the ERROR(/ThreadGroup) of the thread making the call.
LogSaverResultForwarder A ResultForwarder for saving logs with the global file saver.
LogUtil A logging utility class.
LogUtil.CLog A shim class for Log that automatically uses the simple classname of the caller as the log tag

M

MainlineModuleHandler A simple handler class for Mainline Modules that creates a InstallApexModuleTargetPreparer and injects the dynamic link into it based on the given mainline modules to automatically retrieve those modules.
MainlineTestModuleController Base class for a module controller to run tests based on the preloaded mainline modules on the device under test.
ManagedRemoteDevice A device running inside a virtual machine that we manage remotely via a Tradefed instance inside the VM.
ManagedTestDeviceFactory Factory to create the different kind of devices that can be monitored by Tf
MaxSdkModuleController Base class for a module controller to not run tests on versions above a specified SDK version number.
MergedZipEntryCollection Merge individual zip entries in a large zip file into blocks to minimize the download attempts.
MergeMultiBuildTargetPreparer A IMultiTargetPreparer that allows to pass information from one build to another by naming them and the file key to copy to the other build.
MergeStrategy Describes how the results should be aggregated when multiple attempts are present.
MetricFilePostProcessor Used for uploading the metrics log file collected during the test and run level.
MetricOption Annotation for test methods annotated with @Test , or if the annotation is part of the annotation list of TestDescription that allows to specify some extra parameters useful for: Tuning the behavior of the collectors, filtering some methods.
MetricsXMLResultReporter MetricsXMLResultReporter writes test metrics and run metrics to an XML file in a folder specified by metrics-folder parameter at the invocationEnded phase of the test.
MetricTestCase Extension of TestCase that allows to log metrics when running as part of TradeFed.
MetricTestCase.LogHolder Structure to hold a log file to be reported.
MetricUtil Utility class for pulling metrics from pushed statsd configurations.
MetricUtility Contains common utility methods for storing the test metrics, aggregating the metrics in similar tests and writing the metrics to a file.
MinApiLevelModuleController Base class for a module controller to not run tests when it below a specified API Level.
MinSdkModuleController Base class for a module controller to not run tests on versions below a specified SDK version number.
MixImageZipPreparer An IMultiTargetPreparer that mixes a system build's images in a device build.
MixKernelTargetPreparer A ITargetPreparer that allows to mix a kernel image with the device image.
MoblyBinaryHostTest Host test meant to run a mobly python binary file from the Android Build system (Soong)
MoblyYamlResultControllerInfoHandler Mobly yaml result 'Controller Info' element handler.
MoblyYamlResultControllerInfoHandler.ControllerInfo
MoblyYamlResultControllerInfoHandler.ControllerInfo.Builder
MoblyYamlResultHandlerFactory Mobly yaml result handler factory which generates appropriate handler based on result type.
MoblyYamlResultHandlerFactory.InvalidResultTypeException
MoblyYamlResultHandlerFactory.Type
MoblyYamlResultParser Mobly yaml test results parser.
MoblyYamlResultRecordHandler Mobly yaml result 'Record' element handler.
MoblyYamlResultRecordHandler.Record
MoblyYamlResultRecordHandler.Record.Builder
MoblyYamlResultRecordHandler.RecordResult
MoblyYamlResultSummaryHandler Mobly yaml result 'Summary' element handler.
MoblyYamlResultSummaryHandler.Summary
MoblyYamlResultSummaryHandler.Summary.Builder
MoblyYamlResultTestNameListHandler Mobly yaml result 'Test Name List' element handler.
MoblyYamlResultTestNameListHandler.TestNameList
MoblyYamlResultTestNameListHandler.TestNameList.Builder
MoblyYamlResultUserDataHandler Mobly yaml result 'User Data' element handler.
MoblyYamlResultUserDataHandler.UserData
MoblyYamlResultUserDataHandler.UserData.Builder
ModifiedFilesParser Class responsible to parse and extract information from modified_files.json.
ModuleDefinition Container for the test run configuration.
ModuleListener Listener attached to each IRemoteTest of each module in order to collect the list of results.
ModuleLogcatCollector Version of logcat collector but for module.
ModuleMerger Helper class for operation related to merging ITestSuite and ModuleDefinition after a split.
ModuleOemTargetPreparer
ModuleParameters Special values associated with the suite "parameter" keys in the metadata of each module.
ModuleParametersHelper Helper to get the IModuleParameterHandler associated with the parameter.
ModulePusher
ModulePusher.ModulePushError Fatal error during Mainline module push.
ModuleSplitter Helper to split a list of modules represented by IConfiguration into a list of execution units represented by ModuleDefinition .
MultiFailureDescription Collect multiple FailureDescription in one holder.
MultiMap <K, V> A ERROR(/Map) that supports multiple values per key.

N

NameMangleListener A proxy listener to translate test method, class, and package names as results are reported.
NativeBenchmarkTest A Test that runs a native benchmark test executable on given device.
NativeBenchmarkTestParser A IShellOutputReceiver that parses the benchmark test data output, collecting metrics on average time per operation.
NativeBridgeModuleController A module controller to check if a device support native bridge.
NativeCodeCoverageFlusher A utility class that clears native coverage measurements and forces a flush of native coverage data from processes on the device.
NativeDevice Default implementation of a ITestDevice Non-full stack android devices.
NativeDevice.AdbAction A ERROR(DeviceAction/com.android.tradefed.device.NativeDevice.DeviceAction DeviceAction) for running a OS 'adb ....' command.
NativeDevice.AdbShellAction
NativeDevice.RebootDeviceAction ERROR(DeviceAction/com.android.tradefed.device.NativeDevice.DeviceAction DeviceAction) for rebooting a device.
NativeDevice.RebootMode A mode of a reboot.
NativeDeviceStateMonitor Helper class for monitoring the state of a IDevice with no framework support.
NativeLeakCollector A ITargetPreparer that runs 'dumpsys meminfo --unreachable -a' to identify the unreachable native memory currently held by each process.
NativeStressTest A Test that runs a native stress test executable on given device.
NativeStressTestParser A IShellOutputReceiver that parses the stress test data output, collecting metrics on number of iterations complete and average time per iteration.
NegativeHandler Handler that specify that nothing should be done and the parameter should not create any extra module.
NestedDeviceStateMonitor Device state monitor that executes extra checks on nested device to accommodate the specifics of the virtualized environment.
NestedRemoteDevice Representation of the device running inside a remote Cuttlefish VM.
NetworkNotAvailableException Thrown when a device is not able to connect to network for testing.
NoApkTestSkipper Special preparer that allows to skip an invocation completely (preparation and tests) if there are no apks to tests.
NoDeviceException Thrown when there's no device to execute a given command.
NoisyDryRunTest Run noisy dry run on a command file.
NoOpConfigOptionValueTransformer An no-op IConfigOptionValueTransformer
NotMultiAbiHandler Special handler that notify the SuiteModuleLoader that the secondary abi should not create a module.
NullDevice A placeholder IDevice used by DeviceManager to allocate when IDeviceSelection#nullDeviceRequested() is true

O

OpenObjectLoader Loader for the default objects available in AOSP.
Option Annotates a field as representing a IConfiguration option.
Option.Importance
OptionClass Annotates a class as representing a IConfiguration object.
OptionCopier A helper class that can copy Option field values with same names from one object to another.
OptionDef Holds the details of an Option .
OptionFetcher Helper to get the test options from the parent process.
OptionNotAllowedException Specific ConfigurationException when an option is not allowed to be passed in the command line.
OptionSetter Populates Option fields.
OptionSetter.OptionFieldsForName Container for the list of option fields with given name.
OptionUpdateRule Controls the behavior when an option is specified multiple times.
OtaDeviceBuildInfo A IDeviceBuildInfo used for over-the-air update testing.
OtatoolsBuildInfo An IBuildInfo that contains otatools artifacts.
OtaZipfileBuildProvider Provides a IBuildInfo based on a local OTA zip file.
OxygenClient A class that manages the use of Oxygen client binary to lease or release Oxygen device.
OxygenUtil Utility to interact with Oxygen service.

P

PackageInfo Container for an application's package info parsed from device.
PackageInstalledModuleController Module controller to not run tests when the device has not got the given packages installed.
Pair <A, B> Define our own Pair class which contains two objects.
PairingMultiTargetPreparer A multi-target preparer helps make Bluetooth pairing (and connection) between two devices.
ParallelDeviceExecutor <V> Wrapper of ERROR(/ExecutorService) to execute a function in parallel.
ParentSandboxInvocationExecution Version of InvocationExecution for the parent invocation special actions when running a sandbox.
ParentShardReplicate Replicate a setup for one device to all other devices that will be part of sharding.
PassingTestFileReporter A ITestInvocationListener that saves the list of passing test cases to a test file
PerfettoGenericPostProcessor A post processor that processes text/binary metric perfetto proto file into key-value pairs by recursively expanding the proto messages and fields with string values until the field with numeric value is encountered.
PerfettoGenericPostProcessor.AlternativeParseFormat
PerfettoGenericPostProcessor.METRIC_FILE_FORMAT
PerfettoPreparer Perfetto preparer pushes the config file in to the device at a standard location to which perfetto have access to.
PerfettoPullerMetricCollector Base implementation of FilePullerDeviceMetricCollector that allows pulling the perfetto files from the device and collect the metrics from it.
PerfettoPullerMetricCollector.METRIC_FILE_FORMAT
PerfettoTraceRecorder A utility class for recording perfetto trace on a ITestDevice .
PrettyPrintDelimiter Helper utility that helps to print delimited message that stands out.
PrettyTestEventLogger Logger matching the events and logging them in order to make it easier to debug.
ProcessInfo Used to store process related(USER, PID, NAME, START TIME IN SECOND SINCE EPOCH) information.
ProfileParameterHandler Base parameter handler for any profile user.
ProfileTargetPreparer Base class for setting up target preparer for any profile user android.os.usertype.profile.XXX .
PropertyChanger A utility class for changing (or adding) items in an Android property file
ProtoResultParser Parser for the Tradefed results proto format.
ProtoResultParser.TestLevel Enumeration representing the current level of the proto being processed.
ProtoResultReporter Result reporter build a TestRecord protobuf with all the results inside.
ProtoUtil Utility methods for dealing with protobuf messages type-agnostically.
ProxyConfiguration Object that allows pointing to a remote configuration to execute.
PsParser Utility used to parse(USER,PID and NAME) from the "ps" command output
PtsBotTest Run PTS-bot tests.
PushFileInvoker This class is deprecated. Use PushFilePreparer instead
PushFilePreparer A ITargetPreparer that attempts to push any number of files from any host path to any device path.
PythonBinaryHostTest Host test meant to run a python binary file from the Android Build system (Soong)

The test runner supports include-filter and exclude-filter.

PythonBinaryHostTest.PythonForwarder Result forwarder to replace the run name by the binary name.
PythonUnitTestResultParser Interprets the output of tests run with Python's unittest framework and translates it into calls on a series of ITestInvocationListener s.
PythonUnitTestRunner This class is deprecated. Use PythonBinaryHostTest instead.
PythonVirtualenvHelper A helper class for activating Python 3 virtual environment.
PythonVirtualenvPreparer Sets up a Python virtualenv on the host and installs packages.

Q

QuotationAwareTokenizer

R

RebootReasonCollector Collector that collects device reboot during the test run and report them by reason and counts.
RebootTargetPreparer Target preparer that reboots the device.
RecoveryLogPreparer A target preparer used to collect logs before recovery.
RegexTrie <V> The RegexTrie is a trie where each stored segment of the key is a regex ERROR(/Pattern) .
RemoteAndroidDevice Implementation of a ITestDevice for a full stack android device connected via adb connect.
RemoteAndroidVirtualDevice Extends RemoteAndroidDevice behavior for a full stack android device running in the Google Compute Engine (Gce).
RemoteAvdIDevice A placeholder IDevice used by DeviceManager to allocate when DeviceSelectionOptions.gceDeviceRequested() is true
RemoteFileResolver A simple class that allows one to load files from a variety of places using URIs and the service provider functionality.
RemoteFileUtil Utility class to handle file from a remote instance
RemoteInvocationExecution Implementation of InvocationExecution that drives a remote execution.
RemoteInvocationExecution.FileOptionValueTransformer
RemoteSshUtil Utility to execute ssh commands on remote instances.
RemoteTestTimeOutEnforcer Listeners that allows to check the execution time of a given test config and fail it if it goes over a given timeout.
RemoteZip Utilities to unzip individual files inside a remote zip file.
RemoveSystemAppPreparer A ITargetPreparer for removing an apk from the system partition before a test run.
ReportPassedTests Report in a file possible filters to exclude passed test.
ResolvePartialDownload Resolve a partial download request.
ResourceMetricUtil Utility functions for composing metrics.
ResourceUtil Utility for reading configuration resources.
RestApiHelper A helper class for performing REST API calls.
RestartSystemServerTargetPreparer Target preparer that restarts the system server without rebooting the device.
ResultAggregator Special forwarder that aggregates the results when needed, based on the retry strategy that was taken.
ResultAndLogForwarder Forwarder for results and logs events.
ResultForwarder A ITestInvocationListener that forwards invocation results to a list of other listeners.
ResultsPlayer Special runner that replays the results given to it.
RetentionFileSaver Helper class for creating a .retention file in a directory.
RetryConfigurationFactory Factory that handles retrying a command.
RetryLogSaverResultForwarder Forwarder that also handles passing the current attempt we are at.
RetryPreparationDecision A Class to describe the decisions about whether or not to retry preparation and to fail the module run.
RetryRescheduler A special runner that allows to reschedule a previous run tests that failed or where not executed.
RetryRescheduler.RetryType The types of the tests that can be retried.
RetryResultForwarder An Extension of ResultForwarder that always push to a given attempt number.
RetryResultHelper Helper class to determine which module or test should run or not.
RetryStatistics Structure holding the statistics for a retry session of one IRemoteTest .
RetryStrategy The Retry Strategy to be used when re-running some tests.
RootTargetPreparer Target preparer that performs "adb root" or "adb unroot" based on option "force-root".
RunAftersWithInfo
RunBeforesWithInfo
RunCommandTargetPreparer
RunConfigDeviceRecovery Generic base IMultiDeviceRecovery to run a tradefed configuration to do the recovery step.
RunHostCommandTargetPreparer Target preparer to run arbitrary host commands before and after running the test.
RunHostScriptTargetPreparer Target preparer which executes a script before running a test.
RunInterruptedException Thrown when a run operation is interrupted by an external request.
RunNotifierWrapper Wrapper of RunNotifier so we can carry the DeviceNotAvailableException .
RunOnCloneProfileParameterHandler
RunOnCloneProfileTargetPreparer
RunOnSdkSandboxHandler Handler for ModuleParameters#RUN_ON_SDK_SANDBOX .
RunOnSdkSandboxTargetPreparer An ITargetPreparer to marks that tests should run in the sdk sandbox.
RunOnSecondaryUserParameterHandler
RunOnSecondaryUserTargetPreparer An ITargetPreparer that creates a secondary user in setup, and marks that tests should be run in that user.
RunOnSystemUserTargetPreparer An ITargetPreparer that marks that tests should be run on the user (rather than the current user).
RunOnWorkProfileParameterHandler
RunOnWorkProfileTargetPreparer An ITargetPreparer that creates a work profile in setup, and marks that tests should be run in that user.
RuntimeRestartCollector Collector that collects timestamps of runtime restarts (system server crashes) during the test run, if any.
RunUtil A collection of helper methods for executing operations.
RustBenchmarkResultParser Interprets the output of tests run with Criterion benchmarking framework and translates it into calls on a series of ITestInvocationListener s.
RustBinaryHostTest Host test meant to run a rust binary file from the Android Build system (Soong)
RustBinaryTest A Test that runs a rust binary on given device.
RustTestBase Base class of RustBinaryHostTest and RustBinaryTest
RustTestBase.EnvPair
RustTestBase.Invocation
RustTestResultParser Interprets the output of tests run with Rust's unittest framework and translates it into calls on a series of ITestInvocationListener s.

S

SandboxConfigDump Runner class that creates a IConfiguration based on a command line and dump it to a file.
SandboxConfigDump.DumpCmd
SandboxConfigurationException Special Configuration Exception coming from the Sandbox setup.
SandboxConfigurationFactory Special Configuration factory to handle creation of configurations for Sandboxing purpose.
SandboxConfigUtil A utility class for managing IConfiguration when doing sandboxing.
SandboxedInvocationExecution Special sandbox execution of the invocation: This is the InvocationExection for when we are inside the sandbox running the command.
SandboxInvocationRunner Run the tests associated with the invocation in the sandbox.
SandboxOptions Class that can receive and provide options to a ISandbox .
ScreenshotOnFailureCollector Collector that will capture and log a screenshot when a test case fails.
Sdk28ModuleController A module controller to check if a device is on SDK 28 (Android 9) or above.
Sdk29ModuleController Only run tests if the device under test is SDK version 29 or above.
Sdk30ModuleController Only run tests if the device under test is SDK version 30 or above.
Sdk31ModuleController Only run tests if the device under test is SDK version 31 or above.
Sdk32ModuleController Only run tests if the device under test is SDK version 32 or above.
Sdk33ModuleController Only run tests if the device under test is SDK version 33 or above.
SecondaryUserHandler Handler for ModuleParameters#SECONDARY_USER .
SecondaryUserOnDefaultDisplayHandler Handler for ModuleParameters#SECONDARY_USER_ON_DEFAULT_DISPLAY .
SecondaryUserOnSecondaryDisplayHandler Handler for ModuleParameters#SECONDARY_USER_ON_SECONDARY_DISPLAY .
SemaphoreTokenTargetPreparer This is a preparer used to use token to serialize test excution in tradefed host.
SerializationUtil Utility to serialize/deserialize an object that implements ERROR(/Serializable) .
ServiceAccountKeyCredentialFactory A credential factory to create service account key based oauth Credential .
SettingsBaselineSetter A common setter to handle device baseline settings via ITestDevice.setSetting.
ShardBuildCloner Helper class that handles cloning a build info from the command line.
ShardHelper Helper class that handles creating the shards and scheduling them for an invocation.
ShardListener A ITestInvocationListener that collects results from a invocation shard (aka an invocation split to run on multiple resources in parallel), and forwards them to another listener.
ShardMainResultForwarder A ResultForwarder that combines the results of a sharded test invocations.
ShellOutputReceiverStream Utility subclass of OutputStream that writes into an IShellOutputReceiver.
ShellStatusChecker Check if the shell status is as expected before and after a module run.
ShippingApiLevelModuleController Run tests if the device meets the following conditions:
  • If min-api-level is defined:
    • The device shipped with the min-api-level or later.
ShowmapPullerMetricCollector Base implementation of FilePullerDeviceMetricCollector that allows pulling the showmap files from the device and collect the metrics from it.
SideloadOtaTargetPreparer A target preparer that performs sideload of a specified OTA package, applies the package, waits for device to boot up, and injects the device build properties to use as build info

This target preparer assumes that the device will be in regular adb mode when started, and will ensure that the device exits in the same mode but with the newer build applied.

SimpleFileLogger A ILeveledLogOutput that directs log messages to stdout and to a single log file.
SimplePerfResult Object to hold all simpleperf test results
SimplePerfStatResultParser A utility class to parse simpleperf result.
SimplePerfUtil Utility class to dispatch simple command and collect results
SimplePerfUtil.SimplePerfType Enum of simpleperf command options
SimpleStats A small utility class that calculates a few statistical measures given a numerical dataset.
SizeLimitedOutputStream A thread safe file backed ERROR(/OutputStream) that limits the maximum amount of data that can be written.
SkipHWASanModuleController Base class for a module controller to not run tests on HWASan builds.
Sl4aBluetoothUtil A utility class provides Bluetooth operations on one or two devices using SL4A
Sl4aBluetoothUtil.BluetoothAccessLevel Enums for Bluetooth device access level which are based on BluetoothDevice.java
Sl4aBluetoothUtil.BluetoothConnectionState Enums for Bluetooth connection states which are based on BluetoothProfile.java
Sl4aBluetoothUtil.BluetoothPriorityLevel Enums for Bluetooth profile priority level which are based on BluetoothProfile.java
Sl4aBluetoothUtil.BluetoothProfile Enums for Bluetooth profiles which are based on BluetoothProfile.java
Sl4aClient Sl4A client to interact via RPC with SL4A scripting layer.
Sl4aEventDispatcher Event dispatcher polls for event and queue them by name to be queried.
Sl4aEventDispatcher.EventSl4aObject Object returned by the event poller.
SnapshotInputStreamSource A File-backed InputStreamSource.
SparseImageUtil Utility to unsparse sparse images.
SparseImageUtil.SparseInputStream SparseInputStream read from upstream and detects the data format.
StatsdBeforeAfterGaugeMetricPostProcessor A post processor that processes gauge metrics collected in a "before/after" approach, ie
StatsdEventMetricPostProcessor A post processor that processes event metrics in statsd reports into key-value pairs, using the formatters specified on the processor.
StatsdGenericPostProcessor A post processor that processes binary proto statsd reports into key-value pairs by expanding the report as a tree structure.
StatusCheckerResult Contains the result of a ISystemStatusChecker execution.
StatusCheckerResult.CheckStatus
StdoutLogger A ILeveledLogOutput that directs log messages to stdout.
StopServicesSetup A ITargetPreparer that stops services on the device.
StreamProtoReceiver A receiver that translates proto TestRecord received into Tradefed events.
StreamProtoResultReporter An implementation of ProtoResultReporter
StreamUtil Utility class for managing input streams.
StrictShardHelper Sharding strategy to create strict shards that do not report together,
StringEscapeUtils Utility class for escaping strings for specific formats.
StringUtil Utility class for escaping strings for common string manipulation.
StubBuildProvider No-op empty implementation of a IBuildProvider .
StubDevice Stub placeholder implementation of a IDevice .
StubKeyStoreClient Default stub implementation for KeyStore Client.
StubKeyStoreFactory Default stub implementation for KeyStore Factory
StubLocalAndroidVirtualDevice A placeholder IDevice used by DeviceManager to allocate when DeviceSelectionOptions.localVirtualDeviceRequested() is true
StubMultiTargetPreparer Placeholder empty implementation of a IMultiTargetPreparer .
StubTargetPreparer Placeholder empty implementation of a ITargetPreparer .
StubTest No-op empty test implementation.
StubTestRunListener Stub implementation of ITestRunListener
SubprocessCommandException A subprocess command failed to run.
SubprocessConfigBuilder Build a wrapper TF config XML for an existing TF config.
SubprocessEventHelper Helper to serialize/deserialize the events to be passed to the log.
SubprocessEventHelper.BaseTestEventInfo Base Helper for TestIgnored information.
SubprocessEventHelper.FailedTestEventInfo Helper for testFailed information.
SubprocessEventHelper.InvocationEndedEventInfo Helper for invocation ended information.
SubprocessEventHelper.InvocationFailedEventInfo Helper for InvocationFailed information.
SubprocessEventHelper.InvocationStartedEventInfo Helper for invocation started information.
SubprocessEventHelper.LogAssociationEventInfo Helper for logAssociation information.
SubprocessEventHelper.TestEndedEventInfo Helper for testEnded information.
SubprocessEventHelper.TestLogEventInfo Helper for testLog information.
SubprocessEventHelper.TestModuleStartedEventInfo Helper for test module started information.
SubprocessEventHelper.TestRunEndedEventInfo Helper for testRunEnded Information.
SubprocessEventHelper.TestRunFailedEventInfo Helper for testRunFailed information
SubprocessEventHelper.TestRunStartedEventInfo Helper for testRunStarted information
SubprocessEventHelper.TestStartedEventInfo Helper for testStarted information
SubprocessExceptionParser Helper to handle the exception output from standard Tradefed command runners.
SubprocessReportingHelper A class to build a wrapper configuration file to use subprocess results reporter for a cluster command.
SubprocessResultsReporter Implements ITestInvocationListener to be specified as a result_reporter and forward from the subprocess the results of tests, test runs, test invocations.
SubprocessTestResultsParser Extends ERROR(/FileOutputStream) to parse the output before writing to the file so we can generate the test events on the launcher side.
SubprocessTestResultsParser.StatusKeys Relevant test status keys.
SubprocessTfLauncher A IRemoteTest for running tests against a separate TF installation.
SuiteApkInstaller Installs specified APKs for Suite configuration: either from $ANDROID_TARGET_OUT_TESTCASES variable or the ROOT_DIR in build info.
SuiteModuleLoader Retrieves Compatibility test module definitions from the repository.
SuiteModuleLoader.ConfigFilter A ERROR(/FilenameFilter) to find all the config files in a directory.
SuiteResultHolder Helper object to ease up serializing and deserializing the invocation results.
SuiteResultReporter Collect test results for an entire suite invocation and output the final results.
SuiteResultReporter.ModulePrepTimes Object holder for the preparation and tear down time of one module.
SuiteTestFilter Represents a filter for including and excluding tests.
SwitchUserTargetPreparer A ITargetPreparer that switches to the specified user kind in setUp.
SystemServerFileDescriptorChecker Checks if system server appears to be running out of FDs.
SystemServerStatusChecker Check if the pid of system_server has changed from before and after a module run.
SystemUpdaterDeviceFlasher A IDeviceFlasher that relies on the system updater to install a system image bundled in a OTA update package.
SystemUtil Utility class for making system calls.
SystemUtil.EnvVariable

T

TableBuilder Helper class to display a matrix of String elements in a table.
TableFormatter Helper class to display a matrix of String elements so each element column is lined up
TargetFileUtils
TargetFileUtils.FilePermission
TargetSetupError A fatal error occurred while preparing the target for testing.
TarUtil Utility to manipulate a tar file.
TcpDevice A placeholder IDevice used by DeviceManager to allocate when DeviceSelectionOptions.tcpDeviceRequested() is true
TearDownPassThroughPreparer Allows for running tearDown on preparers that are included in a config as an object.
TelephonyHelper A utility to use and get information related to the telephony.
TelephonyHelper.SimCardInformation An information holder for the sim card related information.
TelephonyTokenProvider Token provider for telephony related tokens.
TemperatureThrottlingWaiter An ITargetPreparer that waits until device's temperature gets down to target
TemplateResolutionError Class extending ConfigurationException for template related error during configuration parsing.
TerribleFailureEmailHandler A simple handler class that sends an email to interested people when a WTF (What a Terrible Failure) error occurs within a Trade Federation instance.
TestAppInstallSetup A ITargetPreparer that installs one or more apps from a IDeviceBuildInfo.getTestsDir() folder onto device.
TestContext A class to model a TestContext message of TFC API.
TestDependencyResolver Helper to resolve dependencies if needed.
TestDescription Class representing information about a test case.
TestDescriptionsFile A utility class for marshalling and unmarshalling a list of TestDescriptions to a test file.
TestDevice Implementation of a ITestDevice for a full stack android device
TestDevice.MicrodroidBuilder A builder used to create a Microdroid TestDevice.
TestDeviceOptions Container for ITestDevice Option s
TestDeviceOptions.InstanceType
TestDeviceState A more fully featured representation of device state than DeviceState .
TestEnvironment A class to model a TestEnvironment message returned by TFC API.
TestErrorIdentifier Error identifier from tests and tests runners.
TestFailureListener Listener used to take action such as screenshot, bugreport, logcat collection upon a test failure when requested.
TestFailureModuleController Controller for module that simply want to tune how the tests failures log collected are behaving.
TestFilePushSetup A ITargetPreparer that pushes one or more files/dirs from a IDeviceBuildInfo.getTestsDir() folder onto device.
TestFilterHelper Helper class for filtering tests
TestGroupStatus A class to store status of a test group.
TestInfo Stores the test information set in a TEST_MAPPING file.
TestInformation Holder object that contains all the information and dependencies a test runner or test might need to execute properly.
TestInformation.Builder Builder to create a TestInformation instance.
TestInvocation Default implementation of ITestInvocation .
TestInvocation.RunMode The different mode an invocation can run into.
TestInvocation.Stage
TestInvocationManagementServer GRPC server helping to management test invocation and their lifecycle.
TestInvocationManagementServer.InvocationInformation
TestMapping A class for loading a TEST_MAPPING file.
TestMappingSuiteRunner Implementation of BaseTestSuite to run tests specified by option include-filter, or TEST_MAPPING files from build, as a suite.
TestOption Stores the test option details set in a TEST_MAPPING file.
TestOutputUploader Uploads test output files to local file system, GCS, or an HTTP(S) endpoint.
TestRecordInterpreter Utility to convert a TestRecord proto into a more easily manipulable format in Tradefed.
TestRecordProtoUtil Utility to read the TestRecord proto from a file.
TestResource A class to model a TestResource message returned by TFC API.
TestResourceDownloader A class to download test resource files from file system/GCS/HTTP.
TestResult Container for a result of a single test.
TestResultListener A simplification of ITestLifecycleListener for implementers that only care about individual test results.
TestRunnerUtil A utility class to help various test runners.
TestRunResult Holds results from a single test run.
TestRunToTestInvocationForwarder Forwarder from ddmlib ITestRunListener to ITestLifeCycleReceiver .
TestsPoolPoller Tests wrapper that allow to execute all the tests of a pool of tests.
TestSuiteInfo A class that resolves loading of build related metadata for test suite

To properly expose related info, a test suite must include a test-suite-info.properties file in its jar resources

TestSummary A class to represent a test summary.
TestSummary.Type
TestSummary.TypedString
TestSystemAppInstallSetup A ITargetPreparer that installs one or more apps from a IDeviceBuildInfo.getTestsDir() folder onto the /system partition on device.
TestTimeoutEnforcer Listeners that allows to check the execution time of a given test case and fail it if it goes over a given timeout.
TextResultReporter A test result reporter that forwards results to the JUnit text result printer.
TfMetricProtoUtil Utility class to help with the Map to Map transition.
TfObjectTracker A utility to track the usage of the different Trade Fedederation objects.
TfSuiteRunner Implementation of ITestSuite which will load tests from TF jars res/config/suite/ folder.
TfTestLauncher A IRemoteTest for running unit or functional tests against a separate TF installation.
TimeStatusChecker Status checker to ensure that the device and host time are kept in sync.
TimeUtil Contains time related utility methods.
TimeVal This is a sentinel type which wraps a Long .
TimeWaster A simple target preparer to waste time and potentially restart the device.
TokenProperty Supported token with dynamic sharding.
TokenProviderHelper Helper that gives the provider associated to a particular token, in order to find out if a device supports the token.
TraceCmdCollector A IMetricCollector that collects traces during the test using trace-cmd, and logs them to the invocation.
TracePropagatingExecutorService An executor service that forwards tasks to an underlying implementation while propagating the tracing context.
TracingLogger Class that helps to manage tracing for each test invocation.
TradefedConfigObject A class to model a TradefedConfigObject message of TFC API.
TradefedConfigObject.Type A list of configuration object types which can be injected to a cluster command config.
TradefedDelegator Objects that helps delegating the invocation to another Tradefed binary.
TradefedFeatureClient A grpc client to request feature execution from the server.
TradefedFeatureServer A server that responds to requests for triggering features.
TradefedSandbox Sandbox container that can run a Trade Federation invocation.
TradefedSandboxFactory Default implementation for SandboxFactory
TradefedSandboxRunner Runner associated with a TradefedSandbox that will allow executing the sandbox.
TradefedSandboxRunner.StubScheduledInvocationListener A stub IScheduledInvocationListener that does nothing.

U

UiAutomatorRunner Runs UI Automator test on device and reports results.
UiAutomatorTest
UiAutomatorTest.LoggingOption
UiAutomatorTest.TestFailureAction
UnexecutedTestReporterThread Threads that takes care of reporting all unexecuted tests.
UniqueMultiMap <K, V> A MultiMap that ensures unique values for each key.
UsbResetMultiDeviceRecovery A IMultiDeviceRecovery which resets USB buses for offline devices.
UsbResetRunConfigRecovery Allow to trigger a command to reset the USB of a device
UsbResetTest An IRemoteTest that reset the device USB and checks whether the device comes back online afterwards.
UserChecker Checks if users have changed during the test.
UserCleaner A ITargetPreparer that removes secondary users on teardown.
UserInfo Similar to UserInfo class from platform.
UserInfo.UserType Supported variants of a user's type in external APIs.

V

ValidateSuiteConfigHelper This class will help validating that the IConfiguration loaded for the suite are meeting the expected requirements: - No Build providers - No Result reporters
VersionedFile Data structure representing a file that has an associated version.
VersionParser Fetch the version of the running tradefed artifacts.
VisibleBackgroundUserPreparer Target preparer for running tests in a user that is started in the visible in the background.
VmRemoteDevice A Remote virtual device that we will manage from inside the Virtual Machine.

W

WaitDeviceRecovery A simple implementation of a IDeviceRecovery that waits for device to be online and respond to simple commands.
WaitForDeviceDatetimePreparer A ITargetPreparer that waits for datetime to be set on device

Optionally this preparer can force a TargetSetupError if datetime is not set within timeout, or force host datetime onto device,

WifiHelper Helper class for manipulating wifi services on device.
WifiPreparer A ITargetPreparer that configures wifi on the device if necessary.

X

XmlFormattedGeneratorReporter Implementation of the FormattedGeneratorReporter which format the suite results in an xml format.
XmlResultReporter Writes JUnit results to an XML files in a format consistent with Ant's XMLJUnitResultFormatter.
XmlSuiteResultFormatter Utility class to save a suite run as an XML.
XmlSuiteResultFormatter.RunHistory Helper object for JSON conversion.

Y

YamlClassOptionsParser Helper to parse test runner information from the YAML Tradefed Configuration.

Z

ZipCompressionStrategy An ICompressionStrategy for creating zip archives.
ZipUtil A helper class for compression-related operations
ZipUtil2 A helper class for zip extraction that takes POSIX file permissions into account
,

Class Index

These are the API classes. See all API packages .

A

AaptParser Class that extracts info from apk by parsing output of 'aapt dump badging'.
AaptParser.AaptVersion Enum of options for AAPT version used to parse APK files.
Abi A class representing an ABI.
AbiFormatter Utility class for abi.
AbiUtils Utility class for handling device ABIs
AbstractConnection Abstract connection representation.
AbstractHostMonitor Typical class for Host Health Monitoring.
AbstractXmlParser Helper base class for parsing xml files
AbstractXmlParser.ParseException Thrown if XML input could not be parsed
AcloudConfigParser Helper class that parse an Acloud config (used to start a Cloud device instance).
AcloudConfigParser.AcloudKeys Sets of key that can be searched from the configuration.
ActionInProgress The general action in progress.
ActiveTrace Main class helping to describe and manage an active trace.
ActivityStatusChecker Status checker for left over activities running at the end of a module.
AdbRootElevator An AutoCloseable that enables adb root when constructed if needed and restores root state when complete.
AdbSshConnection Adb connection over an ssh bridge.
AdbStopServerPreparer Target preparer to stop adb server on the host before and after running adb tests.
AdbTcpConnection Default connection representation of a device, assumed to be a standard adb connection of the device.
AdbUtils A utility class for adb operations.
AfterClassWithInfo Similar guarantees as AfterClass but method annotated must require a TestInformation parameter.
AggregatePostProcessor A metric aggregator that gives the min, max, mean, variance, standard deviation, total, count and optionally percentiles for numeric metrics collected during multiple-iteration test runs, treating them as doubles.
AllTestAppsInstallSetup A ITargetPreparer that installs all apps from a IDeviceBuildInfo#getTestsDir() folder onto device.
AltDirBehavior An enum to define alternative directory behaviors for various test artifact installers/pushers

AndroidJUnitTest A Test that runs an instrumentation test package on given device using the android.support.test.runner.AndroidJUnitRunner.
AoaTargetPreparer ITargetPreparer that executes a series of actions (eg clicks and swipes) using the Android Open Accessory (AOAv2) protocol.
AppBuildInfo A IBuildInfo that represents an Android application and its test package(s).
AppDeviceBuildInfo This class is deprecated. Use IDeviceBuildInfo directly.
AppSetup A ITargetPreparer that installs an apk and its tests.
AppVersionFetcher Utility class to get app version string from device.
AppVersionFetcher.AppVersionInfo App version info types.
ArchModuleController Module controller to not run tests when it doesn't match any given architectures.
ArgsOptionParser Populates Option fields from parsed command line arguments.
ArrayUtil Utility methods for arrays
ArtChrootPreparer Create chroot directory for ART tests.
ArtGTest
ArtRunTest A test runner to run ART run-tests.
ArtRunTest.AdbShellCommandException An exception class to report an error that occurred during the execution of an ADB shell command.
ATestFileSystemLogSaver This LogSaver class is used by ATest to save logs in a specific path.
AtestRunner Implementation of ITestSuite
AtraceCollector A IMetricCollector that runs atrace during a test and collects the result and log them to the invocation.
AtraceRunMetricCollector Collects the traces from all the test directory under the given directory from the test device, log the test directory and post process the trace files under the test directory and aggregate the metrics.
AutoLogCollector Enumeration describing which collector can automatically be handled by the harness.
AutomatedReporters Class that defines the mapping from Tradefed automated reporters.
AveragePostProcessor Implementation of post processor that calculate the average of the list of metrics.

B

BackgroundDeviceAction Runs a command on a given device repeating as necessary until the action is canceled.
BaseDeviceMetricCollector Base implementation of IMetricCollector that allows to start and stop collection on onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData) and ERROR(/#onTestRunEnd(com.android.tradefed.device.metric.DeviceMetricData,Map)) .
BaseEmulatorPreparer Common preparer for launching a local emulator.
BaseHostJUnit4Test Base test class for running host JUnit4 style tests.
BaseLeveledLogOutput A base implementation for ILeveledLogOutput that allows to filtering some tags based on their name or components.
BaseModuleController Basic implementation of IModuleController that should be implemented for checking if a module should run or not.
BaseMultiTargetPreparer Base implementation of IMultiTargetPreparer that allows to disable the object.
BasePostProcessor The base IPostProcessor that every implementation should extend.
BaseRetryDecision Base implementation of IRetryDecision .
BaseStreamLogger <OS extends OutputStream> A ILeveledLogOutput that directs log messages to an output stream and to stdout.
BaseTargetPreparer Base implementation class for ITargetPreparer that allows to control whether the object is disabled or not.
BaseTestSuite A Test for running Compatibility Test Suite with new suite system.
BatteryController Utility class that allows to control the battery charging state of a device.
BatteryRechargeDeviceRecovery Allow to trigger a command when the battery level of the device goes under a given threshold.
BatteryTemperature
BatteryUnavailableDeviceRecovery Recovery checker that will trigger a configuration if the battery level is not available.
BeforeClassWithInfo Similar guarantees as BeforeClass but method annotated must require a TestInformation parameter.
BinaryState Enum used to record ON/OFF state with a IGNORE no-op state.
BluetoothConnectionLatencyCollector The collector will push a pre-defined statsd duration metric config to devices and collect Bluetooth connection duration for each profile.
BluetoothConnectionStateCollector This collector will collect BluetoothConnectionStateChanged metrics and record connection state number for each profile.
BluetoothConnectionSuccessRatePostProcessor Implementation of postprocessor which calculates success rate for a bluetooth profile

Use "metric-key-match" to specify metrics which contain bluetooth connection states in numeric array Example [0, 1, 2, 3, 0, 1, 2, 3].

BluetoothHciSnoopLogCollector Collector to enable Bluetooth HCI snoop logging on the DUT and to collect the log for each test.
BluetoothUtils Utility functions for calling BluetoothInstrumentation on device

Device side BluetoothInstrumentation code can be found in AOSP at: frameworks/base/core/tests/bluetoothtests

BootstrapBuildProvider A IDeviceBuildProvider that bootstraps build info from the test device

This is typically used for devices with an externally supplied build, ie

BootstrapServiceFileResolverLoader Loads resolvers using the service loading facility.
Bugreport Object holding the bugreport files references, compatible of flat bugreport and zipped bugreport (bugreportz).
BugreportCollector A pass-through ITestInvocationListener that collects bugreports when configurable events occur and then calls ITestInvocationListener#testLog on its children after each bugreport is collected.
BugreportCollector.Filter
BugreportCollector.Freq
BugreportCollector.Noun
BugreportCollector.Predicate A full predicate describing when to capture a bugreport.
BugreportCollector.Relation
BugreportCollector.SubPredicate
BugreportzOnFailureCollector Collect a bugreportz when a test case fails.
BugreportzOnTestCaseFailureCollector Collect a bugreportz when a test case in a run fails.
BuildError Thrown if the provided build fails to run.
BuildInfo Generic implementation of a IBuildInfo that should be associated with a ITestDevice .
BuildInfoKey Class holding enumeration related to build information queries.
BuildInfoKey.BuildInfoFileKey Enum describing all the known file types that can be queried through IBuildInfo.getFile(com.android.tradefed.build.BuildInfoKey.BuildInfoFileKey) .
BuildInfoRecorder An ITargetPreparer that writes build info meta data into a specified file.
BuildInfoUtil A util class to help manipulate IBuildInfo
BuildRetrievalError A fatal error occurred while retrieving the build for testing.
BuildSerializedVersion Class that contains the current serialization version of all IBuildInfo .
BuildTestsZipUtils A helper class for operations related to tests zip generated by Android build system
BulkEmailer A email sender utility that allows the following configuration: sent interval,initial burst size, recipients and the total number messages.
BundletoolUtil Utility class that uses bundletool command line to install the .apks on deivce.
ByteArrayInputStreamSource
ByteArrayList A class to represent a lightweight byte array.
ByteArrayUtil Utilities to operate on byte array, eg, convert bytes to integer.

C

CarModuleController This controller prevents execution of tests cases on non-automotive devices.
CarryDnaeError Internal ERROR(/RuntimeException) to carry DeviceNotAvailableException through the JUnit4 framework.
CarryInterruptedException Thrown when test phase timeout is triggered and an InterruptedException needs to be carried from test execution thread to invocation execution thread.
CdmaDeviceFlasher A class that flashes an image on a physical Android device with a CDMA radio.
CecControllerTokenProvider Token provider for Consumer Electronics Control (CEC) related tokens.
CentralDirectoryInfo CentralDirectoryInfo is a class containing the information of a file/folder inside a zip file.
CheckPairingPreparer A CompanionAwarePreparer that verifies BT bonding between primary and companion devices
CircularAtraceUtil An atrace utility developed primarily for identifying the root causes of ANRs during Monkey testing.
CircularByteArray Data structure for holding a fixed size array that operates as a circular buffer, and tracks the total sum of all values in the array.
ClangCodeCoverageCollector A BaseDeviceMetricCollector that will pull Clang coverage measurements off of the device and log them as test artifacts.
ClassNotFoundConfigurationException ConfigurationException for when the class of an object is not found.
ClassPathScanner Finds entries on classpath.
ClassPathScanner.ClassNameFilter A IClassPathFilter that filters and transforms java class names.
ClassPathScanner.ExternalClassNameFilter A ClassNameFilter that rejects inner classes
ClassPathScanner.IClassPathFilter A filter for classpath entry paths

Patterned after FileFilter

ClockworkUtils A clockwork utility for sharing multi-device logic
CloseableTraceScope A scoped class that allows to report tracing section via try-with-resources
ClusterBuildInfo A IBuildInfo class for builds piped from TFC.
ClusterBuildProvider A IBuildProvider to download TFC test resources.
ClusterClient A IClusterClient implementation for interacting with the TFC backend.
ClusterCommand A class that represents a task fetched from TF Cluster.
ClusterCommand.RequestType
ClusterCommand.State Command's status in the TF cluster.
ClusterCommandConfigBuilder A class to build a configuration file for a cluster command.
ClusterCommandEvent A class to encapsulate cluster command events to be uploaded.
ClusterCommandEvent.Builder
ClusterCommandEvent.Type
ClusterCommandLauncher A IRemoteTest class to launch a command from TFC via a subprocess TF.
ClusterCommandScheduler A ICommandScheduler to support TFC (Tradefed Cluster).
ClusterCommandStatus A class that represents the state and the cancel reason for a command from TF Cluster.
ClusterDeviceInfo A class to encapsulate cluster device info to be uploaded.
ClusterDeviceInfo.Builder
ClusterDeviceMonitor An IDeviceMonitor implementation that reports results to the Tradefed Cluster service.
ClusterEventUploader <T extends IClusterEvent > ClusterEventUploader class, which uploads IClusterEvent to TFC.
ClusterHostEvent A class to encapsulate cluster host events to be uploaded.
ClusterHostEvent.Builder
ClusterHostEvent.HostEventType Enums of the different types of host events.
ClusterHostUtil Static util functions for TF Cluster to get global config instances, host information, etc.
ClusterLogSaver A ILogSaver class to upload test outputs to TFC.
ClusterLogSaver.FilePickingStrategy File picking strategies.
ClusterOptions
CodeCoverageTest A Test that runs an instrumentation test package on a given device and generates the code coverage report.
CollectingByteOutputReceiver A IShellOutputReceiver which collects the whole shell output into a byte[] .
CollectingOutputReceiver A IShellOutputReceiver which collects the whole shell output into one ERROR(/String) .
CollectingTestListener A ITestInvocationListener that will collect all test results.
CollectorHelper Helper to do some IMetricCollector operations needed in several places.
CommandFileParser Parser for file that contains set of command lines.
CommandFileParser.CommandLine
CommandInterrupter Service allowing TradeFederation commands to be interrupted or marked as uninterruptible.
CommandLineBuildInfoBuilder Utility meant to capture the usual build information arguments from a command line and create a IBuildInfo from them.
CommandOptions Implementation of ICommandOptions .
CommandOptionsGetter Service implementation that returns the command options value of a given invocation.
CommandResult Contains the result of a command.
CommandRunner An alternate TradeFederation entry point that will run command specified in command line arguments and then quit.
CommandRunner.ExitCode Error codes that are possible to exit with.
CommandScheduler A scheduler for running TradeFederation commands across all available devices.
CommandScheduler.HostState Enums of different status of host
CommandStatus Represents the status of an timed operation.
CommandStatusHandler Handler helping to monitor and update the status of an invocation.
CommonLogRemoteFileUtil This utility allows to avoid code duplication across the different remote device representation for the remote log fetching logic of common files.
CommonLogRemoteFileUtil.KnownLogFileEntry A representation of a known log entry for remote devices.
CompanionAllocator Base class that takes care of allocating and freeing companion device

getCompanionDeviceSelectionOptions() should be implemented to describe the criteria needed to allocate the companion device

CompanionAwarePreparer An ITargetPreparer that encapsulates the logic of getting an already allocated companion device.
CompanionAwareTest Base test class that encapsulates boilerpate of getting and checking companion device

Subclass may call getCompanion() to retrieve the allocated companion.

CompanionDeviceTracker A class for allocating and freeing companion devices
CompanionRunCommandTargetPreparer A ITargetPreparer that runs specified commands on the allocated companion device
CompanionTestAppInstallSetup A ITargetPreparer that installs one or more apps from a IDeviceBuildInfo#getTestsDir() folder onto an allocated companion device.
CompileBootImageWithSpeedTargetPreparer Recompiles the boot classpath and system server with the compiler filter 'speed'.
ConditionFailureMonitor Monitor for any failures from the invocation.
ConditionPriorityBlockingQueue <T> A thread-safe class with ERROR(/PriorityBlockingQueue) -like operations that can retrieve objects that match a certain condition.
ConditionPriorityBlockingQueue.AlwaysMatch <T> A ConditionPriorityBlockingQueue.IMatcher that matches any object.
ConditionPriorityBlockingQueue.IMatcher <T> An interface for determining if elements match some sort of condition.
ConfigCompleter Implementation of the Completer for our TF configurations.
Configuration A concrete IConfiguration implementation that stores the loaded config objects in a map.
ConfigurationDef Holds a record of a configuration, its associated objects and their options.
ConfigurationDef.ConfigObjectDef Object to hold info for a className and the appearance number it has (eg if a config has the same object twice, the first one will have the first appearance number).
ConfigurationDescriptor Configuration Object that describes some aspect of the configuration itself.
ConfigurationDescriptor.LocalTestRunner Enum used to indicate local test runner.
ConfigurationException Thrown if configuration could not be loaded.
ConfigurationFactory Factory for creating IConfiguration .
ConfigurationFactory.ConfigLoader Implementation of IConfigDefLoader that tracks the included configurations from one root config, and throws an exception on circular includes.
ConfigurationFactory.ExceptionLoader
ConfigurationUtil Utility functions to handle configuration files.
ConfigurationXmlParserSettings A simple class to accept settings for the ConfigurationXmlParser

To pass settings to this class, the alias is mandatory.

ConfigurationYamlParser Parser for YAML style Tradefed configurations
ConfigUtil Utility class for creating, interacting with, and pushing statsd configuration files.
Console Main TradeFederation console providing user with the interface to interact

Currently supports operations such as

  • add a command to test
  • list devices and their state
  • list invocations in progress
  • list commands in queue
  • dump invocation log to file/stdout
  • shutdown
Console.ArgRunnable <T> A ERROR(/Runnable) with a run method that can take an argument
Console.CaptureList A convenience type for List<List<String>>
ConsoleReaderOutputStream An OutputStream that can be used to make System.out.print() play nice with the user's LineReader unfinishedLine.
ConsoleResultReporter Result reporter to print the test results to the console.
ContentProviderHandler Handler that abstract the content provider interactions and allow to use the device side content provider for different operations.
CountingTestResultListener A TestResultListener that tracks the total number of tests by TestStatus
CountTestCasesCollector Count and report the number of test cases for a given IRemoteTest .
CoverageMeasurementForwarder A placeholder test that forwards coverage measurements from the build provider to the logger.
CoverageOptions Tradefed object to hold coverage options.
CoverageOptions.Toolchain
CpuThrottlingWaiter An ITargetPreparer that waits until max frequency on all cores are restored to highest level available
CreateAvdPreparer
CreateUserPreparer Target preparer for creating user and cleaning it up at the end.
CurrentInvocation A class that tracks and provides the current invocation information useful anywhere inside the invocation.
CurrentInvocation.InvocationInfo Some special named key that we will always populate for the invocation.
CurrentInvocation.IsolationGrade Describes the level of isolation

D

DebugHostLogOnFailureCollector Collector that will gather and log the host-side logs when a test case failure occurs.
DefaultConnection Default connection representation of a device, assumed to be a standard adb connection of the device.
DefaultConnection.ConnectionBuilder Builder used to described the connection.
DefaultRemoteAndroidTestRunner Extension of the ddmlib RemoteAndroidTestRunner to set some default for Tradefed use cases.
DefaultTestsZipInstaller A default implementation of tests zip installer.
DelegatedInvocationExecution InvocationExecution which delegate the execution to another Tradefed binary.
DependenciesResolver A new type of provider that allows to get all the dependencies for a test.
DeviceAllocationResult Represents the results of an allocation attempt for a command.
DeviceAllocationState Represents the allocation state of the device from the IDeviceManager perspective
DeviceAvailableChecker Checker to ensure a module doesn't leave the device in an offline state.
DeviceBaselineChecker Set device baseline settings before each module.
DeviceBaselineSetter Abstract class used to create a device baseline setting.
DeviceBatteryLevelChecker An IRemoteTest that checks for a minimum battery charge, and waits for the battery to reach a second charging threshold if the minimum charge isn't present.
DeviceBatteryResourceMetricCollector This collector collects device battery metrics.
DeviceBuildDescriptor A wrapper class for a IBuildInfo , that contains helper methods to retrieve device platform build information.
DeviceBuildInfo A IBuildInfo that represents a complete Android device build and (optionally) its tests.
DeviceBuildInfoBootStrapper A ITargetPreparer that replaces build info fields with attributes read from device

This is useful for testing devices with builds generated from an external source (eg

DeviceBuildInfoInjector A ITargetPreparer that inserts DeviceBuildDescriptor metadata into the IBuildInfo .
DeviceCleaner Performs reboot or format as cleanup action after test, and optionally turns screen off
DeviceCleaner.CleanupAction
DeviceCleaner.PostCleanupAction
DeviceConcurrentUtil Contains utility methods and classes for concurrent device side command execution

Use ERROR(/ExecutorService) to run commands implemented as ShellCommandCallable , and use ERROR(/#joinFuture(String,Future,long)) for synchronization against the ERROR(/Future) as returned by ERROR(/ExecutorService) for the command execution.

DeviceConcurrentUtil.ShellCommandCallable <V> A ERROR(/Callable) that wraps the details of executing shell command on an ITestDevice .
DeviceConfigurationHolder A concrete IDeviceConfiguration implementation that stores the loaded device configuration objects in its attributes.
DeviceDescriptor A class containing information describing a device under test.
DeviceDisconnectedException Thrown when a device is no longer reachable via it's transport type, eg if the device is no longer visible via USB, or TCP/IP connection
DeviceErrorIdentifier Error Identifiers from Device errors and device reported errors.
DeviceFailedToBootError Thrown if a device fails to boot after being flashed with a build.
DeviceFeatureModuleController A module controller to not run tests when it doesn't support certain feature.
DeviceFileReporter A utility class that checks the device for files and sends them to ITestInvocationListener#testLog(String, LogDataType, InputStreamSource) if found.
DeviceFlashPreparer A ITargetPreparer that flashes an image on physical Android hardware.
DeviceFoldableState Representation of device foldable state as returned by "cmd device_state print-states".
DeviceFolderBuildInfo A IDeviceBuildInfo that also contains other build artifacts contained in a directory on the local filesystem.
DeviceImageZipFlashingTargetPreparer A target preparer that flashes the device with device images provided via a specific format.
DeviceInternetAccessibilityResourceMetricCollector The collector pings google.com to check if the device has internet accessibility or not.
DeviceJUnit4ClassRunner JUnit4 test runner that also accommodates IDeviceTest .
DeviceJUnit4ClassRunner.LogAnnotation Fake annotation meant to carry logs to the reporters.
DeviceJUnit4ClassRunner.MetricAnnotation Fake annotation meant to carry metrics to the reporters.
DeviceJUnit4ClassRunner.TestLogData Implementation of ExternalResource and TestRule .
DeviceJUnit4ClassRunner.TestMetrics Implementation of ExternalResource and TestRule .
DeviceManagementGrpcServer GRPC server allowing to reserve a device from Tradefed.
DeviceManager
DeviceManager.FastbootDevice Representation of a device in Fastboot mode.
DeviceMetricData Object to hold all the data collected by metric collectors.
DeviceMonitorMultiplexer A proxy class to propagate requests to multiple IDeviceMonitor s.
DeviceNotAvailableException Thrown when a device is no longer available for testing.
DeviceOwnerTargetPreparer An ITargetPreparer that sets up a device owner component.
DeviceParameterizedRunner JUnit4 style parameterized runner for host-side driven parameterized tests.
DeviceProperties Common constant definitions for device side property names
DeviceRecoveryModeUtil
DeviceReleaseReporter Device release reporter that handles communicating with the parent process the device(s) to be released.
DeviceResetFeature Server side implementation of device reset.
DeviceResetHandler Utility handling generically device resetting.
DeviceRuntimeException Thrown when a device action did not results in the expected results.
DeviceSelectionOptions Container for for device selection criteria.
DeviceSelectionOptions.DeviceRequestedType The different possible types of placeholder devices supported.
DeviceSettingChecker Check if device settings have changed during a module run.
DeviceSetup A ITargetPreparer that configures a device for testing based on provided Option s.
DeviceStateMonitor Helper class for monitoring the state of a IDevice .
DeviceStorageAgeResourceMetricCollector Parse storage age from logcat.
DeviceStorageFiller Target preparer to fill up storage so some amount of free space is available.
DeviceStorageStatusChecker Check if device has enough disk space for the given partitions.
DeviceStringPusher Target preparer to write a string to a file.
DeviceSuite Extends the JUnit4 container Suite in order to provide a ITestDevice to the tests that requires it.
DeviceSyncHelper Helper that helps syncing a new device image to the device.
DeviceTestCase Helper JUnit test case that provides the IRemoteTest and IDeviceTest services.
DeviceTestResult An specialization of TestResult that will abort when a DeviceNotAvailableException occurs
DeviceTestResult.RuntimeDeviceNotAvailableException
DeviceTestRunOptions A builder class for options related to running device tests through BaseHostJUnit4Test.
DeviceTestSuite Helper JUnit test suite that provides the IRemoteTest and IDeviceTest services.
DeviceTraceCollector Collector that will start perfetto trace when a test run starts and log trace file at the end.
DeviceUnavailableMonitor This listener attempts to capture a test case level DNAE only.
DeviceUnresponsiveException A specialization of DeviceNotAvailableException that indicates device is visible to adb, but is unresponsive (ie, commands timing out, won't boot, etc)
DeviceUpdateTargetPreparer An abstract ITargetPreparer that takes care of common steps around updating devices with a device image file from an external source (as opposed to a build service).
DeviceWifiResourceMetricCollector The collector collects current connected wifi signal strength and link speed metrics.
DeviceWiper A ITargetPreparer that wipes userdata
DirectedGraph <V> A directed unweighted graphs implementation.
DisableSELinuxTargetPreparer Target preparer that disables SELinux if enabled.
DryRunKeyStore A keystore for dry-run where any keystore value is always properly replaced and found.
DryRunner Transparently dry runs tests instead of actually executing them.
DynamicFileStubTest This is a tradefed test to test tradefed can resolve dynamic file correctly.
DynamicRemoteFileResolver Class that helps resolving path to remote files.
DynamicRemoteFileResolver.FileResolverLoader Loads implementations of IRemoteFileResolver .
DynamicSystemPreparer An ITargetPreparer that sets up a system image on top of a device build with the Dynamic System Update.

E

EarlyDeviceReleaseFeature Feature server implementation for early device release.
Email A helper class to send an email.
EmailHostHealthAgent A IHostHealthAgent implementation to send email from Host monitor reports
EmmaXmlConstants Constants used when parsing emma xml report.
EmulatorMemoryCpuCapturer
EndCentralDirectoryInfo EndCentralDirectoryInfo is a class containing the overall information of a zip file.
EnforcedSeLinuxChecker Status checker that ensures the status of Selinux.
EraseUserDataPreparer A ITargetPreparer that wipes user data on the device.
ErrorIdentifier This interface describes a specific error and its properties.
ErrorStorageUtil Helper class for manipulating the errors to align with the common storage.
EventsLoggerListener Listener that logs all the events it receives into a file
ExceptionThrowingRunnerWrapper
ExecutableBaseTest Base class for executable style of tests.
ExecutableHostTest Test runner for executable running on the host.
ExecutableTargetTest Test runner for executable running on the target.
ExecutionFiles Files dependencies generated during the execution of a test or invocation that need to be carried for testing.
ExecutionFiles.FilesKey Enumeration of known standard key for the map.
ExecutionProperties Properties generated during the execution of a test or invocation.
ExistingBuildProvider A IBuildProvider that returns an already constructed IBuildInfo .
ExtendedFile A extension of standard file to carry a build related metadata.

F

FailureDescription The class describing a failure information in Trade Federation.
FakeTest A fake test whose purpose is to make it easy to generate repeatable test results.
FakeTestsZipFolder A testing fixture that creates a fake unzipped tests folder based on a list of content.
FakeTestsZipFolder.ItemType
FastbootCommandPreparer Target preparer that triggers fastboot and sends fastboot commands.
FastbootDeviceFlasher A class that relies on fastboot to flash an image on physical Android hardware.
FastbootHelper A helper class for fastboot operations.
FastbootUpdateBootstrapPreparer An ITargetPreparer that stages specified files (bootloader, radio, device image zip) into IDeviceBuildInfo to get devices flashed with FastbootDeviceFlasher , then injects post-boot device attributes into the build info for result reporting purposes.
FatalHostError An exception that indicates a fatal unrecoverable error has occurred on the host machine running TradeFederation, and that the TradeFederation instance should be shut down.
FeatureFlagTargetPreparer Updates the DeviceConfig (feature flags tuned by a remote service).
FileDownloadCache A helper class that maintains a local filesystem LRU cache of downloaded files.
FileDownloadCacheFactory A factory for creating FileDownloadCache
FileDownloadCacheWrapper A wrapper class that provides FileDownloadCache facilities while implementing the IFileDownloader interface.
FileIdleMonitor Monitors files and executes a callback if they have been idle (ie
FileInputStreamSource A InputStreamSource that takes an input file.
FileLogger A ILeveledLogOutput that directs log messages to a file and to stdout.
FileProtoResultReporter Proto reporter that dumps the TestRecord into a file.
FilePullerDeviceMetricCollector A BaseDeviceMetricCollector that listen for metrics key coming from the device and pull them as a file from the device.
FilePullerLogCollector Logger of the file reported by the device-side.
FileSystemLogSaver Save logs to a file system.
FileUtil A helper class for file related operations
FileUtil.HarnessIOException Harness exception that helps carrying file issues.
FileUtil.LowDiskSpaceException Thrown if usable disk space is below minimum threshold.
FilteredResultForwarder Variant of ResultForwarder that only allows an allowlist of TestDescription to be reported.
FixedByteArrayOutputStream An in-memory ERROR(/OutputStream) that only keeps a maximum amount of data.
FlashingMethod An enum to describe the method used to flash device under test
FlashingResourcesParser A class that parses out required versions of auxiliary image files needed to flash a device.
FlashingResourcesParser.AndroidInfo A typedef for Map&lt;String, MultiMap&lt;String, String&gt;&gt; .
FlashingResourcesParser.Constraint A filtering interface, intended to allow FlashingResourcesParser to ignore some resources that it otherwise might use
FlashingResourceUtil This utility helps setting the appropriate version of artifacts so they can be flashed via DeviceFlashPreparer .
FoldableExpandingHandler A IModuleParameterHandler expanding into more for each non-primary foldable configuration.
FoldableHandler Generic foldable handler that can take the foldable parameters to create a specialized module.
FoldableModePreparer A target preparer that can switch the foldable state of a device.
FolderBuildInfo Concrete implementation of a IFolderBuildInfo .
FolderSaver A ITargetPreparer that pulls directories off device, compresses and saves it into logging backend.
FormattedGeneratorReporter Reporter that allows to generate reports in a particular format.
FreeDeviceState
FuseUtil A helper class for FUSE operations.

G

GceAvdInfo Structure to hold relevant data for a given GCE AVD instance.
GceAvdInfo.GceStatus
GceAvdInfo.LogFileEntry
GceManager Helper that manages the GCE calls to start/stop and collect logs from GCE.
GceRemoteCmdFormatter Utility class to format commands to reach a remote gce device.
GceRemoteCmdFormatter.ScpMode SCP can be used to push or pull file depending of the structure of the args.
GceSshTunnelMonitor Thread Monitor for the Gce ssh tunnel.
GcovCodeCoverageCollector A BaseDeviceMetricCollector that will pull gcov coverage measurements off of the device and log them as test artifacts.
GcovKernelCodeCoverageCollector A BaseDeviceMetricCollector that will pull gcov kernel coverage measurements out of debugfs and off of the device and then finally logs them as test artifacts.
GCSBucketUtil File manager to download and upload files from Google Cloud Storage (GCS).
GCSBucketUtil.GCSFileMetadata Simple wrapper for file info in GCS.
GCSCommon Base class for Gcs operation like download and upload.
GCSConfigurationFactory A ConfigurationFactory loads configs from Google Cloud Storage.
GCSConfigurationFactory.GCSConfigLoader Extension of ConfigurationFactory.ConfigLoader that loads config from GCS, tracks the included configurations from one root config, and throws an exception on circular includes.
GCSConfigurationServer Config server loads configs from Google Cloud Storage (GCS).
GCSDownloaderHelper Downloader for GCS bucket that takes care of caching and resolving the global config.
GCSFileDownloader File downloader to download file from google cloud storage (GCS).
GCSFileUploader File uploader to upload file data to google cloud storage (GCS).
GCSHostResourceManager Download host resource from GCS (Google cloud storage).
GcsRemoteFileResolver Implementation of IRemoteFileResolver that allows downloading from a GCS bucket.
GenericLogcatEventParser <LogcatEventType> Parse logcat input for events.
GenericLogcatEventParser.LogcatEvent Struct to hold a logcat event with the event type and triggering logcat message
GetPreviousPassedHelper Helper to get the previous passed test filters.
GkiDeviceFlashPreparer A target preparer that flash the device with android common kernel generic image.
GlobalConfiguration An IGlobalConfiguration implementation that stores the loaded config objects in a map
GlobalFilterGetter Service implementation that returns the filters of a given invocation.
GlobalTestFilter Filter options applied to the invocation.
GoogleApiClientUtil Utils for create Google API client.
GoogleBenchmarkResultParser Parses the results of Google Benchmark that run from shell, and return a map with all the results.
GoogleBenchmarkTest A Test that runs a Google benchmark test package on given device.
GranularRetriableTestWrapper A wrapper class works on the IRemoteTest to granulate the IRemoteTest in testcase level.
GranularRetriableTestWrapper.StartEndCollector Class helper to catch missing run start and end.
GsiDeviceFlashPreparer A target preparer that flashes the device with android generic system image.
GTest A Test that runs a native test package on given device.
GTestBase The base class of gTest
GTestListTestParser A result parser for gtest dry run mode with "--gtest_list_tests" parameter.
GTestResultParser Parses the 'raw output mode' results of native tests using GTest that run from shell, and informs a ITestInvocationListener of the results.
GTestXmlResultParser Parses the 'xml output mode' results of native tests using GTest that run from shell, and informs a ITestRunListener of the results.

H

HarnessException Base exception class for exception thrown within the harness.
HarnessRuntimeException
HeapHostMonitor AbstractHostMonitor implementation that monitors the heap memory on the host and log it periodically to the history log.
HelloWorldMultiTargetPreparer An example implementation of a IMultiTargetPreparer .
HistoryLogger TF History Logger,只包含一些特定事件的特殊日誌。
HostGTest A Test that runs a native test package.
HostMetric This class represents a host metric sample to be reported.
HostOptions Host options holder class.
HostStatsdMetricCollector A IMetricCollector that collects statsd metrics from host side using statsd utility commands.
HostTest A test runner for JUnit host based tests.
HostUtils Implements some useful utility methods for running host tests.
HprofAllocSiteParser Helper class to parse info from an Allocation Sites section of hprof reports.
HttpHelper Contains helper methods for making http requests
HttpHelper.RequestRunnable Runnable for making requests with IRunUtil#runEscalatingTimedRetry(long, long, long, long, IRunnableResult) .
HttpMultipartPost Helper class for making multipart HTTP post requests.
HttpRemoteFileResolver Implementation of IRemoteFileResolver that allows downloading remote file via http
HttpsRemoteFileResolver Implementation of IRemoteFileResolver that allows downloading remote file via https

I

IAbi Interface representing the ABI under test.
IAbiReceiver A test that needs the ABI under test.
IAndroidDebugBridge Interface definition for AndroidDebugBridge methods used in this package.
IAppBuildInfo This interface is deprecated. Use IBuildInfo directly.
IAutoRetriableTest Interface for an IRemoteTest that doesn't implement ITestFilterReceiver but still wishes to support auto-retry.
IBatteryInfo The interface defining the interaction with a battery of a device.
IBatteryInfo.BatteryState Describes the current battery charging state.
IBuildInfo Holds information about the build under test.
IBuildInfo.BuildInfoProperties Some properties that a IBuildInfo can have to tweak some handling of it.
IBuildProvider Responsible for providing info regarding the build under test.
IBuildReceiver A test that needs reference to the build under test.
IClusterClient An interface for interacting with the TFC backend.
IClusterEvent Interface for any cluster event to be uploaded to TFC.
IClusterEventUploader <T extends IClusterEvent > Interface for ClusterEventUploader
IClusterOptions An interface for getting cluster-related options.
ICommandOptions Container for execution options for commands.
ICommandScheduler A scheduler for running TradeFederation commands.
ICommandScheduler.IScheduledInvocationListener Listener for invocation events when invocation completes.
ICompressionStrategy An interface representing a compression algorithm that can be selected at runtime.
IConfigOptionValueTransformer An interface for manipulating config option value
IConfigurableVirtualDevice An interface to provide information about a possibly preconfigured virtual device info (host ip, host user, ports offset and etc.).
IConfiguration Configuration information for a TradeFederation invocation.
IConfigurationFactory Factory for creating IConfiguration s
IConfigurationReceiver Simple interface to represent object that accepts an IConfiguration .
IConfigurationServer An interface for config server.
ICredentialFactory An interface for credential factory to create oauth2 Credential .
IDefaultObjectLoader Interface for loading the default objects that should be part of our YAML configuration.
IDefaultObjectLoader.LoaderConfiguration The loading configuration object to pass information to the loader.
IDeviceActionReceiver Provides an API to receive device events.
IDeviceBuildInfo A IBuildInfo that represents a complete Android device build and (optionally) its tests.
IDeviceBuildProvider A IBuildProvider that uses information from a ITestDevice to retrieve a build.
IDeviceConfiguration Device Configuration Holder Interface.
IDeviceFlasher Flashes a device image on a device.
IDeviceFlasher.UserDataFlashOption Enum of options for handling the userdata image
IDeviceManager Interface for managing the set of available devices for testing.
IDeviceManager.IFastbootListener A listener for fastboot state changes.
IDeviceMonitor Interface for monitoring state of devices.
IDeviceMonitor.DeviceLister A ERROR(/Runnable) -like class that should return the known devices and their states.
IDeviceRecovery Interface for recovering a device that has gone offline.
IDeviceSelection Interface for device selection criteria.
IDeviceSelection.BaseDeviceType
IDeviceStateMonitor Provides facilities for monitoring the state of a IDevice .
IDeviceTest Interface for object that needs a reference to a ITestDevice .
IDisableable Interface that describes a Tradefed object that can be disabled.
IEmail Interface for sending email.
IEmail.Message Container for email message data.
IFileDownloader Interface for downloading a remote file.
IFileEntry Interface definition that provides simpler, mockable contract to FileEntry methods.
IFileResolverLoader Loads implementations of IRemoteFileResolver .
IFileResolverLoader.ResolverLoadingException Exception thrown if a resolver cannot be loaded or initialized.
IFlashingResourcesParser Interface for providing required versions of auxiliary image files needed to flash a device.
IFlashingResourcesRetriever Interface for retrieving auxiliary image files needed to flash a device.
IFolderBuildInfo A simple abstract IBuildInfo whose build artifacts are containing in a local filesystem directory.
IFormatterGenerator Interface describing a formatter for SuiteResultHolder .
IGlobalConfiguration A class to encompass global configuration information for a single Trade Federation instance (encompassing any number of invocations of actual configurations).
IHarnessException Description of the harness exception interface that will be implemented by harness exceptions.
IHostCleaner Cleans up the host after the test run has finished.
IHostHealthAgent An interface to emit host or device metrics.
IHostMonitor Interface to dispatch host data
IHostMonitor.HostDataPoint Generic class for data to be reported.
IHostMonitor.HostMetricType
IHostOptions Host options holder interface.
IHostOptions.PermitLimitType Enum describing the possible permit limiters
IHostResourceManager Interface to manager host resource.
IHttpHelper Helper methods for performing http requests.
IHttpHelper.DataSizeException
IInvocationContext Holds information about the Invocation for the tests to access if needed.
IInvocationContext.TimingEvent
IInvocationContextReceiver A test that needs reference to the context of the invocation.
IInvocationExecution Interface describing the actions that will be done as part of an invocation.
IKeyStoreClient Interface to access a key store for password or sensitive data.
IKeyStoreFactory Factory for creating IKeyStoreClient .
ILabPreparer Marker interface for lab preparers

See ITargetPreparer for a description of what these interfaces are intended.

ILeveledLogOutput Classes which implement this interface provides methods that deal with outputting log messages.
ILogcatReceiver A class that provides the output of a device's logcat as an InputStreamSource .
ILogRegistry An interface for a ILogOutput singleton logger that multiplexes and manages different loggers.
ILogRegistry.EventType Events that are useful to be logged
ILogSaver Classes which implement this interface provide methods for storing logs to a central location.
ILogSaverListener Allows for ITestInvocationListener s to listen for when log files are saved.
IManagedTestDevice A ITestDevice whose lifecycle is managed.
IManagedTestDevice.DeviceEventResponse Container for a response to a IManagedTestDevice#handleAllocationEvent(DeviceEvent) call
IManagedTestDeviceFactory Creator interface for IManagedTestDevice s
IMetricCollector This interface will be added as a decorator when reporting tests results in order to collect matching metrics.
IMetricCollectorReceiver Interface for IRemoteTest s to implement if they need to get the list of IMetricCollector s for the test run.
IMoblyYamlResultHandler Interface of mobly yaml result handler.
IMoblyYamlResultHandler.ITestResult Interface of mobly yaml result
IModuleController Interface for controlling if a module should be executed or not.
IModuleController.RunStrategy Enum describing how the module should be executed.
IModuleParameterHandler The interface for parameters of suites modules.
IMultiDeviceRecovery Interface for recovering multiple offline devices.
IMultiDeviceTest This interface is deprecated. This interface is kept temporarily for compatibility but is not actually used anymore. Please do not implement it.
IMultiTargetPreparer Prepares the test environment for several devices together.
INativeDevice Provides an reliable and slightly higher level API to a ddmlib IDevice .
INativeDeviceTest Interface for object that needs a reference to a INativeDevice .
InfraErrorIdentifier Error Identifiers from Trade Federation infra, and dependent infra (like Build infra).
InputStreamSource This interface basically wraps an ERROR(/InputStream) to make it clonable.
InstallAllTestZipAppsSetup A ITargetPreparer that installs all apps in a test zip.
InstallApexModuleTargetPreparer
InstallApkSetup A ITargetPreparer that installs one or more apks located on the filesystem.
InstallBuildEnvApkSetup A ITargetPreparer that installs one or more test apks from an Android platform build env.
InstalledInstrumentationsTest Runs all instrumentation found on current device.
InstantAppHandler Handler for ModuleParameters#INSTANT_APP .
InstrumentationPreparer A ITargetPreparer that runs instrumentation
InstrumentationTest A Test that runs an instrumentation test package on given device.
InvocationContext Generic implementation of a IInvocationContext .
InvocationExecution Class that describes all the invocation steps: build download, target_prep, run tests, clean up.
InvocationLocal <T> This class provides invocation-scope variables.
InvocationMetricLogger A utility class for an invocation to log some metrics.
InvocationMetricLogger.InvocationGroupMetricKey Grouping allows to log several groups under a same key.
InvocationMetricLogger.InvocationMetricKey Some special named key that we will always populate for the invocation.
InvocationStatus A class to store invocation status.
InvocationStatus A helper enum to represent the invocation status
InvocationSummaryHelper Helper class for gathering and reporting TestSummary for set of listeners
InvocationToJUnitResultForwarder A class that listens to ITestInvocationListener events and forwards them to a TestListener .
IPostProcessor Post processors is a Trade Federation object meant to allow the processing of metrics and logs AFTER the tests and BEFORE result reporting.
IRemoteFeature Interface describing a feature in Tradefed that can be executed based on the request.
IRemoteFileResolver Interface for objects that can resolve a remote file into a local one.
IRemoteFileResolver.RemoteFileResolverArgs The args passed to the resolvers
IRemoteFileResolver.ResolvedFile Class holding information about the resolved file and some metadata.
IRemoteScheduledListenersFeature Extension of IRemoteFeature to support passing in IScheduledInvocationListener s.
IRemoteTest A test that reports results directly to a ITestInvocationListener .
IReportNotExecuted In case of an incomplete execution, IRemoteTest that implements this interface may report their non-executed tests for improved reporting.
IRescheduler Interface for rescheduling a config for future execution.
IResourceMetricCollector The interface for user to implement customized resource collectors.
IRestApiHelper A helper interface for performing REST API calls.
IResumableTest This interface is deprecated. No need for this anymore
IRetryDecision Interface driving the retry decision and applying the filter on the class for more targeted retry.
IRuntimeHintProvider
IRunUtil Interface for running timed operations and system commands.
IRunUtil.EnvPriority Enum that defines whether setting or unsetting a particular env.
IRunUtil.IRunnableResult An interface for asynchronously executing an operation that returns a boolean status.
ISandbox Interface defining a sandbox that can be used to run an invocation.
ISandboxFactory Factory for creating ISandbox .
ISetOptionReceiver Implementation of this interface should have an Option with a "set-option" name linked to HostTest#SET_OPTION_NAME .
IShardableListener A ITestInvocationListener that can be sharded.
IShardableTest A IRemoteTest that can be split into separately executable sub-tests.
IShardHelper Interface of an object that describes the sharding strategy to adopt for a configuration.
IsolatedHostTest Implements a TradeFed runner that uses a subprocess to execute the tests in a low-dependency environment instead of executing them on the main process.
ISupportGranularResults Interface specifying whether a ITestInvocationListener supports receiving the granular results or not.
ISystemStatusChecker An checker that performs checks on system status and returns a boolean to indicate if the system is in an expected state.
ISystemStatusCheckerReceiver A IRemoteTest that requires access to the ISystemStatusChecker from the configuration.
ITargetCleaner This interface is deprecated. tearDown has been moved to the base ITargetPreparer interface.
ITargetPreparer Prepares the test environment for the test run.
ITerribleFailureHandler An interface to handle terrible failures from LogUtil.CLog.wtf(String, Throwable)
ITestAnnotationFilterReceiver A runner that can filter which tests to run based on annotations.
ITestCollector Provides support for test collection; when set, test runner must perform a dry run to collect test cases without actually executing them.
ITestDevice Provides an reliable and slightly higher level API to a ddmlib IDevice .
ITestDevice.ApexInfo A simple struct class to store information about a single APEX
ITestDevice.MountPointInfo A simple struct class to store information about a single mountpoint
ITestDevice.RecoveryMode
ITestFileFilterReceiver A runner that can receive a file specifying which tests to run and/or not to run.
ITestFilterReceiver A runner that can filter which tests to run.
ITestInformationReceiver Interface to receive the TestInformation for some classes.
ITestInvocation Handles one TradeFederation test invocation.
ITestInvocation.ExitInformation Represents some exit information for an invocation.
ITestInvocationListener Listener for test results from the test invocation.
ITestLifeCycleReceiver Receives event notifications during instrumentation test runs.
ITestLogger An entity that can perform logging of data streams of various types.
ITestLoggerReceiver An entity that can be injected with an ITestLogger instance so that it can be used for logging purposes.
ITestsPool Interface describing a pool of tests that we can access and run
ITestSuite Abstract class used to run Test Suite.
ITestSuite.MultiDeviceModuleStrategy
ITestSuiteResultLoader Interface describing an helper to load previous results in a way that can be re-run.
ITestSummaryListener Interface that allows ITestInvocationListener to exchange some limited information via summaries.
ITestsZipInstaller Installs tests from a tests zip file (as outputted by the build system) on a device.
ITokenProvider Interface describing an object that can provide the tokens of a particular device.
ITokenRequest Interface a IRemoteTest can implement to expose the fact that it requires a device with a special token.

J

JarHostTest Test runner for host-side JUnit tests.
JarHostTest.HostTestListener Wrapper listener that forwards all events except testRunStarted() and testRunEnded() to the embedded listener.
JavaCodeCoverageCollector A BaseDeviceMetricCollector that will pull Java coverage measurements off of the device and log them as test artifacts.
JavaCodeCoverageFlusher A utility class that resets and forces a flush of Java code coverage measurements from processes running on the device.
JSONFileKeyStoreClient A sample implementation where a local JSON file acts a key store.
JSONFileKeyStoreFactory Implementation of a JSON KeyStore Factory, which provides a JSONFileKeyStoreClient for accessing a JSON Key Store File.
JsonHttpTestResultReporter A result reporter that encode test metrics results and branch, device info into JSON and POST into an HTTP service endpoint
JUnit4ResultForwarder Result forwarder from JUnit4 Runner.
JUnit4TestFilter Helper Class that provides the filtering for JUnit4 runner by extending the Filter .
JUnitRunUtil A helper class for directing a IRemoteTest#run(TestInformation, ITestInvocationListener) call to a Test#run(TestResult) call.
JUnitToInvocationResultForwarder A class that listens to TestListener events and forwards them to an ITestInvocationListener .
JUnitXmlParser Parser that extracts test result data from JUnit results stored in ant's XMLJUnitResultFormatter and forwards it to a ITestInvocationListener.

K

KeyguardControllerState A container for the keyguard states.
KeyguardStatusChecker Checks the keyguard status after module execution.
KeyStoreException Thrown when a fatal key store error happens.
KillExistingEmulatorPreparer A ITargetPreparer that shuts down a running emulator.
KnownFailurePreparer Target preparer to skip retrying known failure.

L

LabResourceDeviceMonitor The lab resource monitor which initializes/manages the gRPC server for LabResourceService.
LargeOutputReceiver A class designed to help run long running commands collect output.
LastShardDetector When running local sharding, sometimes we only want to execute some actions when the last shard reaches invocationEnded(long) .
LaunchCvdHelper Utility helper to control Launch_cvd in the Cuttlefish VM.
LeakedThreadStatusChecker Status checker to ensure a module does not leak a running Thread.
LegacySubprocessResultsReporter A frozen implementation of the subprocess results reporter which should remain compatible with earlier versions of TF/CTS (eg 8+), despite changes in its superclass.
ListInstrumentationParser A IShellOutputReceiver that parses the output of a 'pm list instrumentation' query
ListInstrumentationParser.InstrumentationTarget
LocalAndroidVirtualDevice The class for local virtual devices running on TradeFed host.
LocalAppBuildProvider A IBuildProvider that constructs a IBuildInfo based on a provided local path
LocalDeveloper Detects and returns whether this is a local developer running Tradefed.
LocalDeviceBuildProvider A IBuildProvider that constructs a IDeviceBuildInfo based on a provided filesystem directory path.
LocalEmulatorLaunch A TargetPreparer that launches an emulator locally from an android build environment.
LocalEmulatorSnapshot A TargetPreparer intended for generating a clean emulator snapshot from a android build/development environment
LocalFileHeader LocalFileHeader is a class containing the information of a file/folder inside a zip file.
LocalFileResolver Implementation of IRemoteFileResolver that allows linking local files
LocalFolderBuildProvider A IBuildProvider that constructs a IFolderBuildInfo based on a provided local path
LocalHostResourceManager Manager host resource.
LocalPool Implementation of a pool of local tests
LocalRunInstructionBuilder Utility to compile the instruction to run test locally.
LockSettingsBaselineSetter A setter to remove screen lock settings.
LogcatCrashResultForwarder Special listener: on failures (instrumentation process crashing) it will attempt to extract from the logcat the crash and adds it to the failure message associated with the test.
LogcatEventParser
LogcatEventType Event types for LogcatEventParser .
LogcatOnFailureCollector Collector that will capture and log a logcat when a test case fails.
LogcatReceiver Class that collects logcat in background.
LogcatTimingMetricCollector A metric collector that collects timing information (eg user switch time) from logcat during one or multiple repeated tests by using given regex patterns to parse start and end signals of an event from logcat lines.
LogDataType Represents the data type of log data.
LogFile Class to hold the metadata for a saved log file.
LogFileSaver A helper for ITestInvocationListener 's that will save log data to a file
LogReceiver
LogRegistry A ILogRegistry implementation that multiplexes and manages different loggers, using the appropriate one based on the ERROR(/ThreadGroup) of the thread making the call.
LogSaverResultForwarder A ResultForwarder for saving logs with the global file saver.
LogUtil A logging utility class.
LogUtil.CLog A shim class for Log that automatically uses the simple classname of the caller as the log tag

M

MainlineModuleHandler A simple handler class for Mainline Modules that creates a InstallApexModuleTargetPreparer and injects the dynamic link into it based on the given mainline modules to automatically retrieve those modules.
MainlineTestModuleController Base class for a module controller to run tests based on the preloaded mainline modules on the device under test.
ManagedRemoteDevice A device running inside a virtual machine that we manage remotely via a Tradefed instance inside the VM.
ManagedTestDeviceFactory Factory to create the different kind of devices that can be monitored by Tf
MaxSdkModuleController Base class for a module controller to not run tests on versions above a specified SDK version number.
MergedZipEntryCollection Merge individual zip entries in a large zip file into blocks to minimize the download attempts.
MergeMultiBuildTargetPreparer A IMultiTargetPreparer that allows to pass information from one build to another by naming them and the file key to copy to the other build.
MergeStrategy Describes how the results should be aggregated when multiple attempts are present.
MetricFilePostProcessor Used for uploading the metrics log file collected during the test and run level.
MetricOption Annotation for test methods annotated with @Test , or if the annotation is part of the annotation list of TestDescription that allows to specify some extra parameters useful for: Tuning the behavior of the collectors, filtering some methods.
MetricsXMLResultReporter MetricsXMLResultReporter writes test metrics and run metrics to an XML file in a folder specified by metrics-folder parameter at the invocationEnded phase of the test.
MetricTestCase Extension of TestCase that allows to log metrics when running as part of TradeFed.
MetricTestCase.LogHolder Structure to hold a log file to be reported.
MetricUtil Utility class for pulling metrics from pushed statsd configurations.
MetricUtility Contains common utility methods for storing the test metrics, aggregating the metrics in similar tests and writing the metrics to a file.
MinApiLevelModuleController Base class for a module controller to not run tests when it below a specified API Level.
MinSdkModuleController Base class for a module controller to not run tests on versions below a specified SDK version number.
MixImageZipPreparer An IMultiTargetPreparer that mixes a system build's images in a device build.
MixKernelTargetPreparer A ITargetPreparer that allows to mix a kernel image with the device image.
MoblyBinaryHostTest Host test meant to run a mobly python binary file from the Android Build system (Soong)
MoblyYamlResultControllerInfoHandler Mobly yaml result 'Controller Info' element handler.
MoblyYamlResultControllerInfoHandler.ControllerInfo
MoblyYamlResultControllerInfoHandler.ControllerInfo.Builder
MoblyYamlResultHandlerFactory Mobly yaml result handler factory which generates appropriate handler based on result type.
MoblyYamlResultHandlerFactory.InvalidResultTypeException
MoblyYamlResultHandlerFactory.Type
MoblyYamlResultParser Mobly yaml test results parser.
MoblyYamlResultRecordHandler Mobly yaml result 'Record' element handler.
MoblyYamlResultRecordHandler.Record
MoblyYamlResultRecordHandler.Record.Builder
MoblyYamlResultRecordHandler.RecordResult
MoblyYamlResultSummaryHandler Mobly yaml result 'Summary' element handler.
MoblyYamlResultSummaryHandler.Summary
MoblyYamlResultSummaryHandler.Summary.Builder
MoblyYamlResultTestNameListHandler Mobly yaml result 'Test Name List' element handler.
MoblyYamlResultTestNameListHandler.TestNameList
MoblyYamlResultTestNameListHandler.TestNameList.Builder
MoblyYamlResultUserDataHandler Mobly yaml result 'User Data' element handler.
MoblyYamlResultUserDataHandler.UserData
MoblyYamlResultUserDataHandler.UserData.Builder
ModifiedFilesParser Class responsible to parse and extract information from modified_files.json.
ModuleDefinition Container for the test run configuration.
ModuleListener Listener attached to each IRemoteTest of each module in order to collect the list of results.
ModuleLogcatCollector Version of logcat collector but for module.
ModuleMerger Helper class for operation related to merging ITestSuite and ModuleDefinition after a split.
ModuleOemTargetPreparer
ModuleParameters Special values associated with the suite "parameter" keys in the metadata of each module.
ModuleParametersHelper Helper to get the IModuleParameterHandler associated with the parameter.
ModulePusher
ModulePusher.ModulePushError Fatal error during Mainline module push.
ModuleSplitter Helper to split a list of modules represented by IConfiguration into a list of execution units represented by ModuleDefinition .
MultiFailureDescription Collect multiple FailureDescription in one holder.
MultiMap <K, V> A ERROR(/Map) that supports multiple values per key.

N

NameMangleListener A proxy listener to translate test method, class, and package names as results are reported.
NativeBenchmarkTest A Test that runs a native benchmark test executable on given device.
NativeBenchmarkTestParser A IShellOutputReceiver that parses the benchmark test data output, collecting metrics on average time per operation.
NativeBridgeModuleController A module controller to check if a device support native bridge.
NativeCodeCoverageFlusher A utility class that clears native coverage measurements and forces a flush of native coverage data from processes on the device.
NativeDevice Default implementation of a ITestDevice Non-full stack android devices.
NativeDevice.AdbAction A ERROR(DeviceAction/com.android.tradefed.device.NativeDevice.DeviceAction DeviceAction) for running a OS 'adb ....' command.
NativeDevice.AdbShellAction
NativeDevice.RebootDeviceAction ERROR(DeviceAction/com.android.tradefed.device.NativeDevice.DeviceAction DeviceAction) for rebooting a device.
NativeDevice.RebootMode A mode of a reboot.
NativeDeviceStateMonitor Helper class for monitoring the state of a IDevice with no framework support.
NativeLeakCollector A ITargetPreparer that runs 'dumpsys meminfo --unreachable -a' to identify the unreachable native memory currently held by each process.
NativeStressTest A Test that runs a native stress test executable on given device.
NativeStressTestParser A IShellOutputReceiver that parses the stress test data output, collecting metrics on number of iterations complete and average time per iteration.
NegativeHandler Handler that specify that nothing should be done and the parameter should not create any extra module.
NestedDeviceStateMonitor Device state monitor that executes extra checks on nested device to accommodate the specifics of the virtualized environment.
NestedRemoteDevice Representation of the device running inside a remote Cuttlefish VM.
NetworkNotAvailableException Thrown when a device is not able to connect to network for testing.
NoApkTestSkipper Special preparer that allows to skip an invocation completely (preparation and tests) if there are no apks to tests.
NoDeviceException Thrown when there's no device to execute a given command.
NoisyDryRunTest Run noisy dry run on a command file.
NoOpConfigOptionValueTransformer An no-op IConfigOptionValueTransformer
NotMultiAbiHandler Special handler that notify the SuiteModuleLoader that the secondary abi should not create a module.
NullDevice A placeholder IDevice used by DeviceManager to allocate when IDeviceSelection#nullDeviceRequested() is true

O

OpenObjectLoader Loader for the default objects available in AOSP.
Option Annotates a field as representing a IConfiguration option.
Option.Importance
OptionClass Annotates a class as representing a IConfiguration object.
OptionCopier A helper class that can copy Option field values with same names from one object to another.
OptionDef Holds the details of an Option .
OptionFetcher Helper to get the test options from the parent process.
OptionNotAllowedException Specific ConfigurationException when an option is not allowed to be passed in the command line.
OptionSetter Populates Option fields.
OptionSetter.OptionFieldsForName Container for the list of option fields with given name.
OptionUpdateRule Controls the behavior when an option is specified multiple times.
OtaDeviceBuildInfo A IDeviceBuildInfo used for over-the-air update testing.
OtatoolsBuildInfo An IBuildInfo that contains otatools artifacts.
OtaZipfileBuildProvider Provides a IBuildInfo based on a local OTA zip file.
OxygenClient A class that manages the use of Oxygen client binary to lease or release Oxygen device.
OxygenUtil Utility to interact with Oxygen service.

P

PackageInfo Container for an application's package info parsed from device.
PackageInstalledModuleController Module controller to not run tests when the device has not got the given packages installed.
Pair <A, B> Define our own Pair class which contains two objects.
PairingMultiTargetPreparer A multi-target preparer helps make Bluetooth pairing (and connection) between two devices.
ParallelDeviceExecutor <V> Wrapper of ERROR(/ExecutorService) to execute a function in parallel.
ParentSandboxInvocationExecution Version of InvocationExecution for the parent invocation special actions when running a sandbox.
ParentShardReplicate Replicate a setup for one device to all other devices that will be part of sharding.
PassingTestFileReporter A ITestInvocationListener that saves the list of passing test cases to a test file
PerfettoGenericPostProcessor A post processor that processes text/binary metric perfetto proto file into key-value pairs by recursively expanding the proto messages and fields with string values until the field with numeric value is encountered.
PerfettoGenericPostProcessor.AlternativeParseFormat
PerfettoGenericPostProcessor.METRIC_FILE_FORMAT
PerfettoPreparer Perfetto preparer pushes the config file in to the device at a standard location to which perfetto have access to.
PerfettoPullerMetricCollector Base implementation of FilePullerDeviceMetricCollector that allows pulling the perfetto files from the device and collect the metrics from it.
PerfettoPullerMetricCollector.METRIC_FILE_FORMAT
PerfettoTraceRecorder A utility class for recording perfetto trace on a ITestDevice .
PrettyPrintDelimiter Helper utility that helps to print delimited message that stands out.
PrettyTestEventLogger Logger matching the events and logging them in order to make it easier to debug.
ProcessInfo Used to store process related(USER, PID, NAME, START TIME IN SECOND SINCE EPOCH) information.
ProfileParameterHandler Base parameter handler for any profile user.
ProfileTargetPreparer Base class for setting up target preparer for any profile user android.os.usertype.profile.XXX .
PropertyChanger A utility class for changing (or adding) items in an Android property file
ProtoResultParser Parser for the Tradefed results proto format.
ProtoResultParser.TestLevel Enumeration representing the current level of the proto being processed.
ProtoResultReporter Result reporter build a TestRecord protobuf with all the results inside.
ProtoUtil Utility methods for dealing with protobuf messages type-agnostically.
ProxyConfiguration Object that allows pointing to a remote configuration to execute.
PsParser Utility used to parse(USER,PID and NAME) from the "ps" command output
PtsBotTest Run PTS-bot tests.
PushFileInvoker This class is deprecated. Use PushFilePreparer instead
PushFilePreparer A ITargetPreparer that attempts to push any number of files from any host path to any device path.
PythonBinaryHostTest Host test meant to run a python binary file from the Android Build system (Soong)

The test runner supports include-filter and exclude-filter.

PythonBinaryHostTest.PythonForwarder Result forwarder to replace the run name by the binary name.
PythonUnitTestResultParser Interprets the output of tests run with Python's unittest framework and translates it into calls on a series of ITestInvocationListener s.
PythonUnitTestRunner This class is deprecated. Use PythonBinaryHostTest instead.
PythonVirtualenvHelper A helper class for activating Python 3 virtual environment.
PythonVirtualenvPreparer Sets up a Python virtualenv on the host and installs packages.

Q

QuotationAwareTokenizer

R

RebootReasonCollector Collector that collects device reboot during the test run and report them by reason and counts.
RebootTargetPreparer Target preparer that reboots the device.
RecoveryLogPreparer A target preparer used to collect logs before recovery.
RegexTrie <V> The RegexTrie is a trie where each stored segment of the key is a regex ERROR(/Pattern) .
RemoteAndroidDevice Implementation of a ITestDevice for a full stack android device connected via adb connect.
RemoteAndroidVirtualDevice Extends RemoteAndroidDevice behavior for a full stack android device running in the Google Compute Engine (Gce).
RemoteAvdIDevice A placeholder IDevice used by DeviceManager to allocate when DeviceSelectionOptions.gceDeviceRequested() is true
RemoteFileResolver A simple class that allows one to load files from a variety of places using URIs and the service provider functionality.
RemoteFileUtil Utility class to handle file from a remote instance
RemoteInvocationExecution Implementation of InvocationExecution that drives a remote execution.
RemoteInvocationExecution.FileOptionValueTransformer
RemoteSshUtil Utility to execute ssh commands on remote instances.
RemoteTestTimeOutEnforcer Listeners that allows to check the execution time of a given test config and fail it if it goes over a given timeout.
RemoteZip Utilities to unzip individual files inside a remote zip file.
RemoveSystemAppPreparer A ITargetPreparer for removing an apk from the system partition before a test run.
ReportPassedTests Report in a file possible filters to exclude passed test.
ResolvePartialDownload Resolve a partial download request.
ResourceMetricUtil Utility functions for composing metrics.
ResourceUtil Utility for reading configuration resources.
RestApiHelper A helper class for performing REST API calls.
RestartSystemServerTargetPreparer Target preparer that restarts the system server without rebooting the device.
ResultAggregator Special forwarder that aggregates the results when needed, based on the retry strategy that was taken.
ResultAndLogForwarder Forwarder for results and logs events.
ResultForwarder A ITestInvocationListener that forwards invocation results to a list of other listeners.
ResultsPlayer Special runner that replays the results given to it.
RetentionFileSaver Helper class for creating a .retention file in a directory.
RetryConfigurationFactory Factory that handles retrying a command.
RetryLogSaverResultForwarder Forwarder that also handles passing the current attempt we are at.
RetryPreparationDecision A Class to describe the decisions about whether or not to retry preparation and to fail the module run.
RetryRescheduler A special runner that allows to reschedule a previous run tests that failed or where not executed.
RetryRescheduler.RetryType The types of the tests that can be retried.
RetryResultForwarder An Extension of ResultForwarder that always push to a given attempt number.
RetryResultHelper Helper class to determine which module or test should run or not.
RetryStatistics Structure holding the statistics for a retry session of one IRemoteTest .
RetryStrategy The Retry Strategy to be used when re-running some tests.
RootTargetPreparer Target preparer that performs "adb root" or "adb unroot" based on option "force-root".
RunAftersWithInfo
RunBeforesWithInfo
RunCommandTargetPreparer
RunConfigDeviceRecovery Generic base IMultiDeviceRecovery to run a tradefed configuration to do the recovery step.
RunHostCommandTargetPreparer Target preparer to run arbitrary host commands before and after running the test.
RunHostScriptTargetPreparer Target preparer which executes a script before running a test.
RunInterruptedException Thrown when a run operation is interrupted by an external request.
RunNotifierWrapper Wrapper of RunNotifier so we can carry the DeviceNotAvailableException .
RunOnCloneProfileParameterHandler
RunOnCloneProfileTargetPreparer
RunOnSdkSandboxHandler Handler for ModuleParameters#RUN_ON_SDK_SANDBOX .
RunOnSdkSandboxTargetPreparer An ITargetPreparer to marks that tests should run in the sdk sandbox.
RunOnSecondaryUserParameterHandler
RunOnSecondaryUserTargetPreparer An ITargetPreparer that creates a secondary user in setup, and marks that tests should be run in that user.
RunOnSystemUserTargetPreparer An ITargetPreparer that marks that tests should be run on the user (rather than the current user).
RunOnWorkProfileParameterHandler
RunOnWorkProfileTargetPreparer An ITargetPreparer that creates a work profile in setup, and marks that tests should be run in that user.
RuntimeRestartCollector Collector that collects timestamps of runtime restarts (system server crashes) during the test run, if any.
RunUtil A collection of helper methods for executing operations.
RustBenchmarkResultParser Interprets the output of tests run with Criterion benchmarking framework and translates it into calls on a series of ITestInvocationListener s.
RustBinaryHostTest Host test meant to run a rust binary file from the Android Build system (Soong)
RustBinaryTest A Test that runs a rust binary on given device.
RustTestBase Base class of RustBinaryHostTest and RustBinaryTest
RustTestBase.EnvPair
RustTestBase.Invocation
RustTestResultParser Interprets the output of tests run with Rust's unittest framework and translates it into calls on a series of ITestInvocationListener s.

S

SandboxConfigDump Runner class that creates a IConfiguration based on a command line and dump it to a file.
SandboxConfigDump.DumpCmd
SandboxConfigurationException Special Configuration Exception coming from the Sandbox setup.
SandboxConfigurationFactory Special Configuration factory to handle creation of configurations for Sandboxing purpose.
SandboxConfigUtil A utility class for managing IConfiguration when doing sandboxing.
SandboxedInvocationExecution Special sandbox execution of the invocation: This is the InvocationExection for when we are inside the sandbox running the command.
SandboxInvocationRunner Run the tests associated with the invocation in the sandbox.
SandboxOptions Class that can receive and provide options to a ISandbox .
ScreenshotOnFailureCollector Collector that will capture and log a screenshot when a test case fails.
Sdk28ModuleController A module controller to check if a device is on SDK 28 (Android 9) or above.
Sdk29ModuleController Only run tests if the device under test is SDK version 29 or above.
Sdk30ModuleController Only run tests if the device under test is SDK version 30 or above.
Sdk31ModuleController Only run tests if the device under test is SDK version 31 or above.
Sdk32ModuleController Only run tests if the device under test is SDK version 32 or above.
Sdk33ModuleController Only run tests if the device under test is SDK version 33 or above.
SecondaryUserHandler Handler for ModuleParameters#SECONDARY_USER .
SecondaryUserOnDefaultDisplayHandler Handler for ModuleParameters#SECONDARY_USER_ON_DEFAULT_DISPLAY .
SecondaryUserOnSecondaryDisplayHandler Handler for ModuleParameters#SECONDARY_USER_ON_SECONDARY_DISPLAY .
SemaphoreTokenTargetPreparer This is a preparer used to use token to serialize test excution in tradefed host.
SerializationUtil Utility to serialize/deserialize an object that implements ERROR(/Serializable) .
ServiceAccountKeyCredentialFactory A credential factory to create service account key based oauth Credential .
SettingsBaselineSetter A common setter to handle device baseline settings via ITestDevice.setSetting.
ShardBuildCloner Helper class that handles cloning a build info from the command line.
ShardHelper Helper class that handles creating the shards and scheduling them for an invocation.
ShardListener A ITestInvocationListener that collects results from a invocation shard (aka an invocation split to run on multiple resources in parallel), and forwards them to another listener.
ShardMainResultForwarder A ResultForwarder that combines the results of a sharded test invocations.
ShellOutputReceiverStream Utility subclass of OutputStream that writes into an IShellOutputReceiver.
ShellStatusChecker Check if the shell status is as expected before and after a module run.
ShippingApiLevelModuleController Run tests if the device meets the following conditions:
  • If min-api-level is defined:
    • The device shipped with the min-api-level or later.
ShowmapPullerMetricCollector Base implementation of FilePullerDeviceMetricCollector that allows pulling the showmap files from the device and collect the metrics from it.
SideloadOtaTargetPreparer A target preparer that performs sideload of a specified OTA package, applies the package, waits for device to boot up, and injects the device build properties to use as build info

This target preparer assumes that the device will be in regular adb mode when started, and will ensure that the device exits in the same mode but with the newer build applied.

SimpleFileLogger A ILeveledLogOutput that directs log messages to stdout and to a single log file.
SimplePerfResult Object to hold all simpleperf test results
SimplePerfStatResultParser A utility class to parse simpleperf result.
SimplePerfUtil Utility class to dispatch simple command and collect results
SimplePerfUtil.SimplePerfType Enum of simpleperf command options
SimpleStats A small utility class that calculates a few statistical measures given a numerical dataset.
SizeLimitedOutputStream A thread safe file backed ERROR(/OutputStream) that limits the maximum amount of data that can be written.
SkipHWASanModuleController Base class for a module controller to not run tests on HWASan builds.
Sl4aBluetoothUtil A utility class provides Bluetooth operations on one or two devices using SL4A
Sl4aBluetoothUtil.BluetoothAccessLevel Enums for Bluetooth device access level which are based on BluetoothDevice.java
Sl4aBluetoothUtil.BluetoothConnectionState Enums for Bluetooth connection states which are based on BluetoothProfile.java
Sl4aBluetoothUtil.BluetoothPriorityLevel Enums for Bluetooth profile priority level which are based on BluetoothProfile.java
Sl4aBluetoothUtil.BluetoothProfile Enums for Bluetooth profiles which are based on BluetoothProfile.java
Sl4aClient Sl4A client to interact via RPC with SL4A scripting layer.
Sl4aEventDispatcher Event dispatcher polls for event and queue them by name to be queried.
Sl4aEventDispatcher.EventSl4aObject Object returned by the event poller.
SnapshotInputStreamSource A File-backed InputStreamSource.
SparseImageUtil Utility to unsparse sparse images.
SparseImageUtil.SparseInputStream SparseInputStream read from upstream and detects the data format.
StatsdBeforeAfterGaugeMetricPostProcessor A post processor that processes gauge metrics collected in a "before/after" approach, ie
StatsdEventMetricPostProcessor A post processor that processes event metrics in statsd reports into key-value pairs, using the formatters specified on the processor.
StatsdGenericPostProcessor A post processor that processes binary proto statsd reports into key-value pairs by expanding the report as a tree structure.
StatusCheckerResult Contains the result of a ISystemStatusChecker execution.
StatusCheckerResult.CheckStatus
StdoutLogger A ILeveledLogOutput that directs log messages to stdout.
StopServicesSetup A ITargetPreparer that stops services on the device.
StreamProtoReceiver A receiver that translates proto TestRecord received into Tradefed events.
StreamProtoResultReporter An implementation of ProtoResultReporter
StreamUtil Utility class for managing input streams.
StrictShardHelper Sharding strategy to create strict shards that do not report together,
StringEscapeUtils Utility class for escaping strings for specific formats.
StringUtil Utility class for escaping strings for common string manipulation.
StubBuildProvider No-op empty implementation of a IBuildProvider .
StubDevice Stub placeholder implementation of a IDevice .
StubKeyStoreClient Default stub implementation for KeyStore Client.
StubKeyStoreFactory Default stub implementation for KeyStore Factory
StubLocalAndroidVirtualDevice A placeholder IDevice used by DeviceManager to allocate when DeviceSelectionOptions.localVirtualDeviceRequested() is true
StubMultiTargetPreparer Placeholder empty implementation of a IMultiTargetPreparer .
StubTargetPreparer Placeholder empty implementation of a ITargetPreparer .
StubTest No-op empty test implementation.
StubTestRunListener Stub implementation of ITestRunListener
SubprocessCommandException A subprocess command failed to run.
SubprocessConfigBuilder Build a wrapper TF config XML for an existing TF config.
SubprocessEventHelper Helper to serialize/deserialize the events to be passed to the log.
SubprocessEventHelper.BaseTestEventInfo Base Helper for TestIgnored information.
SubprocessEventHelper.FailedTestEventInfo Helper for testFailed information.
SubprocessEventHelper.InvocationEndedEventInfo Helper for invocation ended information.
SubprocessEventHelper.InvocationFailedEventInfo Helper for InvocationFailed information.
SubprocessEventHelper.InvocationStartedEventInfo Helper for invocation started information.
SubprocessEventHelper.LogAssociationEventInfo Helper for logAssociation information.
SubprocessEventHelper.TestEndedEventInfo Helper for testEnded information.
SubprocessEventHelper.TestLogEventInfo Helper for testLog information.
SubprocessEventHelper.TestModuleStartedEventInfo Helper for test module started information.
SubprocessEventHelper.TestRunEndedEventInfo Helper for testRunEnded Information.
SubprocessEventHelper.TestRunFailedEventInfo Helper for testRunFailed information
SubprocessEventHelper.TestRunStartedEventInfo Helper for testRunStarted information
SubprocessEventHelper.TestStartedEventInfo Helper for testStarted information
SubprocessExceptionParser Helper to handle the exception output from standard Tradefed command runners.
SubprocessReportingHelper A class to build a wrapper configuration file to use subprocess results reporter for a cluster command.
SubprocessResultsReporter Implements ITestInvocationListener to be specified as a result_reporter and forward from the subprocess the results of tests, test runs, test invocations.
SubprocessTestResultsParser Extends ERROR(/FileOutputStream) to parse the output before writing to the file so we can generate the test events on the launcher side.
SubprocessTestResultsParser.StatusKeys Relevant test status keys.
SubprocessTfLauncher A IRemoteTest for running tests against a separate TF installation.
SuiteApkInstaller Installs specified APKs for Suite configuration: either from $ANDROID_TARGET_OUT_TESTCASES variable or the ROOT_DIR in build info.
SuiteModuleLoader Retrieves Compatibility test module definitions from the repository.
SuiteModuleLoader.ConfigFilter A ERROR(/FilenameFilter) to find all the config files in a directory.
SuiteResultHolder Helper object to ease up serializing and deserializing the invocation results.
SuiteResultReporter Collect test results for an entire suite invocation and output the final results.
SuiteResultReporter.ModulePrepTimes Object holder for the preparation and tear down time of one module.
SuiteTestFilter Represents a filter for including and excluding tests.
SwitchUserTargetPreparer A ITargetPreparer that switches to the specified user kind in setUp.
SystemServerFileDescriptorChecker Checks if system server appears to be running out of FDs.
SystemServerStatusChecker Check if the pid of system_server has changed from before and after a module run.
SystemUpdaterDeviceFlasher A IDeviceFlasher that relies on the system updater to install a system image bundled in a OTA update package.
SystemUtil Utility class for making system calls.
SystemUtil.EnvVariable

T

TableBuilder Helper class to display a matrix of String elements in a table.
TableFormatter Helper class to display a matrix of String elements so each element column is lined up
TargetFileUtils
TargetFileUtils.FilePermission
TargetSetupError A fatal error occurred while preparing the target for testing.
TarUtil Utility to manipulate a tar file.
TcpDevice A placeholder IDevice used by DeviceManager to allocate when DeviceSelectionOptions.tcpDeviceRequested() is true
TearDownPassThroughPreparer Allows for running tearDown on preparers that are included in a config as an object.
TelephonyHelper A utility to use and get information related to the telephony.
TelephonyHelper.SimCardInformation An information holder for the sim card related information.
TelephonyTokenProvider Token provider for telephony related tokens.
TemperatureThrottlingWaiter An ITargetPreparer that waits until device's temperature gets down to target
TemplateResolutionError Class extending ConfigurationException for template related error during configuration parsing.
TerribleFailureEmailHandler A simple handler class that sends an email to interested people when a WTF (What a Terrible Failure) error occurs within a Trade Federation instance.
TestAppInstallSetup A ITargetPreparer that installs one or more apps from a IDeviceBuildInfo.getTestsDir() folder onto device.
TestContext A class to model a TestContext message of TFC API.
TestDependencyResolver Helper to resolve dependencies if needed.
TestDescription Class representing information about a test case.
TestDescriptionsFile A utility class for marshalling and unmarshalling a list of TestDescriptions to a test file.
TestDevice Implementation of a ITestDevice for a full stack android device
TestDevice.MicrodroidBuilder A builder used to create a Microdroid TestDevice.
TestDeviceOptions Container for ITestDevice Option s
TestDeviceOptions.InstanceType
TestDeviceState A more fully featured representation of device state than DeviceState .
TestEnvironment A class to model a TestEnvironment message returned by TFC API.
TestErrorIdentifier Error identifier from tests and tests runners.
TestFailureListener Listener used to take action such as screenshot, bugreport, logcat collection upon a test failure when requested.
TestFailureModuleController Controller for module that simply want to tune how the tests failures log collected are behaving.
TestFilePushSetup A ITargetPreparer that pushes one or more files/dirs from a IDeviceBuildInfo.getTestsDir() folder onto device.
TestFilterHelper Helper class for filtering tests
TestGroupStatus A class to store status of a test group.
TestInfo Stores the test information set in a TEST_MAPPING file.
TestInformation Holder object that contains all the information and dependencies a test runner or test might need to execute properly.
TestInformation.Builder Builder to create a TestInformation instance.
TestInvocation Default implementation of ITestInvocation .
TestInvocation.RunMode The different mode an invocation can run into.
TestInvocation.Stage
TestInvocationManagementServer GRPC server helping to management test invocation and their lifecycle.
TestInvocationManagementServer.InvocationInformation
TestMapping A class for loading a TEST_MAPPING file.
TestMappingSuiteRunner Implementation of BaseTestSuite to run tests specified by option include-filter, or TEST_MAPPING files from build, as a suite.
TestOption Stores the test option details set in a TEST_MAPPING file.
TestOutputUploader Uploads test output files to local file system, GCS, or an HTTP(S) endpoint.
TestRecordInterpreter Utility to convert a TestRecord proto into a more easily manipulable format in Tradefed.
TestRecordProtoUtil Utility to read the TestRecord proto from a file.
TestResource A class to model a TestResource message returned by TFC API.
TestResourceDownloader A class to download test resource files from file system/GCS/HTTP.
TestResult Container for a result of a single test.
TestResultListener A simplification of ITestLifecycleListener for implementers that only care about individual test results.
TestRunnerUtil A utility class to help various test runners.
TestRunResult Holds results from a single test run.
TestRunToTestInvocationForwarder Forwarder from ddmlib ITestRunListener to ITestLifeCycleReceiver .
TestsPoolPoller Tests wrapper that allow to execute all the tests of a pool of tests.
TestSuiteInfo A class that resolves loading of build related metadata for test suite

To properly expose related info, a test suite must include a test-suite-info.properties file in its jar resources

TestSummary A class to represent a test summary.
TestSummary.Type
TestSummary.TypedString
TestSystemAppInstallSetup A ITargetPreparer that installs one or more apps from a IDeviceBuildInfo.getTestsDir() folder onto the /system partition on device.
TestTimeoutEnforcer Listeners that allows to check the execution time of a given test case and fail it if it goes over a given timeout.
TextResultReporter A test result reporter that forwards results to the JUnit text result printer.
TfMetricProtoUtil Utility class to help with the Map to Map transition.
TfObjectTracker A utility to track the usage of the different Trade Fedederation objects.
TfSuiteRunner Implementation of ITestSuite which will load tests from TF jars res/config/suite/ folder.
TfTestLauncher A IRemoteTest for running unit or functional tests against a separate TF installation.
TimeStatusChecker Status checker to ensure that the device and host time are kept in sync.
TimeUtil Contains time related utility methods.
TimeVal This is a sentinel type which wraps a Long .
TimeWaster A simple target preparer to waste time and potentially restart the device.
TokenProperty Supported token with dynamic sharding.
TokenProviderHelper Helper that gives the provider associated to a particular token, in order to find out if a device supports the token.
TraceCmdCollector A IMetricCollector that collects traces during the test using trace-cmd, and logs them to the invocation.
TracePropagatingExecutorService An executor service that forwards tasks to an underlying implementation while propagating the tracing context.
TracingLogger Class that helps to manage tracing for each test invocation.
TradefedConfigObject A class to model a TradefedConfigObject message of TFC API.
TradefedConfigObject.Type A list of configuration object types which can be injected to a cluster command config.
TradefedDelegator Objects that helps delegating the invocation to another Tradefed binary.
TradefedFeatureClient A grpc client to request feature execution from the server.
TradefedFeatureServer A server that responds to requests for triggering features.
TradefedSandbox Sandbox container that can run a Trade Federation invocation.
TradefedSandboxFactory Default implementation for SandboxFactory
TradefedSandboxRunner Runner associated with a TradefedSandbox that will allow executing the sandbox.
TradefedSandboxRunner.StubScheduledInvocationListener A stub IScheduledInvocationListener that does nothing.

U

UiAutomatorRunner Runs UI Automator test on device and reports results.
UiAutomatorTest
UiAutomatorTest.LoggingOption
UiAutomatorTest.TestFailureAction
UnexecutedTestReporterThread Threads that takes care of reporting all unexecuted tests.
UniqueMultiMap <K, V> A MultiMap that ensures unique values for each key.
UsbResetMultiDeviceRecovery A IMultiDeviceRecovery which resets USB buses for offline devices.
UsbResetRunConfigRecovery Allow to trigger a command to reset the USB of a device
UsbResetTest An IRemoteTest that reset the device USB and checks whether the device comes back online afterwards.
UserChecker Checks if users have changed during the test.
UserCleaner A ITargetPreparer that removes secondary users on teardown.
UserInfo Similar to UserInfo class from platform.
UserInfo.UserType Supported variants of a user's type in external APIs.

V

ValidateSuiteConfigHelper This class will help validating that the IConfiguration loaded for the suite are meeting the expected requirements: - No Build providers - No Result reporters
VersionedFile Data structure representing a file that has an associated version.
VersionParser Fetch the version of the running tradefed artifacts.
VisibleBackgroundUserPreparer Target preparer for running tests in a user that is started in the visible in the background.
VmRemoteDevice A Remote virtual device that we will manage from inside the Virtual Machine.

W

WaitDeviceRecovery A simple implementation of a IDeviceRecovery that waits for device to be online and respond to simple commands.
WaitForDeviceDatetimePreparer A ITargetPreparer that waits for datetime to be set on device

Optionally this preparer can force a TargetSetupError if datetime is not set within timeout, or force host datetime onto device,

WifiHelper Helper class for manipulating wifi services on device.
WifiPreparer A ITargetPreparer that configures wifi on the device if necessary.

X

XmlFormattedGeneratorReporter Implementation of the FormattedGeneratorReporter which format the suite results in an xml format.
XmlResultReporter Writes JUnit results to an XML files in a format consistent with Ant's XMLJUnitResultFormatter.
XmlSuiteResultFormatter Utility class to save a suite run as an XML.
XmlSuiteResultFormatter.RunHistory Helper object for JSON conversion.

Y

YamlClassOptionsParser Helper to parse test runner information from the YAML Tradefed Configuration.

Z

ZipCompressionStrategy An ICompressionStrategy for creating zip archives.
ZipUtil A helper class for compression-related operations
ZipUtil2 A helper class for zip extraction that takes POSIX file permissions into account