ベースポストプロセッサ

public abstract class BasePostProcessor
extends Object implements IPostProcessor

java.lang.オブジェクト
com.android.tradefed.postprocessor.BasePostProcessor


すべての実装が拡張する必要がある基本IPostProcessor 。後処理メソッドが最終結果レポーターの前に呼び出されることを確認してください。

まとめ

パブリックコンストラクター

BasePostProcessor ()

パブリックメソッド

final ITestInvocationListener init ( ITestInvocationListener listener)

ポストプロセッサの初期化ステップ。

final void invocationEnded (long elapsedTime)

正常に終了したか、何らかのエラー条件により呼び出しが終了したことを報告します。

final void invocationFailed ( FailureDescription failure)

何らかのエラー状態が原因で不完全な呼び出しを報告します。

final void invocationFailed (Throwable cause)

何らかのエラー状態が原因で不完全な呼び出しを報告します。

void invocationSkipped ( SkipReason reason)

呼び出しがスキップされたと報告します

final void invocationStarted ( IInvocationContext context)

転送用の呼び出しリスナー

final boolean isDisabled ()

オブジェクト全体が無効な場合 (セットアップとティアダウンの両方をスキップする)、True を返します。

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)コールバックはできません。

ログとテストの関連付けを更新します。

processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)

このメソッドを実装して、すべてのテストのメトリクスとログを集計します。

abstract processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs)

既存のメトリックとログから新しいメトリックのセットを生成するには、このメソッドを実装します。

processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs)

このメソッドを実装して、各テストのメトリクスとログを後処理します。

final void setLogSaver ( ILogSaver logSaver)

実装者がファイルを保存できるようにILogSaverを設定します。

void setUp ()

子ポストプロセッサでこのメソッドをオーバーライドして、テストの実行前に初期化します。

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)

ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))の代わりに、終了時刻を直接指定できます。

final 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 testLog (String dataName, LogDataType dataType, InputStreamSource dataStream)

このメソッドを使用して、PostProcessor 実装からファイルをログに記録します。

final void testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)

テスト ログが保存されるときに呼び出されます。

final void testModuleEnded ()

モジュールの実行の終了を報告します。

final void testModuleStarted ( IInvocationContext moduleContext)

モジュールの実行の開始を報告します。

final void testRunEnded (long elapsedTime, runMetrics) testRunEnded (long elapsedTime, runMetrics)

テスト実行の終了を報告します。

final void testRunFailed ( FailureDescription failure)

FailureDescriptionで説明されている障害のため、レポートのテスト実行が完了できませんでした。

final void testRunFailed (String errorMessage)

レポートのテスト実行は、致命的なエラーのため完了できませんでした。

final void testRunStarted (String runName, int testCount, int attemptNumber)

テスト実行の開始を報告します。

final void testRunStarted (String runName, int testCount)

テスト実行コールバック

final void testRunStarted (String runName, int testCount, int attemptNumber, long startTime)

テスト実行の開始を報告します。

final void testRunStopped (long elapsedTime)

ユーザーの要求により、テスト実行が完了前に停止したことをレポートします。

final void testSkipped ( TestDescription test, SkipReason reason)

通常予期しない理由でテストがスキップされ、実行されなかったときに呼び出されます。

final void testStarted ( TestDescription test, long startTime)

testStarted(com.android.tradefed.result.TestDescription)の代わりに、テストの開始時期も指定し、正確な測定のためにERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))と組み合わせます。 。

final void testStarted ( TestDescription test)

テストケースのコールバック

保護されたメソッド

MetricMeasurement.DataType getMetricType ()

必要に応じて、このメソッドをオーバーライドしてメトリック タイプを変更します。

String getRunName ()

パブリックコンストラクター

ベースポストプロセッサ

public BasePostProcessor ()

パブリックメソッド

初期化

public final ITestInvocationListener init (ITestInvocationListener listener)

