آی‌تست‌سوئیت

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

شیء جاوا
↳ com.android.tradefed.testtype.suite.ITestSuite

کلاس انتزاعی (abstract class) که برای اجرای مجموعه تست (Test Suite) استفاده می‌شود. این کلاس مبنای نحوه اجرای مجموعه را فراهم می‌کند. هر پیاده‌سازی می‌تواند لیست تست‌ها را از طریق متد loadTests() تعریف کند.

خلاصه

ثابت‌ها

String ABI_OPTION

String ACTIVE_MAINLINE_PARAMETER_KEY

String BUILD_ATTRIBUTE_FLAG_OVERRIDES_KEY

String ENABLE_RESOLVE_SYM_LINKS

String MAINLINE_PARAMETER_KEY

String MODULE_CHECKER_POST

String MODULE_CHECKER_PRE

String MODULE_END_TIME

String MODULE_METADATA_EXCLUDE_FILTER

String MODULE_METADATA_INCLUDE_FILTER

String MODULE_START_TIME

String PARAMETER_KEY

String PREPARER_WHITELIST

String PRIMARY_ABI_RUN

String RANDOM_SEED

String RUNNER_WHITELIST

String SKIP_HOST_ARCH_CHECK

String SKIP_STAGING_ARTIFACTS

String SKIP_SYSTEM_STATUS_CHECKER

String STAGE_MODULE_ARTIFACTS

String TEST_TYPE_KEY

String TEST_TYPE_VALUE_PERFORMANCE

String TOKEN_KEY

فیلدها

protected boolean mEnableResolveSymlinks

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)

مجموعه ABI های پشتیبانی شده توسط تست سازگاری AbiUtils.getAbisSupportedByCompatibility() و دستگاه تحت آزمایش را دریافت می‌کند.

static getAbisForBuildTargetArchFromSuite ()

abis های ممکن را از TestSuiteInfo برمی‌گرداند.

IBuildInfo getBuildInfo ()

پیاده‌سازی ITestSuite ممکن است برای بارگذاری تست‌ها به اطلاعات ساخت نیاز داشته باشد.

final IConfiguration getConfiguration ()

فراخوانی IConfiguration را برمی‌گرداند.

ITestLogger getCurrentTestLogger ()
ITestDevice getDevice ()

دستگاه را تحت آزمایش قرار دهید.

ModuleDefinition getDirectModule ()

ModuleDefinition را برای اجرا مستقیم برمی‌گرداند، یا اگر هنوز اجرا نشده باشد، null برمی‌گرداند (وقتی ITestSuite هنوز shard نشده است).

boolean getIntraModuleSharding ()
IInvocationContext getInvocationContext ()

زمینه فراخوانی را برمی‌گرداند.

MultiMap <String, String> getModuleMetadataIncludeFilters ()
ITestSuite.MultiDeviceModuleStrategy getMultiDeviceStrategy ()
final String getRequestedAbi ()

abi درخواست شده با گزینه -a یا --abi را برمی‌گرداند.

getRequiredTokens ( TestInformation testInfo)

لیست توکن‌های مورد نیاز توسط تست را برمی‌گرداند.

long getRuntimeHint ()

زمان اجرای مورد انتظار تست را بر حسب میلی ثانیه برگردانید.

File getTestsDir ()
boolean isRemoveModuleBuffering ()
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)
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)

لیست IMetricCollector های تعریف شده برای اجرای تست را تنظیم می‌کند.

void setMultiDeviceStrategy ( ITestSuite.MultiDeviceModuleStrategy strategy)
void setPrimaryAbiRun (boolean primaryAbiRun)

مقدار mPrimaryAbiRun را تنظیم کنید

void setShouldMakeDynamicModule (boolean dynamicModule)

هنگام انجام شاردینگ توزیع‌شده، نمی‌توانیم ModuleDefinition داشته باشیم که تست‌ها را در یک Pool به اشتراک بگذارد، در غیر این صورت شاردینگ درون ماژولی کار نخواهد کرد، بنابراین می‌توانیم آن را غیرفعال کنیم.

void setSkipContext ( SkipContext skipContext)
void setSystemStatusChecker ( systemCheckers)

ISystemStatusChecker ها را از پیکربندی برای تست تنظیم می‌کند.

void setTestLogger ( ITestLogger testLogger)

نمونه ITestLogger را تزریق می‌کند

split (Integer shardCountHint, TestInformation testInfo)

نسخه جایگزین split(int) که یک TestInformation نیز ارائه می‌دهد که شامل اطلاعات اولیه از والدِ ایجادکننده‌ی Shardها است.

روش‌های محافظت‌شده

