ITestSuite
public abstract class ITestSuite
extends Object
implements IRemoteTest , IDeviceTest , IBuildReceiver , ISystemStatusCheckerReceiver , IShardableTest , ITestCollector , IInvocationContextReceiver , IRuntimeHintProvider , IMetricCollectorReceiver , IConfigurationReceiver , IReportNotExecuted , ITokenRequest , ITestLoggerReceiver
java.lang.Object | |
↳ | com.android.tradefed.testtype.suite.ITestSuite |
Lớp trừu tượng dùng để chạy Test Suite. Lớp này cung cấp cơ sở về cách chạy Suite. Mỗi lần triển khai có thể xác định danh sách các bài kiểm tra thông qua phương thức loadTests()
.
Bản tóm tắt
Lĩnh vực | |
---|---|
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 | TOKEN_KEY |
protected boolean | mRecoverDeviceByCvd
|
Nhà thầu xây dựng công cộng | |
---|---|
ITestSuite () |
Phương pháp công khai | |
---|---|
void | addModuleMetadataExcludeFilters ( MultiMap <String, String> filters) |
void | addModuleMetadataIncludeFilters ( MultiMap <String, String> filters) |
void | cleanUpSuiteSetup () Cơ hội để dọn dẹp tất cả những thứ cần thiết trong quá trình thiết lập bộ nhưng không bắt buộc phải chạy thử nghiệm. |
boolean | filterByConfigMetadata ( IConfiguration config, MultiMap <String, String> include, MultiMap <String, String> exclude) Áp dụng bộ lọc siêu dữ liệu cho cấu hình và xem cấu hình có chạy hay không. |
getAbis ( ITestDevice device) Nhận tập hợp ABI được hỗ trợ bởi cả thử nghiệm Khả năng tương thích | |
static | getAbisForBuildTargetArchFromSuite () Trả về abis có thể có từ TestSuiteInfo. |
IBuildInfo | getBuildInfo () Việc triển khai |
final IConfiguration | getConfiguration () Trả về lời gọi |
ITestLogger | getCurrentTestLogger () |
ITestDevice | getDevice () Lấy thiết bị đang được kiểm tra. |
ModuleDefinition | getDirectModule () Trả về |
IInvocationContext | getInvocationContext () Trả về bối cảnh lời gọi. |
MultiMap <String, String> | getModuleMetadataIncludeFilters () |
ITestSuite.MultiDeviceModuleStrategy | getMultiDeviceStrategy () |
final String | getRequestedAbi () Trả về abi được yêu cầu với tùy chọn -a hoặc --abi. |
getRequiredTokens ( TestInformation testInfo) Trả về danh sách các mã thông báo được yêu cầu theo thử nghiệm. | |
long | getRuntimeHint () Trả về thời gian chạy thử nghiệm dự kiến tính bằng mili giây. |
File | getTestsDir () |
boolean | isSplitting () Trả về true nếu chúng ta hiện đang ở |
abstract | loadTests () Phương pháp trừu tượng để tải cấu hình thử nghiệm sẽ được chạy. |
void | reportNotExecuted ( ITestInvocationListener listener, String message) Báo cáo các thử nghiệm chưa được thực hiện cho trình nghe chính được cung cấp. |
void | reportNotExecuted ( ITestInvocationListener listener) Báo cáo các thử nghiệm chưa được thực hiện cho trình nghe chính được cung cấp. |
final void | run ( TestInformation testInfo, ITestInvocationListener listener) Phương pháp chạy chung cho tất cả thử nghiệm được tải từ |
void | setAbiName (String abiName) Đặt giá trị của mAbiName |
final void | setAbis ( abis) setAbis ( abis) |
void | setBuild ( IBuildInfo buildInfo) |
void | setCollectTestsOnly (boolean shouldCollectTest) Chạy bộ thử nghiệm ở chế độ chỉ thu thập, điều này yêu cầu tất cả các thử nghiệm phụ cũng phải triển khai giao diện này. |
void | setConfiguration ( IConfiguration configuration) Tiêm |
void | setDevice ( ITestDevice device) Tiêm thiết bị đang được thử nghiệm. |
void | setDirectModule ( ModuleDefinition module) |
void | setIntraModuleSharding (boolean intraModuleSharding) |
void | setInvocationContext ( IInvocationContext invocationContext) |
void | setMetricCollectors ( collectors) setMetricCollectors ( collectors) Đặt danh sách |
void | setMultiDeviceStrategy ( ITestSuite.MultiDeviceModuleStrategy strategy) |
void | setPrimaryAbiRun (boolean primaryAbiRun) Đặt giá trị của mPrimaryAbiRun |
void | setShouldMakeDynamicModule (boolean dynamicModule) Khi thực hiện phân đoạn phân tán, chúng tôi không thể có ModuleDefinition chia sẻ các bài kiểm tra trong một nhóm, nếu không, phân đoạn nội bộ mô-đun sẽ không hoạt động, vì vậy chúng tôi cho phép vô hiệu hóa nó. |
void | setSystemStatusChecker ( systemCheckers) setSystemStatusChecker ( systemCheckers) Đặt |
void | setTestLogger ( ITestLogger testLogger) Tiêm phiên bản |
split (Integer shardCountHint, TestInformation testInfo) Phiên bản thay thế của |
Phương pháp được bảo vệ | |
---|---|
createModuleListeners () Trả về danh sách | |
boolean | filterByRunnerType ( IConfiguration config, allowedRunners) filterByRunnerType ( IConfiguration config, allowedRunners) Áp dụng tính năng lọc danh sách trắng của Người chạy, loại bỏ bất kỳ người chạy nào không có trong danh sách trắng. |
getAbisForBuildTargetArch () Trả về abis được hỗ trợ bởi kiến trúc mục tiêu xây dựng máy chủ. | |
getHostAbis () Trả về abis máy chủ. | |
boolean | shouldModuleRun ( ModuleDefinition module) |
Lĩnh vực
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
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
HẠT GIỐNG NGẪU NHIÊN
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
TOKEN_KEY
public static final String TOKEN_KEY
mRecoverDeviceByCvd
protected boolean mRecoverDeviceByCvd
Nhà thầu xây dựng công cộng
ITestSuite
public ITestSuite ()
Phương pháp công khai
addModuleMetadataExcludeFilters
public void addModuleMetadataExcludeFilters (MultiMap<String, String> filters)
Thông số | |
---|---|
filters | MultiMap |
addModuleMetadataIncludeFilters
public void addModuleMetadataIncludeFilters (MultiMap<String, String> filters)
Thông số | |
---|---|
filters | MultiMap |
cleanUpSuiteThiết lập
public void cleanUpSuiteSetup ()
Cơ hội để dọn dẹp tất cả những thứ cần thiết trong quá trình thiết lập bộ nhưng không bắt buộc phải chạy thử nghiệm.
filterByConfigMetadata
public boolean filterByConfigMetadata (IConfiguration config, MultiMap<String, String> include, MultiMap<String, String> exclude)
Áp dụng bộ lọc siêu dữ liệu cho cấu hình và xem cấu hình có chạy hay không.
Thông số | |
---|---|
config | IConfiguration : IConfiguration đang được đánh giá. |
include | MultiMap : siêu dữ liệu bao gồm bộ lọc |
exclude | MultiMap : bộ lọc loại trừ siêu dữ liệu |
Trả lại | |
---|---|
boolean | Đúng nếu mô-đun nên chạy, nếu không thì sai. |
getAbis
publicgetAbis (ITestDevice device)
Nhận tập hợp ABI được hỗ trợ bởi cả thử nghiệm Khả năng tương thích AbiUtils.getAbisSupportedByCompatibility()
và thiết bị được thử nghiệm.
Thông số | |
---|---|
device | ITestDevice |
Trả lại | |
---|---|
Bộ ABI để chạy thử nghiệm |
Ném | |
---|---|
| com.android.tradefed.device.DeviceNotAvailableException |
DeviceNotAvailableException |
getAbisForBuildTargetArchFromSuite
public staticgetAbisForBuildTargetArchFromSuite ()
Trả về abis có thể có từ TestSuiteInfo.
Trả lại | |
---|---|
getBuildInfo
public IBuildInfo getBuildInfo ()
Việc triển khai ITestSuite
có thể yêu cầu thông tin bản dựng để tải các bài kiểm tra.
Trả lại | |
---|---|
IBuildInfo |
lấy cấu hình
public final IConfiguration getConfiguration ()
Trả về lời gọi IConfiguration
.
Trả lại | |
---|---|
IConfiguration |
lấy thiết bị
public ITestDevice getDevice ()
Lấy thiết bị đang được kiểm tra.
Trả lại | |
---|---|
ITestDevice | ITestDevice |
getDirectModule
public ModuleDefinition getDirectModule ()
Trả về ModuleDefinition
để được thực thi trực tiếp hoặc trả về null nếu chưa có (khi ITestSuite chưa được phân chia).
Trả lại | |
---|---|
ModuleDefinition |
getInvocationContext
public IInvocationContext getInvocationContext ()
Trả về bối cảnh lời gọi.
Trả lại | |
---|---|
IInvocationContext |
getModuleMetadataIncludeFilters
public MultiMap<String, String> getModuleMetadataIncludeFilters ()
Trả lại | |
---|---|
MultiMap <String, String> |
getMultiDeviceChiến lược
public ITestSuite.MultiDeviceModuleStrategy getMultiDeviceStrategy ()
Trả lại | |
---|---|
ITestSuite.MultiDeviceModuleStrategy |
getRequestedAbi
public final String getRequestedAbi ()
Trả về abi được yêu cầu với tùy chọn -a hoặc --abi.
Trả lại | |
---|---|
String |
nhận được các Token bắt buộc
publicgetRequiredTokens (TestInformation testInfo)
Trả về danh sách các mã thông báo được yêu cầu theo thử nghiệm. Trả về null nếu không hỗ trợ mã thông báo.
Thông số | |
---|---|
testInfo | TestInformation |
Trả lại | |
---|---|
getRuntimeHint
public long getRuntimeHint ()
Trả về thời gian chạy thử nghiệm dự kiến tính bằng mili giây. Thời gian được sử dụng để thực hiện phân chia cân bằng tải
Trả lại | |
---|---|
long |
getTestsDir
public File getTestsDir ()
Trả lại | |
---|---|
File |
đang chia tách
public boolean isSplitting ()
Trả về true nếu chúng ta hiện đang ở IShardableTest.split(int)
.
Trả lại | |
---|---|
boolean |
tải thử nghiệm
public abstractloadTests ()
Phương pháp trừu tượng để tải cấu hình thử nghiệm sẽ được chạy. Mỗi thử nghiệm được xác định bởi IConfiguration
và một tên duy nhất để báo cáo kết quả.
Trả lại | |
---|---|
báo cáoKhông được thực thi
public void reportNotExecuted (ITestInvocationListener listener, String message)
Báo cáo các thử nghiệm chưa được thực hiện cho trình nghe chính được cung cấp. Chúng sẽ được báo cáo là không thành công với thông báo NOT_EXECUTED_FAILURE
.
Thông số | |
---|---|
listener | ITestInvocationListener : trình nghe chính nơi báo cáo các kết quả không được thực hiện. |
message | String : thông báo liên quan đến lỗi không được thực thi. |
báo cáoKhông được thực thi
public void reportNotExecuted (ITestInvocationListener listener)
Báo cáo các thử nghiệm chưa được thực hiện cho trình nghe chính được cung cấp. Chúng sẽ được báo cáo là không thành công với thông báo NOT_EXECUTED_FAILURE
.
Thông số | |
---|---|
listener | ITestInvocationListener : trình nghe chính nơi báo cáo các kết quả không được thực hiện. |
chạy
public final void run (TestInformation testInfo, ITestInvocationListener listener)
Phương pháp chạy chung cho tất cả thử nghiệm được tải từ loadTests()
.
Thông số | |
---|---|
testInfo | TestInformation : Đối tượng TestInformation chứa thông tin hữu ích để chạy thử nghiệm. |
listener | ITestInvocationListener : ITestInvocationListener của kết quả kiểm tra |
Ném | |
---|---|
DeviceNotAvailableException |
setAbiName
public void setAbiName (String abiName)
Đặt giá trị của mAbiName
Thông số | |
---|---|
abiName | String |
setAbis
public final void setAbis (abis)
Thông số | |
---|---|
abis |
setCollectTestsOnly
public void setCollectTestsOnly (boolean shouldCollectTest)
Chạy bộ thử nghiệm ở chế độ chỉ thu thập, điều này yêu cầu tất cả các thử nghiệm phụ cũng phải triển khai giao diện này.
setConfiguration
public void setConfiguration (IConfiguration configuration)
Tiêm IConfiguration
đang sử dụng.
Thông số | |
---|---|
configuration | IConfiguration |
bộThiết bị
public void setDevice (ITestDevice device)
Tiêm thiết bị đang được thử nghiệm.
Thông số | |
---|---|
device | ITestDevice : ITestDevice sẽ sử dụng |
setDirectModule
public void setDirectModule (ModuleDefinition module)
Thông số | |
---|---|
module | ModuleDefinition |
setIntraModuleSharding
public void setIntraModuleSharding (boolean intraModuleSharding)
Thông số | |
---|---|
intraModuleSharding | boolean |
setInvocationContext
public void setInvocationContext (IInvocationContext invocationContext)
Thông số | |
---|---|
invocationContext | IInvocationContext |
setMetricCollectors
public void setMetricCollectors (collectors)
Đặt danh sách IMetricCollector
được xác định cho lần chạy thử nghiệm.
Thông số | |
---|---|
collectors |
setMultiDeviceChiến lược
public void setMultiDeviceStrategy (ITestSuite.MultiDeviceModuleStrategy strategy)
Thông số | |
---|---|
strategy | ITestSuite.MultiDeviceModuleStrategy |
setPrimaryAbiRun
public void setPrimaryAbiRun (boolean primaryAbiRun)
Đặt giá trị của mPrimaryAbiRun
Thông số | |
---|---|
primaryAbiRun | boolean |
setShouldMakeDynamicModule
public void setShouldMakeDynamicModule (boolean dynamicModule)
Khi thực hiện phân đoạn phân tán, chúng tôi không thể có ModuleDefinition chia sẻ các bài kiểm tra trong một nhóm, nếu không, phân đoạn nội bộ mô-đun sẽ không hoạt động, vì vậy chúng tôi cho phép vô hiệu hóa nó.
Thông số | |
---|---|
dynamicModule | boolean |
setSystemStatusChecker
public void setSystemStatusChecker (systemCheckers)
Đặt ISystemStatusChecker
s từ cấu hình cho thử nghiệm.
Thông số | |
---|---|
systemCheckers |
setTestLogger
public void setTestLogger (ITestLogger testLogger)
Tiêm phiên bản ITestLogger
Thông số | |
---|---|
testLogger | ITestLogger |
tách ra
publicsplit (Integer shardCountHint, TestInformation testInfo)
Phiên bản thay thế của split(int)
cũng cung cấp TestInformation
chứa thông tin ban đầu từ nguồn gốc tạo phân đoạn. Điều này rất hữu ích nếu những thứ như thông tin về thiết bị hoặc bản dựng cần được truy cập trong quá trình phân chia.
Thông số | |
---|---|
shardCountHint | Integer : số lượng phân đoạn đã thử. |
testInfo | TestInformation : TestInformation gốc |
Trả lại | |
---|---|
một tập hợp các bài kiểm tra phụ sẽ được thực hiện riêng biệt hoặc null nếu bài kiểm tra hiện không thể phân chia được |
Phương pháp được bảo vệ
createModuleListeners
protectedcreateModuleListeners ()
Trả về danh sách ITestInvocationListener
áp dụng cho cấp độ ModuleListener
. Những trình nghe này sẽ được sử dụng lại cho mỗi mô-đun, chúng sẽ không được khởi tạo lại nên chúng không giả định trạng thái bên trong.
Trả lại | |
---|---|
bộ lọcByRunnerType
protected boolean filterByRunnerType (IConfiguration config,allowedRunners)
Áp dụng tính năng lọc danh sách trắng của Người chạy, loại bỏ bất kỳ người chạy nào không có trong danh sách trắng. Nếu một cấu hình có nhiều Á hậu, một số có thể bị loại bỏ và cấu hình đó vẫn chạy.
Thông số | |
---|---|
config | IConfiguration : IConfiguration đang được đánh giá. |
allowedRunners |
Trả lại | |
---|---|
boolean | Đúng nếu mô-đun cấu hình được phép chạy, nếu không thì sai. |
getAbisForBuildTargetArch
protectedgetAbisForBuildTargetArch ()
Trả về abis được hỗ trợ bởi kiến trúc mục tiêu xây dựng máy chủ. Tiếp xúc để thử nghiệm.
Trả lại | |
---|---|
getHostAbis
protectedgetHostAbis ()
Trả về abis máy chủ.
Trả lại | |
---|---|
nênModuleRun
protected boolean shouldModuleRun (ModuleDefinition module)
Thông số | |
---|---|
module | ModuleDefinition |
Trả lại | |
---|---|
boolean |