ITestLifeCycleReceiver

public interface ITestLifeCycleReceiver

com.android.tradefed.result.ITestLifeCycleReceiver

已知的间接子类 AggregatePostProcessor、AndroidBuildResultReporter、AtraceCollector、AtraceRunMetricCollector、AveragePostProcessor、BaseDeviceMetricCollector、BasePostProcessor、BluetoothConnectionLatencyCollector、BluetoothConnectionStateCollector、BluetoothConnectionSuccessRatePostProcessor、BluetoothHciSnoopLogCollector、BugreportCollector、BugreportzOnFailureCollector、BugreportzOnTestCaseFailureCollector、ClangCodeCoverageCollector 以及其他 90 个。 AggregatePostProcessor 一种指标聚合器，用于提供多次迭代测试运行期间收集的数值指标的最小值、最大值、平均值、方差、标准差、总和、数量，以及可选的百分位数（将这些指标视为双精度浮点数）。  AndroidBuildResultReporter 向 Android Build API 报告测试结果。  AtraceCollector 一种在测试期间运行 atrace 并收集结果和日志，然后将它们记录到调用中的 IMetricCollector。  AtraceRunMetricCollector 从测试设备收集给定目录下所有测试目录中的轨迹，记录测试目录，对测试目录下的轨迹文件进行后处理，并汇总指标。  AveragePostProcessor 实现后处理器，用于计算指标列表的平均值。  BaseDeviceMetricCollector IMetricCollector 的基本实现，允许在 onTestRunStart(DeviceMetricData) 和 onTestRunEnd(DeviceMetricData,Map) 上开始和停止收集。  BasePostProcessor 每个实现都应扩展的基础 IPostProcessor。  BluetoothConnectionLatencyCollector 收集器会将预定义的 statsd 时长指标配置推送到设备，并收集每个配置文件的蓝牙连接时长。  BluetoothConnectionStateCollector 此收集器将收集 BluetoothConnectionStateChanged 指标，并记录每个配置的连接状态编号。  BluetoothConnectionSuccessRatePostProcessor 实现了用于计算蓝牙配置文件成功率的后处理器 使用“metric-key-match”指定包含蓝牙连接状态（以数字数组表示）的指标。示例：[0, 1, 2, 3, 0, 1, 2, 3]。  BluetoothHciSnoopLogCollector 用于在 DUT 上启用蓝牙 HCI 信息收集日志记录并收集每次测试的日志的收集器。  BugreportCollector 一种直通 ITestInvocationListener，可在发生可配置的事件时收集 bug 报告，然后在每次收集 bug 报告后对其子级调用 ITestInvocationListener.testLog。  BugreportzOnFailureCollector 在测试用例失败时收集 bugreportz。  BugreportzOnTestCaseFailureCollector 在运行中的测试用例失败时收集 bugreportz。  ClangCodeCoverageCollector 一个 BaseDeviceMetricCollector，用于从设备中提取 Clang 覆盖率测量数据，并将其记录为测试制品。  CodeCoverageCollector 一个 BaseDeviceMetricCollector，用于从设备中提取 Java 和原生覆盖率测量数据，并将其记录为测试制品。  CollectingTestListener 一个将收集所有测试结果的 ITestInvocationListener。  CommandStatusHandler 用于帮助监控和更新调用状态的处理程序。  ConditionFailureMonitor 监控调用是否失败。  ConsoleResultReporter 用于将测试结果输出到控制台的结果报告程序。  CountTestCasesCollector 统计并报告给定 IRemoteTest 的测试用例数量。  CountingTestResultListener 一个 TestResultListener，用于按 TestStatus 跟踪测试总数 CoverageMetadataCollector 一种 ILogSaverListener，用于收集已记录的覆盖率测量结果，并生成 CoverageMetadataProto 以供 Android 代码覆盖率服务处理。  DebugHostLogOnFailureCollector 在测试用例失败时收集并记录主机端日志的收集器。  DeviceReleaseReporter 设备发布报告程序，用于处理与父进程的通信，以确定要发布的设备。  DeviceTraceCollector 在测试运行开始时启动 Perfetto 跟踪并在结束时记录跟踪文件的收集器。  DeviceUnavailableMonitor 此监听器仅尝试捕获测试用例级 DNAE。  EventsLoggerListener 将接收到的所有事件记录到文件中的监听器 FileProtoResultReporter 将 TestRecord 转储到文件中的 Proto 报告器。  FilePullerDeviceMetricCollector 一个 BaseDeviceMetricCollector，用于监听来自设备的指标密钥，并以文件形式从设备中提取这些密钥。  FilePullerLogCollector 设备端报告的文件的记录器。  FilteredResultForwarder ResultForwarder 的变体，仅允许报告许可名单中的 TestDescription。  FormattedGeneratorReporter 允许以特定格式生成报告的报告器。  GcovCodeCoverageCollector 一个 BaseDeviceMetricCollector，用于从设备中提取 gcov 覆盖率测量数据，并将其记录为测试制品。  GcovKernelCodeCoverageCollector 一个 BaseDeviceMetricCollector，用于从 debugfs 和设备中提取 gcov 内核覆盖率测量数据，然后最终将其记录为测试制品。  GeminiDebuggingPostProcessor 后处理器创建用于调试错误的提示查询。  GranularRetriableTestWrapper.StartEndCollector 用于捕获缺失的跑步开始和结束时间的类帮助程序。  HostStatsdMetricCollector 一种 IMetricCollector，可使用 statsd 实用程序命令从主机端收集 statsd 指标。  ICommandScheduler.IScheduledInvocationListener 当调用完成时，用于监听调用事件的监听器。  ILogSaverListener 允许 ITestInvocationListener 监听日志文件何时保存。  IMetricCollector 在报告测试结果时，此接口将作为装饰器添加，以便收集匹配的指标。  IPostProcessor 后处理器是一种 Trade Federation 对象，旨在允许在测试结束后和报告结果之前处理指标和日志。  IShardableListener 可分片的 ITestInvocationListener。  ISupportGranularResults 用于指定 ITestInvocationListener 是否支持接收精细结果的接口。  ITestInvocationListener 用于监听测试调用中的测试结果。  ITestSummaryListener 允许 ITestInvocationListener 通过摘要交换一些有限信息的接口。  InvocationProtoResultReporter 用于存储调用级缓存信息及其模块列表的报告器  InvocationToJUnitResultForwarder 一个监听 ITestInvocationListener 事件并将其转发到 TestListener 的类。  JarHostTest.HostTestListener 封装容器监听器，用于将除 testRunStarted() 和 testRunEnded() 之外的所有事件转发到嵌入式监听器。  JavaCodeCoverageCollector 一个 BaseDeviceMetricCollector，用于从设备中提取 Java 覆盖率测量数据，并将其记录为测试制品。  JsonHttpTestResultReporter 一种结果报告程序，可将测试指标结果和分支、设备信息编码为 JSON 并 POST 到 HTTP 服务端点  LUCIResultReporter 一种结果报告程序，可将 ResultDB 和 LUCI 所需的测试结果保存为 JSON 格式 (go/result-sink)，并在控制台中记录文件位置。  LastShardDetector 在运行本地分片时，有时我们只希望在最后一个分片达到 invocationEnded(long) 时执行某些操作。  LegacySubprocessResultsReporter 子进程结果报告器的冻结实现，尽管其父类发生了变化，但仍应与早期版本的 TF/CTS（例如 8 及更高版本）保持兼容。  LogSaverResultForwarder 用于使用全局文件保存程序保存日志的 ResultForwarder。  LogcatCrashResultForwarder 特殊监听器：在发生故障（插桩进程崩溃）时，它会尝试从 logcat 中提取崩溃信息，并将其添加到与测试关联的故障消息中。  LogcatOnFailureCollector 当测试用例或测试运行失败时，将捕获并记录 logcat 的收集器。  LogcatTimingMetricCollector 一种指标收集器，通过使用给定的正则表达式模式从 logcat 行解析事件的开始和结束信号，在一次或多次重复测试期间从 logcat 收集时间信息（例如用户切换时间）。  MetricFilePostProcessor 用于上传在测试和运行级别收集的指标日志文件。  MetricsXMLResultReporter 在测试的 invocationEnded 阶段，MetricsXMLResultReporter 会将测试指标和运行指标写入 metrics-folder 参数指定的文件夹中的 XML 文件。  ModuleListener 附加到每个模块的每个 IRemoteTest 的监听器，用于收集结果列表。  ModuleLogcatCollector logcat 收集器的版本（但适用于模块）。  ModulePerfettoCollector 当测试模块启动和结束以及设备重新启动时，将启动 Perfetto 轨迹的收集器。  ModuleProtoResultReporter 一种旨在仅报告模块级结果的结果报告程序。  ModuleResultsAndMetricsForwarder ResultAndLogForwarder 的扩展，可向测试结果添加额外的模块相关指标。  NameMangleListener 一个代理监听器，用于在报告结果时转换测试方法、类和软件包名称。  PassingTestFileReporter 将通过的测试用例列表保存到测试文件中的 ITestInvocationListener PerfettoFilePullerCollector 一种从设备拉取 Perfetto 轨迹文件的收集器，可以选择性地压缩这些文件，并将其添加到测试日志中。  PerfettoGenericPostProcessor 一种后处理器，用于通过递归展开具有字符串值的 proto 消息和字段，直到遇到具有数值的字段，从而将文本/二进制指标 perfetto proto 文件处理为键值对。  PerfettoPullerMetricCollector 此类已弃用。 请改用 PerfettoFilePullerCollector 和 ERROR(/PerfettoTracePostProcessor)。  PerfettoTracePostProcessor 一种后处理器，用于从测试日志中检索 Perfetto 轨迹文件，并在这些文件上运行轨迹处理器以生成 Perfetto 指标 proto。  PrettyTestEventLogger 与事件匹配的记录器，并按顺序记录事件，以便更轻松地进行调试。  ProtoResultReporter 结果报告程序会构建一个包含所有结果的 TestRecord protobuf。  PythonBinaryHostTest.PythonForwarder 结果转发器，用于将运行名称替换为二进制名称。  RebootReasonCollector 收集器，用于收集测试运行期间的设备重启情况，并按原因和次数报告这些情况。  RemoteTestTimeOutEnforcer 监听器，用于检查给定测试配置的执行时间，如果超过给定的超时时间，则使测试失败。  ReportPassedTests 报告文件中可能存在的过滤条件，以排除通过的测试。  ResultAggregator 一种特殊的转发器，可根据所采取的重试策略在需要时汇总结果。  ResultAndLogForwarder 用于转发结果和日志事件的转发器。  ResultDBReporter 将测试结果上传到 ResultDB 的结果报告程序。  ResultForwarder 一个将调用结果转发给其他监听器列表的 ITestInvocationListener。  ResultReporter   RetryLogSaverResultForwarder 转发器，还负责传递当前尝试次数。  RetryResultForwarder ResultForwarder 的扩展，始终推送到给定的尝试次数。  RuntimeRestartCollector 收集器，用于收集测试运行期间的运行时重启（系统服务器崩溃）时间戳（如有）。  ScreenRecordOnFailureCollector 在测试用例失败时捕获并记录屏幕录制的收集器。  ScreenshotOnFailureCollector 在测试用例失败时捕获并记录屏幕截图的收集器。  ShardListener 一种 ITestInvocationListener，用于从调用分片（即拆分后的调用，可在多个资源上并行运行）收集结果，并将结果转发给另一个监听器。  ShardMainResultForwarder 一种用于合并分片测试调用结果的 ResultForwarder。  ShowmapPullerMetricCollector FilePullerDeviceMetricCollector 的基本实现，允许从设备拉取 showmap 文件并从中收集指标。  SimpleperfProfilePostProcessor 一种后处理器，用于查找 simpleperf 性能剖析数据并生成 pprof 配置文件。  StatsdBeforeAfterGaugeMetricPostProcessor 一种后处理器，用于处理以“前后”方式收集的测量指标，即 StatsdEventMetricPostProcessor 一种后处理器，用于使用处理器上指定的格式化程序将 statsd 报告中的事件指标处理为键值对。  StatsdGenericPostProcessor 一种后处理器，用于通过将二进制 proto statsd 报告展开为树结构，将其处理为键值对。  StreamProtoResultReporter ProtoResultReporter 的实现 SubprocessResultsReporter 实现 ITestInvocationListener 以指定为 result_reporter，并从子进程转发测试、测试运行、测试调用的结果。  SuiteResultReporter 收集整个套件调用的测试结果，并输出最终结果。  TestResultListener 针对仅关注单个测试结果的实现者，对 ITestLifecycleListener 进行了简化。  TestRunResultListener 用于读取最终测试运行状态的监听器。  TestTimeoutEnforcer 允许检查给定测试用例的执行时间并在其超过给定超时时间时使其失败的监听器。  TextResultReporter 一种测试结果报告程序，可将结果转发给 JUnit 文本结果打印程序。  TraceCmdCollector 一个 IMetricCollector，用于在测试期间使用 trace-cmd 收集轨迹，并将其记录到调用中。  TradefedSandboxRunner.StubScheduledInvocationListener 不执行任何操作的桩 IScheduledInvocationListener。  XmlFormattedGeneratorReporter FormattedGeneratorReporter 的实现，用于以 XML 格式设置测试套件结果的格式。  XmlResultReporter 以与 Ant 的 XMLJUnitResultFormatter 一致的格式将 JUnit 结果写入 XML 文件。

