ITestSuite

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

java.lang.Object
↳	com.android.tradefed.testtype.suite.ITestSuite

תת-כיתות ישירות ידועות BaseTestSuite, ‏ TfSuiteRunner BaseTestSuite בדיקה להרצת חבילה לבדיקות תאימות (CTS) עם מערכת חבילה חדשה.  TfSuiteRunner הטמעה של ITestSuite, שתטען בדיקות מהתיקייה res/config/suite/‎ של קובצי ה-jar של TF.

תת-כיתות עקיפות ידועות AtestRunner, ‏ TestMappingSuiteRunner AtestRunner הטמעה של ITestSuite  TestMappingSuiteRunner הטמעה של BaseTestSuite להרצת בדיקות שצוינו באמצעות האפשרות include-filter, או קובצי TEST_MAPPING מה-build, כחבילה.

---

כיתה מופשטת שמשמשת להרצת חבילת בדיקות. הכיתה הזו מספקת את הבסיס להפעלת ה-Suite. כל הטמעה יכולה להגדיר את רשימת הבדיקות באמצעות השיטה loadTests().

סיכום

שדות
public static final String	ABI_OPTION
public static final String	ACTIVE_MAINLINE_PARAMETER_KEY
public static final String	BUILD_ATTRIBUTE_FLAG_OVERRIDES_KEY
public static final String	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
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	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
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) הפונקציה מקבלת את קבוצת ה-ABIs שנתמכת גם בבדיקת התאימות AbiUtils.getAbisSupportedByCompatibility() וגם במכשיר שנבדק.
static	getAbisForBuildTargetArchFromSuite() הפונקציה מחזירה את ABIs האפשריים מ-TestSuiteInfo.
IBuildInfo	getBuildInfo() כדי להטמיע את ITestSuite, יכול להיות שתצטרכו את פרטי ה-build כדי לטעון את הבדיקות.
final IConfiguration	getConfiguration() הפונקציה מחזירה את ההפעלה IConfiguration.
ITestLogger	getCurrentTestLogger()
ITestDevice	getDevice() מקבלים את המכשיר לבדיקה.
ModuleDefinition	getDirectModule() הפונקציה מחזירה את ModuleDefinition לביצוע ישיר, או ערך null אם עדיין לא בוצעה חלוקה ל-ITestSuite (כש-ITestSuite עדיין לא פוצל).
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	isSplitting() הפונקציה מחזירה את הערך true אם אנחנו נמצאים כרגע ב-IShardableTest.split(int).
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 שמשתף בדיקות במאגר, אחרת חלוקה פנימית של המודול לא תפעל. לכן אנחנו מאפשרים להשבית את האפשרות הזו.
void	setSkipContext(SkipContext skipContext)
void	setSystemStatusChecker( systemCheckers) מגדיר את הערכים של ISystemStatusChecker מההגדרה של הבדיקה.
void	setTestLogger(ITestLogger testLogger) החדרת המכונה ITestLogger
	split(Integer shardCountHint, TestInformation testInfo) גרסה חלופית של split(int) שמספקת גם TestInformation שמכיל מידע מוקדם מההורה שיצר את הפיצולים.

שיטות מוגנות
	createModuleListeners() הפונקציה מחזירה את רשימת ה-ITestInvocationListener שרלוונטית לרמה ModuleListener.
boolean	filterByRunnerType(IConfiguration config, allowedRunners) מחילים את הסינון של רשימת ההיתרים של ה-Runner, ומסירים כל Runner שלא נכלל ברשימת ההיתרים.
	getAbisForBuildTargetArch() הפונקציה מחזירה את ABIs שנתמכים על ידי ארכיטקטורת היעד של build המארח.
	getHostAbis() הפונקציה מחזירה את abis של מחשב המארח.
void	setPrioritizeHostConfig(boolean prioritizeHostConfig) מגדירים את האפשרות prioritize-host-config.
boolean	shouldModuleRun(ModuleDefinition module)

שדות

ABI_OPTION

public static final String ABI_OPTION

ACTIVE_MAINLINE_PARAMETER_KEY

public static final String ACTIVE_MAINLINE_PARAMETER_KEY

BUILD_ATTRIBUTE_FLAG_OVERRIDES_KEY

public static final String BUILD_ATTRIBUTE_FLAG_OVERRIDES_KEY

ENABLE_RESOLVE_SYM_LINKS

public static final String ENABLE_RESOLVE_SYM_LINKS

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

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

RUNNER_WHITELIST

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

STAGE_MODULE_ARTIFACTS

public static final String STAGE_MODULE_ARTIFACTS

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

mEnableResolveSymlinks

protected boolean mEnableResolveSymlinks

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

cleanUpSuiteSetup

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 אחרת.

getAbis

public  getAbis (ITestDevice device)

