Cette page a été traduite par l'API Cloud Translation.

Définition du module

public class ModuleDefinition
extends Object implements ITestCollector

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

Conteneur pour la configuration de l'exécution du test. Cette classe vous permet de préparer et d'exécuter les tests.

Résumé

Champs
`public static final String`	`ISOLATION_COST`
`public static final String`	`MODULE_ABI`
`public static final String`	`MODULE_CACHED` Cette propriété est définie sur "true" si les résultats du module de test ont été mis en cache.
`public static final String`	`MODULE_CONTROLLER`
`public static final String`	`MODULE_EXTERNAL_DEPENDENCIES`
`public static final String`	`MODULE_ID` ID de module : nom qui permettra d'identifier de manière unique le module lors de testRunStart.
`public static final String`	`MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY`
`public static final String`	`MODULE_ISOLATED` Cette propriété est définie sur "true" si le module s'exécutait sur un appareil fraîchement préparé.
`public static final String`	`MODULE_NAME` Le nom du module est le nom de base associé au module, généralement issu du fichier de configuration TF XML à partir duquel le module a été chargé.
`public static final String`	`MODULE_PARAMETERIZATION`
`public static final String`	`MODULE_SKIPPED` Cette propriété est définie sur "true" si le module de test a été ignoré.
`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` Cette propriété est définie sur "true" si seuls les événements au niveau du module sont signalés.
`public static final String`	`TEAR_DOWN_TIME`
`public static final String`	`TEST_TIME`

Constructeurs publics
`ModuleDefinition()`
`ModuleDefinition(String name, tests, preparersPerDevice, multiPreparers, IConfiguration moduleConfig)` Constructeur
`ModuleDefinition(String name, tests, preparersPerDevice, suitePreparersPerDevice, multiPreparers, IConfiguration moduleConfig)` Constructeur

Méthodes publiques
`int`	`compareTo(ModuleDefinition moduleDef)`
`String`	`getId()` Renvoie le nom unique du module.
`Integer`	`getIntraModuleShardCount()`
`Integer`	`getIntraModuleShardIndex()`
`IConfiguration`	`getModuleConfiguration()`
`IInvocationContext`	`getModuleInvocationContext()` Renvoie l'`IInvocationContext` associé au module.
	`getRequiredTokens(TestInformation testInfo)`
`long`	`getRuntimeHint()` Renvoie la durée approximative d'exécution de tous les tests du module.
`boolean`	`hasModuleFailed()` Affiche la valeur "True" si un testRunFailure a été appelé sur le module *
`int`	`neededDevices()` Renvoie le nombre d'appareils qui devraient exécuter ce test.
`int`	`numTests()` Renvoie le nombre actuel de `IRemoteTest` en attente d'exécution.
`final void`	`reportNotExecuted(ITestInvocationListener listener, String message)` Signalez les modules complètement non exécutés.
`final void`	`run(TestInformation moduleInfo, ITestInvocationListener listener, moduleLevelListeners)` Exécutez tous les `IRemoteTest` contenus dans le module et utilisez tous les préparateurs avant et après pour configurer et nettoyer l'appareil.
`final void`	`run(TestInformation moduleInfo, ITestInvocationListener listener, moduleLevelListeners, int maxRunLimit)` Exécutez tous les `IRemoteTest` contenus dans le module et utilisez tous les préparateurs avant et après pour configurer et nettoyer l'appareil.
`final void`	`run(TestInformation moduleInfo, ITestInvocationListener listener)` Exécutez tous les `IRemoteTest` contenus dans le module et utilisez tous les préparateurs avant et après pour configurer et nettoyer l'appareil.
`Throwable`	`runPreparation(boolean includeSuitePreparers)` Exécutez les préparateurs du test, y compris les préparateurs au niveau de la suite, le cas échéant.
`void`	`setBuild(IBuildInfo build)` Injectez le `IBuildInfo` à utiliser pendant les tests.
`void`	`setCollectTestsOnly(boolean collectTestsOnly)` Active ou désactive le mode de collecte de test
`void`	`setDevice(ITestDevice device)` Injectez le `ITestDevice` à utiliser pendant les tests.
`void`	`setEnableDynamicDownload(boolean enableDynamicDownload)` Indique si le téléchargement dynamique doit être activé ou non au niveau du module.
`void`	`setIntraModuleInformation(int shardCount, int shardIndex)`
`void`	`setLogSaver(ILogSaver logSaver)` Transmettez l'outil de sauvegarde du journal d'appel au module afin qu'il puisse l'utiliser si nécessaire.
`final void`	`setMergeAttemps(boolean mergeAttempts)` Détermine si les résultats doivent être fusionnés ou non.
`void`	`setMetricCollectors( collectors)` Injectez la liste des `IMetricCollector` à utiliser par le module.
`void`	`setRecoverVirtualDevice(boolean recoverVirtualDevice)` Les ensembles doivent récupérer l'appareil virtuel.
`final void`	`setRetryDecision(IRetryDecision decision)` Définit les `IRetryDecision` à utiliser pour la nouvelle tentative au sein du module.
`boolean`	`shouldRecoverVirtualDevice()` Indique si nous devons récupérer l'appareil virtuel.
`String`	`toString()`
`void`	`transferSuiteLevelOptions(IConfiguration mSuiteConfiguration)` Copier certains éléments de la configuration au niveau de la suite