---

在插桩测试运行期间接收事件通知。

以 org.junit.runner.notification.RunListener 为蓝本

调用顺序如下：

• testRunStarted
• testStarted
• [testFailed]
• [testAssumptionFailure]
• [testIgnored]
• testEnded
• ....
• [testRunFailed]
• testRunEnded

摘要

公共方法
default void	testAssumptionFailure(TestDescription test, String trace) 当原子测试标记其假设的条件为 false 时调用
default void	testAssumptionFailure(TestDescription test, FailureDescription failure) 当原子测试标记其假设的条件为 false 时调用
default void	testEnded(TestDescription test, HashMap<String, MetricMeasurement.Metric> testMetrics) 报告单个测试用例的执行结束时间。
default void	testEnded(TestDescription test, long endTime, Map<String, String> testMetrics) testEnded(TestDescription,Map) 的替代方案，可直接指定结束时间。
default void	testEnded(TestDescription test, long endTime, HashMap<String, MetricMeasurement.Metric> testMetrics) testEnded(TestDescription,Map) 的替代方案，可直接指定结束时间。
default void	testEnded(TestDescription test, Map<String, String> testMetrics) 报告单个测试用例的执行结束时间。
default void	testFailed(TestDescription test, FailureDescription failure) 报告单个测试用例的失败情况。
default void	testFailed(TestDescription test, String trace) 报告单个测试用例的失败情况。
default void	testIgnored(TestDescription test) 当测试不会运行时（通常是因为测试方法使用 org.junit.Ignore 注释进行了注释）调用。
default void	testRunEnded(long elapsedTimeMillis, HashMap<String, MetricMeasurement.Metric> runMetrics) 报告测试运行结束。
default void	testRunEnded(long elapsedTimeMillis, Map<String, String> runMetrics) 报告测试运行结束。
default void	testRunFailed(FailureDescription failure) 报告测试运行因 FailureDescription 所述的失败而未能完成。
default void	testRunFailed(String errorMessage) 由于出现严重错误，报告测试运行未能完成。
default void	testRunStarted(String runName, int testCount, int attemptNumber) 报告测试运行的开始。
default void	testRunStarted(String runName, int testCount) 报告测试运行的开始。
default void	testRunStarted(String runName, int testCount, int attemptNumber, long startTime) 报告测试运行的开始。
default void	testRunStopped(long elapsedTime) 报告测试运行因用户请求而在完成前停止。
default void	testSkipped(TestDescription test, SkipReason reason) 当测试因通常不预期的原因而被跳过且未执行时调用。
default void	testStarted(TestDescription test, long startTime) testStarted(TestDescription) 的替代方案，其中还指定了测试开始时间，并与 testEnded(TestDescription,long,Map) 结合使用以实现精确衡量。
default void	testStarted(TestDescription test) 报告单个测试用例的开始。

