Mulai 27 Maret 2025, sebaiknya gunakan android-latest-release, bukan aosp-main, untuk mem-build dan berkontribusi pada AOSP. Untuk mengetahui informasi selengkapnya, lihat Perubahan pada AOSP.

Halaman ini diterjemahkan oleh Cloud Translation API.

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

Subclass langsung yang dikenal

BaseTestSuite, TfSuiteRunner

BaseTestSuite	Pengujian untuk menjalankan Compatibility Test Suite dengan sistem suite baru.
TfSuiteRunner	Implementasi `ITestSuite` yang akan memuat pengujian dari folder res/config/suite/ TF jar.

Subclass tidak langsung yang umum

AtestRunner, TestMappingSuiteRunner

AtestRunner	Implementasi `ITestSuite`
TestMappingSuiteRunner	Implementasi `BaseTestSuite` untuk menjalankan pengujian yang ditentukan oleh opsi include-filter, atau file TEST_MAPPING dari build, sebagai suite.

Class abstrak yang digunakan untuk menjalankan Test Suite. Class ini menyediakan dasar cara Suite akan dijalankan. Setiap implementasi dapat menentukan daftar pengujian melalui metode loadTests().

Ringkasan

Kolom
`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`

Konstruktor publik
`ITestSuite()`

Metode publik
`void`	`addModuleMetadataExcludeFilters(MultiMap<String, String> filters)`
`void`	`addModuleMetadataIncludeFilters(MultiMap<String, String> filters)`
`void`	`cleanUpSuiteSetup()` Kesempatan untuk membersihkan semua hal yang diperlukan selama penyiapan suite, tetapi tidak diperlukan untuk menjalankan pengujian.
`boolean`	`filterByConfigMetadata(IConfiguration config, MultiMap<String, String> include, MultiMap<String, String> exclude)` Terapkan filter metadata ke konfigurasi dan lihat apakah konfigurasi harus berjalan.
	`getAbis(ITestDevice device)` Mendapatkan kumpulan ABI yang didukung oleh `AbiUtils.getAbisSupportedByCompatibility()` Pengujian kompatibilitas dan perangkat yang sedang diuji.
`static`	`getAbisForBuildTargetArchFromSuite()` Menampilkan kemungkinan abis dari TestSuiteInfo.
`IBuildInfo`	`getBuildInfo()` Implementasi `ITestSuite` mungkin memerlukan info build untuk memuat pengujian.
`final IConfiguration`	`getConfiguration()` Menampilkan pemanggilan `IConfiguration`.
`ITestLogger`	`getCurrentTestLogger()`
`ITestDevice`	`getDevice()` Dapatkan perangkat yang sedang diuji.
`ModuleDefinition`	`getDirectModule()` Menampilkan `ModuleDefinition` yang akan dieksekusi secara langsung, atau null jika belum ada (saat ITestSuite belum di-shard).
`boolean`	`getIntraModuleSharding()`
`IInvocationContext`	`getInvocationContext()` Menampilkan konteks pemanggilan.
`MultiMap<String, String>`	`getModuleMetadataIncludeFilters()`
`ITestSuite.MultiDeviceModuleStrategy`	`getMultiDeviceStrategy()`
`final String`	`getRequestedAbi()` Menampilkan abi yang diminta dengan opsi -a atau --abi.
	`getRequiredTokens(TestInformation testInfo)` Menampilkan daftar token yang diperlukan oleh pengujian.
