分片监听器

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()测量