基础后处理器

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]。 度量文件后处理器 用于上传测试和运行级别期间收集的指标日志文件。 完美通用后处理器 后处理器，通过递归扩展原始消息和具有字符串值的字段，直到遇到具有数值的字段，将文本/二进制度量 perfetto 原始文件处理为键值对。 统计通用后处理器 后处理器，通过将报告扩展为树结构，将二进制原始 statsd 报告处理为键值对。

已知的间接子类 StatsdBeforeAfterGaugeMetricPostProcessor 、 StatsdEventMetricPostProcessor StatsdBeforeAfterGaugeMetricPostProcessor 后处理器，处理以“之前/之后”方法收集的仪表指标，即 统计事件度量后处理器 后处理器，使用处理器上指定的格式化程序将 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) 当原子测试标记其假定条件为 false 时调用
final void	testAssumptionFailure ( TestDescription test, FailureDescription failure) 当原子测试标记其假定条件为 false 时调用
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 ：失败的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 ，应与测试用例关联。

处理所有测试指标和日志

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

实现此方法来聚合所有测试的指标和日志。此方法得出的指标将作为运行指标报告。仅应返回新生成的指标，并具有唯一的键名称（不允许与现有键发生冲突）。

参数
allTestMetrics	ListMultimap ：一个 HashMultimap，存储按指标名称分组的每个测试的指标。
allTestLogs	：存储每个测试的日志文件映射的映射，以数据名称为键，使用每个测试的TestDescription作为键。

退货
	从所有测试指标中新生成的一组指标。

进程运行指标和日志

public abstract  processRunMetricsAndLogs ( rawMetrics, 
                 runLogs)

实现此方法是为了从现有指标和日志生成一组新指标。仅应返回新生成的指标，并具有唯一的键名称（不允许与现有键发生冲突）。

参数
rawMetrics	：可用于运行的原始指标集。
runLogs	：测试运行的日志文件集。

退货
	从运行指标新生成的一组指标。

流程测试指标和日志

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)

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

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

测试假设失败

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

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

参数
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 ：测试结束的时间，通过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 ：数据的String描述性名称。例如“device_logcat”。注意 每次调用时 dataName 可能不是唯一的。即实现者必须能够处理具有相同 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 ：数据的String描述性名称。例如“device_logcat”。注意 每次调用时 dataName 可能不是唯一的。即实现者必须能够处理具有相同 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 ：描述运行失败原因的String 。

测试运行开始

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

报告测试运行的开始。

参数
runName	String : 测试运行名称
testCount	int : 测试运行中的测试总数
attemptNumber	int ：订单号，标识同一 runName 多次运行的不同尝试。 attemptsNumber 是从 0 开始索引的，并且每次新的运行发生时都应该递增。例如，一个测试被粒度重试 3 次，它应该在同一 runName 下总共运行 4 次，并且 attemptsNumber 从 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 ：订单号，标识同一 runName 多次运行的不同尝试。 attemptsNumber 是从 0 开始索引的，并且每次新的运行发生时都应该递增。例如，一个测试被粒度重试 3 次，它应该在同一 runName 下总共运行 4 次，并且 attemptsNumber 从 0 到 3。
startTime	long ：运行开始的时间，通过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 ：测试开始的时间，通过System.currentTimeMillis()测量

测试开始

public final void testStarted (TestDescription test)

测试用例回调

参数
test	TestDescription ：标识测试

受保护的方法

获取指标类型

protected MetricMeasurement.DataType getMetricType ()

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

退货
MetricMeasurement.DataType

获取运行名称

protected String getRunName ()

退货
String