此页面由 Cloud Translation API 翻译。

BasePostProcessor

public abstract class BasePostProcessor
extends Object implements IPostProcessor

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

已知的直接子类

AggregatePostProcessor、AveragePostProcessor、BluetoothConnectionSuccessRatePostProcessor、MetricFilePostProcessor、PerfettoGenericPostProcessor、StatsdGenericPostProcessor

AggregatePostProcessor	一个指标汇总器，用于为多次迭代测试运行期间收集的数值指标提供最小值、最大值、平均值、方差、标准差、总和、计数，以及可选的分位数（将这些指标视为双精度值）。
AveragePostProcessor	实现后期处理程序，用于计算指标列表的平均值。
BluetoothConnectionSuccessRatePostProcessor	实现了用于计算蓝牙配置文件成功率的后处理器使用“metric-key-match”指定包含数字数组中的蓝牙连接状态的指标（示例：[0, 1, 2, 3, 0, 1, 2, 3]）。
MetricFilePostProcessor	用于上传在测试和运行级别收集的指标日志文件。
PerfettoGenericPostProcessor	一个后期处理器，该程序通过以递归方式扩展带字符串值的 proto 消息和字段，直到遇到带数字值的字段，从而将文本/二进制指标 perfetto proto 文件处理为键值对。
StatsdGenericPostProcessor	一种后处理程序，用于将二进制 proto statsd 报告扩展为树结构，以便将其处理为键值对。

已知的间接子类

StatsdBeforeAfterGaugeMetricPostProcessor、StatsdEventMetricPostProcessor

StatsdBeforeAfterGaugeMetricPostProcessor	用于处理以“前/后”方式收集的平均值指标的后处理器，即
StatsdEventMetricPostProcessor	后处理器，使用处理器上指定的格式化程序将 statsd 报告中的事件指标处理为键值对。

每个实现都应扩展的基础 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)` 当原子测试标记为假的假设条件时调用
`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` 原因

invocationSkipped

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

testFailed

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() 相关联，在序列中是可选的。它仅在使用模块（基于套件的运行程序）的运行期间使用。

参数
`moduleContext`	`IInvocationContext`：模块的 `IInvocationContext`。

testRunEnded

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

报告测试运行结束。

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

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 的不同尝试。attemptNumber 从 0 开始编号，每次有新的运行时都应递增。例如，如果某个测试进行了 3 次精细重试，则它在同一 runName 下总共应有 4 次运行，并且 attemptNumber 应介于 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 次，它应该在相同 runName 下总共运行 4 次，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`：用于标识测试

受保护的方法

cleanUp

protected void cleanUp ()

getMetricType

protected MetricMeasurement.DataType getMetricType ()

如有必要，请替换此方法以更改指标类型。默认情况下，指标设置为“已处理”类型。

返回
`MetricMeasurement.DataType`

getRunName

protected String getRunName ()

返回
`String`