ITestsSuite

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

Klasa abstrakcyjna używana do uruchamiania pakietu testów. Ta klasa stanowi podstawę działania pakietu. Każda implementacja może zdefiniować listę testów za pomocą metody loadTests().

Podsumowanie

Stałe

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

Pola

protected boolean mEnableResolveSymlinks

protected boolean mRecoverDeviceByCvd

Konstruktory publiczne

ITestSuite()

Metody publiczne

void addModuleMetadataExcludeFilters(MultiMap<String, String> filters)
void addModuleMetadataIncludeFilters(MultiMap<String, String> filters)
void cleanUpSuiteSetup()

Możliwość usunięcia wszystkich elementów, które były potrzebne podczas konfiguracji pakietów, ale nie są wymagane do uruchomienia testów.

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

Zastosuj filtr metadanych do konfiguracji i sprawdź, czy powinna ona zostać uruchomiona.

Set<IAbi> getAbis(ITestDevice device)

Pobiera zestaw interfejsów ABI obsługiwanych zarówno przez testy zgodności AbiUtils.getAbisSupportedByCompatibility(), jak i przez testowane urządzenie.

static Set<String> getAbisForBuildTargetArchFromSuite()

Zwraca możliwe interfejsy ABI z obiektu TestSuiteInfo.

IBuildInfo getBuildInfo()

Wdrożenie ITestSuite może wymagać wczytania informacji o kompilacji w celu przeprowadzenia testów.

final IConfiguration getConfiguration()

Zwraca wywołanie IConfiguration.

ITestLogger getCurrentTestLogger()
ITestDevice getDevice()

Przygotuj urządzenie testowe.

ModuleDefinition getDirectModule()

Zwraca ModuleDefinition do bezpośredniego wykonania lub wartość null, jeśli jeszcze nie ma żadnego (gdy interfejs ITestSuite nie został jeszcze podzielony na fragmenty).

boolean getIntraModuleSharding()
IInvocationContext getInvocationContext()

Zwraca kontekst wywołania.

MultiMap<String, String> getModuleMetadataIncludeFilters()
ITestSuite.MultiDeviceModuleStrategy getMultiDeviceStrategy()
final String getRequestedAbi()

Zwraca interfejs ABI żądany za pomocą opcji -a lub --abi.

Set<TokenProperty> getRequiredTokens(TestInformation testInfo)

Zwraca listę tokenów wymaganych przez test.

long getRuntimeHint()

Zwraca oczekiwany czas działania testu w milisekundach.

File getTestsDir()
boolean isRemoveModuleBuffering()
boolean isSplitting()

Zwraca wartość „prawda”, jeśli obecnie jesteśmy w IShardableTest.split(int).

abstract LinkedHashMap<String, IConfiguration> loadTests()

Metoda abstrakcyjna do wczytywania konfiguracji testów, które zostaną uruchomione.

void reportNotExecuted(ITestInvocationListener listener, String message)

Zgłoś niewykonane testy do głównego odbiorcy.

void reportNotExecuted(ITestInvocationListener listener)

Zgłoś niewykonane testy do głównego odbiorcy.

final void run(TestInformation testInfo, ITestInvocationListener listener)

Ogólna metoda uruchamiania wszystkich testów wczytanych z loadTests().

void setAbiName(String abiName)

Ustaw wartość mAbiName

final void setAbis(Set<IAbi> abis)
void setBuild(IBuildInfo buildInfo)

void setCollectTestsOnly(boolean shouldCollectTest)

Uruchom zestaw testów w trybie tylko kolektora. Wymaga to, aby wszystkie testy podrzędne również implementowały ten interfejs.

void setConfiguration(IConfiguration configuration)

Wstawia używaną wartość IConfiguration.

void setDevice(ITestDevice device)

Wstrzyknij testowane urządzenie.

void setDirectModule(ModuleDefinition module)
void setInLocalRetry(boolean inLocalRetry)
void setIntraModuleSharding(boolean intraModuleSharding)
void setInvocationContext(IInvocationContext invocationContext)

void setMetricCollectors(List<IMetricCollector> collectors)

