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


Classe astratta utilizzata per eseguire Test Suite. Questa classe fornisce la base su come verrà eseguita la Suite. Ogni implementazione può definire l'elenco dei test tramite il metodo loadTests() .

Riepilogo

Campi

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 TEST_TYPE_KEY

public static final String TEST_TYPE_VALUE_PERFORMANCE

public static final String TOKEN_KEY

protected boolean mRecoverDeviceByCvd

Costruttori pubblici

ITestSuite ()

Metodi pubblici

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

Opportunità di ripulire tutte le cose necessarie durante la configurazione delle suite ma non necessarie per eseguire i test.

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

Applica il filtro dei metadati alla configurazione e verifica se la configurazione deve essere eseguita.

getAbis ( ITestDevice device)

Ottiene il set di ABI supportati sia dal test di compatibilità AbiUtils.getAbisSupportedByCompatibility() sia dal dispositivo sottoposto a test.

static getAbisForBuildTargetArchFromSuite ()

Restituisce l'eventuale abis da TestSuiteInfo.

IBuildInfo getBuildInfo ()

L'implementazione di ITestSuite potrebbe richiedere le informazioni sulla build per caricare i test.

final IConfiguration getConfiguration ()

Restituisce l'invocazione IConfiguration .

ITestLogger getCurrentTestLogger ()
ITestDevice getDevice ()

Metti il ​​dispositivo in prova.

ModuleDefinition getDirectModule ()

Restituisce ModuleDefinition da eseguire direttamente o null se ancora non presente (quando ITestSuite non è stato ancora partizionato).

boolean getIntraModuleSharding ()
IInvocationContext getInvocationContext ()

Restituisce il contesto di chiamata.

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

Restituisce l'abi richiesto con l'opzione -a o --abi.

getRequiredTokens ( TestInformation testInfo)

Restituisce l'elenco dei token richiesti dal test.

long getRuntimeHint ()

Restituisce il tempo di esecuzione previsto del test in millisecondi.

File getTestsDir ()
boolean isSplitting ()

Restituisce true se ci troviamo attualmente in IShardableTest.split(int) .

abstract loadTests ()

Metodo astratto per caricare la configurazione dei test che verranno eseguiti.

void reportNotExecuted ( ITestInvocationListener listener, String message)

Riportare i test non eseguiti all'ascoltatore principale fornito.

void reportNotExecuted ( ITestInvocationListener listener)

Riportare i test non eseguiti all'ascoltatore principale fornito.

final void run ( TestInformation testInfo, ITestInvocationListener listener)

Metodo di esecuzione generico per tutti i test caricati da loadTests() .

void setAbiName (String abiName)

Imposta il valore di mAbiName

final void setAbis ( abis) setAbis ( abis)
void setBuild ( IBuildInfo buildInfo)

void setCollectTestsOnly (boolean shouldCollectTest)

Esegui la suite di test in modalità solo raccoglitore, ciò richiede che tutti i test secondari implementino anche questa interfaccia.

void setConfiguration ( IConfiguration configuration)

Inserisce la IConfiguration in uso.

void setDevice ( ITestDevice device)

Iniettare il dispositivo in prova.

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

void setMetricCollectors ( collectors) setMetricCollectors ( collectors)

Imposta l'elenco di IMetricCollector definiti per l'esecuzione del test.

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

Imposta il valore di mPrimaryAbiRun

void setShouldMakeDynamicModule (boolean dynamicModule)

Quando eseguiamo lo sharding distribuito, non possiamo avere ModuleDefinition che condivida i test in un pool altrimenti lo sharding intra-modulo non funzionerà, quindi consentiamo di disabilitarlo.

void setSystemStatusChecker ( systemCheckers) setSystemStatusChecker ( systemCheckers)

Imposta ISystemStatusChecker dalla configurazione per il test.

void setTestLogger ( ITestLogger testLogger)

Inserisce l'istanza ITestLogger

split (Integer shardCountHint, TestInformation testInfo)

Versione alternativa di split(int) che fornisce anche un TestInformation che contiene le informazioni iniziali del genitore che crea i frammenti.

Metodi protetti

createModuleListeners ()

Restituisce l'elenco di ITestInvocationListener applicabile al livello ModuleListener .

boolean filterByRunnerType ( IConfiguration config, allowedRunners) filterByRunnerType ( IConfiguration config, allowedRunners)

Applica il filtro della lista bianca dei corridori, rimuovendo tutti i corridori che non sono stati inseriti nella lista bianca.

getAbisForBuildTargetArch ()

Restituisce l'abis supportato dall'architettura di destinazione della build dell'host.

getHostAbis ()

Restituisce la macchina host abis.

boolean shouldModuleRun ( ModuleDefinition module)

Campi

ABI_OPZIONE

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

