BasePostProcessor

public abstract class BasePostProcessor
extends Object implements IPostProcessor

java.lang.Object
↳ 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)

何らかのエラー状態による不完全な呼び出しを報告します。

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

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

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 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 ()

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

BasePostProcessor

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 : ERROR(/Throwable)失敗の原因

呼び出し開始

public final void invocationStarted (IInvocationContext context)

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

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

無効になっています

public final boolean isDisabled ()

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

戻り値
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)コールバックはできません。したがって、このコールバックにより、強い関連付けを明示的に提供できます。

ログとテストの関連付けを更新します。テスト中にこのメソッドが呼び出された場合、ログはテストに属します。それ以外の場合は実行ログになります。

パラメーター
dataName String : データの名前

logFile LogFile : 以前にログに記録され、テスト ケースに関連付ける必要があるLogFile 。

processAllTestMetricsAndLogs

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

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

パラメーター
allTestMetrics ListMultimap : メトリック名でグループ化された各テストからのメトリックを格納する HashMultimap。

allTestLogs : 各テストのTestDescriptionをキーとして使用して、データ名でキー付けされたログ ファイルの各テストのマップを格納するマップ。

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

processRunMetricsAndLogs

public abstract  processRunMetricsAndLogs ( rawMetrics, 
                 runLogs)

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

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

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

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

processTestMetricsAndLogs

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 ()

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

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 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 : データのERROR(/String)記述名。例: "device_logcat"。注意 dataName は、呼び出しごとに一意ではない場合があります。つまり、実装者は同じ dataName で複数の呼び出しを処理できなければなりません

dataType LogDataType : データのLogDataType

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

testLogSaved

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

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

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

パラメーター
dataName String : データのERROR(/String)記述名。例: "device_logcat"。注意 dataName は、呼び出しごとに一意ではない場合があります。つまり、実装者は同じ dataName で複数の呼び出しを処理できなければなりません

dataType LogDataType : データのLogDataType

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

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

testModuleEnded

public final void testModuleEnded ()

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

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

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

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

testRunEnded

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

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

パラメーター
elapsedTime 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 final 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 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 : 実行が開始された時間、 ERROR(/System#currentTimeMillis())で測定

testRunStopped

public final void testRunStopped (long elapsedTime)

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

TODO: 現在使用されていません。削除を検討してください

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

テスト開始

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)

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

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

保護されたメソッド

getMetricType

protected MetricMeasurement.DataType getMetricType ()

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

戻り値
MetricMeasurement.DataType

getRunName

protected String getRunName ()

戻り値
String