BaseDeviceMetricCollector

public class BaseDeviceMetricCollector
extends Object implements IMetricCollector

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

已知的直接子类 AtraceCollector , BugreportzOnFailureCollector , BugreportzOnTestCaseFailureCollector , ClangCodeCoverageCollector , CountTestCasesCollector , DebugHostLogOnFailureCollector , DeviceTraceCollector , FilePullerDeviceMetricCollector , GcovCodeCoverageCollector , GcovKernelCodeCoverageCollector , HostStatsdMetricCollector , JavaCodeCoverageCollector , LogcatOnFailureCollector , LogcatTimingMetricCollector , RebootReasonCollector , RuntimeRestartCollector , ScreenshotOnFailureCollector 跟踪收集器 在测试期间运行IMetricCollector并收集结果并将其记录到调用中的 IMetricCollector。 BugreportzOnFailureCollector 当测试用例失败时收集错误报告。 错误报告 zOnTestCaseFailureCollector 当运行中的测试用例失败时收集错误报告。 ClangCodeCoverageCollector 一个BaseDeviceMetricCollector ，它将从设备中提取 Clang 覆盖测量并将它们记录为测试工件。 计数测试用例收集器 计算并报告给定IRemoteTest的测试用例数。 DebugHostLogOnFailureCollector 发生测试用例失败时收集并记录主机端日志的收集器。 设备跟踪收集器 收集器将在测试运行开始时启动 perfetto trace 并在结束时记录跟踪文件。 FilePullerDeviceMetricCollector 一个BaseDeviceMetricCollector ，它侦听来自设备的指标键并将它们作为文件从设备中提取。 GcovCodeCoverageCollector 一个BaseDeviceMetricCollector ，它将从设备中提取 gcov 覆盖测量并将它们记录为测试工件。 GcovKernelCodeCoverageCollector 一个BaseDeviceMetricCollector ，它将 gcov 内核覆盖测量从 debugfs 和设备中拉出，然后最终将它们记录为测试工件。 HostStatsdMetricCollector 一个IMetricCollector ，它使用 statsd 实用程序命令从主机端收集 statsd 指标。 JavaCodeCoverageCollector 一个BaseDeviceMetricCollector ，它将从设备中提取 Java 覆盖率测量并将它们记录为测试工件。 LogcatOnFailure 收集器 当测试用例失败时将捕获并记录 logcat 的收集器。 LogcatTimingMetricCollector 一种度量收集器，通过使用给定的正则表达式模式从 logcat 行解析事件的开始和结束信号，在一次或多次重复测试期间从 logcat 收集计时信息（例如用户切换时间）。 重启原因收集器 在测试运行期间收集设备重启并按原因和计数报告的收集器。 运行时重启收集器 收集测试运行期间运行时重启（系统服务器崩溃）时间戳的收集器（如果有）。 ScreenshotOnFailure收集器 当测试用例失败时将捕获并记录屏幕截图的收集器。

已知的间接子类 AtraceRunMetricCollector , BluetoothConnectionLatencyCollector , BluetoothConnectionStateCollector , FilePullerLogCollector , ModuleLogcatCollector , PerfettoPullerMetricCollector , ShowmapPullerMetricCollector , TraceCmdCollector AtraceRunMetricCollector 从测试设备的给定目录下的所有测试目录中收集跟踪，记录测试目录并后处理测试目录下的跟踪文件并聚合指标。 BluetoothConnectionLatencyCollector 收集器会将预定义的 statsd 持续时间指标配置推送到设备，并收集每个配置文件的蓝牙连接持续时间。 蓝牙连接状态收集器 此收集器将收集 BluetoothConnectionStateChanged 指标并记录每个配置文件的连接状态数。 FilePuller日志收集器 设备端上报文件的Logger。 模块LogcatCollector logcat 收集器的版本，但用于模块。 PerfettoPullerMetricCollector FilePullerDeviceMetricCollector的基本实现，允许从设备中拉取 perfetto 文件并从中收集指标。 ShowmapPullerMetricCollector FilePullerDeviceMetricCollector的基本实现，它允许从设备中拉取显示地图文件并从中收集指标。 跟踪命令收集器 一个IMetricCollector ，它在测试期间使用 trace-cmd 收集跟踪，并将它们记录到调用中。

---

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

