Probar la asignación

Esta es una breve introducción a la asignación de pruebas y una explicación para comenzar a configurar pruebas en el Proyecto de código abierto de Android (AOSP).

Información acerca de la asignación de pruebas

La asignación de pruebas es un enfoque basado en Gerrit que permite a los desarrolladores crear reglas de pruebas previas y posteriores al envío directamente en el árbol de fuentes de Android y dejar las decisiones de las ramas y los dispositivos que se probarán a la infraestructura de pruebas. Las definiciones de la asignación de pruebas son archivos JSON llamados TEST_MAPPING que puedes colocar en cualquier directorio del código fuente.

Atest puede usar los archivos TEST_MAPPING para ejecutar pruebas antes del envío en los directorios asociados. Con la asignación de pruebas, puedes agregar el mismo conjunto de pruebas a las verificaciones previas al envío con un cambio mínimo dentro del árbol de origen de Android.

Consulta estos ejemplos:

La asignación de pruebas se basa en el agente de prueba de la Federación de Comercio (TF) para la ejecución de pruebas y los informes de resultados.

Define los grupos de prueba

Prueba las pruebas de grupos de asignación con un grupo de prueba. El nombre de un grupo de prueba puede ser cualquier cadena. Por ejemplo, presubmit puede ser el nombre de un grupo de pruebas que se ejecutarán cuando se validen los cambios. Y postsubmit pueden ser las pruebas que se usan para validar las compilaciones después de que se combinan los cambios.

Reglas de secuencias de comandos de compilación del paquete

A fin de que el agente de prueba de la Federación de Comercio ejecute módulos de prueba para una compilación determinada, estos deben tener un test_suites configurado para Soong o un LOCAL_COMPATIBILITY_SUITE para Make en uno de estos dos paquetes:

  • general-tests es para pruebas que no dependen de las capacidades específicas 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 paquete general-tests, incluso si son específicas de una ABI, una cantidad de bits o funciones de hardware, como HWASan (hay un destino test_suites independiente para cada ABI) y, incluso, si se tienen que ejecutar en un dispositivo.
  • device-tests es para pruebas que dependen de capacidades específicas del dispositivo. Por lo general, estas pruebas se encuentran en vendor/. Específico de dispositivo solo se refiere a las capacidades que son exclusivas de un dispositivo, por lo que esto se aplica a las pruebas JUnit y las pruebas de GTest (que normalmente deben marcarse como general-tests, incluso si son específicas de ABI).

Ejemplos:

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

Configura pruebas para que se ejecuten en un paquete de pruebas

Para que una prueba se ejecute dentro de un paquete de pruebas, la prueba debe cumplir con lo siguiente:

  • No debe tener ningún proveedor de compilación.
  • Se debe limpiar después de que finaliza, por ejemplo, borrando los archivos temporales generados durante la prueba.
  • Se debe cambiar la configuración del sistema al valor original o predeterminado.

  • No se debe suponer que un dispositivo está en un estado determinado, por ejemplo, listo para rootear. La mayoría de las pruebas no requieren privilegios de raíz para ejecutarse. Si una prueba debe requerir permisos de raíz, debe especificarlo con RootTargetPreparer en su AndroidTest.xml, como en el siguiente ejemplo:

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

Crea archivos de asignación de prueba

Para el directorio que requiere cobertura de prueba, agrega un archivo JSON TEST_MAPPING similar al ejemplo. Estas reglas garantizan que las pruebas se ejecuten en las verificaciones previas al envío cuando se toquen archivos en ese directorio o en cualquiera de sus subdirectorios.

Sigue un ejemplo

Este es un archivo TEST_MAPPING de ejemplo (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": "CtsDeqpTestCases",
      "options": [
        {
          // Use regex in include-filter which is supported in AndroidJUnitTest
          "include-filter": "dEQP-EGL.functional.color_clears.*"
        }
      ]
    }
  ],
  "imports": [
    {
      "path": "frameworks/base/services/core/java/com/android/server/am"
    }
  ]
}

Establece atributos

En el ejemplo, presubmit y postsubmit son los nombres de cada grupo de prueba. Consulta Cómo definir grupos de prueba para obtener más información sobre los grupos de prueba.

