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

TestSuiteの実行に使用される抽象クラス。このクラスは、スイートの実行方法の基礎を提供します。各実装は、 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 ()

テスト前の再起動をtrueに設定します。

getAbis (ITestDevice device)

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

static getAbisForBuildTargetArchFromSuite ()

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

IBuildInfo getBuildInfo ()

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

final IConfiguration getConfiguration ()

呼び出しIConfigurationを返します。

ITestLogger getCurrentTestLogger ()
ITestDevice getDevice ()

テスト対象のデバイスを入手します。

ModuleDefinition getDirectModule ()

直接実行されるModuleDefinitionを返します。まだ実行されていない場合は、nullを返します（ITestSuiteがまだシャーディングされていない場合）。

IInvocationContext getInvocationContext ()

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

final String getRequestedAbi ()

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

getRequiredTokens ()
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 setInvocationContext (IInvocationContext invocationContext)

void setInvocationInjector (Injector injector)

呼び出しから現在のGuice Injectorを取得します。

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)

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

ホストビルドターゲットアーキテクチャでサポートされている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

PARAMETER_KEY

public static final String PARAMETER_KEY

PREPARER_WHITELIST

public static final String PREPARER_WHITELIST

PRIMARY_ABI_RUN

public static final String PRIMARY_ABI_RUN

RANDOM_SEED

public static final String RANDOM_SEED

REBOOT_BEFORE_TEST

public static final String REBOOT_BEFORE_TEST

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

enableRebootBeforeTest

public final void enableRebootBeforeTest ()

テスト前の再起動をtrueに設定します。

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を返します。まだ実行されていない場合は、nullを返します（ITestSuiteがまだシャーディングされていない場合）。

戻り値
ModuleDefinition

getInvocationContext

public IInvocationContext getInvocationContext ()

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

戻り値
IInvocationContext

getRequestedAbi

public final String getRequestedAbi ()

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

戻り値
String

getRequiredTokens

public  getRequiredTokens ()

戻り値

getRuntimeHint

public long getRuntimeHint ()

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

戻り値
long

getTestsDir

public File getTestsDir ()

戻り値
File

isSplitting

public boolean isSplitting ()

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

戻り値
boolean

loadTests

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

listener 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

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

setShouldMakeDynamicModule

public void setShouldMakeDynamicModule (boolean dynamicModule)

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

パラメーター
dynamicModule boolean

setSystemStatusChecker

public void setSystemStatusChecker ( systemCheckers)

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

パラメーター
systemCheckers

setTestLogger

public void setTestLogger (ITestLogger testLogger)

パラメーター
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 ()

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

戻り値

getHostAbis

protected  getHostAbis ()

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

戻り値

shouldModuleRun

protected boolean shouldModuleRun (ModuleDefinition module)

パラメーター
module ModuleDefinition

戻り値
boolean