BugreportCollector

public class BugreportCollector
extends Object implements ITestInvocationListener

java.lang.Object
   ↳ com.android.tradefed.result.BugreportCollector

一种透传 ITestInvocationListener，用于在发生可配置事件时收集 bugreport，然后在收集每个 bugreport 后对其子项调用 ITestInvocationListener.testLog。

行为：（FIXME：完成此操作）

  • 如果有任何测试用例失败，则在每次运行后捕获
  • 在每个测试用例后捕获
  • 在每次失败的测试用例后捕获
  • 捕获

摘要

嵌套类

class BugreportCollector.Predicate

用于描述何时捕获 bug 报告的完整谓词。 

interface BugreportCollector.SubPredicate

 

字段

public static final BugreportCollector.Predicate AFTER_FAILED_TESTCASES

一个预定义的谓词，会在每次失败的测试用例后触发

public static final BugreportCollector.Predicate AT_START

一个预定义的谓词，会在首次调用开始时触发

公共构造函数

BugreportCollector(ITestInvocationListener listener, ITestDevice testDevice)

公共方法

void addPredicate(BugreportCollector.Predicate p)
void blockUntilIdle()

阻塞，直到收集器停止收集任何 bug 报告。

TestSummary getSummary()

允许 InvocationListener 返回摘要。

void invocationEnded(long elapsedTime)

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

void invocationFailed(Throwable cause)

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

void invocationStarted(IInvocationContext context)

报告测试调用的开始。

void setAsynchronous(boolean asynchronous)

设置 bugreport 收集功能是应在其他线程中收集 bugreport (asynchronous = true)，还是应在捕获 bugreport 之前阻塞调用方 (asynchronous = false)。

void setDescriptiveName(String name)

设置在记录 bug 报告时要使用的描述性名称。

void setDeviceWaitTime(int waitTime)

设置在尝试捕获 bug 报告之前等待设备处于在线状态的时长（以秒为单位）。

void testAssumptionFailure(TestDescription test, String trace)

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

void testEnded(TestDescription test, 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, runMetrics)

报告测试运行结束。

void testRunFailed(String errorMessage)

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

void testRunStarted(String runName, int testCount)

报告测试运行的开始。

void testRunStopped(long elapsedTime)

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

void testStarted(TestDescription test)

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

字段

AFTER_FAILED_TESTCASES

public static final BugreportCollector.Predicate AFTER_FAILED_TESTCASES

在每次失败的测试用例后触发的预定义谓词

AT_START

public static final BugreportCollector.Predicate AT_START

一个预定义的谓词，会在首次调用开始时触发

公共构造函数

BugreportCollector

public BugreportCollector (ITestInvocationListener listener, 
                ITestDevice testDevice)

参数
listener ITestInvocationListener

testDevice ITestDevice

公共方法

addPredicate

public void addPredicate (BugreportCollector.Predicate p)

参数
p BugreportCollector.Predicate

blockUntilIdle

public void blockUntilIdle ()

阻塞，直到收集器停止收集任何 bug 报告。如果收集器未在积极收集 bugreport，则立即返回

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：调用相关信息

setAsynchronous

public void setAsynchronous (boolean asynchronous)

设置 bugreport 收集功能是应在其他线程中收集 bugreport (asynchronous = true)，还是应在捕获 bugreport 之前阻塞调用方 (asynchronous = false)。

参数
asynchronous boolean

setDescriptiveName

public void setDescriptiveName (String name)

设置在记录 bug 报告时要使用的描述性名称。如果为 null，BugreportCollector 将回退到默认行为，即序列化导致收集 bugreport 的事件的名称。

参数
name String

setDeviceWaitTime

public void setDeviceWaitTime (int waitTime)

设置在尝试捕获 bug 报告之前等待设备处于在线状态的时长（以秒为单位）。如果为负，则不会执行任何检查。在此检查期间遇到的任何 DeviceNotAvailableException 都将记录并忽略。

参数
waitTime int

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                String trace)

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

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

testEnded

public void testEnded (TestDescription test, 
                 testMetrics)

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

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

参数
test TestDescription：用于标识测试
testMetrics ：发出的指标的 ERROR(/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)) 或 ERROR(/ITestInvocationListener#invocationEnded(long)) 之前调用

TradeFederation 框架会自动调用此方法，提供主机日志和（如果适用）设备 logcat。

参数
dataName String：数据的 String 描述性名称，例如“device_logcat”。注意：每次调用时，dataName 可能不唯一。即，实现者必须能够处理具有相同 dataName 的多次调用
dataType LogDataType：数据的 LogDataType
dataStream InputStreamSource：数据的 InputStreamSource。实现人员应调用 createInputStream 以开始读取数据，并确保在完成后关闭生成的 InputStream。调用方应确保数据源在 testLog 方法完成之前保持存在且可访问。

testRunEnded

public void testRunEnded (long elapsedTime, 
                 runMetrics)

报告测试运行结束。

参数
elapsedTime long：设备报告的经过时间（以毫秒为单位）
runMetrics ：测试运行结束时报告的键值对

testRunFailed

public void testRunFailed (String errorMessage)

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

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

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(com.android.tradefed.result.TestDescription)。

参数
test TestDescription：用于标识测试