基礎設備指標收集器

public class BaseDeviceMetricCollector
extends Object implements IMetricCollector , IDeviceActionReceiver

java.lang.Object
↳ com.android.tradefed.device.metric.BaseDeviceMetricCollector

IMetricCollector的基本實現，允許在onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData)和ERROR(/#onTestRunEnd(com.android.tradefed.device.metric.DeviceMetricData,Map))上啟動和停止收集。

概括

領域

public static final String TEST_CASE_EXCLUDE_GROUP_OPTION

public static final String TEST_CASE_INCLUDE_GROUP_OPTION

公共構造函數

BaseDeviceMetricCollector ()

公共方法

void extraInit ( IInvocationContext context, ITestInvocationListener listener)
final getBuildInfos ()

返回調用中可用的構建信息列表。

final getDevices ()

返回調用中可用的設備列表。

File getFileFromTestArtifacts (String fileName)

從測試工件或模塊工件中檢索文件並將其緩存在映射中以供後續調用。

final ITestInvocationListener getInvocationListener ()

返回我們在其中轉發結果的原始ITestInvocationListener 。

String getModuleName ()
final getRealDevices ()

返回getDevices()列表中的所有非存根設備。

String getRunName ()

返回觸發收集器的測試運行mRunName的名稱。

final ITestInvocationListener init ( IInvocationContext context, ITestInvocationListener listener)

使用當前上下文以及將結果轉發到的位置來初始化收集器。

final void invocationEnded (long elapsedTime)

報告調用已終止，無論是成功還是由於某些錯誤情況。

final void invocationFailed ( FailureDescription failure)

由於某些錯誤情況而報告不完整的調用。

final void invocationFailed (Throwable cause)

由於某些錯誤情況而報告不完整的調用。

final void invocationStarted ( IInvocationContext context)

調用轉發監聽器

final boolean isDisabled ()

如果整個對像被禁用（跳過設置和拆卸），則返回 True。

boolean isDisabledReceiver ()

IDeviceActionReceiver是否被禁用。

final void logAssociation (String dataName, LogFile logFile)

不要使用內部度量收集器實現。

void onTestAssumptionFailure ( DeviceMetricData testData, TestDescription test)

當測試用例因假設失敗而失敗時的回調。

void onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics, TestDescription test) onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics, TestDescription test)

測試用例結束時的回調。

void onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics) onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics)

測試用例結束時的回調。

void onTestFail ( DeviceMetricData testData, TestDescription test)

測試用例失敗時的回調。

void onTestModuleEnded ()

允許捕獲模塊結束事件。

void onTestModuleStarted ()

允許捕獲模塊啟動事件。

void onTestRunEnd ( DeviceMetricData runData, currentRunMetrics) onTestRunEnd ( DeviceMetricData runData, currentRunMetrics)

測試運行結束時的回調。

void onTestRunFailed ( DeviceMetricData testData, FailureDescription failure)

testRunFailed 事件的回調

void onTestRunStart ( DeviceMetricData runData)

測試運行開始時的回調。

void onTestStart ( DeviceMetricData testData)

測試用例啟動時的回調。

void rebootEnded ( ITestDevice device)

當設備重新啟動結束時獲取通知。

void rebootStarted ( ITestDevice device)

在設備中開始重新啟動時獲取通知。

final void setDisable (boolean isDisabled)

設置是否應禁用該對象。

void setDisableReceiver (boolean isDisabled)

設置是否應禁用IDeviceActionReceiver 。

final void setLogSaver ( ILogSaver logSaver)

不要使用內部度量收集器實現。

final void testAssumptionFailure ( TestDescription test, String trace)

當原子測試標記其假定條件為 false 時調用

final void testAssumptionFailure ( TestDescription test, FailureDescription failure)

當原子測試標記其假定條件為 false 時調用

final void testEnded ( TestDescription test, long endTime, testMetrics) testEnded ( TestDescription test, long endTime, testMetrics)

ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))的替代方案，我們可以直接指定結束時間。

