ITestSuite

public abstract class ITestSuite
extends Object implements IRemoteTest , IDeviceTest , IBuildReceiver , ISystemStatusCheckerReceiver , IShardableTest , ITestCollector , IInvocationContextReceiver , IRuntimeHintProvider , IMetricCollectorReceiver , IConfigurationReceiver , IReportNotExecuted , ITokenRequest , ITestLoggerReceiver

java.lang.オブジェクト
↳ 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_END_TIME

public static final String MODULE_METADATA_EXCLUDE_FILTER

public static final String MODULE_METADATA_INCLUDE_FILTER

public static final String MODULE_START_TIME

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_STAGING_ARTIFACTS

public static final String SKIP_SYSTEM_STATUS_CHECKER

public static final String TEST_TYPE_KEY

public static final String TEST_TYPE_VALUE_PERFORMANCE

public static final String TOKEN_KEY

protected boolean mRecoverDeviceByCvd

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

ITestSuite ()

パブリックメソッド

void addModuleMetadataExcludeFilters ( MultiMap <String, String> filters)
void addModuleMetadataIncludeFilters ( MultiMap <String, String> filters)
void cleanUpSuiteSetup ()

スイートのセットアップ中に必要であったが、テストの実行には必要ではなかったものをすべてクリーンアップする機会。

boolean filterByConfigMetadata ( IConfiguration config, MultiMap <String, String> include, MultiMap <String, String> exclude)

メタデータ フィルターを構成に適用し、構成が実行されるかどうかを確認します。

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 ()
ITestSuite.MultiDeviceModuleStrategy getMultiDeviceStrategy ()
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 setIntraModuleSharding (boolean intraModuleSharding)
void setInvocationContext ( IInvocationContext invocationContext)

void setMetricCollectors ( collectors) setMetricCollectors ( collectors)

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

void setMultiDeviceStrategy ( ITestSuite.MultiDeviceModuleStrategy strategy)
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)

split(int)の代替バージョン。シャードを作成する親からの初期情報を含むTestInformationも提供します。

保護されたメソッド

createModuleListeners ()

ModuleListenerレベルに適用できるITestInvocationListenerのリストを返します。

boolean filterByRunnerType ( IConfiguration config, allowedRunners) filterByRunnerType ( IConfiguration config, allowedRunners)

ランナー ホワイトリスト フィルタリングを適用し、ホワイトリストに登録されていないランナーを削除します。

getAbisForBuildTargetArch ()

ホスト ビルド ターゲット アーキテクチャでサポートされている abi を返します。

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_END_TIME

public static final String MODULE_END_TIME

MODULE_METADATA_EXCLUDE_FILTER

public static final String MODULE_METADATA_EXCLUDE_FILTER

MODULE_METADATA_INCLUDE_FILTER

public static final String MODULE_METADATA_INCLUDE_FILTER

MODULE_START_TIME

public static final String MODULE_START_TIME

パラメータキー

public static final String PARAMETER_KEY

準備者_ホワイトリスト

public static final String PREPARER_WHITELIST

PRIMARY_ABI_RUN

public static final String PRIMARY_ABI_RUN

ランダムシード

public static final String RANDOM_SEED

ランナー_ホワイトリスト

public static final String RUNNER_WHITELIST

SKIP_HOST_ARCH_CHECK

public static final String SKIP_HOST_ARCH_CHECK

SKIP_STAGING_ARTIFACTS

public static final String SKIP_STAGING_ARTIFACTS

SKIP_SYSTEM_STATUS_CHECKER

public static final String SKIP_SYSTEM_STATUS_CHECKER

TEST_TYPE_KEY

public static final String TEST_TYPE_KEY

TEST_TYPE_VALUE_PERFORMANCE

public static final String TEST_TYPE_VALUE_PERFORMANCE

TOKEN_KEY

public static final String TOKEN_KEY

mRecoverDeviceByCvd

protected boolean mRecoverDeviceByCvd

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

ITestSuite

public ITestSuite ()

パブリックメソッド

addModuleMetadataExcludeFilters

public void addModuleMetadataExcludeFilters (MultiMap<String, String> filters)

パラメーター
filters MultiMap

addModuleMetadataIncludeFilters

public void addModuleMetadataIncludeFilters (MultiMap<String, String> filters)

パラメーター
filters MultiMap

cleanUpSuiteセットアップ

public void cleanUpSuiteSetup ()

スイートのセットアップ中に必要であったが、テストの実行には必要ではなかったものをすべてクリーンアップする機会。

filterByConfigMetadata

public boolean filterByConfigMetadata (IConfiguration config, 
                MultiMap<String, String> include, 
                MultiMap<String, String> exclude)

メタデータ フィルターを構成に適用し、構成が実行されるかどうかを確認します。

