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

既知の直接サブクラス BaseTestSuite 、 TfSuiteRunner BaseTestSuite 新しいスイート システムで互換性テスト スイートを実行するためのテスト。 TfSuiteRunner TF jar の res/config/suite/ フォルダーからテストをロードするITestSuiteの実装。

既知の間接サブクラス AtestRunner 、 TestMappingSuiteRunner AtestRunner ITestSuiteの実装 TestMappingSuiteRunner オプション include-filter で指定されたテストを実行するBaseTestSuiteの実装、またはビルドからの TEST_MAPPING ファイルをスイートとして実行します。

---

テスト スイートの実行に使用される抽象クラス。このクラスは、スイートの実行方法のベースを提供します。各実装は、 loadTests()メソッドを介してテストのリストを定義できます。

概要

ネストされたクラス
enum	ITestSuite.MultiDeviceModuleStrategy

田畑
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	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)
	getAbis ( ITestDevice device) 互換性テストAbiUtils.getAbisSupportedByCompatibility()とテスト対象のデバイスの両方でサポートされている ABI のセットを取得します。
static	getAbisForBuildTargetArchFromSuite () TestSuiteInfo から可能な abis を返します。
IBuildInfo	getBuildInfo () ITestSuiteの実装では、テストをロードするためにビルド情報が必要になる場合があります。
final IConfiguration	getConfiguration () 呼び出しIConfigurationを返します。
ITestLogger	getCurrentTestLogger ()
ITestDevice	getDevice () テスト対象のデバイスを取得します。
ModuleDefinition	getDirectModule () 直接実行されるModuleDefinitionを返します。まだ実行されていない場合 (ITestSuite がまだシャードされていない場合) は null を返します。
IInvocationContext	getInvocationContext () 呼び出しコンテキストを返します。
MultiMap <String, String>	getModuleMetadataIncludeFilters ()
final String	getRequestedAbi () オプション -a または --abi で要求された abi を返します。
	getRequiredTokens ( TestInformation testInfo) テストで必要なトークンのリストを返します。
long	getRuntimeHint () テストの予想実行時間をミリ秒単位で返します。
File	getTestsDir ()
boolean	isSplitting () 現在IShardableTest.split(int)にいる場合は true を返します。
abstract	loadTests () 実行されるテスト構成をロードするための抽象メソッド。
void	reportNotExecuted ( ITestInvocationListener listener, String message) 実行されなかったテストを、提供されたメイン リスナーに報告します。
void	reportNotExecuted ( ITestInvocationListener listener) 実行されなかったテストを、提供されたメイン リスナーに報告します。
final void	run ( TestInformation testInfo, ITestInvocationListener listener) loadTests()からロードされたすべてのテストの汎用実行メソッド。
void	setAbiName (String abiName) mAbiName の値を設定します
final void	setAbis ( abis) setAbis ( abis)
void	setBuild ( IBuildInfo buildInfo)
void	setCollectTestsOnly (boolean shouldCollectTest) テスト スイートをコレクター専用モードで実行します。これには、すべてのサブテストでこのインターフェイスも実装する必要があります。
void	setConfiguration ( IConfiguration configuration) 使用中のIConfigurationを挿入します。
void	setDevice ( ITestDevice device) テスト対象のデバイスを注入します。
void	setDirectModule ( ModuleDefinition module)
void	setInvocationContext ( IInvocationContext invocationContext)
void	setMetricCollectors ( collectors) setMetricCollectors ( collectors) テスト実行用に定義されたIMetricCollectorのリストを設定します。
void	setPrimaryAbiRun (boolean primaryAbiRun) mPrimaryAbiRun の値を設定します
void	setShouldMakeDynamicModule (boolean dynamicModule) 分散シャーディングを行う場合、プールでテストを共有する ModuleDefinition を持つことはできません。そうしないと、モジュール内シャーディングが機能しないため、無効にすることができます。
void	setSystemStatusChecker ( systemCheckers) setSystemStatusChecker ( systemCheckers) テストの構成からISystemStatusCheckerを設定します。
void	setTestLogger ( ITestLogger testLogger) ITestLoggerインスタンスを挿入します
	split (Integer shardCountHint, TestInformation testInfo) シャードを作成する親からの初期情報を含むTestInformationも提供するsplit(int)の代替バージョン。

保護されたメソッド
	createModuleListeners () ModuleListenerレベルに適用可能なITestInvocationListenerのリストを返します。
boolean	filterByConfigMetadata ( IConfiguration config, MultiMap <String, String> include, MultiMap <String, String> exclude) メタデータ フィルターを構成に適用し、構成が実行されるかどうかを確認します。
boolean	filterByRunnerType ( IConfiguration config, allowedRunners) filterByRunnerType ( IConfiguration config, allowedRunners) ランナー ホワイトリスト フィルタリングを適用し、ホワイトリストに登録されていないランナーをすべて削除します。
	getAbisForBuildTargetArch () Host ビルド ターゲット アーキテクチャでサポートされている abis を返します。
	getHostAbis () ホスト マシンの abis を返します。
void	setMultiDeviceStrategy ( ITestSuite.MultiDeviceModuleStrategy strategy)
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

PARAMETER_KEY

public static final String PARAMETER_KEY

PREPARER_WITELIST

public static final String PREPARER_WHITELIST

PRIMARY_ABI_RUN

