Ajouter de nouveaux GoogleTests (GTests)

Si vous êtes nouveau dans le développement de plates-formes Android, vous trouverez peut-être cet exemple complet d'ajout d'un tout nouveau binaire GTest (également parfois appelé test « natif ») à partir de zéro, utile pour démontrer le flux de travail typique impliqué. Pour plus d'informations sur le framework GTest pour C++, reportez-vous au site du projet GTest pour une documentation supplémentaire.

Ce guide utilise le Hello World GTest comme exemple. Nous vous recommandons de lire le code pour en avoir une idée générale avant de continuer.

Décidez d'un emplacement source

En règle générale, votre équipe disposera déjà d'un modèle établi d'emplacements pour archiver le code et d'emplacements pour ajouter des tests. La plupart des équipes possèdent un seul référentiel 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 à <component source root> , la plupart des composants contiennent des dossiers src et tests , ainsi que des fichiers supplémentaires tels que Android.mk (ou divisés en fichiers .bp supplémentaires).

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

Dans certains cas, votre équipe peut avoir d'autres structures de répertoires en cours tests en raison de la nécessité de regrouper différentes suites de tests dans des binaires individuels. Et dans ce cas, vous devrez créer un nouveau sous-répertoire sous tests .

Pour illustrer, voici un aperçu de répertoire typique 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
          \-- ...

et voici un aperçu de répertoire typique pour les composants avec plusieurs répertoires 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 nouvellement créé avec des fichiers similaires à ceux du répertoire native dans l'exemple de changement gerrit. Les sections ci-dessous expliqueront plus en détail chaque fichier.

Code source

Reportez-vous au Hello World GTest pour un exemple.

Le code source de cet exemple est annoté ici :

#include <gtest/gtest.h>

Fichier d'en-tête inclus pour GTest. La dépendance du fichier d'inclusion est automatiquement résolue en utilisant BUILD_NATIVE_TEST dans le makefile.

#include <stdio.h>

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

Les GTests sont écrits à l'aide de la macro TEST : le premier paramètre est le nom du scénario de test et le second est le 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 plus d'informations sur l'écriture de tests avec GTest, reportez-vous à la documentation GTest

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 utiliser Trade Federation à la place, écrivez 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.

Construire et tester localement

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

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