ResultDBReporter

public class ResultDBReporter
extends Object implements IConfigurationReceiver, ILogSaverListener, ISupportGranularResults, ITestSummaryListener

java.lang.Object
↳	com.android.tradefed.result.resultdb.ResultDBReporter

---

將測試結果上傳至 ResultDB 的結果回報器。

摘要

公用建構函式
ResultDBReporter()

公用方法
TestSummary	getSummary() 允許 InvocationListener 傳回摘要。
void	invocationEnded(long elapsedTime) 回報叫用已終止，無論是成功或因某些錯誤條件而終止。
void	invocationFailed(FailureDescription failure) 由於某些錯誤情況，系統會回報未完成的叫用作業。
void	invocationFailed(Throwable cause) 由於某些錯誤情況，系統會回報未完成的叫用作業。
void	invocationSkipped(SkipReason reason) 將叫用動作回報為略過
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	setConfiguration(IConfiguration configuration) 插入目前使用的 IConfiguration。
void	setLogSaver(ILogSaver logSaver) 設定 ILogSaver，允許實作者儲存檔案。
boolean	supportGranularResults() 如果回報器支援精細結果，則傳回「是」；否則傳回「否」。
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	testModuleEnded() 回報模組執行作業結束。
void	testModuleStarted(IInvocationContext moduleContext) 回報模組開始執行的時間。
void	testRunEnded(long elapsedTimeMillis, runMetrics) 回報測試執行結束。
void	testRunFailed(FailureDescription failure) 由於 FailureDescription 所述的錯誤，無法完成報表測試執行作業。
void	testRunFailed(String errorMessage) 由於發生致命錯誤，報表測試執行作業無法完成。
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 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) 回報個別測試案例的開始時間。

公用建構函式

ResultDBReporter

public ResultDBReporter ()

公用方法

getSummary

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 原因

invocationSkipped

public void invocationSkipped (SkipReason reason)

將叫用動作回報為略過

參數
reason	SkipReason

invocationStarted

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

setConfiguration

public void setConfiguration (IConfiguration configuration)

插入正在使用的 IConfiguration。

參數
configuration	IConfiguration

setLogSaver

public void setLogSaver (ILogSaver logSaver)

設定 ILogSaver，允許實作者儲存檔案。

參數
logSaver	ILogSaver：ILogSaver

supportGranularResults

public boolean supportGranularResults ()

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

傳回
boolean

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)

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

必須在 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 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 執行多次的不同嘗試。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，每次執行新測試時，這個值都會遞增。舉例來說，如果某個測試重試 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：用於識別測試