ModuleDefinition

public class ModuleDefinition
extends Object implements ITestCollector

java.lang.Object
   ↳ com.android.tradefed.testtype.suite.ModuleDefinition


Es el contenedor para la configuración de la ejecución de prueba. Esta clase te ayudará a preparar y ejecutar las pruebas.

Resumen

Campos

public static final String ISOLATION_COST

public static final String MODULE_ABI

public static final String MODULE_CACHED

Esta propiedad se establece como verdadera si los resultados del módulo de prueba se almacenaron en caché.

public static final String MODULE_CONTROLLER

public static final String MODULE_EXTERNAL_DEPENDENCIES

public static final String MODULE_ID

ID del módulo: Es el nombre que se usará para identificar de forma única el módulo durante testRunStart.

public static final String MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY

public static final String MODULE_ISOLATED

Esta propiedad se establece como verdadera si el módulo se ejecutaba en un dispositivo recién preparado.

public static final String MODULE_NAME

El nombre del módulo es el nombre base asociado al módulo y, por lo general, proviene del archivo de configuración XML de TF desde el que se cargó el módulo.

public static final String MODULE_PARAMETERIZATION

public static final String MODULE_SKIPPED

Esta propiedad se establece como verdadera si se omitió el módulo de prueba.

public static final String MODULE_TEST_COUNT

public static final String PREPARATION_TIME

public static final String RETRY_FAIL_COUNT

public static final String RETRY_SUCCESS_COUNT

public static final String RETRY_TIME

public static final String SPARSE_MODULE

Esta propiedad se establece como verdadera si solo se informan eventos a nivel del módulo.

public static final String TEAR_DOWN_TIME

public static final String TEST_TIME

Constructores públicos

ModuleDefinition()
ModuleDefinition(String name, tests, preparersPerDevice, multiPreparers, IConfiguration moduleConfig)

Constructor

ModuleDefinition(String name, tests, preparersPerDevice, suitePreparersPerDevice, multiPreparers, IConfiguration moduleConfig)

Constructor

Métodos públicos

int compareTo(ModuleDefinition moduleDef)

String getId()

Muestra el nombre único del módulo.

Integer getIntraModuleShardCount()
Integer getIntraModuleShardIndex()
IConfiguration getModuleConfiguration()
IInvocationContext getModuleInvocationContext()

Muestra el IInvocationContext asociado con el módulo.

getRequiredTokens(TestInformation testInfo)
long getRuntimeHint()

Muestra el tiempo aproximado para ejecutar todas las pruebas del módulo.

boolean hasModuleFailed()

Muestra el valor True si se llamó a un testRunFailure en el módulo.

int neededDevices()

Muestra la cantidad de dispositivos que se espera que ejecuten esta prueba.

int numTests()

Muestra la cantidad actual de IRemoteTest que esperan a ejecutarse.

final void reportNotExecuted(ITestInvocationListener listener, String message)

Informa los módulos que no se ejecutaron por completo.

final void run(TestInformation moduleInfo, ITestInvocationListener listener, moduleLevelListeners)

Ejecuta todos los IRemoteTest contenidos en el módulo y usa todos los preparadores antes y después para configurar y limpiar el dispositivo.

final void run(TestInformation moduleInfo, ITestInvocationListener listener, moduleLevelListeners, int maxRunLimit)

Ejecuta todos los IRemoteTest contenidos en el módulo y usa todos los preparadores antes y después para configurar y limpiar el dispositivo.

final void run(TestInformation moduleInfo, ITestInvocationListener listener)

Ejecuta todos los IRemoteTest contenidos en el módulo y usa todos los preparadores antes y después para configurar y limpiar el dispositivo.

Throwable runPreparation(boolean includeSuitePreparers)

Ejecuta los preparadores de la prueba, incluidos los preparadores a nivel del paquete si se especifica.

void setBuild(IBuildInfo build)

Inyecta el IBuildInfo que se usará durante las pruebas.

void setCollectTestsOnly(boolean collectTestsOnly)

Habilita o inhabilita el modo de recopilación de pruebas

void setDevice(ITestDevice device)

Inyecta el ITestDevice que se usará durante las pruebas.

void setEnableDynamicDownload(boolean enableDynamicDownload)

Indica si se debe habilitar o no la descarga dinámica a nivel del módulo.

void setIntraModuleInformation(int shardCount, int shardIndex)
void setLogSaver(ILogSaver logSaver)

Pasa el ahorro de registro de invocación al módulo para que pueda usarlo si es necesario.

final void setMergeAttemps(boolean mergeAttempts)

Establece si debemos combinar los resultados o no.

void setMetricCollectors( collectors)

Inyecta la lista de IMetricCollector que usará el módulo.

void setRecoverVirtualDevice(boolean recoverVirtualDevice)

Los conjuntos deberían recuperar el dispositivo virtual.

final void setRetryDecision(IRetryDecision decision)

Configura el IRetryDecision que se usará para los reintentos dentro del módulo.

