BaseDeviceMetricCollector

public class BaseDeviceMetricCollector
extends Object implements IDeviceActionReceiver, IMetricCollector

java.lang.Object
   ↳ com.android.tradefed.device.metric.BaseDeviceMetricCollector

収集の開始と停止を可能にする IMetricCollector の基本実装 onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData) と ERROR(/#onTestRunEnd(com.android.tradefed.device.metric.DeviceMetricData,Map))。

概要

フィールド

public static final String TEST_CASE_EXCLUDE_GROUP_OPTION

public static final String TEST_CASE_INCLUDE_GROUP_OPTION

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

BaseDeviceMetricCollector()

パブリック メソッド

void extraInit(IInvocationContext context, ITestInvocationListener listener)
final getBuildInfos()

呼び出しで使用できるビルド情報のリストを返します。

final getDevices()

呼び出しで使用可能なデバイスのリストを返します。

File getFileFromTestArtifacts(String fileName)

テスト アーティファクトまたはモジュール アーティファクトとキャッシュからファイルを取得する 後続の呼び出し用にマップで使用します。

final ITestInvocationListener getInvocationListener()

結果の転送先となる元の ITestInvocationListener を返します。

String getModuleName()
final getRealDevices()

getDevices() リストからスタブ以外のデバイスをすべて返します。

String getRunName()

コレクタをトリガーするテスト実行 mRunName の名前を返します。

final ITestInvocationListener init(IInvocationContext context, 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 を返します（セットアップとティアダウンの両方をスキップ）。

boolean isDisabledReceiver()

IDeviceActionReceiver が無効かどうか。

final void logAssociation(String dataName, LogFile logFile)

指標コレクタの実装内で使用しないでください。

void onTestAssumptionFailure(DeviceMetricData testData, TestDescription test)

テストケースが仮定エラーで失敗したときに呼び出されるコールバック。

void onTestEnd(DeviceMetricData testData, currentTestCaseMetrics, TestDescription test)

テストケースが終了したときに呼び出されるコールバック。

void onTestEnd(DeviceMetricData testData, currentTestCaseMetrics)

テストケースが終了したときに呼び出されるコールバック。

void onTestFail(DeviceMetricData testData, TestDescription test)

テストケースが失敗した場合のコールバック。

void onTestModuleEnded()

モジュール終了イベントをキャプチャできるようにします。

void onTestModuleStarted()

モジュール開始イベントをキャプチャできるようにします。

void onTestRunEnd(DeviceMetricData runData, currentRunMetrics)

テスト実行が終了したときのコールバック。

void onTestRunFailed(DeviceMetricData testData, FailureDescription failure)

testRunFailed イベントのコールバック

void onTestRunStart(DeviceMetricData runData)

テスト実行が開始されたときのコールバック。

void onTestStart(DeviceMetricData testData)

テストケースが開始されたときのコールバック。

void rebootEnded(ITestDevice device)

デバイスで再起動が終了したときに通知が届きます。

void rebootStarted(ITestDevice device)

デバイスで再起動が開始すると通知が届きます。

final void setDisable(boolean isDisabled)

オブジェクトを無効にするかどうかを設定します。

void setDisableReceiver(boolean isDisabled)

IDeviceActionReceiver を無効にするかどうかを設定します。

final void setLogSaver(ILogSaver logSaver)

指標コレクタの実装内で使用しないでください。

final void testAssumptionFailure(TestDescription test, String trace)

アトミック テストで、条件が false であるとフラグが立てられたときに呼び出されます

final void testAssumptionFailure(TestDescription test, FailureDescription failure)

アトミック テストで、条件が false であるとフラグが立てられたときに呼び出されます

final void testEnded(TestDescription test, long endTime, testMetrics)

終了時間を指定できる ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) の代替 直接渡されます。

final void 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)

テスト呼び出しの関連ログまたはデバッグデータを提供します。

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)