Ustawia listę IMetricCollector zdefiniowanych dla testu.

void setMultiDeviceStrategy(ITestSuite.MultiDeviceModuleStrategy strategy)
void setPrimaryAbiRun(boolean primaryAbiRun)

Ustaw wartość mPrimaryAbiRun

void setShouldMakeDynamicModule(boolean dynamicModule)

W przypadku rozproszonego dzielenia na fragmenty nie możemy mieć elementu ModuleDefinition, który udostępnia testy w puli, ponieważ w przeciwnym razie dzielenie na fragmenty w ramach modułu nie będzie działać. Dlatego zezwalamy na jego wyłączenie.

void setSkipContext(SkipContext skipContext)
void setSystemStatusChecker(List<ISystemStatusChecker> systemCheckers)

Ustawia ISystemStatusCheckers z konfiguracji testu.

void setTestLogger(ITestLogger testLogger)

Wstrzykuje instancję ITestLogger

Collection<IRemoteTest> split(Integer shardCountHint, TestInformation testInfo)

Alternatywna wersja split(int), która zawiera też TestInformation , czyli wczesne informacje od rodzica tworzącego fragmenty.

Metody chronione

List<ITestInvocationListener> createModuleListeners()

Zwraca listę ITestInvocationListener, które mają zastosowanie na poziomie ModuleListener.

boolean filterByRunnerType(IConfiguration config, Set<String> allowedRunners)

Zastosuj filtrowanie według białej listy biegaczy, usuwając wszystkich biegaczy, którzy nie zostali dodani do białej listy.

Set<String> getAbisForBuildTargetArch()

Zwraca interfejsy ABI obsługiwane przez architekturę docelową kompilacji hosta.

Set<String> getHostAbis()

Zwraca interfejsy ABI maszyny hosta.

void setPrioritizeHostConfig(boolean prioritizeHostConfig)

Ustaw opcję prioritize-host-config.

boolean shouldModuleRun(ModuleDefinition module)

Stałe

ABI_OPTION

public static final String ABI_OPTION

Wartość stała: "abi"

ACTIVE_MAINLINE_PARAMETER_KEY

public static final String ACTIVE_MAINLINE_PARAMETER_KEY

Wartość stała: "active-mainline-parameter"

BUILD_ATTRIBUTE_FLAG_OVERRIDES_KEY

public static final String BUILD_ATTRIBUTE_FLAG_OVERRIDES_KEY

Wartość stała: "flag-overrides" 

public static final String ENABLE_RESOLVE_SYM_LINKS

Wartość stała: "enable-resolve-sym-links"

MAINLINE_PARAMETER_KEY

public static final String MAINLINE_PARAMETER_KEY

Wartość stała: "mainline-param"

MODULE_CHECKER_POST

public static final String MODULE_CHECKER_POST

Wartość stała: "PostModuleChecker"

MODULE_CHECKER_PRE

public static final String MODULE_CHECKER_PRE

Wartość stała: "PreModuleChecker"

MODULE_END_TIME

public static final String MODULE_END_TIME

Wartość stała: "MODULE_END_TIME"

MODULE_METADATA_EXCLUDE_FILTER

public static final String MODULE_METADATA_EXCLUDE_FILTER

Wartość stała: "module-metadata-exclude-filter"

MODULE_METADATA_INCLUDE_FILTER

public static final String MODULE_METADATA_INCLUDE_FILTER

Wartość stała: "module-metadata-include-filter"

MODULE_START_TIME

public static final String MODULE_START_TIME

Wartość stała: "MODULE_START_TIME"

PARAMETER_KEY

public static final String PARAMETER_KEY

Wartość stała: "parameter"

PREPARER_WHITELIST

public static final String PREPARER_WHITELIST

Wartość stała: "preparer-whitelist"

PRIMARY_ABI_RUN

public static final String PRIMARY_ABI_RUN

Wartość stała: "primary-abi-only"

RANDOM_SEED

public static final String RANDOM_SEED

Wartość stała: "random-seed"

RUNNER_WHITELIST

public static final String RUNNER_WHITELIST

Wartość stała: "runner-whitelist"

