ResultForwarder

public class ResultForwarder
extends Object implements ITestInvocationListener

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

將叫用結果轉送至其他 Listener 清單的 ITestInvocationListener。

摘要

公用建構函式

ResultForwarder(ITestInvocationListener... listeners)

ResultForwarder 的替代變數引數建構函式。
ResultForwarder( listeners)

建立 ResultForwarder。

受保護的建構函式

ResultForwarder()

使用延遲的事件監聽器設定建立 ResultForwarder。

公用方法

TestSummary getSummary()

允許 InvocationListener 傳回摘要。

void invocationEnded(long elapsedTime)

回報叫用已終止，無論是否成功或因某些錯誤條件而終止。
void invocationFailed(FailureDescription failure)

由於某些錯誤情況，因此回報未完成的叫用作業。

void invocationFailed(Throwable cause)

由於某些錯誤情況，因此回報未完成的叫用作業。

void invocationSkipped(SkipReason reason)

將叫用動作回報為略過

void invocationStarted(IInvocationContext context)

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

void testAssumptionFailure(TestDescription test, String trace)

當原子測試標記假設條件為 false 時，系統會呼叫此方法

void testAssumptionFailure(TestDescription test, FailureDescription failure)

當原子測試標記假設條件為 false 時，系統會呼叫此方法

void testEnded(TestDescription test, long endTime, testMetrics)

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

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

void testFailed(TestDescription test, FailureDescription failure)

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

void testFailed(TestDescription test, String trace)

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

void testIgnored(TestDescription test)

在測試不會執行時呼叫的方法，通常是因為測試方法加上 org.junit.Ignore 註解。
void testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)

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

void testModuleEnded()

回報模組執行作業的結尾。
void testModuleStarted(IInvocationContext moduleContext)

回報模組開始執行的時間。
void testRunEnded(long elapsedTime, runMetrics)

回報測試執行結束。

void testRunFailed(FailureDescription failure)

發生「FailureDescription」所述的失敗情形，因此無法完成報表測試。

void testRunFailed(String errorMessage)

由於發生致命錯誤，報表測試執行作業無法完成。

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

報表測試在使用者要求下，在完成前停止執行。

void testSkipped(TestDescription test, SkipReason reason)

測試被略過，且因非預期原因而未執行時呼叫。
void testStarted(TestDescription test, long startTime)

testStarted(com.android.tradefed.result.TestDescription) 的替代方案，我們也會指定測試開始時間，並搭配 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) 進行精確評估。
void testStarted(TestDescription test)

回報個別測試案例的開始時間。

保護方法

getListeners()

取得事件監聽器清單。

void setListeners(ITestInvocationListener... listeners)

在建構後設定監聽器。

void setListeners( listeners)

在建構後設定監聽器。

公用建構函式

ResultForwarder

public ResultForwarder (ITestInvocationListener... listeners)

ResultForwarder 的替代變數參數建構函式。

參數
listeners ITestInvocationListener：傳回結果的實際 ITestInvocationListener

ResultForwarder

public ResultForwarder ( listeners)

建立 ResultForwarder。

參數
listeners ：傳回結果的實際 ITestInvocationListener

受保護的建構函式

ResultForwarder

protected ResultForwarder ()

建立具有延遲事件監聽器設定的 ResultForwarder。僅供子類別使用。

公用方法

getSummary

public TestSummary getSummary ()

允許 InvocationListener 傳回摘要。

傳回
TestSummary 摘要執行作業的 TestSummary，或空值

invocationEnded

public void invocationEnded (long elapsedTime)

回報叫用已終止，無論是成功或因某些錯誤條件而終止。

會由 TradeFederation 架構自動呼叫。

參數
elapsedTime long：叫用作業的經過時間 (以毫秒為單位)

invocationFailed

public void invocationFailed (FailureDescription failure)

回報因某些錯誤狀況而不完整的叫用。

會由 TradeFederation 架構自動呼叫。

參數
failure FailureDescription：說明失敗原因的 FailureDescription

invocationFailed

public void invocationFailed (Throwable cause)

由於某些錯誤情況，因此回報未完成的叫用作業。

會由 TradeFederation 架構自動呼叫。

參數
cause Throwable：失敗的 Throwable 原因

invocationSkipped

public void invocationSkipped (SkipReason reason)

將叫用動作回報為略過

參數
reason SkipReason

invocationStarted

public void invocationStarted (IInvocationContext context)

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

會由 TradeFederation 架構自動呼叫。回報者必須覆寫這個方法，才能支援多部裝置回報功能。

參數
context IInvocationContext：叫用作業相關資訊

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                String trace)

當原子測試標記假設條件為 false 時，系統會呼叫此方法

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

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

當原子測試標記假設條件為 false 時，系統會呼叫此方法

參數
test TestDescription：用於識別測試
failure FailureDescription：FailureDescription 可說明失敗和相關情境。

testEnded

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

testEnded

public void testEnded (TestDescription test, 
                 testMetrics)

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

如果未叫用 testFailed(TestDescription, FailureDescription)，則這項測試會通過。也會傳回在測試案例執行期間可能已發出的任何鍵/值指標。

參數
test TestDescription：用於識別測試
testMetrics ：傳送指標的 ERROR(/Map)

testFailed

public void testFailed (TestDescription test, 
                FailureDescription failure)

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

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

參數
test TestDescription：用於識別測試
failure FailureDescription：FailureDescription 可說明失敗和相關情境。

測試失敗

public void testFailed (TestDescription test, 
                String trace)

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

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

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

testIgnored

public void testIgnored (TestDescription test)

當測試不會執行時，系統會呼叫此方法，通常是因為測試方法已標註為 org.junit.Ignore。

參數
test TestDescription：用於識別測試

testLog

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 elapsedTime, 
                 runMetrics)

測試執行結束報表。

參數
elapsedTime long：裝置回報的經過時間，以毫秒為單位
runMetrics ：測試執行結束時回報的鍵/值組合

testRunFailed

public void testRunFailed (FailureDescription failure)

由於 FailureDescription 所述的錯誤，導致報表測試執行作業無法完成。

參數
failure FailureDescription：FailureDescription 可說明失敗和相關情境。

testRunFailed

public 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 次，在同一個 runName 下應有 4 次執行作業，而 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 次，在同一個 runName 下應有 4 次執行作業，而 tryNumber 介於 0 到 3 之間。
startTime long：透過 System.currentTimeMillis() 測量的執行作業開始時間

testRunStopped

public void testRunStopped (long elapsedTime)

報表測試在使用者要求下，在完成前停止執行。

TODO：目前未使用，建議移除

參數
elapsedTime long：裝置回報的經過時間，以毫秒為單位

testSkipped

public void testSkipped (TestDescription test, 
                SkipReason reason)

當測試遭到略過，且未因通常預期的原因而執行時，系統會呼叫此方法。系統會嘗試重新嘗試這些測試，以嘗試執行正確的作業。

參數
test TestDescription：用於識別測試
reason SkipReason：SkipReason

testStarted

public 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 void testStarted (TestDescription test)

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

參數
test TestDescription：用於識別測試

受保護的方法

getListeners

protected  getListeners ()

取得事件監聽器清單。僅供子類別使用。

傳回
ITestInvocationListener 清單。

setListeners

protected void setListeners (ITestInvocationListener... listeners)

在建構後設定監聽器。僅供子類別使用。

參數
listeners ITestInvocationListener：傳回結果的實際 ITestInvocationListener

setListeners

protected void setListeners ( listeners)

在建構後設定監聽器。僅供子類別使用。

參數
listeners ：傳回結果的實際 ITestInvocationListener