Ajouter de nouveaux tests GoogleTests (GTests)

Si vous débutez dans le développement de la plate-forme Android, cet exemple complet d'ajout d'un binaire GTest (parfois appelé "test natif") à partir de zéro peut vous être utile pour illustrer le workflow type impliqué. Pour en savoir plus sur le framework GTest pour C++, consultez le site du projet GTest pour obtenir des informations supplémentaires.

Ce guide utilise l'exemple GTest Hello World comme exemple. Nous vous recommandons de lire le code pour en avoir une compréhension approximative avant de continuer.

Choisir un emplacement source

En règle générale, votre équipe a déjà établi un schéma de vérification du code et d'ajout de tests. La plupart des équipes possèdent un seul dépôt Git ou en partagent un avec d'autres équipes, mais disposent d'un sous-répertoire dédié contenant le code source des composants.

En supposant que l'emplacement racine de la source de votre composant se trouve dans <component source root>, la plupart des composants comportent des dossiers src et tests, ainsi que des fichiers supplémentaires tels que Android.mk (ou divisés en fichiers .bp supplémentaires).

Étant donné que vous ajoutez un tout nouveau test, vous devrez probablement créer le répertoire tests à côté de votre composant src et le remplir avec du contenu.

Dans certains cas, votre équipe peut avoir d'autres structures de répertoires sous tests, car elle doit empaqueter différentes suites de tests dans des binaires individuels. Dans ce cas, vous devrez créer un sous-répertoire sous tests.

Pour illustrer, voici un schéma de répertoire type pour les composants avec un seul dossier tests:

\
 <component source root>
  \-- Android.bp (component makefile)
  \-- AndroidTest.xml (test config file)
  \-- src (component source)
  |    \-- foo.cpp
  |    \-- ...
  \-- tests (test source root)
      \-- Android.bp (test makefile)
      \-- src (test source)
          \-- foo_test.cpp
          \-- ...

Voici un schéma de répertoire typique pour les composants avec plusieurs répertoires de sources de test:

\
 <component source root>
  \-- Android.bp (component makefile)
  \-- AndroidTest.xml (test config file)
  \-- src (component source)
  |    \-- foo.cpp
  |    \-- ...
  \-- tests (test source root)
      \-- Android.bp (test makefile)
      \-- testFoo (sub test source root)
      |   \-- Android.bp (sub test makefile)
      |   \-- src (sub test source)
      |       \-- test_foo.cpp
      |       \-- ...
      \-- testBar
      |   \-- Android.bp
      |   \-- src
      |       \-- test_bar.cpp
      |       \-- ...
      \-- ...

Quelle que soit la structure, vous finirez par remplir le répertoire tests ou le sous-répertoire que vous venez de créer avec des fichiers semblables à ceux du répertoire native dans l'exemple de modification de gerrit. Les sections ci-dessous expliquent plus en détail chaque fichier.

Code source

Pour obtenir un exemple, consultez Hello World GTest.

Le code source de cet exemple est annoté ici:

#include <gtest/gtest.h>

Inclusion de fichier d'en-tête pour GTest. La dépendance du fichier d'inclusion est automatiquement résolue à l'aide de BUILD_NATIVE_TEST dans le fichier make.

#include <stdio.h>

TEST(HelloWorldTest, PrintHelloWorld) {
    printf("Hello, World!");
}

Les GTests sont écrits à l'aide de la macro TEST: le premier paramètre correspond au nom du cas de test et le second au nom du test. Avec le nom du binaire de test, ils forment la hiérarchie suivante dans le tableau de bord des résultats:

<test binary 1>
| \-- <test case 1>
| |   \-- <test 1>
| |   \-- <test 2>
| |   \-- ...
| \-- <test case 2>
| |   \-- <test 1>
| |   \-- ...
| \-- ...
<test binary 2>
|
...

Pour en savoir plus sur l'écriture de tests avec GTest, consultez la documentation GTest.

Fichier de configuration simple

Chaque nouveau module de test doit disposer d'un fichier de configuration pour diriger le système de compilation avec les métadonnées du module, les dépendances au moment de la compilation et les instructions de packaging. Dans la plupart des cas, l'option de fichier de plan basée sur Soong est suffisante. Pour en savoir plus, consultez la page Configuration de test simple.

Fichier de configuration complexe

Pour utiliser Trade Federation à la place, écrivez un fichier de configuration de test pour le banc d'essais d'Android, Trade Federation.

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

Compiler et tester en local

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

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