BaseDeviceMetricCollector
public class BaseDeviceMetricCollector
extends Object
implements IMetricCollector , IDeviceActionReceiver
java.lang.Object | |
↳ | 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 () 結果を転送する元の |
String | getModuleName () |
final | getRealDevices () |
String | getRunName () コレクターをトリガーするテスト実行 |
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 () |
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) |
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) |
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) |
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) |
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 finalgetBuildInfos ()
呼び出しで利用可能なビルド情報のリストを返します。
戻り値 | |
---|---|
getDevices
public finalgetDevices ()
呼び出しで使用可能なデバイスのリストを返します。
戻り値 | |
---|---|
getFileFromTestArtifacts
public File getFileFromTestArtifacts (String fileName)
テスト成果物またはモジュール成果物からファイルを取得し、後続の呼び出しのためにマップにキャッシュします。
パラメーター | |
---|---|
fileName | String : 成果物で検索するファイルの名前。 |
戻り値 | |
---|---|
File | テスト成果物またはモジュール成果物からのファイル。ファイルが見つからない場合は null を返します。 |
getInvocationListener
public final ITestInvocationListener getInvocationListener ()
結果を転送する元のITestInvocationListener
を返します。
戻り値 | |
---|---|
ITestInvocationListener |
getModuleName
public String getModuleName ()
戻り値 | |
---|---|
String |
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 : ERROR(/Throwable) 失敗の原因 |
呼び出し開始
public final void invocationStarted (IInvocationContext context)
転送用の呼び出しリスナー
パラメーター | |
---|---|
context | IInvocationContext : 呼び出しに関する情報 |
無効になっています
public final boolean isDisabled ()
オブジェクト全体が無効になっている場合は True を返します (セットアップとティアダウンの両方をスキップします)。それ以外の場合は偽。
戻り値 | |
---|---|
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 |
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 |
再起動終了
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 |
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)
テスト呼び出しから関連するログまたはデバッグ データを提供します。
ERROR(/ITestInvocationListener#invocationFailed(Throwable))
またはERROR(/ITestInvocationListener#invocationEnded(long))
の前に呼び出す必要がありますTradeFederation フレームワークは、このメソッドを自動的に呼び出し、ホスト ログと、該当する場合はデバイスの logcat を提供します。パラメーター | |
---|---|
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)
メトリック コレクターの実装内では使用しないでください。これは純粋な転送です。
パラメーター | |
---|---|
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 : テストを識別します |