MODULO_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_METADATI_INCLUDE_FILTER

public static final String MODULE_METADATA_INCLUDE_FILTER

MODULE_START_TIME

public static final String MODULE_START_TIME

PARAMETRO_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

SEME_RANDOM

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

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

mRecoverDeviceByCvd

protected boolean mRecoverDeviceByCvd

Costruttori pubblici

ITestSuite

public ITestSuite ()

Metodi pubblici

addModuleMetadataExcludeFilters

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

Parametri
filters MultiMap

addModuleMetadataIncludeFilters

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

Parametri
filters MultiMap

cleanUpSuiteSetup

public void cleanUpSuiteSetup ()

Opportunità di ripulire tutte le cose necessarie durante la configurazione delle suite ma non necessarie per eseguire i test.

filterByConfigMetadata

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

Applica il filtro dei metadati alla configurazione e verifica se la configurazione deve essere eseguita.

Parametri
config IConfiguration : IConfiguration da valutare.

include MultiMap : i metadati includono il filtro

exclude MultiMap : il filtro di esclusione dei metadati

ritorna
boolean Vero se il modulo deve essere eseguito, falso altrimenti.

getAbis

public  getAbis (ITestDevice device)

Ottiene il set di ABI supportati sia dal test di compatibilità AbiUtils.getAbisSupportedByCompatibility() sia dal dispositivo sottoposto a test.

Parametri
device ITestDevice

ritorna
L'insieme di ABI su cui eseguire i test

Lancia
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getAbisForBuildTargetArchFromSuite

public static  getAbisForBuildTargetArchFromSuite ()

Restituisce l'eventuale abis da TestSuiteInfo.

ritorna

getBuildInfo

public IBuildInfo getBuildInfo ()

L'implementazione di ITestSuite potrebbe richiedere le informazioni sulla build per caricare i test.

ritorna
IBuildInfo

getConfigurazione

public final IConfiguration getConfiguration ()

Restituisce l'invocazione IConfiguration .

ritorna
IConfiguration

getCurrentTestLogger

public ITestLogger getCurrentTestLogger ()

ritorna
ITestLogger

getDevice

public ITestDevice getDevice ()

Metti il ​​dispositivo in prova.

ritorna
ITestDevice l' ITestDevice

getDirectModule

public ModuleDefinition getDirectModule ()

Restituisce ModuleDefinition da eseguire direttamente o null se ancora non presente (quando ITestSuite non è stato ancora partizionato).

ritorna
ModuleDefinition

getIntraModuleSharding

public boolean getIntraModuleSharding ()

ritorna
boolean

getInvocationContext

public IInvocationContext getInvocationContext ()

Restituisce il contesto di chiamata.

ritorna
IInvocationContext

getModuleMetadataIncludeFilters

public MultiMap<String, String> getModuleMetadataIncludeFilters ()

ritorna
MultiMap <String, String>

getMultiDeviceStrategy

public ITestSuite.MultiDeviceModuleStrategy getMultiDeviceStrategy ()

ritorna
ITestSuite.MultiDeviceModuleStrategy

getRequestedAbi

public final String getRequestedAbi ()

Restituisce l'abi richiesto con l'opzione -a o --abi.

ritorna
String

getRequiredTokens

public  getRequiredTokens (TestInformation testInfo)

Restituisce l'elenco dei token richiesti dal test. Restituisce null se non è supportato il token.

Parametri
testInfo TestInformation

ritorna

getRuntimeHint

public long getRuntimeHint ()

Restituisce il tempo di esecuzione previsto del test in millisecondi. Il tempo viene utilizzato per bilanciare il carico dell'esecuzione partizionata

ritorna
long

getTestDir

public File getTestsDir ()

ritorna
File

èSplitting

public boolean isSplitting ()

Restituisce true se ci troviamo attualmente in IShardableTest.split(int) .

ritorna
boolean

loadTest

public abstract  loadTests ()

Metodo astratto per caricare la configurazione dei test che verranno eseguiti. Ogni test è definito da una IConfiguration e da un nome univoco con il quale riporterà i risultati.

ritorna

reportNotExecuted

public void reportNotExecuted (ITestInvocationListener listener, 
                String message)

Riportare i test non eseguiti all'ascoltatore principale fornito. Dovrebbero essere segnalati come non riusciti con il messaggio NOT_EXECUTED_FAILURE .

Parametri
listener ITestInvocationListener : il listener principale dove riportare i risultati non eseguiti.

message String : il messaggio da associare al fallimento non eseguito.

reportNotExecuted

public void reportNotExecuted (ITestInvocationListener listener)

Riportare i test non eseguiti all'ascoltatore principale fornito. Dovrebbero essere segnalati come non riusciti con il messaggio NOT_EXECUTED_FAILURE .

