ITestSuite
public
abstract
class
ITestSuite
extends Object
implements
IRemoteTest,
IDeviceTest,
IBuildReceiver,
ISystemStatusCheckerReceiver,
IShardableTest,
ITestCollector,
IInvocationContextReceiver,
IRuntimeHintProvider,
IMetricCollectorReceiver,
IConfigurationReceiver,
IReportNotExecuted,
ITokenRequest,
ITestLoggerReceiver
java.lang.Object | |
↳ | com.android.tradefed.testtype.suite.ITestSuite |
テストスイートの実行に使用される抽象クラス。このクラスは、スイートの実行方法の基礎となります。
各実装では、loadTests()
メソッドでテストのリストを定義できます。
概要
フィールド | |
---|---|
public
static
final
String |
ABI_OPTION
|
public
static
final
String |
ACTIVE_MAINLINE_PARAMETER_KEY
|
public
static
final
String |
MAINLINE_PARAMETER_KEY
|
public
static
final
String |
MODULE_CHECKER_POST
|
public
static
final
String |
MODULE_CHECKER_PRE
|
public
static
final
String |
MODULE_METADATA_EXCLUDE_FILTER
|
public
static
final
String |
MODULE_METADATA_INCLUDE_FILTER
|
public
static
final
String |
PARAMETER_KEY
|
public
static
final
String |
PREPARER_WHITELIST
|
public
static
final
String |
PRIMARY_ABI_RUN
|
public
static
final
String |
RANDOM_SEED
|
public
static
final
String |
REBOOT_BEFORE_TEST
|
public
static
final
String |
RUNNER_WHITELIST
|
public
static
final
String |
SKIP_HOST_ARCH_CHECK
|
public
static
final
String |
SKIP_SYSTEM_STATUS_CHECKER
|
public
static
final
String |
TOKEN_KEY
|
パブリック コンストラクタ | |
---|---|
ITestSuite()
|
パブリック メソッド | |
---|---|
void
|
addModuleMetadataExcludeFilters(MultiMap<String, String> filters)
|
void
|
addModuleMetadataIncludeFilters(MultiMap<String, String> filters)
|
final
void
|
enableRebootBeforeTest()
recovery-before-test を true に設定します。 |
|
getAbis(ITestDevice device)
互換性テスト |
static
|
getAbisForBuildTargetArchFromSuite()
TestSuiteInfo から有効な abis を返します。 |
IBuildInfo
|
getBuildInfo()
|
final
IConfiguration
|
getConfiguration()
呼び出し |
ITestLogger
|
getCurrentTestLogger()
|
ITestDevice
|
getDevice()
テスト対象のデバイスを入手します。 |
ModuleDefinition
|
getDirectModule()
直接実行される |
IInvocationContext
|
getInvocationContext()
呼び出しコンテキストを返します。 |
final
String
|
getRequestedAbi()
オプション -a または --abi を指定して、リクエストされた abi を返します。 |
|
getRequiredTokens()
|
long
|
getRuntimeHint()
テストで想定される実行時間を ミリ秒単位です。 |
File
|
getTestsDir()
|
boolean
|
isSplitting()
現在 |
abstract
|
loadTests()
実行するテスト構成を読み込むための抽象メソッド。 |
void
|
reportNotExecuted(ITestInvocationListener listener, String message)
実行されていないテストを、指定されたメインリスナーに報告します。 |
void
|
reportNotExecuted(ITestInvocationListener listener)
実行されていないテストを、指定されたメインリスナーに報告します。 |
final
void
|
run(TestInformation testInfo, ITestInvocationListener listener)
|
void
|
setAbiName(String abiName)
mAbiName の値を設定する |
final
void
|
setAbis(
|
void
|
setBuild(IBuildInfo buildInfo)
|
void
|
setCollectTestsOnly(boolean shouldCollectTest)
テストスイートをコレクタ専用モードで実行します。これを実装するには、すべてのサブテストが必要です。 インターフェースもサポートしています。 |
void
|
setConfiguration(IConfiguration configuration)
使用中の |
void
|
setDevice(ITestDevice device)
テスト対象デバイスを挿入します。 |
void
|
setInvocationContext(IInvocationContext invocationContext)
|
void
|
setInvocationInjector(Injector injector)
呼び出しから現在の Guice |
void
|
setMetricCollectors(
テスト実行用に定義された |
void
|
setPrimaryAbiRun(boolean primaryAbiRun)
mPrimaryAbiRun の値を設定する |
void
|
setShouldMakeDynamicModule(boolean dynamicModule)
分散シャーディングを行う場合、プール内のテストを共有する ModuleDefinition は使用できない そうしないとモジュール内シャーディングが機能しないため、無効にできます。 |
void
|
setSystemStatusChecker(
テストの構成から |
void
|
setTestLogger(ITestLogger testLogger)
|
|
split(Integer shardCountHint, TestInformation testInfo)
|
保護されたメソッド | |
---|---|
|
createModuleListeners()
|
boolean
|
filterByConfigMetadata(IConfiguration config, MultiMap<String, String> include, MultiMap<String, String> exclude)
メタデータ フィルタを構成に適用して、構成が実行されるかどうかを確認します。 |
boolean
|
filterByRunnerType(IConfiguration config,
ランナーのホワイトリストのフィルタを適用して、許可リストに登録されていないランナーを削除します。 |
|
getAbisForBuildTargetArch()
ホストビルド ターゲット アーキテクチャでサポートされている abis を返します。 |
|
getHostAbis()
ホストマシンの abis を返します。 |
boolean
|
shouldModuleRun(ModuleDefinition module)
|
フィールド
ABI_OPTION
public static final String ABI_OPTION
ACTIVE_MAINLINE_PARAMETER_KEY
public static final String ACTIVE_MAINLINE_PARAMETER_KEY
MAINLINE_PARAMETER_KEY
public static final String MAINLINE_PARAMETER_KEY
MODULE_CHECKER_POST
public static final String MODULE_CHECKER_POST
MODULE_CHECKER_PRE
public static final String MODULE_CHECKER_PRE
MODULE_METADATA_EXCLUDE_FILTER
public static final String MODULE_METADATA_EXCLUDE_FILTER
MODULE_METADATA_INCLUDE_FILTER
public static final String MODULE_METADATA_INCLUDE_FILTER
パラメータキー
public static final String PARAMETER_KEY
PREPARER_WHITELIST
public static final String PREPARER_WHITELIST
PRIMARY_ABI_RUN
public static final String PRIMARY_ABI_RUN
ランダムシード
public static final String RANDOM_SEED
REBOOT_BEFORE_TEST
public static final String REBOOT_BEFORE_TEST
ランナーのホワイトリスト
public static final String RUNNER_WHITELIST
SKIP_HOST_ARCH_CHECK
public static final String SKIP_HOST_ARCH_CHECK
SKIP_SYSTEM_STATUS_CHECKER
public static final String SKIP_SYSTEM_STATUS_CHECKER
トークンキー
public static final String TOKEN_KEY
パブリック コンストラクタ
ITestSuite
public ITestSuite ()
パブリック メソッド
addModuleMetadataExcludeFilters
public void addModuleMetadataExcludeFilters (MultiMap<String, String> filters)
パラメータ | |
---|---|
filters |
MultiMap |
addModuleMetadataIncludeFilters
public void addModuleMetadataIncludeFilters (MultiMap<String, String> filters)
パラメータ | |
---|---|
filters |
MultiMap |
enableRebootBeforeTest
public final void enableRebootBeforeTest ()
recovery-before-test を true に設定します。
getAbis
publicgetAbis (ITestDevice device)
互換性テスト AbiUtils.getAbisSupportedByCompatibility()
とテスト対象デバイスの両方でサポートされている ABI のセットを取得します。
パラメータ | |
---|---|
device |
ITestDevice |
戻り値 | |
---|---|
|
テストを実行する ABI のセット |
例外 | |
---|---|
DeviceNotAvailableException |
getAbisForBuildTargetArchFromSuite
public staticgetAbisForBuildTargetArchFromSuite ()
TestSuiteInfo から有効な abis を返します。
戻り値 | |
---|---|
|
getBuildInfo
public IBuildInfo getBuildInfo ()
ITestSuite
の実装で、テストを読み込むためにビルド情報が必要になる場合があります。
戻り値 | |
---|---|
IBuildInfo |
getConfiguration
public final IConfiguration getConfiguration ()
呼び出し IConfiguration
を返します。
戻り値 | |
---|---|
IConfiguration |
getCurrentTestLogger
public ITestLogger getCurrentTestLogger ()
戻り値 | |
---|---|
ITestLogger |
getDirectModule
public ModuleDefinition getDirectModule ()
直接実行される ModuleDefinition
を返します。まだ実行されていない場合(
ITestSuite がまだシャーディングされていない)。
戻り値 | |
---|---|
ModuleDefinition |
getInvocationContext
public IInvocationContext getInvocationContext ()
呼び出しコンテキストを返します。
戻り値 | |
---|---|
IInvocationContext |
getRequestedAbi
public final String getRequestedAbi ()
オプション -a または --abi を指定して、リクエストされた abi を返します。
戻り値 | |
---|---|
String |
getRequiredTokens
publicgetRequiredTokens ()
戻り値 | |
---|---|
|
getRuntimeHint
public long getRuntimeHint ()
テストで想定される実行時間を ミリ秒単位です。 この時間は、シャーディングされた実行のロード バランシングに使用されます
戻り値 | |
---|---|
long |
getTestsDir
public File getTestsDir ()
戻り値 | |
---|---|
File |
isSplitting
public boolean isSplitting ()
現在 IShardableTest.split(int)
にいる場合は true を返します。
戻り値 | |
---|---|
boolean |
loadTests
public abstractloadTests ()
実行するテスト構成を読み込むための抽象メソッド。各テストは
IConfiguration
と、結果を報告する一意の名前。
戻り値 | |
---|---|
|
reportNotExecuted
public void reportNotExecuted (ITestInvocationListener listener, String message)
実行されていないテストを、指定されたメインリスナーに報告します。報告すべき問題
NOT_EXECUTED_FAILURE
メッセージで失敗しました。
パラメータ | |
---|---|
listener |
ITestInvocationListener : 実行されていない結果を報告するメインリスナー。 |
message |
String : 実行されなかったエラーに関連付けるメッセージ。
|
reportNotExecuted
public void reportNotExecuted (ITestInvocationListener listener)
実行されていないテストを、指定されたメインリスナーに報告します。報告すべき問題
NOT_EXECUTED_FAILURE
メッセージで失敗しました。
パラメータ | |
---|---|
listener |
ITestInvocationListener : 実行されていない結果を報告するメインリスナー。
|
ホームラン
public final void run (TestInformation testInfo, ITestInvocationListener listener)
loadTests()
から読み込まれたすべてのテストの一般的な実行メソッド。
パラメータ | |
---|---|
testInfo |
TestInformation |
listener |
ITestInvocationListener |
例外 | |
---|---|
DeviceNotAvailableException |
setAbiName
public void setAbiName (String abiName)
mAbiName の値を設定する
パラメータ | |
---|---|
abiName |
String |
設定
public final void setAbis (abis)
パラメータ | |
---|---|
abis |
|
setBuild
public void setBuild (IBuildInfo buildInfo)
パラメータ | |
---|---|
buildInfo |
IBuildInfo |
setCollectTestsOnly
public void setCollectTestsOnly (boolean shouldCollectTest)
テストスイートをコレクタ専用モードで実行します。これを実装するには、すべてのサブテストが必要です。 インターフェースもサポートしています。
setConfiguration
public void setConfiguration (IConfiguration configuration)
使用中の IConfiguration
を注入します。
パラメータ | |
---|---|
configuration |
IConfiguration |
setDevice
public void setDevice (ITestDevice device)
テスト対象デバイスを挿入します。
パラメータ | |
---|---|
device |
ITestDevice : 使用する ITestDevice
|
setInvocationContext
public void setInvocationContext (IInvocationContext invocationContext)
パラメータ | |
---|---|
invocationContext |
IInvocationContext |
setInvocationInjector
public void setInvocationInjector (Injector injector)
呼び出しから現在の Guice Injector
を取得します。これにより
モジュールのオブジェクト インジェクションなどです。
パラメータ | |
---|---|
injector |
Injector |
setMetricCollectors
public void setMetricCollectors (collectors)
テスト実行用に定義された IMetricCollector
のリストを設定します。
パラメータ | |
---|---|
collectors |
|
setPrimaryAbiRun
public void setPrimaryAbiRun (boolean primaryAbiRun)
mPrimaryAbiRun の値を設定する
パラメータ | |
---|---|
primaryAbiRun |
boolean |
set shouldMakeDynamicModule
public void setShouldMakeDynamicModule (boolean dynamicModule)
分散シャーディングを行う場合、プール内のテストを共有する ModuleDefinition は使用できない そうしないとモジュール内シャーディングが機能しないため、無効にできます。
パラメータ | |
---|---|
dynamicModule |
boolean |
setSystemStatusChecker
public void setSystemStatusChecker (systemCheckers)
テストの構成から ISystemStatusChecker
を設定します。
パラメータ | |
---|---|
systemCheckers |
|
setTestLogger
public void setTestLogger (ITestLogger testLogger)
パラメータ | |
---|---|
testLogger |
ITestLogger |
分割
publicsplit (Integer shardCountHint, TestInformation testInfo)
split(int)
の代替バージョン。TestInformation
も提供します。
これには、シャードを作成する親からの早期情報が含まれます。たとえば、
デバイスまたはビルドの情報にシャーディング中にアクセスする必要があるとします。
パラメータ | |
---|---|
shardCountHint |
Integer : 試行されたシャードの数。 |
testInfo |
TestInformation : 親 TestInformation |
戻り値 | |
---|---|
|
個別に実行するサブテストのコレクション。テストが必要な場合は null
現在シャーディング不可
|
保護されたメソッド
createModuleListeners
protectedcreateModuleListeners ()
ModuleListener
に適用される ITestInvocationListener
のリストを返します。
できます。これらのリスナーはモジュールごとに再利用されます。再インスタンス化はされません。
内部状態を想定すべきではありません。
戻り値 | |
---|---|
|
filterByConfigMetadata
protected boolean filterByConfigMetadata (IConfiguration config, MultiMap<String, String> include, MultiMap<String, String> exclude)
メタデータ フィルタを構成に適用して、構成が実行されるかどうかを確認します。
パラメータ | |
---|---|
config |
IConfiguration : 評価対象の IConfiguration 。 |
include |
MultiMap : メタデータ インクルード フィルタ |
exclude |
MultiMap : メタデータ除外フィルタ |
戻り値 | |
---|---|
boolean |
モジュールを実行する場合は true、それ以外の場合は false。 |
filterByRunnerType
protected boolean filterByRunnerType (IConfiguration config,allowedRunners)
ランナーのホワイトリストのフィルタを適用して、許可リストに登録されていないランナーを削除します。もし 構成に複数のランナーがあります。一部のランナーは削除されても、構成は引き続き実行されます。
パラメータ | |
---|---|
config |
IConfiguration : 評価対象の IConfiguration 。 |
allowedRunners |
: 現在のランナーのホワイトリスト。 |
戻り値 | |
---|---|
boolean |
構成モジュールの実行が許可されている場合は true、そうでない場合は false。 |
getAbisForBuildTargetArch
protectedgetAbisForBuildTargetArch ()
ホストビルド ターゲット アーキテクチャでサポートされている abis を返します。テスト用に公開されています。
戻り値 | |
---|---|
|
getHostAbis
protectedgetHostAbis ()
ホストマシンの abis を返します。
戻り値 | |
---|---|
|
shouldModuleRun
protected boolean shouldModuleRun (ModuleDefinition module)
パラメータ | |
---|---|
module |
ModuleDefinition |
戻り値 | |
---|---|
boolean |