Ejemplo de pruebas de autoinstrumentación

Cuando se inicia una prueba de instrumentación, su paquete de destino se reinicia con el código de instrumentación inyectado e iniciado para su ejecución. Una excepción es que el paquete de destino aquí no puede ser el marco de la aplicación Android en sí, como el paquete android , porque hacerlo conduce a la situación paradójica en la que sería necesario reiniciar el marco de Android, que es lo que soporta las funciones del sistema, incluyendo la propia instrumentación.

Esto significa que una prueba de instrumentación no puede inyectarse en el marco de trabajo de Android, también conocido como el servidor del sistema, para su ejecución. Para probar el marco de Android, el código de prueba puede invocar solo superficies API públicas o aquellas expuestas mediante el lenguaje de definición de interfaz de Android AIDL disponible en el árbol de fuentes de la plataforma. Para esta categoría de pruebas, no tiene sentido apuntar a ningún paquete en particular. Por lo tanto, es habitual que dichas instrumentaciones se declaren para apuntar a su propio paquete de aplicación de prueba, como se define en su propia etiqueta <manifest> de AndroidManifest.xml .

Dependiendo de los requisitos, los paquetes de aplicaciones de prueba en esta categoría también pueden:

  • Agrupe las actividades necesarias para las pruebas.
  • Comparta la identificación de usuario con el sistema.
  • Estar firmado con la clave de la plataforma.
  • Compilarse con la fuente del marco en lugar del SDK público.

Esta categoría de pruebas de instrumentación a veces se denomina autoinstrumentación. A continuación se muestran algunos ejemplos de pruebas de autoinstrumentación en la fuente de la plataforma:

El ejemplo que se trata aquí consiste en escribir una nueva prueba de instrumentación con el paquete de destino configurado en su propio paquete de aplicación de prueba. Esta guía utiliza la siguiente prueba como ejemplo:

Se recomienda examinar primero el código para tener una impresión aproximada antes de continuar.

Decidir una ubicación de origen

Normalmente, su equipo ya tendrá un patrón establecido de lugares para registrar el código y lugares para agregar pruebas. La mayoría de los equipos poseen un único repositorio de git o comparten uno con otros equipos, pero tienen un subdirectorio dedicado que contiene el código fuente de los componentes.

Suponiendo que la ubicación raíz del origen de su componente está en <component source root> , la mayoría de los componentes tienen carpetas src y tests debajo, y algunos archivos adicionales como Android.mk (o divididos en archivos .mk adicionales), el archivo de manifiesto AndroidManifest.xml y el archivo de configuración de prueba 'AndroidTest.xml'.

Dado que está agregando una prueba nueva, probablemente necesitará crear el directorio tests junto a su componente src y completarlo con contenido.

En algunos casos, es posible que su equipo tenga más estructuras de directorios bajo tests debido a la necesidad de empaquetar diferentes conjuntos de pruebas en aplicaciones individuales. Y en este caso, deberá crear un nuevo subdirectorio en tests .

Independientemente de la estructura, terminará llenando el directorio tests o el subdirectorio recién creado con archivos similares a los que hay en el directorio instrumentation en el cambio de gerrit de muestra. Los detalles de cada archivo se explican más adelante en este documento.

archivo de manifiesto

Al igual que con un proyecto de aplicación, cada módulo de prueba de instrumentación requiere un archivo de manifiesto llamado AndroidManifest.xml . Para incluir automáticamente este archivo usando el archivo MAKE principal BUILD_PACKAGE , proporcione este archivo junto al archivo Android.mk para su módulo de prueba.

Si no está familiarizado con el archivo AndroidManifest.xml , consulte la descripción general del manifiesto de la aplicación.

A continuación se muestra un archivo AndroidManifest.xml de muestra:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
  android:sharedUserId="android.uid.system"
  package="android.test.example.helloworld" >

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

    <instrumentation android:name="androidx.test.runner.AndroidJUnitRunner"
                     android:targetPackage="android.test.example.helloworld"
                     android:label="Hello World Test"/>

