ModuleDefinition

public class ModuleDefinition
extends Object implements ITestCollector

java.lang.Object
   ↳ com.android.tradefed.testtype.suite.ModuleDefinition

テスト実行構成のコンテナ。このクラスは、テストの準備と実行を支援するものです。

概要

定数

String ISOLATION_COST

String MODULE_ABI

String MODULE_CACHED

テスト モジュールの結果がキャッシュに保存された場合、このプロパティは true に設定されます。
String MODULE_CONTROLLER

String MODULE_EXTERNAL_DEPENDENCIES

String MODULE_ID

testRunStart でモジュールを一意に識別するために使用される名前のモジュール ID。
String MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY

String MODULE_ISOLATED

モジュールが新たに準備されたデバイスで実行されていた場合、このプロパティは true に設定されます。
String MODULE_NAME

モジュール名は、モジュールに関連付けられたベース名です。通常は、モジュールが読み込まれた XML TF 構成ファイルから取得されます。
String MODULE_PARAMETERIZATION

String MODULE_SKIPPED

テスト モジュールがスキップされた場合、このプロパティは true に設定されます。
String MODULE_TEST_COUNT

String PREPARATION_TIME

String RETRY_FAIL_COUNT

String RETRY_SUCCESS_COUNT

String RETRY_TIME

String SPARSE_MODULE

モジュール レベルのイベントのみが報告される場合、このプロパティは true に設定されます。
String TEAR_DOWN_TIME

String TEST_TIME

パブリック コンストラクタ

ModuleDefinition()
ModuleDefinition(String name, tests, preparersPerDevice, multiPreparers, IConfiguration moduleConfig)

コンストラクタ

ModuleDefinition(String name, tests, preparersPerDevice, suitePreparersPerDevice, multiPreparers, IConfiguration moduleConfig)

コンストラクタ

パブリック メソッド

int compareTo(ModuleDefinition moduleDef)

String getId()

一意のモジュール名を返します。
Integer getIntraModuleShardCount()
Integer getIntraModuleShardIndex()
IConfiguration getModuleConfiguration()
IInvocationContext getModuleInvocationContext()

モジュールに関連付けられた IInvocationContext を返します。
TestInformation getModuleTestInformation()
getRequiredTokens(TestInformation testInfo)
long getRuntimeHint()

モジュール内のすべてのテストを実行するおおよその時間を返します。
boolean hasModuleFailed()

モジュールで testRunFailure が呼び出された場合は True を返します。
int neededDevices()

このテストを実行する予定のデバイスの数を返します。
int numTests()

実行を待機している IRemoteTest の現在の数を返します。
final void reportNotExecuted(ITestInvocationListener listener, String message)

完全に実行されなかったモジュールをレポートします。
final void run(TestInformation moduleInfo, ITestInvocationListener listener, int maxRunLimit)

モジュールに含まれるすべての IRemoteTest を実行し、前後のすべての準備ツールを使用してデバイスをセットアップしてクリーンアップします。
final void run(TestInformation moduleInfo, ITestInvocationListener listener)

モジュールに含まれるすべての IRemoteTest を実行し、前後のすべての準備ツールを使用してデバイスをセットアップしてクリーンアップします。
Throwable runPreparation(boolean includeSuitePreparers)

テストの準備ツールを実行します。指定されている場合は、スイートレベルの準備ツールも実行します。
void setBuild(IBuildInfo build)

テスト中に使用する IBuildInfo を挿入します。
void setCollectTestsOnly(boolean collectTestsOnly)

テスト収集モードを有効または無効にします。
void setDevice(ITestDevice device)

テスト中に使用する ITestDevice を挿入します。
void setEnableDynamicDownload(boolean enableDynamicDownload)

モジュール レベルで動的ダウンロードを有効にするかどうか。

void setIntraModuleInformation(int shardCount, int shardIndex)
void setLogSaver(ILogSaver logSaver)

呼び出しログ セーバーをモジュールに渡して、必要に応じて使用できるようにします。
final void setMergeAttemps(boolean mergeAttempts)

結果をマージするかどうかを設定します。
void setMetricCollectors( collectors)

モジュールで使用される IMetricCollector のリストを挿入します。
void setRecoverVirtualDevice(boolean recoverVirtualDevice)

セットは仮想デバイスを復元する必要があります。

void setRemoveModuleBuffering(boolean removeModuleBuffering)
void setReportModuleEnd(boolean shouldReportModuleEnd)
void setReportModuleStart(boolean shouldReportModuleStart)
final void setRetryDecision(IRetryDecision decision)

モジュール内の再試行に使用する IRetryDecision を設定します。
void setUseModuleResultsForwarder(boolean useModuleResultsForwarder)
boolean shouldRecoverVirtualDevice()

仮想デバイスを復元すべきかどうかを返します。
String toString()

void transferSuiteLevelOptions(IConfiguration mSuiteConfiguration)

スイートレベルの構成をいくつかコピーします。

