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 การทดสอบการเรียกใช้ชุดเครื่องมือทดสอบความเข้ากันได้กับระบบชุดทดสอบใหม่  TfSuiteRunner การใช้งาน ITestSuite ซึ่งจะโหลดการทดสอบจากโฟลเดอร์ res/config/suite/ ของ TF jars

คลาสย่อยโดยอ้อมที่ทราบ AtestRunner, TestMappingSuiteRunner AtestRunner การใช้งาน ITestSuite  TestMappingSuiteRunner การใช้ BaseTestSuite เพื่อเรียกใช้การทดสอบที่ระบุโดยตัวเลือก include-filter หรือไฟล์ TEST_MAPPING จากบิลด์เป็นชุด

---

คลาสนามธรรมที่ใช้เรียกใช้ชุดทดสอบ คลาสนี้จะระบุพื้นฐานของวิธีเรียกใช้ชุดโปรแกรม การติดตั้งใช้งานแต่ละครั้งจะกำหนดรายการการทดสอบผ่านเมธอด 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) รับชุด ABI ที่รองรับทั้งการทดสอบความเข้ากันได้ AbiUtils.getAbisSupportedByCompatibility() และอุปกรณ์ทดสอบ
static	getAbisForBuildTargetArchFromSuite() แสดงผล abis ที่เป็นไปได้จาก TestSuiteInfo
IBuildInfo	getBuildInfo() การติดตั้งใช้งาน ITestSuite อาจต้องใช้ข้อมูลบิลด์เพื่อโหลดการทดสอบ
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	isSplitting() แสดงผลเป็น "จริง" หากเราอยู่ใน 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 ที่รองรับโดยสถาปัตยกรรมเป้าหมายของบิลด์โฮสต์
	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	จริงหากโมดูลควรทํางาน เป็นเท็จหากไม่

getAbis

public  getAbis (ITestDevice device)

รับชุด ABI ที่รองรับทั้งการทดสอบความเข้ากันได้ AbiUtils.getAbisSupportedByCompatibility() และอุปกรณ์ทดสอบ

พารามิเตอร์
device	ITestDevice

คิกรีเทิร์น
	ชุด ABI ที่จะทำการทดสอบ

การโยน
	com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getAbisForBuildTargetArchFromSuite

public static  getAbisForBuildTargetArchFromSuite ()

แสดงผล abis ที่เป็นไปได้จาก TestSuiteInfo

คิกรีเทิร์น

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

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

แสดงผลเป็น "จริง" หากเราอยู่ใน 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 ด้วย ซึ่งประกอบด้วยข้อมูลเบื้องต้นจากรายการหลักที่สร้างกลุ่ม ซึ่งจะมีประโยชน์ในกรณีที่ต้องเข้าถึงข้อมูลต่างๆ เช่น ข้อมูลอุปกรณ์หรือข้อมูลบิลด์ระหว่างการแยกข้อมูล

พารามิเตอร์
shardCountHint	Integer: จํานวนชาร์ดที่พยายาม
testInfo	TestInformation: รายการหลัก TestInformation

คิกรีเทิร์น
	ชุดการทดสอบย่อยที่จะเรียกใช้แยกกัน หรือ null หากการทดสอบไม่สามารถแบ่งกลุ่มได้ในขณะนี้

วิธีการที่มีการป้องกัน

createModuleListeners

protected  createModuleListeners ()

แสดงรายการ ITestInvocationListener ที่ใช้กับระดับ ModuleListener ระบบจะใช้ตัวรับฟังเหล่านี้ซ้ำสำหรับแต่ละโมดูล โดยจะไม่สร้างอินสแตนซ์ใหม่ ดังนั้นตัวรับฟังจึงไม่ควรถือว่ามีสถานะภายใน

คิกรีเทิร์น

filterByRunnerType

protected boolean filterByRunnerType (IConfiguration config, 
                 allowedRunners)

ใช้การกรองรายการที่อนุญาตพิเศษของ Runner โดยนํา Runner ที่ไม่ได้อยู่ในรายการที่อนุญาตพิเศษออก หากการกําหนดค่ามี Runner หลายรายการ ระบบอาจนํา Runner บางรายการออกและการกำหนดค่าจะยังคงทํางานต่อไป

พารามิเตอร์
config	IConfiguration: IConfiguration ที่กำลังประเมิน
allowedRunners	: รายการที่อนุญาตพิเศษสำหรับ Runner ปัจจุบัน

คิกรีเทิร์น
boolean	เป็นจริงหากอนุญาตให้โมดูลการกําหนดค่าทํางานได้ หรือเป็นเท็จหากไม่

getAbisForBuildTargetArch

protected  getAbisForBuildTargetArch ()

แสดง abis ที่รองรับโดยสถาปัตยกรรมเป้าหมายของบิลด์โฮสต์ แสดงเพื่อทดสอบ

คิกรีเทิร์น

getHostAbis

protected  getHostAbis ()

แสดงผล abis ของเครื่องโฮสต์

คิกรีเทิร์น

setPrioritizeHostConfig

protected void setPrioritizeHostConfig (boolean prioritizeHostConfig)

ตั้งค่าตัวเลือก prioritize-host-config

พารามิเตอร์
prioritizeHostConfig	boolean: จริงเพื่อจัดลําดับความสําคัญของการกำหนดค่าโฮสต์ เช่น เรียกใช้การทดสอบโฮสต์หากเป็นไปได้

shouldModuleRun

protected boolean shouldModuleRun (ModuleDefinition module)

พารามิเตอร์
module	ModuleDefinition

คิกรีเทิร์น
boolean