このページは Cloud Translation API によって翻訳されました。

ベースポストプロセッサ

public abstract class BasePostProcessor
extends Object implements IPostProcessor

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

既知の直接サブクラス

AggregatePostProcessor 、 AveragePostProcessor 、 BluetoothConnectionSuccessRatePostProcessor 、 MetricFilePostProcessor 、 PerfettoGenericPostProcessor 、 StatsdGenericPostProcessor

集約ポストプロセッサ	複数回の反復テスト実行中に収集された数値メトリクスの最小値、最大値、平均値、分散、標準偏差、合計、カウント、およびオプションでパーセンタイルを提供するメトリクスアグリゲータ。それらを double として扱います。
平均ポストプロセッサ	メトリクスのリストの平均を計算するポストプロセッサの実装。
Bluetooth接続成功率ポストプロセッサ	Bluetooth プロファイルの成功率を計算するポストプロセッサの実装「metric-key-match」を使用して、Bluetooth 接続状態を含むメトリックを数値配列 (例 [0, 1, 2, 3, 0, 1, 2, 3]) で指定します。
メトリックファイルポストプロセッサ	テストおよび実行レベル中に収集されたメトリクスログファイルをアップロードするために使用されます。
PerfettoGenericPostProcessor	数値を持つフィールドが見つかるまでプロトメッセージと文字列値を持つフィールドを再帰的に展開することにより、テキスト/バイナリメトリクス perfetto proto ファイルをキーと値のペアに処理するポストプロセッサー。
StatsdGenericPostProcessor	レポートをツリー構造として展開することにより、バイナリ proto statsd レポートをキーと値のペアに処理するポストプロセッサー。

既知の間接サブクラス

StatsdBeforeAfterGaugeMetricPostProcessor 、 StatsdEventMetricPostProcessor

StatsdBeforeAfterGaugeMetricPostProcessor	「前/後」アプローチで収集されたゲージメトリクスを処理するポストプロセッサ。
StatsdEventMetricPostProcessor	プロセッサ上で指定されたフォーマッタを使用して、statsd レポート内のイベントメトリックをキーと値のペアに処理するポストプロセッサ。

すべての実装が拡張する必要がある基本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)`で関連付けることができます。 `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 ()`

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

ベースポストプロセッサ

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 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 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`