public static final String PRIMARY_ABI_RUN

RANDOM_SEED

public static final String RANDOM_SEED

RUNNER_WHITELIST

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

TOKEN_KEY

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

getAbis

public  getAbis (ITestDevice device)

互換性テストAbiUtils.getAbisSupportedByCompatibility()とテスト対象のデバイスの両方でサポートされている ABI のセットを取得します。

パラメーター
device	ITestDevice

戻り値
	テストを実行する ABI のセット

スロー
DeviceNotAvailableException

getAbisForBuildTargetArchFromSuite

public static  getAbisForBuildTargetArchFromSuite ()

TestSuiteInfo から可能な abis を返します。

戻り値

getBuildInfo

public IBuildInfo getBuildInfo ()

ITestSuiteの実装では、テストをロードするためにビルド情報が必要になる場合があります。

戻り値
IBuildInfo

getConfiguration

public final IConfiguration getConfiguration ()

呼び出しIConfigurationを返します。

戻り値
IConfiguration

getCurrentTestLogger

public ITestLogger getCurrentTestLogger ()

戻り値
ITestLogger

getDevice

public ITestDevice getDevice ()

テスト対象のデバイスを取得します。

戻り値
ITestDevice	ITestDevice

getDirectModule

public ModuleDefinition getDirectModule ()

直接実行されるModuleDefinitionを返します。まだ実行されていない場合 (ITestSuite がまだシャードされていない場合) は null を返します。

戻り値
ModuleDefinition

getInvocationContext

public IInvocationContext getInvocationContext ()

呼び出しコンテキストを返します。

戻り値
IInvocationContext

getModuleMetadataIncludeFilters

public MultiMap<String, String> getModuleMetadataIncludeFilters ()

戻り値
MultiMap <String, String>

getRequestedAbi

public final String getRequestedAbi ()

オプション -a または --abi で要求された abi を返します。

戻り値
String

getRequiredTokens

public  getRequiredTokens (TestInformation testInfo)

テストで必要なトークンのリストを返します。トークンがサポートされていない場合は null を返します。

パラメーター
testInfo	TestInformation

戻り値

getRuntimeHint

public long getRuntimeHint ()

テストの予想実行時間をミリ秒単位で返します。この時間は、シャード実行の負荷分散に使用されます

戻り値
long

getTestsDir

public File getTestsDir ()

戻り値
File

分裂中

public boolean isSplitting ()

現在IShardableTest.split(int)にいる場合は true を返します。

戻り値
boolean

負荷テスト

public abstract  loadTests ()

実行されるテスト構成をロードするための抽象メソッド。各テストは、 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 : テストを実行するための有用な情報を含むTestInformationオブジェクト。
listener	ITestInvocationListener : テスト結果のITestInvocationListener

スロー
DeviceNotAvailableException

setAbiName

public void setAbiName (String abiName)

mAbiName の値を設定します

パラメーター
abiName	String

setAbis

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

setDirectModule

public void setDirectModule (ModuleDefinition module)

パラメーター
module	ModuleDefinition

setInvocationContext

public void setInvocationContext (IInvocationContext invocationContext)

パラメーター
invocationContext	IInvocationContext

setMetricCollectors

public void setMetricCollectors ( collectors)

テスト実行用に定義されたIMetricCollectorのリストを設定します。

パラメーター
collectors

setPrimaryAbiRun

public void setPrimaryAbiRun (boolean primaryAbiRun)

mPrimaryAbiRun の値を設定します

パラメーター
primaryAbiRun	boolean

setShouldMakeDynamicModule

public void setShouldMakeDynamicModule (boolean dynamicModule)

分散シャーディングを行う場合、プールでテストを共有する ModuleDefinition を持つことはできません。そうしないと、モジュール内シャーディングが機能しないため、無効にすることができます。

パラメーター
dynamicModule	boolean

setSystemStatusChecker

public void setSystemStatusChecker ( systemCheckers)

テストの構成からISystemStatusCheckerを設定します。

パラメーター
systemCheckers

setTestLogger

public void setTestLogger (ITestLogger testLogger)

ITestLoggerインスタンスを挿入します

パラメーター
testLogger	ITestLogger

スプリット

public  split (Integer shardCountHint, 
                TestInformation testInfo)

シャードを作成する親からの初期情報を含むTestInformationも提供するsplit(int)の代替バージョン。シャーディング中にデバイスやビルド情報などにアクセスする必要がある場合に便利です。

パラメーター
shardCountHint	Integer : 試行されたシャード数。
testInfo	TestInformation : 親のTestInformation

戻り値
	個別に実行されるサブテストのコレクション、またはテストが現在シャード可能でない場合はnull

保護されたメソッド

createModuleListeners

protected  createModuleListeners ()

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

protected  getAbisForBuildTargetArch ()

Host ビルド ターゲット アーキテクチャでサポートされている abis を返します。テストのために公開。

戻り値

getHostAbis

protected  getHostAbis ()

ホスト マシンの abis を返します。

戻り値

setMultiDeviceStrategy

protected void setMultiDeviceStrategy (ITestSuite.MultiDeviceModuleStrategy strategy)

パラメーター
strategy	ITestSuite.MultiDeviceModuleStrategy

shouldModuleRun

protected boolean shouldModuleRun (ModuleDefinition module)

パラメーター
module	ModuleDefinition

戻り値
boolean