テスト実行の終了をレポートします。

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)

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

フィールド

TEST_CASE_EXCLUDE_GROUP_OPTION。

public static final String TEST_CASE_EXCLUDE_GROUP_OPTION

TEST_CASE_INCLUDE_GROUP_OPTION

public static final String TEST_CASE_INCLUDE_GROUP_OPTION

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

BaseDeviceMetricCollector

public BaseDeviceMetricCollector ()

パブリック メソッド

extraInit

public void extraInit (IInvocationContext context, 
                ITestInvocationListener listener)

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getBuildInfo

public final  getBuildInfos ()

呼び出しで使用できるビルド情報のリストを返します。

戻り値

getDevices

public final  getDevices ()

呼び出しで使用可能なデバイスのリストを返します。

戻り値

getFileFromTestArtifacts

public File getFileFromTestArtifacts (String fileName)

テスト アーティファクトまたはモジュール アーティファクトとキャッシュからファイルを取得する 後続の呼び出し用にマップで使用します。

パラメータ
fileName String: アーティファクトで検索するファイルの名前。
戻り値
File テスト アーティファクトまたはモジュール アーティファクトのファイル。null を返す ファイルが見つからない場合は

getInvocationListener

public final ITestInvocationListener getInvocationListener ()

結果の転送先となる元の ITestInvocationListener を返します。

戻り値
ITestInvocationListener

getModuleName

public String getModuleName ()

戻り値
String

getRealDevices

public final  getRealDevices ()

getDevices() リストからスタブ以外のデバイスをすべて返します。

戻り値

getRunName

public String getRunName ()

コレクタをトリガーするテスト実行 mRunName の名前を返します。

戻り値
String mRunName。現在のテスト実行名。

init

public final ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

現在のコンテキストと結果の転送先でコレクタを初期化します。ウィル インスタンスごとに 1 回だけ呼び出され、コレクタは自身の内部 コンテキストとリスナー。テスト実行中に init が呼び出されることはありません。

自分が何をしているかを明確にしていない限り、オーバーライドしないでください。

パラメータ
context IInvocationContext: 進行中の呼び出しの IInvocationContext。
listener ITestInvocationListener: 結果を配置する ITestInvocationListener。
戻り値
ITestInvocationListener 元のリスナーをラップする新しいリスナーです。
例外
DeviceNotAvailableException

invocationEnded

public final void invocationEnded (long elapsedTime)

正常に終了したか、なんらかのエラーが発生したために呼び出しが終了したことを報告する あります。

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

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

invocationFailed

public final void invocationFailed (FailureDescription failure)

エラー条件により不完全な呼び出しを報告します。

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

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

invocationFailed

public final void invocationFailed (Throwable cause)

エラー条件により不完全な呼び出しを報告します。

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

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

invocationSkipped

public void invocationSkipped (SkipReason reason)

呼び出しをスキップ済みとして報告する

パラメータ
reason SkipReason

invocationStarted

public final void invocationStarted (IInvocationContext context)

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

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

isDisabled

public final boolean isDisabled ()

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

戻り値
boolean

isDisabledReceiver

public boolean isDisabledReceiver ()

IDeviceActionReceiver が無効かどうか。

戻り値
boolean 無効の場合は true、それ以外の場合は false を返します。

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

指標コレクタの実装内で使用しないでください。これは純粋な転送です。

パラメータ
dataName String: データの名前
logFile LogFile: 以前にログに記録された LogFile に関連付ける必要があります。 テストケースです

onTestAssumptionFailure

public void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

テストケースが仮定エラーで失敗したときに呼び出されるコールバック。

パラメータ
testData DeviceMetricData: テストケースのデータを保持する DeviceMetricData。
test TestDescription: 進行中のテストケースの TestDescription。
例外
DeviceNotAvailableException

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics, 
                TestDescription test)

テストケースが終了したときに呼び出されるコールバック。この時点でクリーンアップを行います。

