ProtoResultReporter

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

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

結果回報工具會建構 TestRecord protobuf，並提供所有結果。應為 擴充為處理 processFinalProto(com.android.tradefed.result.proto.TestRecordProto.TestRecord) 中最終 proto 的處理方式。

摘要

公用建構函式

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)

處理具有所有結果的最終 proto。

void processStartInvocation(TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext)

在 invocationStarted(com.android.tradefed.invoker.IInvocationContext) 發生後處理部分叫用測試記錄 proto。

void processTestCaseEnded(TestRecordProto.TestRecord testCaseRecord)

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

void processTestCaseStarted(TestRecordProto.TestRecord testCaseStartedRecord)

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

void processTestModuleEnd(TestRecordProto.TestRecord moduleRecord)

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

void processTestModuleStarted(TestRecordProto.TestRecord moduleStartRecord)

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

void processTestRunEnded(TestRecordProto.TestRecord runRecord, boolean moduleInProgress)

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

void processTestRunStarted(TestRecordProto.TestRecord runStartedRecord)

處理 testRunStarted(String, int) 之後的部分測試執行記錄 proto 發生。

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)

ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) 的替代方式，可以指定結束時間

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

測試執行結束報表。

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)

為模組建立子項參照。

公用建構函式

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：失敗的 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之前記錄且應與 測試案例

processFinalInvocationLogs

public void processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs)

使用叫用記錄，逐一傳送叫用的所有最終記錄。

參數
invocationLogs TestRecordProto.TestRecord：最終的 proto，代表叫用。

processFinalProto

public void processFinalProto (TestRecordProto.TestRecord finalRecord)

處理具有所有結果的最終 proto。

參數
finalRecord TestRecordProto.TestRecord：最終的 proto，包含所有叫用結果。

processStartInvocation

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

在 invocationStarted(com.android.tradefed.invoker.IInvocationContext) 發生後處理部分叫用測試記錄 proto。

參數
invocationStartRecord TestRecordProto.TestRecord：在叫用啟動後填入的部分 proto。
invocationContext IInvocationContext：叫用 IInvocationContext。

processTestCaseEnded

public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)

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

參數
testCaseRecord TestRecordProto.TestRecord：完成的 proto，代表測試案例。

processTestCaseStarted

public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)

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

參數
testCaseStartedRecord TestRecordProto.TestRecord：代表測試案例的部分 proto。

processTestModuleEnd

public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)

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

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

processTestModuleStarted

public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)

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

參數
moduleStartRecord TestRecordProto.TestRecord：代表模組的部分 proto。

processTestRunEnded

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

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

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

processTestRunStarted

public void processTestRunStarted (TestRecordProto.TestRecord runStartedRecord)

處理 testRunStarted(String, int) 之後的部分測試執行記錄 proto 發生。

參數
runStartedRecord TestRecordProto.TestRecord：代表執行作業的部分 proto。

setGranularResults

public void setGranularResults (boolean granularResults)

參數
granularResults boolean

setInlineRecordOfChildren

public void setInlineRecordOfChildren (boolean inline)

參數
inline boolean

支援 GranularResults

public boolean supportGranularResults ()

如果回報程式支援精細結果，會傳回 True，否則傳回 false。

傳回
boolean

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，說明失敗及其背景資訊。

測試結束

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：識別測試

testModuleEnded

public final void testModuleEnded ()

回報模組的執行完畢。

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

回報執行模組的開始。這個回呼與 testModuleEnded() 相關聯，在序列中是選用選項。只會在使用 模組：套件型執行器

參數
moduleContext IInvocationContext：模組的 IInvocationContext。

testRunEnded

public final void testRunEnded (long elapsedTimeMillis, 
                 runMetrics)

測試執行結束報表。FIXME：我們不能有兩張地圖<>產生不同類型的介面 我們一定要在這裡使用 HashMap

參數
elapsedTimeMillis long：裝置回報的經過時間 (以毫秒為單位)
runMetrics ：使用 Metric 的測試執行結束時回報的鍵/值組合。

testRunFailed

public final void testRunFailed (FailureDescription failure)

由於「FailureDescription」指出失敗，因此無法完成報表測試。

參數
failure FailureDescription：FailureDescription，說明失敗及其背景資訊。

testRunFailed

public final void testRunFailed (String errorMessage)

發生嚴重錯誤，因此無法完成報表測試。

參數
errorMessage String：String 說明執行失敗的原因。

testRunStarted

public void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber)

回報測試執行作業的開始。

參數
runName String：測試執行作業名稱
testCount int：測試執行作業中的測試總數
attemptNumber int：訂單號碼，可識別同一個 runName 的不同嘗試次數 執行多次tryNumber 為 0 的索引，且每次都會遞增 新的執行作業發生時例如：每次執行精細的重試測試 3 次，總共應該有 4 次 在同一個 runName 下執行，且 tryNumber 介於 0 到 3 之間。

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

回報測試執行作業的開始。

參數
runName String：測試執行作業名稱
testCount int：測試執行作業中的測試總數

testRunStarted

public void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

回報測試執行作業的開始。

參數
runName String：測試執行作業名稱
testCount int：測試執行作業中的測試總數
attemptNumber int：訂單號碼，可識別同一個 runName 的不同嘗試次數 執行多次tryNumber 為 0 的索引，且每次傳回 新的工作也會開始執行例如：執行精細的重試 3 次測試，總共應執行 4 次測試 同一個 runName，且 tryNumber 介於 0 到 3 之間。
startTime long：執行作業開始的時間，透過 System.currentTimeMillis() 測量

測試略過

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)

回報個別測試案例的開頭。舊版介面，應盡可能使用 testStarted(com.android.tradefed.result.TestDescription)。

參數
test TestDescription：識別測試

保護方法

createModuleChildReference

protected TestRecordProto.ChildReference createModuleChildReference (TestRecordProto.TestRecord record)

為模組建立子項參照。

參數
record TestRecordProto.TestRecord

傳回
TestRecordProto.ChildReference