BasePostProcessor

public abstract class BasePostProcessor
extends Object implements IPostProcessor

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

已知的直接子类 AggregatePostProcessor、AveragePostProcessor、BluetoothConnectionSuccessRatePostProcessor、MetricFilePostProcessor、PerfettoGenericPostProcessor、PerfettoTracePostProcessor、StatsdGenericPostProcessor AggregatePostProcessor 一种指标聚合器，用于提供多次迭代测试运行期间收集的数值指标的最小值、最大值、平均值、方差、标准差、总和、数量，以及可选的百分位数（将这些指标视为双精度浮点数）。  AveragePostProcessor 实现后处理器，用于计算指标列表的平均值。  BluetoothConnectionSuccessRatePostProcessor 实现用于计算蓝牙配置文件成功率的后处理器 使用“metric-key-match”指定包含蓝牙连接状态（以数字数组表示）的指标，例如 [0, 1, 2, 3, 0, 1, 2, 3]。  MetricFilePostProcessor 用于上传在测试和运行级别收集的指标日志文件。  PerfettoGenericPostProcessor 一种后处理器，用于通过递归展开具有字符串值的 proto 消息和字段，直到遇到具有数值的字段，从而将文本/二进制指标 perfetto proto 文件处理为键值对。  PerfettoTracePostProcessor 一种后处理器，用于从测试日志中检索 Perfetto 轨迹文件，并在这些文件上运行轨迹处理器以生成 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) 当原子测试标记其假设的条件为 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 原因

invocationSkipped

public void invocationSkipped (SkipReason reason)

报告调用已跳过

参数
reason	SkipReason

invocationStarted

public final void invocationStarted (IInvocationContext context)

用于转发的调用监听器

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

isDisabled

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

setUp

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。

testFailed

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：数据的描述性名称。例如“device_logcat”。String请注意，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：数据的描述性名称。例如“device_logcat”。String请注意，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 的不同尝试的订单号。attemptNumber 从 0 开始，每次新运行都会递增。例如，如果某项测试进行了 3 次精细重试，则在同一 runName 下，该测试总共应运行 4 次，且 attemptNumber 从 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