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))
上開始及停止收集。
摘要
欄位 | |
---|---|
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,
測試案例結束時的回呼。 |
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)
請勿在指標收集器實作中使用。 |
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)
當測試不會執行時,系統會呼叫此方法,通常是因為測試方法已標註為 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,
回報測試執行結束。 |
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
公用建構函式
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,目前的測試執行名稱。 |
init
public final ITestInvocationListener init (IInvocationContext context, ITestInvocationListener listener)
使用目前的內容和轉送結果的位置,初始化收集器。每個例項只會呼叫一次,且收集器應會更新其內部內容和事件監聽器。在測試執行期間,系統一律不會呼叫初始化。
除非您知道自己在做什麼,否則請勿覆寫。
參數 | |
---|---|
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)
由於某些錯誤情況,因此回報未完成的叫用作業。
會由 TradeFederation 架構自動呼叫。
參數 | |
---|---|
failure |
FailureDescription :描述失敗原因的 FailureDescription |
invocationFailed
public final void invocationFailed (Throwable cause)
由於某些錯誤情況,因此回報未完成的叫用作業。
會由 TradeFederation 架構自動呼叫。
參數 | |
---|---|
cause |
Throwable :失敗的 Throwable 原因 |
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)
設定是否應停用物件。停用表示應略過設定和拆卸步驟。可用於在預設建構函式中,讓物件預設為停用。
參數 | |
---|---|
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 執行多次的不同嘗試。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 執行多次的不同嘗試。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)
當測試遭到略過,且未因通常預期的原因而執行時,系統會呼叫此方法。系統會嘗試重試這些測試,以便取得正確的執行結果。
參數 | |
---|---|
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 :用於識別測試 |