ITestLifeCycleReceiver

public interface ITestLifeCycleReceiver

com.android.tradefed.result.ITestLifeCycleReceiver

已知間接子類別 AggregatePostProcessor、AtraceCollector、AtraceRunMetricCollector、AveragePostProcessor、BaseDeviceMetricCollector、BasePostProcessor、BluetoothConnectionLatencyCollector、BluetoothConnectionStateCollector、BluetoothConnectionSuccessRatePostProcessor、BluetoothHciSnoopLogCollector、BugreportCollector、BugreportzOnFailureCollector、BugreportzOnTestCaseFailureCollector、ClangCodeCoverageCollector、CollectingTestListener 和其他 77 個。 AggregatePostProcessor 指標匯總工具，可針對在多次迭代測試執行期間收集到的數值指標，提供最小值、最大值、平均值、變異數、標準差、總數、計數，以及選用的百分位數，並將這些指標視為雙精度浮點值。  AtraceCollector 在測試期間執行 atrace，並收集結果並記錄至叫用作業的 IMetricCollector。  AtraceRunMetricCollector 從測試裝置的指定目錄中，收集所有測試目錄的追蹤記錄，記錄測試目錄，並對測試目錄下的追蹤記錄檔案進行後置處理，然後匯總成效指標。  AveragePostProcessor 實作後置處理器，計算指標清單的平均值。  BaseDeviceMetricCollector 允許在 onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData) 和 ERROR(/#onTestRunEnd(com.android.tradefed.device.metric.DeviceMetricData,Map)) 上開始和停止收集的 IMetricCollector 基本實作。  BasePostProcessor 每個實作項目都應擴充的基本 IPostProcessor。  BluetoothConnectionLatencyCollector 收集器會將預先定義的 statsd 持續時間指標設定推送至裝置，並收集每個設定檔的藍牙連線時間。  BluetoothConnectionStateCollector 這個收集器會收集 BluetoothConnectionStateChanged 指標，並記錄每個設定檔的連線狀態編號。  BluetoothConnectionSuccessRatePostProcessor 實作後置處理器，計算藍牙設定檔的成功率 使用「metric-key-match」指定指標，這些指標在數值陣列中包含藍牙連線狀態。例如 [0、1、2、3、0、1、2、3]。  BluetoothHciSnoopLogCollector 收集器，可在 DUT 上啟用藍牙 HCI 窺探記錄，並收集每項測試的記錄。  BugreportCollector 在可設定事件發生時收集錯誤報告的傳遞 ITestInvocationListener，然後在收集每個錯誤報告後，對其子項呼叫 ITestInvocationListener#testLog。  BugreportzOnFailureCollector 在測試案例失敗時收集錯誤報告。  BugreportzOnTestCaseFailureCollector 在執行期間收集測試案例失敗的錯誤報告。  ClangCodeCoverageCollector BaseDeviceMetricCollector 會從裝置中提取 Clang 涵蓋率測量資料，並將其記錄為測試構件。  收集 TestListener 用於收集所有測試結果的 ITestInvocationListener。  CommandStatusHandler 處理程序，可協助監控及更新叫用作業的狀態。  ConditionFailureMonitor 監控叫用失敗的情形。  ConsoleResultReporter 結果回報器，用於將測試結果輸出至控制台。  CountTestCasesCollector 計算及回報指定 IRemoteTest 的測試案例數量。  CountingTestResultListener TestResultListener，可追蹤 TestStatus 的測試總數 DebugHostLogOnFailureCollector 當測試案例失敗時，這個收集器會收集並記錄主機端記錄。  DeviceReleaseReporter 裝置發布報告器，可處理與要發布的裝置父項程序進行通訊。  DeviceTraceCollector 會在測試開始時啟動 Perfetto 追蹤記錄的收集器，並在結束時記錄追蹤檔。  DeviceUnavailableMonitor 這個事件監聽器只會嘗試擷取測試案例層級的 DNAE。  EventsLoggerListener 事件監聽器，可將收到的所有事件記錄到檔案中 FileProtoResultReporter 可將 TestRecord 傾印至檔案的 Proto 回報程式。  FilePullerDeviceMetricCollector BaseDeviceMetricCollector 會監聽來自裝置的評估指標鍵，並將這些指標鍵從裝置中擷取為檔案。  FilePullerLogCollector 裝置端回報的檔案記錄器。  FilteredResultForwarder ResultForwarder 的變化版本，僅允許回報 TestDescription 的許可清單。  FormattedGeneratorReporter 可讓您以特定格式產生報表的報表產生器。  GcovCodeCoverageCollector BaseDeviceMetricCollector 會從裝置中提取 gcov 涵蓋率測量資料，並將其記錄為測試構件。  GcovKernelCodeCoverageCollector BaseDeviceMetricCollector 會從 debugfs 和裝置中提取 gcov 核心涵蓋率測量值，然後將這些值記錄為測試構件。  GranularRetriableTestWrapper.StartEndCollector 用於擷取缺少的執行開始和結束時間的類別輔助程式。  HostStatsdMetricCollector IMetricCollector 會使用 StatsD 公用程式指令，從主機端收集 StatsD 指標。  ICommandScheduler.IScheduledInvocationListener 叫用完成時的叫用事件監聽器。  ILogSaverListener 儲存記錄檔時，可允許 ITestInvocationListener 監聽。  IMetricCollector 在回報測試結果時，系統會將此介面新增為修飾符，以便收集相符的指標。  IPostProcessor 後置處理器是 Trade Federation 物件，可在測試完成後及結果回報前處理指標和記錄。  IShardableListener 可分割的 ITestInvocationListener。  ISupportGranularResults 介面，可指定 ITestInvocationListener 是否支援接收精細結果。  ITestInvocationListener 測試叫用測試結果的接聽程式。  ITestSummaryListener 可讓 ITestInvocationListener 透過摘要交換部分有限資訊的介面。  InvocationToJUnitResultForwarder 監聽 ITestInvocationListener 事件並將事件轉送至 TestListener 的類別。  JarHostTest.HostTestListener 除了 testRunStarted() 和 testRunEnded() 以外，所有事件都會由包裝函式事件監聽器轉送至內嵌事件監聽器。  JavaCodeCoverageCollector BaseDeviceMetricCollector，可從裝置中提取 Java 涵蓋率評估結果，並將其記錄為測試構件。  JsonHttpTestResultReporter 結果回報器，可將測試指標結果和分支、裝置資訊編碼為 JSON，並將其 POST 至 HTTP 服務端點 LUCIResultReporter 結果回報器，可將 ResultDB 和 LUCI 所需的測試結果儲存為 JSON 格式 (go/result-sink)，並在主控台記錄檔案位置。  LastShardDetector 執行本機區塊時，有時只想在最後一個區塊達到 invocationEnded(long) 時執行某些動作。  LegacySubprocessResultsReporter 凍結的子程序結果回報器實作項目，即使其超類別有所變更，仍應與較舊版本的 TF/CTS (例如 8 以上版本) 相容。  LogSaverResultForwarder 使用全域檔案儲存工具儲存記錄的 ResultForwarder。  LogcatCrashResultForwarder 特殊事件監聽器：失敗時 (檢測程序異常終止)，它會嘗試從 Logcat 擷取當機情形，並加入與測試相關聯的失敗訊息。  LogcatOnFailureCollector 在測試案例失敗時，會擷取並記錄 Logcat 的收集器。  LogcatTimingMetricCollector 指標收集器會在一次或多次重複測試期間，使用指定的規則運算式剖析 logcat 行中的事件開始和結束信號，從而從 logcat 收集時間資訊 (例如使用者切換時間)。  MetricFilePostProcessor 用於上傳在測試和執行層級收集的指標記錄檔案。  MetricsXMLResultReporter MetricsXMLResultReporter 會在測試的 invocationEnded 階段，將測試指標和執行指標寫入由 metrics-folder 參數指定的資料夾中 XML 檔案。  ModuleListener 監聽器會附加至每個模組的每個 IRemoteTest，以便收集結果清單。  ModuleLogcatCollector Logcat 收集器的版本，但適用於模組。  ModuleProtoResultReporter 結果回報器，只會回報模組層級結果。  NameMangleListener 代理程式事件監聽器，用於在回報結果時轉譯測試方法、類別和套件名稱。  PassingTestFileReporter ITestInvocationListener，可將通過測試的測試案例清單儲存至測試檔案 PerfettoGenericPostProcessor 後置處理器會以遞迴方式展開 proto 訊息和字串值欄位，直到遇到數值欄位為止，藉此將文字/二進位指標 perfetto proto 檔案處理成鍵/值組合。  PerfettoPullerMetricCollector FilePullerDeviceMetricCollector 的基本實作項目，可從裝置中提取 Perfetto 檔案，並收集其中的指標。  PrettyTestEventLogger 比對事件並記錄事件的記錄器，以便更輕鬆地進行偵錯。  ProtoResultReporter 結果回報器會建構 TestRecord protobuf，其中包含所有結果。  PythonBinaryHostTest.PythonForwarder 結果轉寄器，用以將執行名稱替換為二進位名稱。  RebootReasonCollector 收集器會在測試執行期間收集裝置重新啟動情形，並依據原因和計數回報。  RemoteTestTimeOutEnforcer 可用於檢查指定測試設定的執行時間，並在超過指定逾時時間時失敗的事件監聽器。  ReportPassedTests 在檔案中回報可能的篩選器，以便排除已通過測試的項目。  ResultAggregator 特殊轉送器，可根據採用的重試策略，在需要時匯總結果。  ResultAndLogForwarder 結果和記錄事件的轉發器。  ResultForwarder 將叫用結果轉送至其他 Listener 清單的 ITestInvocationListener。  RetryLogSaverResultForwarder 也負責通過目前嘗試的轉送器。  RetryResultForwarder ResultForwarder 的擴充功能，一律會推送至指定的嘗試次數。  RuntimeRestartCollector 收集器，可在測試執行期間收集執行階段重新啟動 (系統伺服器當機) 的時間戳記 (如果有的話)。  ScreenshotOnFailureCollector 在測試案例失敗時，擷取並記錄螢幕截圖的收集器。  ShardListener ITestInvocationListener 會收集呼叫分割作業 (也就是在多個資源上並行執行的呼叫分割作業) 的結果，並將結果轉送至其他事件監聽器。  ShardMainResultForwarder 結合分割測試叫用結果的 ResultForwarder。  ShowmapPullerMetricCollector FilePullerDeviceMetricCollector 的基本實作項目，可從裝置中提取 showmap 檔案，並收集相關指標。  StatsdBeforeAfterGaugeMetricPostProcessor 後續處理器會處理以「前後」方式收集的評估指標，也就是 StatsdEventMetricPostProcessor 後置處理器，可使用處理器上指定的格式化工具，將 statsd 報表中的事件指標轉換為鍵/值組合。  StatsdGenericPostProcessor 後置處理器會將二進位值 Proto 統計資料報表處理為鍵/值組合，方法是將報表展開為樹狀結構。  StreamProtoResultReporter ProtoResultReporter 實作 SubprocessResultsReporter 實作 ITestInvocationListener，以便指定為 result_reporter，並從子程序轉寄測試、測試執行和測試叫用結果。  SuiteResultReporter 收集整個套件叫用作業的測試結果，並輸出最終結果。  TestResultListener 針對只在乎個別測試結果的實作者，簡化 ITestLifecycleListener。  TestRunResultListener 可讀取最終測試執行狀態的事件監聽器。  TestTimeoutEnforcer 可用於檢查特定測試案例的執行時間，並在超過指定逾時時間時失敗的事件監聽器。  TextResultReporter 將結果轉送至 JUnit 文字結果列印機的測試結果回報器。  TraceCmdCollector 使用 trace-cmd 在測試期間收集追蹤記錄，並記錄到叫用的 IMetricCollector。  TradefedSandboxRunner.StubScheduledInvocationListener 不執行任何操作的 Stub IScheduledInvocationListener。  XmlFormattedGeneratorReporter 實作 FormattedGeneratorReporter，以 XML 格式格式化套裝軟體結果。  XmlResultReporter 以與 Ant 的 XMLJUnitResultFormatter 一致的格式，將 JUnit 結果寫入 XML 檔案。

---

在檢測工具測試執行期間接收事件通知。

以 org.junit.runner.notification.RunListener 為範本

呼叫順序將為：

• testRunStarted
• testStarted
• [testFailed]
• [testAssumptionFailure]
• [測試忽略]
• testEnded
• ....
• [testRunFailed]
• testRunEnded

摘要

公用方法
default void	testAssumptionFailure(TestDescription test, String trace) 在不可部分完成的測試旗標假設條件為 false 時呼叫
default void	testAssumptionFailure(TestDescription test, FailureDescription failure) 在不可部分完成的測試旗標假設條件為 false 時呼叫
default void	testEnded(TestDescription test, long endTime, testMetrics) ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) 的替代方案，可直接指定結束時間。
default void	testEnded(TestDescription test, testMetrics) 回報個別測試案例的執行結束時間。
default void	testFailed(TestDescription test, FailureDescription failure) 回報個別測試案例的失敗情形。
default void	testFailed(TestDescription test, String trace) 回報個別測試案例的失敗情形。
default void	testIgnored(TestDescription test) 當測試不會執行時，系統會呼叫此方法，通常是因為測試方法已標註為 org.junit.Ignore。
default void	testRunEnded(long elapsedTimeMillis, runMetrics) 回報測試執行結束。
default void	testRunFailed(FailureDescription failure) 由於 FailureDescription 所述的錯誤，無法完成報表測試執行作業。
default void	testRunFailed(String errorMessage) 發生嚴重錯誤，因此無法完成報表測試。
default void	testRunStarted(String runName, int testCount, int attemptNumber) 回報測試執行作業的開始時間。
default void	testRunStarted(String runName, int testCount) 回報測試執行作業的開始時間。
default void	testRunStarted(String runName, int testCount, int attemptNumber, long startTime) 回報測試執行作業的開始時間。
default void	testRunStopped(long elapsedTime) 報表測試在使用者要求下，在完成前停止執行。
default void	testSkipped(TestDescription test, SkipReason reason) 當測試遭到略過，且未因通常預期的原因而執行時，系統會呼叫此方法。
default void	testStarted(TestDescription test, long startTime) testStarted(com.android.tradefed.result.TestDescription) 的替代方案，我們也會指定測試開始時間，並搭配 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) 進行精確評估。
default void	testStarted(TestDescription test) 回報個別測試案例的開頭。