boolean shouldRecoverVirtualDevice()

Muestra si debemos recuperar el dispositivo virtual.

String toString()

void transferSuiteLevelOptions(IConfiguration mSuiteConfiguration)

Copia algunos parámetros de configuración a nivel del paquete

Métodos protegidos

boolean hasTests()

Muestra verdadero si el módulo aún tiene IRemoteTest para ejecutar en su grupo.

Campos

ISOLATION_COST

public static final String ISOLATION_COST

ABI_MÓDULO

public static final String MODULE_ABI

MODULE_CACHED

public static final String MODULE_CACHED

Esta propiedad se establece como verdadera si los resultados del módulo de prueba se almacenaron en caché.

MODULE_CONTROLLER

public static final String MODULE_CONTROLLER

MODULE_EXTERNAL_DEPENDENCIES

public static final String MODULE_EXTERNAL_DEPENDENCIES

ID DE MÓDULO

public static final String MODULE_ID

ID del módulo: Es el nombre que se usará para identificar de forma exclusiva el módulo durante testRunStart. Por lo general, será una combinación de MODULE_ABI + MODULE_NAME.

MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY

public static final String MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY

MÓDULO_ISOLADO

public static final String MODULE_ISOLATED

Esta propiedad se establece como verdadera si el módulo se ejecutaba en un dispositivo recién preparado.

MODULE_NAME

public static final String MODULE_NAME

El nombre del módulo es el nombre base asociado con el módulo, que suele provenir del archivo de configuración de TF Xml desde el que se cargó el módulo.

MODULE_PARAMETERIZATION

public static final String MODULE_PARAMETERIZATION

MODULE_SKIPPED

public static final String MODULE_SKIPPED

Esta propiedad se establece como verdadera si se omitió el módulo de prueba.

MODULE_TEST_COUNT

public static final String MODULE_TEST_COUNT

PREPARATION_TIME

public static final String PREPARATION_TIME

RETRY_FAIL_COUNT

public static final String RETRY_FAIL_COUNT

RETRY_SUCCESS_COUNT

public static final String RETRY_SUCCESS_COUNT

RETRY_TIME

public static final String RETRY_TIME

SPARSE_MODULE

public static final String SPARSE_MODULE

Esta propiedad se establece como verdadera si solo se informan eventos a nivel del módulo.

TEAR_DOWN_TIME

public static final String TEAR_DOWN_TIME

TEST_TIME

public static final String TEST_TIME

Constructores públicos

ModuleDefinition

public ModuleDefinition ()

Definición de módulo

public ModuleDefinition (String name, 
                 tests, 
                 preparersPerDevice, 
                 multiPreparers, 
                IConfiguration moduleConfig)

Constructor

Parámetros
name String: Es el nombre único de la configuración de prueba.

tests : Es la lista de IRemoteTest que se debe ejecutar.

preparersPerDevice : Es una lista de ITargetPreparer que se usará para configurar el dispositivo.

multiPreparers

moduleConfig IConfiguration: Es el IConfiguration de la configuración del módulo subyacente.

Definición de módulo

public ModuleDefinition (String name, 
                 tests, 
                 preparersPerDevice, 
                 suitePreparersPerDevice, 
                 multiPreparers, 
                IConfiguration moduleConfig)

Constructor

Parámetros
name String: Es el nombre único de la configuración de prueba.

tests : Es la lista de IRemoteTest que se debe ejecutar.

preparersPerDevice : Es una lista de ITargetPreparer que se usará para configurar el dispositivo.

suitePreparersPerDevice

multiPreparers

moduleConfig IConfiguration: Es el IConfiguration de la configuración del módulo subyacente.

Métodos públicos

compareTo

public int compareTo (ModuleDefinition moduleDef)

Parámetros
moduleDef ModuleDefinition

Muestra
int

getId

public String getId ()

Devuelve el nombre de módulo único.

Muestra
String

getIntraModuleShardCount

public Integer getIntraModuleShardCount ()

Muestra
Integer

getIntraModuleShardIndex

public Integer getIntraModuleShardIndex ()

Muestra
Integer

getModuleConfiguration

public IConfiguration getModuleConfiguration ()

Muestra
IConfiguration

getModuleInvocationContext

public IInvocationContext getModuleInvocationContext ()

Devuelve el IInvocationContext asociado con el módulo.

Muestra
IInvocationContext

getRequiredTokens

public  getRequiredTokens (TestInformation testInfo)

Parámetros
testInfo TestInformation

Muestra

getRuntimeHint

public long getRuntimeHint ()

Muestra el tiempo aproximado para ejecutar todas las pruebas del módulo.

Muestra
long

Error del módulo

public boolean hasModuleFailed ()

Muestra el valor True si se llamó a un testRunFailure en el módulo.

Muestra
boolean

dispositivosnecesarios

public int neededDevices ()

Muestra la cantidad de dispositivos que se espera que ejecuten esta prueba.

Muestra
int

