ModuleDefinition

public class ModuleDefinition
extends Object implements ITestCollector

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

---

テスト実行構成のコンテナ。このクラスは、テストの準備と実行を行うヘルパーです。

概要

フィールド
public static final String	ISOLATION_COST
public static final String	MODULE_ABI
public static final String	MODULE_CACHED このプロパティは、テスト モジュールの結果がキャッシュに保存されている場合に true に設定されます。
public static final String	MODULE_CONTROLLER
public static final String	MODULE_EXTERNAL_DEPENDENCIES
public static final String	MODULE_ID モジュール ID: testRunStart 中にモジュールを一意に識別するために使用される名前。
public static final String	MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY
public static final String	MODULE_ISOLATED このプロパティは、モジュールが新しく準備されたデバイスで実行されている場合に true に設定されます。
public static final String	MODULE_NAME モジュール名は、モジュールに関連付けられたベース名です。通常は、モジュールの読み込み元である XML TF 構成ファイルから取得されます。
public static final String	MODULE_PARAMETERIZATION
public static final String	MODULE_SKIPPED テスト モジュールがスキップされた場合は、このプロパティが true に設定されます。
public static final String	MODULE_TEST_COUNT
public static final String	PREPARATION_TIME
public static final String	RETRY_FAIL_COUNT
public static final String	RETRY_SUCCESS_COUNT
public static final String	RETRY_TIME
public static final String	SPARSE_MODULE モジュールレベルのイベントのみが報告される場合は、このプロパティが true に設定されます。
public static final String	TEAR_DOWN_TIME
public static final 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 を返します。
	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, moduleLevelListeners) モジュールに含まれるすべての IRemoteTest を実行し、その前後にすべての準備ツールを使用して、デバイスのセットアップとクリーンアップを行います。
final void	run(TestInformation moduleInfo, ITestInvocationListener listener, moduleLevelListeners, 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) セットは仮想デバイスを復元する必要があります。
final void	setRetryDecision(IRetryDecision decision) モジュール内の再試行に使用する IRetryDecision を設定します。
boolean	shouldRecoverVirtualDevice() 仮想デバイスを復元する必要があるかどうかを返します。
String	toString()
void	transferSuiteLevelOptions(IConfiguration mSuiteConfiguration) スイートレベルの設定の一部をコピーします。

保護されたメソッド
boolean	hasTests() モジュールにプールで実行する IRemoteTest がまだ残っている場合は true を返します。

フィールド

ISOLATION_COST

public static final String ISOLATION_COST

MODULE_ABI

public static final String MODULE_ABI

MODULE_CACHED

public static final String MODULE_CACHED

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

MODULE_CONTROLLER

public static final String MODULE_CONTROLLER

MODULE_EXTERNAL_DEPENDENCIES

public static final String MODULE_EXTERNAL_DEPENDENCIES

MODULE_ID

public static final String MODULE_ID

モジュール ID: testRunStart 中にモジュールを一意に識別するために使用される名前。通常は MODULE_ABI + MODULE_NAME の組み合わせになります。

MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY

public static final String MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY

MODULE_ISOLATED

public static final String MODULE_ISOLATED

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

MODULE_NAME

public static final String MODULE_NAME

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

MODULE_PARAMETERIZATION

public static final String MODULE_PARAMETERIZATION

MODULE_SKIPPED（モジュールをスキップ）

public static final String MODULE_SKIPPED

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

MODULE_TEST_COUNT 人

public static final String MODULE_TEST_COUNT

PREPARATION_TIME

public static final String PREPARATION_TIME

RETRY_FAIL_COUNT

public static final String RETRY_FAIL_COUNT

RETRY_SUCCESS_COUNT

public static final String RETRY_SUCCESS_COUNT

再試行時間

public static final String RETRY_TIME

SPARSE_MODULE

public static final String SPARSE_MODULE

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

TEAR_DOWN_TIME

public static final String TEAR_DOWN_TIME

TEST_TIME

public static final String 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

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, 
                 moduleLevelListeners)

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

パラメータ
moduleInfo	TestInformation
listener	ITestInvocationListener: 結果を報告する ITestInvocationListener。
moduleLevelListeners	: モジュール レベルのリスナーのリスト。

例外
DeviceNotAvailableException	デバイスがオフラインになった場合。

ホームラン

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

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

パラメータ
moduleInfo	TestInformation: モジュールの TestInformation。
listener	ITestInvocationListener: 結果を報告する ITestInvocationListener。
moduleLevelListeners	: モジュール レベルのリスナーのリスト。
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

setRetryDecision

public final void setRetryDecision (IRetryDecision decision)

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

パラメータ
decision	IRetryDecision

shouldRecoverVirtualDevice

public boolean shouldRecoverVirtualDevice ()

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

戻り値
boolean

toString

public String toString ()

戻り値
String

transferSuiteLevelOptions

public void transferSuiteLevelOptions (IConfiguration mSuiteConfiguration)

スイートレベルの設定の一部をコピーする

パラメータ
mSuiteConfiguration	IConfiguration

保護されたメソッド

hasTests

protected boolean hasTests ()

モジュールのプールで実行する IRemoteTest がまだ残っている場合は true を返します。それ以外の場合は False です。

戻り値
boolean