SubprocessResultsReporter

public class SubprocessResultsReporter
extends Object implements ILogSaverListener, ISupportGranularResults, ITestInvocationListener

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

已知直接子類別 LegacySubprocessResultsReporter LegacySubprocessResultsReporter 凍結的子程序結果回報器實作項目，即使其超類別有所變更，仍應與較舊版本的 TF/CTS (例如 8 以上版本) 相容。

---

實作 ITestInvocationListener 並將其指定為 result_reporter，並從子程序的測試、測試執行作業、測試叫用結果中轉送出去。

摘要

公用建構函式
SubprocessResultsReporter()

公用方法
void	close()
TestSummary	getSummary() 允許 InvocationListener 傳回摘要。
void	invocationEnded(long elapsedTime) 回報叫用已終止 (無論成功或因某些錯誤狀況而終止)。
void	invocationFailed(FailureDescription failure) 由於某些錯誤情況，因此回報未完成的叫用作業。
void	invocationFailed(Throwable cause) 回報因某些錯誤條件而不完整的叫用。
void	invocationStarted(IInvocationContext context) 回報測試叫用作業的開始時間。
void	logAssociation(String dataName, LogFile logFile) 在某些情況下，記錄必須與測試案例建立強連結，但無法在直接 testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) 回呼上執行這項操作。
void	printEvent(String key, Object event) 輔助程式，用於列印事件鍵，然後列印 JSON 物件。
void	setOutputTestLog(boolean outputTestLog) 設定是否應輸出記錄的測試。
boolean	supportGranularResults() 如果回報程式支援精細結果，會傳回 True，否則傳回 false。
void	testAssumptionFailure(TestDescription testId, String trace) 當原子測試標記假設條件為 false 時，系統會呼叫此方法
void	testAssumptionFailure(TestDescription testId, FailureDescription failure) 當原子測試標記假設條件為 false 時，系統會呼叫此方法
void	testEnded(TestDescription testId, long endTime, metrics) ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) 的替代方案，可直接指定結束時間。
void	testEnded(TestDescription testId, metrics) 回報個別測試案例的執行結束時間。
void	testFailed(TestDescription testId, FailureDescription failure) 回報個別測試案例的失敗情形。
void	testFailed(TestDescription testId, String reason) 回報個別測試案例的失敗情形。
void	testIgnored(TestDescription testId) 當測試不會執行時，系統會呼叫此方法，通常是因為測試方法已標註為 org.junit.Ignore。
void	testLog(String dataName, LogDataType dataType, InputStreamSource dataStream) 提供測試叫用作業的相關記錄或偵錯資料。
void	testModuleEnded() 回報模組執行作業結束。
void	testModuleStarted(IInvocationContext moduleContext) 回報模組開始執行的時間。
void	testRunEnded(long time, runMetrics) 回報測試執行結束。
void	testRunFailed(FailureDescription failure) 由於 FailureDescription 所述的錯誤，無法完成報表測試執行作業。
void	testRunFailed(String reason) 由於發生致命錯誤，報表測試執行作業無法完成。
void	testRunStarted(String runName, int testCount, int attemptNumber) 回報測試執行作業的開始時間。
void	testRunStarted(String runName, int testCount) 回報測試執行作業的開始時間。
void	testRunStarted(String runName, int testCount, int attemptNumber, long startTime) 回報測試執行作業的開始時間。
void	testRunStopped(long arg0) 報表測試在使用者要求下，在完成前停止執行。
void	testSkipped(TestDescription testId, SkipReason reason) 測試被略過，且因非預期原因而未執行時呼叫。
void	testStarted(TestDescription testId, long startTime) testStarted(com.android.tradefed.result.TestDescription) 的替代方案，我們也會指定測試開始時間，並搭配 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) 進行精確評估。
void	testStarted(TestDescription testId) 回報個別測試案例的開始時間。

公用建構函式

SubprocessResultsReporter

public SubprocessResultsReporter ()

公用方法

關閉

public void close ()

取得摘要

public TestSummary getSummary ()

允許 InvocationListener 傳回摘要。

傳回
TestSummary	摘要執行作業的 TestSummary，或空值

invocationEnded

public void invocationEnded (long elapsedTime)

回報叫用已終止，無論是成功或因某些錯誤條件而終止。

會由 TradeFederation 架構自動呼叫。

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

invocationFailed

public void invocationFailed (FailureDescription failure)

由於某些錯誤情況，因此回報未完成的叫用作業。

將由 TradeFederation 架構自動呼叫。

參數
failure	FailureDescription：說明失敗原因的 FailureDescription