`long`	`getRuntimeHint()` Menampilkan runtime pengujian yang diharapkan dalam milidetik.
`File`	`getTestsDir()`
`boolean`	`isSplitting()` Menampilkan true jika saat ini kita berada di `IShardableTest.split(int)`.
`abstract`	`loadTests()` Metode abstrak untuk memuat konfigurasi pengujian yang akan dijalankan.
`void`	`reportNotExecuted(ITestInvocationListener listener, String message)` Melaporkan pengujian yang tidak dieksekusi ke pemroses utama yang disediakan.
`void`	`reportNotExecuted(ITestInvocationListener listener)` Melaporkan pengujian yang tidak dieksekusi ke pemroses utama yang disediakan.
`final void`	`run(TestInformation testInfo, ITestInvocationListener listener)` Metode run generik untuk semua pengujian yang dimuat dari `loadTests()`.
`void`	`setAbiName(String abiName)` Menetapkan nilai mAbiName
`final void`	`setAbis( abis)`
`void`	`setBuild(IBuildInfo buildInfo)`
`void`	`setCollectTestsOnly(boolean shouldCollectTest)` Jalankan rangkaian pengujian dalam mode khusus kolektor, hal ini mengharuskan semua sub-pengujian untuk mengimplementasikan antarmuka ini juga.
`void`	`setConfiguration(IConfiguration configuration)` Memasukkan `IConfiguration` yang digunakan.
`void`	`setDevice(ITestDevice device)` Masukkan perangkat yang sedang diuji.
`void`	`setDirectModule(ModuleDefinition module)`
`void`	`setIntraModuleSharding(boolean intraModuleSharding)`
`void`	`setInvocationContext(IInvocationContext invocationContext)`
`void`	`setMetricCollectors( collectors)` Menetapkan daftar `IMetricCollector` yang ditentukan untuk pengujian yang dijalankan.
`void`	`setMultiDeviceStrategy(ITestSuite.MultiDeviceModuleStrategy strategy)`
`void`	`setPrimaryAbiRun(boolean primaryAbiRun)` Menetapkan nilai mPrimaryAbiRun
`void`	`setShouldMakeDynamicModule(boolean dynamicModule)` Saat melakukan sharding terdistribusi, kita tidak dapat memiliki ModuleDefinition yang berbagi pengujian dalam kumpulan jika tidak, sharding intra-modul tidak akan berfungsi, jadi kita mengizinkan untuk menonaktifkannya.
`void`	`setSkipContext(SkipContext skipContext)`
`void`	`setSystemStatusChecker( systemCheckers)` Menetapkan `ISystemStatusChecker` dari konfigurasi untuk pengujian.
`void`	`setTestLogger(ITestLogger testLogger)` Memasukkan instance `ITestLogger`
	`split(Integer shardCountHint, TestInformation testInfo)` Versi alternatif `split(int)` yang juga menyediakan `TestInformation` yang berisi info awal dari induk yang membuat shard.

Metode yang dilindungi
	`createModuleListeners()` Menampilkan daftar `ITestInvocationListener` yang berlaku untuk tingkat `ModuleListener`.
`boolean`	`filterByRunnerType(IConfiguration config, allowedRunners)` Terapkan pemfilteran daftar yang diizinkan Runner, dengan menghapus semua runner yang tidak diizinkan.
	`getAbisForBuildTargetArch()` Menampilkan abis yang didukung oleh arsitektur target build Host.
	`getHostAbis()` Menampilkan abis mesin host.
`void`	`setPrioritizeHostConfig(boolean prioritizeHostConfig)` Tetapkan opsi prioritize-host-config.
`boolean`	`shouldModuleRun(ModuleDefinition module)`

Kolom

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

Konstruktor publik

ITestSuite

public ITestSuite ()

Metode publik

addModuleMetadataExcludeFilters

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

Parameter
`filters`	`MultiMap`

addModuleMetadataIncludeFilters

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

Parameter
`filters`	`MultiMap`

cleanUpSuiteSetup

public void cleanUpSuiteSetup ()

Kesempatan untuk membersihkan semua hal yang diperlukan selama penyiapan suite, tetapi tidak diperlukan untuk menjalankan pengujian.

filterByConfigMetadata

public boolean filterByConfigMetadata (IConfiguration config, 
                MultiMap<String, String> include, 
                MultiMap<String, String> exclude)

Terapkan filter metadata ke konfigurasi dan lihat apakah konfigurasi harus berjalan.

Parameter
`config`	`IConfiguration`: `IConfiguration` yang dievaluasi.
`include`	`MultiMap`: filter sertakan metadata
`exclude`	`MultiMap`: filter pengecualian metadata

Hasil
`boolean`	Benar jika modul harus berjalan, salah jika tidak.

getAbis

public  getAbis (ITestDevice device)

Mendapatkan kumpulan ABI yang didukung oleh AbiUtils.getAbisSupportedByCompatibility() Pengujian kompatibilitas dan perangkat yang sedang diuji.

Parameter
`device`	`ITestDevice`

Hasil
	Kumpulan ABI tempat pengujian dijalankan

Menampilkan
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getAbisForBuildTargetArchFromSuite

public static  getAbisForBuildTargetArchFromSuite ()

Menampilkan kemungkinan abis dari TestSuiteInfo.

Hasil

getBuildInfo

public IBuildInfo getBuildInfo ()

Implementasi ITestSuite mungkin memerlukan info build untuk memuat pengujian.

Hasil
`IBuildInfo`

getConfiguration

public final IConfiguration getConfiguration ()