公用方法

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                String trace)

當原子測試標記假設條件為 false 時，系統會呼叫此方法

參數
test	TestDescription：用於識別測試
trace	String：失敗的堆疊追蹤

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

當原子測試標記假設條件為 false 時，系統會呼叫此方法

參數
test	TestDescription：用於識別測試
failure	FailureDescription：FailureDescription 可說明失敗和其情境。

testEnded

public 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 void testEnded (TestDescription test, 
                 testMetrics)

回報個別測試案例的執行結束時間。

如果未叫用 testFailed(TestDescription, FailureDescription)，則表示這項測試已通過。也會傳回在測試案例執行期間發出的任何鍵/值指標。

參數
test	TestDescription：用於識別測試
testMetrics	：傳送指標的 ERROR(/Map)

測試失敗

public void testFailed (TestDescription test, 
                FailureDescription failure)

回報個別測試案例的失敗情形。

這個值會在 testStarted 和 testEnded 之間呼叫。

參數
test	TestDescription：用於識別測試
failure	FailureDescription：FailureDescription 可描述失敗和其情境。

測試失敗

public void testFailed (TestDescription test, 
                String trace)

回報個別測試案例的失敗情形。

這個值會在 testStarted 和 testEnded 之間呼叫。

參數
test	TestDescription：用於識別測試
trace	String：失敗的堆疊追蹤