保護されたメソッド

boolean hasTests()

Module のプールに実行する IRemoteTest がまだある場合は True を返します。

定数

ISOLATION_COST

public static final String ISOLATION_COST

定数値: "ISOLATION_COST"

MODULE_ABI

public static final String MODULE_ABI

定数値: "module-abi"

MODULE_CACHED

public static final String MODULE_CACHED

テスト モジュールの結果がキャッシュに保存された場合、このプロパティは true に設定されます。

定数値: "module-cached"

MODULE_CONTROLLER

public static final String MODULE_CONTROLLER

定数値: "module_controller"

MODULE_EXTERNAL_DEPENDENCIES

public static final String MODULE_EXTERNAL_DEPENDENCIES

定数値: "module-external-dependencies"

MODULE_ID

public static final String MODULE_ID

テスト実行の開始時にモジュールを一意に識別するために使用される名前であるモジュール ID。通常は、MODULE_ABI と MODULE_NAME の組み合わせになります。

定数値: "module-id"

MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY

public static final String MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY

定数値: "module-flag-overrides"

MODULE_ISOLATED

public static final String MODULE_ISOLATED

モジュールが新たに準備されたデバイスで実行された場合、このプロパティは true に設定されます。

定数値: "module-isolated"

MODULE_NAME

public static final String MODULE_NAME

モジュール名は、モジュールに関連付けられたベース名です。通常は、モジュールが読み込まれた Xml TF 構成ファイルから取得されます。

定数値: "module-name"

MODULE_PARAMETERIZATION

public static final String MODULE_PARAMETERIZATION

定数値: "module-param"

MODULE_SKIPPED

public static final String MODULE_SKIPPED

テスト モジュールがスキップされた場合、このプロパティは true に設定されます。

定数値: "module-skipped"

MODULE_TEST_COUNT

public static final String MODULE_TEST_COUNT

定数値: "MODULE_TEST_COUNT"

PREPARATION_TIME

public static final String PREPARATION_TIME

定数値: "PREP_TIME"

RETRY_FAIL_COUNT

public static final String RETRY_FAIL_COUNT

定数値: "MODULE_RETRY_FAILED"

RETRY_SUCCESS_COUNT

public static final String RETRY_SUCCESS_COUNT

定数値: "MODULE_RETRY_SUCCESS"

RETRY_TIME

public static final String RETRY_TIME

定数値: "MODULE_RETRY_TIME"

SPARSE_MODULE

public static final String SPARSE_MODULE

モジュール レベルのイベントのみが報告される場合、このプロパティは true に設定されます。

定数値: "sparse-module"

TEAR_DOWN_TIME

public static final String TEAR_DOWN_TIME

定数値: "TEARDOWN_TIME"

TEST_TIME

public static final String TEST_TIME

定数値: "TEST_TIME"

パブリック コンストラクタ

ModuleDefinition

public ModuleDefinition ()

ModuleDefinition

public ModuleDefinition (String name, 
                 tests, 
                 preparersPerDevice, 
                 multiPreparers, 
                IConfiguration moduleConfig)

コンストラクタ

パラメータ
name String: テスト構成の一意の名前。
tests : 実行する必要がある IRemoteTest のリスト。
preparersPerDevice : デバイスのセットアップに使用する ITargetPreparer のリスト。
multiPreparers

moduleConfig IConfiguration: 基盤となるモジュール構成の IConfiguration。

ModuleDefinition

public ModuleDefinition (String name, 
                 tests, 
                 preparersPerDevice, 
                 suitePreparersPerDevice, 
                 multiPreparers, 
                IConfiguration moduleConfig)

コンストラクタ

パラメータ
name String: テスト構成の一意の名前。
tests : 実行する必要がある IRemoteTest のリスト。
preparersPerDevice : デバイスのセットアップに使用する ITargetPreparer のリスト。
suitePreparersPerDevice

multiPreparers

moduleConfig IConfiguration: 基盤となるモジュール構成の IConfiguration。

パブリック メソッド

compareTo

public int compareTo (ModuleDefinition moduleDef)

パラメータ
moduleDef ModuleDefinition

戻り値
int

getId

public String getId ()

一意のモジュール名を返します。

戻り値
String

getIntraModuleShardCount

public Integer getIntraModuleShardCount ()

戻り値
Integer

getIntraModuleShardIndex

public Integer getIntraModuleShardIndex ()

戻り値
Integer

getModuleConfiguration

public IConfiguration getModuleConfiguration ()

戻り値
IConfiguration

getModuleInvocationContext

public IInvocationContext getModuleInvocationContext ()

モジュールに関連付けられた IInvocationContext を返します。

戻り値
IInvocationContext

getModuleTestInformation

public TestInformation getModuleTestInformation ()

戻り値
TestInformation

getRequiredTokens

public  getRequiredTokens (TestInformation testInfo)

パラメータ
testInfo TestInformation

戻り値

getRuntimeHint

public long getRuntimeHint ()

