此页面由 Cloud Translation API 翻译。

基础后处理器

public abstract class BasePostProcessor
extends Object implements IPostProcessor

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

已知的直接子类

AggregatePostProcessor , AveragePostProcessor , BluetoothConnectionSuccessRatePostProcessor , MetricFilePostProcessor , PerfettoGenericPostProcessor , StatsdGenericPostProcessor

聚合后处理器	一个度量聚合器，它给出了在多次迭代测试运行期间收集的数字度量的最小值、最大值、平均值、方差、标准差、总数、计数和可选的百分位数，将它们视为双精度数。
平均后处理器	计算指标列表平均值的后处理器的实现。
蓝牙连接成功率后处理器	计算蓝牙配置文件成功率的后处理器的实现使用“metric-key-match”指定包含数字数组示例 [0, 1, 2, 3, 0, 1, 2, 3] 中的蓝牙连接状态的指标。
公制文件后处理器	用于上传在测试和运行级别收集的指标日志文件。
PerfettoGeneric后处理器	一个后处理器，通过递归地扩展原型消息和具有字符串值的字段，直到遇到具有数值的字段，将文本/二进制度量 perfetto 原型文件处理成键值对。
Statsd通用后处理器	通过将报告扩展为树结构，将二进制原型 statsd 报告处理为键值对的后处理器。

已知的间接子类

StatsdBeforeAfterGaugeMetricPostProcessor , StatsdEventMetricPostProcessor

StatsdBeforeAfterGaugeMetricPostProcessor	一个后处理器，它处理以“之前/之后”的方式收集的测量指标，即
StatsdEventMetric后处理器	使用处理器上指定的格式化程序将 statsd 报告中的事件指标处理为键值对的后处理器。

每个实现都应该扩展的基础IPostProcessor 。确保在最终结果报告器之前调用后处理方法。

概括

公共构造函数
`BasePostProcessor ()`

公共方法
`final ITestInvocationListener`	`init ( ITestInvocationListener listener)` 后处理器的初始化步骤。
`final void`	`invocationEnded (long elapsedTime)` 报告调用已终止，无论是成功终止还是由于某些错误情况。
`final void`	`invocationFailed ( FailureDescription failure)` 报告由于某些错误情况导致的不完整调用。
`final void`	`invocationFailed (Throwable cause)` 报告由于某些错误情况导致的不完整调用。
`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)` `processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)` 实施此方法以聚合所有测试的指标和日志。
`abstract`	`processRunMetricsAndLogs ( rawMetrics, runLogs)` `processRunMetricsAndLogs ( rawMetrics, runLogs)` `processRunMetricsAndLogs ( rawMetrics, runLogs)` 实施此方法以便从现有指标和日志生成一组新指标。
	`processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs)` `processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs)` `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)` 当原子测试标记它假定条件为假时调用
`final void`	`testEnded ( TestDescription test, long endTime, testMetrics)` `testEnded ( TestDescription test, long endTime, testMetrics)` `ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))`的替代方法，我们可以在其中直接指定结束时间。
`final void`	`testEnded ( TestDescription test, testMetrics)` `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)` `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`	`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)` 测试用例回调

受保护的方法
`MetricMeasurement.DataType`	`getMetricType ()` 如果需要，重写此方法以更改指标类型。
`String`	`getRunName ()`

公共构造函数

基础后处理器

public BasePostProcessor ()

公共方法

在里面

public final ITestInvocationListener init (ITestInvocationListener listener)

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

参数
`listener`	`ITestInvocationListener`

退货
`ITestInvocationListener`

调用结束

public final void invocationEnded (long elapsedTime)

报告调用已终止，无论是成功终止还是由于某些错误情况。

将由 TradeFederation 框架自动调用。

参数
`elapsedTime`	`long` ：调用经过的时间（以毫秒为单位）

调用失败

public final void invocationFailed (FailureDescription failure)

报告由于某些错误情况导致的不完整调用。

将由 TradeFederation 框架自动调用。

参数
`failure`	`FailureDescription` ：描述失败原因的`FailureDescription`

调用失败

public final void invocationFailed (Throwable cause)

报告由于某些错误情况导致的不完整调用。

将由 TradeFederation 框架自动调用。

参数
`cause`	`Throwable` : 失败的`ERROR(/Throwable)`原因

调用开始

public final void invocationStarted (IInvocationContext context)

用于转发的调用侦听器

参数
`context`	`IInvocationContext` ：有关调用的信息

被禁用

public final boolean isDisabled ()

如果禁用整个对象（跳过设置和拆卸），则返回 True。否则为假。