公共方法
final	getBuildInfos () 返回调用中可用的构建信息列表。
final	getDevices () 返回调用中可用的设备列表。
File	getFileFromTestArtifacts (String fileName) 从测试工件或模块工件中检索文件并将其缓存在映射中以供后续调用使用。
final ITestInvocationListener	getInvocationListener () 返回我们转发结果的原始ITestInvocationListener 。
String	getModuleName ()
final	getRealDevices () 返回getDevices()列表中的所有非存根设备。
String	getRunName () 返回触发收集器的测试运行mRunName的名称。
ITestInvocationListener	init ( IInvocationContext context, ITestInvocationListener listener) 使用当前上下文和转发结果的位置初始化收集器。
final void	invocationEnded (long elapsedTime) 报告调用已终止，无论是成功终止还是由于某些错误情况。
final void	invocationFailed ( FailureDescription failure) 报告由于某些错误情况导致的不完整调用。
final void	invocationFailed (Throwable cause) 报告由于某些错误情况导致的不完整调用。
final void	invocationStarted ( IInvocationContext context) 用于转发的调用侦听器
final boolean	isDisabled () 如果禁用整个对象（跳过设置和拆卸），则返回 True。
final void	logAssociation (String dataName, LogFile logFile) 不要使用内部指标收集器实现。
void	onTestAssumptionFailure ( DeviceMetricData testData, TestDescription test) 当测试用例因假设失败而失败时回调。
void	onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics, TestDescription test) onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics, TestDescription test) 测试用例结束时的回调。
void	onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics) onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics) 测试用例结束时的回调。
void	onTestFail ( DeviceMetricData testData, TestDescription test) 测试用例失败时回调。
void	onTestModuleEnded () 允许捕获模块结束事件。
void	onTestModuleStarted () 允许捕获模块启动事件。
void	onTestRunEnd ( DeviceMetricData runData, currentRunMetrics) onTestRunEnd ( DeviceMetricData runData, currentRunMetrics) 测试运行结束时回调。
void	onTestRunFailed ( DeviceMetricData testData, FailureDescription failure) testRunFailed 事件的回调
void	onTestRunStart ( DeviceMetricData runData) 测试运行开始时的回调。
void	onTestStart ( DeviceMetricData testData) 测试用例启动时的回调。
final void	setDisable (boolean isDisabled) 设置对象是否应该被禁用。
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) testEnded ( TestDescription test, long endTime, testMetrics) ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))的替代方法，我们可以在其中直接指定结束时间。
final void	testEnded ( TestDescription test, testMetrics) 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) 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	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 ()

公共方法

获取构建信息

public final  getBuildInfos ()

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

退货

获取设备

public final  getDevices ()

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

退货

getFileFromTestArtifacts

public File getFileFromTestArtifacts (String fileName)

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

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

退货
File	来自测试工件或模块工件的文件。如果找不到文件，则返回 null。

getInvocationListener

public final ITestInvocationListener getInvocationListener ()

返回我们转发结果的原始ITestInvocationListener 。

退货
ITestInvocationListener

获取模块名称

public String getModuleName ()

退货
String

获取真实设备

public final  getRealDevices ()

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

退货

获取运行名称

public String getRunName ()

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

退货
String	mRunName，当前测试运行名称。

在里面

public ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

使用当前上下文和转发结果的位置初始化收集器。每个实例只会调用一次，收集器应该更新其内部上下文和侦听器。 Init 永远不会在之前的测试运行期间被调用。

除非您知道自己在做什么，否则不要覆盖。

参数
context	IInvocationContext ：正在进行的调用的IInvocationContext 。
listener	ITestInvocationListener ：放置结果的ITestInvocationListener 。

退货
ITestInvocationListener	新的听众包装了原来的听众。

投掷
DeviceNotAvailableException

调用结束

public final void invocationEnded (long elapsedTime)

报告调用已终止，无论是成功终止还是由于某些错误情况。

将由 TradeFederation 框架自动调用。

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

调用失败

public final void invocationFailed (FailureDescription failure)

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

将由 TradeFederation 框架自动调用。

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

调用失败

public final void invocationFailed (Throwable cause)

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

将由 TradeFederation 框架自动调用。

参数
cause	Throwable ：失败的Throwable原因

调用开始

public final void invocationStarted (IInvocationContext context)

用于转发的调用侦听器

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

被禁用

public final boolean isDisabled ()

如果禁用整个对象（跳过设置和拆卸），则返回 True。否则为假。

退货
boolean

日志关联

public final void logAssociation (String dataName, 
                LogFile logFile)

不要使用内部指标收集器实现。这是纯转发。

参数
dataName	String ：数据的名称
logFile	LogFile ：之前记录的LogFile ，应该与测试用例相关联。

测试假设失败

public void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

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

参数
testData	DeviceMetricData ：保存测试用例数据的DeviceMetricData 。
test	TestDescription ：正在进行的测试用例的TestDescription 。

投掷
DeviceNotAvailableException

在测试结束时

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

在测试结束时

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

测试失败

public void onTestFail (DeviceMetricData testData, 
                TestDescription test)

测试用例失败时回调。

参数
testData	DeviceMetricData ：保存测试用例数据的DeviceMetricData 。
test	TestDescription ：正在进行的测试用例的TestDescription 。

投掷
DeviceNotAvailableException

onTestModule结束

public void onTestModuleEnded ()

允许捕获模块结束事件。

投掷
DeviceNotAvailableException

onTestModuleStarted

public void onTestModuleStarted ()

允许捕获模块启动事件。

投掷
DeviceNotAvailableException

onTestRun结束

public void onTestRunEnd (DeviceMetricData runData, 
                 currentRunMetrics)

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

