NameMangleListener

public abstract class NameMangleListener
extends Object implements ITestInvocationListener

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


用於在回報結果時轉譯測試方法、類別和套件名稱的 Proxy 事件監聽器。

摘要

公用建構函式

NameMangleListener(ITestInvocationListener listener)

公用方法

TestSummary getSummary()

允許 InvocationListener 傳回摘要。

void invocationEnded(long elapsedTime)

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

void invocationFailed(Throwable cause)

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

void invocationStarted(IInvocationContext context)

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

void testAssumptionFailure(TestDescription test, String trace)

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

void testEnded(TestDescription test, testMetrics)

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

void testFailed(TestDescription test, String trace)

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

void testIgnored(TestDescription test)

在測試不會執行時呼叫的方法,通常是因為測試方法加上 org.junit.Ignore 註解。

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

提供測試叫用作業的相關記錄或偵錯資料。

void testRunEnded(long elapsedTime, runMetrics)

回報測試執行結束。

void testRunFailed(String errorMessage)

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

void testRunStarted(String runName, int testCount)

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

void testRunStopped(long elapsedTime)

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

void testStarted(TestDescription test)

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

受保護的方法

TestDescription mangleTestId(TestDescription test)

這個方法會在傳遞至 testStarted(com.android.tradefed.result.TestDescription)testFailed(com.android.tradefed.result.TestDescription, String)ERROR(/#testEnded(com.android.tradefed.result.TestDescription,HashMap)) 回呼的所有 TestDescription 上執行。

String mangleTestRunName(String name)

這個方法會在傳遞至 testRunStarted(String, int) 回呼的所有測試執行名稱上執行。

公用建構函式

NameMangleListener

public NameMangleListener (ITestInvocationListener listener)

參數
listener ITestInvocationListener

公用方法

取得摘要

public TestSummary getSummary ()

允許 InvocationListener 傳回摘要。

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

invocationEnded

public void invocationEnded (long elapsedTime)

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

會由 TradeFederation 架構自動呼叫。

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

invocationFailed

public void invocationFailed (Throwable cause)

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

將由 TradeFederation 架構自動呼叫。

參數
cause Throwable:失敗的 Throwable 原因

invocationStarted

public void invocationStarted (IInvocationContext context)

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

會由 TradeFederation 架構自動呼叫。回報器需要覆寫這個方法,才能支援多裝置回報。

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

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                String trace)

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

參數
test TestDescription:用於識別測試

trace String:失敗的堆疊追蹤

testEnded

public void testEnded (TestDescription test, 
                 testMetrics)

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

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

參數
test TestDescription:用於識別測試

testMetrics :傳送指標的 ERROR(/Map)

testFailed

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 方法完成前仍存在且可供存取。

testRunEnded

public void testRunEnded (long elapsedTime, 
                 runMetrics)

回報測試執行結束。

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

runMetrics :測試執行結束時回報的鍵/值組合

testRunFailed

public void testRunFailed (String errorMessage)

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

參數
errorMessage StringString,說明執行失敗的原因。

testRunStarted

public void testRunStarted (String runName, 
                int testCount)

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

參數
runName String:測試執行作業名稱

testCount int:測試執行作業中的測試總數

testRunStopped

public void testRunStopped (long elapsedTime)

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

TODO:目前未使用,建議移除

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

testStarted

public void testStarted (TestDescription test)

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

參數
test TestDescription:用於識別測試

受保護的方法

mangleTestId

protected TestDescription mangleTestId (TestDescription test)

這個方法會在傳遞至 testStarted(com.android.tradefed.result.TestDescription)testFailed(com.android.tradefed.result.TestDescription, String)ERROR(/#testEnded(com.android.tradefed.result.TestDescription,HashMap)) 回呼的所有 TestDescription 上執行。這個方法應傳回可能不同的 TestDescription,並傳遞至建構期間指定的下游 ITestInvocationListener

實作時應小心,避免修改原始 TestDescription

預設實作方式會將傳入的 ID 傳遞至未修改的狀態。

參數
test TestDescription

傳回
TestDescription

mangleTestRunName

protected String mangleTestRunName (String name)

此方法會在傳遞至 testRunStarted(String, int) 回呼的所有測試執行作業名稱上執行。此方法應傳回可能不同的測試執行名稱,並傳遞至建構期間指定的下游 ITestInvocationListener

實作時應小心,不要修改原始執行作業名稱。

預設實作方式會將傳入的測試執行名稱傳遞,且不會修改。

參數
name String

傳回
String