ModuleDefinition

public class ModuleDefinition
extends Object implements ITestCollector

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

---

Es un contenedor para la configuración de la ejecución de la prueba. Esta clase es un asistente para preparar y ejecutar las pruebas.

Resumen

Constantes
String	ISOLATION_COST
String	MODULE_ABI
String	MODULE_CACHED Esta propiedad se establece como verdadera si los resultados del módulo de prueba se almacenaron en caché.
String	MODULE_CONTROLLER
String	MODULE_EXTERNAL_DEPENDENCIES
String	MODULE_ID Es el ID del módulo, el nombre que se usará para identificar de forma única el módulo durante testRunStart.
String	MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY
String	MODULE_ISOLATED Esta propiedad se establece como verdadera si el módulo se ejecutó en un dispositivo recién preparado.
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 en XML desde el que se cargó el módulo.
String	MODULE_PARAMETERIZATION
String	MODULE_SKIPPED Esta propiedad se establece como verdadera si se omitió el módulo de prueba.
String	MODULE_TEST_COUNT
String	PREPARATION_TIME
String	RETRY_FAIL_COUNT
String	RETRY_SUCCESS_COUNT
String	RETRY_TIME
String	SPARSE_MODULE Esta propiedad se establece como verdadera si solo se informan los eventos a nivel del módulo.
String	TEAR_DOWN_TIME
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() Devuelve el nombre único del módulo.
Integer	getIntraModuleShardCount()
Integer	getIntraModuleShardIndex()
IConfiguration	getModuleConfiguration()
IInvocationContext	getModuleInvocationContext() Devuelve el IInvocationContext asociado con el módulo.
TestInformation	getModuleTestInformation()
	getRequiredTokens(TestInformation testInfo)
long	getRuntimeHint() Devuelve el tiempo aproximado para ejecutar todas las pruebas del módulo.
boolean	hasModuleFailed() Devuelve True si se llamó a testRunFailure en el módulo *
int	neededDevices() Devuelve la cantidad de dispositivos que se espera que ejecuten esta prueba.
int	numTests() Devuelve la cantidad actual de IRemoteTest en espera de ejecución.
final void	reportNotExecuted(ITestInvocationListener listener, String message) Informa los módulos que no se ejecutaron por completo.
final void	run(TestInformation moduleInfo, ITestInvocationListener listener, int maxRunLimit) Ejecuta todos los IRemoteTest incluidos 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 incluidos 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 especifican.
void	setBuild(IBuildInfo build) Inserta 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) Inserta el ITestDevice que se usará durante las pruebas.
void	setEnableDynamicDownload(boolean enableDynamicDownload) Indica si se debe habilitar la descarga dinámica a nivel del módulo.
void	setIntraModuleInformation(int shardCount, int shardIndex)
void	setLogSaver(ILogSaver logSaver) Pasa el guardador de registros de invocación al módulo para que pueda usarlo si es necesario.
final void	setMergeAttemps(boolean mergeAttempts) Establece si debemos combinar los resultados.
void	setMetricCollectors( collectors) Inyecta la lista de IMetricCollector que usará el módulo.
void	setRecoverVirtualDevice(boolean recoverVirtualDevice) Los conjuntos deben recuperar el dispositivo virtual.
void	setRemoveModuleBuffering(boolean removeModuleBuffering)
void	setReportModuleEnd(boolean shouldReportModuleEnd)
void	setReportModuleStart(boolean shouldReportModuleStart)
final void	setRetryDecision(IRetryDecision decision) Establece el IRetryDecision que se usará para el reintento dentro del módulo.
void	setUseModuleResultsForwarder(boolean useModuleResultsForwarder)
boolean	shouldRecoverVirtualDevice() Devuelve 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() Devuelve True si el módulo aún tiene IRemoteTest para ejecutarse en su grupo.

Constantes

ISOLATION_COST

public static final String ISOLATION_COST

Valor de la constante: "ISOLATION_COST"

MODULE_ABI

public static final String MODULE_ABI

Valor de la constante: "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é.

Valor de la constante: "module-cached"

MODULE_CONTROLLER

public static final String MODULE_CONTROLLER

Valor de la constante: "module_controller"

MODULE_EXTERNAL_DEPENDENCIES

public static final String MODULE_EXTERNAL_DEPENDENCIES

Valor de la constante: "module-external-dependencies"

MODULE_ID

public static final String MODULE_ID

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

Valor de la constante: "module-id"

MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY

public static final String MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY

Valor de la constante: "module-flag-overrides"

MODULE_ISOLATED

public static final String MODULE_ISOLATED

Esta propiedad se establece en verdadero si el módulo se ejecutó en un dispositivo recién preparado.

Valor de la constante: "module-isolated"

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 en XML desde el que se cargó el módulo.

Valor de la constante: "module-name"

MODULE_PARAMETERIZATION

public static final String MODULE_PARAMETERIZATION

Valor de la constante: "module-param"

MODULE_SKIPPED

public static final String MODULE_SKIPPED

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

Valor de la constante: "module-skipped"

