BugreportCollector

public class BugreportCollector
extends Object implements ITestInvocationListener

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

會在可設定事件時收集錯誤報告的傳遞 ITestInvocationListener 便會在每次發生後，對其子項呼叫 ITestInvocationListener#testLog 錯誤報告收集完成。

行為：(FIXME：完成此項)

  • 如有測試案例失敗，請在每次測試後擷取
  • 在每個測試案例後擷取
  • 在每次測試失敗後擷取
  • 擷取

摘要

巢狀類別

class BugreportCollector.Predicate

說明擷取錯誤報告的時機的完整述詞。 

interface BugreportCollector.SubPredicate

 

欄位

public static final BugreportCollector.Predicate AFTER_FAILED_TESTCASES

預先定義的述詞，會在每個測試失敗後觸發

public static final BugreportCollector.Predicate AT_START

首次叫用時觸發的預先定義述詞

公用建構函式

BugreportCollector(ITestInvocationListener listener, ITestDevice testDevice)

公用方法

void addPredicate(BugreportCollector.Predicate p)
void blockUntilIdle()

封鎖，直到收集器未收集任何錯誤報告為止。

TestSummary getSummary()

允許 InvocationListener 傳回摘要。

void invocationEnded(long elapsedTime)

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

void invocationFailed(Throwable cause)

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

void invocationStarted(IInvocationContext context)

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

void setAsynchronous(boolean asynchronous)

設定錯誤報告收集作業是否應透過其他執行緒收集錯誤報告 (asynchronous = true) 或封鎖呼叫端，直到擷取錯誤報告為止 (asynchronous = false)。

void setDescriptiveName(String name)

設定記錄錯誤報告時使用的描述性名稱。

void setDeviceWaitTime(int waitTime)

設定裝置上線前，等待時間 (秒) 開始擷取 錯誤報告。

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)

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

欄位

AFTER_FAILED_TESTCASES 數

public static final BugreportCollector.Predicate AFTER_FAILED_TESTCASES

預先定義的述詞，會在每個測試失敗後觸發

AT_START

public static final BugreportCollector.Predicate AT_START

首次叫用時觸發的預先定義述詞

公用建構函式

BugreportCollector

public BugreportCollector (ITestInvocationListener listener, 
                ITestDevice testDevice)

參數
listener ITestInvocationListener

testDevice ITestDevice

公用方法

addPredicate

public void addPredicate (BugreportCollector.Predicate p)

參數
p BugreportCollector.Predicate

BlockUntilIdle

public void blockUntilIdle ()

封鎖，直到收集器未收集任何錯誤報告為止。如果收集器未主動運作 收集錯誤報告後，請立即傳回

取得摘要

public TestSummary getSummary ()

允許 InvocationListener 傳回摘要。

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

已叫用

public void invocationEnded (long elapsedTime)

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

將由 TradeFederation 架構自動呼叫。

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

叫用失敗

public void invocationFailed (Throwable cause)

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

將由 TradeFederation 架構自動呼叫。

參數
cause Throwable：失敗的 Throwable 原因

叫用

public void invocationStarted (IInvocationContext context)

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

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

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

非同步設定

public void setAsynchronous (boolean asynchronous)

設定錯誤報告收集作業是否應透過其他執行緒收集錯誤報告 (asynchronous = true) 或封鎖呼叫端，直到擷取錯誤報告為止 (asynchronous = false)。

參數
asynchronous boolean

setDescriptiveName

public void setDescriptiveName (String name)

設定記錄錯誤報告時使用的描述性名稱。如果是 null， BugreportCollector 會改回使用將名稱序列化時的預設行為 觸發要收集錯誤報告的事件。

參數
name String

setDeviceWaitTime

public void setDeviceWaitTime (int waitTime)

設定裝置上線前，等待時間 (秒) 開始擷取 錯誤報告。如果值為負數，則不會執行檢查。任何DeviceNotAvailableException 系統會記錄並忽略檢查期間遇到的任何變化。

參數
waitTime int

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                String trace)

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

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

測試結束

public void testEnded (TestDescription test, 
                 testMetrics)

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

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

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

測試失敗

public void testFailed (TestDescription test, 
                String trace)

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

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

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

已忽略測試

public void testIgnored (TestDescription test)

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

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

testRunEnded

public void testRunEnded (long elapsedTime, 
                 runMetrics)

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

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

testRunFailed

public void testRunFailed (String errorMessage)

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

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

testRunStarted

public void testRunStarted (String runName, 
                int testCount)

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

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

testRunStopped

public void testRunStopped (long elapsedTime)

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

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

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

testStarted

public void testStarted (TestDescription test)

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

參數
test TestDescription：識別測試