基礎設備指標收集器
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 () 傳回我們在其中轉發結果的原始 |
String | getModuleName () |
final | getRealDevices () 傳回 |
String | getRunName () 傳回觸發收集器的測試運行 |
final ITestInvocationListener | init ( IInvocationContext context, ITestInvocationListener listener) 使用當前上下文以及將結果轉送到的位置來初始化收集器。 |
final void | invocationEnded (long elapsedTime) 報告呼叫已終止,無論是成功還是由於某些錯誤情況。 |
final void | invocationFailed ( FailureDescription failure) 由於某些錯誤情況而報告不完整的呼叫。 |
final void | invocationFailed (Throwable cause) 由於某些錯誤情況而報告不完整的呼叫。 |
void | invocationSkipped ( SkipReason reason) 將呼叫報告為已跳過 |
final void | invocationStarted ( IInvocationContext context) 呼叫轉發監聽器 |
final boolean | isDisabled () 如果整個物件被停用(跳過設定和拆卸),則傳回 True。 |
boolean | isDisabledReceiver () |
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) 設定是否應停用 |
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) |
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) 報告測試運行由於 |
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 | testSkipped ( TestDescription test, SkipReason reason) 當測試因通常意外的原因而被跳過且未執行時調用。 |
final void | testStarted ( TestDescription test, long startTime) |
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 finalgetBuildInfos ()
傳回呼叫中可用的建置資訊列表。
退貨 | |
---|---|
取得設備
public finalgetDevices ()
傳回呼叫中可用的設備清單。
退貨 | |
---|---|
從測試工件取得文件
public File getFileFromTestArtifacts (String fileName)
從測試工件或模組工件中檢索檔案並將其緩存在映射中以供後續調用。
參數 | |
---|---|
fileName | String :要在工件中尋找的檔案的名稱。 |
退貨 | |
---|---|
File | 來自測試工件或模組工件的檔案。如果未找到檔案則傳回 null。 |
取得呼叫監聽器
public final ITestInvocationListener getInvocationListener ()
傳回我們在其中轉發結果的原始ITestInvocationListener
。
退貨 | |
---|---|
ITestInvocationListener |
取得模組名稱
public String getModuleName ()
退貨 | |
---|---|
String |
取得運行名稱
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 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 testSkipped (TestDescription test, SkipReason reason)
當測試因通常意外的原因而被跳過且未執行時調用。將嘗試重試這些測試以嘗試正確執行。
參數 | |
---|---|
test | TestDescription :標識測試 |
reason | SkipReason : SkipReason |
測試開始
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() 測量 |