À partir de 2026, pour nous aligner sur notre modèle de développement stable et garantir la stabilité de la plate-forme pour l'écosystème, nous publierons le code source sur AOSP au deuxième et au quatrième trimestre. Pour créer et contribuer à AOSP, nous vous recommandons d'utiliser android-latest-release au lieu de aosp-main. La branche de fichier manifeste android-latest-release fera toujours référence à la version la plus récente envoyée à AOSP. Pour en savoir plus, consultez Modifications apportées à AOSP.

ModuleDefinition

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 est une aide pour préparer et exécuter les tests.

Résumé

Constantes
`String`	`ISOLATION_COST`
`String`	`MODULE_ABI`
`String`	`MODULE_CACHED` Cette propriété est définie sur "true" si les résultats du module de test ont été mis en cache.
`String`	`MODULE_CONTROLLER`
`String`	`MODULE_EXTERNAL_DEPENDENCIES`
`String`	`MODULE_ID` ID du module : nom qui sera utilisé pour identifier de manière unique le module lors de testRunStart.
`String`	`MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY`
`String`	`MODULE_ISOLATED` Cette propriété est définie sur "true" si le module s'exécutait sur un appareil fraîchement préparé.
`String`	`MODULE_NAME` Le nom du module est le nom de base associé au module, qui provient généralement du fichier de configuration XML TF à partir duquel le module a été chargé.
`String`	`MODULE_PARAMETERIZATION`
`String`	`MODULE_SKIPPED` Cette propriété est définie sur "true" si le module de test a été ignoré.
`String`	`MODULE_TEST_COUNT`
`String`	`PREPARATION_TIME`
`String`	`RETRY_FAIL_COUNT`
`String`	`RETRY_SUCCESS_COUNT`
`String`	`RETRY_TIME`
`String`	`SPARSE_MODULE` Cette propriété est définie sur "true" si seuls les événements au niveau du module sont signalés.
`String`	`TEAR_DOWN_TIME`
`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 la valeur `IInvocationContext` associée au module.
`TestInformation`	`getModuleTestInformation()`
	`getRequiredTokens(TestInformation testInfo)`
`long`	`getRuntimeHint()` Renvoie la durée approximative d'exécution de tous les tests du module.
`boolean`	`hasModuleFailed()` Renvoie la valeur "True" si testRunFailure a été appelé sur le module.
`int`	`neededDevices()` Renvoie le nombre d'appareils censés 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 qui n'ont pas été exécutés du tout.
`final void`	`run(TestInformation moduleInfo, ITestInvocationListener listener, 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écute 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 lors des tests.
`void`	`setCollectTestsOnly(boolean collectTestsOnly)` Active ou désactive le mode de collecte des tests
`void`	`setDevice(ITestDevice device)` Injectez le `ITestDevice` à utiliser lors des tests.
`void`	`setEnableDynamicDownload(boolean enableDynamicDownload)` Indique s'il faut activer ou non le téléchargement dynamique au niveau du module.
`void`	`setIntraModuleInformation(int shardCount, int shardIndex)`
`void`	`setLogSaver(ILogSaver logSaver)` Transmettez le module de sauvegarde des journaux d'invocation au module pour qu'il puisse l'utiliser si nécessaire.
`final void`	`setMergeAttemps(boolean mergeAttempts)` Indique si nous devons fusionner les résultats ou non.
`void`	`setMetricCollectors( collectors)` Injectez la liste de `IMetricCollector` à utiliser par le module.
`void`	`setRecoverVirtualDevice(boolean recoverVirtualDevice)` Les ensembles doivent récupérer l'appareil virtuel.
`void`	`setRemoveModuleBuffering(boolean removeModuleBuffering)`
`void`	`setReportModuleEnd(boolean shouldReportModuleEnd)`
`void`	`setReportModuleStart(boolean shouldReportModuleStart)`
`final void`	`setRetryDecision(IRetryDecision decision)` Définit le `IRetryDecision` à utiliser pour les nouvelles tentatives dans le module.
`void`	`setUseModuleResultsForwarder(boolean useModuleResultsForwarder)`
`boolean`	`shouldRecoverVirtualDevice()` Indique si nous devons récupérer l'appareil virtuel.
`String`	`toString()`
`void`	`transferSuiteLevelOptions(IConfiguration mSuiteConfiguration)` Copier quelques configurations 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.

Constantes

ISOLATION_COST

public static final String ISOLATION_COST

Valeur de constante : "ISOLATION_COST"

MODULE_ABI

public static final String MODULE_ABI

Valeur de constante : "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.

Valeur constante : "module-cached"

MODULE_CONTROLLER

public static final String MODULE_CONTROLLER

Valeur de constante : "module_controller"

MODULE_EXTERNAL_DEPENDENCIES

public static final String MODULE_EXTERNAL_DEPENDENCIES

Valeur constante : "module-external-dependencies"

MODULE_ID

public static final String MODULE_ID

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

Valeur constante : "module-id"

MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY

public static final String MODULE_INVOCATION_ATTRIBUTE_FLAG_OVERRIDES_KEY

Valeur de constante : "module-flag-overrides"

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é.

Valeur constante : "module-isolated"

MODULE_NAME

public static final String MODULE_NAME

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

Valeur constante : "module-name"

MODULE_PARAMETERIZATION

public static final String MODULE_PARAMETERIZATION

Valeur constante : "module-param"

MODULE_SKIPPED

public static final String MODULE_SKIPPED

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

Valeur constante : "module-skipped"

MODULE_TEST_COUNT

public static final String MODULE_TEST_COUNT

Valeur de constante : "MODULE_TEST_COUNT"

PREPARATION_TIME

public static final String PREPARATION_TIME

Valeur de constante : "PREP_TIME"

RETRY_FAIL_COUNT

public static final String RETRY_FAIL_COUNT

Valeur de constante : "MODULE_RETRY_FAILED"

RETRY_SUCCESS_COUNT

public static final String RETRY_SUCCESS_COUNT

Valeur de constante : "MODULE_RETRY_SUCCESS"

RETRY_TIME

public static final String RETRY_TIME

Valeur de constante : "MODULE_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.

Valeur constante : "sparse-module"

TEAR_DOWN_TIME

public static final String TEAR_DOWN_TIME

Valeur de constante : "TEARDOWN_TIME"

TEST_TIME

public static final String TEST_TIME

Valeur de constante : "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.

ModuleDefinition

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 la valeur IInvocationContext associée au module.

Renvoie
`IInvocationContext`

getModuleTestInformation

public TestInformation getModuleTestInformation ()

Renvoie
`TestInformation`

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 ()

Renvoie la valeur "True" si testRunFailure a été appelé sur le module.

Renvoie
`boolean`

neededDevices

public int neededDevices ()

Renvoie le nombre d'appareils censés 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 qui n'ont pas été exécutés du tout.

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

Exécuter

public final void run (TestInformation moduleInfo, 
                ITestInvocationListener listener, 
                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ù signaler les résultats.
`maxRunLimit`	`int` : nombre maximal d'exécutions pour chaque cas de test.

Génère
`DeviceNotAvailableException`	en cas de dé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 préparateurs 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écute les préparateurs du test, y compris les préparateurs au niveau de la suite, le cas échéant.

Paramètres
`includeSuitePreparers`	`boolean` : définissez 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 lors des tests.

Paramètres
`build`	`IBuildInfo`

setCollectTestsOnly

public void setCollectTestsOnly (boolean collectTestsOnly)

Active ou désactive le mode de collecte des tests

setDevice

public void setDevice (ITestDevice device)

Injectez le ITestDevice à utiliser lors des tests.

Paramètres
`device`	`ITestDevice`

setEnableDynamicDownload

public void setEnableDynamicDownload (boolean enableDynamicDownload)

Indique s'il faut activer ou non le téléchargement dynamique 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 le module de sauvegarde des journaux d'invocation au module pour qu'il puisse l'utiliser si nécessaire.

Paramètres
`logSaver`	`ILogSaver`

setMergeAttemps

public final void setMergeAttemps (boolean mergeAttempts)

Indique si nous devons fusionner les résultats ou non.

Paramètres
`mergeAttempts`	`boolean`

setMetricCollectors

public void setMetricCollectors ( collectors)

Injectez la liste de 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`

setRemoveModuleBuffering

public void setRemoveModuleBuffering (boolean removeModuleBuffering)

Paramètres
`removeModuleBuffering`	`boolean`

setReportModuleEnd

public void setReportModuleEnd (boolean shouldReportModuleEnd)

Paramètres
`shouldReportModuleEnd`	`boolean`

setReportModuleStart

public void setReportModuleStart (boolean shouldReportModuleStart)

Paramètres
`shouldReportModuleStart`	`boolean`

setRetryDecision

public final void setRetryDecision (IRetryDecision decision)

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

Paramètres
`decision`	`IRetryDecision`

setUseModuleResultsForwarder

public void setUseModuleResultsForwarder (boolean useModuleResultsForwarder)

Paramètres
`useModuleResultsForwarder`	`boolean`

shouldRecoverVirtualDevice

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 quelques configurations au niveau de la suite

Paramètres
`mSuiteConfiguration`	`IConfiguration`

Méthodes protégées

hasTests

protected boolean hasTests ()

Renvoie la valeur "true" si le module a encore des IRemoteTest à exécuter dans son pool. Sinon renvoie "false".

Renvoie
`boolean`