final void testEnded ( TestDescription test, testMetrics) testEnded ( TestDescription test, testMetrics)

報告單個測試用例的執行結束。

final void testFailed ( TestDescription test, FailureDescription failure)

報告單個測試用例的失敗。

final void testFailed ( TestDescription test, String trace)

報告單個測試用例的失敗。

final void testIgnored ( TestDescription test)

當測試不會運行時調用，通常是因為測試方法用 org.junit.Ignore 註解。

final void testLog (String dataName, LogDataType dataType, InputStreamSource dataStream)

提供來自測試調用的關聯日誌或調試數據。

final void testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)

不要使用內部度量收集器實現。

final void testModuleEnded ()

報告模塊運行結束。

final void testModuleStarted ( IInvocationContext moduleContext)

報告模塊運行的開始。

final void testRunEnded (long elapsedTime, runMetrics) testRunEnded (long elapsedTime, runMetrics)

報告測試運行結束。

final void testRunFailed ( FailureDescription failure)

報告測試運行由於FailureDescription描述的故障而未能完成。

final void testRunFailed (String errorMessage)

報告測試運行由於致命錯誤而未能完成。

final void testRunStarted (String runName, int testCount, int attemptNumber)

報告測試運行的開始。

final void testRunStarted (String runName, int testCount)

測試運行回調

final void testRunStarted (String runName, int testCount, int attemptNumber, long startTime)

報告測試運行的開始。

final void testRunStopped (long elapsedTime)

由於用戶請求，報告測試運行在完成之前停止。

final void testStarted ( TestDescription test, long startTime)

testStarted(com.android.tradefed.result.TestDescription)的替代方案，其中我們還指定測試開始時間，並結合ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))進行準確測量。

final void testStarted ( TestDescription test)

測試用例回調

領域

TEST_CASE_EXCLUDE_GROUP_OPTION

public static final String TEST_CASE_EXCLUDE_GROUP_OPTION

TEST_CASE_INCLUDE_GROUP_OPTION

public static final String TEST_CASE_INCLUDE_GROUP_OPTION

公共構造函數

基礎設備指標收集器

public BaseDeviceMetricCollector ()

公共方法

額外初始化

public void extraInit (IInvocationContext context, 
                ITestInvocationListener listener)

投擲
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

獲取構建信息

public final  getBuildInfos ()

返回調用中可用的構建信息列表。

退貨

獲取設備

public final  getDevices ()

返回調用中可用的設備列表。

退貨

從測試工件獲取文件

public File getFileFromTestArtifacts (String fileName)

從測試工件或模塊工件中檢索文件並將其緩存在映射中以供後續調用。

參數
fileName String ：要在工件中查找的文件的名稱。

退貨
File來自測試工件或模塊工件的文件。如果未找到文件則返回 null。

獲取調用監聽器

public final ITestInvocationListener getInvocationListener ()

返回我們在其中轉發結果的原始ITestInvocationListener 。

退貨
ITestInvocationListener

獲取模塊名稱

public String getModuleName ()

退貨
String

獲取真實設備

public final  getRealDevices ()

返回getDevices()列表中的所有非存根設備。

退貨

獲取運行名稱

public String getRunName ()

返回觸發收集器的測試運行mRunName的名稱。

退貨
String mRunName，當前測試運行名稱。

在裡面

public final ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

使用當前上下文以及將結果轉發到的位置來初始化收集器。每個實例只會調用一次，並且收集器預計會更新其內部上下文和偵聽器。以前在測試運行期間永遠不會調用 Init。

除非您知道自己在做什麼，否則請勿覆蓋。

參數
context IInvocationContext ：正在進行的調用的IInvocationContext 。

listener ITestInvocationListener ： ITestInvocationListener放置結果的位置。

退貨
ITestInvocationListener新的監聽器包裹了原來的監聽器。

投擲
DeviceNotAvailableException

調用結束

public final void invocationEnded (long elapsedTime)

