BaseDeviceMetricCollector

public class BaseDeviceMetricCollector
extends Object implements IMetricCollector

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

パブリック メソッド

final getBuildInfos()

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

final getDevices()

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

File getFileFromTestArtifacts(String fileName)

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

final ITestInvocationListener getInvocationListener()

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

final getRealDevices()

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

String getRunName()

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

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 を返します。

final void logAssociation(String dataName, LogFile logFile)

指標コレクタの実装内で使用しないでください。

void onTestAssumptionFailure(DeviceMetricData testData, TestDescription test)

テストケースが前提条件の失敗で失敗した場合のコールバック。

void onTestEnd(DeviceMetricData testData, currentTestCaseMetrics, TestDescription test)

テストケースが終了したときのコーリングバック。

void onTestEnd(DeviceMetricData testData, currentTestCaseMetrics)

テストケースが終了したときのコーリングバック。

void onTestFail(DeviceMetricData testData, TestDescription test)

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

void onTestRunEnd(DeviceMetricData runData, currentRunMetrics)

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

void onTestRunFailed(DeviceMetricData testData, FailureDescription failure)
void onTestRunStart(DeviceMetricData runData)

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

void onTestStart(DeviceMetricData testData)

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

final void setDisable(boolean isDisabled)

オブジェクトを無効にするかどうかを設定します。

final void setLogSaver(ILogSaver logSaver)

指標コレクタの実装内で使用しないでください。

final void testAssumptionFailure(TestDescription test, String trace)
final void testAssumptionFailure(TestDescription test, FailureDescription failure)
final void testEnded(TestDescription test, long endTime, testMetrics)
final void testEnded(TestDescription test, testMetrics)
final void testFailed(TestDescription test, FailureDescription failure)
final void testFailed(TestDescription test, String trace)
final void testIgnored(TestDescription test)
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)
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 ()

パブリック メソッド

getBuildInfos

public final  getBuildInfos ()

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

戻り値

getDevices

public final  getDevices ()

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

戻り値

getFileFromTestArtifacts

public File getFileFromTestArtifacts (String fileName)

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

パラメータ
fileName String: アーティファクトで検索するファイルの名前。
戻り値
File テスト アーティファクトまたはモジュール アーティファクトのファイル。ファイルが見つからない場合は null を返します。

getInvocationListener

public final ITestInvocationListener getInvocationListener ()

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

戻り値
ITestInvocationListener

getRealDevices

public final  getRealDevices ()

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

戻り値

getRunName

public String getRunName ()

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

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

init

public ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

現在のコンテキストと結果を転送する場所を指定してコレクタを初期化します。インスタンスごとに 1 回だけ呼び出され、コレクタは内部コンテキストとリスナーを更新することが期待されます。以前は、テスト実行中に Init が呼び出されることはなかった。

自分のしていることをはっきりと把握できている場合にのみオーバーライドしてください。

パラメータ
context IInvocationContext: 進行中の呼び出しの IInvocationContext。
listener ITestInvocationListener: 結果を格納する ITestInvocationListener。
戻り値
ITestInvocationListener 元のリスナーをラップする新しいリスナー。

invocationEnded

public final void invocationEnded (long elapsedTime)

パラメータ
elapsedTime long

invocationFailed

public final void invocationFailed (FailureDescription failure)

パラメータ
failure FailureDescription

invocationFailed

public final void invocationFailed (Throwable cause)

パラメータ
cause Throwable

invocationStarted

public final void invocationStarted (IInvocationContext context)

転送の呼び出しリスナー

パラメータ
context IInvocationContext

isDisabled

public final boolean isDisabled ()

オブジェクト全体が無効になっている場合（セットアップとテイクダウンの両方をスキップ）、true を返します。それ以外の場合は false です。

戻り値
boolean

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

指標コレクタの実装内で使用しないでください。これは純粋な転送です。

パラメータ
dataName String

logFile LogFile

onTestAssumptionFailure

public void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

テストケースが前提条件の失敗で失敗した場合のコールバック。

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

onTestEnd

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

テストケースが終了したときに呼び出されるコールバック。この時点でクリーンアップを行います。

