ShardListener

public class ShardListener
extends CollectingTestListener implements ISupportGranularResults

java.lang.Object
   ↳ com.android.tradefed.result.CollectingTestListener
     ↳ com.android.tradefed.invoker.ShardListener

ITestInvocationListener收集叫用資料分割 (亦稱為 以便同時對多個資源執行)，然後再轉送至其他 接聽程式。

摘要

公用建構函式

ShardListener(ITestInvocationListener main)

建立 ShardListener。

公用方法

getUnderlyingResultReporter()
void invocationEnded(long elapsedTime)

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

void invocationFailed(FailureDescription failure)

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

void invocationFailed(Throwable cause)

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

void invocationSkipped(SkipReason reason)

將叫用回報為略過

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 setSupportGranularResults(boolean enableGranularResults)
boolean supportGranularResults()

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

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

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

void testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)

void testModuleEnded()

回報模組的執行完畢。

void testModuleStarted(IInvocationContext moduleContext)

回報執行模組的開始。

void testRunEnded(long elapsedTime, runMetrics)

測試執行結束報表。

void testRunFailed(FailureDescription failure)

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

void testRunFailed(String failureMessage)

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

void testRunStarted(String name, int numTests, int attemptNumber, long startTime)

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

公用建構函式

ShardListener

public ShardListener (ITestInvocationListener main)

建立 ShardListener。

參數
main ITestInvocationListener：應轉送結果的 ITestInvocationListener。為了防止 與其他 ShardListener 衝突，這個物件會在 轉送結果時為 main。而且只有在 讀取及寫入資料。

公用方法

getUnderlyingResultReporter

public  getUnderlyingResultReporter ()

傳回

已叫用

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 invocationSkipped (SkipReason reason)

將叫用回報為略過

參數
reason SkipReason

叫用

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

setSupportGranularResults

public void setSupportGranularResults (boolean enableGranularResults)

參數
enableGranularResults boolean

支援 GranularResults

public boolean supportGranularResults ()

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

傳回
boolean

測試記錄

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

testLog 已儲存

public void testLogSaved (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream, 
                LogFile logFile)

參數
dataName String

dataType LogDataType

dataStream InputStreamSource

logFile LogFile

testModuleEnded

public void testModuleEnded ()

回報模組的執行完畢。

testModuleStarted

public void testModuleStarted (IInvocationContext moduleContext)

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

參數
moduleContext IInvocationContext：模組的 IInvocationContext。

testRunEnded

public void testRunEnded (long elapsedTime, 
                 runMetrics)

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

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

testRunFailed

public void testRunFailed (FailureDescription failure)

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

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

testRunFailed

public void testRunFailed (String failureMessage)

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

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

testRunStarted

public void testRunStarted (String name, 
                int numTests, 
                int attemptNumber, 
                long startTime)

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

參數
name String：測試執行作業名稱
numTests int：測試執行作業中的測試總數
attemptNumber int：訂單號碼，可識別同一個 runName 的不同嘗試次數 執行多次tryNumber 為 0 的索引，且每次傳回 新的工作也會開始執行例如：執行精細的重試次數為 3 次，總共應執行 4 次測試 同一個 runName，且 tryNumber 介於 0 到 3 之間。
startTime long：執行作業開始的時間，透過 System.currentTimeMillis() 測量