numTests

public int numTests ()

Muestra la cantidad actual de IRemoteTest que esperan a ejecutarse.

Muestra
int

reportNotExecuted

public final void reportNotExecuted (ITestInvocationListener listener, 
                String message)

Informa los módulos que no se ejecutaron por completo.

Parámetros
listener ITestInvocationListener

message String

run

public final void run (TestInformation moduleInfo, 
                ITestInvocationListener listener, 
                 moduleLevelListeners)

Ejecuta todos los IRemoteTest contenidos en el módulo y usa todos los preparadores antes y después para configurar y limpiar el dispositivo.

Parámetros
moduleInfo TestInformation

listener ITestInvocationListener: Es el ITestInvocationListener en el que se deben informar los resultados.

moduleLevelListeners : Es la lista de objetos de escucha a nivel del módulo.

Arroja
DeviceNotAvailableException en caso de que el dispositivo se quede sin conexión.

run

public final void run (TestInformation moduleInfo, 
                ITestInvocationListener listener, 
                 moduleLevelListeners, 
                int maxRunLimit)

Ejecuta todos los IRemoteTest contenidos en el módulo y usa todos los preparadores antes y después para configurar y limpiar el dispositivo.

Parámetros
moduleInfo TestInformation: Es el TestInformation del módulo.

listener ITestInvocationListener: Es el ITestInvocationListener en el que se deben informar los resultados.

moduleLevelListeners : Es la lista de objetos de escucha a nivel del módulo.

maxRunLimit int: Es la cantidad máxima de ejecuciones para cada caso de prueba.

Arroja
DeviceNotAvailableException en caso de que el dispositivo se quede sin conexión.

run

public final void run (TestInformation moduleInfo, 
                ITestInvocationListener listener)

Ejecuta todos los IRemoteTest contenidos en el módulo y usa todos los preparadores antes y después para configurar y limpiar el dispositivo.

Parámetros
moduleInfo TestInformation

listener ITestInvocationListener: Es el ITestInvocationListener en el que se deben informar los resultados.

Arroja
DeviceNotAvailableException en caso de que el dispositivo esté sin conexión.

runPreparation

public Throwable runPreparation (boolean includeSuitePreparers)

Ejecuta los preparadores de la prueba, incluidos los preparadores a nivel del paquete si se especifica.

Parámetros
includeSuitePreparers boolean: Establece en true para ejecutar también los preparadores a nivel de la suite.

Muestra
Throwable Throwable de cualquier excepción que se genere cuando se ejecuten los preparadores.

setBuild

public void setBuild (IBuildInfo build)

Inserta el IBuildInfo que se usará durante las pruebas.

Parámetros
build IBuildInfo

setCollectTestsOnly

public void setCollectTestsOnly (boolean collectTestsOnly)

Habilita o inhabilita el modo de recopilación de pruebas

setDevice

public void setDevice (ITestDevice device)

Inyecta el ITestDevice que se usará durante las pruebas.

Parámetros
device ITestDevice

setEnableDynamicDownload

public void setEnableDynamicDownload (boolean enableDynamicDownload)

Indica si se debe habilitar o no la descarga dinámica a nivel del módulo.

Parámetros
enableDynamicDownload boolean

setIntraModuleInformation

public void setIntraModuleInformation (int shardCount, 
                int shardIndex)

Parámetros
shardCount int

shardIndex int

setLogSaver

public void setLogSaver (ILogSaver logSaver)

Pasa el ahorro de registro de invocación al módulo para que pueda usarlo si es necesario.

Parámetros
logSaver ILogSaver

setMergeAttemps

public final void setMergeAttemps (boolean mergeAttempts)

Determina si se deben combinar los resultados.

Parámetros
mergeAttempts boolean

setMetricCollectors

public void setMetricCollectors ( collectors)

Incorpora la lista de IMetricCollector que usará el módulo.

Parámetros
collectors

setRecoverVirtualDevice

public void setRecoverVirtualDevice (boolean recoverVirtualDevice)

Los conjuntos deberían recuperar el dispositivo virtual.

Parámetros
recoverVirtualDevice boolean

setRetryDecision

public final void setRetryDecision (IRetryDecision decision)

Establece el IRetryDecision que se usará para el reintento intramódulo.

Parámetros
decision IRetryDecision

shouldRecoverVirtualDevice

public boolean shouldRecoverVirtualDevice ()

Muestra si debemos recuperar el dispositivo virtual.

Muestra
boolean

toString

public String toString ()

Muestra
String

transferSuiteLevelOptions

public void transferSuiteLevelOptions (IConfiguration mSuiteConfiguration)

Copia algunos de los parámetros de configuración a nivel de la suite

Parámetros
mSuiteConfiguration IConfiguration

Métodos protegidos

hasTests

protected boolean hasTests ()

Muestra el valor True si el módulo aún tiene IRemoteTest para ejecutarse en su grupo. De lo contrario, el valor es falso.

Muestra
boolean