ResultForwarder

public class ResultForwarder
extends Object implements ITestInvocationListener

java.lang.Object 中
↳	com.android.tradefed.result.ResultForwarder

已知的直接子类 FilteredResultForwarder、JarHostTest.HostTestListener、LogSaverResultForwarder、LogcatCrashResultForwarder、PythonHostTest.PythonForwarder、ResultAndLogForwarder、RetryResultForwarder、ShardMainResultForwarder、 FilteredResultForwarder ResultForwarder 的变体，仅允许将 TestDescription 的许可名单 被举报。  JarHostTest.HostTestListener 一个封装容器监听器，用于将除 testRunStarted() 和 testRunEnded() 之外的所有事件转发给 嵌入式监听器。  LogSaverResultForwarder ResultForwarder，用于通过全局文件保存程序保存日志。  LogcatCrashResultForwarder 特殊监听器：在失败（插桩进程崩溃）时，它会尝试从 logcat，并将其添加到与测试关联的失败消息中。  PythonBinaryHostTest.PythonForwarder 结果转发器，用于将运行名称替换为二进制文件名称。  ResultAndLogForwarder 用于结果和日志事件的转发器。  tryResultForwarder ResultForwarder 的扩展，始终推送到给定尝试编号。  ShardMainResultForwarder 一个 ResultForwarder，用于合并分片测试调用的结果。  TestTimeoutEnforcer 允许检查给定测试用例的执行时间并在成功时失败的监听器 指定超时值

已知的间接子类 GranularRetriableTestWrapper.StartEndCollector、RetryLogSaverResultForwarder GranularRetriableTestWrapper.StartEndCollector 用于捕获缺失的运行开始和结束的类辅助程序。  RetryLogSaverResultForwarder 转发器，也负责传递我们所处的当前尝试。

---

一个 ITestInvocationListener，用于将调用结果转发给一系列其他监听器。

摘要

公共构造函数
ResultForwarder( listeners) 创建 ResultForwarder。
ResultForwarder(ITestInvocationListener... listeners) ResultForwarder 的备用变量参数构造函数。

受保护的构造函数
ResultForwarder() 创建具有延迟监听器设置的 ResultForwarder。

公共方法
TestSummary	getSummary() 允许 InvocationListener 返回摘要。
void	invocationEnded(long elapsedTime) 报告调用已终止（无论是成功终止还是由于某些错误） 条件。
void	invocationFailed(FailureDescription failure) 由于某些错误情况，报告不完整的调用。
void	invocationFailed(Throwable cause) 由于某些错误情况，报告不完整的调用。
void	invocationSkipped(SkipReason reason) 将调用报告为跳过
void	invocationStarted(IInvocationContext context) 报告测试调用的开始。
void	testAssumptionFailure(TestDescription test, String trace) 在原子测试标记它假设条件为 false 时调用
void	testAssumptionFailure(TestDescription test, FailureDescription failure) 在原子测试标记它假设条件为 false 时调用
void	testEnded(TestDescription test, long endTime, testMetrics) ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) 的替代方法，可用于指定结束时间 。
void	testEnded(TestDescription test, testMetrics) 报告单个测试用例的执行结束。
void	testFailed(TestDescription test, FailureDescription failure) 报告单个测试用例的失败情况。
void	testFailed(TestDescription test, String trace) 报告单个测试用例的失败情况。
void	testIgnored(TestDescription test) 在不会运行测试时调用，通常是因为测试方法带有 org.junit.Ignore。
void	testLog(String dataName, LogDataType dataType, InputStreamSource dataStream) 提供来自测试调用的关联日志或调试数据。
void	testModuleEnded() 报告模块运行结束。
void	testModuleStarted(IInvocationContext moduleContext) 报告正在运行的模块的开始。
void	testRunEnded(long elapsedTime, runMetrics) 报告测试运行结束。
void	testRunFailed(FailureDescription failure) 由于“FailureDescription”所述的失败情况，未能完成报告测试运行。
void	testRunFailed(String errorMessage) 由于出现严重错误，未能完成报告测试运行。
void	testRunStarted(String runName, int testCount, int attemptNumber) 报告测试运行开始。
void	testRunStarted(String runName, int testCount) 报告测试运行开始。
void	testRunStarted(String runName, int testCount, int attemptNumber, long startTime) 报告测试运行开始。
void	testRunStopped(long elapsedTime) 由于用户请求，报告测试运行在完成之前停止。
void	testSkipped(TestDescription test, SkipReason reason) 在因通常不符合预期的原因跳过测试且未执行测试时调用。
void	testStarted(TestDescription test, long startTime) testStarted(com.android.tradefed.result.TestDescription) 的替代方法，其中我们还指定了测试 开始，并结合 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) 进行准确测量。
void	testStarted(TestDescription test) 报告单个测试用例的开始。

受保护的方法
	getListeners() 获取监听器列表。
void	setListeners(ITestInvocationListener... listeners) 在构建后设置监听器。
void	setListeners( listeners) 在构建后设置监听器。

公共构造函数

ResultForwarder

public ResultForwarder ( listeners)

创建 ResultForwarder。

参数
listeners	：要向其转发结果的实际 ITestInvocationListener

ResultForwarder

public ResultForwarder (ITestInvocationListener... listeners)

