Cibler un exemple d'application

Cette catégorie de test d'instrumentation n'est pas si différente de celles ciblant les applications Android classiques. Il convient de noter que l'application de test qui inclut l'instrumentation doit être signée avec le même certificat que l'application qu'elle cible.

Notez que ce guide suppose que vous avez déjà une certaine connaissance du flux de travail de l'arborescence source de la plate-forme. Si ce n'est pas le cas, veuillez vous référer à https://source.android.com/source/requirements. L'exemple couvert ici est l'écriture d'un nouveau test d'instrumentation avec un package cible défini sur son propre package d'application de test. Si vous n'êtes pas familier avec le concept, veuillez lire l' introduction aux tests de plate -forme .

Ce guide utilise le test suivant pour servir d'exemple :

  • frameworks/base/paquets/Shell/tests

Il est recommandé de parcourir d'abord le code pour avoir une impression approximative avant de continuer.

Décider d'un emplacement source

Étant donné que le test d'instrumentation ciblera une application, la convention consiste à placer le code source du test dans un répertoire tests sous la racine du répertoire source de votre composant dans l'arborescence source de la plate-forme.

Voir plus de discussions sur l'emplacement de la source dans l' exemple de bout en bout pour les tests d'auto-instrumentation .

Fichier manifeste

Tout comme une application standard, chaque module de test d'instrumentation a besoin d'un fichier manifeste. Si vous nommez le fichier AndroidManifest.xml et que vous le fournissez à côté d' Android.mk pour votre tmodule de test, il sera automatiquement inclus par le makefile de base BUILD_PACKAGE .

Avant d'aller plus loin, il est fortement recommandé de parcourir d'abord la vue d' ensemble du manifeste d'application .

Cela donne un aperçu des composants de base d'un fichier manifeste et de leurs fonctionnalités.

La dernière version du fichier manifeste pour l'exemple de modification de gerrit est accessible à : https://android.googlesource.com/platform/frameworks/base/+/master/packages/Shell/tests/AndroidManifest.xml

Un instantané est inclus ici pour plus de commodité :

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.android.shell.tests">

    <application>
        <uses-library android:name="android.test.runner" />

        <activity
            android:name="com.android.shell.ActionSendMultipleConsumerActivity"
            android:label="ActionSendMultipleConsumer"
            android:theme="@android:style/Theme.NoDisplay"
            android:noHistory="true"
            android:excludeFromRecents="true">
            <intent-filter>
                <action android:name="android.intent.action.SEND_MULTIPLE" />
                <category android:name="android.intent.category.DEFAULT" />
                <data android:mimeType="*/*" />
            </intent-filter>
        </activity>
    </application>

    <instrumentation android:name="android.support.test.runner.AndroidJUnitRunner"
        android:targetPackage="com.android.shell"
        android:label="Tests for Shell" />

</manifest>

Certaines remarques sélectionnées sur le fichier manifeste :

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.android.shell.tests">

L'attribut package est le nom du package d'application : il s'agit de l'identifiant unique utilisé par le framework d'application Android pour identifier une application (ou dans ce contexte : votre application de test). Chaque utilisateur du système ne peut installer qu'une seule application avec ce nom de package.

Puisqu'il s'agit d'un package d'application de test, indépendant du package d'application testé, un nom de package différent doit être utilisé : une convention courante consiste à ajouter un suffixe .test .

De plus, cet attribut package est le même que ce que ComponentName#getPackageName() , et également le même que vous utiliseriez pour interagir avec diverses sous-commandes pm via adb shell .

Veuillez également noter que bien que le nom du package soit généralement dans le même style qu'un nom de package Java, il a en fait très peu de choses à voir avec lui. En d'autres termes, votre package d'application (ou de test) peut contenir des classes avec n'importe quel nom de package, mais d'un autre côté, vous pouvez opter pour la simplicité et avoir votre nom de package Java de niveau supérieur dans votre application ou test identique au nom du package d'application.

<uses-library android:name="android.test.runner" />

Ceci est requis pour tous les tests d'instrumentation puisque les classes associées sont empaquetées dans un fichier de bibliothèque jar de framework séparé, nécessite donc des entrées de chemin de classe supplémentaires lorsque le package de test est appelé par le framework d'application.

android:targetPackage="com.android.shell"

Cela définit le package cible de l'instrumentation sur com.android.shell . Lorsque l'instrumentation est invoquée via la commande am instrument , le framework redémarre le processus com.android.shell et injecte le code d'instrumentation dans le processus pour l'exécution du test. Cela signifie également que le code de test aura accès à toutes les instances de classe en cours d'exécution dans l'application testée et pourra peut-être manipuler l'état en fonction des crochets de test exposés.

Fichier de configuration simple

Chaque nouveau module de test doit avoir un fichier de configuration pour diriger le système de construction avec les métadonnées du module, les dépendances au moment de la compilation et les instructions d'empaquetage. Dans la plupart des cas, l'option de fichier Blueprint basée sur Soong est suffisante. Voir Configuration de test simple pour plus de détails.

Fichier de configuration complexe

Pour des tests plus complexes, vous devez également écrire un fichier de configuration de test pour le harnais de test d'Android, Trade Federation .

