CollectingTestListener

public class CollectingTestListener
extends Object implements IDisableable, ILogSaverListener, ITestInvocationListener

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

已知的直接子类 JsonHttpTestResultReporter、LUCIResultReporter、MetricsXMLResultReporter、ModuleListener、ReportPassedTests、ResultAggregator、ShardListener、SuiteResultReporter、XmlResultReporter JsonHttpTestResultReporter 结果报告程序，可将测试结果和分支、设备信息编码为 JSON 和 POST HTTP 服务端点 LUCIResultReporter 一个结果报告程序，用于保存 ResultDB 和 LUCI 所需的测试结果 转换为 JSON 格式 (go/result-sink)，并在控制台中记录文件位置。  MetricsXMLResultReporter MetricsXMLResultReporter 将测试指标和运行指标写入指定文件夹内的 XML 文件中 。  ModuleListener 附加到每个模块的每个 IRemoteTest 的监听器，以便收集 结果。  ReportPassedTests 文件中的报告可能会用来排除已通过测试的过滤条件。  ResultAggregator 根据之前使用的重试策略，根据需要汇总结果的特殊转发器 。  ShardListener（分片监听器） 一个 ITestInvocationListener，用于收集调用分片（也称为 调用拆分以并行运行多个资源），并将其转发到另一个资源 监听器。  SuiteResultReporter 收集整个套件调用的测试结果，并输出最终结果。  XmlResultReporter 以与以下项一致的格式将 JUnit 结果写入 XML 文件 Ant 的 XMLJUnitResultFormatter。

已知的间接子类 FormattedGeneratorReporter、XmlFormattedGeneratorReporter FormattedGeneratorReporter 允许生成特定格式的报告的报告程序。  XmlFormattedGeneratorReporter FormattedGeneratorReporter 的实现，用于为套件结果设置 xml 格式 格式。

---

将收集所有测试结果的 ITestInvocationListener。

尽管此对象中使用的数据结构是线程安全的，但必须按正确的顺序调用 ITestInvocationListener 回调。

摘要

公共构造函数
CollectingTestListener()

公共方法
IBuildInfo	getBuildInfo() <ph type="x-smartling-placeholder"></ph> 此方法已被弃用。 依赖于 getInvocationContext() 中的 IBuildInfo。
TestRunResult	getCurrentRunResults() 获取当前测试运行的结果。
int	getExpectedTests() 返回预期的测试计数。
IInvocationContext	getInvocationContext() 返回通过 invocationStarted(com.android.tradefed.invoker.IInvocationContext) 报告的调用上下文
	getMergedTestRunResults() 返回不同尝试中所有运行的合并结果集合。
IInvocationContext	getModuleContextForRunResult(String testRunName) 返回与结果关联的模块的 IInvocationContext。
MultiMap<String, LogFile>	getModuleLogFiles() 返回地图的副本，其中包含与模块相关联的所有已记录文件
MultiMap<String, LogFile>	getNonAssociatedLogFiles() 返回地图的副本，其中包含未与测试运行或 模块。
int	getNumAllFailedTestRuns() 返回处于失败状态的测试运行总数
int	getNumAllFailedTests() 返回处于失败状态的测试总数（只有失败的测试不会返回， 都计入其中）。
int	getNumTestsInState(TestStatus status) 返回本次运行的处于给定状态的测试数量。
int	getNumTestsInState(TestResult.TestStatus ddmlibStatus) 为了与旧版状态类型兼容
int	getNumTotalTests() 返回所有运行的完整测试总数。
IBuildInfo	getPrimaryBuildInfo() 返回通过 invocationStarted(com.android.tradefed.invoker.IInvocationContext) 报告的主要 build 信息。
	getRunResults() <ph type="x-smartling-placeholder"></ph> 此方法已被弃用。 使用 getMergedTestRunResults()
TestRunResult	getTestRunAtAttempt(String testRunName, int attempt) 针对单次尝试返回 TestRunResult。
int	getTestRunAttemptCount(String testRunName) 返回给定测试运行名称的尝试次数。
	getTestRunAttempts(String testRunName) 获取指定测试运行的 TestRunResult 的所有尝试。
	getTestRunForAttempts(int attempt) 获取指定尝试的所有结果。
	getTestRunNames() 返回所有测试运行的所有名称。
