NameMangleListener

public abstract class NameMangleListener
extends Object implements ITestInvocationListener

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

---

一个代理监听器，用于在报告结果时转换测试方法、类和软件包名称。

摘要

公共构造函数
NameMangleListener(ITestInvocationListener listener)

公共方法
TestSummary	getSummary() 允许 InvocationListener 返回摘要。
void	invocationEnded(long elapsedTime) 报告调用已终止（无论是成功终止还是由于某些错误） 条件。
void	invocationFailed(Throwable cause) 由于某些错误情况，报告不完整的调用。
void	invocationStarted(IInvocationContext context) 报告测试调用的开始。
void	testAssumptionFailure(TestDescription test, String trace) 在原子测试标记它假设条件为 false 时调用
void	testEnded(TestDescription test, testMetrics) 报告单个测试用例的执行结束。
void	testFailed(TestDescription test, String trace) 报告单个测试用例的失败情况。
void	testIgnored(TestDescription test) 在不会运行测试时调用，通常是因为测试方法带有 org.junit.Ignore。
void	testLog(String dataName, LogDataType dataType, InputStreamSource dataStream) 提供来自测试调用的关联日志或调试数据。
void	testRunEnded(long elapsedTime, runMetrics) 报告测试运行结束。
void	testRunFailed(String errorMessage) 由于出现严重错误，未能完成报告测试运行。
void	testRunStarted(String runName, int testCount) 报告测试运行开始。
void	testRunStopped(long elapsedTime) 由于用户请求，报告测试运行在完成之前停止。
void	testStarted(TestDescription test) 报告单个测试用例的开始。

受保护的方法
TestDescription	mangleTestId(TestDescription test) 此方法在已传递给 testStarted(com.android.tradefed.result.TestDescription)、testFailed(com.android.tradefed.result.TestDescription, String) 和 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,HashMap)) 回调的所有 TestDescription 上运行。
String	mangleTestRunName(String name) 此方法会针对传递给 testRunStarted(String, int) 回调。

公共构造函数

NameMangleListener

public NameMangleListener (ITestInvocationListener listener)

参数
listener	ITestInvocationListener

公共方法

getSummary

public TestSummary getSummary ()

允许 InvocationListener 返回摘要。

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

invocationEnded

public void invocationEnded (long elapsedTime)

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

将由 TradeFederation 框架自动调用。

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

invocationFailed

public void invocationFailed (Throwable cause)

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

将由 TradeFederation 框架自动调用。

参数
cause	Throwable：失败的 Throwable 原因

invocationStarted

public void invocationStarted (IInvocationContext context)

报告测试调用的开始。

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

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

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                String trace)

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

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

testEnded

public void testEnded (TestDescription test, 
                 testMetrics)

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

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

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

测试失败

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

testRunEnded

public void testRunEnded (long elapsedTime, 
                 runMetrics)

报告测试运行结束。FIXME：不能有两个 Map<>具有不同类型的接口 我们在这里必须使用 HashMap。

参数
elapsedTime	long：设备报告的所用时间（以毫秒为单位）
runMetrics	：通过 Metric 运行测试运行结束时报告的键值对。

testRunFailed

public void testRunFailed (String errorMessage)

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

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

testRunStarted

public void testRunStarted (String runName, 
                int testCount)

报告测试运行开始。

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

testRunStopped

public void testRunStopped (long elapsedTime)

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

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

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

testStarted

public void testStarted (TestDescription test)

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

参数
test	TestDescription：标识测试

受保护的方法

mangleTestId

protected TestDescription mangleTestId (TestDescription test)

此方法在已传递给 testStarted(com.android.tradefed.result.TestDescription)、testFailed(com.android.tradefed.result.TestDescription, String) 和 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,HashMap)) 回调的所有 TestDescription 上运行。该方法应返回 TestDescription（将传递给构建过程中指定的下游 ITestInvocationListener）。

实现应小心谨慎，不要修改原始 TestDescription。

默认实现会在未经修改的情况下传递传入的标识符。

参数
test	TestDescription

返回
TestDescription

mangleTestRunName

protected String mangleTestRunName (String name)

此方法会针对传递给 testRunStarted(String, int) 回调。该方法应返回可能不同的 测试运行名称，该名称将传递给之前使用的下游 ITestInvocationListener 。

实现应小心谨慎，不要修改原始运行名称。

默认实现会在未经修改的情况下传递传入的测试运行名称。

参数
name	String

返回
String