退货
`boolean`

日志关联

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`	：测试期间记录的文件集。

退货
	来自测试指标的一组新生成的指标。

设置日志保存器

public final void setLogSaver (ILogSaver logSaver)

设置ILogSaver以允许实施者保存文件。

参数
`logSaver`	`ILogSaver` ： `ILogSaver`

设置

public void setUp ()

在测试运行之前在子后处理器中覆盖此方法以进行初始化。

测试假设失败

public final void testAssumptionFailure (TestDescription test, 
                String trace)

当原子测试标记它假定条件为假时调用

参数
`test`	`TestDescription` ：标识测试
`trace`	`String` ：失败的堆栈跟踪

测试假设失败

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

当原子测试标记它假定条件为假时调用

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

测试结束

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` ：测试结束的时间，通过`ERROR(/System#currentTimeMillis())`测量
`testMetrics`	: 发出的指标的`ERROR(/Map)`

测试结束

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` ：失败的堆栈跟踪

测试忽略

public final void testIgnored (TestDescription test)

当测试不会运行时调用，通常是因为测试方法用 org.junit.Ignore 注释。

参数
`test`	`TestDescription` ：标识测试

测试日志

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

使用此方法记录来自 PostProcessor 实现的文件。

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

测试日志已保存

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

保存测试日志时调用。

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

参数
`dataName`	`String` ：数据的`ERROR(/String)`描述性名称。例如“device_logcat”。注意 dataName 每次调用可能不是唯一的。即实现者必须能够处理具有相同数据名的多个调用
`dataType`	`LogDataType` ：数据的`LogDataType`
`dataStream`	`InputStreamSource` ：数据的`InputStreamSource` 。实施者应调用 createInputStream 开始读取数据，并确保在完成后关闭生成的 InputStream。
`logFile`	`LogFile` ：包含已保存文件的元数据的`LogFile` 。

测试模块结束

public final void testModuleEnded ()

报告模块运行结束。

测试模块启动

public final void testModuleStarted (IInvocationContext moduleContext)

报告模块运行的开始。此回调与testModuleEnded()关联，并且在序列中是可选的。它仅在使用模块的运行期间使用：基于套件的运行器。

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

测试运行结束

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

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

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

测试运行失败

public final void testRunFailed (FailureDescription failure)

由于FailureDescription描述的故障，报告测试运行未能完成。

参数
`failure`	`FailureDescription` ：描述故障及其上下文的`FailureDescription` 。

测试运行失败

public final void testRunFailed (String errorMessage)

报告测试运行由于致命错误而未能完成。

参数
`errorMessage`	`String` : `ERROR(/String)`描述运行失败的原因。

测试运行开始

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

报告测试运行的开始。

参数
`runName`	`String` : 测试运行名称
`testCount`	`int` : 测试运行中的测试总数
`attemptNumber`	`int` : order number，标识同一 runName 多次运行的不同尝试。 attemptNumber 是从 0 开始索引的，每次发生新的运行时都应该递增。例如，一个测试被精细地重试了 3 次，它应该在同一个 runName 下总共运行 4 次，并且 attemptNumber 是从 0 到 3。

测试运行开始

public final void testRunStarted (String runName, 
                int testCount)

测试运行回调

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

测试运行开始

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

报告测试运行的开始。

参数
`runName`	`String` : 测试运行名称
`testCount`	`int` : 测试运行中的测试总数
`attemptNumber`	`int` : order number，标识同一 runName 多次运行的不同尝试。 attemptNumber 是从 0 开始索引的，每次发生新的运行时都应该递增。例如，一个测试被精细地重试了 3 次，它应该在同一个 runName 下总共运行 4 次，并且 attemptNumber 是从 0 到 3。
`startTime`	`long` ：运行开始的时间，通过`ERROR(/System#currentTimeMillis())`测量

测试运行已停止

public final void testRunStopped (long elapsedTime)

由于用户请求，报告测试运行在完成之前停止。

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

参数
`elapsedTime`	`long` ：设备报告经过的时间，以毫秒为单位

测试开始

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` ：测试开始的时间，通过`ERROR(/System#currentTimeMillis())`测量

测试开始

public final void testStarted (TestDescription test)

测试用例回调

参数
`test`	`TestDescription` ：标识测试

受保护的方法

获取指标类型

protected MetricMeasurement.DataType getMetricType ()

如果需要，重写此方法以更改指标类型。默认情况下，指标设置为已处理类型。

退货
`MetricMeasurement.DataType`

获取运行名称

protected String getRunName ()

退货
`String`