パラメータ
testData DeviceMetricData: テストケースのデータを保持する DeviceMetricData。アップグレード前の onTestStart(com.android.tradefed.device.metric.DeviceMetricData) のときと同じオブジェクトです。
currentTestCaseMetrics : ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) に渡される指標の現在のマップ。
test TestDescription: 進行中のテストケースの TestDescription。
例外
DeviceNotAvailableException

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics)

テストケースが終了したときに呼び出されるコールバック。この時点でクリーンアップを行います。

パラメータ
testData DeviceMetricData: テストケースのデータを保持する DeviceMetricData。アップグレード前の onTestStart(com.android.tradefed.device.metric.DeviceMetricData) のときと同じオブジェクトです。
currentTestCaseMetrics : ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) に渡される指標の現在のマップ。
例外
DeviceNotAvailableException

onTestFail

public void onTestFail (DeviceMetricData testData, 
                TestDescription test)

テストケースが失敗した場合のコールバック。

パラメータ
testData DeviceMetricData: テストケースのデータを保持する DeviceMetricData。
test TestDescription: 進行中のテストケースの TestDescription。
例外
DeviceNotAvailableException

onTestModuleEnded

public void onTestModuleEnded ()

モジュール終了イベントをキャプチャできるようにします。

例外
DeviceNotAvailableException

onTestModuleStarted

public void onTestModuleStarted ()

モジュール開始イベントをキャプチャできるようにします。

例外
DeviceNotAvailableException

onTestRunEnd

public void onTestRunEnd (DeviceMetricData runData, 
                 currentRunMetrics)

テスト実行が終了したときのコールバック。この時点でクリーンアップを行います。

パラメータ
runData DeviceMetricData: 実行のデータを保持する DeviceMetricData。変更なし オブジェクト（onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData) など）。
currentRunMetrics : ERROR(/#testRunEnded(long,Map)) に渡される指標の現在のマップ。
例外
DeviceNotAvailableException

onTestRunFailed

public void onTestRunFailed (DeviceMetricData testData, 
                FailureDescription failure)

testRunFailed イベントのコールバック

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestRunStart

public void onTestRunStart (DeviceMetricData runData)

テスト実行が開始されたときのコールバック。

パラメータ
runData DeviceMetricData: 実行のデータを保持する DeviceMetricData。
例外
DeviceNotAvailableException

onTestStart

public void onTestStart (DeviceMetricData testData)

テストケースが開始されたときのコールバック。

パラメータ
testData DeviceMetricData: テストケースのデータを保持する DeviceMetricData。
例外
DeviceNotAvailableException

restartEnded

public void rebootEnded (ITestDevice device)

デバイスで再起動が終了したときに通知が届きます。

注: レシーバはこのコールバック中に再起動しないようにしてください。再起動を試みると、 無視されます。

パラメータ
device ITestDevice: 再起動が終了した ITestDevice。
例外
DeviceNotAvailableException

returnStarted（再起動の開始）

public void rebootStarted (ITestDevice device)

デバイスで再起動が開始すると通知が届きます。

注: レシーバはこのコールバック中に再起動しないようにしてください。再起動を試みると、 無視されます。

パラメータ
device ITestDevice: 再起動が開始された ITestDevice。
例外
DeviceNotAvailableException

setDisable

public final void setDisable (boolean isDisabled)

オブジェクトを無効にするかどうかを設定します。無効とはセットアップと破棄の両方のステップが スキップすべきですデフォルト状態で使用するオブジェクトをデフォルトで無効にするために コンストラクタがあります。

パラメータ
isDisabled boolean: オブジェクトを配置する状態。

setDisableReceiver

public void setDisableReceiver (boolean isDisabled)

IDeviceActionReceiver を無効にするかどうかを設定します。無効にすると デバイス アクション イベントを受信するデバイスに登録されていない。

パラメータ
isDisabled boolean

setLogSaver

public final void setLogSaver (ILogSaver logSaver)

指標コレクタの実装内で使用しないでください。これは純粋な転送です。

パラメータ
logSaver ILogSaver: ILogSaver

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。

testEnded

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)

