ProtoResultReporter
public abstract class ProtoResultReporter
extends Object
implements ITestInvocationListener , ILogSaverListener , ISupportGranularResults
java.lang.Object | |
↳ | com.android.tradefed.result.proto.ProtoResultReporter |
結果レポーターは、内部にすべての結果を含むTestRecord
protobuf を構築します。 processFinalProto(com.android.tradefed.result.proto.TestRecordProto.TestRecord)
の最終プロトを処理するために拡張する必要があります。
まとめ
パブリック コンストラクター | |
---|---|
ProtoResultReporter () |
公開メソッド | |
---|---|
final void | invocationEnded (long elapsedTime) 呼び出しが正常に終了したか、何らかのエラー状態により終了したことを報告します。 |
void | invocationFailed ( FailureDescription failure) 何らかのエラー状態による不完全な呼び出しを報告します。 |
void | invocationFailed (Throwable cause) 何らかのエラー状態による不完全な呼び出しを報告します。 |
final void | invocationStarted ( IInvocationContext context) テスト呼び出しの開始を報告します。 |
final void | logAssociation (String dataName, LogFile logFile) 場合によっては、ログをテスト ケースと強く関連付ける必要がありますが、直接 |
void | processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs) 呼び出しレコードを使用して、呼び出しのすべての最終ログを 1 つずつ送信します。 |
void | processFinalProto (TestRecordProto.TestRecord finalRecord) すべての結果を含む最終プロトの処理。 |
void | processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext) |
void | processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord) |
void | processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord) |
void | processTestModuleEnd (TestRecordProto.TestRecord moduleRecord) |
void | processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord) |
void | processTestRunEnded (TestRecordProto.TestRecord runRecord, boolean moduleInProgress) |
void | processTestRunStarted (TestRecordProto.TestRecord runStartedRecord) |
void | setGranularResults (boolean granularResults) |
void | setInlineRecordOfChildren (boolean inline) |
boolean | supportGranularResults () レポーターが詳細な結果をサポートしている場合は True を返し、そうでない場合は False を返します。 |
final void | testAssumptionFailure ( TestDescription test, String trace) アトミック テストが false の条件を想定していることを示すフラグを立てたときに呼び出されます |
final void | testAssumptionFailure ( TestDescription test, FailureDescription failure) アトミック テストが false の条件を想定していることを示すフラグを立てたときに呼び出されます |
final void | testEnded ( TestDescription test, long endTime, testMetrics) testEnded ( TestDescription test, long endTime, testMetrics) |
void | testEnded ( TestDescription test, testMetrics) testEnded ( TestDescription test, testMetrics) 個々のテスト ケースの実行終了を報告します。 |
final void | testFailed ( TestDescription test, FailureDescription failure) 個々のテスト ケースの失敗を報告します。 |
final void | testFailed ( TestDescription test, String trace) 個々のテスト ケースの失敗を報告します。 |
final void | testIgnored ( TestDescription test) 通常、テストメソッドに org.junit.Ignore の注釈が付けられているため、テストが実行されない場合に呼び出されます。 |
final void | testModuleEnded () モジュール実行の終了を報告します。 |
final void | testModuleStarted ( IInvocationContext moduleContext) 実行中のモジュールの開始を報告します。 |
final void | testRunEnded (long elapsedTimeMillis, runMetrics) testRunEnded (long elapsedTimeMillis, runMetrics) テスト実行の終了を報告します。 |
final void | testRunFailed ( FailureDescription failure) |
final void | testRunFailed (String errorMessage) 致命的なエラーのため、レポートのテスト実行を完了できませんでした。 |
void | testRunStarted (String runName, int testCount, int attemptNumber) テスト実行の開始を報告します。 |
final void | testRunStarted (String runName, int testCount) テスト実行の開始を報告します。 |
void | testRunStarted (String runName, int testCount, int attemptNumber, long startTime) テスト実行の開始を報告します。 |
final void | testStarted ( TestDescription test, long startTime) |
final void | testStarted ( TestDescription test) 個々のテスト ケースの開始を報告します。 |
保護されたメソッド | |
---|---|
TestRecordProto.ChildReference | createModuleChildReference (TestRecordProto.TestRecord record) モジュールの子参照を作成します。 |
パブリック コンストラクター
ProtoResultReporter
public ProtoResultReporter ()
公開メソッド
呼び出し終了
public final void invocationEnded (long elapsedTime)
呼び出しが正常に終了したか、何らかのエラー状態により終了したことを報告します。
TradeFederation フレームワークによって自動的に呼び出されます。パラメーター | |
---|---|
elapsedTime | long : 呼び出しの経過時間 (ミリ秒) |
呼び出し失敗
public void invocationFailed (FailureDescription failure)
何らかのエラー状態による不完全な呼び出しを報告します。
TradeFederation フレームワークによって自動的に呼び出されます。
パラメーター | |
---|---|
failure | FailureDescription : 失敗の原因を説明するFailureDescription |
呼び出し失敗
public void invocationFailed (Throwable cause)
何らかのエラー状態による不完全な呼び出しを報告します。
TradeFederation フレームワークによって自動的に呼び出されます。パラメーター | |
---|---|
cause | Throwable : ERROR(/Throwable) 失敗の原因 |
呼び出し開始
public final void invocationStarted (IInvocationContext context)
テスト呼び出しの開始を報告します。
TradeFederation フレームワークによって自動的に呼び出されます。レポーターは、複数のデバイス レポートをサポートするために、このメソッドをオーバーライドする必要があります。
パラメーター | |
---|---|
context | IInvocationContext : 呼び出しに関する情報 |
ログ関連付け
public final 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 。 |
processFinalInvocationLogs
public void processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs)
呼び出しレコードを使用して、呼び出しのすべての最終ログを 1 つずつ送信します。
パラメーター | |
---|---|
invocationLogs | TestRecordProto.TestRecord : 呼び出しを表す最終的なプロト。 |
processFinalProto
public void processFinalProto (TestRecordProto.TestRecord finalRecord)
すべての結果を含む最終プロトの処理。
パラメーター | |
---|---|
finalRecord | TestRecordProto.TestRecord : すべての呼び出し結果を含むファイナライズされたプロト。 |
processStartInvocation
public void processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext)
invocationStarted(com.android.tradefed.invoker.IInvocationContext)
発生後の部分呼び出しテスト レコード proto の処理。
パラメーター | |
---|---|
invocationStartRecord | TestRecordProto.TestRecord : invocationStart の後に入力される部分プロトコル。 |
invocationContext | IInvocationContext : 呼び出しIInvocationContext 。 |
processTestCaseEnded
public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)
ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,HashMap))
発生した後の最終テスト ケース レコード proto の処理。
パラメーター | |
---|---|
testCaseRecord | TestRecordProto.TestRecord : テスト ケースを表す最終的なプロト。 |
processTestCaseStarted
public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)
testStarted(com.android.tradefed.result.TestDescription, long)
発生した後の部分的なテスト ケース レコード proto の処理。
パラメーター | |
---|---|
testCaseStartedRecord | TestRecordProto.TestRecord : テスト ケースを表す部分プロトコル。 |
processTestModuleEnd
public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)
testModuleEnded()
が発生した後のファイナライズされたモジュール レコード proto の処理。
パラメーター | |
---|---|
moduleRecord | TestRecordProto.TestRecord : モジュールを表すファイナライズされたプロト。 |
processTestModuleStarted
public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)
testModuleStarted(com.android.tradefed.invoker.IInvocationContext)
発生した後の部分モジュール レコード proto の処理。
パラメーター | |
---|---|
moduleStartRecord | TestRecordProto.TestRecord : モジュールを表す部分プロトコル。 |
processTestRunEnded
public void processTestRunEnded (TestRecordProto.TestRecord runRecord, boolean moduleInProgress)
ERROR(/#testRunEnded(long,HashMap))
発生した後のファイナライズされた実行レコード proto の処理。
パラメーター | |
---|---|
runRecord | TestRecordProto.TestRecord : 実行を表すファイナライズされたプロト。 |
moduleInProgress | boolean : モジュールが進行中かどうか。 |
processTestRunStarted
public void processTestRunStarted (TestRecordProto.TestRecord runStartedRecord)
testRunStarted(String, int)
発生した後の部分的なテスト実行レコード proto の処理。
パラメーター | |
---|---|
runStartedRecord | TestRecordProto.TestRecord : 実行を表す部分プロトコル。 |
setGranularResults
public void setGranularResults (boolean granularResults)
パラメーター | |
---|---|
granularResults | boolean |
setInlineRecordOfChildren
public void setInlineRecordOfChildren (boolean inline)
パラメーター | |
---|---|
inline | boolean |
supportGranularResults
public boolean supportGranularResults ()
レポーターが詳細な結果をサポートしている場合は True を返し、そうでない場合は False を返します。
戻り値 | |
---|---|
boolean |
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, String trace)
アトミック テストが false の条件を想定していることを示すフラグを立てたときに呼び出されます
パラメーター | |
---|---|
test | TestDescription : テストを識別します |
trace | String : 失敗のスタック トレース |
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
アトミック テストが false の条件を想定していることを示すフラグを立てたときに呼び出されます
パラメーター | |
---|---|
test | TestDescription : テストを識別します |
failure | FailureDescription : 失敗とそのコンテキストを説明するFailureDescription 。 |
テスト終了
public final 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 : ERROR(/System#currentTimeMillis()) を介して測定された、テストが終了した時間 |
testMetrics | ERROR(/Map) |
テスト終了
public void testEnded (TestDescription test,testMetrics)
個々のテスト ケースの実行終了を報告します。
testFailed(TestDescription, FailureDescription)
が呼び出されなかった場合、このテストは成功しました。また、テスト ケースの実行中に発行された可能性のあるキー/値メトリックも返します。
パラメーター | |
---|---|
test | TestDescription : テストを識別します |
testMetrics | ERROR(/Map) |
テスト失敗
public final void testFailed (TestDescription test, FailureDescription failure)
個々のテスト ケースの失敗を報告します。
testStarted と testEnded の間で呼び出されます。
パラメーター | |
---|---|
test | TestDescription : テストを識別します |
failure | FailureDescription : 失敗とそのコンテキストを説明するFailureDescription 。 |
テスト失敗
public final void testFailed (TestDescription test, String trace)
個々のテスト ケースの失敗を報告します。
testStarted と testEnded の間で呼び出されます。
パラメーター | |
---|---|
test | TestDescription : テストを識別します |
trace | String : 失敗のスタック トレース |
テスト無視
public final void testIgnored (TestDescription test)
通常、テストメソッドに org.junit.Ignore の注釈が付けられているため、テストが実行されない場合に呼び出されます。
パラメーター | |
---|---|
test | TestDescription : テストを識別します |
testModuleEnded
public final void testModuleEnded ()
モジュール実行の終了を報告します。
testModuleStarted
public final void testModuleStarted (IInvocationContext moduleContext)
実行中のモジュールの開始を報告します。このコールバックはtestModuleEnded()
に関連付けられており、シーケンスではオプションです。モジュールを使用する実行中にのみ使用されます: スイートベースのランナー。
パラメーター | |
---|---|
moduleContext | IInvocationContext : モジュールのIInvocationContext 。 |
testRunEnded
public final void testRunEnded (long elapsedTimeMillis,runMetrics)
テスト実行の終了を報告します。 FIXME: タイプの異なる 2 つの Map<> インターフェイスを持つことはできないため、ここでは HashMap を使用する必要があります。
パラメーター | |
---|---|
elapsedTimeMillis | long : デバイスが報告した経過時間 (ミリ秒) |
runMetrics | Metric でのテスト実行の最後に報告されるキーと値のペア。 |
testRunFailed
public final void testRunFailed (FailureDescription failure)
FailureDescription
で説明されているエラーのため、レポートのテスト実行を完了できませんでした。
パラメーター | |
---|---|
failure | FailureDescription : 失敗とそのコンテキストを説明するFailureDescription 。 |
testRunFailed
public final void testRunFailed (String errorMessage)
致命的なエラーのため、レポートのテスト実行を完了できませんでした。
パラメーター | |
---|---|
errorMessage | String : 実行失敗の理由を説明するERROR(/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 final 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 : 実行が開始された時間、 ERROR(/System#currentTimeMillis()) で測定 |
テスト開始
public final 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 : ERROR(/System#currentTimeMillis()) を介して測定された、テストの開始時間 |
テスト開始
public final void testStarted (TestDescription test)
個々のテスト ケースの開始を報告します。古いインターフェースでは、可能な限りtestStarted(com.android.tradefed.result.TestDescription)
を使用する必要があります。
パラメーター | |
---|---|
test | TestDescription : テストを識別します |
保護されたメソッド
createModuleChildReference
protected TestRecordProto.ChildReference createModuleChildReference (TestRecordProto.TestRecord record)
モジュールの子参照を作成します。
パラメーター | |
---|---|
record | TestRecordProto.TestRecord |
戻り値 | |
---|---|
TestRecordProto.ChildReference |