プロト結果レポーター
public abstract class ProtoResultReporter
extends Object
implements ITestInvocationListener , ILogSaverListener , ISupportGranularResults
java.lang.オブジェクト | |
↳ | 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) モジュールの子参照を作成します。 |
パブリックコンストラクター
プロト結果レポーター
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 : 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)
で関連付けることができます。 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 : 呼び出しを表す最終的なプロト。 |
プロセスファイナルプロト
public void processFinalProto (TestRecordProto.TestRecord finalRecord)
すべての結果を含む最終プロトの処理。
パラメーター | |
---|---|
finalRecord | TestRecordProto.TestRecord : すべての呼び出し結果を含む最終的なプロト。 |
processStartInvocation
public void processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext)
invocationStarted(com.android.tradefed.invoker.IInvocationContext)
発生した後の部分呼び出しテスト レコード プロトの処理。
パラメーター | |
---|---|
invocationStartRecord | TestRecordProto.TestRecord : invocationStart の後に設定される部分的なプロト。 |
invocationContext | IInvocationContext : 呼び出しIInvocationContext 。 |
プロセステストケース終了
public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)
ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,HashMap))
発生した後の、最終的なテスト ケース レコード プロトの処理。
パラメーター | |
---|---|
testCaseRecord | TestRecordProto.TestRecord : テスト ケースを表す最終的なプロト。 |
プロセステストケース開始しました
public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)
testStarted(com.android.tradefed.result.TestDescription, long)
発生した後の部分的なテスト ケース レコード プロトの処理。
パラメーター | |
---|---|
testCaseStartedRecord | TestRecordProto.TestRecord : テスト ケースを表す部分的なプロト。 |
プロセステストモジュール終了
public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)
testModuleEnded()
が発生した後の、ファイナライズされたモジュール レコード proto の処理。
パラメーター | |
---|---|
moduleRecord | TestRecordProto.TestRecord : モジュールを表す最終的なプロト。 |
プロセステストモジュール開始済み
public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)
testModuleStarted(com.android.tradefed.invoker.IInvocationContext)
発生した後の部分モジュール レコード proto の処理。
パラメーター | |
---|---|
moduleStartRecord | TestRecordProto.TestRecord : モジュールを表す部分的なプロト。 |
プロセステスト実行終了
public void processTestRunEnded (TestRecordProto.TestRecord runRecord, boolean moduleInProgress)
ERROR(/#testRunEnded(long,HashMap))
発生した後の最終的な実行レコードの処理プロト。
パラメーター | |
---|---|
runRecord | TestRecordProto.TestRecord : 実行を表す最終的なプロト。 |
moduleInProgress | boolean : モジュールが進行中かどうか。 |
プロセステスト実行開始
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 |
サポート粒状の結果
public boolean supportGranularResults ()
レポーターが詳細な結果をサポートする場合は True を返し、そうでない場合は false を返します。
戻り値 | |
---|---|
boolean |
テスト仮定失敗
public final void testAssumptionFailure (TestDescription test, String trace)
アトミック テストが条件が false であると仮定することを示すフラグを立てたときに呼び出されます。
パラメーター | |
---|---|
test | TestDescription : テストを識別します |
trace | String : 失敗のスタック トレース |
テスト仮定失敗
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 : 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 : テストを識別します |
テストモジュール終了
public final void testModuleEnded ()
モジュールの実行の終了を報告します。
テストモジュールが開始されました
public final void testModuleStarted (IInvocationContext moduleContext)
モジュールの実行の開始を報告します。このコールバックはtestModuleEnded()
に関連付けられており、シーケンス内ではオプションです。これは、モジュール (スイート ベースのランナー) を使用する実行中にのみ使用されます。
パラメーター | |
---|---|
moduleContext | IInvocationContext : モジュールのIInvocationContext 。 |
テスト実行終了
public final void testRunEnded (long elapsedTimeMillis,runMetrics)
テスト実行の終了を報告します。修正: タイプの異なる 2 つの Map<> インターフェイスを使用することはできないため、ここでは HashMap を使用する必要があります。
パラメーター | |
---|---|
elapsedTimeMillis | long : デバイスが報告した経過時間 (ミリ秒単位) |
runMetrics | Metric を使用したテスト実行の終了時に報告されたキーと値のペア。 |
テスト実行失敗
public final void testRunFailed (FailureDescription failure)
FailureDescription
で説明されている障害のため、レポートのテスト実行が完了できませんでした。
パラメーター | |
---|---|
failure | FailureDescription : 失敗とそのコンテキストを説明するFailureDescription 。 |
テスト実行失敗
public final void testRunFailed (String errorMessage)
レポートのテスト実行は、致命的なエラーのため完了できませんでした。
パラメーター | |
---|---|
errorMessage | String : 実行失敗の理由を説明するString 。 |
テスト実行開始しました
public void testRunStarted (String runName, int testCount, int attemptNumber)
テスト実行の開始を報告します。
パラメーター | |
---|---|
runName | String : テスト実行名 |
testCount | int : テスト実行のテストの総数 |
attemptNumber | int : 順序番号。複数回実行される同じ runName の異なる試行を識別します。 attemptNumber は 0 から始まるインデックスであり、新しい実行が発生するたびに増加する必要があります。たとえば、テストは 3 回詳細に再試行され、同じ runName で合計 4 回の実行が必要で、attemptNumber は 0 ~ 3 です。 |
テスト実行開始しました
public final void testRunStarted (String runName, int testCount)
テスト実行の開始を報告します。
パラメーター | |
---|---|
runName | String : テスト実行名 |
testCount | int : テスト実行のテストの総数 |
テスト実行開始しました
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() によって測定された実行の開始時刻 |
テスト開始
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 : 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 |