分片监听器

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) 报告测试运行开始。

公共构造函数

分片监听器

public ShardListener (ITestInvocationListener main)

创建 ShardListener。

参数
main	ITestInvocationListener：应转发结果的 ITestInvocationListener。为防止 与其他 ShardListener 冲突，此对象将在 转发结果时为 main。而结果仅在 调用分片完成。

公共方法

getUnderlyingResultReporter

public  getUnderlyingResultReporter ()

返回

invocationEnded

public void invocationEnded (long elapsedTime)

报告调用已终止（无论是成功终止还是由于某些错误） 条件。

将由 TradeFederation 框架自动调用。

参数
elapsedTime	long：调用所用的时间（以毫秒为单位）

invocationFailed

public void invocationFailed (FailureDescription failure)

由于某些错误情况，报告不完整的调用。

将由 TradeFederation 框架自动调用。

参数
failure	FailureDescription：描述失败原因的 FailureDescription

invocationFailed

public void invocationFailed (Throwable cause)

由于某种错误情况，报告不完整的调用。

将由 TradeFederation 框架自动调用。

参数
cause	Throwable：失败的 Throwable 原因

已跳过调用

public void invocationSkipped (SkipReason reason)

将调用报告为跳过

参数
reason	SkipReason

invocationStarted

public void invocationStarted (IInvocationContext context)

报告测试调用的开始。

将由 TradeFederation 框架自动调用。报告者需要覆盖 此方法支持多设备报告。

参数
context	IInvocationContext：调用的相关信息

logAssociation

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

supportGranularResults

public boolean supportGranularResults ()

如果报告程序支持精细的结果，则返回 True，否则返回 false。

返回
boolean

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 方法完成为止。

testLogSaved

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() 相关联，在序列中是可选的。它仅在使用 module：基于套件的运行程序。

参数
moduleContext	IInvocationContext：模块的 IInvocationContext。

testRunEnded

public void testRunEnded (long elapsedTime, 
                 runMetrics)

报告测试运行结束。FIXME：不能有两个 Map<>具有不同类型的接口 我们在这里必须使用 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() 测量