パラメーター
config IConfiguration : 評価されるIConfiguration 。

include MultiMap : メタデータ インクルード フィルター

exclude MultiMap : メタデータ除外フィルター

戻り値
booleanモジュールを実行する必要がある場合は true、それ以外の場合は false。

アビスを取得

public  getAbis (ITestDevice device)

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

パラメーター
device ITestDevice

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

投げる
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getAbisForBuildTargetArchFromSuite

public static  getAbisForBuildTargetArchFromSuite ()

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

戻り値

ビルド情報の取得

public IBuildInfo getBuildInfo ()

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

戻り値
IBuildInfo

get構成

public final IConfiguration getConfiguration ()

IConfigurationの呼び出しを返します。

戻り値
IConfiguration

getCurrentTestLogger

public ITestLogger getCurrentTestLogger ()

戻り値
ITestLogger

デバイスの取得

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>

getマルチデバイス戦略

public ITestSuite.MultiDeviceModuleStrategy getMultiDeviceStrategy ()

戻り値
ITestSuite.MultiDeviceModuleStrategy

getRequestedAbi

public final String getRequestedAbi ()

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

戻り値
String

getRequiredTokens

public  getRequiredTokens (TestInformation testInfo)

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

パラメーター
testInfo TestInformation

戻り値

ランタイムヒントの取得

public long getRuntimeHint ()

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

戻り値
long

getTestsDir

public File getTestsDir ()

戻り値
File

分割中です

public boolean isSplitting ()

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

戻り値
boolean

ロードテスト

public abstract  loadTests ()

実行されるテスト構成をロードする抽象メソッド。各テストは、 IConfigurationと結果を報告する一意の名前によって定義されます。

戻り値

レポート未実行

public void reportNotExecuted (ITestInvocationListener listener, 
                String message)

実行されなかったテストを、提供されたメイン リスナーに報告します。これらはNOT_EXECUTED_FAILUREメッセージで失敗として報告されるはずです。

パラメーター
listener ITestInvocationListener : 実行されなかった結果を報告するメインのリスナー。

message String : 実行されなかった失敗に関連付けられるメッセージ。

レポート未実行

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

セットアビス

public final void setAbis ( abis)

パラメーター
abis

setBuild

public void setBuild (IBuildInfo buildInfo)

パラメーター
buildInfo IBuildInfo

setCollectTestsOnly

public void setCollectTestsOnly (boolean shouldCollectTest)

テスト スイートをコレクター専用モードで実行します。これには、すべてのサブテストもこのインターフェイスを実装する必要があります。

set構成

public void setConfiguration (IConfiguration configuration)

使用中のIConfigurationを挿入します。

パラメーター
configuration IConfiguration

セットデバイス

public void setDevice (ITestDevice device)

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

パラメーター
device ITestDevice : 使用するITestDevice

setDirectModule

public void setDirectModule (ModuleDefinition module)

パラメーター
module ModuleDefinition

setIntraModuleシャーディング

public void setIntraModuleSharding (boolean intraModuleSharding)

パラメーター
intraModuleSharding boolean

setInvocationContext

public void setInvocationContext (IInvocationContext invocationContext)

パラメーター
invocationContext IInvocationContext

setMetricCollectors

public void setMetricCollectors ( collectors)

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

パラメーター
collectors

setMultiDeviceStrategy

public void setMultiDeviceStrategy (ITestSuite.MultiDeviceModuleStrategy strategy)

パラメーター
strategy ITestSuite.MultiDeviceModuleStrategy

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)

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

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

testInfo TestInformation : 親のTestInformation

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

保護されたメソッド

createModuleListeners

protected  createModuleListeners ()

ModuleListenerレベルに適用できるITestInvocationListenerのリストを返します。これらのリスナーはモジュールごとに再利用され、再インスタンス化されないため、内部状態を想定すべきではありません。

戻り値

ランナータイプによるフィルター

protected boolean filterByRunnerType (IConfiguration config, 
                 allowedRunners)

ランナー ホワイトリスト フィルタリングを適用し、ホワイトリストに登録されていないランナーを削除します。構成に複数のランナーがある場合、一部が削除されても構成は引き続き実行される可能性があります。

パラメーター
config IConfiguration : 評価されるIConfiguration 。

allowedRunners : 現在のランナーのホワイトリスト。

戻り値
boolean構成モジュールの実行が許可されている場合は true、それ以外の場合は false。

getAbisForBuildTargetArch

protected  getAbisForBuildTargetArch ()

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

戻り値

getHostAbis

protected  getHostAbis ()

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

戻り値

shouldModuleRun

protected boolean shouldModuleRun (ModuleDefinition module)

パラメーター
module ModuleDefinition

戻り値
boolean