Méthodes protégées
`boolean`	`hasTests()` Renvoie la valeur "True" si le module a encore des `IRemoteTest` à exécuter dans son pool.

Champs

COÛT_ISOLATION

public static final String ISOLATION_COST

ABI_MODULE

public static final String MODULE_ABI

MODULE_CACHED

public static final String MODULE_CACHED

Cette propriété est définie sur "true" si les résultats du module de test ont été mis en cache.

MODULE_CONTROLLER

public static final String MODULE_CONTROLLER

MODULE_EXTERNAL_DEPENDENCIES

public static final String MODULE_EXTERNAL_DEPENDENCIES

MODULE_ID

public static final String MODULE_ID

ID de module : nom qui permettra d'identifier de manière unique le module lors de testRunStart. Il s'agit généralement d'une combinaison de MODULE_ABI + MODULE_NAME.

MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY

public static final String MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY

MODULE_ISOLATED

public static final String MODULE_ISOLATED

Cette propriété est définie sur "true" si le module s'exécutait sur un appareil fraîchement préparé.

MODULE_NAME

public static final String MODULE_NAME

Le nom du module est le nom de base associé au module, généralement issu du fichier de configuration TF XML à partir duquel le module a été chargé.

MODULE_PARAMETERIZATION

public static final String MODULE_PARAMETERIZATION

MODULE_SKIPPED

public static final String MODULE_SKIPPED

Cette propriété est définie sur "true" si le module de test a été ignoré.

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

RÉESSAYER_COUNT

public static final String RETRY_SUCCESS_COUNT

RÉESSAYER

public static final String RETRY_TIME

SPARSE_MODULE

public static final String SPARSE_MODULE

Cette propriété est définie sur "true" si seuls les événements au niveau du module sont signalés.

TEAR_DOWN_TIME

public static final String TEAR_DOWN_TIME

TEST_TIME

public static final String TEST_TIME

Constructeurs publics

ModuleDefinition

public ModuleDefinition ()

ModuleDefinition

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

Constructeur

Paramètres
`name`	`String`: nom unique de la configuration de test.
`tests`	: liste des `IRemoteTest` à exécuter.
`preparersPerDevice`	: liste des `ITargetPreparer` à utiliser pour configurer l'appareil.
`multiPreparers`
`moduleConfig`	`IConfiguration`: `IConfiguration` de la configuration du module sous-jacent.

Définition du module

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

Constructeur

Paramètres
`name`	`String`: nom unique de la configuration de test.
`tests`	: liste des `IRemoteTest` à exécuter.
`preparersPerDevice`	: liste des `ITargetPreparer` à utiliser pour configurer l'appareil.
`suitePreparersPerDevice`
`multiPreparers`
`moduleConfig`	`IConfiguration`: `IConfiguration` de la configuration du module sous-jacent.

Méthodes publiques

compareTo

public int compareTo (ModuleDefinition moduleDef)

Paramètres
`moduleDef`	`ModuleDefinition`

Renvoie
`int`

getId

public String getId ()

Renvoie le nom unique du module.

Renvoie
`String`

getIntraModuleShardCount

public Integer getIntraModuleShardCount ()

Renvoie
`Integer`

getIntraModuleShardIndex

public Integer getIntraModuleShardIndex ()

Renvoie
`Integer`

getModuleConfiguration

public IConfiguration getModuleConfiguration ()

Renvoie
`IConfiguration`

getModuleInvocationContext

public IInvocationContext getModuleInvocationContext ()

Renvoie l'IInvocationContext associé au module.

Renvoie
`IInvocationContext`

getRequiredTokens

public  getRequiredTokens (TestInformation testInfo)

Paramètres
`testInfo`	`TestInformation`

Renvoie

getRuntimeHint

public long getRuntimeHint ()

Renvoie la durée approximative d'exécution de tous les tests du module.

Renvoie
`long`

hasModuleFailed

public boolean hasModuleFailed ()

Affiche la valeur "True" si un testRunFailure a été appelé sur le module *

Renvoie
`boolean`

neededDevices

public int neededDevices ()

Renvoie le nombre d'appareils qui devraient exécuter ce test.

Renvoie
`int`

numTests

public int numTests ()

Renvoie le nombre actuel de IRemoteTest en attente d'exécution.

Renvoie
`int`

