BaseDeviceMetricCollector

public class BaseDeviceMetricCollector
extends Object implements IMetricCollector , IDeviceActionReceiver

java.lang.オブジェクト
↳ com.android.tradefed.device.metric.BaseDeviceMetricCollector

onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData)およびERROR(/#onTestRunEnd(com.android.tradefed.device.metric.DeviceMetricData,Map))で収集を開始および停止できるIMetricCollectorの基本実装。

まとめ

田畑

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)

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

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) onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics, TestDescription test)

テストケース終了時のコールバック。

void onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics) onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics)

テストケース終了時のコールバック。

void onTestFail ( DeviceMetricData testData, TestDescription test)

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

void onTestModuleEnded ()

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

void onTestModuleStarted ()

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

void onTestRunEnd ( DeviceMetricData runData, currentRunMetrics) 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) 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)

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

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)

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

田畑

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

パブリックメソッド

余分な初期化

public void extraInit (IInvocationContext context, 
                ITestInvocationListener listener)

投げる
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getBuildInfos

public final  getBuildInfos ()

呼び出しで利用可能なビルド情報のリストを返します。

戻り値

デバイスの取得

public final  getDevices ()

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

戻り値

getFileFromTestArtifacts

public File getFileFromTestArtifacts (String fileName)

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

パラメーター
fileName String : アーティファクト内で検索するファイルの名前。

戻り値
Fileテスト アーティファクトまたはモジュール アーティファクトからのファイル。ファイルが見つからない場合は null を返します。

getInvocationListener

public final ITestInvocationListener getInvocationListener ()

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

戻り値
ITestInvocationListener

getモジュール名

public String getModuleName ()

戻り値
String

getRealDevices

public final  getRealDevices ()

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

戻り値

getRunName

public String getRunName ()

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

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

初期化

public final ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

現在のコンテキストと結果の転送先を使用したコレクターの初期化。インスタンスごとに 1 回だけ呼び出され、コレクターは内部コンテキストとリスナーを更新することが期待されます。常に以前のテスト実行中に Init が呼び出されることはありません。

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

パラメーター
context IInvocationContext : 進行中の呼び出しのIInvocationContext 。

listener ITestInvocationListener : 結果を格納するITestInvocationListener 。

戻り値
ITestInvocationListener元のリスナーをラップする新しいリスナー。

投げる
DeviceNotAvailableException

呼び出し終了

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

isDisabledReceiver

public boolean isDisabledReceiver ()

IDeviceActionReceiverが無効になっているかどうか。

戻り値
boolean無効な場合は true を返し、そうでない場合は false を返します。

ログ関連付け

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

テスト終了時

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

テスト終了時

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

onTestModule終了

public void onTestModuleEnded ()

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

投げる
DeviceNotAvailableException

onTestModuleStarted

public void onTestModuleStarted ()

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

投げる
DeviceNotAvailableException

テスト実行終了時

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

テスト開始時

public void onTestStart (DeviceMetricData testData)

テストケース開始時のコールバック。

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

投げる
DeviceNotAvailableException

再起動終了しました

public void rebootEnded (ITestDevice device)

デバイスの再起動が終了したときに通知を受け取ります。

注: 受信者は、このコールバック中に再起動しないようにする必要があります。再起動の試行は無視されます。

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

投げる
DeviceNotAvailableException

再起動開始しました

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

テスト仮定失敗

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)

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

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 メソッドが完了するまで、データのソースが存在し、アクセス可能な状態にあることを確認する必要があります。

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

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 。

テストモジュール終了

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 : テストを識別します