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 此後處理器會將文字/二進位指標 Perfetto proto 檔案處理成鍵/值組合， 以遞迴方式展開 proto 訊息和欄位，同時增加包含字串值的欄位，直到 數值。  StatsdGenericPostProcessor 一種後處理器，透過擴充 以樹狀結構的形式記錄

已知間接子類別 StatsdBeforeGaugeMetricPostProcessor、StatsdEventMetricPostProcessor StatsdBeforeAfterGaugeMetricPostProcessor 處理「之前/之後」收集指標的後製處理器 StatsdEventMetricPostProcessor 後處理器，使用 處理器上指定的格式化工具

---

每個實作項目都應擴充的基本 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 ()

公用方法

初始

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 void invocationSkipped (SkipReason reason)

將叫用回報為略過

參數
reason	SkipReason

叫用

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	：測試期間記錄的一組檔案。

傳回
	根據測試指標新產生的指標組合。

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，說明失敗及其背景資訊。

測試結束

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 方法完成前開放存取。

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。

testModuleEnded

public final void testModuleEnded ()

回報模組的執行完畢。

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

回報執行模組的開始。這個回呼與 testModuleEnded() 相關聯，在序列中是選用選項。只會在使用 模組：套件型執行器

參數
moduleContext	IInvocationContext：模組的 IInvocationContext。

testRunEnded

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

測試執行結束報表。FIXME：我們不能有兩張地圖<>產生不同類型的介面 我們一定要在這裡使用 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)

由於使用者要求，報表測試在執行完畢前已停止執行。

待辦事項：目前未使用，建議移除

參數
elapsedTime	long：裝置回報的經過時間 (以毫秒為單位)

測試略過

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