SKIP_HOST_ARCH_CHECK

public static final String SKIP_HOST_ARCH_CHECK

Wartość stała: "skip-host-arch-check"

SKIP_STAGING_ARTIFACTS

public static final String SKIP_STAGING_ARTIFACTS

Wartość stała: "skip-staging-artifacts"

SKIP_SYSTEM_STATUS_CHECKER

public static final String SKIP_SYSTEM_STATUS_CHECKER

Wartość stała: "skip-system-status-check"

STAGE_MODULE_ARTIFACTS

public static final String STAGE_MODULE_ARTIFACTS

Wartość stała: "stage-module-artifacts"

TEST_TYPE_KEY

public static final String TEST_TYPE_KEY

Wartość stała: "test-type"

TEST_TYPE_VALUE_PERFORMANCE

public static final String TEST_TYPE_VALUE_PERFORMANCE

Wartość stała: "performance"

TOKEN_KEY

public static final String TOKEN_KEY

Wartość stała: "token"

Pola

protected boolean mEnableResolveSymlinks

mRecoverDeviceByCvd

protected boolean mRecoverDeviceByCvd

Konstruktory publiczne

ITestsSuite

public ITestSuite ()

Metody publiczne

addModuleMetadataExcludeFilters

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

Parametry
filters MultiMap

addModuleMetadataIncludeFilters

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

Parametry
filters MultiMap

cleanUpSuiteSetup

public void cleanUpSuiteSetup ()

Możliwość usunięcia wszystkich elementów, które były potrzebne podczas konfiguracji pakietów, ale nie są wymagane do uruchomienia testów.

filterByConfigMetadata

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

Zastosuj filtr metadanych do konfiguracji i sprawdź, czy powinna ona zostać uruchomiona.

Parametry
config IConfiguration: IConfiguration, które jest oceniane.
include MultiMap: filtr uwzględniania metadanych;
exclude MultiMap: filtr wykluczania metadanych;
Zwraca
boolean Wartość „prawda”, jeśli moduł ma zostać uruchomiony. W przeciwnym razie „fałsz”.

getAbis

public Set<IAbi> getAbis (ITestDevice device)

Pobiera zestaw interfejsów ABI obsługiwanych zarówno przez testy zgodności AbiUtils.getAbisSupportedByCompatibility(), jak i przez testowane urządzenie.

Parametry
device ITestDevice

Zwraca
Set<IAbi> Zestaw interfejsów ABI, na których mają być przeprowadzane testy.
Zgłasza
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getAbisForBuildTargetArchFromSuite

public static Set<String> getAbisForBuildTargetArchFromSuite ()

Zwraca możliwe interfejsy ABI z obiektu TestSuiteInfo.

Zwraca
Set<String>

getBuildInfo

public IBuildInfo getBuildInfo ()

Wdrożenie ITestSuite może wymagać wczytania informacji o kompilacji w celu przeprowadzenia testów.

Zwraca
IBuildInfo

getConfiguration

public final IConfiguration getConfiguration ()

Zwraca wywołanie IConfiguration.

Zwraca
IConfiguration

getCurrentTestLogger

public ITestLogger getCurrentTestLogger ()

Zwraca
ITestLogger

getDevice

public ITestDevice getDevice ()

Przygotuj urządzenie testowe.

Zwraca
ITestDevice ITestDevice

getDirectModule

public ModuleDefinition getDirectModule ()

Zwraca ModuleDefinition do bezpośredniego wykonania lub wartość null, jeśli jeszcze nie ma żadnego (gdy interfejs ITestSuite nie został jeszcze podzielony na fragmenty).

Zwraca
ModuleDefinition

getIntraModuleSharding

public boolean getIntraModuleSharding ()

Zwraca
boolean

getInvocationContext

public IInvocationContext getInvocationContext ()

Zwraca kontekst wywołania.

Zwraca
IInvocationContext

getModuleMetadataIncludeFilters

public MultiMap<String, String> getModuleMetadataIncludeFilters ()

Zwraca
MultiMap<String, String>

getMultiDeviceStrategy

public ITestSuite.MultiDeviceModuleStrategy getMultiDeviceStrategy ()

