原型結果報告器

public abstract class ProtoResultReporter
extends Object implements ITestInvocationListener , ILogSaverListener , ISupportGranularResults

java.lang.Object
↳	com.android.tradefed.result.proto.ProtoResultReporter

已知的直接子類 文件協議結果報告器、流協議結果報告器 文件原型結果報告器 將TestRecord轉儲到文件中的原型報告器。 StreamProtoResultReporter 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) 由於某些錯誤情況而報告不完整的呼叫。
void	invocationSkipped ( SkipReason reason) 將呼叫報告為已跳過
final void	invocationStarted ( IInvocationContext context) 報告測試調用的開始。
final void	logAssociation (String dataName, LogFile logFile) 在某些情況下，日誌必須與測試案例強關聯，但有機會這樣做就直接testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)回呼是不可能的。
void	processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs) 使用呼叫記錄一一發送所有呼叫的最終日誌。
void	processFinalProto (TestRecordProto.TestRecord finalRecord) 處理帶有所有結果的最終原型。
void	processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext) 發生invocationStarted(com.android.tradefed.invoker.IInvocationContext)後處理部分呼叫測試記錄原型。
void	processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord) 發生ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,HashMap))後處理最終測試案例記錄原型。
void	processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord) 在testStarted(com.android.tradefed.result.TestDescription, long)發生後處理部分測試案例記錄原型。
void	processTestModuleEnd (TestRecordProto.TestRecord moduleRecord) 在testModuleEnded()發生後處理最終的模組記錄原型。
void	processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord) 在testModuleStarted(com.android.tradefed.invoker.IInvocationContext)發生後處理部分模組記錄原型。
void	processTestRunEnded (TestRecordProto.TestRecord runRecord, boolean moduleInProgress) 發生ERROR(/#testRunEnded(long,HashMap))後最終運行記錄原型的處理。
void	processTestRunStarted (TestRecordProto.TestRecord runStartedRecord) testRunStarted(String, int)發生後處理部分測試運行記錄原型。
void	setGranularResults (boolean granularResults)
void	setInlineRecordOfChildren (boolean inline)
boolean	supportGranularResults () 如果報告器支援精細結果，則傳回 True，否則傳回 false。
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))的替代方案，我們可以直接指定結束時間。
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) 報告測試運行由於FailureDescription描述的故障而未能完成。
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	testSkipped ( TestDescription test, SkipReason reason) 當測試因通常意外的原因而被跳過且未執行時調用。
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) 報告單一測試用例的開始。

受保護的方法
TestRecordProto.ChildReference	createModuleChildReference (TestRecordProto.TestRecord record) 為模組建立子引用。

公共構造函數

原型結果報告器

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 ：失敗的Throwable原因

呼叫已跳過

public void invocationSkipped (SkipReason reason)

將呼叫報告為已跳過

參數
reason	SkipReason

調用開始

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 ，應與測試案例關聯。

處理最終呼叫日誌

public void processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs)

使用呼叫記錄一一發送所有呼叫的最終日誌。

參數
invocationLogs	TestRecordProto.TestRecord ：表示呼叫的最終原型。

流程最終原型

public void processFinalProto (TestRecordProto.TestRecord finalRecord)

處理帶有所有結果的最終原型。

參數
finalRecord	TestRecordProto.TestRecord ：包含所有呼叫結果的最終原型。

進程開始調用

public void processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, 
                IInvocationContext invocationContext)

發生invocationStarted(com.android.tradefed.invoker.IInvocationContext)後處理部分呼叫測試記錄原型。

參數
invocationStartRecord	TestRecordProto.TestRecord ：呼叫開始後填入的部分原型。
invocationContext	IInvocationContext ：呼叫IInvocationContext 。

流程測試用例結束

public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)

發生ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,HashMap))後處理最終測試案例記錄原型。

參數
testCaseRecord	TestRecordProto.TestRecord ：代表測試用例的最終原型。

流程測試用例開始

public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)

在testStarted(com.android.tradefed.result.TestDescription, long)發生後處理部分測試案例記錄原型。

參數
testCaseStartedRecord	TestRecordProto.TestRecord ：表示測試案例的部分原型。

進程測試模組結束

public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)

在testModuleEnded()發生後處理最終的模組記錄原型。

參數
moduleRecord	TestRecordProto.TestRecord ：表示模組的最終原型。

進程測試模組已啟動

public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)

在testModuleStarted(com.android.tradefed.invoker.IInvocationContext)發生後處理部分模組記錄原型。

參數
moduleStartRecord	TestRecordProto.TestRecord ：表示模組的部分原型。

進程測試運行結束

public void processTestRunEnded (TestRecordProto.TestRecord runRecord, 
                boolean moduleInProgress)

發生ERROR(/#testRunEnded(long,HashMap))後最終運行記錄原型的處理。

參數
runRecord	TestRecordProto.TestRecord ：代表運行的最終原型。
moduleInProgress	boolean ：模組是否正在進行中。

進程測試運行開始

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 ()

如果報告器支援精細結果，則傳回 True，否則傳回 false。

退貨
boolean

測試假設失敗

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 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 ：描述運行失敗原因的String 。

測試運行開始

public 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 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 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()測量

測試開始

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