testEnded

public final void testEnded (TestDescription test, 
                 testMetrics)

個々のテストケースの実行終了を報告します。

testFailed(TestDescription, FailureDescription) が呼び出されなかった場合、このテストは合格です。また、任意の Key-Value を返します。 テストケースの実行中に出力された可能性のある指標を示します。

パラメータ
test TestDescription: テストを識別します。
testMetrics : 出力された指標の ERROR(/Map)

testFailed

public final void testFailed (TestDescription test, 
                FailureDescription failure)

個々のテストケースの失敗を報告します。

testStarted と testEnded の間で呼び出されます。

パラメータ
test TestDescription: テストを識別します。
failure FailureDescription: エラーとそのコンテキストを記述する FailureDescription。

testFailed

public final void testFailed (TestDescription test, 
                String trace)

個々のテストケースの失敗を報告します。

testStarted と testEnded の間で呼び出されます。

パラメータ
test TestDescription: テストを識別します。
trace String: 障害のスタック トレース

testIgnored

public final void testIgnored (TestDescription test)

テストが実行されないときに呼び出されます。通常はテストメソッドに org.junit.Ignore を使用します。

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

testLog

public final void testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

テスト呼び出しの関連ログまたはデバッグデータを提供します。

ERROR(/ITestInvocationListener#invocationFailed(Throwable)) または ERROR(/ITestInvocationListener#invocationEnded(long))

TradeFederation フレームワークは自動的にこのメソッドを呼び出し、ホストログを提供します。 デバイスの logcat（該当する場合）

パラメータ
dataName String: 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)

指標コレクタの実装内で使用しないでください。これは純粋な転送です。

パラメータ
dataName String: 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() に関連付けられており、シーケンスでは省略可能です。これは、Pod を使用する実行時にのみ スイートベースのランナーです。

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

testRunEnded

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

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

パラメータ
elapsedTime long: デバイスで報告された経過時間（ミリ秒単位）
runMetrics : Metric を使用してテスト実行の最後にレポートされる Key-Value ペア。

testRunFailed

public final void testRunFailed (FailureDescription failure)

FailureDescription で説明されているエラーのため、テスト実行を完了できなかったことをレポートします。

パラメータ
failure FailureDescription: エラーとそのコンテキストを記述する FailureDescription。

testRunFailed

public final void testRunFailed (String errorMessage)

致命的なエラーのため、テスト実行を完了できなかったことをレポートします。

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

testRunStarted

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

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

パラメータ
runName String: テスト実行名
testCount int: テスト実行中のテストの合計数
attemptNumber int: 同じ runName の異なる試行を識別する注文番号 実行されるリソースのことですtryNumber の値は、0 から始まる番号で、毎回増分する必要があります。 発生します。例:テストは詳細に 3 回再試行され、合計 4 回試行される必要がある 同じ runName で実行され、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 の異なる試行を識別する注文番号 実行されるリソースのことですtryNumber の値は 0 から始まり、 発生します。例:テストを細かく 3 回再試行する（合計 4 回の実行が必要） 同じ runName で指定され、trialNumber は 0 ～ 3 です。
startTime long: 実行の開始時刻（System.currentTimeMillis() で測定）

testRunStopped

public final void testRunStopped (long elapsedTime)

ユーザー リクエストが原因で、テスト実行が完了前に停止したことを報告します。

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

パラメータ
elapsedTime long: デバイスで報告された経過時間（ミリ秒単位）

testSkipped

public final void testSkipped (TestDescription test, 
                SkipReason reason)

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

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

testStarted

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() で測定）

testStarted

public final void testStarted (TestDescription test)

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

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