公共方法

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                String trace)

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

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

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

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

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

testEnded

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

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

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

参数
test	TestDescription：标识测试
testMetrics	HashMap：所发出指标的 Map

testEnded

public void testEnded (TestDescription test, 
                long endTime, 
                Map<String, String> testMetrics)

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

参数
test	TestDescription：标识测试
endTime	long：测试结束时间，通过 System.currentTimeMillis() 测量
testMetrics	Map：所发出指标的 Map

testEnded

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

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

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

参数
test	TestDescription：标识测试
testMetrics	Map：所发出指标的 Map

testFailed

public void testFailed (TestDescription test, 
                FailureDescription failure)

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

将在 testStarted 和 testEnded 之间调用。

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

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：标识测试

testRunEnded

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

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

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

testRunEnded

public void testRunEnded (long elapsedTimeMillis, 
                Map<String, String> runMetrics)

报告测试运行结束。

参数
elapsedTimeMillis	long：设备报告的已用时间，以毫秒为单位
runMetrics	Map：在测试运行结束时报告的键值对

testRunFailed

public void testRunFailed (FailureDescription failure)

报告测试运行因 FailureDescription 所述的失败而未能完成。

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

testRunFailed

public void testRunFailed (String errorMessage)

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

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

testRunStarted

public 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 void testRunStarted (String runName, 
                int testCount)

报告测试运行的开始。

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

testRunStarted

public 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 void testRunStopped (long elapsedTime)

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

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

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

testSkipped

public void testSkipped (TestDescription test, 
                SkipReason reason)

当测试因通常不预期的原因而被跳过且未执行时调用。 系统将尝试重试这些测试，以尝试获得正确的执行结果。

参数
test	TestDescription：标识测试
reason	SkipReason：SkipReason

testStarted

public void testStarted (TestDescription test, 
                long startTime)

testStarted(TestDescription) 的替代方案，我们还指定了测试开始时间，并与 testEnded(TestDescription,long,Map) 结合使用以实现精确衡量。

参数
test	TestDescription：标识测试
startTime	long：测试开始时间，通过 System.currentTimeMillis() 测量

testStarted

public void testStarted (TestDescription test)

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

参数
test	TestDescription：标识测试