Mapeo de prueba

Esta es una breve introducción de Test Mapping y una explicación de cómo comenzar a configurar pruebas fácilmente en el Proyecto de código abierto de Android (AOSP).

¿Qué es el mapeo de prueba?

Test Mapping es un enfoque basado en Gerrit que permite a los desarrolladores crear reglas de prueba previas y posteriores al envío directamente en el árbol de fuentes de Android y dejar que las decisiones de las sucursales y los dispositivos se prueben en la propia infraestructura de prueba. Las definiciones de asignación de prueba son archivos JSON denominados TEST_MAPPING que se pueden colocar en cualquier directorio de origen.

Atest puede usar los archivos TEST_MAPPING para ejecutar pruebas previas al envío en los directorios asociados. Con Test Mapping, puede agregar el mismo conjunto de pruebas para enviar comprobaciones con un simple cambio dentro del árbol de fuentes de Android.

Vea estos ejemplos:

Agregue pruebas de envío previo a TEST_MAPPING para services.core

Agregue pruebas de envío previo a TEST_MAPPING para herramientas/dexter usando importaciones

Test Mapping se basa en el arnés de prueba de Trade Federation (TF) para la ejecución de pruebas y el informe de resultados.

Definición de grupos de prueba

La asignación de pruebas agrupa las pruebas a través de un grupo de prueba . El nombre de un grupo de prueba puede ser cualquier cadena. Por ejemplo, el envío previo puede ser para que se ejecute un grupo de pruebas al validar los cambios. Y las pruebas posteriores al envío se pueden usar para validar las compilaciones después de fusionar los cambios.

Empaquetar reglas de script de compilación

Para que Trade Federation Test Harness ejecute los módulos de prueba de Test Mapping para una compilación determinada, estos módulos deben tener test_suite configurado para Soong o LOCAL_COMPATIBILITY_SUITE configurado para Make en uno de estos dos conjuntos:

• pruebas generales : pruebas que no dependen de la funcionalidad específica del dispositivo (como el hardware específico del proveedor que la mayoría de los dispositivos no tienen). La mayoría de las pruebas deben estar en el conjunto de pruebas generales, incluso si son específicas de una ABI o bitness o características de hardware como HWASan (hay un objetivo de conjuntos de pruebas separado para cada ABI), e incluso si tienen que ejecutarse en un dispositivo.
• pruebas de dispositivos : pruebas que dependen de la funcionalidad específica del dispositivo. Por lo general, estas pruebas se encuentran en el vendor/ . Debido a que "específico del dispositivo" no se refiere a la funcionalidad ABI o SoC que otros dispositivos pueden tener o no, sino solo a la funcionalidad que es exclusiva de un dispositivo, esto se aplica a las pruebas JUnit tanto como las pruebas nativas de GTest (que generalmente deberían ser general-tests incluso si son específicas de ABI).

Ejemplos:

Android.bp: test_suites: ["general-tests"],
Android.mk: LOCAL_COMPATIBILITY_SUITE := general-tests

Configuración de pruebas para ejecutar en un conjunto de pruebas

Para que una prueba se ejecute dentro de un conjunto de pruebas, la prueba:

• no debe tener ningún proveedor de compilación.
• debe limpiarse una vez finalizada, por ejemplo, eliminando los archivos temporales generados durante la prueba.
• cambie la configuración del sistema a su valor predeterminado u original.
• no debe asumir un dispositivo en un cierto estado, por ejemplo, root listo. La mayoría de las pruebas no requieren privilegios de root para ejecutarse. Si una prueba debe requerir root, debe especificarlo con un RootTargetPreparer en su AndroidTest.xml , como en el siguiente ejemplo:

<target_preparer class="com.android.tradefed.targetprep.RootTargetPreparer"/>

Creación de archivos de asignación de prueba

Para el directorio que requiere cobertura de prueba, simplemente agregue un archivo JSON TEST_MAPPING similar al ejemplo a continuación. Estas reglas garantizarán que las pruebas se ejecuten en comprobaciones previas al envío cuando se toque cualquier archivo en ese directorio o cualquiera de sus subdirectorios.

Siguiendo un ejemplo

Aquí hay un archivo TEST_MAPPING de muestra (está en formato JSON pero admite comentarios):

{
  "presubmit": [
    // JUnit test with options and file patterns.
    {
      "name": "CtsWindowManagerDeviceTestCases",
      "options": [
        {
          "include-annotation": "android.platform.test.annotations.RequiresDevice"
        }
      ],
      "file_patterns": ["(/|^)Window[^/]*\\.java", "(/|^)Activity[^/]*\\.java"]
    },
    // Device-side GTest with options.
    {
      "name" : "hello_world_test",
      "options": [
        {
          "native-test-flag": "\"servicename1 servicename2\""
        },
        {
          "native-test-timeout": "6000"
        }
      ]
    }
    // Host-side GTest.
    {
      "name" : "net_test_avrcp",
      "host" : true
    }
  ],
  "postsubmit": [
    {
      "name": "CtsWindowManagerDeviceTestCases"
    }
  ],
  "imports": [
    {
      "path": "frameworks/base/services/core/java/com/android/server/am"
    }
  ]
}

Configuración de atributos

En el ejemplo anterior, presubmit y postsubmit son los nombres de cada grupo de prueba . Consulte Definición de grupos de prueba para obtener más información sobre los grupos de prueba.

El nombre del módulo de prueba o el nombre de prueba de integración de Trade Federation (ruta de recursos al archivo XML de prueba, por ejemplo, uiautomator/uiautomator-demo ) se puede establecer en el valor del atributo de name . Tenga en cuenta que el campo de nombre no puede usar el name name método de prueba. Para reducir las pruebas a ejecutar, puede usar opciones como include-filter aquí. Consulte ( uso de ejemplo de filtro incluido ).

