IToolSuite

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 שתטען בדיקות מקובצי TF jars res/config/suite/ folder.

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

---

Abstract class used to run 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

Constructors ציבוריים
ITestSuite()

‫methods ציבוריים
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() מחזירה את ה-ABI האפשריים מ-TestSuiteInfo.
IBuildInfo	getBuildInfo() יכול להיות שהטמעה של ITestSuite תדרוש טעינה של פרטי ה-build כדי להריץ את הבדיקות.
final IConfiguration	getConfiguration() מחזירה את הקריאה IConfiguration.
ITestLogger	getCurrentTestLogger()
ITestDevice	getDevice() משיגים את המכשיר שנבדק.
ModuleDefinition	getDirectModule() הפונקציה מחזירה את ModuleDefinition שצריך להפעיל ישירות, או null אם עדיין לא הוגדר (כאשר 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	isRemoveModuleBuffering()
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) הגדרת רשימת IMetricCollectors שהוגדרו להרצת הבדיקה.
void	setMultiDeviceStrategy(ITestSuite.MultiDeviceModuleStrategy strategy)
void	setPrimaryAbiRun(boolean primaryAbiRun) הגדרת הערך של mPrimaryAbiRun
void	setShouldMakeDynamicModule(boolean dynamicModule) כשמבצעים חלוקה למקטעים מבוזרת, אי אפשר להשתמש ב-ModuleDefinition שמשתף בדיקות במאגר, אחרת חלוקה למקטעים בתוך מודול לא תפעל, ולכן אנחנו מאפשרים להשבית אותה.
void	setSkipContext(SkipContext skipContext)
void	setSystemStatusChecker( systemCheckers) הגדרת ISystemStatusCheckers מההגדרה לבדיקה.
void	setTestLogger(ITestLogger testLogger) החדרת המופע ITestLogger
	split(Integer shardCountHint, TestInformation testInfo) גרסה חלופית של split(int) שמספקת גם TestInformation שמכיל מידע מוקדם מההורה שיוצר את הרסיסים.

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

ערכים קבועים

ABI_OPTION

public static final String ABI_OPTION

ערך קבוע: "abi"

ACTIVE_MAINLINE_PARAMETER_KEY

public static final String ACTIVE_MAINLINE_PARAMETER_KEY

ערך קבוע: "active-mainline-parameter"

BUILD_ATTRIBUTE_FLAG_OVERRIDES_KEY

public static final String BUILD_ATTRIBUTE_FLAG_OVERRIDES_KEY

ערך קבוע: "flag-overrides"

ENABLE_RESOLVE_SYM_LINKS

public static final String ENABLE_RESOLVE_SYM_LINKS

ערך קבוע: "enable-resolve-sym-links"

MAINLINE_PARAMETER_KEY

public static final String MAINLINE_PARAMETER_KEY

ערך קבוע: "mainline-param"

MODULE_CHECKER_POST

public static final String MODULE_CHECKER_POST

ערך קבוע: "PostModuleChecker"

MODULE_CHECKER_PRE

public static final String MODULE_CHECKER_PRE

ערך קבוע: "PreModuleChecker"

MODULE_END_TIME

public static final String MODULE_END_TIME

ערך קבוע: "MODULE_END_TIME"

MODULE_METADATA_EXCLUDE_FILTER

public static final String MODULE_METADATA_EXCLUDE_FILTER

ערך קבוע: "module-metadata-exclude-filter"

MODULE_METADATA_INCLUDE_FILTER

public static final String MODULE_METADATA_INCLUDE_FILTER

ערך קבוע: "module-metadata-include-filter"

MODULE_START_TIME

public static final String MODULE_START_TIME

ערך קבוע: "MODULE_START_TIME"

PARAMETER_KEY

public static final String PARAMETER_KEY

ערך קבוע: "parameter"

PREPARER_WHITELIST

public static final String PREPARER_WHITELIST

ערך קבוע: ‎"preparer-whitelist"‎

PRIMARY_ABI_RUN

public static final String PRIMARY_ABI_RUN

ערך קבוע: "primary-abi-only"

RANDOM_SEED

public static final String RANDOM_SEED

ערך קבוע: ‎"random-seed"‎

RUNNER_WHITELIST

public static final String RUNNER_WHITELIST

ערך קבוע: "runner-whitelist"

SKIP_HOST_ARCH_CHECK

public static final String SKIP_HOST_ARCH_CHECK

ערך קבוע: "skip-host-arch-check"

SKIP_STAGING_ARTIFACTS

public static final String SKIP_STAGING_ARTIFACTS

ערך קבוע: "skip-staging-artifacts"

SKIP_SYSTEM_STATUS_CHECKER

public static final String SKIP_SYSTEM_STATUS_CHECKER

ערך קבוע: "skip-system-status-check"

STAGE_MODULE_ARTIFACTS

public static final String STAGE_MODULE_ARTIFACTS

ערך קבוע: "stage-module-artifacts"

TEST_TYPE_KEY

public static final String TEST_TYPE_KEY

ערך קבוע: test-type

TEST_TYPE_VALUE_PERFORMANCE

public static final String TEST_TYPE_VALUE_PERFORMANCE

ערך קבוע: 'ביצועים'

TOKEN_KEY

public static final String TOKEN_KEY

ערך קבוע: "token"

שדות

mEnableResolveSymlinks

protected boolean mEnableResolveSymlinks

mRecoverDeviceByCvd

protected boolean mRecoverDeviceByCvd

Constructors ציבוריים

IToolSuite

public ITestSuite ()

‫methods ציבוריים

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)

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

פרמטרים
device	ITestDevice

החזרות
	קבוצת ה-ABI להרצת הבדיקות

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

getAbisForBuildTargetArchFromSuite

public static  getAbisForBuildTargetArchFromSuite ()

מחזירה את ה-ABI האפשריים מ-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 עדיין לא חולק).

החזרות
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

isRemoveModuleBuffering

public boolean isRemoveModuleBuffering ()

החזרות
boolean

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)

הגדרת רשימת IMetricCollectors שהוגדרו להרצת הבדיקה.

פרמטרים
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)

הגדרת ISystemStatusCheckers מההגדרה לבדיקה.

פרמטרים
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 ()

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

החזרות

filterByRunnerType

protected boolean filterByRunnerType (IConfiguration config, 
                 allowedRunners)

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

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

החזרות
boolean	‫True אם מותר להפעיל את מודול ההגדרה, אחרת False.

getAbisForBuildTargetArch

protected  getAbisForBuildTargetArch ()

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

החזרות

getHostAbis

protected  getHostAbis ()

מחזירה את ה-ABI של המחשב המארח.

החזרות

setPrioritizeHostConfig

protected void setPrioritizeHostConfig (boolean prioritizeHostConfig)

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

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

shouldModuleRun

protected boolean shouldModuleRun (ModuleDefinition module)

פרמטרים
module	ModuleDefinition

החזרות
boolean