CollectingTestListener

public class CollectingTestListener
extends Object implements IDisableable, ILogSaverListener, ITestInvocationListener

java.lang.Object
↳	com.android.tradefed.result.CollectingTestListener

已知直接子類別 JsonHttpTestResultReporter、LUCIResultReporter、MetricsXMLResultReporter、ModuleListener、ReportPassedTests、ResultAggregator、ShardListener、SuiteResultReporter、XmlResultReporter JsonHttpTestResultReporter 將測試指標結果和分支版本、裝置資訊編碼為 JSON 和 POST 的結果回報器 連線至 HTTP 服務端點 LUCIResultReporter 產生結果回報器，可儲存 ResultDB 和 LUCI 所需的測試結果 轉換為 JSON 格式 (go/result-sink)，並在控制台中記錄檔案位置。  MetricsXMLResultReporter MetricsXMLResultReporter 將測試指標寫入至指定資料夾中的 XML 檔案， 。  ModuleListener 附加至每個模組每個 IRemoteTest 的事件監聽器，藉此收集 也就是預測結果  ReportPassedTests 在報表中加入可能的篩選器，以排除通過的測試。  ResultAggregator 特殊轉寄站，根據要求過的重試策略，在需要時匯總結果 。  ShardListener ITestInvocationListener收集叫用資料分割 (亦稱為 以便同時對多個資源執行)，然後再轉送至其他 接聽程式。  SuiteResultReporter 收集整個套件叫用的測試結果，並輸出最終結果。  XmlResultReporter 這個外掛程式能使用 Ant 的 XMLJUnitResultFormatter。

已知間接子類別 FormattedGeneratorReporter、XmlFormattedGeneratorReporter FormattedGeneratorReporter 可產生特定格式的報表報表。  XmlFormattedGeneratorReporter 實作 FormattedGeneratorReporter，這會以 xml 格式呈現套件 格式。

---

會收集所有測試結果的 ITestInvocationListener。

雖然此物件中使用的資料結構屬於執行緒安全，但必須以正確順序呼叫 ITestInvocationListener 回呼。

摘要

公用建構函式
CollectingTestListener()

公用方法
IBuildInfo	getBuildInfo() 此方法已淘汰。 而依靠 getInvocationContext() 的 IBuildInfo。
TestRunResult	getCurrentRunResults() 取得目前測試執行作業的結果。
int	getExpectedTests() 傳回預期測試數。
IInvocationContext	getInvocationContext() 傳回透過 invocationStarted(com.android.tradefed.invoker.IInvocationContext) 回報的叫用內容
	getMergedTestRunResults() 針對不同嘗試的所有執行作業，傳回合併的結果集合。