参数
runData	DeviceMetricData ：保存运行数据的DeviceMetricData 。将与onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData)期间的对象相同。
currentRunMetrics	：传递给ERROR(/#testRunEnded(long,Map))的当前指标图。

投掷
DeviceNotAvailableException

onTestRun失败

public void onTestRunFailed (DeviceMetricData testData, 
                FailureDescription failure)

testRunFailed 事件的回调

投掷
DeviceNotAvailableException

onTestRunStart

public void onTestRunStart (DeviceMetricData runData)

测试运行开始时的回调。

参数
runData	DeviceMetricData ：保存运行数据的DeviceMetricData 。

投掷
DeviceNotAvailableException

onTestStart

public void onTestStart (DeviceMetricData testData)

测试用例启动时的回调。

参数
testData	DeviceMetricData ：保存测试用例数据的DeviceMetricData 。

投掷
DeviceNotAvailableException

设置禁用

public final void setDisable (boolean isDisabled)

设置对象是否应该被禁用。禁用意味着应该跳过设置和拆卸步骤。可用于在默认构造函数中默认禁用对象。

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

设置日志保存器

public final void setLogSaver (ILogSaver logSaver)

不要使用内部指标收集器实现。这是纯转发。

参数
logSaver	ILogSaver ： ILogSaver

测试假设失败

public final void testAssumptionFailure (TestDescription test, 
                String trace)

当原子测试标记它假定条件为假时调用

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

测试假设失败

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

当原子测试标记它假定条件为假时调用

参数
test	TestDescription ：标识测试
failure	FailureDescription ：描述故障及其上下文的FailureDescription 。

测试结束

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)

测试结束

public final void testEnded (TestDescription test, 
                 testMetrics)

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

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

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

测试失败

public final void testFailed (TestDescription test, 
                FailureDescription failure)

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

将在 testStarted 和 testEnded 之间调用。

参数
test	TestDescription ：标识测试
failure	FailureDescription ：描述故障及其上下文的FailureDescription 。

测试失败

public final void testFailed (TestDescription test, 
                String trace)

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

将在 testStarted 和 testEnded 之间调用。

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

测试忽略

public final void testIgnored (TestDescription test)

当测试不会运行时调用，通常是因为测试方法用 org.junit.Ignore 注释。

参数
test	TestDescription ：标识测试

测试日志

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 每次调用可能不是唯一的。即实现者必须能够处理具有相同数据名的多个调用
dataType	LogDataType ：数据的LogDataType
dataStream	InputStreamSource ：数据的InputStreamSource 。实施者应调用 createInputStream 开始读取数据，并确保在完成后关闭生成的 InputStream。调用者应确保数据源保持存在且可访问，直到 testLog 方法完成。

测试日志已保存

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

不要使用内部指标收集器实现。这是纯转发。

参数
dataName	String ：数据的String描述性名称。例如“device_logcat”。注意 dataName 每次调用可能不是唯一的。即实现者必须能够处理具有相同数据名的多个调用
dataType	LogDataType ：数据的LogDataType
dataStream	InputStreamSource ：数据的InputStreamSource 。实施者应调用 createInputStream 开始读取数据，并确保在完成后关闭生成的 InputStream。
logFile	LogFile ：包含已保存文件的元数据的LogFile 。

测试模块结束

public final void testModuleEnded ()

报告模块运行结束。

测试模块启动

public final void testModuleStarted (IInvocationContext moduleContext)

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

参数
moduleContext	IInvocationContext ：模块的IInvocationContext 。

测试运行结束

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

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

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

测试运行失败

public final void testRunFailed (FailureDescription failure)

由于FailureDescription描述的故障，报告测试运行未能完成。

参数
failure	FailureDescription ：描述故障及其上下文的FailureDescription 。

测试运行失败

public final void testRunFailed (String errorMessage)

报告测试运行由于致命错误而未能完成。

参数
errorMessage	String : 描述运行失败原因的String 。

测试运行开始

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

报告测试运行的开始。

参数
runName	String : 测试运行名称
testCount	int : 测试运行中的测试总数
attemptNumber	int : order number，标识同一 runName 多次运行的不同尝试。 attemptNumber 是从 0 开始索引的，每次发生新的运行时都应该递增。例如，一个测试被精细地重试了 3 次，它应该在同一个 runName 下总共运行 4 次，并且 attemptNumber 是从 0 到 3。

测试运行开始

public final void testRunStarted (String runName, 
                int testCount)

测试运行回调

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

测试运行开始

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

报告测试运行的开始。

参数
runName	String : 测试运行名称
testCount	int : 测试运行中的测试总数
attemptNumber	int : order number，标识同一 runName 多次运行的不同尝试。 attemptNumber 是从 0 开始索引的，每次发生新的运行时都应该递增。例如，一个测试被精细地重试了 3 次，它应该在同一个 runName 下总共运行 4 次，并且 attemptNumber 是从 0 到 3。
startTime	long ：运行开始的时间，通过System.currentTimeMillis()测量

测试运行已停止

public final void testRunStopped (long elapsedTime)

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

TODO：目前未使用，考虑删除

参数
elapsedTime	long ：设备报告经过的时间，以毫秒为单位

测试开始

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

测试开始

public final void testStarted (TestDescription test)

测试用例回调

参数
test	TestDescription ：标识测试