La configuration de test peut spécifier des options de configuration de périphérique spéciales et des arguments par défaut pour fournir la classe de test.

La dernière version du fichier de configuration pour l'exemple de modification de gerrit est accessible à : frameworks/base/packages/Shell/tests/AndroidTest.xml

Un instantané est inclus ici pour plus de commodité :

<configuration description="Runs Tests for Shell.">
    <target_preparer class="com.android.tradefed.targetprep.TestAppInstallSetup">
        <option name="test-file-name" value="ShellTests.apk" />
    </target_preparer>

    <option name="test-suite-tag" value="apct" />
    <option name="test-tag" value="ShellTests" />
    <test class="com.android.tradefed.testtype.AndroidJUnitTest" >
        <option name="package" value="com.android.shell.tests" />
        <option name="runner" value="android.support.test.runner.AndroidJUnitRunner" />
    </test>
</configuration>

Quelques remarques sélectives sur le fichier de configuration de test :

<target_preparer class="com.android.tradefed.targetprep.TestAppInstallSetup">
  <option name="test-file-name" value="ShellTests.apk"/>
</target_preparer>

Cela indique à Trade Federation d'installer ShellTests.apk sur l'appareil cible à l'aide d'un target_preparer spécifié. Il existe de nombreux préparateurs cibles disponibles pour les développeurs dans Trade Federation et ceux-ci peuvent être utilisés pour s'assurer que l'appareil est correctement configuré avant l'exécution du test.

<test class="com.android.tradefed.testtype.AndroidJUnitTest">
  <option name="package" value="com.android.shell.tests"/>
  <option name="runner" value="android.support.test.runner.AndroidJUnitRunner"/>
</test>

Cela spécifie la classe de test Trade Federation à utiliser pour exécuter le test et passe dans le package sur l'appareil à exécuter et le framework de test runner qui est JUnit dans ce cas.

Regardez ici pour plus d'informations sur les configurations de module de test

Fonctionnalités de JUnit4

L'utilisation de la bibliothèque android-support-test comme exécuteur de test permet l'adoption de nouvelles classes de test de style JUnit4, et l'exemple de modification de gerrit contient une utilisation très basique de ses fonctionnalités.

Le dernier code source de l'exemple de modification de gerrit est accessible à : frameworks/base/packages/Shell/tests/src/com/android/shell/BugreportReceiverTest.java

Bien que les modèles de test soient généralement spécifiques aux équipes de composants, il existe des modèles d'utilisation généralement utiles.

@SmallTest
@RunWith(AndroidJUnit4.class)
public final class FeatureFactoryImplTest {

Une différence significative dans JUnit4 est que les tests ne sont plus tenus d'hériter d'une classe de test de base commune ; à la place, vous écrivez des tests dans des classes Java simples et utilisez des annotations pour indiquer certaines configurations et contraintes de test. Dans cet exemple, nous indiquons que cette classe doit être exécutée en tant que test Android JUnit4.

L'annotation @SmallTest a spécifié une taille de test pour l'ensemble de la classe de test : toutes les méthodes de test ajoutées à cette classe de test héritent de cette annotation de taille de test. configuration de classe pré-test, démontage post-test et démontage de classe post-test : similaire aux méthodes setUp et tearDown dans JUnit4. L'annotation de Test est utilisée pour annoter le test réel.

    @Before
    public void setup() {
    ...
    @Test
    public void testGetProvider_shouldCacheProvider() {
    ...

L'annotation @Before est utilisée sur les méthodes par JUnit4 pour effectuer la configuration du pré-test. Bien qu'il ne soit pas utilisé dans cet exemple, il existe également @After pour le démontage après le test. De même, les annotations @BeforeClass et @AfterClass peuvent être utilisées sur des méthodes par JUnit4 pour effectuer la configuration avant d'exécuter tous les tests dans une classe de test, et le démontage par la suite. Notez que les méthodes de configuration et de démontage de la portée de classe doivent être statiques.

Quant aux méthodes de test, contrairement à la version précédente de JUnit, elles n'ont plus besoin de commencer le nom de la méthode par test , à la place, chacune d'entre elles doit être annotée avec @Test . Comme d'habitude, les méthodes de test doivent être publiques, ne déclarer aucune valeur de retour, ne prendre aucun paramètre et peuvent lever des exceptions.

        Context context = InstrumentationRegistry.getTargetContext();

Étant donné que les tests JUnit4 ne nécessitent plus une classe de base commune, il n'est plus nécessaire d'obtenir des instances Context via getContext() ou getTargetContext() via des méthodes de classe de base ; au lieu de cela, le nouveau testeur les gère via InstrumentationRegistry où la configuration contextuelle et environnementale créée par le framework d'instrumentation est stockée. Grâce à cette classe, vous pouvez également appeler :

  • getInstrumentation() : l'instance de la classe Instrumentation
  • getArguments() : les arguments de ligne de commande passés à am instrument via -e <key> <value>

Construire et tester localement

Pour les cas d'utilisation les plus courants, utilisez Atest .

Pour les cas plus complexes nécessitant une personnalisation plus lourde, suivez les instructions d'instrumentation .