BasePostProcessor

public abstract class BasePostProcessor
extends Object implements IPostProcessor

java.lang.Object 中
   ↳ com.android.tradefed.postprocessor.BasePostProcessor

每个实现都应扩展的基础 IPostProcessor。确保帖子 处理方法会在最终结果报告程序之前调用。

摘要

公共构造函数

BasePostProcessor()

公共方法

final ITestInvocationListener init(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)

用于转发的调用监听器

final boolean isDisabled()

如果整个对象都已停用（跳过设置和拆解），则返回 True。

final void logAssociation(String dataName, LogFile logFile)

在某些情况下，日志必须与测试用例密切相关， 以此类推，testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) 回调。

更新日志测试关联。

processAllTestMetricsAndLogs(ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)

实现此方法可汇总所有测试中的指标和日志。

abstract processRunMetricsAndLogs( rawMetrics, runLogs)

实现此方法，以便根据现有指标生成一组新指标，并 日志。

processTestMetricsAndLogs(TestDescription testDescription, testMetrics, testLogs)

实现此方法可对每次测试中的指标和日志进行后处理。

final void setLogSaver(ILogSaver logSaver)

设置 ILogSaver 以允许实现人员保存文件。

void setUp()

在子后期处理程序中替换此方法，以在测试运行测试之前进行初始化。

final void testAssumptionFailure(TestDescription test, String trace)

在原子测试标记它假设条件为 false 时调用

final void testAssumptionFailure(TestDescription test, FailureDescription failure)

在原子测试标记它假设条件为 false 时调用

final void testEnded(TestDescription test, long endTime, testMetrics)

ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) 的替代方法，可用于指定结束时间 。

final void 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)

使用此方法通过 PostProcessor 实现记录文件。

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)

报告测试运行结束。

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(com.android.tradefed.result.TestDescription) 的替代方法，其中我们还指定了测试 开始，并结合 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) 进行准确测量。

final void testStarted(TestDescription test)

测试用例回调

受保护的方法

void cleanUp()
MetricMeasurement.DataType getMetricType()

如果需要，可替换此方法来更改指标类型。

String getRunName()

公共构造函数

BasePostProcessor

public BasePostProcessor ()

公共方法

init

public final ITestInvocationListener init (ITestInvocationListener listener)

后期处理程序的初始化步骤。确保在任何测试之前调用 回调。

参数
listener ITestInvocationListener

返回
ITestInvocationListener

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 原因

已跳过调用

public void invocationSkipped (SkipReason reason)

将调用报告为跳过

参数
reason SkipReason

invocationStarted

public final void invocationStarted (IInvocationContext context)

用于转发的调用监听器

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

已停用

public final boolean isDisabled ()

如果整个对象都已停用（跳过设置和拆解），则返回 True。否则为 false。

返回
boolean

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

在某些情况下，日志必须与测试用例密切相关， 以此类推，testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) 回调。因此，此回调允许提供 。

更新日志测试关联。如果在测试期间调用此方法，则日志 属于测试否则就是运行日志。

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

processAllTestMetricsAndLogs

public  processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, 
                 allTestLogs)

实现此方法可汇总所有测试中的指标和日志。提供的指标 此方法将用作运行指标的报告程序。只有新生成的指标 并且具有唯一的键名（不允许与现有键冲突）。

参数
allTestMetrics ListMultimap：一个 HashMultimap，用于存储每个测试的指标（按指标分组） 名称。
allTestLogs ：用于存储每个测试的日志文件映射（按数据名称进行键控）的映射， 使用每个测试的 TestDescription 作为键。
返回
从所有测试指标中新生成的指标集。

processRunMetricsAndLogs

public abstract  processRunMetricsAndLogs ( rawMetrics, 
                 runLogs)

实现此方法，以便根据现有指标生成一组新指标，并 日志。系统应仅返回新生成的指标，并且指标名称是唯一的（没有 与现有密钥冲突）。

参数
rawMetrics ：可用于运行的原始指标集。
runLogs ：测试运行的一组日志文件。
返回
根据运行指标新生成的一组指标。

processTestMetricsAndLogs

public  processTestMetricsAndLogs (TestDescription testDescription, 
                 testMetrics, 
                 testLogs)

实现此方法可对每次测试中的指标和日志进行后处理。只有 系统应返回生成的指标，并且指标具有唯一的键名（与现有指标 键）。

参数
testDescription TestDescription：描述测试的 TestDescription 对象。
testMetrics ：测试中的一组指标。
testLogs ：测试期间记录的文件集。
返回
通过测试指标新生成的一组指标。

setLogSaver（设置日志保存器）

public final void setLogSaver (ILogSaver logSaver)

设置 ILogSaver 以允许实现人员保存文件。

参数
logSaver ILogSaver：ILogSaver

设置

public void setUp ()

在子后期处理程序中替换此方法，以在测试运行测试之前进行初始化。

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

testEnded

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：失败的堆栈轨迹

testIgnored

public final void testIgnored (TestDescription test)

在不会运行测试时调用，通常是因为测试方法带有 org.junit.Ignore。

参数
test TestDescription：标识测试

testLog

public final void testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

使用此方法通过 PostProcessor 实现记录文件。

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

testLogSaved

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

在保存测试日志时调用。

应用于替代 ITestInvocationListener#testLog(String, LogDataType, InputStreamSource)。

参数
dataName String：数据的 String 描述性名称。例如“device_logcat”。注意事项 每次调用的 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() 相关联，在序列中是可选的。它仅在使用 module：基于套件的运行程序。

参数
moduleContext IInvocationContext：模块的 IInvocationContext。

testRunEnded

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

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

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

testRunFailed

public final void testRunFailed (FailureDescription failure)

由于“FailureDescription”所述的失败情况，未能完成报告测试运行。

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

testRunFailed

public final void testRunFailed (String errorMessage)

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

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

testRunStarted

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

报告测试运行开始。

参数
runName String：测试运行名称
testCount int：测试运行中的测试总数
attemptNumber int：订单号，用于标识同一 runName 的不同尝试 运行多次的命令tryNumber 从 0 开始编号，并且应该每次递增。 都会发生新的运行例如测试会精细地重试 3 次，总共应该有 4 次 以相同的 runName 运行，而 tryNumber 范围为 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 的不同尝试 运行多次的命令tryNumber 从 0 开始编号，并且应在每次 都会发生新的运行例如测试会精细地重试 3 次，总共应运行 4 次 位于同一个 runName 下，并且 tryNumber 范围是 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 SkipReason：SkipReason

testStarted

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

testStarted

public final void testStarted (TestDescription test)

测试用例回调

参数
test TestDescription：标识测试

受保护的方法

清理

protected void cleanUp ()

getMetricType

protected MetricMeasurement.DataType getMetricType ()

如果需要，可替换此方法来更改指标类型。默认情况下，指标设置为 处理类型。

返回
MetricMeasurement.DataType

getRunName

protected String getRunName ()

返回
String