ModuleListener

public class ModuleListener
extends CollectingTestListener

java.lang.Object
↳	com.android.tradefed.result.CollectingTestListener
	↳	com.android.tradefed.testtype.suite.ModuleListener

---

監聽器會附加至每個模組的每個 IRemoteTest，以便收集結果清單。

摘要

公用建構函式
ModuleListener(ITestInvocationListener listener, IInvocationContext moduleContext) 建構函式。

公用方法
boolean	hasLastAttemptFailed() 傳回監聽器上次重試工作階段是否失敗。
void	logAssociation(String dataName, LogFile logFile) 在某些情況下，記錄必須與測試案例建立強烈關聯，但無法直接在 testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) 回呼上執行這項操作。
void	setAttemptIsolation(CurrentInvocation.IsolationGrade isolation) 設定嘗試是否應回報為隔離。
void	setCollectTestsOnly(boolean collectTestsOnly) 設定是否只收集測試。
void	setMarkTestsSkipped(boolean skip) 是否標示略過的所有測試案例。
void	setTestMappingSources( testMappingSources) 設定要插入指標的測試對應來源。
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	testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)
void	testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
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, int attemptNumber, long startTime) 回報測試執行作業的開始時間。
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)) 進行精確評估。

公用建構函式

ModuleListener

public ModuleListener (ITestInvocationListener listener, 
                IInvocationContext moduleContext)

建構函式。

參數
listener	ITestInvocationListener
moduleContext	IInvocationContext

公用方法

hasLastAttemptFailed

public boolean hasLastAttemptFailed ()

會傳回監聽器上次重試工作階段是否失敗。

傳回
boolean

logAssociation

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，應與測試案例相關聯。

setAttemptIsolation

public void setAttemptIsolation (CurrentInvocation.IsolationGrade isolation)

設定嘗試是否應回報為隔離。

參數
isolation	CurrentInvocation.IsolationGrade

setCollectTestsOnly

public void setCollectTestsOnly (boolean collectTestsOnly)

設定是否只收集測試。

參數
collectTestsOnly	boolean

setMarkTestsSkipped

public void setMarkTestsSkipped (boolean skip)

是否要將所有略過的測試案例標示為略過。

參數
skip	boolean

setTestMappingSources

public void setTestMappingSources ( testMappingSources)

設定要插入指標的測試對應來源。

參數
testMappingSources

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)

testFailed

public void testFailed (TestDescription test, 
                FailureDescription failure)

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

會在 testStarted 和 testEnded 之間呼叫。

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

testFailed

public void testFailed (TestDescription test, 
                String trace)

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

會在 testStarted 和 testEnded 之間呼叫。

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

testIgnored

public void testIgnored (TestDescription test)

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

參數
test	TestDescription：用於識別測試

testLog

public void testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

參數
dataName	String
dataType	LogDataType
dataStream	InputStreamSource

testLogSaved

public void testLogSaved (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream, 
                LogFile logFile)

參數
dataName	String
dataType	LogDataType
dataStream	InputStreamSource
logFile	LogFile

testRunEnded

public void testRunEnded (long elapsedTime, 
                 runMetrics)

回報測試執行結束。

參數
elapsedTime	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 name, 
                int numTests, 
                int attemptNumber)

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

參數
name	String：測試執行作業名稱
numTests	int：測試執行作業中的測試總數
attemptNumber	int：訂單號碼，用於識別同一個 runName 執行多次的不同嘗試。attemptNumber 的索引為 0，每次執行時都應遞增。舉例來說，如果測試重試 3 次，則在相同的 runName 下，應有 4 次執行，而 attemptNumber 則從 0 到 3。

testRunStarted

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

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

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

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() 測量