BaseDeviceMetricCollector

public class BaseDeviceMetricCollector
extends Object implements IDeviceActionReceiver, IMetricCollector

java.lang.Object
   ↳ com.android.tradefed.device.metric.BaseDeviceMetricCollector


IMetricCollector 的基础实现,允许在 onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData)ERROR(/#onTestRunEnd(com.android.tradefed.device.metric.DeviceMetricData,Map)) 上启动和停止收集。

摘要

字段

public static final String TEST_CASE_EXCLUDE_GROUP_OPTION

public static final String TEST_CASE_INCLUDE_GROUP_OPTION

公共构造函数

BaseDeviceMetricCollector()

公共方法

void extraInit(IInvocationContext context, ITestInvocationListener listener)
final getBuildInfos()

返回调用中可用的 build 信息列表。

final getDevices()

返回调用中可用的设备列表。

File getFileFromTestArtifacts(String fileName)

从测试工件或模块工件中检索文件,并将其缓存在映射中以供后续调用。

final ITestInvocationListener getInvocationListener()

返回我们要将结果转发到的原始 ITestInvocationListener

String getModuleName()
final getRealDevices()

返回 getDevices() 列表中的所有非桩设备。

String getRunName()

返回触发收集器的测试运行 mRunName 的名称。

final ITestInvocationListener init(IInvocationContext context, ITestInvocationListener listener)

使用当前上下文初始化收集器,以及将结果转发到的目的地。

final void invocationEnded(long elapsedTime)

报告调用已终止,无论是成功终止还是因某种错误条件而终止。

final void invocationFailed(FailureDescription failure)

由于某些错误条件,报告调用不完整。

final void invocationFailed(Throwable cause)

报告由于某种错误情况而未完成的调用。

void invocationSkipped(SkipReason reason)

将调用报告为跳过

final void invocationStarted(IInvocationContext context)

用于转发的调用监听器

final boolean isDisabled()

如果整个对象已停用(同时跳过设置和拆解),则返回 true。

boolean isDisabledReceiver()

IDeviceActionReceiver 是否已停用。

final void logAssociation(String dataName, LogFile logFile)

请勿在指标收集器实现中使用。

void onTestAssumptionFailure(DeviceMetricData testData, TestDescription test)

在测试用例因假设失败而失败时的回调。

void onTestEnd(DeviceMetricData testData, currentTestCaseMetrics, TestDescription test)

测试用例结束时的回调。

void onTestEnd(DeviceMetricData testData, currentTestCaseMetrics)

测试用例结束时的回调。

void onTestFail(DeviceMetricData testData, TestDescription test)

测试用例失败时的回调。

void onTestModuleEnded()

允许捕获模块结束事件。

void onTestModuleStarted()

允许捕获模块启动事件。

void onTestRunEnd(DeviceMetricData runData, currentRunMetrics)

测试运行结束时的回调。

void onTestRunFailed(DeviceMetricData testData, FailureDescription failure)

testRunFailed 事件的回调

void onTestRunStart(DeviceMetricData runData)

测试运行开始时的回调。

void onTestStart(DeviceMetricData testData)

启动测试用例时的回调。

void rebootEnded(ITestDevice device)

在设备中重启结束时接收通知。

void rebootStarted(ITestDevice device)

在设备中开始重新启动时接收通知。

final void setDisable(boolean isDisabled)

设置是否应停用对象。

void setDisableReceiver(boolean isDisabled)

设置是否应停用 IDeviceActionReceiver

final void setLogSaver(ILogSaver logSaver)

请勿在指标收集器实现内部使用。

final void testAssumptionFailure(TestDescription test, String trace)

当原子测试标记为假的假设条件时调用

final void testAssumptionFailure(TestDescription test, FailureDescription failure)

当原子测试标记为假的假设条件时调用

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

ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) 的替代方案,我们可以直接指定结束时间。

final void testEnded(TestDescription test, testMetrics)

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

final void testFailed(TestDescription test, FailureDescription failure)

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

final void testFailed(TestDescription test, String trace)

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

final void testIgnored(TestDescription test)

当测试不会运行时调用,通常是因为测试方法带有 org.junit.Ignore 注解。