testIgnored

public void testIgnored (TestDescription test)

當測試不會執行時，系統會呼叫此方法，通常是因為測試方法已標註為 org.junit.Ignore。

參數
test	TestDescription：用於識別測試

testRunEnded

public void testRunEnded (long elapsedTimeMillis, 
                 runMetrics)

測試執行結束報表。

參數
elapsedTimeMillis	long：裝置回報的經過時間，以毫秒為單位
runMetrics	：測試執行結束時回報的鍵/值組合

testRunFailed

public void testRunFailed (FailureDescription failure)

由於 FailureDescription 所述的錯誤，導致報表測試執行作業無法完成。

參數
failure	FailureDescription：FailureDescription 可描述失敗和其情境。

testRunFailed

public void testRunFailed (String errorMessage)

發生嚴重錯誤，因此無法完成報表測試。

參數
errorMessage	String：String 說明執行失敗的原因。

testRunStarted

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

回報測試執行作業的開始時間。

參數
runName	String：測試執行作業名稱
testCount	int：測試執行作業中的測試總數
attemptNumber	int：訂單號碼，用於識別同一個 runName 執行多次的不同嘗試。tryNumber 為 0 的索引，每次執行新執行作業時應遞增。舉例來說，執行精細的重試作業會重試 3 次，在同一個 runName 下應有 4 次執行作業，而 tryNumber 介於 0 到 3 之間。