createModuleListeners ()

لیستی از ITestInvocationListener قابل اجرا در سطح ModuleListener را برمی‌گرداند.

boolean filterByRunnerType ( IConfiguration config, allowedRunners)

فیلتر لیست سفید Runner را اعمال کنید و هر runner که در لیست سفید قرار نگرفته است را حذف کنید.

getAbisForBuildTargetArch ()

abis پشتیبانی شده توسط معماری هدف ساخت میزبان را برگردانید.

getHostAbis ()

دستگاه میزبان abis را برمی‌گرداند.

void setPrioritizeHostConfig (boolean prioritizeHostConfig)

گزینه اولویت‌بندی-میزبان-پیکربندی را تنظیم کنید.

boolean shouldModuleRun ( ModuleDefinition module)

ثابت‌ها

ABI_OPTION 

public static final String ABI_OPTION

مقدار ثابت: "abi"

کلید پارامتر خط اصلی فعال 

public static final String ACTIVE_MAINLINE_PARAMETER_KEY

مقدار ثابت: "پارامتر-خط-اصلی فعال"

کلید ترکیبی BUILD_ATTRIBUTE_FLAG_OVERRIDES 

public static final String BUILD_ATTRIBUTE_FLAG_OVERRIDES_KEY

مقدار ثابت: "flag-overrides" 

public static final String ENABLE_RESOLVE_SYM_LINKS

مقدار ثابت: "enable-resolve-sym-links"

کلید پارامتر خط اصلی 

public static final String MAINLINE_PARAMETER_KEY

مقدار ثابت: "پارامتر خط اصلی"

ماژول_بررسی_پست 

public static final String MODULE_CHECKER_POST

مقدار ثابت: "بررسی‌کننده‌ی ماژول پست"

ماژول_بررسی_قبلی 

public static final String MODULE_CHECKER_PRE

مقدار ثابت: "PreModuleChecker"

زمان پایان ماژول 

public static final String MODULE_END_TIME

مقدار ثابت: "زمان پایان ماژول"

فیلتر حذف ماژول فراداده 

public static final String MODULE_METADATA_EXCLUDE_FILTER

مقدار ثابت: "module-metadata-exclude-filter"

فیلتر شامل فراداده ماژول 

public static final String MODULE_METADATA_INCLUDE_FILTER

مقدار ثابت: "module-metadata-include-filter"

زمان شروع ماژول 

public static final String MODULE_START_TIME

مقدار ثابت: "MODULE_START_TIME"

کلید پارامتر 

public static final String PARAMETER_KEY

مقدار ثابت: "پارامتر"

لیست سفید آماده‌کننده 

public static final String PREPARER_WHITELIST

مقدار ثابت: "لیست سفید آماده‌کننده"

اجرای اولیه ABI 

public static final String PRIMARY_ABI_RUN

مقدار ثابت: "فقط مقادیر اولیه"

RANDOM_SEED 

public static final String RANDOM_SEED

مقدار ثابت: "random-seed"

لیست سفید دونده 

public static final String RUNNER_WHITELIST

مقدار ثابت: "لیست سفید دونده"

بررسی نکردن میزبان 

public static final String SKIP_HOST_ARCH_CHECK

مقدار ثابت: "skip-host-arch-check"

رد کردن آثار باستانی 

public static final String SKIP_STAGING_ARTIFACTS

مقدار ثابت: "رد کردن-مرحله‌بندی-مصنوعات"

بررسی وضعیت سیستم از حالت غیرفعال 

public static final String SKIP_SYSTEM_STATUS_CHECKER

مقدار ثابت: "گذشت از بررسی وضعیت سیستم"

آثار مرحله‌ای ماژول 

public static final String STAGE_MODULE_ARTIFACTS

مقدار ثابت: "ماژول-مرحله-مصنوعات"

نوع_کلید_آزمون 

public static final String TEST_TYPE_KEY

مقدار ثابت: "نوع آزمایشی"

تست_نوع_مقدار_عملکرد 

public static final String TEST_TYPE_VALUE_PERFORMANCE

مقدار ثابت: "عملکرد"

کلید_توکن 

public static final String TOKEN_KEY

مقدار ثابت: "توکن"

فیلدها 

protected boolean mEnableResolveSymlinks

mRecoverDeviceByCvd 

protected boolean mRecoverDeviceByCvd

سازندگان عمومی

آی‌تست‌سوئیت 

public ITestSuite ()

روش‌های عمومی

فیلترهای addModuleMetadataExclude 

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

پارامترها
filters MultiMap

addModuleMetadataIncludeفیلترها 

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

پارامترها
filters MultiMap

