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, HashMap<String, MetricMeasurement.Metric> 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, HashMap<String, MetricMeasurement.Metric> runMetrics)

报告测试运行结束。

void testRunFailed(String errorMessage)

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

void testRunStarted(String runName, int testCount)

报告测试运行的开始。

void testRunStopped(long elapsedTime)

报告测试运行因用户请求而在完成前停止。

void testStarted(TestDescription test)

报告单个测试用例的开始。

受保护的方法

TestDescription mangleTestId(TestDescription test)

此方法会在传递给 testStarted(TestDescription)testFailed(TestDescription,String)testEnded(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, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

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

如果未调用 testFailed(TestDescription, FailureDescription),则此测试通过。还会返回测试用例执行期间可能发出的任何键值指标。

参数
test TestDescription:标识测试

testMetrics HashMap:所发出指标的 Map

testFailed

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)/ITestInvocationListener#invocationFailed(java.lang.Throwable) ITestInvocationListener.invocationFailed(Throwable))ERROR(/ITestInvocationListener#invocationEnded(long)) 之前调用

TradeFederation 框架会自动调用此方法,并提供主机日志和设备 logcat(如果适用)。

参数
dataName String:数据的描述性名称。例如“device_logcat”。String注意:dataName 在每次调用时可能不是唯一的。也就是说,实现者必须能够处理具有相同 dataName 的多次调用

dataType LogDataType:数据的 LogDataType

dataStream InputStreamSource:数据的 InputStreamSource。实现者应调用 createInputStream 开始读取数据,并确保在完成后关闭生成的 InputStream。调用方应确保数据源在 testLog 方法完成之前保持存在且可访问。

testRunEnded

public void testRunEnded (long elapsedTime, 
                HashMap<String, MetricMeasurement.Metric> runMetrics)

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

参数
elapsedTime long:设备报告的已用时间,以毫秒为单位

runMetrics HashMap:在测试运行结束时通过 Metric 报告的键值对。

testRunFailed

public void testRunFailed (String errorMessage)

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

参数
errorMessage StringString,用于描述运行失败的原因。

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(TestDescription)

参数
test TestDescription:标识测试

受保护的方法

mangleTestId

protected TestDescription mangleTestId (TestDescription test)

此方法会在传递给 testStarted(TestDescription)testFailed(TestDescription,String)testEnded(TestDescription,HashMap) 回调的所有 TestDescription 上运行。该方法应返回一个可能不同的 TestDescription,该 TestDescription 将传递给在构建期间指定的下游 ITestInvocationListener

实现时应注意不要修改原始 TestDescription

默认实现会未经修改地传递传入的标识符。

参数
test TestDescription

返回
TestDescription

mangleTestRunName

protected String mangleTestRunName (String name)

此方法针对传递给 testRunStarted(String,int) 回调的所有测试运行名称运行。该方法应返回一个可能不同的测试运行名称,该名称将传递给在构建期间指定的下游 ITestInvocationListener

实现应注意不要修改原始运行名称。

默认实现会原封不动地传递传入的测试运行名称。

参数
name String

返回值
String