BaseDeviceMetricCollector

public class BaseDeviceMetricCollector
extends Object implements IDeviceActionReceiver, IMetricCollector

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


IMetricCollector 的基本实现,允许在 onTestRunStart(DeviceMetricData)onTestRunEnd(DeviceMetricData,Map) 上开始和停止收集。

摘要

常量

String TEST_CASE_EXCLUDE_GROUP_OPTION

String TEST_CASE_INCLUDE_GROUP_OPTION

公共构造函数

BaseDeviceMetricCollector()

公共方法

boolean doesModuleContainFailure()

如果当前模块包含任何测试用例或测试运行失败,则返回 true。

void enableDefaultMetricCollection()

允许收集器启用默认指标收集。

void extraInit(IInvocationContext context, ITestInvocationListener listener)
IMetricCollector.MetricCollectionLevel getAlwaysOnCollectionLevel()
final List<IBuildInfo> getBuildInfos()

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

final List<ITestDevice> getDevices()

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

File getFileFromTestArtifacts(String fileName)

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

final ITestInvocationListener getInvocationListener()

返回转发结果的原始 ITestInvocationListener

String getModuleName()
IMetricCollector.MetricCollectionLevel getOnFailureCollectionLevel()
final List<ITestDevice> getRealDevices()

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

String getRunName()

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

String getTestName()

返回触发收集器的测试 mTestName 的名称。

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)

用于转发的调用监听器

boolean isDefaultMetricCollectionEnabled()

收集器是否正在收集指标(作为默认指标收集的一部分)。

final boolean isDisabled()

如果整个对象都被停用(跳过设置和拆解),则返回 True。

boolean isDisabledReceiver()

IDeviceActionReceiver 是否处于停用状态。

final void logAssociation(String dataName, LogFile logFile)

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

void onTestAssumptionFailure(DeviceMetricData testData, TestDescription test)

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

void onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)

测试用例结束时的回调。

void onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, TestDescription test)

测试用例结束时的回调。

void onTestFail(DeviceMetricData testData, TestDescription test)

测试用例失败时的回调。

void onTestModuleEnded()

允许捕获模块结束事件。

void onTestModuleStarted()

允许捕获模块启动事件。

void onTestRunEnd(DeviceMetricData runData, Map<String, MetricMeasurement.Metric> currentRunMetrics)

测试运行结束时的回调。

void onTestRunFailed(DeviceMetricData testData, FailureDescription failure)

针对 testRunFailed 事件的回调

void onTestRunStart(DeviceMetricData runData)

测试运行开始时的回调。

void onTestStart(DeviceMetricData testData)

测试用例开始时的回调。

void rebootEnded(ITestDevice device)

在设备重启完成时收到通知。

void rebootStarted(ITestDevice device)

在设备重启开始时收到通知。

void setAlwaysOnCollectionLevel(IMetricCollector.MetricCollectionLevel level)

设置收集器应收集日志的级别,无论是否发生故障。

final void setDisable(boolean isDisabled)

设置是否应停用对象。

void setDisableReceiver(boolean isDisabled)

设置是否应停用 IDeviceActionReceiver

final void setLogSaver(ILogSaver logSaver)

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

void setModuleContainsFailure()

设置模块是否出现任何失败(测试用例、测试运行)。

void setOnFailureCollectionLevel(IMetricCollector.MetricCollectionLevel level)

设置收集器在发生故障时应收集日志的级别。

final void testAssumptionFailure(TestDescription test, String trace)

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

final void testAssumptionFailure(TestDescription test, FailureDescription failure)

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

final void testEnded(TestDescription test, long endTime, HashMap<String, MetricMeasurement.Metric> testMetrics)

testEnded(TestDescription,Map) 的替代方案,可直接指定结束时间。