</manifest>

Algunas observaciones selectas sobre el archivo de manifiesto:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="android.test.example.helloworld" >

El atributo del package es el nombre del paquete de la aplicación: este es el identificador único que utiliza el marco de la aplicación de Android para identificar una aplicación (o en este contexto: su aplicación de prueba). Cada usuario del sistema sólo puede instalar una aplicación con ese nombre de paquete.

Además, este atributo package es el mismo que devuelve ComponentName#getPackageName() , y también el mismo que usarías para interactuar con varios subcomandos pm usando adb shell .

Tenga en cuenta que, aunque el nombre del paquete suele tener el mismo estilo que el nombre del paquete Java, en realidad tiene muy pocas cosas que ver con él. En otras palabras, su paquete de aplicación (o prueba) puede contener clases con cualquier nombre de paquete, aunque, por otro lado, puede optar por la simplicidad y tener el nombre del paquete Java de nivel superior en su aplicación o prueba idéntico al nombre del paquete de la aplicación.

android:sharedUserId="android.uid.system"

Esto declara que en el momento de la instalación, a este archivo APK se le debe otorgar el mismo ID de usuario, es decir, identidad de tiempo de ejecución, que la plataforma principal. Tenga en cuenta que esto depende de que la apk esté firmada con el mismo certificado que la plataforma principal (consulte LOCAL_CERTIFICATE en una sección anterior), aunque son conceptos diferentes:

  • algunos permisos o API están protegidos por firma, lo que requiere el mismo certificado de firma
  • algunos permisos o API requieren la identidad de usuario del system de la persona que llama, lo que requiere que el paquete de llamada comparta la ID de usuario con system , si es un paquete separado de la plataforma principal.
<uses-library android:name="android.test.runner" />

Esto es necesario para todas las pruebas de Instrumentación, ya que las clases relacionadas están empaquetadas en un archivo de biblioteca JAR de marco separado, por lo tanto, requiere entradas de ruta de clase adicionales cuando el marco de la aplicación invoca el paquete de prueba.

android:targetPackage="android.test.example.helloworld"

Es posible que hayas notado que el targetPackage aquí se declara igual que el atributo del package declarado en la etiqueta manifest de este archivo. Como se menciona en Conceptos básicos de las pruebas , esta categoría de pruebas de instrumentación generalmente está destinada a probar las API del marco, por lo que no es muy significativo para ellas tener un paquete de aplicación específico, aparte de él mismo.

Archivo de configuración sencillo

Cada nuevo módulo de prueba debe tener un archivo de configuración para dirigir el sistema de compilación con metadatos del módulo, dependencias en tiempo de compilación e instrucciones de empaquetado. En la mayoría de los casos, la opción de archivo Blueprint basado en Soong es suficiente. Para obtener más información, consulte Configuración de prueba simple .

Archivo de configuración complejo

Para estos casos más complejos, también necesita escribir un archivo de configuración de prueba para el arnés de prueba de Android, Trade Federation .

La configuración de prueba puede especificar opciones especiales de configuración del dispositivo y argumentos predeterminados para proporcionar la clase de prueba. Consulte el ejemplo en /platform_testing/tests/example/instrumentation/AndroidTest.xml .

Aquí se incluye una instantánea para mayor comodidad:

<configuration description="Runs sample instrumentation test.">
  <target_preparer class="com.android.tradefed.targetprep.TestFilePushSetup"/>
  <target_preparer class="com.android.tradefed.targetprep.TestAppInstallSetup">
    <option name="test-file-name" value="HelloWorldTests.apk"/>
  </target_preparer>
  <target_preparer class="com.android.tradefed.targetprep.PushFilePreparer"/>
  <target_preparer class="com.android.tradefed.targetprep.RunCommandTargetPreparer"/>
  <option name="test-suite-tag" value="apct"/>
  <option name="test-tag" value="SampleInstrumentationTest"/>

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

