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

コレクタがモジュールレベルのキャプチャに適用され、初期化する必要があるかどうか。

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)

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

パブリック メソッド

captureModuleLevel

public boolean captureModuleLevel ()

コレクタがモジュールレベルのキャプチャに適用され、初期化する必要があるかどうか。

戻り値
boolean

getBuildInfos

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: テストケースのデータを保持する DeviceMetricDataonTestStart(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: テストケースのデータを保持する DeviceMetricDataonTestStart(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: 実行のデータを保持する DeviceMetricDataonTestRunStart(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