IInvocationContext	getModuleContextForRunResult(String testRunName) 傳回與結果相關聯的模組的 IInvocationContext。
MultiMap<String, LogFile>	getModuleLogFiles() 傳回地圖副本，其中包含與模組相關聯的所有記錄檔案
MultiMap<String, LogFile>	getNonAssociatedLogFiles() 傳回所有記錄檔案的地圖副本，其中包含所有與測試執行作業或 後續課程我們將逐一介紹 預先訓練的 API、AutoML 和自訂訓練
int	getNumAllFailedTestRuns() 傳回失敗狀態的測試執行總數
int	getNumAllFailedTests() 傳回失敗狀態的測試總數 (只傳回失敗，假設失敗則否， 。
int	getNumTestsInState(TestStatus status) 傳回此執行作業特定狀態下的測試數量。
int	getNumTestsInState(TestResult.TestStatus ddmlibStatus) 與舊版狀態類型相容
int	getNumTotalTests() 傳回所有執行作業的完整測試總數。
IBuildInfo	getPrimaryBuildInfo() 傳回透過 invocationStarted(com.android.tradefed.invoker.IInvocationContext) 回報的主要建構資訊。
	getRunResults() 此方法已淘汰。 使用 getMergedTestRunResults()
TestRunResult	getTestRunAtAttempt(String testRunName, int attempt) 針對單次嘗試傳回 TestRunResult。
int	getTestRunAttemptCount(String testRunName) 傳回指定測試執行作業名稱的嘗試次數。
	getTestRunAttempts(String testRunName) 取得特定測試執行作業 TestRunResult 的所有嘗試。
	getTestRunForAttempts(int attempt) 取得特定嘗試的所有結果。
	getTestRunNames() 傳回所有測試執行作業的所有名稱。
boolean	hasFailedTests() 如果叫用叫用任何失敗或假設的測試失敗，就會傳回 。
boolean	hasTestRunResultsForName(String testRunName) 傳回指定測試執行作業名稱是否有任何結果。
void	invocationEnded(long elapsedTime) 回報叫用已終止 (無論成功或因某些錯誤而終止) 值。
void	invocationFailed(Throwable cause) 回報因某些錯誤條件而不完整的叫用。
void	invocationSkipped(SkipReason reason) 將叫用回報為略過
void	invocationStarted(IInvocationContext context) 回報測試叫用開始的時間。
boolean	isDisabled() 如果整個物件已停用，則傳回 True (略過設定與拆解)。
void	logAssociation(String dataName, LogFile logFile) 在某些情況下，記錄必須與測試案例產生緊密關聯，不過也可以等到 因此，testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) 直達資訊 無法回呼。
void	setBuildInfo(IBuildInfo buildInfo) 此方法已淘汰。 不再需要進行測試。
void	setDisable(boolean isDisabled) 設定是否應停用該物件。
void	setMergeStrategy(MergeStrategy strategy) 設定合併結果時要使用的 MergeStrategy。
void	testAssumptionFailure(TestDescription test, String trace) 在不可部分完成的測試旗標假設條件為 false 時呼叫
void	testAssumptionFailure(TestDescription test, FailureDescription failure) 在不可部分完成的測試旗標假設條件為 false 時呼叫
void	testEnded(TestDescription test, long endTime, testMetrics) ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) 的替代方式，可以指定結束時間
void	testEnded(TestDescription test, testMetrics) 回報個別測試案例的執行結束時間。
void	testFailed(TestDescription test, FailureDescription failure) 回報個別測試案例的失敗情形。
void	testFailed(TestDescription test, String trace) 回報個別測試案例的失敗情形。
void	testIgnored(TestDescription test) 在測試不執行時呼叫的呼叫，通常是因為測試方法加上了 org.junit.Ignore
void	testModuleEnded() 回報模組的執行完畢。
void	testModuleStarted(IInvocationContext moduleContext) 回報執行模組的開始。
void	testRunEnded(long elapsedTime, runMetrics) 測試執行結束報表。
void	testRunFailed(FailureDescription failure) 由於「FailureDescription」指出失敗，因此無法完成報表測試。
void	testRunFailed(String errorMessage) 發生嚴重錯誤，因此無法完成報表測試。
void	testRunStarted(String name, int numTests, int attemptNumber) 回報測試執行作業的開始。
void	testRunStarted(String name, int numTests) 回報測試執行作業的開始。
void	testRunStarted(String name, int numTests, int attemptNumber, long startTime) 回報測試執行作業的開始。
void	testRunStopped(long elapsedTime) 由於使用者要求，報表測試在執行完畢前已停止執行。
void	testSkipped(TestDescription test, SkipReason reason) 測試被略過，且因非預期原因而未執行時呼叫。
void	testStarted(TestDescription test, long startTime) testStarted(com.android.tradefed.result.TestDescription) 的替代方式，我們會一併指定測試的時間 再加上 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))，才能取得準確的測量結果
void	testStarted(TestDescription test) 回報個別測試案例的開頭。

保護方法
final void	clearModuleLogFiles() 允許清理模組檔案，避免太久攜帶。
final void	clearResultsForName(String testRunName) 允許清除特定執行作業名稱的結果。
void	setIsAggregrateMetrics(boolean aggregate) 切換「匯總指標」選項

公用建構函式

CollectingTestListener

public CollectingTestListener ()

公用方法

getBuildInfo

public IBuildInfo getBuildInfo ()

此方法已淘汰。
而依靠 getInvocationContext() 的 IBuildInfo。

傳回版本資訊。

傳回
IBuildInfo

getCurrentRunResults

public TestRunResult getCurrentRunResults ()

取得目前測試執行作業的結果。