Puedes establecer el nombre del módulo de prueba o el nombre de la prueba de integración de Trade Federation (ruta de acceso al archivo XML de prueba, por ejemplo, uiautomator/uiautomator-demo) en el valor del atributo name. Ten en cuenta que el campo name no puede usar la clase name ni el método de prueba name. Para reducir las pruebas que se ejecutarán, usa opciones como include-filter. Consulta el uso de muestra de include-filter.

La configuración host de una prueba indica si 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 los objetos binarios de GTest y HostTest para las pruebas JUnit.

El atributo file_patterns te permite establecer una lista de cadenas de expresiones regulares para que coincidan con la ruta de acceso relativa de cualquier archivo de código fuente (relativa al directorio que contiene el archivo TEST_MAPPING). En el ejemplo, la prueba CtsWindowManagerDeviceTestCases se ejecuta en la etapa previa al envío solo cuando un archivo Java comienza con Window o Activity, que existe en el mismo directorio que el archivo TEST_MAPPING o cualquiera de sus subdirectorios. Las barras inversas (\) deben tener escape, ya que se encuentran en un archivo JSON.

El atributo imports te permite incluir pruebas en otros archivos TEST_MAPPING sin copiar el contenido. También se incluyen los archivos TEST_MAPPING de los directorios superiores de la ruta de acceso importada. La asignación de pruebas permite importaciones anidadas, lo que significa que dos archivos TEST_MAPPING pueden importarse entre sí, y la asignación de pruebas puede combinar las pruebas incluidas.

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

Para obtener una lista completa de las opciones disponibles para una prueba determinada, ejecuta lo siguiente:

tradefed.sh run commandAndExit [test_module] --help

Consulta Manejo de opciones en Tradefed para obtener más detalles sobre cómo funcionan las opciones.

Ejecuta pruebas con Atest

Para ejecutar las reglas de prueba previas al envío de forma local, haz lo siguiente:

  1. Ve al directorio que contiene el archivo TEST_MAPPING.

  2. Ejecuta el siguiente comando:

    atest

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

Esta es la forma más directa de ejecutar pruebas previas al envío en archivos TEST_MAPPING en el directorio de trabajo actual (CWD) y en los directorios superiores. Atest localiza y usa el archivo TEST_MAPPING en CWD y todos sus directorios superiores.

Estructura el código fuente

En este ejemplo, se muestra cómo puedes configurar 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"
    }
  ]}

Cómo especificar directorios de destino

Puedes especificar un directorio de destino para ejecutar pruebas en archivos TEST_MAPPING en ese directorio. El siguiente comando ejecuta dos pruebas (A y B):

atest --test-mapping src/project_1

Ejecuta reglas de prueba posteriores al envío

También puedes 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 superiores:

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

Ejecutar solo pruebas que no requieran ningún dispositivo

Puedes usar la opción --host para que Atest ejecute solo aquellas pruebas configuradas en el host que no requieren un dispositivo. Sin esta opción, Atest ejecuta ambas pruebas, las que requieren un dispositivo y las que se ejecutan en un host que no requiere un dispositivo. Las pruebas se ejecutan en dos suites independientes:

atest [--test-mapping] --host

Identifica grupos de prueba

Puedes especificar grupos de prueba en el comando Atest. El siguiente comando ejecuta todas las pruebas de postsubmit relacionadas con los archivos del directorio src/project_1, que solo contiene una prueba (C).

O puedes usar :all para ejecutar todas las pruebas, sin importar el grupo. El siguiente comando ejecuta cuatro pruebas (A, B, C y X):

atest --test-mapping src/project_1:all

Cómo incluir subdirectorios

De forma predeterminada, la ejecución de pruebas en TEST_MAPPING con Atest solo ejecuta pruebas de envío previo configuradas en el archivo TEST_MAPPING de CWD (o directorio determinado) y sus directorios superiores. Si deseas ejecutar pruebas en todos los archivos TEST_MAPPING de los subdirectorios, usa la opción --include-subdir para forzar a Atest a que también incluya esas pruebas.

atest --include-subdir

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

Se admiten comentarios a nivel de la línea

Puedes agregar un comentario de formato // a nivel de línea para desarrollar el archivo TEST_MAPPING con una descripción del parámetro de configuración que sigue. ATest y Trade Federation preprocesan TEST_MAPPING a un formato JSON válido sin comentarios. Para mantener limpio el archivo JSON, solo se admite el comentario de formato // a nivel de línea.

Ejemplo:

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