IMetricCollector

public interface IMetricCollector
implements IDisableable, ILogSaverListener

com.android.tradefed.device.metric.IMetricCollector


このインターフェースは、テスト結果を報告する際にデコレータとして追加され、 一致します

このインターフェースは ITestInvocationListener を拡張するとしても、 として使用することはできません。構成チェックで拒否されます。必ず 「metrics_collector」。

コレクタは複数のリージョンで再利用される可能性があるため、内部状態を保持することは想定されていません。 できます。内部状態を本当に使用する必要がある場合は、init(com.android.tradefed.invoker.IInvocationContext, com.android.tradefed.result.ITestInvocationListener) で消去する必要があります。

概要

パブリック メソッド

default boolean captureModuleLevel()

コレクタがモジュール レベルのキャプチャに適用可能で、init である必要があるかどうか。

abstract getBuildInfos()

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

abstract getDevices()

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

abstract ITestInvocationListener getInvocationListener()

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

abstract ITestInvocationListener init(IInvocationContext context, ITestInvocationListener listener)

現在のコンテキストと結果の転送先でコレクタを初期化します。

abstract void onTestAssumptionFailure(DeviceMetricData testData, TestDescription test)

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

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

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

abstract void onTestEnd(DeviceMetricData testData, currentTestCaseMetrics)

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

abstract void onTestFail(DeviceMetricData testData, TestDescription test)

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

default void onTestModuleEnded()

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

default void onTestModuleStarted()

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

abstract void onTestRunEnd(DeviceMetricData runData, currentRunMetrics)

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

abstract void onTestRunStart(DeviceMetricData runData)

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

default void onTestRunStart(DeviceMetricData runData, int testCount)

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

abstract void onTestStart(DeviceMetricData testData)

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

パブリック メソッド

キャプチャ モジュール レベル

public boolean captureModuleLevel ()

コレクタがモジュール レベルのキャプチャに適用可能で、init である必要があるかどうか。

戻り値
boolean

getBuildInfo

public abstract  getBuildInfos ()

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

戻り値

getDevices

public abstract  getDevices ()

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

戻り値

getInvocationListener

public abstract ITestInvocationListener getInvocationListener ()

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

戻り値
ITestInvocationListener

init

public abstract ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

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

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

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

listener ITestInvocationListener: 結果を配置する ITestInvocationListener

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

例外
DeviceNotAvailableException

onTestAssumptionFailure

public abstract void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

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

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

test TestDescription: 進行中のテストケースの TestDescription

例外
DeviceNotAvailableException

onTestEnd

public abstract 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 abstract 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 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, 
                 currentRunMetrics)

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

パラメータ
runData DeviceMetricData: 実行のデータを保持する DeviceMetricData。変更なし オブジェクト(onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData) など)。

currentRunMetrics : ERROR(/#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

onTestStart

public abstract void onTestStart (DeviceMetricData testData)

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

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

例外
DeviceNotAvailableException