À 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 dans AOSP, utilisez android-latest-release. 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.

Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

InstrumentationTest

public class InstrumentationTest
extends Object implements IAbiReceiver, IConfigurationReceiver, IDeviceTest, IMetricCollectorReceiver, IRemoteTest, ITestCollector

java.lang.Object
↳	com.android.tradefed.testtype.InstrumentationTest

Sous-classes directes connues

AndroidJUnitTest, CodeCoverageTest

AndroidJUnitTest	Test qui exécute un package de test d'instrumentation sur un appareil donné à l'aide de android.support.test.runner.AndroidJUnitRunner.
CodeCoverageTest	Test qui exécute un package de test d'instrumentation sur un appareil donné et génère le rapport de couverture de code.

Test qui exécute un package de test d'instrumentation sur un appareil donné.

Résumé

Constantes
`String`	`RUN_TESTS_AS_USER_KEY`
`String`	`RUN_TESTS_ON_SDK_SANDBOX`

Champs
`protected boolean`	`mDebug`
`protected boolean`	`mInstrumentInPcc`
`protected boolean`	`mInstrumentSdkInSandbox`
`protected boolean`	`mInstrumentSdkSandbox`

Constructeurs publics
`InstrumentationTest()`

Méthodes publiques
`void`	`addDeviceListeners(Set<String> extraListeners)` Permet d'ajouter d'autres écouteurs personnalisés au lanceur
`void`	`addInstrumentationArg(String key, String value)` Ajoutez un argument à fournir lors de l'exécution des tests d'instrumentation.
`IAbi`	`getAbi()`
`IConfiguration`	`getConfiguration()` Récupère le `IConfiguration` pour ce test.
`String`	`getCoverageTarget()` Obtenez le coverageTarget précédemment défini via `setCoverageTarget(String)`.
`boolean`	`getDebug()` Obtenez le paramètre de débogage de l'instrumentation.
`ITestDevice`	`getDevice()` Obtenez l'appareil soumis aux tests.
`String`	`getForceAbi()`
`long`	`getMaxTimeout()` Renvoie le délai d'inactivité maximal défini pour l'instrumentation.
`String`	`getPackageName()` Obtenez le package du fichier manifeste Android à exécuter.
`String`	`getRunName()` Obtenez le nom d'exécution de test personnalisé qui sera fourni à l'écouteur.
`String`	`getRunnerName()` Récupère le programme d'exécution de l'instrumentation Android à utiliser.
`boolean`	`isCollectTestsOnly()`
`boolean`	`isOrchestrator()` Renvoie la valeur de `ERROR(InstrumentationTest.mOrchestrator/#mOrchestrator InstrumentationTest.mOrchestrator)`
`void`	`run(TestInformation testInfo, ITestInvocationListener listener)` Exécute les tests et signale le résultat à l'écouteur.
`void`	`setAbi(IAbi abi)`
`void`	`setClassName(String testClassName)` Vous pouvez également définir le nom de la classe de test à exécuter.
`void`	`setCollectTestsOnly(boolean shouldCollectTest)` Active ou désactive le mode de collecte des tests
`void`	`setCollectsTestsShellTimeout(int timeout)` Cette méthode est obsolète. Cette méthode est une opération sans effet.
`void`	`setConfiguration(IConfiguration config)` Injecte le `IConfiguration` en cours d'utilisation.
`void`	`setCoverageTarget(String coverageTarget)` Définissez la couverture cible de ce test.
`void`	`setDebug(boolean debug)` Définissez le paramètre de débogage de l'instrumentation.
`void`	`setDevice(ITestDevice device)` Injectez l'appareil soumis aux tests.
`void`	`setEnforceFormat(boolean enforce)` Définissez sur "True" si nous appliquons le format de sortie AJUR de l'instrumentation.
`void`	`setForceAbi(String abi)` Définit l'option force-abi.
`void`	`setInstallFile(File installFile)` Définissez le fichier facultatif à installer contenant les tests.
`void`	`setIsolatedStorage(boolean isolatedStorage)` Définissez si vous souhaitez ou non utiliser le stockage isolé.
`void`	`setMethodName(String testMethodName)` Vous pouvez éventuellement définir la méthode de test à exécuter.
`void`	`setMetricCollectors(List<IMetricCollector> collectors)` Définit la liste des `IMetricCollector` définis pour l'exécution du test.
`void`	`setOrchestrator(boolean useOrchestrator)` Définit l'option "--orchestrator".
`void`	`setPackageName(String packageName)` Définissez le package de fichier manifeste Android à exécuter.
`void`	`setReRunUsingTestFile(boolean reRunUsingTestFile)` Définit l'option "--rerun-from-file".
`void`	`setRerunMode(boolean rerun)` Vous pouvez également définir le mode de réexécution.
`void`	`setRetryAttemptNumber(int attemptNumber)` Définit le numéro de tentative pour le test. Définit le nombre de tentatives en l'envoyant en tant qu'argument d'instrumentation "retry_attempt" au runner côté appareil.
`void`	`setRunName(String runName)` Définissez le nom personnalisé de l'exécution de test qui sera fourni à l'écouteur.
`void`	`setRunnerName(String runnerName)` Vous pouvez éventuellement définir le runner d'instrumentation Android à utiliser.
`void`	`setShellTimeout(long timeout)` Vous pouvez également définir le délai maximal (en millisecondes) pour recevoir la sortie shell de l'appareil.
`void`	`setTestFilePathOnDevice(String testFilePathOnDevice)` Vous pouvez également définir le chemin d'accès à un fichier situé sur l'appareil, qui doit contenir une liste de classes et de méthodes de test séparées par des lignes (format : com.foo.Class#method) à exécuter.
`void`	`setTestPackageName(String testPackageName)` Définit le filtre du package de test.
`void`	`setTestSize(String size)` Vous pouvez également définir la taille du test à exécuter.
`void`	`setTestTimeout(long timeout)` Vous pouvez également définir la durée maximale (en millisecondes) pour chaque exécution de test.
`void`	`setTestsToRun(Collection<TestDescription> tests)` Définissez la collection de tests qui doivent être exécutés par cet InstrumentationTest.
`void`	`setWindowAnimation(boolean windowAnimation)`

Méthodes protégées
`static Set<TestDescription>`	`excludeNonExecuted(TestRunResult results)` Filtrez les résultats "NOT_EXECUTED" et "Skipped" pour identifier les tests à relancer.
`String`	`getClassName()` Obtenez le nom de la classe à exécuter.
`ListInstrumentationParser`	`getListInstrumentationParser()` Obtenez le `ListInstrumentationParser` utilisé pour analyser les requêtes "pm list instrumentation".
`String`	`getMethodName()` Obtenez la méthode de test à exécuter.
`String`	`getTestPackageName()` Obtenez le package Java de test à exécuter.
`String`	`queryRunnerName()` Interrogez l'appareil pour obtenir un exécuteur de tests à utiliser.
`void`	`setRunnerArgs(IRemoteAndroidTestRunner runner)`

Constantes

RUN_TESTS_AS_USER_KEY

public static final String RUN_TESTS_AS_USER_KEY

Valeur de constante : "RUN_TESTS_AS_USER"

RUN_TESTS_ON_SDK_SANDBOX

public static final String RUN_TESTS_ON_SDK_SANDBOX

Valeur de constante : "RUN_TESTS_ON_SDK_SANDBOX"

Champs

mDebug

protected boolean mDebug

mInstrumentInPcc

protected boolean mInstrumentInPcc

mInstrumentSdkInSandbox

protected boolean mInstrumentSdkInSandbox

mInstrumentSdkSandbox

protected boolean mInstrumentSdkSandbox

Constructeurs publics

InstrumentationTest

public InstrumentationTest ()

Méthodes publiques

addDeviceListeners

public void addDeviceListeners (Set<String> extraListeners)

Permet d'ajouter d'autres écouteurs personnalisés au lanceur

Paramètres
`extraListeners`	`Set`

addInstrumentationArg

public void addInstrumentationArg (String key, 
                String value)

Ajoutez un argument à fournir lors de l'exécution des tests d'instrumentation.

Paramètres
`key`	`String` : nom de l'argument
`value`	`String` : valeur de l'argument

getAbi

public IAbi getAbi ()

Renvoie
`IAbi`

getConfiguration

public IConfiguration getConfiguration ()

Récupère le IConfiguration pour ce test.

Renvoie
`IConfiguration`

getCoverageTarget

public String getCoverageTarget ()

Obtenez le coverageTarget précédemment défini via setCoverageTarget(String).

Renvoie
`String`

getDebug

public boolean getDebug ()

Obtenez le paramètre de débogage de l'instrumentation.

Renvoie
`boolean`	Paramètre de débogage booléen.

getDevice

public ITestDevice getDevice ()

Obtenez l'appareil soumis aux tests.

Renvoie
`ITestDevice`	l'/le/la `ITestDevice`

getForceAbi

public String getForceAbi ()

Renvoie
`String`

getMaxTimeout

public long getMaxTimeout ()

Renvoie le délai d'inactivité maximal défini pour l'instrumentation.

Renvoie
`long`

getPackageName

public String getPackageName ()

Obtenez le package du fichier manifeste Android à exécuter.

Renvoie
`String`

getRunName

public String getRunName ()

Obtenez le nom d'exécution de test personnalisé qui sera fourni à l'écouteur.

Renvoie
`String`

getRunnerName

public String getRunnerName ()

Récupère le programme d'exécution d'instrumentation Android à utiliser.

Renvoie
`String`

isCollectTestsOnly

public boolean isCollectTestsOnly ()

Renvoie
`boolean`	Indique si ce test est en mode "collect-tests-only" (collecter les tests uniquement).

isOrchestrator

public boolean isOrchestrator ()

Renvoie la valeur de ERROR(InstrumentationTest.mOrchestrator/#mOrchestrator InstrumentationTest.mOrchestrator)

Renvoie
`boolean`

run

public void run (TestInformation testInfo, 
                ITestInvocationListener listener)

Exécute les tests et signale le résultat à l'écouteur.

Paramètres
`testInfo`	`TestInformation` : objet `TestInformation` contenant des informations utiles pour exécuter des tests.
`listener`	`ITestInvocationListener` : `ITestInvocationListener` des résultats du test

Génère
`DeviceNotAvailableException`

setAbi

public void setAbi (IAbi abi)

Paramètres
`abi`	`IAbi`

setClassName

public void setClassName (String testClassName)

Vous pouvez également définir le nom de la classe de test à exécuter.

Paramètres
`testClassName`	`String`

setCollectTestsOnly

public void setCollectTestsOnly (boolean shouldCollectTest)

Active ou désactive le mode de collecte des tests

setCollectsTestsShellTimeout

public void setCollectsTestsShellTimeout (int timeout)

Cette méthode est obsolète.
Cette méthode est une no-op

Définissez la durée maximale en millisecondes pour la "durée maximale de réponse de sortie du shell" lors de la collecte des tests.

Paramètres
`timeout`	`int`

setConfiguration

public void setConfiguration (IConfiguration config)

Injecte le IConfiguration en cours d'utilisation.

Paramètres
`config`	`IConfiguration`

setCoverageTarget

public void setCoverageTarget (String coverageTarget)

Définissez la couverture cible de ce test.

Actuellement inutilisé. Cette méthode est uniquement présente pour que coverageTarget puisse être récupéré ultérieurement via getCoverageTarget().

Paramètres
`coverageTarget`	`String`

setDebug

public void setDebug (boolean debug)

Définissez le paramètre de débogage de l'instrumentation.

Paramètres
`debug`	`boolean` : valeur booléenne à définir pour le paramètre de débogage de l'instrumentation.

setDevice

public void setDevice (ITestDevice device)

Injectez l'appareil soumis aux tests.

Paramètres
`device`	`ITestDevice` : `ITestDevice` à utiliser

setEnforceFormat

public void setEnforceFormat (boolean enforce)

Définissez sur "True" si nous appliquons le format de sortie AJUR de l'instrumentation.

Paramètres
`enforce`	`boolean`

setForceAbi

public void setForceAbi (String abi)

Définit l'option force-abi.

setInstallFile

public void setInstallFile (File installFile)

Définissez le fichier facultatif à installer contenant les tests.

Paramètres
`installFile`	`File` : `File` installable

setIsolatedStorage

public void setIsolatedStorage (boolean isolatedStorage)

Définissez si vous souhaitez ou non utiliser le stockage isolé.

Paramètres
`isolatedStorage`	`boolean`

setMethodName

public void setMethodName (String testMethodName)

Vous pouvez éventuellement définir la méthode de test à exécuter.

Paramètres
`testMethodName`	`String`

setMetricCollectors

public void setMetricCollectors (List<IMetricCollector> collectors)

Définit la liste des IMetricCollector définis pour l'exécution du test.

Paramètres
`collectors`	`List`

setOrchestrator

public void setOrchestrator (boolean useOrchestrator)

Définit l'option "--orchestrator".

Paramètres
`useOrchestrator`	`boolean`

setPackageName

public void setPackageName (String packageName)

Définissez le package de fichier manifeste Android à exécuter.

Paramètres
`packageName`	`String`

setReRunUsingTestFile

public void setReRunUsingTestFile (boolean reRunUsingTestFile)

Définit l'option "--rerun-from-file".

Paramètres
`reRunUsingTestFile`	`boolean`

setRerunMode

public void setRerunMode (boolean rerun)

Vous pouvez également définir le mode de réexécution.

Paramètres
`rerun`	`boolean`

setRetryAttemptNumber

public void setRetryAttemptNumber (int attemptNumber)

Définit le numéro de tentative pour le test. La valeur par défaut n'a aucun effet.

Définit le nombre de tentatives en l'envoyant en tant qu'argument d'instrumentation "retry_attempt" au runner côté appareil.

Paramètres
`attemptNumber`	`int`

setRunName

public void setRunName (String runName)

Définissez le nom personnalisé de l'exécution de test qui sera fourni à l'écouteur.

Paramètres
`runName`	`String`

setRunnerName

public void setRunnerName (String runnerName)

Vous pouvez éventuellement définir le runner d'instrumentation Android à utiliser.

Paramètres
`runnerName`	`String`

setShellTimeout

public void setShellTimeout (long timeout)

Vous pouvez également définir le délai maximal (en millisecondes) pour recevoir la sortie shell de l'appareil.

Paramètres
`timeout`	`long`

setTestFilePathOnDevice

public void setTestFilePathOnDevice (String testFilePathOnDevice)

Vous pouvez également définir le chemin d'accès à un fichier situé sur l'appareil, qui doit contenir une liste de classes et de méthodes de test séparées par des lignes (format : com.foo.Class#method) à exécuter. Si cette option est définie, les tests seront automatiquement relancés à l'aide de ce fichier de test via InstrumentationFileTest au lieu d'exécuter des commandes adb distinctes pour chaque test restant via la relance.

Paramètres
`testFilePathOnDevice`	`String`

setTestPackageName

public void setTestPackageName (String testPackageName)

Définit le filtre du package de test.

Si la valeur n'est pas nulle, seuls les tests du package Java spécifié seront exécutés.

Sera ignoré si une valeur non nulle a été fournie à setClassName(String)

Paramètres
`testPackageName`	`String`

setTestSize

public void setTestSize (String size)

Vous pouvez également définir la taille du test à exécuter.

Paramètres
`size`	`String`

setTestTimeout

public void setTestTimeout (long timeout)

Vous pouvez également définir la durée maximale (en millisecondes) pour chaque exécution de test.

Paramètres
`timeout`	`long`

setTestsToRun

public void setTestsToRun (Collection<TestDescription> tests)

Définissez la collection de tests qui doivent être exécutés par cet InstrumentationTest.

Paramètres
`tests`	`Collection` : les tests à exécuter

setWindowAnimation

public void setWindowAnimation (boolean windowAnimation)

Paramètres
`windowAnimation`	`boolean`

Méthodes protégées

excludeNonExecuted

protected static Set<TestDescription> excludeNonExecuted (TestRunResult results)

Filtrez les résultats "NOT_EXECUTED" et "Skipped" pour identifier les tests à relancer.

Paramètres
`results`	`TestRunResult`

Renvoie
`Set<TestDescription>`

getClassName

protected String getClassName ()

Obtenez le nom de la classe à exécuter.

Renvoie
`String`

getListInstrumentationParser

protected ListInstrumentationParser getListInstrumentationParser ()

Obtenez le ListInstrumentationParser utilisé pour analyser les requêtes "pm list instrumentation".

Renvoie
`ListInstrumentationParser`

getMethodName

protected String getMethodName ()

Obtenez la méthode de test à exécuter.

Renvoie
`String`

getTestPackageName

protected String getTestPackageName ()

Obtenez le package Java de test à exécuter.

Renvoie
`String`

queryRunnerName

protected String queryRunnerName ()

Interrogez l'appareil pour obtenir un exécuteur de tests à utiliser.

Renvoie
`String`	Le premier nom de programme de test qui correspond au package ou à la valeur nulle si nous n'en trouvons aucun.

Génère
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

setRunnerArgs

protected void setRunnerArgs (IRemoteAndroidTestRunner runner)

Paramètres
`runner`	`IRemoteAndroidTestRunner`