モジュール内のすべてのテストを実行するおおよその時間を返します。

戻り値
long

hasModuleFailed

public boolean hasModuleFailed ()

モジュールで testRunFailure が呼び出された場合は True を返します。*

戻り値
boolean

neededDevices

public int neededDevices ()

このテストを実行する予定のデバイスの数を返します。

戻り値
int

numTests

public int numTests ()

実行を待機している IRemoteTest の現在の数を返します。

戻り値
int

reportNotExecuted

public final void reportNotExecuted (ITestInvocationListener listener, 
                String message)

完全に実行されなかったモジュールをレポートします。

パラメータ
listener ITestInvocationListener

message String

ホームラン

public final void run (TestInformation moduleInfo, 
                ITestInvocationListener listener, 
                int maxRunLimit)

モジュールに含まれるすべての IRemoteTest を実行し、前後のすべての準備ツールを使用してデバイスをセットアップしてクリーンアップします。

パラメータ
moduleInfo TestInformation: モジュールの TestInformation。
listener ITestInvocationListener: 結果を報告する ITestInvocationListener。
maxRunLimit int: 各テストケースの最大実行回数。
例外
DeviceNotAvailableException デバイスがオフラインになった場合。

ホームラン

public final void run (TestInformation moduleInfo, 
                ITestInvocationListener listener)

モジュールに含まれるすべての IRemoteTest を実行し、前後のすべての準備ツールを使用してデバイスをセットアップしてクリーンアップします。

パラメータ
moduleInfo TestInformation

listener ITestInvocationListener: 結果を報告する ITestInvocationListener。
例外
DeviceNotAvailableException デバイスがオフラインになった場合。

runPreparation

public Throwable runPreparation (boolean includeSuitePreparers)

テストの準備ツールを実行します（指定されている場合はスイートレベルの準備ツールも実行します）。

パラメータ
includeSuitePreparers boolean: スイートレベルの準備ツールも実行する場合は、true に設定します。
戻り値
Throwable 準備ツール実行時に発生した例外の Throwable。

setBuild

public void setBuild (IBuildInfo build)

テスト中に使用する IBuildInfo を挿入します。

パラメータ
build IBuildInfo

setCollectTestsOnly

public void setCollectTestsOnly (boolean collectTestsOnly)

テスト収集モードを有効または無効にします

setDevice

public void setDevice (ITestDevice device)

テスト中に使用する ITestDevice を挿入します。

パラメータ
device ITestDevice

setEnableDynamicDownload

public void setEnableDynamicDownload (boolean enableDynamicDownload)

モジュール レベルで動的ダウンロードを有効にするかどうか。

パラメータ
enableDynamicDownload boolean

setIntraModuleInformation

public void setIntraModuleInformation (int shardCount, 
                int shardIndex)

パラメータ
shardCount int

shardIndex int

setLogSaver

public void setLogSaver (ILogSaver logSaver)

呼び出しログ セーバーをモジュールに渡して、必要に応じて使用できるようにします。

パラメータ
logSaver ILogSaver

setMergeAttemps

public final void setMergeAttemps (boolean mergeAttempts)

結果を統合するかどうかを設定します。

パラメータ
mergeAttempts boolean

setMetricCollectors

public void setMetricCollectors ( collectors)

モジュールで使用される IMetricCollector のリストを挿入します。

パラメータ
collectors

setRecoverVirtualDevice

public void setRecoverVirtualDevice (boolean recoverVirtualDevice)

セットは仮想デバイスを復元する必要があります。

パラメータ
recoverVirtualDevice boolean

setRemoveModuleBuffering

public void setRemoveModuleBuffering (boolean removeModuleBuffering)

パラメータ
removeModuleBuffering boolean

setReportModuleEnd

public void setReportModuleEnd (boolean shouldReportModuleEnd)

パラメータ
shouldReportModuleEnd boolean

setReportModuleStart

public void setReportModuleStart (boolean shouldReportModuleStart)

パラメータ
shouldReportModuleStart boolean

setRetryDecision

public final void setRetryDecision (IRetryDecision decision)

モジュール内の再試行に使用する IRetryDecision を設定します。

パラメータ
decision IRetryDecision

setUseModuleResultsForwarder

public void setUseModuleResultsForwarder (boolean useModuleResultsForwarder)

パラメータ
useModuleResultsForwarder boolean

shouldRecoverVirtualDevice

public boolean shouldRecoverVirtualDevice ()

仮想デバイスを復元する必要があるかどうかを返します。

戻り値
boolean

toString

public String toString ()

戻り値
String

transferSuiteLevelOptions

public void transferSuiteLevelOptions (IConfiguration mSuiteConfiguration)

スイートレベルの構成の一部をコピーする

パラメータ
mSuiteConfiguration IConfiguration

保護されたメソッド

hasTests

protected boolean hasTests ()

Module のプールに実行する IRemoteTest がまだある場合は True を返します。それ以外は False が返されます。

戻り値
boolean