cleanUpSuiteSetup 

public void cleanUpSuiteSetup ()

فرصتی برای پاک کردن تمام مواردی که در طول راه‌اندازی سوئیت‌ها مورد نیاز بودند اما برای اجرای تست‌ها لازم نیستند.

filterByConfigفراداده 

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)

مجموعه ABI های پشتیبانی شده توسط تست سازگاری AbiUtils.getAbisSupportedByCompatibility() و دستگاه تحت آزمایش را دریافت می‌کند.

پارامترها
device ITestDevice

بازگشت‌ها
مجموعه ABIهایی که قرار است تست‌ها روی آنها اجرا شوند

پرتاب‌ها
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

دریافتAbisForBuildTargetArchFromSuite 

public static  getAbisForBuildTargetArchFromSuite ()

abis های ممکن را از TestSuiteInfo برمی‌گرداند.

بازگشت‌ها

اطلاعات ساخت را دریافت کنید 

public IBuildInfo getBuildInfo ()

پیاده‌سازی ITestSuite ممکن است برای بارگذاری تست‌ها به اطلاعات ساخت نیاز داشته باشد.

بازگشت‌ها
IBuildInfo

دریافت پیکربندی 

public final IConfiguration getConfiguration ()

فراخوانی IConfiguration را برمی‌گرداند.

بازگشت‌ها
IConfiguration

getCurrentTestLogger 

public ITestLogger getCurrentTestLogger ()

بازگشت‌ها
ITestLogger

دریافت دستگاه 

public ITestDevice getDevice ()

دستگاه را تحت آزمایش قرار دهید.

بازگشت‌ها
ITestDevice ITestDevice

ماژول getDirect 

public ModuleDefinition getDirectModule ()

ModuleDefinition را برای اجرا مستقیم برمی‌گرداند، یا اگر هنوز اجرا نشده باشد، null برمی‌گرداند (وقتی ITestSuite هنوز shard نشده است).

بازگشت‌ها
ModuleDefinition

دریافت درون ماژولی (getIntraModuleSharding) 

public boolean getIntraModuleSharding ()

بازگشت‌ها
boolean

دریافتInvocationContext 

public IInvocationContext getInvocationContext ()

زمینه فراخوانی را برمی‌گرداند.

بازگشت‌ها
IInvocationContext

فیلترهای getModuleMetadataInclude 

public MultiMap<String, String> getModuleMetadataIncludeFilters ()

بازگشت‌ها
MultiMap <String, String>

استراتژی getMultiDevice 

public ITestSuite.MultiDeviceModuleStrategy getMultiDeviceStrategy ()

بازگشت‌ها
ITestSuite.MultiDeviceModuleStrategy

درخواست‌شده 

public final String getRequestedAbi ()

abi درخواست شده با گزینه -a یا --abi را برمی‌گرداند.

بازگشت‌ها
String

دریافت توکن‌های مورد نیاز 

public  getRequiredTokens (TestInformation testInfo)

لیست توکن‌های مورد نیاز توسط تست را برمی‌گرداند. در صورت عدم پشتیبانی از توکن، مقدار null را برمی‌گرداند.

پارامترها
testInfo TestInformation

بازگشت‌ها

getRuntimeHint 

public long getRuntimeHint ()

زمان اجرای مورد انتظار تست را بر حسب میلی‌ثانیه برمی‌گرداند. این زمان برای بارگذاری تعادل اجرای تکه‌تکه شده استفاده می‌شود.

بازگشت‌ها
long

دریافتTestsDir 

public File getTestsDir ()

بازگشت‌ها
File

بافرینگ ماژول حذف‌شده 

public boolean isRemoveModuleBuffering ()

بازگشت‌ها
boolean

تقسیم‌بندی 

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

نام مجموعه AbiName 

public void setAbiName (String abiName)

مقدار mAbiName را تنظیم کنید.

پارامترها
abiName String

مجموعه ابیس 

public final void setAbis ( abis)

پارامترها
abis

مجموعه ساخت 

public void setBuild (IBuildInfo buildInfo)

پارامترها
buildInfo IBuildInfo

فقط تست‌های جمع‌آوری‌شده 

public void setCollectTestsOnly (boolean shouldCollectTest)

مجموعه تست را در حالت فقط جمع‌کننده اجرا کنید، این امر مستلزم آن است که تمام زیرتست‌ها نیز این رابط را پیاده‌سازی کنند.

پیکربندی set 

public void setConfiguration (IConfiguration configuration)

IConfiguration مورد استفاده را تزریق می‌کند.

پارامترها
configuration IConfiguration

دستگاه تنظیم‌شده 