報告調用已終止，無論是成功還是由於某些錯誤情況。

將由 TradeFederation 框架自動調用。

參數
elapsedTime long ：調用所用的時間（以毫秒為單位）

調用失敗

public final void invocationFailed (FailureDescription failure)

由於某些錯誤情況而報告不完整的調用。

將由 TradeFederation 框架自動調用。

參數
failure FailureDescription ：描述失敗原因的FailureDescription

調用失敗

public final void invocationFailed (Throwable cause)

由於某些錯誤情況而報告不完整的調用。

將由 TradeFederation 框架自動調用。

參數
cause Throwable ：失敗的Throwable原因

調用開始

public final void invocationStarted (IInvocationContext context)

調用轉發監聽器

參數
context IInvocationContext ：有關調用的信息

被禁用

public final boolean isDisabled ()

如果整個對像被禁用（跳過設置和拆卸），則返回 True。否則為假。

退貨
boolean

禁用接收器

public boolean isDisabledReceiver ()

IDeviceActionReceiver是否被禁用。

退貨
boolean如果禁用則返回 true，否則返回 false。

日誌關聯

public final void logAssociation (String dataName, 
                LogFile logFile)

不要使用內部度量收集器實現。這是純粹的轉發。

參數
dataName String : 數據的名稱

logFile LogFile ：之前記錄的LogFile ，應與測試用例關聯。

測試假設失敗

public void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

當測試用例因假設失敗而失敗時的回調。

參數
testData DeviceMetricData ：保存測試用例數據的DeviceMetricData 。

test TestDescription ：正在進行的測試用例的TestDescription 。

投擲
DeviceNotAvailableException

測試結束時

public void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics, 
                TestDescription test)

測試用例結束時的回調。這應該是清理的時間。

參數
testData DeviceMetricData ：保存測試用例數據的DeviceMetricData 。將與onTestStart(com.android.tradefed.device.metric.DeviceMetricData)期間的對象相同。

currentTestCaseMetrics ：傳遞給ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))當前指標映射。

test TestDescription ：正在進行的測試用例的TestDescription 。

投擲
DeviceNotAvailableException

測試結束時

public void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics)

測試用例結束時的回調。這應該是清理的時間。

參數
testData DeviceMetricData ：保存測試用例數據的DeviceMetricData 。將與onTestStart(com.android.tradefed.device.metric.DeviceMetricData)期間的對象相同。

currentTestCaseMetrics ：傳遞給ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))當前指標映射。

投擲
DeviceNotAvailableException

測試失敗時

public void onTestFail (DeviceMetricData testData, 
                TestDescription test)

測試用例失敗時的回調。

參數
testData DeviceMetricData ：保存測試用例數據的DeviceMetricData 。

test TestDescription ：正在進行的測試用例的TestDescription 。

投擲
DeviceNotAvailableException

測試模塊結束時

public void onTestModuleEnded ()

允許捕獲模塊結束事件。

投擲
DeviceNotAvailableException

測試模塊啟動

public void onTestModuleStarted ()

允許捕獲模塊啟動事件。

投擲
DeviceNotAvailableException

測試運行結束時

public void onTestRunEnd (DeviceMetricData runData, 
                 currentRunMetrics)

測試運行結束時的回調。這應該是清理的時間。

參數
runData DeviceMetricData ：保存運行數據的DeviceMetricData 。將與onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData)期間的對象相同。