testRunStarted

public void testRunStarted (String runName, 
                int testCount)

回報測試執行作業的開始時間。

參數
runName	String：測試執行作業名稱
testCount	int：測試執行作業中的測試總數

testRunStarted

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

回報測試執行作業的開始時間。

參數
runName	String：測試執行作業名稱
testCount	int：測試執行作業中的測試總數
attemptNumber	int：訂單號碼，用於識別同一個 runName 執行多次的不同嘗試。attemptNumber 的索引為 0，每次執行新測試時，應增加 1。舉例來說，如果測試重試 3 次，則在相同的 runName 下，應有 4 次總執行次數，而 attemptNumber 則從 0 到 3。
startTime	long：執行作業開始的時間，透過 System.currentTimeMillis() 測量

testRunStopped

public void testRunStopped (long elapsedTime)

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

TODO：目前未使用，建議移除

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

testSkipped

public void testSkipped (TestDescription test, 
                SkipReason reason)

測試被略過，且因非預期原因而未執行時呼叫。系統會嘗試重試這些測試，以便取得正確的執行結果。

參數
test	TestDescription：識別測試
reason	SkipReason：SkipReason

testStarted

public 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 void testStarted (TestDescription test)

回報個別測試案例的開始時間。較舊的介面，應盡可能使用 testStarted(com.android.tradefed.result.TestDescription)。

參數
test	TestDescription：用於識別測試