Parametri
listener ITestInvocationListener : il listener principale dove riportare i risultati non eseguiti.

correre

public final void run (TestInformation testInfo, 
                ITestInvocationListener listener)

Metodo di esecuzione generico per tutti i test caricati da loadTests() .

Parametri
testInfo TestInformation : l'oggetto TestInformation contenente informazioni utili per eseguire i test.

listener ITestInvocationListener : ITestInvocationListener dei risultati del test

Lancia
DeviceNotAvailableException

setAbiNome

public void setAbiName (String abiName)

Imposta il valore di mAbiName

Parametri
abiName String

setAbis

public final void setAbis ( abis)

Parametri
abis

setBuild

public void setBuild (IBuildInfo buildInfo)

Parametri
buildInfo IBuildInfo

setCollectTestsOnly

public void setCollectTestsOnly (boolean shouldCollectTest)

Esegui la suite di test in modalità solo raccoglitore, ciò richiede che tutti i test secondari implementino anche questa interfaccia.

setConfigurazione

public void setConfiguration (IConfiguration configuration)

Inserisce la IConfiguration in uso.

Parametri
configuration IConfiguration

setDevice

public void setDevice (ITestDevice device)

Iniettare il dispositivo in prova.

Parametri
device ITestDevice : l' ITestDevice da utilizzare

setDirectModule

public void setDirectModule (ModuleDefinition module)

Parametri
module ModuleDefinition

setIntraModuleSharding

public void setIntraModuleSharding (boolean intraModuleSharding)

Parametri
intraModuleSharding boolean

setInvocationContext

public void setInvocationContext (IInvocationContext invocationContext)

Parametri
invocationContext IInvocationContext

setMetricCollectors

public void setMetricCollectors ( collectors)

Imposta l'elenco di IMetricCollector definiti per l'esecuzione del test.

Parametri
collectors

setMultiDeviceStrategy

public void setMultiDeviceStrategy (ITestSuite.MultiDeviceModuleStrategy strategy)

Parametri
strategy ITestSuite.MultiDeviceModuleStrategy

setPrimaryAbiRun

public void setPrimaryAbiRun (boolean primaryAbiRun)

Imposta il valore di mPrimaryAbiRun

Parametri
primaryAbiRun boolean

setShouldMakeDynamicModule

public void setShouldMakeDynamicModule (boolean dynamicModule)

Quando eseguiamo lo sharding distribuito, non possiamo avere ModuleDefinition che condivida i test in un pool altrimenti lo sharding intra-modulo non funzionerà, quindi consentiamo di disabilitarlo.

Parametri
dynamicModule boolean

setSystemStatusChecker

public void setSystemStatusChecker ( systemCheckers)

Imposta ISystemStatusChecker dalla configurazione per il test.

Parametri
systemCheckers

setTestLogger

public void setTestLogger (ITestLogger testLogger)

Inserisce l'istanza ITestLogger

Parametri
testLogger ITestLogger

diviso

public  split (Integer shardCountHint, 
                TestInformation testInfo)

Versione alternativa di split(int) che fornisce anche un TestInformation che contiene le informazioni iniziali del genitore che crea i frammenti. È utile se è necessario accedere a elementi come informazioni sul dispositivo o sulla build durante lo sharding.

Parametri
shardCountHint Integer : conteggio dei frammenti tentati.

testInfo TestInformation : il genitore TestInformation

ritorna
una raccolta di test secondari da eseguire separatamente o null se il test non è attualmente frammentabile

Metodi protetti

createModuleListeners

protected  createModuleListeners ()

Restituisce l'elenco di ITestInvocationListener applicabile al livello ModuleListener . Questi ascoltatori verranno riutilizzati per ciascun modulo, non verranno istanziati nuovamente, quindi non dovrebbero assumere uno stato interno.

ritorna

filterByRunnerType

protected boolean filterByRunnerType (IConfiguration config, 
                 allowedRunners)

Applica il filtro della lista bianca dei corridori, rimuovendo tutti i corridori che non sono stati inseriti nella lista bianca. Se una configurazione ha più runner, alcuni potrebbero essere rimossi e la configurazione continuerà a funzionare.

Parametri
config IConfiguration : IConfiguration da valutare.

allowedRunners : la whitelist corrente dei corridori.

ritorna
boolean Vero se è consentita l'esecuzione del modulo di configurazione, falso altrimenti.

getAbisForBuildTargetArch

protected  getAbisForBuildTargetArch ()

Restituisce l'abis supportato dall'architettura di destinazione della build dell'host. Esposto per test.

ritorna

getHostAbis

protected  getHostAbis ()

Restituisce la macchina host abis.

ritorna

dovrebbeModuleRun

protected boolean shouldModuleRun (ModuleDefinition module)

Parametri
module ModuleDefinition

ritorna
boolean