currentRunMetrics ：傳遞給ERROR(/#testRunEnded(long,Map))的當前指標映射。

投擲
DeviceNotAvailableException

測試運行失敗

public void onTestRunFailed (DeviceMetricData testData, 
                FailureDescription failure)

testRunFailed 事件的回調

投擲
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

測試運行開始時

public void onTestRunStart (DeviceMetricData runData)

測試運行開始時的回調。

參數
runData DeviceMetricData ：保存運行數據的DeviceMetricData 。

投擲
DeviceNotAvailableException

測試開始時

public void onTestStart (DeviceMetricData testData)

測試用例啟動時的回調。

參數
testData DeviceMetricData ：保存測試用例數據的DeviceMetricData 。

投擲
DeviceNotAvailableException

重啟結束

public void rebootEnded (ITestDevice device)

當設備重新啟動結束時獲取通知。

注意：接收器應避免在此回調期間重新啟動。任何重新啟動嘗試都將被忽略。

參數
device ITestDevice ：重啟結束的ITestDevice 。

投擲
DeviceNotAvailableException

重新啟動開始

public void rebootStarted (ITestDevice device)

在設備中開始重新啟動時獲取通知。

注意：接收器應避免在此回調期間重新啟動。任何重新啟動嘗試都將被忽略。

參數
device ITestDevice ：重新啟動開始的ITestDevice 。

投擲
DeviceNotAvailableException

設置禁用

public final void setDisable (boolean isDisabled)

設置是否應禁用該對象。禁用意味著應跳過設置和拆卸步驟。可用於在默認構造函數中默認禁用對象。

參數
isDisabled boolean ：對象應處於的狀態。

設置禁用接收器

public void setDisableReceiver (boolean isDisabled)

設置是否應禁用IDeviceActionReceiver 。禁用表示不會註冊到設備上接收設備動作事件。

參數
isDisabled boolean

設置日誌保存程序

public final void setLogSaver (ILogSaver logSaver)

不要使用內部度量收集器實現。這是純粹的轉發。

參數
logSaver ILogSaver ： ILogSaver

測試假設失敗

public final void testAssumptionFailure (TestDescription test, 
                String trace)

當原子測試標記其假定條件為 false 時調用

參數
test TestDescription ：標識測試

trace String : 失敗的堆棧跟踪

測試假設失敗

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

當原子測試標記其假定條件為 false 時調用

參數
test TestDescription ：標識測試

failure FailureDescription ：描述故障及其上下文的FailureDescription 。

測試結束

public final void testEnded (TestDescription test, 
                long endTime, 
                 testMetrics)

ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))的替代方案，我們可以直接指定結束時間。與testStarted(com.android.tradefed.result.TestDescription, long)結合使用以進行準確測量。

參數
test TestDescription ：標識測試

endTime long ：測試結束的時間，通過System.currentTimeMillis()測量

testMetrics ：發出的指標的ERROR(/Map)

測試結束

public final void testEnded (TestDescription test, 
                 testMetrics)

報告單個測試用例的執行結束。

如果未調用testFailed(TestDescription, FailureDescription) ，則此測試通過。還返回測試用例執行期間可能發出的任何鍵/值指標。

參數
test TestDescription ：標識測試

testMetrics ：發出的指標的ERROR(/Map)

測試失敗

public final void testFailed (TestDescription test, 
                FailureDescription failure)

報告單個測試用例的失敗。

將在 testStarted 和 testEnded 之間調用。

參數
test TestDescription ：標識測試

failure FailureDescription ：描述故障及其上下文的FailureDescription 。

測試失敗

public final void testFailed (TestDescription test, 
                String trace)

報告單個測試用例的失敗。

將在 testStarted 和 testEnded 之間調用。

參數
test TestDescription ：標識測試

trace String : 失敗的堆棧跟踪

測試被忽略

public final void testIgnored (TestDescription test)

當測試不會運行時調用，通常是因為測試方法用 org.junit.Ignore 註解。

參數
test TestDescription ：標識測試

測試日誌

public final void testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

提供來自測試調用的關聯日誌或調試數據。