final void testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)

提供测试调用中的关联日志或调试数据。

final void testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)

请勿在指标收集器实现内部使用。

final void testModuleEnded()

报告模块运行结束。

final void testModuleStarted(IInvocationContext moduleContext)

报告正在运行的模块的开头。

final void testRunEnded(long elapsedTime, runMetrics)

报告测试运行结束。

final void testRunFailed(FailureDescription failure)

由于 FailureDescription 所述的失败,报告测试运行未能完成。

final void testRunFailed(String errorMessage)

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

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

报告测试运行的开始。

final void testRunStarted(String runName, int testCount)

测试运行回调

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

报告测试运行的开始。

final void testRunStopped(long elapsedTime)

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

final void testSkipped(TestDescription test, SkipReason reason)

当测试因通常不预期的某种原因而被跳过且未执行时调用。

final void testStarted(TestDescription test, long startTime)

testStarted(com.android.tradefed.result.TestDescription) 的替代方案,我们还会在其中指定测试的开始时间,并将其与 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) 结合使用以进行准确衡量。

final void testStarted(TestDescription test)

测试用例回调

字段

TEST_CASE_EXCLUDE_GROUP_OPTION

public static final String TEST_CASE_EXCLUDE_GROUP_OPTION

TEST_CASE_INCLUDE_GROUP_OPTION

public static final String TEST_CASE_INCLUDE_GROUP_OPTION

公共构造函数

BaseDeviceMetricCollector

public BaseDeviceMetricCollector ()

公共方法

extraInit

public void extraInit (IInvocationContext context, 
                ITestInvocationListener listener)

抛出
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getBuildInfos

public final  getBuildInfos ()

返回调用中可用的 build 信息列表。

返回

getDevices

public final  getDevices ()

返回调用中可用的设备列表。

返回

getFileFromTestArtifacts

public File getFileFromTestArtifacts (String fileName)

从测试工件或模块工件中检索文件,并将其缓存在映射中,以供后续调用使用。

参数
fileName String:要在工件中查找的文件的名称。

返回
File 测试工件或模块工件中的文件。如果未找到文件,则返回 null。

getInvocationListener

public final ITestInvocationListener getInvocationListener ()

返回我们要将结果转发到的原始 ITestInvocationListener

返回
ITestInvocationListener

getModuleName

public String getModuleName ()

返回
String

getRealDevices

public final  getRealDevices ()

返回 getDevices() 列表中的所有非桩设备。

返回

getRunName

public String getRunName ()

返回触发收集器的测试运行 mRunName 的名称。

返回
String mRunName,当前的测试运行名称。

init

public final ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

使用当前上下文初始化收集器,以及将结果转发到的目的地。每个实例只会调用一次,并且收集器应更新其内部上下文和监听器。之前,测试运行期间永远不会调用 init。

除非您知道自己在做什么,否则请勿替换。

参数
context IInvocationContext:正在进行的调用的 IInvocationContext

listener ITestInvocationListener:用于放置结果的 ITestInvocationListener

返回
ITestInvocationListener 封装原始监听器的新监听器。

抛出
DeviceNotAvailableException

invocationEnded

public final void invocationEnded (long elapsedTime)

报告调用已终止,无论是成功终止还是因某种错误条件而终止。

将由 TradeFederation 框架自动调用。

参数
elapsedTime long:调用的经过时间(以毫秒为单位)

invocationFailed

public final void invocationFailed (FailureDescription failure)

由于某些错误条件,报告调用不完整。

将由 TradeFederation 框架自动调用。

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

invocationFailed

public final void invocationFailed (Throwable cause)

由于某些错误条件,报告调用不完整。

将由 TradeFederation 框架自动调用。

参数
cause Throwable:失败的 Throwable 原因

invocationSkipped

public void invocationSkipped (SkipReason reason)

将调用报告为跳过

参数
reason SkipReason

invocationStarted

public final void invocationStarted (IInvocationContext context)

用于转发的调用监听器

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

已停用

public final boolean isDisabled ()

如果整个对象已停用(同时跳过设置和拆解),则返回 true。否则为 false。

返回
boolean

isDisabledReceiver