public void setDevice (ITestDevice device)

دستگاه تحت آزمایش را تزریق کنید.

پارامترها
device ITestDevice : دستگاه ITestDevice مورد استفاده

ماژول setDirect 

public void setDirectModule (ModuleDefinition module)

پارامترها
module ModuleDefinition

setIntraModuleSharding 

public void setIntraModuleSharding (boolean intraModuleSharding)

پارامترها
intraModuleSharding boolean

setInvocationContext 

public void setInvocationContext (IInvocationContext invocationContext)

پارامترها
invocationContext IInvocationContext

مجموعه‌جمع‌کننده‌های متریک 

public void setMetricCollectors ( collectors)

لیست IMetricCollector های تعریف شده برای اجرای تست را تنظیم می‌کند.

پارامترها
collectors

استراتژی setMultiDevice 

public void setMultiDeviceStrategy (ITestSuite.MultiDeviceModuleStrategy strategy)

پارامترها
strategy ITestSuite.MultiDeviceModuleStrategy

setPrimaryAbiRun 

public void setPrimaryAbiRun (boolean primaryAbiRun)

مقدار mPrimaryAbiRun را تنظیم کنید

پارامترها
primaryAbiRun boolean

ماژول پویای setShouldMake 

public void setShouldMakeDynamicModule (boolean dynamicModule)

هنگام انجام شاردینگ توزیع‌شده، نمی‌توانیم ModuleDefinition داشته باشیم که تست‌ها را در یک Pool به اشتراک بگذارد، در غیر این صورت شاردینگ درون ماژولی کار نخواهد کرد، بنابراین می‌توانیم آن را غیرفعال کنیم.

پارامترها
dynamicModule boolean

setSkipContext 

public void setSkipContext (SkipContext skipContext)

پارامترها
skipContext SkipContext

بررسی‌کننده وضعیت سیستم (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 نیز ارائه می‌دهد که شامل اطلاعات اولیه از والد ایجادکننده‌ی shardها است. این مورد در صورتی مفید است که در طول sharding به مواردی مانند اطلاعات دستگاه یا ساخت نیاز باشد.

پارامترها
shardCountHint Integer : تعداد دفعات تلاش برای ایجاد خرده ریز.

testInfo TestInformation : کلاس والد TestInformation

بازگشت‌ها
مجموعه‌ای از زیرآزمون‌ها که باید جداگانه اجرا شوند یا اگر آزمون در حال حاضر قابل تقسیم‌بندی نیست، null

روش‌های محافظت‌شده

ایجادکننده‌های ماژول 

protected  createModuleListeners ()

لیستی از ITestInvocationListener قابل اجرا در سطح ModuleListener را برمی‌گرداند. این listener ها برای هر ماژول دوباره استفاده خواهند شد، دوباره نمونه سازی نمی‌شوند، بنابراین نباید حالت داخلی داشته باشند.

بازگشت‌ها

filterByRunnerType 

protected boolean filterByRunnerType (IConfiguration config, 
                 allowedRunners)

فیلتر لیست سفید Runner را اعمال کنید و هر runner ای را که در لیست سفید قرار نگرفته است، حذف کنید. اگر یک پیکربندی چندین runner داشته باشد، ممکن است برخی از آنها حذف شوند و پیکربندی همچنان اجرا شود.

پارامترها
config IConfiguration : IConfiguration مورد ارزیابی قرار می‌گیرد.

allowedRunners : لیست سفید دونده فعلی.

بازگشت‌ها
boolean اگر ماژول پیکربندی مجاز به اجرا باشد، مقدار true و در غیر این صورت false برمی‌گرداند.

دریافتAbisForBuildTargetArch 

protected  getAbisForBuildTargetArch ()

abis پشتیبانی شده توسط معماری هدف ساخت میزبان را برگردانید. برای آزمایش در معرض نمایش قرار داده شده است.

بازگشت‌ها

دریافت هاست ابیس 

protected  getHostAbis ()

دستگاه میزبان abis را برمی‌گرداند.

بازگشت‌ها

پیکربندی اولویت‌بندی میزبان (setPrioritizeHostConfig) 

protected void setPrioritizeHostConfig (boolean prioritizeHostConfig)

گزینه اولویت‌بندی-میزبان-پیکربندی را تنظیم کنید.

پارامترها
prioritizeHostConfig boolean : true برای اولویت‌بندی پیکربندی میزبان، یعنی اجرای تست میزبان در صورت امکان.

shouldModuleRun 

protected boolean shouldModuleRun (ModuleDefinition module)

پارامترها
module ModuleDefinition

بازگشت‌ها
boolean