ResultForwarder 的备用变量参数构造函数。

参数
listeners	ITestInvocationListener：要向其转发结果的实际 ITestInvocationListener

受保护的构造函数

ResultForwarder

protected ResultForwarder ()

创建具有延迟监听器设置的 ResultForwarder。仅供以下人员使用： 子类。

公共方法

getSummary

public TestSummary getSummary ()

允许 InvocationListener 返回摘要。

返回
TestSummary	总结运行作业的 TestSummary，或 null

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：调用的相关信息

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                String trace)

在原子测试标记它假设条件为 false 时调用

参数
test	TestDescription：标识测试
trace	String：失败的堆栈轨迹

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

在原子测试标记它假设条件为 false 时调用

参数
test	TestDescription：标识测试
failure	FailureDescription：描述失败情况及其上下文的 FailureDescription。

testEnded

public void testEnded (TestDescription test, 
                long endTime, 
                 testMetrics)

ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) 的替代方法，可用于指定结束时间 。与 testStarted(com.android.tradefed.result.TestDescription, long) 结合使用以实现准确的测量。

参数
test	TestDescription：标识测试
endTime	long：测试结束时间，通过 System.currentTimeMillis() 衡量
testMetrics	：发出的指标的 ERROR(/Map)

testEnded

public void testEnded (TestDescription test, 
                 testMetrics)

报告单个测试用例的执行结束。

如果未调用 testFailed(TestDescription, FailureDescription)，则表示此测试已通过。同时返回任意键/值 可能在测试用例执行期间发出的指标。

参数
test	TestDescription：标识测试
testMetrics	：发出的指标的 ERROR(/Map)

测试失败

public void testFailed (TestDescription test, 
                FailureDescription failure)

报告单个测试用例的失败情况。

将在 testStarted 和 testEnded 之间调用。

参数
test	TestDescription：标识测试
failure	FailureDescription：描述失败情况及其上下文的 FailureDescription。

测试失败

public void testFailed (TestDescription test, 
                String trace)

报告单个测试用例的失败情况。

将在 testStarted 和 testEnded 之间调用。

参数
test	TestDescription：标识测试
trace	String：失败的堆栈轨迹

testIgnored

public void testIgnored (TestDescription test)

在不会运行测试时调用，通常是因为测试方法带有 org.junit.Ignore。

参数
test	TestDescription：标识测试

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

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 errorMessage)

由于出现严重错误，未能完成报告测试运行。

参数
errorMessage	String：String，用于说明运行失败的原因。

testRunStarted

public void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber)

报告测试运行开始。

参数
runName	String：测试运行名称
testCount	int：测试运行中的测试总数
attemptNumber	int：订单号，用于标识同一 runName 的不同尝试 运行多次的命令tryNumber 从 0 开始编号，并且应该每次递增。 都会发生新的运行例如测试会精细地重试 3 次，总共应该有 4 次 以相同的 runName 运行，而 tryNumber 范围为 0 到 3。

testRunStarted

public void testRunStarted (String runName, 
                int testCount)

报告测试运行开始。

参数
runName	String：测试运行名称
testCount	int：测试运行中的测试总数

testRunStarted

public void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

报告测试运行开始。

参数
runName	String：测试运行名称
testCount	int：测试运行中的测试总数
attemptNumber	int：订单号，用于标识同一 runName 的不同尝试 运行多次的命令tryNumber 从 0 开始编号，并且应在每次 都会发生新的运行例如测试会精细地重试 3 次，总共应运行 4 次 在同一 runName 下运行，并且 tryNumber 范围是 0 到 3。
startTime	long：运行开始的时间，通过 System.currentTimeMillis() 测量

testRunStopped

public void testRunStopped (long elapsedTime)

由于用户请求，报告测试运行在完成之前停止。

TODO：目前未使用，请考虑移除

参数
elapsedTime	long：设备报告的所用时间（以毫秒为单位）

testSkipped（已跳过测试）

public void testSkipped (TestDescription test, 
                SkipReason reason)

在因通常不符合预期的原因跳过测试且未执行测试时调用。 系统将尝试重新尝试这些测试，以确保正确执行。

参数
test	TestDescription：标识测试
reason	SkipReason：SkipReason

testStarted

public void testStarted (TestDescription test, 
                long startTime)

testStarted(com.android.tradefed.result.TestDescription) 的替代方法，其中我们还指定了测试 开始，并结合 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) 进行准确测量。

参数
test	TestDescription：标识测试
startTime	long：测试的开始时间，通过 System.currentTimeMillis() 测量

testStarted

public void testStarted (TestDescription test)

报告单个测试用例的开始。旧版接口，应尽可能使用 testStarted(com.android.tradefed.result.TestDescription)。

参数
test	TestDescription：标识测试

受保护的方法

getListeners

protected  getListeners ()

获取监听器列表。仅供子类使用。

返回
	ITestInvocationListener 的列表。

setListeners

protected void setListeners (ITestInvocationListener... listeners)

在构建后设置监听器。仅供子类使用。

参数
listeners	ITestInvocationListener：要向其转发结果的实际 ITestInvocationListener

setListeners

protected void setListeners ( listeners)

在构建后设置监听器。仅供子类使用。

参数
listeners	：要向其转发结果的实际 ITestInvocationListener