La configuración del host de una prueba indica si la prueba es una prueba sin dispositivo que se ejecuta en el host o no. El valor predeterminado es false , lo que significa que la prueba requiere un dispositivo para ejecutarse. Los tipos de prueba admitidos son HostGTest para binarios GTest y HostTest para pruebas JUnit.

El atributo file_patterns le permite establecer una lista de cadenas de expresiones regulares para hacer coincidir la ruta relativa de cualquier archivo de código fuente (en relación con el directorio que contiene el archivo TEST_MAPPING). En el ejemplo anterior, la prueba CtsWindowManagerDeviceTestCases se ejecutará en el envío previo solo cuando se cambie cualquier archivo java que comience con Window o Activity, que existe en el mismo directorio del archivo TEST_MAPPING o cualquiera de sus subdirectorios. Las barras invertidas \ deben escaparse, ya que están en un archivo JSON.

El atributo de importación le permite incluir pruebas en otros archivos TEST_MAPPING sin copiar el contenido. Tenga en cuenta que también se incluirán los archivos TEST_MAPPING en los directorios principales de la ruta importada. Test Mapping permite importaciones anidadas; esto significa que dos archivos TEST_MAPPING pueden importarse entre sí, y Test Mapping puede fusionar correctamente las pruebas incluidas.

El atributo de opciones contiene opciones adicionales de la línea de comandos de TradeFed.

Para obtener una lista completa de las opciones disponibles para una prueba determinada, ejecute:

tradefed.sh run commandAndExit [test_module] --help

Consulte Manejo de opciones de TradeFed para obtener más detalles sobre cómo funcionan las opciones.

Ejecución de pruebas con Atest

Para ejecutar las reglas de prueba de preenvío localmente:

1. Vaya al directorio que contiene el archivo TEST_MAPPING.
2. Ejecute el comando:

atest

Se ejecutan todas las pruebas de envío previo configuradas en los archivos TEST_MAPPING del directorio actual y sus directorios principales. Atest localizará y ejecutará dos pruebas para el envío previo (A y B).

Esta es la forma más sencilla de ejecutar pruebas de envío previo en archivos TEST_MAPPING en el directorio de trabajo actual (CWD) y los directorios principales. Atest localizará y utilizará el archivo TEST_MAPPING en CWD y todos sus directorios principales.

Estructuración del código fuente

El siguiente ejemplo muestra cómo se pueden configurar los archivos TEST_MAPPING en el árbol de origen.

src
├── project_1
│   └── TEST_MAPPING
├── project_2
│   └── TEST_MAPPING
└── TEST_MAPPING

Contenido de src/TEST_MAPPING :

{
  "presubmit": [
    {
      "name": "A"
    }
  ]
}

Contenido de src/project_1/TEST_MAPPING :

{
  "presubmit": [
    {
      "name": "B"
    }
  ],
  "postsubmit": [
    {
      "name": "C"
    }
  ],
  "other_group": [
    {
      "name": "X"
    }
  ]}

Contenido de src/project_2/TEST_MAPPING :

{
  "presubmit": [
    {
      "name": "D"
    }
  ],
  "import": [
    {
      "path": "src/project_1"
    }
  ]}

Especificación de directorios de destino

Puede especificar un directorio de destino para ejecutar pruebas en archivos TEST_MAPPING en ese directorio. El siguiente comando ejecutará dos pruebas (A, B).

atest --test-mapping src/project_1

Ejecución de reglas de prueba posteriores al envío

También puede usar este comando para ejecutar las reglas de prueba posteriores al envío definidas en TEST_MAPPING en src_path (predeterminado en CWD) y sus directorios principales:

atest [--test-mapping] [src_path]:postsubmit

Ejecutar solo pruebas que no requieren ningún dispositivo

Puede usar la opción --host para Atest para ejecutar solo pruebas configuradas contra el host que no requieren dispositivo. Sin esta opción, Atest ejecutará ambas pruebas, las que requieren dispositivo y las que se ejecutan en el host y no requieren dispositivo. Las pruebas se ejecutarán en dos suites separadas.

atest [--test-mapping] --host

Identificación de grupos de prueba

Puede especificar grupos de prueba en el comando Atest. El siguiente comando ejecutará todas las pruebas posteriores al envío relacionadas con los archivos en el directorio src/project_1, que contiene solo una prueba (C).

O puede usar :all para ejecutar todas las pruebas independientemente del grupo. El siguiente comando ejecuta cuatro pruebas (A, B, C, X):

atest --test-mapping src/project_1:all

Incluyendo subdirectorios

De forma predeterminada, ejecutar pruebas en TEST_MAPPING con Atest ejecutará solo pruebas de envío previo configuradas en el archivo TEST_MAPPING en CWD (o directorio dado) y sus directorios principales. Si desea ejecutar pruebas en todos los archivos TEST_MAPPING en los subdirectorios, use la opción --include-subdir para obligar a Atest a incluir esas pruebas también.

atest --include-subdir

Sin la opción --include-subdir , Atest ejecutará solo la prueba A. Con la opción --include-subdir , Atest ejecutará dos pruebas (A, B).

Se admiten comentarios a nivel de línea

Puede agregar un comentario de formato // de nivel de línea para completar el archivo TEST_MAPPING con una descripción de la configuración a continuación. ATest y Trade Federation preprocesarán TEST_MAPPING en un formato JSON válido sin comentarios. Para mantener el archivo JSON limpio y fácil de leer, solo se admiten comentarios de formato // de nivel de línea.

Ejemplo:

{
  // For presubmit test group.
  "presubmit": [
    {
      // Run test on module A.
      "name": "A"
    }
  ]
}