boolean	hasFailedTests() 如果调用有任何失败或假设失败的测试，则返回 。
boolean	hasTestRunResultsForName(String testRunName) 返回给定的测试运行名称是否有任何结果。
void	invocationEnded(long elapsedTime) 报告调用已终止（无论是成功终止还是由于某些错误） 条件。
void	invocationFailed(Throwable cause) 由于某些错误情况，报告不完整的调用。
void	invocationSkipped(SkipReason reason) 将调用报告为跳过
void	invocationStarted(IInvocationContext context) 报告测试调用的开始。
boolean	isDisabled() 如果整个对象都已停用（跳过设置和拆解），则返回 True。
void	logAssociation(String dataName, LogFile logFile) 在某些情况下，日志必须与测试用例密切相关， 以此类推，testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) 回调。
void	setBuildInfo(IBuildInfo buildInfo) <ph type="x-smartling-placeholder"></ph> 此方法已被弃用。 不再需要进行测试。
void	setDisable(boolean isDisabled) 设置是否应停用对象。
void	setMergeStrategy(MergeStrategy strategy) 设置要在合并结果时使用的 MergeStrategy。
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	testModuleEnded() 报告模块运行结束。
void	testModuleStarted(IInvocationContext moduleContext) 报告正在运行的模块的开始。
void	testRunEnded(long elapsedTime, runMetrics) 报告测试运行结束。
void	testRunFailed(FailureDescription failure) 由于“FailureDescription”所述的失败情况，未能完成报告测试运行。
void	testRunFailed(String errorMessage) 由于出现严重错误，未能完成报告测试运行。
void	testRunStarted(String name, int numTests, int attemptNumber) 报告测试运行开始。
void	testRunStarted(String name, int numTests) 报告测试运行开始。
void	testRunStarted(String name, int numTests, 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) 报告单个测试用例的开始。

受保护的方法
final void	clearModuleLogFiles() 允许清理模块文件，以避免长时间使用它们。
final void	clearResultsForName(String testRunName) 允许清除给定运行名称的结果。
void	setIsAggregrateMetrics(boolean aggregate) 切换“汇总指标”选项

公共构造函数

CollectingTestListener

public CollectingTestListener ()

公共方法

getBuildInfo

public IBuildInfo getBuildInfo ()

<ph type="x-smartling-placeholder"></ph> 此方法已废弃。
依赖于 getInvocationContext() 中的 IBuildInfo。

返回构建信息。

返回
IBuildInfo

getCurrentRunResults

public TestRunResult getCurrentRunResults ()

获取当前测试运行的结果。