reportNotExecuted

public final void reportNotExecuted (ITestInvocationListener listener, 
                String message)

Signalez les modules complètement non exécutés.

Paramètres
`listener`	`ITestInvocationListener`
`message`	`String`

Exécuter

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

Exécutez tous les IRemoteTest contenus dans le module et utilisez tous les préparateurs avant et après pour configurer et nettoyer l'appareil.

Paramètres
`moduleInfo`	`TestInformation`
`listener`	`ITestInvocationListener` : `ITestInvocationListener` où signaler les résultats.
`moduleLevelListeners`	: liste des écouteurs au niveau du module.

Génère
`DeviceNotAvailableException`	en cas de mise hors connexion de l'appareil.

Exécuter

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

Exécutez tous les IRemoteTest contenus dans le module et utilisez tous les préparateurs avant et après pour configurer et nettoyer l'appareil.

Paramètres
`moduleInfo`	`TestInformation`: `TestInformation` du module.
`listener`	`ITestInvocationListener`: `ITestInvocationListener` où générer les résultats.
`moduleLevelListeners`	: liste des écouteurs au niveau du module.
`maxRunLimit`	`int`: nombre maximal d'exécutions pour chaque test.

Génère
`DeviceNotAvailableException`	en cas de mise hors connexion de l'appareil.

Exécuter

public final void run (TestInformation moduleInfo, 
                ITestInvocationListener listener)

Exécutez tous les IRemoteTest contenus dans le module, et utilisez tous les outils de préparation avant et après pour configurer et nettoyer l'appareil.

Paramètres
`moduleInfo`	`TestInformation`
`listener`	`ITestInvocationListener` : `ITestInvocationListener` où signaler les résultats.

Génère
`DeviceNotAvailableException`	en cas de déconnexion de l'appareil.

runPreparation

public Throwable runPreparation (boolean includeSuitePreparers)

Exécutez les préparateurs du test, y compris les préparateurs au niveau de la suite, le cas échéant.

Paramètres
`includeSuitePreparers`	`boolean`: défini sur `true` pour exécuter également les préparateurs au niveau de la suite.

Renvoie
`Throwable`	`Throwable` de toute exception générée lors de l'exécution des préparateurs.

setBuild

public void setBuild (IBuildInfo build)

Injectez le IBuildInfo à utiliser pendant les tests.

Paramètres
`build`	`IBuildInfo`

setCollectTestsOnly

public void setCollectTestsOnly (boolean collectTestsOnly)

Active ou désactive le mode de collecte test

Définir l'appareil

public void setDevice (ITestDevice device)

Injectez le ITestDevice à utiliser pendant les tests.

Paramètres
`device`	`ITestDevice`

setEnableDynamicDownload

public void setEnableDynamicDownload (boolean enableDynamicDownload)

Indique si le téléchargement dynamique doit être activé ou non au niveau du module.

Paramètres
`enableDynamicDownload`	`boolean`

setIntraModuleInformation

public void setIntraModuleInformation (int shardCount, 
                int shardIndex)

Paramètres
`shardCount`	`int`
`shardIndex`	`int`

setLogSaver

public void setLogSaver (ILogSaver logSaver)

Transmettez l'outil de sauvegarde du journal d'appel au module afin qu'il puisse l'utiliser si nécessaire.

Paramètres
`logSaver`	`ILogSaver`

setMergeAttemps

public final void setMergeAttemps (boolean mergeAttempts)

Définit si les résultats doivent être fusionnés ou non.

Paramètres
`mergeAttempts`	`boolean`

setMetricCollectors

public void setMetricCollectors ( collectors)

Injectez la liste des IMetricCollector à utiliser par le module.

Paramètres
`collectors`

setRecoverVirtualDevice

public void setRecoverVirtualDevice (boolean recoverVirtualDevice)

Les ensembles doivent récupérer l'appareil virtuel.

Paramètres
`recoverVirtualDevice`	`boolean`

setRetryDecision

public final void setRetryDecision (IRetryDecision decision)

Définit le IRetryDecision à utiliser pour les nouvelles tentatives intra-module.

Paramètres
`decision`	`IRetryDecision`

doitRecoverVirtualDevice

public boolean shouldRecoverVirtualDevice ()

Indique si nous devons récupérer l'appareil virtuel.

Renvoie
`boolean`

toString

public String toString ()

Renvoie
`String`

transferSuiteLevelOptions

public void transferSuiteLevelOptions (IConfiguration mSuiteConfiguration)

Copier certains éléments de la configuration au niveau de la suite

Paramètres
`mSuiteConfiguration`	`IConfiguration`

Méthodes protégées

Tests

protected boolean hasTests ()

Renvoie la valeur "True" si le module a encore des IRemoteTest à exécuter dans son pool. Sinon, cette valeur est "false".

Renvoie
`boolean`