Zwraca
ITestSuite.MultiDeviceModuleStrategy

getRequestedAbi

public final String getRequestedAbi ()

Zwraca interfejs ABI żądany za pomocą opcji -a lub --abi.

Zwraca
String

getRequiredTokens

public Set<TokenProperty> getRequiredTokens (TestInformation testInfo)

Zwraca listę tokenów wymaganych przez test. Jeśli token nie jest obsługiwany, zwraca wartość null.

Parametry
testInfo TestInformation

Zwraca
Set<TokenProperty>

getRuntimeHint

public long getRuntimeHint ()

Zwraca oczekiwany czas działania testu w milisekundach. Ten czas jest używany do równoważenia obciążenia podczas wykonywania podzielonego na fragmenty.

Zwraca
long

getTestsDir

public File getTestsDir ()

Zwraca
File

Zgłasza
FileNotFoundException

isRemoveModuleBuffering

public boolean isRemoveModuleBuffering ()

Zwraca
boolean

isSplitting

public boolean isSplitting ()

Zwraca wartość „prawda”, jeśli obecnie jesteśmy w IShardableTest.split(int).

Zwraca
boolean

loadTests

public abstract LinkedHashMap<String, IConfiguration> loadTests ()

Metoda abstrakcyjna do wczytywania konfiguracji testów, które zostaną uruchomione. Każdy test jest określony przez IConfiguration i unikalną nazwę, pod którą będą raportowane wyniki.

Zwraca
LinkedHashMap<String, IConfiguration>

reportNotExecuted

public void reportNotExecuted (ITestInvocationListener listener, 
                String message)

Zgłoś niewykonane testy do głównego odbiorcy. Powinny być zgłaszane jako nieudane z komunikatem NOT_EXECUTED_FAILURE.

Parametry
listener ITestInvocationListener: główny odbiornik, do którego należy zgłaszać wyniki, które nie zostały wykonane.
message String: komunikat, który ma być powiązany z niezrealizowanym błędem.

reportNotExecuted

public void reportNotExecuted (ITestInvocationListener listener)

Zgłoś niewykonane testy do głównego odbiorcy. Powinny być zgłaszane jako nieudane z komunikatem NOT_EXECUTED_FAILURE.

Parametry
listener ITestInvocationListener: główny odbiornik, do którego należy zgłaszać wyniki, które nie zostały wykonane.

home run

public final void run (TestInformation testInfo, 
                ITestInvocationListener listener)

Ogólna metoda uruchamiania wszystkich testów wczytanych z loadTests().

Parametry
testInfo TestInformation: obiekt TestInformation zawierający przydatne informacje do przeprowadzania testów.
listener ITestInvocationListener: ITestInvocationListener wyników testu
Zgłasza
DeviceNotAvailableException

setAbiName

public void setAbiName (String abiName)

Ustaw wartość mAbiName

Parametry
abiName String

setAbis

public final void setAbis (Set<IAbi> abis)

Parametry
abis Set

setBuild

public void setBuild (IBuildInfo buildInfo)

Parametry
buildInfo IBuildInfo

setCollectTestsOnly

public void setCollectTestsOnly (boolean shouldCollectTest)

Uruchom zestaw testów w trybie tylko kolektora. Wymaga to, aby wszystkie testy podrzędne również implementowały ten interfejs.

setConfiguration

public void setConfiguration (IConfiguration configuration)

Wstawia używaną wartość IConfiguration.

Parametry
configuration IConfiguration

setDevice

public void setDevice (ITestDevice device)

Wstrzyknij testowane urządzenie.

Parametry
device ITestDevice: ITestDevice, którego chcesz użyć.

setDirectModule

public void setDirectModule (ModuleDefinition module)

Parametry
module ModuleDefinition

setInLocalRetry

public void setInLocalRetry (boolean inLocalRetry)

Parametry
inLocalRetry boolean

setIntraModuleSharding

public void setIntraModuleSharding (boolean intraModuleSharding)

Parametry
intraModuleSharding boolean

setInvocationContext

public void setInvocationContext (IInvocationContext invocationContext)