请注意，结果可能不完整。建议根据需要测试 TestRunResult.isRunComplete() 和/或 (@link TestRunResult#isRunFailure()} 的值 然后再处理结果。

返回
TestRunResult	TestRunResult，表示上次测试运行期间收集的数据

get 预期测试

public int getExpectedTests ()

返回预期的测试计数。如果满足以下条件，则可能与 getNumTotalTests()不同 一些测试没有运行

返回
int

getInvocationContext

public IInvocationContext getInvocationContext ()

返回通过 invocationStarted(com.android.tradefed.invoker.IInvocationContext) 报告的调用上下文

返回
IInvocationContext

getMergedTestRunResults

public  getMergedTestRunResults ()

返回不同尝试中所有运行的合并结果集合。

如果存在多条结果，则每次测试运行都会合并到一起，并包含最新的测试结果 覆盖之前运行的测试结果。测试运行按尝试编号排序。

系统会根据 aggregate-metrics 设置的偏好设置合并同一次尝试的指标。最终指标将是上次尝试的指标。

返回

getModuleContextForRunResult

public IInvocationContext getModuleContextForRunResult (String testRunName)

返回与结果关联的模块的 IInvocationContext。

参数
testRunName	String：{testRunStarted(String, int) 指定的名称。

返回
IInvocationContext	给定测试运行名称 null 的模块的 IInvocationContext 。

getModuleLogFiles

public MultiMap<String, LogFile> getModuleLogFiles ()

返回地图的副本，其中包含与模块相关联的所有已记录文件

返回
MultiMap<String, LogFile>

getNonAssociatedLogFiles

public MultiMap<String, LogFile> getNonAssociatedLogFiles ()

返回地图的副本，其中包含未与测试运行或 模块。

返回
MultiMap<String, LogFile>

getNumAllFailedTestRuns

public int getNumAllFailedTestRuns ()

返回处于失败状态的测试运行总数

返回
int

getNumAllFailedTests

public int getNumAllFailedTests ()

返回处于失败状态的测试总数（只有失败的测试不会返回， 都计入其中）。

返回
int

getNumTestsInState

public int getNumTestsInState (TestStatus status)

返回本次运行的处于给定状态的测试数量。

参数
status	TestStatus

返回
int

getNumTestsInState

public int getNumTestsInState (TestResult.TestStatus ddmlibStatus)

为了与旧版状态类型兼容

参数
ddmlibStatus	TestResult.TestStatus

返回
int

getNumTotalTests

public int getNumTotalTests ()

返回所有运行的完整测试总数。

返回
int

getPrimaryBuildInfo

public IBuildInfo getPrimaryBuildInfo ()

返回通过 invocationStarted(com.android.tradefed.invoker.IInvocationContext) 报告的主要 build 信息。主 build 是指 运行配置的 build 提供程序。如果没有上下文（未构建到 测试用例）。

返回
IBuildInfo

getRunResults

public  getRunResults ()

<ph type="x-smartling-placeholder"></ph> 此方法已废弃。
使用getMergedTestRunResults()

返回所有测试运行的结果。

返回

getTestRunAtAttempt

public TestRunResult getTestRunAtAttempt (String testRunName, 
                int attempt)

针对单次尝试返回 TestRunResult。

参数
testRunName	String：{testRunStarted(String, int) 指定的名称。
attempt	int：尝试 ID。

返回
TestRunResult	指定名称和尝试 ID 对应的 TestRunResult，如果是，则为 null 不存在。

getTestRunAttemptCount

public int getTestRunAttemptCount (String testRunName)

返回给定测试运行名称的尝试次数。

参数
testRunName	String：{testRunStarted(String, int) 指定的名称。

返回
int

getTestRunAttempts

public  getTestRunAttempts (String testRunName)

获取指定测试运行的 TestRunResult 的所有尝试。

参数
testRunName	String：{testRunStarted(String, int) 指定的名称。

返回
	指定测试运行的所有 TestRunResult，按尝试次数排序。

getTestRunForAttempts

public  getTestRunForAttempts (int attempt)

获取指定尝试的所有结果。

参数
attempt	int：我们希望获取结果的尝试。

返回
	指定尝试的所有 TestRunResult。

getTestRunNames

public  getTestRunNames ()

返回所有测试运行的所有名称。

这些测试运行可能已多次运行，但有不同的尝试。

返回

hasFailedTests

public boolean hasFailedTests ()

如果调用有任何失败或假设失败的测试，则返回 。

返回
boolean

hasTestRunResultsForName

public boolean hasTestRunResultsForName (String testRunName)

返回给定的测试运行名称是否有任何结果。

参数
testRunName	String：{testRunStarted(String, int) 指定的名称。

返回
boolean

invocationEnded

public void invocationEnded (long elapsedTime)

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

将由 TradeFederation 框架自动调用。

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

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

已停用

public boolean isDisabled ()

如果整个对象都已停用（跳过设置和拆解），则返回 True。否则为 false。

返回
boolean

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 之前记录，应与 测试用例。

setBuildInfo

public void setBuildInfo (IBuildInfo buildInfo)

<ph type="x-smartling-placeholder"></ph> 此方法已废弃。
不再需要测试。

设置 build 信息。应仅用于测试。

参数
buildInfo	IBuildInfo

设置停用

public void setDisable (boolean isDisabled)

设置是否应停用对象。停用意味着设置和拆解步骤都没有问题 。可用于在默认情况下停用某个对象 构造函数。

参数
isDisabled	boolean：对象应处于的状态。

setMergeStrategy

public void setMergeStrategy (MergeStrategy strategy)

设置要在合并结果时使用的 MergeStrategy。

参数
strategy	MergeStrategy

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：标识测试

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 name, 
                int numTests, 
                int attemptNumber)

报告测试运行开始。

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

testRunStarted

public void testRunStarted (String name, 
                int numTests)

报告测试运行开始。

参数
name	String：测试运行名称
numTests	int：测试运行中的测试总数

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

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：标识测试

受保护的方法

clearModuleLogFiles 文件

protected final void clearModuleLogFiles ()

允许清理模块文件，以避免长时间使用它们。

clearResultsForName

protected final void clearResultsForName (String testRunName)

允许清除给定运行名称的结果。只应在某些情况下使用，例如 结果聚合器。

参数
testRunName	String

setIsAggregrateMetrics

protected void setIsAggregrateMetrics (boolean aggregate)

切换“汇总指标”选项

参数
aggregate	boolean