Menampilkan pemanggilan IConfiguration.

Hasil
`IConfiguration`

getCurrentTestLogger

public ITestLogger getCurrentTestLogger ()

Hasil
`ITestLogger`

getDevice

public ITestDevice getDevice ()

Dapatkan perangkat yang sedang diuji.

Hasil
`ITestDevice`	`ITestDevice`

getDirectModule

public ModuleDefinition getDirectModule ()

Menampilkan ModuleDefinition yang akan dieksekusi secara langsung, atau null jika belum ada (saat ITestSuite belum di-shard).

Hasil
`ModuleDefinition`

getIntraModuleSharding

public boolean getIntraModuleSharding ()

Hasil
`boolean`

getInvocationContext

public IInvocationContext getInvocationContext ()

Menampilkan konteks pemanggilan.

Hasil
`IInvocationContext`

getModuleMetadataIncludeFilters

public MultiMap<String, String> getModuleMetadataIncludeFilters ()

Hasil
`MultiMap<String, String>`

getMultiDeviceStrategy

public ITestSuite.MultiDeviceModuleStrategy getMultiDeviceStrategy ()

Hasil
`ITestSuite.MultiDeviceModuleStrategy`

getRequestedAbi

public final String getRequestedAbi ()

Menampilkan abi yang diminta dengan opsi -a atau --abi.

Hasil
`String`

getRequiredTokens

public  getRequiredTokens (TestInformation testInfo)

Menampilkan daftar token yang diperlukan oleh pengujian. Menampilkan null jika tidak ada dukungan token.

Parameter
`testInfo`	`TestInformation`

Hasil

getRuntimeHint

public long getRuntimeHint ()

Menampilkan runtime pengujian yang diharapkan dalam milidetik. Waktu ini digunakan untuk melakukan load balancing pada eksekusi yang di-shard

Hasil
`long`

getTestsDir

public File getTestsDir ()

Hasil
`File`

isSplitting

public boolean isSplitting ()

Menampilkan true jika saat ini kita berada di IShardableTest.split(int).

Hasil
`boolean`

loadTests

public abstract  loadTests ()

Metode abstrak untuk memuat konfigurasi pengujian yang akan dijalankan. Setiap pengujian ditentukan oleh IConfiguration dan nama unik yang akan melaporkan hasilnya.

Hasil

reportNotExecuted

public void reportNotExecuted (ITestInvocationListener listener, 
                String message)

Melaporkan pengujian yang tidak dieksekusi ke pemroses utama yang disediakan. Peristiwa tersebut harus dilaporkan sebagai gagal dengan pesan NOT_EXECUTED_FAILURE.

Parameter
`listener`	`ITestInvocationListener`: pemroses utama tempat melaporkan hasil yang tidak dieksekusi.
`message`	`String`: pesan yang akan dikaitkan dengan kegagalan yang tidak dieksekusi.

reportNotExecuted

public void reportNotExecuted (ITestInvocationListener listener)

Melaporkan pengujian yang tidak dieksekusi ke pemroses utama yang disediakan. Peristiwa tersebut harus dilaporkan sebagai gagal dengan pesan NOT_EXECUTED_FAILURE.

Parameter
`listener`	`ITestInvocationListener`: pemroses utama tempat melaporkan hasil yang tidak dieksekusi.

lari

public final void run (TestInformation testInfo, 
                ITestInvocationListener listener)

Metode run generik untuk semua pengujian yang dimuat dari loadTests().

Parameter
`testInfo`	`TestInformation`: Objek `TestInformation` yang berisi informasi berguna untuk menjalankan pengujian.
`listener`	`ITestInvocationListener`: `ITestInvocationListener` hasil pengujian

Menampilkan
`DeviceNotAvailableException`

setAbiName

public void setAbiName (String abiName)

Menetapkan nilai mAbiName

Parameter
`abiName`	`String`

setAbis

public final void setAbis ( abis)

Parameter
`abis`

setBuild

public void setBuild (IBuildInfo buildInfo)

Parameter
`buildInfo`	`IBuildInfo`

setCollectTestsOnly

public void setCollectTestsOnly (boolean shouldCollectTest)

Jalankan rangkaian pengujian dalam mode khusus kolektor, hal ini mengharuskan semua sub-pengujian untuk mengimplementasikan antarmuka ini juga.

setConfiguration

public void setConfiguration (IConfiguration configuration)

Memasukkan IConfiguration yang digunakan.

Parameter
`configuration`	`IConfiguration`

