BaseDeviceMetricCollector
public
class
BaseDeviceMetricCollector
extends Object
implements
IDeviceActionReceiver,
IMetricCollector
| 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)) 上開始及停止收集資料。
摘要
常數 | |
|---|---|
String |
TEST_CASE_EXCLUDE_GROUP_OPTION
|
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()
傳回觸發收集器的測試執行 |
String
|
getTestName()
傳回觸發收集器的測試 |
final
ITestInvocationListener
|
init(IInvocationContext context, ITestInvocationListener listener)
使用目前環境初始化收集器,並指定轉送結果的位置。 |
final
void
|
invocationEnded(long elapsedTime)
回報是否因成功或發生錯誤而終止呼叫。 |
final
void
|
invocationFailed(FailureDescription failure)
Reports an incomplete invocation due to some error condition. |
final
void
|
invocationFailed(Throwable cause)
Reports an incomplete invocation due to some error condition. |
void
|
invocationSkipped(SkipReason reason)
將叫用作業回報為已略過 |
final
void
|
invocationStarted(IInvocationContext context)
轉送的叫用事件監聽器 |
final
boolean
|
isDisabled()
如果整個物件都已停用 (略過設定和終止),則傳回 True。 |
boolean
|
isDisabledReceiver()
|
final
void
|
logAssociation(String dataName, LogFile logFile)
Do not use inside metric collector implementation. |
void
|
onTestAssumptionFailure(DeviceMetricData testData, TestDescription test)
測試案例因假設失敗而失敗時的回呼。 |
void
|
onTestEnd(DeviceMetricData testData,
測試案例結束時的回呼。 |
void
|
onTestEnd(DeviceMetricData testData,
測試案例結束時的回呼。 |
void
|
onTestFail(DeviceMetricData testData, TestDescription test)
測試案例失敗時的回呼。 |
void
|
onTestModuleEnded()
允許擷取模組結束事件。 |
void
|
onTestModuleStarted()
允許擷取模組啟動事件。 |
void
|
onTestRunEnd(DeviceMetricData runData,
測試作業結束時的回呼。 |
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)
Do not use inside metric collector implementation. |
final
void
|
testAssumptionFailure(TestDescription test, String trace)
當原子測試標記假設條件為 false 時,系統會呼叫這個函式。 |
final
void
|
testAssumptionFailure(TestDescription test, FailureDescription failure)
當原子測試標記假設條件為 false 時,系統會呼叫這個函式。 |
final
void
|
testEnded(TestDescription test, long endTime,
|
final
void
|
testEnded(TestDescription test,
回報個別測試案例的執行結束時間。 |
final
void
|
testFailed(TestDescription test, FailureDescription failure)
回報個別測試案例的失敗情形。 |
final
void
|
testFailed(TestDescription test, String trace)
回報個別測試案例的失敗情形。 |
final
void
|
testIgnored(TestDescription test)
Called when a test will not be run, generally because a test method is annotated with org.junit.Ignore. |
final
void
|
testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)
提供測試呼叫的相關記錄或偵錯資料。 |
final
void
|
testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
Do not use inside metric collector implementation. |
final
void
|
testModuleEnded()
回報模組執行作業的結束時間。 |
final
void
|
testModuleStarted(IInvocationContext moduleContext)
回報模組的執行開始時間。 |
final
void
|
testRunEnded(long elapsedTime,
Reports end of test run. |
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)
Called when a test is skipped and did not execute for a reason that is not usually expected. |
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-exclude-group"
TEST_CASE_INCLUDE_GROUP_OPTION
public static final String TEST_CASE_INCLUDE_GROUP_OPTION
常數值: "test-case-include-group"
公用建構函式
BaseDeviceMetricCollector
public BaseDeviceMetricCollector ()
公用方法
extraInit
public void extraInit (IInvocationContext context, ITestInvocationListener listener)
| 擲回 | |
|---|---|
|
com.android.tradefed.device.DeviceNotAvailableException |
DeviceNotAvailableException |
|
getBuildInfos
public finalgetBuildInfos ()
傳回可供呼叫使用的建構資訊清單。
| 傳回 | |
|---|---|
|
|
getDevices
public finalgetDevices ()
傳回呼叫中可用的裝置清單。
| 傳回 | |
|---|---|
|
|
getFileFromTestArtifacts
public File getFileFromTestArtifacts (String fileName)
從測試構件或模組構件擷取檔案,並在對應中快取檔案,以供後續呼叫。
| 參數 | |
|---|---|
fileName |
String:要在構件中查閱的檔案名稱。 |
| 傳回 | |
|---|---|
File |
測試構件或模組構件中的檔案。如果找不到檔案,則傳回空值。 |
getInvocationListener
public final ITestInvocationListener getInvocationListener ()
傳回轉送結果的原始 ITestInvocationListener。
| 傳回 | |
|---|---|
ITestInvocationListener |
|
getModuleName
public String getModuleName ()
| 傳回 | |
|---|---|
String |
|
getRunName
public String getRunName ()
傳回觸發收集器的測試執行 mRunName 名稱。
| 傳回 | |
|---|---|
String |
mRunName:目前的測試執行名稱。 |
getTestName
public String getTestName ()
傳回觸發收集器的測試 mTestName 名稱。
| 傳回 | |
|---|---|
String |
mTestName,目前的測試名稱。 |
init
public final ITestInvocationListener init (IInvocationContext context, ITestInvocationListener listener)
使用目前環境初始化收集器,並指定轉送結果的位置。每個執行個體只會呼叫一次,收集器應更新其內部環境和接聽程式。在測試執行期間,系統一律不會呼叫 Init,而是呼叫 before。
除非您知道自己在做什麼,否則請勿覆寫。
| 參數 | |
|---|---|
context |
IInvocationContext:正在進行的呼叫的 IInvocationContext。 |
listener |
ITestInvocationListener:要放置結果的 ITestInvocationListener。 |
| 傳回 | |
|---|---|
ITestInvocationListener |
新接聽程式包裝原始接聽程式。 |
| 擲回 | |
|---|---|
DeviceNotAvailableException |
|
invocationEnded
public final void invocationEnded (long elapsedTime)
回報是否因某些錯誤狀況而終止呼叫 (無論是否成功)。
TradeFederation 架構會自動呼叫。
| 參數 | |
|---|---|
elapsedTime |
long:以毫秒為單位的呼叫經過時間 |
invocationFailed
public final void invocationFailed (FailureDescription failure)
Reports an incomplete invocation due to some error condition.
TradeFederation 架構會自動呼叫。
| 參數 | |
|---|---|
failure |
FailureDescription:說明失敗原因的 FailureDescription |
invocationFailed
public final void invocationFailed (Throwable cause)
由於發生錯誤狀況,因此回報不完整的叫用。
TradeFederation 架構會自動呼叫。
| 參數 | |
|---|---|
cause |
Throwable:Throwable 失敗的 Throwable 原因 |
invocationSkipped
public void invocationSkipped (SkipReason reason)
將叫用作業回報為已略過
| 參數 | |
|---|---|
reason |
SkipReason |
invocationStarted
public final void invocationStarted (IInvocationContext context)
轉送的叫用事件監聽器
| 參數 | |
|---|---|
context |
IInvocationContext:叫用相關資訊 |
isDisabled
public final boolean isDisabled ()
如果整個物件都已停用 (略過設定和終止),則傳回 True。否則傳回「false」。
| 傳回 | |
|---|---|
boolean |
|
isDisabledReceiver
public boolean isDisabledReceiver ()
IDeviceActionReceiver 是否已停用。
| 傳回 | |
|---|---|
boolean |
如果已停用,則傳回 true,否則傳回 false。 |
logAssociation
public final void logAssociation (String dataName,
LogFile logFile)請勿在指標收集器實作中使用。這屬於純轉送。
| 參數 | |
|---|---|
dataName |
String:資料名稱 |
logFile |
LogFile:先前記錄的 LogFile,應與測試案例建立關聯。 |
onTestAssumptionFailure
public void onTestAssumptionFailure (DeviceMetricData testData, TestDescription test)
測試案例因假設失敗而失敗時的回呼。
| 參數 | |
|---|---|
testData |
DeviceMetricData:保存測試案例資料的 DeviceMetricData。 |
test |
TestDescription:進行中測試案例的 TestDescription。 |
| 擲回 | |
|---|---|
DeviceNotAvailableException |
|
onTestEnd
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 |
|
onTestEnd
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 |
|
onTestFail
public void onTestFail (DeviceMetricData testData, TestDescription test)
測試案例失敗時的回呼。
| 參數 | |
|---|---|
testData |
DeviceMetricData:保存測試案例資料的 DeviceMetricData。 |
test |
TestDescription:進行中測試案例的 TestDescription。 |
| 擲回 | |
|---|---|
DeviceNotAvailableException |
|
onTestRunEnd
public void onTestRunEnd (DeviceMetricData runData,currentRunMetrics)
測試作業結束時的回呼。這時應該要進行清理。
| 參數 | |
|---|---|
runData |
DeviceMetricData:保存執行資料的 DeviceMetricData。與 onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData) 期間的物件相同。 |
currentRunMetrics |
:傳遞至 ERROR(/#testRunEnded(long,Map)) 的指標目前對應。 |
| 擲回 | |
|---|---|
DeviceNotAvailableException |
|
onTestRunFailed
public void onTestRunFailed (DeviceMetricData testData, FailureDescription failure)
testRunFailed 事件的回呼
| 擲回 | |
|---|---|
|
com.android.tradefed.device.DeviceNotAvailableException |
DeviceNotAvailableException |
|
onTestRunStart
public void onTestRunStart (DeviceMetricData runData)
測試執行開始時的回呼。
| 參數 | |
|---|---|
runData |
DeviceMetricData:DeviceMetricData,其中包含執行作業的資料。 |
| 擲回 | |
|---|---|
DeviceNotAvailableException |
|
onTestStart
public void onTestStart (DeviceMetricData testData)
測試案例啟動時的回呼。
| 參數 | |
|---|---|
testData |
DeviceMetricData:保存測試案例資料的 DeviceMetricData。 |
| 擲回 | |
|---|---|
DeviceNotAvailableException |
|
rebootEnded
public void rebootEnded (ITestDevice device)
裝置重新啟動後,系統會傳送通知。
注意:接收器應避免在此回呼期間重新啟動。系統會忽略任何重新啟動嘗試。
| 參數 | |
|---|---|
device |
ITestDevice:重新啟動結束的位置。ITestDevice |
| 擲回 | |
|---|---|
DeviceNotAvailableException |
|
rebootStarted
public void rebootStarted (ITestDevice device)
裝置開始重新啟動時收到通知。
注意:接收器應避免在此回呼期間重新啟動。系統會忽略任何重新啟動嘗試。
| 參數 | |
|---|---|
device |
ITestDevice:重新啟動的ITestDevice位置。 |
| 擲回 | |
|---|---|
DeviceNotAvailableException |
|
setDisable
public final void setDisable (boolean isDisabled)
設定是否應停用物件。如果設為「Disabled」,表示應略過設定和拆除步驟。可用於在預設建構函式中,預設停用物件。
| 參數 | |
|---|---|
isDisabled |
boolean:物件應處於的狀態。 |
setDisableReceiver
public void setDisableReceiver (boolean isDisabled)
設定是否應停用 IDeviceActionReceiver。停用後,裝置不會註冊接收裝置動作事件。
| 參數 | |
|---|---|
isDisabled |
boolean |
setLogSaver
public final void setLogSaver (ILogSaver logSaver)
請勿在指標收集器實作中使用。這屬於純轉送。
| 參數 | |
|---|---|
logSaver |
ILogSaver:ILogSaver |
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, String trace)
當原子測試標記假設為 false 的條件時呼叫
| 參數 | |
|---|---|
test |
TestDescription:識別測試 |
trace |
String:失敗的堆疊追蹤 |
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
當原子測試標記假設為 false 的條件時呼叫
| 參數 | |
|---|---|
test |
TestDescription:識別測試 |
failure |
FailureDescription:FailureDescription,說明失敗情形和相關情境。 |
testEnded
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) |
testEnded
public final void testEnded (TestDescription test,testMetrics)
回報個別測試案例的執行結束時間。
如果未叫用 testFailed(TestDescription, FailureDescription),這項測試就會通過。也會傳回在測試案例執行期間可能發出的任何鍵/值指標。
| 參數 | |
|---|---|
test |
TestDescription:識別測試 |
testMetrics |
:發出的指標 ERROR(/Map) |
testFailed
public final void testFailed (TestDescription test, FailureDescription failure)
回報個別測試案例的失敗情形。
會在 testStarted 和 testEnded 之間呼叫。
| 參數 | |
|---|---|
test |
TestDescription:識別測試 |
failure |
FailureDescription:FailureDescription,說明失敗情形和相關情境。 |
testFailed
public final void testFailed (TestDescription test, String trace)
回報個別測試案例的失敗情形。
會在 testStarted 和 testEnded 之間呼叫。
| 參數 | |
|---|---|
test |
TestDescription:識別測試 |
trace |
String:失敗的堆疊追蹤 |
testIgnored
public final void testIgnored (TestDescription test)
當測試不會執行時呼叫,通常是因為測試方法已使用 org.junit.Ignore 註解。
| 參數 | |
|---|---|
test |
TestDescription:識別測試 |
testLog
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 方法完成為止。 |
testLogSaved
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。 |
testModuleEnded
public final void testModuleEnded ()
回報模組執行作業的結束時間。
testModuleStarted
public final void testModuleStarted (IInvocationContext moduleContext)
回報模組的執行開始時間。這個回呼與 testModuleEnded() 相關聯,且在序列中為選用項目。只有在使用模組的執行期間,才會使用這個標記:以套件為基礎的執行器。
| 參數 | |
|---|---|
moduleContext |
IInvocationContext:模組的 IInvocationContext。 |
testRunEnded
public final void testRunEnded (long elapsedTime,
runMetrics) 報告測試執行結束時間。
| 參數 | |
|---|---|
elapsedTime |
long:裝置回報的經過時間 (以毫秒為單位) |
runMetrics |
:在測試執行結束時回報的鍵/值組合 |
testRunFailed
public final void testRunFailed (FailureDescription failure)
由於 FailureDescription 所述的失敗情形,報表測試執行作業無法完成。
| 參數 | |
|---|---|
failure |
FailureDescription:FailureDescription,說明失敗情形和相關情境。 |
testRunFailed
public final void testRunFailed (String errorMessage)
發生嚴重錯誤,導致報表測試執行作業無法完成。
| 參數 | |
|---|---|
errorMessage |
String:String,說明執行失敗的原因。 |
testRunStarted
public final void testRunStarted (String runName,
int testCount,
int attemptNumber)回報測試執行的開始時間。
| 參數 | |
|---|---|
runName |
String:測試執行作業名稱 |
testCount |
int:測試執行作業中的測試總數 |
attemptNumber |
int:訂單號碼,用於識別相同 runName 的不同嘗試,該 runName 會多次執行。attemptNumber 是以 0 為索引,每次執行新作業時都應遞增。舉例來說,如果測試細部重試 3 次,則在相同 runName 下應有 4 次執行作業,且 attemptNumber 為 0 到 3。 |
testRunStarted
public final void testRunStarted (String runName,
int testCount)測試執行回呼
| 參數 | |
|---|---|
runName |
String:測試執行作業名稱 |
testCount |
int:測試執行作業中的測試總數 |
testRunStarted
public final void testRunStarted (String runName,
int testCount,
int attemptNumber,
long startTime)回報測試執行的開始時間。
| 參數 | |
|---|---|
runName |
String:測試執行作業名稱 |
testCount |
int:測試執行作業中的測試總數 |
attemptNumber |
int:訂單號碼,用於識別相同 runName 的不同嘗試,該 runName 會多次執行。attemptNumber 是以 0 為索引,每次執行新作業時都應遞增。舉例來說,如果測試細部重試 3 次,則在相同 runName 下應有 4 次執行作業,且 attemptNumber 為 0 到 3。 |
startTime |
long:跑步開始時間,透過 System.currentTimeMillis() 測量 |
testRunStopped
public final void testRunStopped (long elapsedTime)
由於使用者要求,報表測試執行作業在完成前停止。
TODO:目前未使用,考慮移除
| 參數 | |
|---|---|
elapsedTime |
long:裝置回報的經過時間 (以毫秒為單位) |
testSkipped
public final void testSkipped (TestDescription test, SkipReason reason)
Called when a test is skipped and did not execute for a reason that is not usually expected. 系統會嘗試重試這些測試,以確保正常執行。
| 參數 | |
|---|---|
test |
TestDescription:識別測試 |
reason |
SkipReason:SkipReason |
testStarted
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() 測量 |
testStarted
public final void testStarted (TestDescription test)
測試案例回呼
| 參數 | |
|---|---|
test |
TestDescription:識別測試 |