Algunas observaciones selectas sobre el archivo de configuración de prueba:

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

Esto le indica a Trade Federation que instale HelloWorldTests.apk en el dispositivo de destino utilizando un target_preparer específico. Hay muchos preparadores de objetivos disponibles para los desarrolladores en Trade Federation y estos se pueden utilizar para garantizar que el dispositivo esté configurado correctamente antes de la ejecución de la prueba.

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

Esto especifica la clase de prueba de Trade Federation que se usará para ejecutar la prueba y pasa en el paquete en el dispositivo que se ejecutará y el marco del ejecutor de pruebas, que es JUnit en este caso.

Para obtener más información, consulte Configuraciones del módulo de prueba .

Características de JUnit4

El uso de la biblioteca android-support-test como ejecutor de pruebas permite la adopción de nuevas clases de prueba de estilo JUnit4, y el cambio de muestra de gerrit contiene un uso muy básico de sus funciones. Consulte el ejemplo en /platform_testing/tests/example/instrumentation/src/android/test/example/helloworld/HelloWorldTest.java .

Si bien los patrones de prueba suelen ser específicos de los equipos de componentes, existen algunos patrones de uso generalmente útiles.

@RunWith(JUnit4.class)
public class HelloWorldTest {

Una diferencia significativa en JUnit4 es que ya no es necesario que las pruebas hereden de una clase de prueba base común; en su lugar, escribe pruebas en clases simples de Java y usa anotaciones para indicar ciertas configuraciones y restricciones de las pruebas. En este ejemplo, indicamos que esta clase se ejecute como una prueba JUnit4.

    @BeforeClass
    public static void beforeClass() {
    ...
    @AfterClass
    public static void afterClass() {
    ...
    @Before
    public void before() {
    ...
    @After
    public void after() {
    ...
    @Test
    @SmallTest
    public void testHelloWorld() {
    ...

Las anotaciones @Before y @After se utilizan en los métodos de JUnit4 para realizar la configuración previa a la prueba y el desmontaje posterior a la prueba. De manera similar, JUnit4 utiliza las anotaciones @BeforeClass y @AfterClass en los métodos para realizar la configuración antes de ejecutar todas las pruebas en una clase de prueba y el desmontaje posterior. Tenga en cuenta que los métodos de configuración y desmontaje del ámbito de clase deben ser estáticos. En cuanto a los métodos de prueba, a diferencia de la versión anterior de JUnit, ya no necesitan comenzar el nombre del método con test , sino que cada uno de ellos debe estar anotado con @Test . Como es habitual, los métodos de prueba deben ser públicos, no declarar ningún valor de retorno, no tomar parámetros y pueden generar excepciones.

Acceso a clases de instrumentación

Aunque no se trata en el ejemplo básico de Hola mundo, es bastante común que una prueba de Android requiera acceso a la instancia Instrumentation : esta es la interfaz API principal que brinda acceso a contextos de aplicaciones, API de prueba relacionadas con el ciclo de vida de la actividad y más.

Debido a que las pruebas JUnit4 ya no requieren una clase base común, ya no es necesario obtener la instancia Instrumentation a través de InstrumentationTestCase#getInstrumentation() ; en su lugar, el nuevo ejecutor de pruebas la administra a través de InstrumentationRegistry , donde se almacena la configuración contextual y ambiental creada por el marco de instrumentación.

Para acceder a la instancia de la clase Instrumentation , simplemente llame al método estático getInstrumentation() en la clase InstrumentationRegistry :

Instrumentation instrumentation = InstrumentationRegistry.getInstrumentation()

Construya y pruebe localmente

Para los casos de uso más comunes, utilice Atest .

Para casos más complejos que requieren una mayor personalización, siga las instrucciones de instrumentación .