子流程結果報告器

public class SubprocessResultsReporter
extends Object implements ITestInvocationListener , ILogSaverListener , ISupportGranularResults

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


實作ITestInvocationListener以指定為 result_reporter 並從子流程轉送測試、測試運行、測試呼叫的結果。

概括

公共構造函數

SubprocessResultsReporter ()

公共方法

void close ()

TestSummary getSummary ()

允許 IncationListener 傳回摘要。

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) testEnded ( TestDescription testId, long endTime, metrics)

ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))的替代方案,我們可以直接指定結束時間。

void testEnded ( TestDescription testId, metrics) 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) 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)

報告單一測試用例的開始。

公共構造函數

子流程結果報告器

public SubprocessResultsReporter ()

公共方法

關閉

public void close ()

取得摘要

public TestSummary getSummary ()

允許 IncationListener 傳回摘要。

退貨
TestSummary總結運行的TestSummary ,或 null

呼叫結束

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

列印事件

public void printEvent (String key, 
                Object event)

幫助程式列印事件鍵,然後列印 json 物件。

參數
key String

event Object

設定輸出測試日誌

public void setOutputTestLog (boolean outputTestLog)

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

參數
outputTestLog boolean

支援粒度結果

public boolean supportGranularResults ()

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

退貨
boolean

測試假設失敗

public void testAssumptionFailure (TestDescription testId, 
                String trace)

當原子測試標記其假定條件為 false 時調用

參數
testId TestDescription :標識測試

trace String : 失敗的堆疊追蹤

測試假設失敗

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 方法完成。

測試模組結束

public void testModuleEnded ()

報告模組運作結束。

測試模組啟動

public void testModuleStarted (IInvocationContext moduleContext)

報告模組運作的開始。此回調與testModuleEnded()關聯,並且在序列中是可選的。它僅在使用模組的運行期間使用:基於套件的運行器。

參數
moduleContext IInvocationContext :模組的IInvocationContext

測試運行結束

public void testRunEnded (long time, 
                 runMetrics)

報告測試運行結束。 FIXME:我們不能有兩個不同類型的 Map<> 接口,所以我們必須在這裡使用 HashMap。

參數
time long :設備報告的經過時間,以毫秒為單位

runMetrics :使用Metric測試運行結束時報告的鍵值對。

測試運行失敗

public void testRunFailed (FailureDescription failure)

報告測試運行由於FailureDescription描述的故障而未能完成。

參數
failure FailureDescription :描述故障及其上下文的FailureDescription

測試運行失敗

public void testRunFailed (String reason)

報告測試運行因致命錯誤而未能完成。

參數
reason 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 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 void testRunStopped (long arg0)

由於用戶請求,報告測試運行在完成之前停止。

TODO:目前未使用,考慮刪除

參數
arg0 long :設備報告的經過時間,以毫秒為單位

測試跳過

public void testSkipped (TestDescription testId, 
                SkipReason reason)

當測試因通常意外的原因而被跳過且未執行時調用。將嘗試重試這些測試以嘗試正確執行。

參數
testId TestDescription :標識測試

reason SkipReason : SkipReason

測試開始

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

測試開始

public void testStarted (TestDescription testId)

報告單一測試用例的開始。較舊的接口,應盡可能使用testStarted(com.android.tradefed.result.TestDescription)

參數
testId TestDescription :標識測試