パラメータ
testData DeviceMetricData: テストケースのデータを保持する DeviceMetricData。onTestStart(com.android.tradefed.device.metric.DeviceMetricData) 時と同じオブジェクトになります。
currentTestCaseMetrics : ITestLifeCycleReceiver.testEnded(com.android.tradefed.result.TestDescription, Map) に渡された指標の現在のマップ。
test TestDescription: 進行中のテストケースの TestDescription。

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics)

テストケースが終了したときに呼び出されるコールバック。この時点でクリーンアップを行います。

パラメータ
testData DeviceMetricData: テストケースのデータを保持する DeviceMetricData。onTestStart(com.android.tradefed.device.metric.DeviceMetricData) 時と同じオブジェクトになります。
currentTestCaseMetrics : ITestLifeCycleReceiver.testEnded(com.android.tradefed.result.TestDescription, Map) に渡された指標の現在のマップ。

onTestFail

public void onTestFail (DeviceMetricData testData, 
                TestDescription test)

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

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

onTestRunEnd

public void onTestRunEnd (DeviceMetricData runData, 
                 currentRunMetrics)

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

パラメータ
runData DeviceMetricData: 実行のデータを保持する DeviceMetricData。onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData) のときと同じオブジェクトになります。
currentRunMetrics : ITestLifeCycleReceiver.testRunEnded(long, Map) に渡された指標の現在のマップ。

onTestRunFailed

public void onTestRunFailed (DeviceMetricData testData, 
                FailureDescription failure)

パラメータ
testData DeviceMetricData

failure FailureDescription

onTestRunStart

public void onTestRunStart (DeviceMetricData runData)

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

パラメータ
runData DeviceMetricData: 実行のデータを保持する DeviceMetricData。

onTestStart

public void onTestStart (DeviceMetricData testData)

テストケースの開始時に呼び出されるコールバック。

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

setDisable

public final void setDisable (boolean isDisabled)

オブジェクトを無効にするかどうかを設定します。無効にすると、セットアップとティアダウンの両方の手順がスキップされます。デフォルト コンストラクタでオブジェクトをデフォルトで無効にするために使用できます。

パラメータ
isDisabled boolean: オブジェクトを配置する状態。

setLogSaver

public final void setLogSaver (ILogSaver logSaver)

指標コレクタの実装内で使用しないでください。これは純粋な転送です。

パラメータ
logSaver ILogSaver

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                String trace)

パラメータ
test TestDescription

trace String

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

パラメータ
test TestDescription

failure FailureDescription

testEnded

public final void testEnded (TestDescription test, 
                long endTime, 
                 testMetrics)

パラメータ
test TestDescription

endTime long

testMetrics

testEnded

public final void testEnded (TestDescription test, 
                 testMetrics)

パラメータ
test TestDescription

testMetrics

testFailed

public final void testFailed (TestDescription test, 
                FailureDescription failure)

パラメータ
test TestDescription

failure FailureDescription

testFailed

public final void testFailed (TestDescription test, 
                String trace)

パラメータ
test TestDescription

trace String

testIgnored

public final void testIgnored (TestDescription test)

パラメータ
test TestDescription

testLog

public final void testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

パラメータ
dataName String

dataType LogDataType

dataStream InputStreamSource

testLogSaved

public final void testLogSaved (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream, 
                LogFile logFile)

指標コレクタの実装内で使用しないでください。これは純粋な転送です。

パラメータ
dataName String

dataType LogDataType

dataStream InputStreamSource

logFile LogFile

testModuleEnded

public final void testModuleEnded ()

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

パラメータ
moduleContext IInvocationContext

testRunEnded

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

パラメータ
elapsedTime long

runMetrics

testRunFailed

public final void testRunFailed (FailureDescription failure)

パラメータ
failure FailureDescription

testRunFailed

public final void testRunFailed (String errorMessage)

パラメータ
errorMessage String

testRunStarted

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber)

パラメータ
runName String

testCount int

attemptNumber int

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

startTime long

testRunStopped

public final void testRunStopped (long elapsedTime)

パラメータ
elapsedTime long

testStarted

public final void testStarted (TestDescription test, 
                long startTime)

パラメータ
test TestDescription

startTime long

testStarted

public final void testStarted (TestDescription test)

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

パラメータ
test TestDescription