IMetricCollector
public
interface
IMetricCollector
implements
IDisableable,
ILogSaverListener
| com.android.tradefed.device.metric.IMetricCollector |
このインターフェースは、一致する指標を収集するためにテスト結果を報告する際にデコレータとして追加されます。
このインターフェースは ITestInvocationListener を拡張しても
コレクタは複数の場所で再利用される可能性があるため、内部状態を保持することは想定されていません。内部状態をどうしても使用する必要がある場合は、init(IInvocationContext,ITestInvocationListener) でクリーンアップする必要があります。
概要
パブリック メソッド | |
|---|---|
default
boolean
|
captureModuleLevel()
コレクタがモジュール レベルのキャプチャに適用可能かどうか、初期化する必要があるかどうか。 |
default
boolean
|
doesModuleContainFailure()
現在のモジュールにテストケースまたはテスト実行の失敗が含まれている場合は true を返します。 |
default
void
|
enableDefaultMetricCollection()
コレクタがデフォルトの指標の収集を有効にできるようにします。 |
default
IMetricCollector.MetricCollectionLevel
|
getAlwaysOnCollectionLevel()
|
abstract
List<IBuildInfo>
|
getBuildInfos()
呼び出しで使用可能なビルド情報のリストを返します。 |
abstract
List<ITestDevice>
|
getDevices()
呼び出しで使用可能なデバイスのリストを返します。 |
abstract
ITestInvocationListener
|
getInvocationListener()
結果を転送する元の |
default
IMetricCollector.MetricCollectionLevel
|
getOnFailureCollectionLevel()
|
abstract
ITestInvocationListener
|
init(IInvocationContext context, ITestInvocationListener listener)
現在のコンテキストと結果の転送先でコレクタを初期化します。 |
default
boolean
|
isDefaultMetricCollectionEnabled()
コレクタがデフォルトの指標収集の一部として指標を収集しているかどうか。 |
abstract
void
|
onTestAssumptionFailure(DeviceMetricData testData, TestDescription test)
前提条件の失敗によりテストケースが失敗した場合のコールバック。 |
abstract
void
|
onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, TestDescription test)
テストケースが終了したときに呼び出されるコールバック。 |
abstract
void
|
onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)
テストケースが終了したときに呼び出されるコールバック。 |
abstract
void
|
onTestFail(DeviceMetricData testData, TestDescription test)
テストケースが失敗したときに呼び出されるコールバック。 |
default
void
|
onTestModuleEnded()
モジュールの終了イベントのキャプチャを許可します。 |
default
void
|
onTestModuleStarted()
モジュールの開始イベントのキャプチャを許可します。 |
abstract
void
|
onTestRunEnd(DeviceMetricData runData, Map<String, MetricMeasurement.Metric> currentRunMetrics)
テスト実行が終了したときに呼び出されるコールバック。 |
abstract
void
|
onTestRunStart(DeviceMetricData runData)
テスト実行が開始されたときのコールバック。 |
default
void
|
onTestRunStart(DeviceMetricData runData, int testCount)
テスト実行が開始されたときのコールバック。 |
default
void
|
onTestRunStartBlocking()
コレクタがサポートしている場合、コレクタを手動で開始するための明示的なコールバック。 |
abstract
void
|
onTestStart(DeviceMetricData testData)
テストケースが開始されたときのコールバック。 |
default
void
|
setAlwaysOnCollectionLevel(IMetricCollector.MetricCollectionLevel level)
障害に関係なくコレクタがログを収集するレベルを設定します。 |
default
void
|
setModuleContainsFailure()
モジュールに失敗（テストケース、テスト実行）があったかどうかを設定します。 |
default
void
|
setOnFailureCollectionLevel(IMetricCollector.MetricCollectionLevel level)
障害発生時にコレクタがログを収集するレベルを設定します。 |
パブリック メソッド
captureModuleLevel
public boolean captureModuleLevel ()
コレクタがモジュール レベルのキャプチャに適用可能かどうか、初期化する必要があるかどうか。
| 戻り値 | |
|---|---|
boolean |
|
doesModuleContainFailure
public boolean doesModuleContainFailure ()
現在のモジュールにテストケースまたはテスト実行の失敗が含まれている場合は true を返します。
| 戻り値 | |
|---|---|
boolean |
|
enableDefaultMetricCollection
public void enableDefaultMetricCollection ()
コレクタがデフォルトの指標収集を有効にできるようにします。デフォルトの指標収集が有効になっている場合、コレクタは指定された収集レベルでのみ収集する必要があります。
getAlwaysOnCollectionLevel
public IMetricCollector.MetricCollectionLevel getAlwaysOnCollectionLevel ()
| 戻り値 | |
|---|---|
IMetricCollector.MetricCollectionLevel |
|
getBuildInfos
public abstract List<IBuildInfo> getBuildInfos ()
呼び出しで使用可能なビルド情報のリストを返します。
| 戻り値 | |
|---|---|
List<IBuildInfo> |
|
getDevices
public abstract List<ITestDevice> getDevices ()
呼び出しで使用可能なデバイスのリストを返します。
| 戻り値 | |
|---|---|
List<ITestDevice> |
|
getInvocationListener
public abstract ITestInvocationListener getInvocationListener ()
結果を転送する元の ITestInvocationListener を返します。
| 戻り値 | |
|---|---|
ITestInvocationListener |
|
getOnFailureCollectionLevel
public IMetricCollector.MetricCollectionLevel getOnFailureCollectionLevel ()
| 戻り値 | |
|---|---|
IMetricCollector.MetricCollectionLevel |
|
init
public abstract ITestInvocationListener init (IInvocationContext context, ITestInvocationListener listener)
現在のコンテキストと結果の転送先を指定してコレクタを初期化します。インスタンスごとに 1 回だけ呼び出されます。コレクタは内部コンテキストとリスナーを更新することが想定されています。テスト実行中に Init が呼び出されることはありません。常にその前に呼び出されます。
何をしているのかを理解していない限り、オーバーライドしないでください。
| パラメータ | |
|---|---|
context |
IInvocationContext: 進行中の呼び出しの IInvocationContext。 |
listener |
ITestInvocationListener: 結果を配置する ITestInvocationListener。 |
| 戻り値 | |
|---|---|
ITestInvocationListener |
新しいリスナーが元のリスナーをラップします。 |
| 例外 | |
|---|---|
DeviceNotAvailableException |
|
isDefaultMetricCollectionEnabled
public boolean isDefaultMetricCollectionEnabled ()
コレクタがデフォルトの指標収集の一部として指標を収集しているかどうか。
| 戻り値 | |
|---|---|
boolean |
|
onTestAssumptionFailure
public abstract void onTestAssumptionFailure (DeviceMetricData testData, TestDescription test)
前提条件の失敗によりテストケースが失敗した場合のコールバック。
| パラメータ | |
|---|---|
testData |
DeviceMetricData: テストケースのデータを保持する DeviceMetricData。 |
test |
TestDescription: 進行中のテストケースの TestDescription。 |
| 例外 | |
|---|---|
DeviceNotAvailableException |
|
onTestEnd
public abstract void onTestEnd (DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, TestDescription test)
テストケースが終了したときに呼び出されるコールバック。このタイミングでクリーンアップを行う必要があります。
| パラメータ | |
|---|---|
testData |
DeviceMetricData: テストケースのデータを保持する DeviceMetricData。onTestStart(DeviceMetricData) のときと同じオブジェクトになります。 |
currentTestCaseMetrics |
Map: testEnded(TestDescription,Map) に渡される指標の現在のマップ。 |
test |
TestDescription: 進行中のテストケースの TestDescription。 |
| 例外 | |
|---|---|
DeviceNotAvailableException |
|
onTestEnd
public abstract void onTestEnd (DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)
テストケースが終了したときに呼び出されるコールバック。このタイミングでクリーンアップを行う必要があります。
| パラメータ | |
|---|---|
testData |
DeviceMetricData: テストケースのデータを保持する DeviceMetricData。onTestStart(DeviceMetricData) のときと同じオブジェクトになります。 |
currentTestCaseMetrics |
Map: testEnded(TestDescription,Map) に渡される指標の現在のマップ。 |
| 例外 | |
|---|---|
DeviceNotAvailableException |
|
onTestFail
public abstract void onTestFail (DeviceMetricData testData, TestDescription test)
テストケースが失敗したときに呼び出されるコールバック。
| パラメータ | |
|---|---|
testData |
DeviceMetricData: テストケースのデータを保持する DeviceMetricData。 |
test |
TestDescription: 進行中のテストケースの TestDescription。 |
| 例外 | |
|---|---|
DeviceNotAvailableException |
|
onTestModuleEnded
public void onTestModuleEnded ()
モジュール終了イベントのキャプチャを許可します。
| 例外 | |
|---|---|
|
com.android.tradefed.device.DeviceNotAvailableException |
DeviceNotAvailableException |
|
onTestModuleStarted
public void onTestModuleStarted ()
モジュールの開始イベントのキャプチャを許可します。
| 例外 | |
|---|---|
|
com.android.tradefed.device.DeviceNotAvailableException |
DeviceNotAvailableException |
|
onTestRunEnd
public abstract void onTestRunEnd (DeviceMetricData runData, Map<String, MetricMeasurement.Metric> currentRunMetrics)
テスト実行が終了したときに呼び出されるコールバック。このタイミングでクリーンアップを行う必要があります。
| パラメータ | |
|---|---|
runData |
DeviceMetricData: 実行のデータを保持する DeviceMetricData。onTestRunStart(DeviceMetricData) のときと同じオブジェクトになります。 |
currentRunMetrics |
Map: testRunEnded(long,Map) に渡される指標の現在のマップ。 |
| 例外 | |
|---|---|
DeviceNotAvailableException |
|
onTestRunStart
public abstract void onTestRunStart (DeviceMetricData runData)
テスト実行が開始されたときのコールバック。
| パラメータ | |
|---|---|
runData |
DeviceMetricData: 実行のデータを保持する DeviceMetricData。 |
| 例外 | |
|---|---|
DeviceNotAvailableException |
|
onTestRunStart
public void onTestRunStart (DeviceMetricData runData, int testCount)
テスト実行が開始されたときのコールバック。
| パラメータ | |
|---|---|
runData |
DeviceMetricData: 実行のデータを保持する DeviceMetricData。 |
testCount |
int: このテスト実行のテストケースの数。 |
| 例外 | |
|---|---|
DeviceNotAvailableException |
|
onTestRunStartBlocking
public void onTestRunStartBlocking ()
コレクタがサポートしている場合、コレクタを手動で開始するための明示的なコールバック。これにより、非同期のテスト ライフサイクルから抜け出すことができます。
| 例外 | |
|---|---|
|
com.android.tradefed.device.DeviceNotAvailableException |
DeviceNotAvailableException |
|
onTestStart
public abstract void onTestStart (DeviceMetricData testData)
テストケースが開始されたときのコールバック。
| パラメータ | |
|---|---|
testData |
DeviceMetricData: テストケースのデータを保持する DeviceMetricData。 |
| 例外 | |
|---|---|
DeviceNotAvailableException |
|
setAlwaysOnCollectionLevel
public void setAlwaysOnCollectionLevel (IMetricCollector.MetricCollectionLevel level)
障害に関係なくコレクタがログを収集するレベルを設定します。
NULL レベルの場合、コレクションは行われません。
| パラメータ | |
|---|---|
level |
IMetricCollector.MetricCollectionLevel: ログが収集される MetricCollectionLevel。 |
setModuleContainsFailure
public void setModuleContainsFailure ()
モジュールに失敗（テストケース、テスト実行）があったかどうかを設定します。
setOnFailureCollectionLevel
public void setOnFailureCollectionLevel (IMetricCollector.MetricCollectionLevel level)
障害発生時にコレクタがログを収集するレベルを設定します。
NULL レベルの場合、コレクションは行われません。
| パラメータ | |
|---|---|
level |
IMetricCollector.MetricCollectionLevel: ログが収集される MetricCollectionLevel。 |