SubprocessResultsReporter

public class SubprocessResultsReporter
extends Object implements ILogSaverListener, ISupportGranularResults, ITestInvocationListener

java.lang.Object
   ↳ com.android.tradefed.result.SubprocessResultsReporter

實作 ITestInvocationListener 做為 result_reporter，並從此指令開始 測試執行作業、測試叫用的結果

摘要

公用建構函式

SubprocessResultsReporter()

公用方法

void close()

TestSummary getSummary()

允許 InvocationListener 傳回摘要。

void invocationEnded(long elapsedTime)

回報叫用已終止 (無論成功或因某些錯誤而終止) 值。

void invocationFailed(FailureDescription failure)

回報因某些錯誤條件而不完整的叫用。

void invocationFailed(Throwable cause)

回報因某些錯誤條件而不完整的叫用。

void invocationStarted(IInvocationContext context)

回報測試叫用開始的時間。

void logAssociation(String dataName, LogFile logFile)

在某些情況下，記錄必須與測試案例產生緊密關聯，不過也可以等到 因此，testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) 直達資訊 無法回呼。

void printEvent(String key, Object event)

顯示事件金鑰和 JSON 物件的輔助程式。

void setOutputTestLog(boolean outputTestLog)

設定我們是否應輸出記錄的測試。

boolean supportGranularResults()

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

void testAssumptionFailure(TestDescription testId, String trace)

在不可部分完成的測試旗標假設條件為 false 時呼叫

void testAssumptionFailure(TestDescription testId, FailureDescription failure)

在不可部分完成的測試旗標假設條件為 false 時呼叫

void testEnded(TestDescription testId, long endTime, metrics)

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

void testEnded(TestDescription testId, metrics)

回報個別測試案例的執行結束時間。

void testFailed(TestDescription testId, FailureDescription failure)

回報個別測試案例的失敗情形。

void testFailed(TestDescription testId, String reason)

回報個別測試案例的失敗情形。

void testIgnored(TestDescription testId)

在測試不執行時呼叫的呼叫，通常是因為測試方法加上了 org.junit.Ignore

void testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)

提供來自測試叫用的相關聯記錄或偵錯資料。

void testModuleEnded()

回報模組的執行完畢。

void testModuleStarted(IInvocationContext moduleContext)

回報執行模組的開始。

void testRunEnded(long time, runMetrics)

測試執行結束報表。

void testRunFailed(FailureDescription failure)

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

void testRunFailed(String reason)

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

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

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

void testRunStarted(String runName, int testCount)

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

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

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

void testRunStopped(long arg0)

由於使用者要求，報表測試在執行完畢前已停止執行。

void testSkipped(TestDescription testId, SkipReason reason)

測試被略過，且因非預期原因而未執行時呼叫。

void testStarted(TestDescription testId, long startTime)

testStarted(com.android.tradefed.result.TestDescription) 的替代方式，我們會一併指定測試的時間 再加上 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))，才能取得準確的測量結果

void testStarted(TestDescription testId)

回報個別測試案例的開頭。

公用建構函式

SubprocessResultsReporter

public SubprocessResultsReporter ()

公用方法

關閉

public void close ()

取得摘要

public TestSummary getSummary ()

允許 InvocationListener 傳回摘要。

傳回
TestSummary 匯總執行作業的 TestSummary，或空值

已叫用

public 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 invocationStarted (IInvocationContext context)

回報測試叫用開始的時間。

將由 TradeFederation 架構自動呼叫。回報者需要覆寫 此方法就能支援多部裝置回報。

參數
context IInvocationContext：叫用的相關資訊

記錄檔關聯

public 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之前記錄且應與 測試案例

printEvent

public void printEvent (String key, 
                Object event)

顯示事件金鑰和 JSON 物件的輔助程式。

參數
key String

event Object

setOutputTestLog

public void setOutputTestLog (boolean outputTestLog)

設定我們是否應輸出記錄的測試。

參數
outputTestLog boolean

支援 GranularResults

public boolean supportGranularResults ()

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

傳回
boolean

testAssumptionFailure

public void testAssumptionFailure (TestDescription testId, 
                String trace)

在不可部分完成的測試旗標假設條件為 false 時呼叫

參數
testId TestDescription：識別測試
trace String：失敗的堆疊追蹤

testAssumptionFailure

public void testAssumptionFailure (TestDescription testId, 
                FailureDescription failure)

在不可部分完成的測試旗標假設條件為 false 時呼叫

參數
testId TestDescription：識別測試
failure FailureDescription：FailureDescription，說明失敗及其背景資訊。

測試結束

public void testEnded (TestDescription testId, 
                long endTime, 
                 metrics)

ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) 的替代方式，可以指定結束時間 搭配 testStarted(com.android.tradefed.result.TestDescription, long) 即可取得準確的測量結果。

參數
testId TestDescription：識別測試
endTime long：測試結束的時間，透過 System.currentTimeMillis() 進行評估
metrics ：發送的指標的 ERROR(/Map)

測試結束

public void testEnded (TestDescription testId, 
                 metrics)

回報個別測試案例的執行結束時間。

如果未叫用 testFailed(TestDescription, FailureDescription)，這項測試就會通過。同時傳回任何鍵/值 指標，這些是在測試案例執行期間產生的指標。

參數
testId TestDescription：識別測試
metrics ：發送的指標的 ERROR(/Map)

測試失敗

public void testFailed (TestDescription testId, 
                FailureDescription failure)

回報個別測試案例的失敗情形。

這個值會在 testStarted 和 testEnded 之間呼叫。

參數
testId TestDescription：識別測試
failure FailureDescription：FailureDescription，說明失敗及其背景資訊。

測試失敗

public void testFailed (TestDescription testId, 
                String reason)

回報個別測試案例的失敗情形。

這個值會在 testStarted 和 testEnded 之間呼叫。

參數
testId TestDescription：識別測試
reason String：失敗的堆疊追蹤

已忽略測試

public void testIgnored (TestDescription testId)

在測試不執行時呼叫的呼叫，通常是因為測試方法加上了 org.junit.Ignore

參數
testId TestDescription：識別測試

測試記錄

public 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 方法完成前開放存取。

testModuleEnded

public void testModuleEnded ()

回報模組的執行完畢。

testModuleStarted

public void testModuleStarted (IInvocationContext moduleContext)

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

參數
moduleContext IInvocationContext：模組的 IInvocationContext。

testRunEnded

public void testRunEnded (long time, 
                 runMetrics)

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

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

testRunFailed

public void testRunFailed (FailureDescription failure)

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

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

testRunFailed

public void testRunFailed (String reason)

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

參數
reason 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 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() 測量

testRunStopped

public void testRunStopped (long arg0)

由於使用者要求，報表測試在執行完畢前已停止執行。

待辦事項：目前未使用，建議移除

參數
arg0 long：裝置回報的經過時間 (以毫秒為單位)

測試略過

public void testSkipped (TestDescription testId, 
                SkipReason reason)

測試被略過，且因非預期原因而未執行時呼叫。 系統會嘗試重新嘗試這些測試，以便執行正確的作業。

參數
testId TestDescription：識別測試
reason SkipReason：SkipReason

testStarted

public void testStarted (TestDescription testId, 
                long startTime)

testStarted(com.android.tradefed.result.TestDescription) 的替代方式，我們會一併指定測試的時間 再加上 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))，才能取得準確的測量結果

參數
testId TestDescription：識別測試
startTime long：測試開始的時間，透過 System.currentTimeMillis() 進行測量

testStarted

public void testStarted (TestDescription testId)

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

參數
testId TestDescription：識別測試