public boolean isDisabledReceiver ()

IDeviceActionReceiver 是否已停用。

返回
boolean 如果已停用,则返回 true;否则返回 false。

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

请勿在指标收集器实现中使用。这是一种纯转发。

参数
dataName String:数据的名称

logFile LogFile:之前记录的 LogFile,应与测试用例相关联。

onTestAssumptionFailure

public void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

当测试用例因假设失败而失败时,系统会调用此回调。

参数
testData DeviceMetricData:用于存储测试用例数据的 DeviceMetricData

test TestDescription:正在进行的测试用例的 TestDescription

抛出
DeviceNotAvailableException

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics, 
                TestDescription test)

测试用例结束时的回调。现在应该是清理时间了。

参数
testData DeviceMetricData:用于保存测试用例数据的 DeviceMetricData。将与 onTestStart(com.android.tradefed.device.metric.DeviceMetricData) 期间相同的对象。

currentTestCaseMetrics :传递给 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) 的指标的当前映射。

test TestDescription:正在进行的测试用例的 TestDescription

抛出
DeviceNotAvailableException

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics)

测试用例结束时的回调。现在应该是清理时间了。

参数
testData DeviceMetricData:用于存储测试用例数据的 DeviceMetricData。将与 onTestStart(com.android.tradefed.device.metric.DeviceMetricData) 期间相同的对象。

currentTestCaseMetrics :传递给 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) 的指标的当前映射。

抛出
DeviceNotAvailableException

onTestFail

public void onTestFail (DeviceMetricData testData, 
                TestDescription test)

测试用例失败时的回调。

参数
testData DeviceMetricData:用于保存测试用例数据的 DeviceMetricData

test TestDescription:正在进行的测试用例的 TestDescription

抛出
DeviceNotAvailableException

onTestModuleEnded

public void onTestModuleEnded ()

允许捕获“模块已结束”事件。

抛出
DeviceNotAvailableException

onTestModuleStarted

public void onTestModuleStarted ()

允许捕获模块启动事件。

抛出
DeviceNotAvailableException

onTestRunEnd

public void onTestRunEnd (DeviceMetricData runData, 
                 currentRunMetrics)

测试运行结束时的回调。这时应该进行清理。

参数
runData DeviceMetricData:用于存储运行数据的 DeviceMetricData。将与 onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData) 期间相同的对象。

currentRunMetrics :传递给 ERROR(/#testRunEnded(long,Map)) 的指标的当前映射。

抛出
DeviceNotAvailableException

onTestRunFailed

public void onTestRunFailed (DeviceMetricData testData, 
                FailureDescription failure)

testRunFailed 事件的回调

抛出
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestRunStart

public void onTestRunStart (DeviceMetricData runData)

测试运行开始时的回调。

参数
runData DeviceMetricData:用于存储运行数据的 DeviceMetricData

抛出
DeviceNotAvailableException

onTestStart

public void onTestStart (DeviceMetricData testData)

测试用例启动时的回调。

参数
testData DeviceMetricData:用于存储测试用例数据的 DeviceMetricData

抛出
DeviceNotAvailableException

已重新启动

public void rebootEnded (ITestDevice device)

在设备中重启结束时接收通知。

注意:接收器应避免在此回调期间重新启动。系统会忽略任何重新启动尝试。

参数
device ITestDevice:重新启动结束时的 ITestDevice

抛出
DeviceNotAvailableException

rebootStarted

public void rebootStarted (ITestDevice device)

在设备中开始重新启动时接收通知。

注意:接收器应避免在此回调期间重新启动。系统将忽略任何重新启动尝试。

参数
device ITestDevice:重新启动的起始位置的 ITestDevice

抛出
DeviceNotAvailableException

设置停用

public final void setDisable (boolean isDisabled)

设置是否应停用对象。停用表示应跳过设置和拆解步骤。可用于在默认构造函数中默认停用对象。

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

setDisableReceiver

public void setDisableReceiver (boolean isDisabled)

设置是否应停用 IDeviceActionReceiver。停用后,设备将不会注册该访问权限级别来接收设备操作事件。

参数
isDisabled boolean

setLogSaver

public final void setLogSaver (ILogSaver logSaver)

请勿在指标收集器实现内部使用。这纯粹是转发。

参数
logSaver ILogSaverILogSaver

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                String trace)

