ResultDBReporter
public
class
ResultDBReporter
extends Object
implements
IConfigurationReceiver,
ILogSaverListener,
ISupportGranularResults,
ITestSummaryListener
| java.lang.Object | |
| ↳ | com.android.tradefed.result.resultdb.ResultDBReporter |
将测试结果上传到 ResultDB 的结果报告程序。
摘要
字段 | |
|---|---|
protected
IInvocationContext |
mContext
|
protected
boolean |
mEnableAlTestProperties
|
公共构造函数 | |
|---|---|
ResultDBReporter()
|
|
公共方法 | |
|---|---|
TestSummary
|
getSummary()
允许 InvocationListener 返回摘要。 |
void
|
invocationEnded(long elapsedTime)
报告调用已终止,无论是成功终止还是因某些错误情况而终止。 |
void
|
invocationFailed(FailureDescription failure)
报告因某些错误情况而导致的不完整调用。 |
void
|
invocationFailed(Throwable cause)
报告因某些错误情况而导致的不完整调用。 |
void
|
invocationSkipped(SkipReason reason)
报告调用已跳过 |
void
|
invocationStarted(IInvocationContext context)
报告测试调用的开始。 |
boolean
|
isDisabled()
|
void
|
logAssociation(String dataName, LogFile logFile)
在某些情况下,日志必须与测试用例紧密关联,但无法在直接 |
void
|
setConfiguration(IConfiguration configuration)
注入正在使用的 |
void
|
setLogSaver(ILogSaver logSaver)
将 |
boolean
|
supportGranularResults()
如果报告器支持精细结果,则返回 True,否则返回 False。 |
void
|
testAssumptionFailure(TestDescription test, String trace)
当原子测试标记其假设的条件为 false 时调用 |
void
|
testAssumptionFailure(TestDescription test, FailureDescription failure)
当原子测试标记其假设的条件为 false 时调用 |
void
|
testEnded(TestDescription test, long endTime, HashMap<String, MetricMeasurement.Metric> testMetrics)
|
void
|
testEnded(TestDescription test, HashMap<String, MetricMeasurement.Metric> testMetrics)
报告单个测试用例的执行结束时间。 |
void
|
testFailed(TestDescription test, FailureDescription failure)
报告单个测试用例的失败情况。 |
void
|
testFailed(TestDescription test, String trace)
报告单个测试用例的失败情况。 |
void
|
testIgnored(TestDescription test)
当测试不会运行时(通常是因为测试方法使用 org.junit.Ignore 注释进行了注释)调用。 |
void
|
testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)
提供测试调用中的相关日志或调试数据。 |
void
|
testModuleEnded()
报告模块运行结束。 |
void
|
testModuleStarted(IInvocationContext moduleContext)
报告模块运行的开始时间。 |
void
|
testRunEnded(long elapsedTimeMillis, HashMap<String, MetricMeasurement.Metric> runMetrics)
报告测试运行结束。 |
void
|
testRunFailed(FailureDescription failure)
报告测试运行因 |
void
|
testRunFailed(String errorMessage)
由于出现严重错误,报告测试运行未能完成。 |
void
|
testRunStarted(String runName, int testCount, int attemptNumber)
报告测试运行的开始。 |
void
|
testRunStarted(String runName, int testCount)
报告测试运行的开始。 |
void
|
testRunStarted(String runName, int testCount, int attemptNumber, long startTime)
报告测试运行的开始。 |
void
|
testRunStopped(long elapsedTime)
报告测试运行因用户请求而在完成前停止。 |
void
|
testSkipped(TestDescription test, SkipReason reason)
当测试因通常不预期的原因而被跳过且未执行时调用。 |
void
|
testStarted(TestDescription test, long startTime)
|
void
|
testStarted(TestDescription test)
报告单个测试用例的开始。 |
void
|
uploadStoragePath(String resourceId, String storagePath, LogFile logFile)
将 AnTS 测试制品的存储路径上传到 ResultDB。 |
字段
mEnableAlTestProperties
protected boolean mEnableAlTestProperties
公共构造函数
ResultDBReporter
public ResultDBReporter ()
公共方法
getSummary
public TestSummary getSummary ()
允许 InvocationListener 返回摘要。
| 返回 | |
|---|---|
TestSummary |
总结跑步活动的 TestSummary,或 null |
invocationEnded
public void invocationEnded (long elapsedTime)
报告调用已终止,无论是成功终止还是因某些错误情况而终止。
将由 TradeFederation 框架自动调用。
| 参数 | |
|---|---|
elapsedTime |
long:调用的已用时间(以毫秒为单位) |
invocationFailed
public void invocationFailed (FailureDescription failure)
报告因某些错误情况而导致的不完整调用。
将由 TradeFederation 框架自动调用。
| 参数 | |
|---|---|
failure |
FailureDescription:描述失败原因的 FailureDescription |
invocationFailed
public void invocationFailed (Throwable cause)
报告因某些错误情况而导致的不完整调用。
将由 TradeFederation 框架自动调用。
| 参数 | |
|---|---|
cause |
Throwable:失败的 Throwable 原因 |
invocationStarted
public void invocationStarted (IInvocationContext context)
报告测试调用的开始。
将由 TradeFederation 框架自动调用。报告者需要替换此方法才能支持多设备报告。
| 参数 | |
|---|---|
context |
IInvocationContext:有关调用的信息 |
isDisabled
public boolean isDisabled ()
| 返回 | |
|---|---|
boolean |
|
logAssociation
public void logAssociation (String dataName,
LogFile logFile)在某些情况下,日志必须与测试用例紧密关联,但无法在直接 testLogSaved(String,LogDataType,InputStreamSource,LogFile) 回调中实现这一点。因此,此回调允许明确提供强关联。
| 参数 | |
|---|---|
dataName |
String:数据的名称 |
logFile |
LogFile:之前记录的 LogFile,应与测试用例相关联。 |
setConfiguration
public void setConfiguration (IConfiguration configuration)
注入正在使用的 IConfiguration。
| 参数 | |
|---|---|
configuration |
IConfiguration |
setLogSaver
public void setLogSaver (ILogSaver logSaver)
将 ILogSaver 设置为允许实现者保存文件。
| 参数 | |
|---|---|
logSaver |
ILogSaver:ILogSaver |
supportGranularResults
public boolean supportGranularResults ()
如果报告器支持精细结果,则返回 True,否则返回 False。
| 返回 | |
|---|---|
boolean |
|
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, 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, HashMap<String, MetricMeasurement.Metric> testMetrics)
报告单个测试用例的执行结束时间。
如果未调用 testFailed(TestDescription, FailureDescription),则此测试通过。还会返回测试用例执行期间可能发出的任何键值指标。
| 参数 | |
|---|---|
test |
TestDescription:标识测试 |
testMetrics |
HashMap:所发出指标的 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:标识测试 |
testLog
public 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 方法完成之前保持存在且可访问。 |
testModuleEnded
public void testModuleEnded ()
报告模块运行结束。
testModuleStarted
public void testModuleStarted (IInvocationContext moduleContext)
报告模块运行的开始时间。此回调与 testModuleEnded() 相关联,在序列中是可选的。仅在运行使用模块(基于套件的运行程序)时使用。
| 参数 | |
|---|---|
moduleContext |
IInvocationContext:模块的 IInvocationContext。 |
testRunEnded
public void testRunEnded (long elapsedTimeMillis,
HashMap<String, MetricMeasurement.Metric> runMetrics)报告测试运行结束。FIXME:我们不能有两个具有不同类型的 Map<> 接口,因此我们必须在此处使用 HashMap。
| 参数 | |
|---|---|
elapsedTimeMillis |
long:设备报告的已用时间,以毫秒为单位 |
runMetrics |
HashMap:在测试运行结束时通过 Metric 报告的键值对。 |
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:标识测试 |
uploadStoragePath
public void uploadStoragePath (String resourceId,
String storagePath,
LogFile logFile)将 AnTS 测试制品的存储路径上传到 ResultDB。
这是从 AnTS 迁移到 ResultDB 的临时解决方案(请参阅 go/convergence-tr)。当制品的存储路径可用时,AnTS 报告程序应调用此方法。
AnTS 报告程序保证会针对其上传的每个制品调用此方法。此报告程序随后会将所有此类制品上传到 ResultDB,并建立正确的测试关联。为了正确关联日志,必须事先针对同一资源 ID 调用 logAssociation(String,LogFile)。这样可确保制品已被跟踪。否则,相应制品将与 tradefed 调用的顶级工作单元相关联。
不得在 invocationStarted(IInvocationContext) 之前调用此方法。对于由上游系统管理的调用,可以在 invocationEnded(long) 之后调用此方法,因为这些调用不会由此报告程序最终确定。此限制不适用于本地创建的调用,此类调用在 invocationEnded(long) 中完成。
TODO(b/464941055):一旦我们可以将 AnTS 制品正确迁移到 ResultDB,就移除此方法。
| 参数 | |
|---|---|
resourceId |
String:相应制品的资源 ID。 |
storagePath |
String:制品的存储路径(例如 /bigstore/ 路径)。 |
logFile |
LogFile:与制品关联的 LogFile 对象。 |