ポストプロセッサの初期化ステップ。いずれかのテスト コールバックの前に必ず呼び出されるようにします。

パラメーター
listener ITestInvocationListener

戻り値
ITestInvocationListener

呼び出し終了

public final void invocationEnded (long elapsedTime)

正常に終了したか、何らかのエラー条件により呼び出しが終了したことを報告します。

TradeFederation フレームワークによって自動的に呼び出されます。

パラメーター
elapsedTime long : 呼び出しの経過時間 (ミリ秒)

呼び出し失敗

public final void invocationFailed (FailureDescription failure)

何らかのエラー状態が原因で不完全な呼び出しを報告します。

TradeFederation フレームワークによって自動的に呼び出されます。

パラメーター
failure FailureDescription : 失敗の原因を説明するFailureDescription

呼び出し失敗

public final void invocationFailed (Throwable cause)

何らかのエラー状態が原因で不完全な呼び出しを報告します。

TradeFederation フレームワークによって自動的に呼び出されます。

パラメーター
cause Throwable : Throwableの失敗の原因

呼び出しがスキップされました

public void invocationSkipped (SkipReason reason)

呼び出しがスキップされたと報告します

パラメーター
reason SkipReason

呼び出し開始

public final void invocationStarted (IInvocationContext context)

転送用の呼び出しリスナー

パラメーター
context IInvocationContext : 呼び出しに関する情報

無効になっています

public final boolean isDisabled ()

オブジェクト全体が無効な場合 (セットアップとティアダウンの両方をスキップする)、True を返します。それ以外の場合は false。

戻り値
boolean

ログ関連付け

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

プロセスすべてのテストメトリクスとログ

public  processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, 
                 allTestLogs)

このメソッドを実装して、すべてのテストのメトリクスとログを集計します。このメソッドから得られるメトリクスは、実行メトリクスとしてレポーターになります。新しく生成されたメトリクスのみを、一意のキー名とともに返す必要があります (既存のキーとの衝突は許可されません)。

パラメーター
allTestMetrics ListMultimap : メトリック名ごとにグループ化された各テストのメトリックを保存する HashMultimap。

allTestLogs : 各テストのTestDescriptionキーとして使用し、データ名をキーとする各テストのログ ファイルのマップを保存するマップ。

戻り値
すべてのテスト メトリックから新しく生成されたメトリックのセット。

プロセス実行メトリクスとログ

public abstract  processRunMetricsAndLogs ( rawMetrics, 
                 runLogs)

既存のメトリックとログから新しいメトリックのセットを生成するには、このメソッドを実装します。新しく生成されたメトリクスのみを、一意のキー名とともに返す必要があります (既存のキーとの衝突は許可されません)。

パラメーター
rawMetrics : 実行に使用できる生のメトリクスのセット。

runLogs : テスト実行のログ ファイルのセット。

戻り値
実行メトリクスから新しく生成されたメトリクスのセット。

プロセステストメトリクスとログ

public  processTestMetricsAndLogs (TestDescription testDescription, 
                 testMetrics, 
                 testLogs)

このメソッドを実装して、各テストのメトリクスとログを後処理します。新しく生成されたメトリクスのみを、一意のキー名とともに返す必要があります (既存のキーとの衝突は許可されません)。

パラメーター
testDescription TestDescription : テストを説明する TestDescription オブジェクト。

testMetrics : テストからのメトリクスのセット。

testLogs : テスト中に記録されたファイルのセット。

戻り値
テスト メトリクスから新たに生成されたメトリクスのセット。

setLogSaver

public final void setLogSaver (ILogSaver logSaver)

実装者がファイルを保存できるようにILogSaverを設定します。

パラメーター
logSaver ILogSaver : ILogSaver

設定

public void setUp ()

子ポストプロセッサでこのメソッドをオーバーライドして、テストの実行前に初期化します。

テスト仮定失敗

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 final 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 testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