MODULE_TEST_COUNT

public static final String MODULE_TEST_COUNT

Valor de la constante: "MODULE_TEST_COUNT"

PREPARATION_TIME

public static final String PREPARATION_TIME

Valor de la constante: "PREP_TIME"

RETRY_FAIL_COUNT

public static final String RETRY_FAIL_COUNT

Valor de la constante: "MODULE_RETRY_FAILED"

RETRY_SUCCESS_COUNT

public static final String RETRY_SUCCESS_COUNT

Valor de la constante: "MODULE_RETRY_SUCCESS"

RETRY_TIME

public static final String RETRY_TIME

Valor constante: "MODULE_RETRY_TIME"

SPARSE_MODULE

public static final String SPARSE_MODULE

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

Valor de la constante: "sparse-module"

TEAR_DOWN_TIME

public static final String TEAR_DOWN_TIME

Valor de la constante: "TEARDOWN_TIME"

TEST_TIME

public static final String TEST_TIME

Valor de la constante: "TEST_TIME"

Constructores públicos

ModuleDefinition

public ModuleDefinition ()

ModuleDefinition

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 deben ejecutar.
preparersPerDevice	: Es una lista de ITargetPreparer que se usarán para configurar el dispositivo.
multiPreparers
moduleConfig	IConfiguration: Es el IConfiguration de la configuración del módulo subyacente.

ModuleDefinition

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 deben ejecutar.
preparersPerDevice	: Es una lista de ITargetPreparer que se usarán 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 único del módulo.

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

getModuleTestInformation

public TestInformation getModuleTestInformation ()

Muestra
TestInformation

getRequiredTokens

public  getRequiredTokens (TestInformation testInfo)

Parámetros
testInfo	TestInformation

Muestra

getRuntimeHint

public long getRuntimeHint ()

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

Muestra
long

hasModuleFailed

public boolean hasModuleFailed ()

Devuelve True si se llamó a testRunFailure en el módulo *

Muestra
boolean

neededDevices

public int neededDevices ()

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

Muestra
int

numTests

public int numTests ()

Devuelve la cantidad actual de IRemoteTest en espera de ejecución.

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, 
                int maxRunLimit)

Ejecuta todos los IRemoteTest incluidos 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 informarán los resultados.
maxRunLimit	int: Es la cantidad máxima de ejecuciones para cada caso de prueba.

Arroja
DeviceNotAvailableException	en caso de que el dispositivo se desconecte.

run

public final void run (TestInformation moduleInfo, 
                ITestInvocationListener listener)

Ejecuta todos los IRemoteTest incluidos 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 informarán los resultados.

Arroja
DeviceNotAvailableException	en caso de que el dispositivo se desconecte.

runPreparation

public Throwable runPreparation (boolean includeSuitePreparers)

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

Parámetros
includeSuitePreparers	boolean: Se debe establecer en true para ejecutar también los preparadores a nivel del conjunto de pruebas.

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)

Inserta el ITestDevice que se usará durante las pruebas.

Parámetros
device	ITestDevice

setEnableDynamicDownload

public void setEnableDynamicDownload (boolean enableDynamicDownload)

Indica si se debe habilitar 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 guardador de registros de invocación al módulo para que pueda usarlo si es necesario.

Parámetros
logSaver	ILogSaver

setMergeAttemps

public final void setMergeAttemps (boolean mergeAttempts)

Establece si debemos combinar los resultados.

Parámetros
mergeAttempts	boolean

setMetricCollectors

public void setMetricCollectors ( collectors)

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

Parámetros
collectors

setRecoverVirtualDevice

public void setRecoverVirtualDevice (boolean recoverVirtualDevice)

Los conjuntos deben recuperar el dispositivo virtual.

Parámetros
recoverVirtualDevice	boolean

setRemoveModuleBuffering

public void setRemoveModuleBuffering (boolean removeModuleBuffering)

Parámetros
removeModuleBuffering	boolean

setReportModuleEnd

public void setReportModuleEnd (boolean shouldReportModuleEnd)

Parámetros
shouldReportModuleEnd	boolean

setReportModuleStart

public void setReportModuleStart (boolean shouldReportModuleStart)

Parámetros
shouldReportModuleStart	boolean

setRetryDecision

public final void setRetryDecision (IRetryDecision decision)

Establece el IRetryDecision que se usará para el reintento dentro del módulo.

Parámetros
decision	IRetryDecision

setUseModuleResultsForwarder

public void setUseModuleResultsForwarder (boolean useModuleResultsForwarder)

Parámetros
useModuleResultsForwarder	boolean

shouldRecoverVirtualDevice

public boolean shouldRecoverVirtualDevice ()

Devuelve si debemos recuperar el dispositivo virtual.

Muestra
boolean

toString

public String toString ()

Muestra
String

transferSuiteLevelOptions

public void transferSuiteLevelOptions (IConfiguration mSuiteConfiguration)

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

Parámetros
mSuiteConfiguration	IConfiguration

Métodos protegidos

hasTests

protected boolean hasTests ()

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

Muestra
boolean