為配合主幹穩定開發模型，並確保生態系統的平台穩定性，我們將自 2026 年起，在第 2 季和第 4 季將原始碼發布至 AOSP。如要建構及貢獻 AOSP，請使用 android-latest-release。android-latest-release 資訊清單分支版本一律會參照推送至 Android 開放原始碼計畫的最新版本。詳情請參閱「Android 開放原始碼計畫變更」。

Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

ResultDBReporter

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

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

結果回報工具，可將測試結果上傳至 ResultDB。

摘要

欄位
`protected IInvocationContext`	`mContext`
`protected boolean`	`mEnableAlTestProperties`

公用建構函式
`ResultDBReporter()`

公用方法
`TestSummary`	`getSummary()` 允許 InvocationListener 傳回摘要。
`void`	`invocationEnded(long elapsedTime)` 回報是否因某種錯誤狀況而終止呼叫 (無論是否成功)。
`void`	`invocationFailed(FailureDescription failure)` Reports an incomplete invocation due to some error condition.
`void`	`invocationFailed(Throwable cause)` Reports an incomplete invocation due to some error condition.
`void`	`invocationSkipped(SkipReason reason)` 回報已略過的叫用
`void`	`invocationStarted(IInvocationContext context)` Reports the start of the test invocation.
`boolean`	`isDisabled()`
`void`	`logAssociation(String dataName, LogFile logFile)` 在某些情況下，記錄必須與測試案例密切相關，但無法在直接 `testLogSaved(String,LogDataType,InputStreamSource,LogFile)` 回呼中執行這項操作。
`void`	`setConfiguration(IConfiguration configuration)` 注入使用的 `IConfiguration`。
`void`	`setLogSaver(ILogSaver logSaver)` 設定 `ILogSaver`，允許實作者儲存檔案。
`boolean`	`supportGranularResults()` 如果檢舉者支援精細結果，則傳回 True，否則傳回 False。
`void`	`testAssumptionFailure(TestDescription test, String trace)` 當原子測試標記假設為 false 的條件時，系統會呼叫這個函式
`void`	`testAssumptionFailure(TestDescription test, FailureDescription failure)` 當原子測試標記假設為 false 的條件時，系統會呼叫這個函式
`void`	`testEnded(TestDescription test, long endTime, HashMap<String, MetricMeasurement.Metric> testMetrics)` `testEnded(TestDescription,Map)` 的替代方案，可直接指定結束時間。
`void`	`testEnded(TestDescription test, HashMap<String, MetricMeasurement.Metric> 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, HashMap<String, MetricMeasurement.Metric> runMetrics)` Reports end of test run.
`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)` Called when a test is skipped and did not execute for a reason that is not usually expected.
`void`	`testStarted(TestDescription test, long startTime)` `testStarted(TestDescription)` 的替代方案，我們也會指定測試開始時間，並搭配 `testEnded(TestDescription,long,Map)` 進行準確的評估。
`void`	`testStarted(TestDescription test)` 回報個別測試案例的開始時間。
`void`	`uploadStoragePath(String resourceId, String storagePath, LogFile logFile)` 將 AnTS 測試構件的儲存路徑上傳至 ResultDB。

欄位

mContext

protected IInvocationContext mContext

mEnableAlTestProperties

protected boolean mEnableAlTestProperties

公用建構函式

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`：叫用相關資訊

isDisabled

public boolean isDisabled ()

傳回
`boolean`

logAssociation

public void logAssociation (String dataName, 
                LogFile logFile)

在某些情況下，記錄必須與測試案例密切相關，但無法在直接 testLogSaved(String,LogDataType,InputStreamSource,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, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

testEnded(TestDescription,Map) 的替代方案，可直接指定結束時間。搭配 testStarted(TestDescription,long) 使用，可準確測量。

參數
`test`	`TestDescription`：識別測試
`endTime`	`long`：測試結束時間，透過 `System.currentTimeMillis()` 測量
`testMetrics`	`HashMap`：發出的指標 `Map`

testEnded

public void testEnded (TestDescription test, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

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

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

參數
`test`	`TestDescription`：識別測試
`testMetrics`	`HashMap`：發出的指標 `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)/ITestInvocationListener#invocationFailed(java.lang.Throwable) 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, 
                HashMap<String, MetricMeasurement.Metric> runMetrics)

測試執行結束時會回報。FIXME：我們無法使用不同型別的兩個 Map<> 介面，因此必須在此使用 HashMap。

參數
`elapsedTimeMillis`	`long`：裝置回報的經過時間 (以毫秒為單位)
`runMetrics`	`HashMap`：在測試執行結束時，使用 `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 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)

Called when a test is skipped and did not execute for a reason that is not usually expected. 系統會嘗試重試這些測試，以確保正常執行。

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

testStarted

public void testStarted (TestDescription test, 
                long startTime)

testStarted(TestDescription) 的替代方案，我們也會指定測試開始時間，並搭配 testEnded(TestDescription,long,Map) 進行準確的評估。

參數
`test`	`TestDescription`：識別測試
`startTime`	`long`：測試開始時間，透過 `System.currentTimeMillis()` 測量

testStarted

public void testStarted (TestDescription test)

回報個別測試案例的開始時間。舊版介面，建議盡可能使用 testStarted(TestDescription)。

參數
`test`	`TestDescription`：識別測試

uploadStoragePath

public void uploadStoragePath (String resourceId, 
                String storagePath, 
                LogFile logFile)

將 AnTS 測試構件的儲存路徑上傳至 ResultDB。

這是從 AnTS 遷移至 ResultDB 的暫時解決方案 (請參閱 go/convergence-tr)。當構件的儲存路徑可用時，AnTS 報告器應呼叫這個方法。

AnTS 記者保證會針對上傳的每個構件呼叫這個方法。這個回報器會將所有這類構件上傳至 ResultDB，並正確建立測試關聯。為正確建立記錄關聯，您必須事先為相同資源 ID 呼叫 logAssociation(String,LogFile)。這可確保構件已受到追蹤。否則，構件會與 Tradefed 叫用作業的頂層工作單元建立關聯。

請勿在 invocationStarted(IInvocationContext) 之前呼叫這個方法。如果呼叫是由上游系統管理，則可以在 invocationEnded(long) 之後呼叫，因為這類呼叫並非由這個檢舉者完成。這不適用於在本機建立的叫用，這類叫用會在 invocationEnded(long) 中完成。

TODO(b/464941055)：將 AnTS 構件正確遷移至 ResultDB 後，請移除這個方法。

參數
`resourceId`	`String`：構件的資源 ID。
`storagePath`	`String`：成果的儲存路徑 (例如 /bigstore/ 路徑)。
`logFile`	`LogFile`：與構件相關聯的 `LogFile` 物件。