Parametry
invocationContext IInvocationContext

setMetricCollectors

public void setMetricCollectors (List<IMetricCollector> collectors)

Ustawia listę IMetricCollector zdefiniowanych dla testu.

Parametry
collectors List

setMultiDeviceStrategy

public void setMultiDeviceStrategy (ITestSuite.MultiDeviceModuleStrategy strategy)

Parametry
strategy ITestSuite.MultiDeviceModuleStrategy

setPrimaryAbiRun

public void setPrimaryAbiRun (boolean primaryAbiRun)

Ustaw wartość mPrimaryAbiRun

Parametry
primaryAbiRun boolean

setShouldMakeDynamicModule

public void setShouldMakeDynamicModule (boolean dynamicModule)

W przypadku rozproszonego dzielenia na fragmenty nie możemy mieć elementu ModuleDefinition, który udostępnia testy w puli, ponieważ w przeciwnym razie dzielenie na fragmenty w ramach modułu nie będzie działać. Dlatego zezwalamy na jego wyłączenie.

Parametry
dynamicModule boolean

setSkipContext

public void setSkipContext (SkipContext skipContext)

Parametry
skipContext SkipContext

setSystemStatusChecker

public void setSystemStatusChecker (List<ISystemStatusChecker> systemCheckers)

Ustawia ISystemStatusCheckers z konfiguracji testu.

Parametry
systemCheckers List

setTestLogger

public void setTestLogger (ITestLogger testLogger)

Wstrzykuje instancję ITestLogger

Parametry
testLogger ITestLogger

podziel

public Collection<IRemoteTest> split (Integer shardCountHint, 
                TestInformation testInfo)

Alternatywna wersja split(int), która zawiera też TestInformation , czyli wczesne informacje od rodzica tworzącego fragmenty. Jest to przydatne, jeśli podczas dzielenia na fragmenty trzeba uzyskać dostęp do informacji o urządzeniu lub kompilacji.

Parametry
shardCountHint Integer: liczba fragmentów, których utworzenie zostało podjęte.
testInfo TestInformation: Reklamodawca TestInformation
Zwraca
Collection<IRemoteTest> zbiór podtestów do wykonania osobno lub null, jeśli test nie jest obecnie podzielony na części.

Metody chronione

createModuleListeners

protected List<ITestInvocationListener> createModuleListeners ()

Zwraca listę ITestInvocationListener, które mają zastosowanie na poziomie ModuleListener. Te odbiorniki będą ponownie używane w każdym module i nie będą ponownie tworzone, więc nie powinny zakładać stanu wewnętrznego.

Zwraca
List<ITestInvocationListener>

filterByRunnerType

protected boolean filterByRunnerType (IConfiguration config, 
                Set<String> allowedRunners)

Zastosuj filtrowanie według białej listy biegaczy, usuwając wszystkich biegaczy, którzy nie zostali dodani do białej listy. Jeśli konfiguracja ma kilku wykonawców, niektórzy z nich mogą zostać usunięci, a konfiguracja nadal będzie działać.

Parametry
config IConfiguration: IConfiguration, które jest oceniane.
allowedRunners Set: aktualna biała lista wykonawców.
Zwraca
boolean Wartość true, jeśli moduł konfiguracji może działać. W przeciwnym razie wartość false.

getAbisForBuildTargetArch

protected Set<String> getAbisForBuildTargetArch ()

Zwraca interfejsy ABI obsługiwane przez architekturę docelową kompilacji hosta. Udostępniono do testowania.

Zwraca
Set<String>

getHostAbis

protected Set<String> getHostAbis ()

Zwraca interfejsy ABI maszyny hosta.

Zwraca
Set<String>

setPrioritizeHostConfig

protected void setPrioritizeHostConfig (boolean prioritizeHostConfig)

Ustaw opcję prioritize-host-config.

Parametry
prioritizeHostConfig boolean: wartość true, aby nadać priorytet konfiguracji hosta, czyli w miarę możliwości uruchomić test hosta.

shouldModuleRun

protected boolean shouldModuleRun (ModuleDefinition module)

Parametry
module ModuleDefinition

Zwraca
boolean