הפונקציה מקבלת את קבוצת ה-ABIs שנתמכת גם בבדיקת התאימות AbiUtils.getAbisSupportedByCompatibility() וגם במכשיר שנבדק.

פרמטרים
device	ITestDevice

החזרות
	קבוצת ה-ABIs שבהם מריצים את הבדיקות

זריקות
	com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getAbisForBuildTargetArchFromSuite

public static  getAbisForBuildTargetArchFromSuite ()

הפונקציה מחזירה את ABIs האפשריים מ-TestSuiteInfo.

החזרות

getBuildInfo

public IBuildInfo getBuildInfo ()

כדי להטמיע את ITestSuite, יכול להיות שתצטרכו את פרטי ה-build כדי לטעון את הבדיקות.

החזרות
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 (כש-ITestSuite עדיין לא פוצל).

החזרות
ModuleDefinition

getIntraModuleSharding

public boolean getIntraModuleSharding ()

החזרות
boolean

getInvocationContext

public IInvocationContext getInvocationContext ()

הפונקציה מחזירה את הקשר ההפעלה.

החזרות
IInvocationContext

getModuleMetadataIncludeFilters

public MultiMap<String, String> getModuleMetadataIncludeFilters ()

החזרות
MultiMap<String, String>

getMultiDeviceStrategy

public ITestSuite.MultiDeviceModuleStrategy getMultiDeviceStrategy ()

החזרות
ITestSuite.MultiDeviceModuleStrategy

getRequestedAbi

public final String getRequestedAbi ()

הפונקציה מחזירה את ה-abi המבוקש באמצעות האפשרות -a או --abi.

החזרות
String

getRequiredTokens

public  getRequiredTokens (TestInformation testInfo)

הפונקציה מחזירה את רשימת האסימונים הנדרשים לבדיקה. הפונקציה מחזירה ערך null אם אין תמיכה באסימונים.

פרמטרים
testInfo	TestInformation

החזרות

getRuntimeHint

public long getRuntimeHint ()

הפונקציה מחזירה את זמן הריצה הצפוי של הבדיקה באלפיות שנייה. הזמן משמש לאיזון העומסים בביצוע המפוצל.

החזרות
long

getTestsDir

public File getTestsDir ()

החזרות
File

isSplitting

public boolean isSplitting ()

הפונקציה מחזירה את הערך true אם אנחנו נמצאים כרגע ב-IShardableTest.split(int).

החזרות
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: האובייקט 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

setIntraModuleSharding

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

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 שמכיל מידע מוקדם מההורה שיצר את הפיצולים. היא שימושית אם צריך לגשת למידע כמו פרטי המכשיר או פרטי ה-build במהלך חלוקת המידע למקטעים.

פרמטרים
shardCountHint	Integer: מספר הניסיונות ליצירת שבר.
testInfo	TestInformation: ההורה TestInformation

החזרות
	אוסף של בדיקות משנה שיופעלו בנפרד, או null אם אי אפשר לפצל את הבדיקה כרגע

שיטות מוגנות

createModuleListeners

protected  createModuleListeners ()

הפונקציה מחזירה את רשימת ה-ITestInvocationListener שרלוונטית לרמה ModuleListener. נעשה שימוש חוזר במאזינים האלה בכל מודול, הם לא יופעלו מחדש, ולכן לא צריך להניח שהם שומרים מצב פנימי.

החזרות

filterByRunnerType

protected boolean filterByRunnerType (IConfiguration config, 
                 allowedRunners)

מחילים את הסינון של רשימת ההיתרים של ה-Runner, ומסירים כל Runner שלא נכלל ברשימת ההיתרים. אם להגדרה יש כמה מפעילים, יכול להיות שחלק מהם יוסרו וההגדרה עדיין תפעל.

פרמטרים
config	IConfiguration: ה-IConfiguration שנבדק.
allowedRunners	: רשימת ההיתרים הנוכחית של ה-runner.

החזרות
boolean	הערך True אם מותר להפעיל את מודול התצורה, ו-False אחרת.

getAbisForBuildTargetArch

protected  getAbisForBuildTargetArch ()

הפונקציה מחזירה את ABIs שנתמכים על ידי ארכיטקטורת היעד של build המארח. חשוף לבדיקה.

החזרות

getHostAbis

protected  getHostAbis ()

הפונקציה מחזירה את abis של מחשב המארח.

החזרות

setPrioritizeHostConfig

protected void setPrioritizeHostConfig (boolean prioritizeHostConfig)

מגדירים את האפשרות prioritize-host-config.

פרמטרים
prioritizeHostConfig	boolean: true כדי לתת עדיפות להגדרות המארח, כלומר, להריץ בדיקת מארח אם אפשר.

shouldModuleRun

protected boolean shouldModuleRun (ModuleDefinition module)

פרמטרים
module	ModuleDefinition

החזרות
boolean