invocationFailed

public void invocationFailed (Throwable cause)

由於某些錯誤情況，因此回報未完成的叫用作業。

會由 TradeFederation 架構自動呼叫。

參數
cause	Throwable：失敗的 Throwable 原因

叫用

public void invocationStarted (IInvocationContext context)

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

會由 TradeFederation 架構自動呼叫。回報器需要覆寫這個方法，才能支援多裝置回報。

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

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。

printEvent

public void printEvent (String key, 
                Object event)

輔助程式，用於列印事件鍵，然後列印 JSON 物件。

參數
key	String
event	Object

setOutputTestLog

public void setOutputTestLog (boolean outputTestLog)

設定是否應輸出記錄的測試。

參數
outputTestLog	boolean

supportGranularResults

public boolean supportGranularResults ()

如果回報器支援精細結果，則傳回「True」；否則傳回「false」。

傳回
boolean

testAssumptionFailure

public void testAssumptionFailure (TestDescription testId, 
                String trace)

在不可部分完成的測試旗標假設條件為 false 時呼叫

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

testAssumptionFailure

public void testAssumptionFailure (TestDescription testId, 
                FailureDescription failure)

在不可部分完成的測試旗標假設條件為 false 時呼叫

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

testEnded

public void testEnded (TestDescription testId, 
                long endTime, 
                 metrics)

ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) 的替代方案，可直接指定結束時間。搭配 testStarted(com.android.tradefed.result.TestDescription, long) 使用，可獲得精確的測量結果。

參數
testId	TestDescription：用於識別測試
endTime	long：測試結束的時間，透過 System.currentTimeMillis() 進行評估
metrics	：傳送指標的 ERROR(/Map)

testEnded

public void testEnded (TestDescription testId, 
                 metrics)

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

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

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

testFailed

public void testFailed (TestDescription testId, 
                FailureDescription failure)

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

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

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

測試失敗

public void testFailed (TestDescription testId, 
                String reason)

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

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

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

testIgnored

public void testIgnored (TestDescription testId)

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

參數
testId	TestDescription：用於識別測試

測試記錄

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

提供測試叫用作業的相關記錄或偵錯資料。

必須在 ERROR(/ITestInvocationListener#invocationFailed(Throwable)) 或 ERROR(/ITestInvocationListener#invocationEnded(long)) 之前呼叫

TradeFederation 架構會自動呼叫這個方法，提供主機記錄，並在適用情況下提供裝置 Logcat。

參數
dataName	String：資料的 String 描述性名稱，例如「device_logcat」。請注意，每個叫用作業的 dataName 可能不具唯一性。也就是說，實作者必須能夠處理具有相同 dataName 的多個呼叫
dataType	LogDataType：資料的 LogDataType
dataStream	InputStreamSource：資料的 InputStreamSource。實作者應呼叫 createInputStream 以開始讀取資料，並確保在完成時關閉產生的 InputStream。呼叫端應確保資料來源在 testLog 方法完成前仍存在且可供存取。

testModuleEnded

public void testModuleEnded ()

回報模組執行作業結束。

testModuleStarted

public void testModuleStarted (IInvocationContext moduleContext)

回報執行模組的開始。這個回呼與 testModuleEnded() 相關聯，在序列中為選用項目。這個屬性只會在使用模組：套件式執行程式的執行期間使用。

參數
moduleContext	IInvocationContext：模組的 IInvocationContext。

testRunEnded

public void testRunEnded (long time, 
                 runMetrics)

測試執行結束報表。

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

testRunFailed

public void testRunFailed (FailureDescription failure)

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

參數
failure	FailureDescription：FailureDescription 可說明失敗和相關情境。

testRunFailed

public void testRunFailed (String reason)

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

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

testRunStarted

public 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 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 arg0)

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

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

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

testSkipped

public void testSkipped (TestDescription testId, 
                SkipReason reason)

當測試遭到略過，且未因通常預期的原因而執行時，系統會呼叫此方法。系統會嘗試重試這些測試，以便取得正確的執行結果。

參數
testId	TestDescription：用於識別測試
reason	SkipReason：SkipReason

testStarted

public void testStarted (TestDescription testId, 
                long startTime)

testStarted(com.android.tradefed.result.TestDescription) 的替代選項，作用是指定測試開始的時間，結合 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) 以取得準確的測量結果。

參數
testId	TestDescription：用於識別測試
startTime	long：測試開始的時間，透過 System.currentTimeMillis() 測量

testStarted

public void testStarted (TestDescription testId)

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

參數
testId	TestDescription：用於識別測試