final void testEnded(TestDescription test, HashMap<String, MetricMeasurement.Metric> 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, HashMap<String, MetricMeasurement.Metric> 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(TestDescription) 的替代方案,其中还指定了测试开始时间,并与 testEnded(TestDescription,long,Map) 结合使用以实现精确衡量。

final void testStarted(TestDescription test)

测试用例回调

常量

TEST_CASE_EXCLUDE_GROUP_OPTION

public static final String TEST_CASE_EXCLUDE_GROUP_OPTION

常量值: "test-case-exclude-group"

TEST_CASE_INCLUDE_GROUP_OPTION

public static final String TEST_CASE_INCLUDE_GROUP_OPTION

常量值: "test-case-include-group"

公共构造函数

BaseDeviceMetricCollector

public BaseDeviceMetricCollector ()

公共方法

doesModuleContainFailure

public boolean doesModuleContainFailure ()

如果当前模块包含任何测试用例或测试运行失败,则返回 true。

返回
boolean

enableDefaultMetricCollection

public void enableDefaultMetricCollection ()

允许收集器启用默认指标收集。启用默认指标收集功能后,收集器应仅在指定的收集级别进行收集。

extraInit

public void extraInit (IInvocationContext context, 
                ITestInvocationListener listener)

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

getAlwaysOnCollectionLevel

public IMetricCollector.MetricCollectionLevel getAlwaysOnCollectionLevel ()

返回
IMetricCollector.MetricCollectionLevel

getBuildInfos

public final List<IBuildInfo> getBuildInfos ()

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

返回
List<IBuildInfo>

getDevices

public final List<ITestDevice> getDevices ()

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

返回
List<ITestDevice>

getFileFromTestArtifacts

public File getFileFromTestArtifacts (String fileName)

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

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

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

getInvocationListener

public final ITestInvocationListener getInvocationListener ()

返回转发结果的原始 ITestInvocationListener

返回
ITestInvocationListener

getModuleName

public String getModuleName ()

返回
String

getOnFailureCollectionLevel

public IMetricCollector.MetricCollectionLevel getOnFailureCollectionLevel ()

返回
IMetricCollector.MetricCollectionLevel

getRealDevices

public final List<ITestDevice> getRealDevices ()

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

返回
List<ITestDevice>

getRunName

public String getRunName ()

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

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

getTestName

public String getTestName ()

返回触发收集器的测试 mTestName 的名称。

返回
String mTestName,当前测试名称。

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:有关调用的信息

isDefaultMetricCollectionEnabled

public boolean isDefaultMetricCollectionEnabled ()

收集器是否正在收集指标(作为默认指标收集的一部分)。

返回
boolean

isDisabled

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, 
                Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)

测试用例结束时的回调。此时应执行清理操作。

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

currentTestCaseMetrics Map:传递给 testEnded(TestDescription,Map) 的当前指标映射。

抛出
DeviceNotAvailableException

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, 
                TestDescription test)

测试用例结束时的回调。此时应执行清理操作。

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

currentTestCaseMetrics Map:传递给 testEnded(TestDescription,Map) 的当前指标映射。

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

抛出
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, 
                Map<String, MetricMeasurement.Metric> currentRunMetrics)

测试运行结束时的回调。此时应执行清理操作。

参数
runData DeviceMetricData:用于保存运行数据的 DeviceMetricData。将与 onTestRunStart(DeviceMetricData) 期间的对象相同。

currentRunMetrics Map:传递给 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

rebootEnded

public void rebootEnded (ITestDevice device)

在设备重启完成时收到通知。

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

参数
device ITestDevice:已完成重启的 ITestDevice

抛出
DeviceNotAvailableException

rebootStarted

public void rebootStarted (ITestDevice device)

在设备重启开始时收到通知。

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

参数
device ITestDevice:已开始重启的 ITestDevice

抛出
DeviceNotAvailableException

setAlwaysOnCollectionLevel

public void setAlwaysOnCollectionLevel (IMetricCollector.MetricCollectionLevel level)

设置收集器应收集日志的级别,无论是否发生故障。

如果级别为 NULL,则不会收集任何数据。

参数
level IMetricCollector.MetricCollectionLevel:将收集日志的MetricCollectionLevel

setDisable

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

setModuleContainsFailure

public void setModuleContainsFailure ()

设置模块是否出现任何失败(测试用例、测试运行)。

setOnFailureCollectionLevel

public void setOnFailureCollectionLevel (IMetricCollector.MetricCollectionLevel level)

设置收集器在发生故障时应收集日志的级别。

如果级别为 NULL,则不会收集任何数据。

参数
level IMetricCollector.MetricCollectionLevel:将收集日志的MetricCollectionLevel

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                String trace)

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

参数
test TestDescription:标识测试

trace String:失败的堆栈轨迹

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

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

参数
test TestDescription:标识测试

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

testEnded

public final void testEnded (TestDescription test, 
                long endTime, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

testEnded(TestDescription,Map) 的替代方案,可直接指定结束时间。与 testStarted(TestDescription,long) 结合使用,可实现精确衡量。

参数
test TestDescription:标识测试

endTime long:测试结束时间,通过 System.currentTimeMillis() 测量

testMetrics HashMap:所发出指标的 Map

testEnded

public final void testEnded (TestDescription test, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

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

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

参数
test TestDescription:标识测试

testMetrics HashMap:所发出指标的 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)/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 方法完成之前保持存在且可访问。

testLogSaved

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

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

参数
dataName String:数据的描述性名称。例如“device_logcat”。String注意: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, 
                HashMap<String, MetricMeasurement.Metric> runMetrics)

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

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

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

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(TestDescription) 的替代方案,我们还指定了测试开始时间,并与 testEnded(TestDescription,long,Map) 结合使用以实现精确衡量。

参数
test TestDescription:标识测试

startTime long:测试开始时间,通过 System.currentTimeMillis() 测量

testStarted

public final void testStarted (TestDescription test)

测试用例回调

参数
test TestDescription:标识测试