ProtoResultReporter
public abstract class ProtoResultReporter
extends Object
implements ITestInvocationListener , ILogSaverListener , ISupportGranularResults
java.lang.Object | |
↳ | com.android.tradefed.result.proto.ProtoResultReporter |
結果報告器構建一個包含所有結果的TestRecord
protobuf。應該擴展以處理如何處理processFinalProto(com.android.tradefed.result.proto.TestRecordProto.TestRecord)
中的最終原型。
概括
公共構造函數 | |
---|---|
ProtoResultReporter () |
公共方法 | |
---|---|
final void | invocationEnded (long elapsedTime) 報告調用已終止,無論是成功終止還是由於某些錯誤情況。 |
void | invocationFailed ( FailureDescription failure) 報告由於某些錯誤情況導致的不完整調用。 |
void | invocationFailed (Throwable cause) 報告由於某些錯誤情況導致的不完整調用。 |
final void | invocationStarted ( IInvocationContext context) 報告測試調用的開始。 |
final void | logAssociation (String dataName, LogFile logFile) 在某些情況下,日誌必須與測試用例強關聯,但有機會這樣做就直接 |
void | processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs) 使用調用記錄將調用的所有最終日誌一一發送。 |
void | processFinalProto (TestRecordProto.TestRecord finalRecord) 處理具有所有結果的最終原型。 |
void | processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext) 在發生 |
void | processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord) 在 |
void | processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord) 在 |
void | processTestModuleEnd (TestRecordProto.TestRecord moduleRecord) 在 |
void | processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord) 在 |
void | processTestRunEnded (TestRecordProto.TestRecord runRecord, boolean moduleInProgress) |
void | processTestRunStarted (TestRecordProto.TestRecord runStartedRecord) 在 |
void | setGranularResults (boolean granularResults) |
void | setInlineRecordOfChildren (boolean inline) |
boolean | supportGranularResults () 如果 reporter 支持粒度結果,則返回 True,否則返回 false。 |
final void | testAssumptionFailure ( TestDescription test, String trace) 當原子測試標記它假定條件為假時調用 |
final void | testAssumptionFailure ( TestDescription test, FailureDescription failure) 當原子測試標記它假定條件為假時調用 |
final void | testEnded ( TestDescription test, long endTime, testMetrics) testEnded ( TestDescription test, long endTime, testMetrics) |
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 | testModuleEnded () 報告模塊運行結束。 |
final void | testModuleStarted ( IInvocationContext moduleContext) 報告模塊運行的開始。 |
final void | testRunEnded (long elapsedTimeMillis, runMetrics) testRunEnded (long elapsedTimeMillis, runMetrics) 報告測試運行結束。 |
final void | testRunFailed ( FailureDescription failure) 由於 |
final void | testRunFailed (String errorMessage) 報告測試運行由於致命錯誤而未能完成。 |
void | testRunStarted (String runName, int testCount, int attemptNumber) 報告測試運行的開始。 |
final void | testRunStarted (String runName, int testCount) 報告測試運行的開始。 |
void | testRunStarted (String runName, int testCount, int attemptNumber, long startTime) 報告測試運行的開始。 |
final void | testStarted ( TestDescription test, long startTime) |
final void | testStarted ( TestDescription test) 報告單個測試用例的開始。 |
受保護的方法 | |
---|---|
TestRecordProto.ChildReference | createModuleChildReference (TestRecordProto.TestRecord record) 為模塊創建子引用。 |
公共構造函數
ProtoResultReporter
public ProtoResultReporter ()
公共方法
調用結束
public final void invocationEnded (long elapsedTime)
報告調用已終止,無論是成功終止還是由於某些錯誤情況。
將由 TradeFederation 框架自動調用。參數 | |
---|---|
elapsedTime | long :調用經過的時間(以毫秒為單位) |
調用失敗
public void invocationFailed (FailureDescription failure)
報告由於某些錯誤情況導致的不完整調用。
將由 TradeFederation 框架自動調用。
參數 | |
---|---|
failure | FailureDescription :描述失敗原因的FailureDescription |
調用失敗
public void invocationFailed (Throwable cause)
報告由於某些錯誤情況導致的不完整調用。
將由 TradeFederation 框架自動調用。參數 | |
---|---|
cause | Throwable : 失敗的ERROR(/Throwable) 原因 |
調用開始
public final void invocationStarted (IInvocationContext context)
報告測試調用的開始。
將由 TradeFederation 框架自動調用。記者需要覆蓋此方法以支持多設備報告。
參數 | |
---|---|
context | IInvocationContext :有關調用的信息 |
日誌關聯
public final void logAssociation (String dataName, LogFile logFile)
在某些情況下,日誌必須與測試用例強關聯,但有機會這樣做就直接testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
回調是不可能的。因此,此回調允許顯式提供強關聯。
參數 | |
---|---|
dataName | String :數據的名稱 |
logFile | LogFile :之前記錄的LogFile ,應該與測試用例相關聯。 |
processFinalInvocationLogs
public void processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs)
使用調用記錄將調用的所有最終日誌一一發送。
參數 | |
---|---|
invocationLogs | TestRecordProto.TestRecord :表示調用的最終原型。 |
處理最終協議
public void processFinalProto (TestRecordProto.TestRecord finalRecord)
處理具有所有結果的最終原型。
參數 | |
---|---|
finalRecord | TestRecordProto.TestRecord :具有所有調用結果的最終原型。 |
processStartInvocation
public void processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext)
在發生invocationStarted(com.android.tradefed.invoker.IInvocationContext)
後處理部分調用測試記錄原型。
參數 | |
---|---|
invocationStartRecord | TestRecordProto.TestRecord :在 invocationStart 之後填充的部分原型。 |
invocationContext | IInvocationContext :調用IInvocationContext 。 |
流程測試用例結束
public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)
在ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,HashMap))
發生後處理最終的測試用例記錄原型。
參數 | |
---|---|
testCaseRecord | TestRecordProto.TestRecord :表示測試用例的最終原型。 |
processTestCaseStarted
public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)
在testStarted(com.android.tradefed.result.TestDescription, long)
發生後處理部分測試用例記錄原型。
參數 | |
---|---|
testCaseStartedRecord | TestRecordProto.TestRecord :表示測試用例的部分原型。 |
processTestModuleEnd
public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)
在testModuleEnded()
發生後處理最終模塊記錄原型。
參數 | |
---|---|
moduleRecord | TestRecordProto.TestRecord :表示模塊的最終原型。 |
processTestModuleStarted
public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)
在testModuleStarted(com.android.tradefed.invoker.IInvocationContext)
發生後處理部分模塊記錄原型。
參數 | |
---|---|
moduleStartRecord | TestRecordProto.TestRecord :表示模塊的部分原型。 |
processTestRunEnded
public void processTestRunEnded (TestRecordProto.TestRecord runRecord, boolean moduleInProgress)
ERROR(/#testRunEnded(long,HashMap))
發生後最終運行記錄原型的處理。
參數 | |
---|---|
runRecord | TestRecordProto.TestRecord :代表運行的最終原型。 |
moduleInProgress | boolean : 模塊是否在進行中。 |
processTestRunStarted
public void processTestRunStarted (TestRecordProto.TestRecord runStartedRecord)
在testRunStarted(String, int)
發生後處理部分測試運行記錄原型。
參數 | |
---|---|
runStartedRecord | TestRecordProto.TestRecord :代表運行的部分原型。 |
設置粒度結果
public void setGranularResults (boolean granularResults)
參數 | |
---|---|
granularResults | boolean |
setInlineRecordOfChildren
public void setInlineRecordOfChildren (boolean inline)
參數 | |
---|---|
inline | boolean |
支持粒度結果
public boolean supportGranularResults ()
如果 reporter 支持粒度結果,則返回 True,否則返回 false。
退貨 | |
---|---|
boolean |
測試假設失敗
public final void testAssumptionFailure (TestDescription test, String trace)
當原子測試標記它假定條件為假時調用
參數 | |
---|---|
test | TestDescription :標識測試 |
trace | String :失敗的堆棧跟踪 |
測試假設失敗
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
當原子測試標記它假定條件為假時調用
參數 | |
---|---|
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 :測試結束的時間,通過ERROR(/System#currentTimeMillis()) 測量 |
testMetrics | ERROR(/Map) |
測試結束
public 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 testModuleEnded ()
報告模塊運行結束。
測試模塊啟動
public final void testModuleStarted (IInvocationContext moduleContext)
報告模塊運行的開始。此回調與testModuleEnded()
關聯,並且在序列中是可選的。它僅在使用模塊的運行期間使用:基於套件的運行器。
參數 | |
---|---|
moduleContext | IInvocationContext :模塊的IInvocationContext 。 |
測試運行結束
public final void testRunEnded (long elapsedTimeMillis,runMetrics)
報告測試運行結束。 FIXME: 我們不能有兩個不同類型的 Map<> 接口,所以我們必須在這裡使用 HashMap。
參數 | |
---|---|
elapsedTimeMillis | long :設備報告經過的時間,以毫秒為單位 |
runMetrics | Metric 報告的鍵值對。 |
測試運行失敗
public final void testRunFailed (FailureDescription failure)
由於FailureDescription
描述的故障,報告測試運行未能完成。
參數 | |
---|---|
failure | FailureDescription :描述故障及其上下文的FailureDescription 。 |
測試運行失敗
public final void testRunFailed (String errorMessage)
報告測試運行由於致命錯誤而未能完成。
參數 | |
---|---|
errorMessage | String : ERROR(/String) 描述運行失敗的原因。 |
測試運行開始
public void testRunStarted (String runName, int testCount, int attemptNumber)
報告測試運行的開始。
參數 | |
---|---|
runName | String : 測試運行名稱 |
testCount | int : 測試運行中的測試總數 |
attemptNumber | int : order number,標識同一 runName 多次運行的不同嘗試。 attemptNumber 是從 0 開始索引的,每次發生新的運行時都應該遞增。例如,一個測試被精細地重試了 3 次,它應該在同一個 runName 下總共運行 4 次,並且 attemptNumber 是從 0 到 3。 |
測試運行開始
public final void testRunStarted (String runName, int testCount)
報告測試運行的開始。
參數 | |
---|---|
runName | String : 測試運行名稱 |
testCount | int : 測試運行中的測試總數 |
測試運行開始
public void testRunStarted (String runName, int testCount, int attemptNumber, long startTime)
報告測試運行的開始。
參數 | |
---|---|
runName | String : 測試運行名稱 |
testCount | int : 測試運行中的測試總數 |
attemptNumber | int : order number,標識同一 runName 多次運行的不同嘗試。 attemptNumber 是從 0 開始索引的,每次發生新的運行時都應該遞增。例如,一個測試被精細地重試了 3 次,它應該在同一個 runName 下總共運行 4 次,並且 attemptNumber 是從 0 到 3。 |
startTime | long :運行開始的時間,通過ERROR(/System#currentTimeMillis()) 測量 |
測試開始
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 :測試開始的時間,通過ERROR(/System#currentTimeMillis()) 測量 |
測試開始
public final void testStarted (TestDescription test)
報告單個測試用例的開始。較舊的界面,應盡可能使用testStarted(com.android.tradefed.result.TestDescription)
。
參數 | |
---|---|
test | TestDescription :標識測試 |
受保護的方法
創建模塊子引用
protected TestRecordProto.ChildReference createModuleChildReference (TestRecordProto.TestRecord record)
為模塊創建子引用。
參數 | |
---|---|
record | TestRecordProto.TestRecord |
退貨 | |
---|---|
TestRecordProto.ChildReference |