分片監聽器

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

公共方法

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

報告測試運行結束。

void testRunFailed ( FailureDescription failure)

由於FailureDescription描述的失敗,報告測試運行未能完成。

void testRunFailed (String failureMessage)

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

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

報告測試運行的開始。

公共構造函數

分片監聽器

public ShardListener (ITestInvocationListener main)

創建一個ShardListener

參數
main ITestInvocationListener : ITestInvocationListener結果應該被轉發。為了防止與其他ShardListener發生衝突,該對像在轉發結果時將在main上同步。並且只有在調用分片完成後才會發送結果。

公共方法

調用結束

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

setSupportGranularResults

public void setSupportGranularResults (boolean enableGranularResults)

參數
enableGranularResults boolean

支持粒度結果

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 每次調用可能不是唯一的。即實現者必須能夠處理具有相同數據名稱的多個調用

dataType LogDataType : 數據的LogDataType

dataStream InputStreamSource :數據的InputStreamSource 。實現者應調用 createInputStream 開始讀取數據,並確保在完成後關閉生成的 InputStream。調用者應確保數據源保持存在並可訪問,直到 testLog 方法完成。

測試日誌已保存

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

參數
dataName String

dataType LogDataType

dataStream InputStreamSource

logFile LogFile

測試模塊結束

public void testModuleEnded ()

報告模塊運行的結束。

testModuleStarted

public void testModuleStarted (IInvocationContext moduleContext)

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

參數
moduleContext IInvocationContext :模塊的IInvocationContext

測試運行結束

public void testRunEnded (long elapsedTime, 
                 runMetrics)

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

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

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

測試運行失敗

public void testRunFailed (FailureDescription failure)

由於FailureDescription描述的失敗,報告測試運行未能完成。

參數
failure FailureDescriptionFailureDescription描述失敗及其上下文。

測試運行失敗

public void testRunFailed (String failureMessage)

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

參數
failureMessage String :描述運行失敗原因的String

測試運行開始

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

報告測試運行的開始。

參數
name String : 測試運行名稱

numTests int :測試運行中的測試總數

attemptNumber int :訂單號,標識同一 runName 多次運行的不同嘗試。 attemptNumber 是 0-indexed 並且應該在每次新的運行發生時遞增。例如,一個測試是粒度重試 3 次,它應該在相同的 runName 下總共運行 4 次,並且嘗試編號是從 0 到 3。

startTime long :運行開始的時間,通過System.currentTimeMillis()測量