必須在ERROR(/ITestInvocationListener#invocationFailed(Throwable))或ERROR(/ITestInvocationListener#invocationEnded(long))之前調用

TradeFederation 框架將自動調用此方法，提供主機日誌和設備 logcat（如果適用）。

參數
dataName String ：數據的String描述性名稱。例如“device_logcat”。注意 每次調用時 dataName 可能不是唯一的。即實現者必須能夠處理具有相同 dataName 的多個調用

dataType LogDataType ：數據的LogDataType

dataStream InputStreamSource ：數據的InputStreamSource 。實現者應該調用 createInputStream 來開始讀取數據，並確保完成後關閉生成的 InputStream。調用者應確保數據源保持存在且可訪問，直到 testLog 方法完成。

測試日誌已保存

public final void testLogSaved (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream, 
                LogFile logFile)

不要使用內部度量收集器實現。這是純粹的轉發。

參數
dataName String ：數據的String描述性名稱。例如“device_logcat”。注意 每次調用時 dataName 可能不是唯一的。即實現者必須能夠處理具有相同 dataName 的多個調用

dataType LogDataType ：數據的LogDataType

dataStream InputStreamSource ：數據的InputStreamSource 。實現者應該調用 createInputStream 來開始讀取數據，並確保完成後關閉生成的 InputStream。

logFile LogFile ：包含已保存文件的元數據的LogFile 。

測試模塊結束

public final void testModuleEnded ()

報告模塊運行結束。

測試模塊啟動

public final void testModuleStarted (IInvocationContext moduleContext)

報告模塊運行的開始。此回調與testModuleEnded()關聯，並且在序列中是可選的。它僅在使用模塊的運行期間使用：基於套件的運行器。

參數
moduleContext IInvocationContext ：模塊的IInvocationContext 。

測試運行結束

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

報告測試運行結束。 FIXME：我們不能有兩個不同類型的 Map<> 接口，所以我們必須在這裡使用 HashMap。

參數
elapsedTime long ：設備報告的經過時間，以毫秒為單位

runMetrics ：使用Metric測試運行結束時報告的鍵值對。

測試運行失敗

public final void testRunFailed (FailureDescription failure)

報告測試運行由於FailureDescription描述的故障而未能完成。

參數
failure FailureDescription ：描述故障及其上下文的FailureDescription 。

測試運行失敗

public final void testRunFailed (String errorMessage)

報告測試運行由於致命錯誤而未能完成。

參數
errorMessage String ：描述運行失敗原因的String 。

測試運行開始

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber)

報告測試運行的開始。

參數
runName String : 測試運行名稱

testCount int : 測試運行中的測試總數

attemptNumber int ：訂單號，標識同一 runName 多次運行的不同嘗試。 attemptsNumber 是從 0 開始索引的，並且每次新的運行發生時都應該遞增。例如，一個測試被粒度重試 3 次，它應該在同一 runName 下總共運行 4 次，並且 attemptsNumber 從 0 到 3。

測試運行開始

public final void testRunStarted (String runName, 
                int testCount)

測試運行回調

參數
runName String : 測試運行名稱

testCount int : 測試運行中的測試總數

測試運行開始

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

報告測試運行的開始。

參數
runName String : 測試運行名稱

testCount int : 測試運行中的測試總數

attemptNumber int ：訂單號，標識同一 runName 多次運行的不同嘗試。 attemptsNumber 是從 0 開始索引的，並且每次新的運行發生時都應該遞增。例如，一個測試被粒度重試 3 次，它應該在同一 runName 下總共運行 4 次，並且 attemptsNumber 從 0 到 3。

startTime long ：運行開始的時間，通過System.currentTimeMillis()測量

測試運行停止

public final void testRunStopped (long elapsedTime)

由於用戶請求，報告測試運行在完成之前停止。

TODO：當前未使用，考慮刪除

參數
elapsedTime long ：設備報告的經過時間，以毫秒為單位

測試開始

public final void testStarted (TestDescription test, 
                long startTime)

testStarted(com.android.tradefed.result.TestDescription)的替代方案，其中我們還指定測試開始時間，並結合ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))進行準確測量。

參數
test TestDescription ：標識測試

startTime long ：測試開始的時間，通過System.currentTimeMillis()測量

測試開始

public final void testStarted (TestDescription test)

測試用例回調

參數
test TestDescription ：標識測試