請注意，結果可能並不完整。建議您視情況測試 TestRunResult.isRunComplete() 和/或 (@link TestRunResult#isRunFailure()} 的值) 再處理結果

傳回
TestRunResult	TestRunResult，代表上次測試執行期間收集的資料

getexpectedTests

public int getExpectedTests ()

傳回預期測試數。若有以下情況，則可能與getNumTotalTests()不同 但部分測試並未執行

傳回
int

getInvocationContext

public IInvocationContext getInvocationContext ()

傳回透過 invocationStarted(com.android.tradefed.invoker.IInvocationContext) 回報的叫用內容

傳回
IInvocationContext

getMergedTestRunResults

public  getMergedTestRunResults ()

針對不同嘗試的所有執行作業，傳回合併的結果集合。

如有多項結果，系統會將每項測試執行作業合併，並呈現最新的測試結果 並覆寫先前執行作業的測試結果。測試執行作業會按照嘗試次數排序。

系統會根據 aggregate-metrics 設定的偏好設定，合併相同嘗試指標。最終指標會是上次嘗試時的指標。

傳回

getModuleContextForRunResult

public IInvocationContext getModuleContextForRunResult (String testRunName)

傳回與結果相關聯的模組的 IInvocationContext。

參數
testRunName	String：由 {testRunStarted(String, int) 提供的名稱。

傳回
IInvocationContext	特定測試執行作業名稱 null 的模組 IInvocationContext 沒有與該名稱相符的搜尋結果。

getModuleLogFiles

public MultiMap<String, LogFile> getModuleLogFiles ()

傳回地圖副本，其中包含與模組相關聯的所有記錄檔案

傳回
MultiMap<String, LogFile>

getNonAssociatedLogFiles

public MultiMap<String, LogFile> getNonAssociatedLogFiles ()

傳回所有記錄檔案的地圖副本，其中包含所有與測試執行作業或 後續課程我們將逐一介紹 預先訓練的 API、AutoML 和自訂訓練

傳回
MultiMap<String, LogFile>

getNumAllFailedTestRuns

public int getNumAllFailedTestRuns ()

傳回失敗狀態的測試執行總數

傳回
int

getNumAllFailedTests

public int getNumAllFailedTests ()

傳回失敗狀態的測試總數 (只傳回失敗，假設失敗則否， 。

傳回
int

getNumTestsInState

public int getNumTestsInState (TestStatus status)

傳回此執行作業特定狀態下的測試數量。

參數
status	TestStatus

傳回
int

getNumTestsInState

public int getNumTestsInState (TestResult.TestStatus ddmlibStatus)

與舊版狀態類型相容

參數
ddmlibStatus	TestResult.TestStatus

傳回
int

getNumTotalTests

public int getNumTotalTests ()

傳回所有執行作業的完整測試總數。

傳回
int

getPrimaryBuildInfo

public IBuildInfo getPrimaryBuildInfo ()

傳回透過 invocationStarted(com.android.tradefed.invoker.IInvocationContext) 回報的主要建構資訊。主要版本是指第一個傳回的建構作業 建構供應器如果沒有結構定義，則傳回空值 (沒有建構到 測試案例)。

傳回
IBuildInfo

getRunResults

public  getRunResults ()

此方法已淘汰。
使用「getMergedTestRunResults()」

會傳回所有測試執行作業的結果。

傳回

getTestRunAtTry

public TestRunResult getTestRunAtAttempt (String testRunName, 
                int attempt)

針對單次嘗試傳回 TestRunResult。

參數
testRunName	String：由 {testRunStarted(String, int) 提供的名稱。
attempt	int：嘗試 ID。

傳回
TestRunResult	指定名稱和嘗試 ID 的 TestRunResult，或 null (如果為) 不存在。

getTestRunTryCount

public int getTestRunAttemptCount (String testRunName)

傳回指定測試執行作業名稱的嘗試次數。

參數
testRunName	String：由 {testRunStarted(String, int) 提供的名稱。

傳回
int

getTestRunTrys

public  getTestRunAttempts (String testRunName)

取得特定測試執行作業 TestRunResult 的所有嘗試。

參數
testRunName	String：由 {testRunStarted(String, int) 提供的名稱。

傳回
	特定測試執行作業的所有 TestRunResult，按照嘗試順序排序。

getTestRunForTrys

public  getTestRunForAttempts (int attempt)

取得特定嘗試的所有結果。

參數
attempt	int：希望獲得的結果。

傳回
	特定嘗試的所有 TestRunResult。

getTestRunNames

public  getTestRunNames ()

傳回所有測試執行作業的所有名稱。

這些測試可能會以不同的嘗試方式多次執行。

傳回

hasFailedTests

public boolean hasFailedTests ()

如果叫用叫用任何失敗或假設的測試失敗，就會傳回 。

傳回
boolean

hasTestRunResultsForName

public boolean hasTestRunResultsForName (String testRunName)

傳回指定測試執行作業名稱是否有任何結果。

參數
testRunName	String：由 {testRunStarted(String, int) 提供的名稱。

傳回
boolean

已叫用

public void invocationEnded (long elapsedTime)

回報叫用已終止 (無論成功或因某些錯誤而終止) 值。

將由 TradeFederation 架構自動呼叫。

參數
elapsedTime	long：叫用的經過時間 (以毫秒為單位)

叫用失敗

public void invocationFailed (Throwable cause)

回報因某些錯誤條件而不完整的叫用。

將由 TradeFederation 架構自動呼叫。

參數
cause	Throwable：失敗的 Throwable 原因

已略過叫用

public void invocationSkipped (SkipReason reason)

將叫用回報為略過

參數
reason	SkipReason

叫用

public void invocationStarted (IInvocationContext context)

回報測試叫用開始的時間。

將由 TradeFederation 架構自動呼叫。回報者需要覆寫 此方法就能支援多部裝置回報。

參數
context	IInvocationContext：叫用的相關資訊

已停用

public boolean isDisabled ()

如果整個物件已停用，則傳回 True (略過設定與拆解)。否則傳回「否」。

傳回
boolean

記錄檔關聯

public 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之前記錄且應與 測試案例

setBuildInfo

public void setBuildInfo (IBuildInfo buildInfo)

此方法已淘汰。
不再需要進行測試。

設定建構資訊。請僅用於測試。

參數
buildInfo	IBuildInfo

設定停用

public void setDisable (boolean isDisabled)

設定是否應停用該物件。「停用」表示設定和拆解步驟 應略過可用於將物件預設為停用狀態 建構函式中設定。

參數
isDisabled	boolean：物件應置於的狀態。

設定合併

public void setMergeStrategy (MergeStrategy strategy)

設定合併結果時要使用的 MergeStrategy。

參數
strategy	MergeStrategy

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

測試結束

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)

測試結束

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：失敗的堆疊追蹤

已忽略測試

public void testIgnored (TestDescription test)

在測試不執行時呼叫的呼叫，通常是因為測試方法加上了 org.junit.Ignore

參數
test	TestDescription：識別測試

testModuleEnded

public void testModuleEnded ()

回報模組的執行完畢。

testModuleStarted

public void testModuleStarted (IInvocationContext moduleContext)

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

參數
moduleContext	IInvocationContext：模組的 IInvocationContext。

testRunEnded

public void testRunEnded (long elapsedTime, 
                 runMetrics)

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

參數
elapsedTime	long：裝置回報的經過時間 (以毫秒為單位)
runMetrics	：使用 Metric 的測試執行結束時回報的鍵/值組合。

testRunFailed

public void testRunFailed (FailureDescription failure)

由於「FailureDescription」指出失敗，因此無法完成報表測試。

參數
failure	FailureDescription：FailureDescription，說明失敗及其背景資訊。

testRunFailed

public void testRunFailed (String errorMessage)

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

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

testRunStarted

public void testRunStarted (String name, 
                int numTests, 
                int attemptNumber)

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

參數
name	String：測試執行作業名稱
numTests	int：測試執行作業中的測試總數
attemptNumber	int：訂單號碼，可識別同一個 runName 的不同嘗試次數 執行多次tryNumber 為 0 的索引，且每次都會遞增 新的執行作業發生時例如：每次執行精細的重試測試 3 次，總共應該有 4 次 在同一個 runName 下執行，且 tryNumber 介於 0 到 3 之間。

testRunStarted

public void testRunStarted (String name, 
                int numTests)

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

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

testRunStarted

public void testRunStarted (String name, 
                int numTests, 
                int attemptNumber, 
                long startTime)

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

參數
name	String：測試執行作業名稱
numTests	int：測試執行作業中的測試總數
attemptNumber	int：訂單號碼，可識別同一個 runName 的不同嘗試次數 執行多次tryNumber 為 0 的索引，且每次傳回 新的工作也會開始執行例如：執行精細的重試 3 次測試，總共應執行 4 次測試 同一個 runName，且 tryNumber 介於 0 到 3 之間。
startTime	long：執行作業開始的時間，透過 System.currentTimeMillis() 測量

testRunStopped

public void testRunStopped (long elapsedTime)

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

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

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

測試略過

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：識別測試

保護方法

ClearModuleLogFiles

protected final void clearModuleLogFiles ()

允許清理模組檔案，避免太久攜帶。

ClearResultsForName

protected final void clearResultsForName (String testRunName)

允許清除特定執行作業名稱的結果。只有在 匯總結果。

參數
testRunName	String

setIsAggregrateMetrics

protected void setIsAggregrateMetrics (boolean aggregate)

切換「匯總指標」選項

參數
aggregate	boolean