当原子测试标记为假的假设条件时调用

参数
test TestDescription:用于标识测试

trace String:失败的堆栈轨迹

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

当原子测试标记为假的假设条件时调用

参数
test TestDescription:用于标识测试

failure FailureDescription:描述失败情况及其上下文的 FailureDescription

testEnded

public final 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 final void testEnded (TestDescription test, 
                 testMetrics)

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

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

参数
test TestDescription:用于标识测试

testMetrics :发出的指标的 ERROR(/Map)

testFailed

public final void testFailed (TestDescription test, 
                FailureDescription failure)

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

将在 testStarted 和 testEnded 之间调用。

参数
test TestDescription:用于标识测试

failure FailureDescription:描述失败情况及其上下文的 FailureDescription

testFailed

public final void testFailed (TestDescription test, 
                String trace)

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

将在 testStarted 和 testEnded 之间调用。

参数
test TestDescription:用于标识测试

trace String:失败的堆栈轨迹

testIgnored

public final void testIgnored (TestDescription test)

当测试不会运行时调用,通常是因为测试方法带有 org.junit.Ignore 注解。

参数
test TestDescription:标识测试

testLog

public final 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 final void testLogSaved (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream, 
                LogFile logFile)

请勿在指标收集器实现中使用。这是一种纯转发。

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

dataType LogDataType:数据的 LogDataType

dataStream InputStreamSource:数据的 InputStreamSource。实现人员应调用 createInputStream 以开始读取数据,并确保在完成后关闭生成的 InputStream。

logFile LogFile:包含已保存文件的元数据的 LogFile

testModuleEnded

public final void testModuleEnded ()

报告模块运行结束。

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

报告正在运行的模块的开始。此回调与 testModuleEnded() 相关联,在序列中是可选的。它仅在使用模块(基于套件的运行程序)的运行期间使用。

参数
moduleContext IInvocationContext:模块的 IInvocationContext

testRunEnded

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

报告测试运行结束。

参数
elapsedTime long:设备报告的所用时间(以毫秒为单位)

runMetrics :在测试运行结束时报告的键值对

testRunFailed

public final void testRunFailed (FailureDescription failure)

由于 FailureDescription 所述的失败,报告测试运行未能完成。

参数
failure FailureDescription:描述失败及其上下文的 FailureDescription

testRunFailed

public final void testRunFailed (String errorMessage)

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

参数
errorMessage StringString,用于说明运行失败的原因。

testRunStarted

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

报告测试运行的开始。

参数
runName String:测试运行名称

testCount int:测试运行中的测试总数

attemptNumber int:顺序号,用于标识多次运行同一 runName 的不同尝试。attemptNumber 从 0 开始编号,每次有新的运行时都应递增。例如,如果某个测试进行了 3 次精细重试,则它在同一 runName 下总共应有 4 次运行,并且 attemptNumber 应介于 0 到 3 之间。

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

测试运行回调

参数
runName String:测试运行名称

testCount int:测试运行中的测试总数

testRunStarted

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

报告测试运行的开始。

参数
runName String:测试运行名称

testCount int:测试运行中的测试总数

attemptNumber int:顺序号,用于标识多次运行同一 runName 的不同尝试。attemptNumber 从 0 开始编号,每次有新的运行时都应递增。例如,如果某个测试进行了 3 次精细重试,则它在同一 runName 下总共应有 4 次运行,并且 attemptNumber 应介于 0 到 3 之间。

startTime long:运行开始时间,通过 System.currentTimeMillis() 衡量

testRunStopped

public final void testRunStopped (long elapsedTime)

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

TODO:目前未使用,考虑移除

参数
elapsedTime long:设备报告的经过时间(以毫秒为单位)

testSkipped(已跳过测试)

public final void testSkipped (TestDescription test, 
                SkipReason reason)

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

参数
test TestDescription:用于标识测试

reason SkipReasonSkipReason

testStarted

public final 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 final void testStarted (TestDescription test)

测试用例回调

参数
test TestDescription:标识测试