setDevice

public void setDevice (ITestDevice device)

Masukkan perangkat yang sedang diuji.

Parameter
`device`	`ITestDevice`: `ITestDevice` yang akan digunakan

setDirectModule

public void setDirectModule (ModuleDefinition module)

Parameter
`module`	`ModuleDefinition`

setIntraModuleSharding

public void setIntraModuleSharding (boolean intraModuleSharding)

Parameter
`intraModuleSharding`	`boolean`

setInvocationContext

public void setInvocationContext (IInvocationContext invocationContext)

Parameter
`invocationContext`	`IInvocationContext`

setMetricCollectors

public void setMetricCollectors ( collectors)

Menetapkan daftar IMetricCollector yang ditentukan untuk pengujian yang dijalankan.

Parameter
`collectors`

setMultiDeviceStrategy

public void setMultiDeviceStrategy (ITestSuite.MultiDeviceModuleStrategy strategy)

Parameter
`strategy`	`ITestSuite.MultiDeviceModuleStrategy`

setPrimaryAbiRun

public void setPrimaryAbiRun (boolean primaryAbiRun)

Menetapkan nilai mPrimaryAbiRun

Parameter
`primaryAbiRun`	`boolean`

setShouldMakeDynamicModule

public void setShouldMakeDynamicModule (boolean dynamicModule)

Saat melakukan sharding terdistribusi, kita tidak dapat memiliki ModuleDefinition yang berbagi pengujian dalam kumpulan jika tidak, sharding intra-modul tidak akan berfungsi, jadi kita mengizinkan untuk menonaktifkannya.

Parameter
`dynamicModule`	`boolean`

setSkipContext

public void setSkipContext (SkipContext skipContext)

Parameter
`skipContext`	`SkipContext`

setSystemStatusChecker

public void setSystemStatusChecker ( systemCheckers)

Menetapkan ISystemStatusChecker dari konfigurasi untuk pengujian.

Parameter
`systemCheckers`

setTestLogger

public void setTestLogger (ITestLogger testLogger)

Memasukkan instance ITestLogger

Parameter
`testLogger`	`ITestLogger`

pisahkan

public  split (Integer shardCountHint, 
                TestInformation testInfo)

Versi alternatif split(int) yang juga menyediakan TestInformation yang berisi info awal dari induk yang membuat shard. Hal ini berguna jika hal-hal seperti informasi perangkat atau build perlu diakses selama sharding.

Parameter
`shardCountHint`	`Integer`: jumlah shard yang dicoba.
`testInfo`	`TestInformation`: `TestInformation` induk

Hasil
	kumpulan subpengujian yang akan dijalankan secara terpisah atau `null` jika pengujian saat ini tidak dapat di-shard

Metode yang dilindungi

createModuleListeners

protected  createModuleListeners ()

Menampilkan daftar ITestInvocationListener yang berlaku untuk tingkat ModuleListener. Pemroses ini akan digunakan kembali untuk setiap modul, dan tidak akan dibuat instance-nya lagi sehingga tidak boleh mengasumsikan status internal.

Hasil

filterByRunnerType

protected boolean filterByRunnerType (IConfiguration config, 
                 allowedRunners)

Terapkan pemfilteran daftar yang diizinkan Runner, dengan menghapus semua runner yang tidak diizinkan. Jika konfigurasi memiliki beberapa runner, beberapa runner mungkin dihapus dan konfigurasi akan tetap berjalan.

Parameter
`config`	`IConfiguration`: `IConfiguration` yang dievaluasi.
`allowedRunners`	: Daftar yang diizinkan runner saat ini.

Hasil
`boolean`	Benar jika modul konfigurasi diizinkan untuk berjalan, salah jika tidak.

getAbisForBuildTargetArch

protected  getAbisForBuildTargetArch ()

Menampilkan abis yang didukung oleh arsitektur target build Host. Ditampilkan untuk pengujian.

Hasil

getHostAbis

protected  getHostAbis ()

Menampilkan abis mesin host.

Hasil

setPrioritizeHostConfig

protected void setPrioritizeHostConfig (boolean prioritizeHostConfig)

Tetapkan opsi prioritize-host-config.

Parameter
`prioritizeHostConfig`	`boolean`: benar untuk memprioritaskan konfigurasi host, yaitu, menjalankan pengujian host jika memungkinkan.

shouldModuleRun

protected boolean shouldModuleRun (ModuleDefinition module)

Parameter
`module`	`ModuleDefinition`

Hasil
`boolean`