このメソッドを使用して、PostProcessor 実装からファイルをログに記録します。

パラメーター
dataName String : データを説明するString名。たとえば、「device_logcat」。 dataName は呼び出しごとに一意ではない場合があることに注意してください。つまり、実装者は同じ dataName で複数の呼び出しを処理できなければなりません

dataType LogDataType : データのLogDataType

dataStream InputStreamSource : データのInputStreamSource 。実装者は、createInputStream を呼び出してデータの読み取りを開始し、完了したら結果として得られた InputStream を確実に閉じる必要があります。呼び出し元は、testLog メソッドが完了するまで、データのソースが存在し、アクセス可能な状態にあることを確認する必要があります。

テストログが保存されました

public final void testLogSaved (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream, 
                LogFile logFile)

テスト ログが保存されるときに呼び出されます。

ITestInvocationListener#testLog(String, LogDataType, InputStreamSource)の代わりに使用する必要があります。

パラメーター
dataName String : データを説明するString名。たとえば、「device_logcat」。 dataName は呼び出しごとに一意ではない場合があることに注意してください。つまり、実装者は同じ dataName で複数の呼び出しを処理できなければなりません

dataType LogDataType : データのLogDataType

dataStream InputStreamSource : データのInputStreamSource 。実装者は、createInputStream を呼び出してデータの読み取りを開始し、完了したら結果として得られた InputStream を確実に閉じる必要があります。

logFile LogFile : 保存されたファイルのメタデータを含むLogFile

テストモジュール終了

public final void testModuleEnded ()

モジュールの実行の終了を報告します。

テストモジュールが開始されました

public final void testModuleStarted (IInvocationContext moduleContext)

モジュールの実行の開始を報告します。このコールバックはtestModuleEnded()に関連付けられており、シーケンス内ではオプションです。これは、モジュール (スイート ベースのランナー) を使用する実行中にのみ使用されます。

パラメーター
moduleContext IInvocationContext : モジュールのIInvocationContext

テスト実行終了

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

テスト実行の終了を報告します。修正: タイプの異なる 2 つの Map<> インターフェイスを使用することはできないため、ここでは HashMap を使用する必要があります。

パラメーター
elapsedTime long : デバイスが報告した経過時間 (ミリ秒単位)

runMetrics : Metricを使用したテスト実行の終了時に報告されたキーと値のペア。

テスト実行失敗

public final void testRunFailed (FailureDescription failure)

FailureDescriptionで説明される障害のため、レポートのテスト実行が完了できませんでした。

パラメーター
failure FailureDescription : 失敗とそのコンテキストを説明するFailureDescription

テスト実行失敗

public final void testRunFailed (String errorMessage)

レポートのテスト実行は、致命的なエラーのため完了できませんでした。

パラメーター
errorMessage String : 実行失敗の理由を説明するString

テスト実行開始しました

public final 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 final 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 testRunStopped (long elapsedTime)

ユーザーの要求により、テスト実行が完了前に停止したことをレポートします。

TODO: 現在使用されていないため、削除することを検討してください

パラメーター
elapsedTime long : デバイスが報告した経過時間 (ミリ秒単位)

テストスキップされました

public final void testSkipped (TestDescription test, 
                SkipReason reason)

通常予期しない理由でテストがスキップされ、実行されなかったときに呼び出されます。これらのテストは、適切な実行を試みるために再試行されます。

パラメーター
test TestDescription : テストを識別します

reason SkipReason : SkipReason

テスト開始

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)

テストケースのコールバック

パラメーター
test TestDescription : テストを識別します

保護されたメソッド

getMetricType

protected MetricMeasurement.DataType getMetricType ()

必要に応じて、このメソッドをオーバーライドしてメトリック タイプを変更します。デフォルトでは、メトリックは処理済みタイプに設定されます。

戻り値
MetricMeasurement.DataType

getRunName

protected String getRunName ()

戻り値
String