Comienza a realizar pruebas de instrumentación

En esta guía, se describe cómo preparar y ejecutar una prueba de instrumentación con Firebase Test Lab. Para usar esta guía, necesitas una prueba de instrumentación (escrita por ti o tu equipo) que use los frameworks de pruebas de Android Espresso o UI Automator. Las pruebas de instrumentación pueden ejecutarse hasta 45 minutos en dispositivos físicos y hasta 60 minutos en dispositivos virtuales.

En los pasos posteriores, subirás el archivo APK de la app y el de la prueba a Firebase.

Nota: Test Lab ya no es compatible con el framework de pruebas para Android Robotium.

Agrega la biblioteca de capturas de pantalla a tu app (opcional)

Firebase Test Lab incluye una biblioteca (testlab‑instr‑lib) que puedes usar para procesar las capturas de pantalla que realices con ScreenCapture de AndroidX cuando ejecutes pruebas de instrumentación, como aquellas que se escriben con el framework para pruebas Espresso. En esta sección, se describe cómo crear objetos ScreenCapture con la biblioteca de AndroidX y cómo procesarlos con testlab‑instr‑lib.

Después de que se ejecute la prueba de instrumentación, podrás ver las capturas de pantalla tomadas en Firebase console.

Prueba una app de ejemplo

Descarga la app de ejemplo de NotePad para probar esta funcionalidad. La capacidad de tomar capturas de pantalla ya está incorporada en el proyecto del NotePad.

Paso 1: Agrega la biblioteca de capturas de pantalla a tu proyecto

1. En el archivo Gradle (settings.gradle.kts o settings.gradle) de la configuración de nivel de raíz de tu proyecto de prueba, agrega el repositorio Maven de Google a cada sección repositories:

   pluginManagement {
       repositories {
           // Add the following line:
           google() // Google's Maven repository
           mavenCentral()
           gradlePluginPortal()
       }
   }
   dependencyResolutionManagement {
       repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
       repositories {
           // Add the following line:
           google() // Google's Maven repository
           mavenCentral()
       }
   }
   // ...

2. En el archivo Gradle (generalmente <project>/<app-module>/build.gradle.kts o <project>/<app-module>/build.gradle) del módulo (nivel de app), agrega una dependencia para la biblioteca de capturas de pantalla de Test Lab.

   dependencies {
     // ...
     // Add Test Lab's instrumentation test screenshot library:
     androidTestImplementation("com.google.firebase:testlab-instr-lib:0.2")
     // ...

3. En el archivo AndroidManifest.xml de la prueba, registra el FirebaseScreenCaptureProcessor en una etiqueta de metadatos dentro del elemento <instrumentation>. También puedes especificar el procesador como un argumento en AndroidJUnitRunner (consulta la documentación de referencia de AndroidJUnitRunner para obtener instrucciones).

   <instrumentation
     // Check that you have the following line (if not, add it):
     android:name="androidx.test.runner.AndroidJUnitRunner" // Specifies AndroidJUnitRunner as the test runner
     android:targetPackage="com.your.package.name">
   
   // Add the following:
   <meta-data
     android:name="screenCaptureProcessors"
     android:value="com.google.firebase.testlab.screenshot.FirebaseScreenCaptureProcessor" />
   </instrumentation>
   ...
   

4. En el archivo AndroidManifest.xml de tu app, agrega las siguientes líneas al elemento <manifest>:

    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
   

5. En el archivo AndroidManifest.xml, agrega las siguientes líneas a la etiqueta <manifest> para especificar los permisos de sistema de la app. Si realizas pruebas en Android 10 (nivel de API 29) o versiones posteriores, omite el permiso WRITE_EXTERNAL_STORAGE (la app no requiere este permiso para leer y escribir capturas de pantalla en el dispositivo).

   <manifest ... >
       <!-- WRITE_EXTERNAL_STORAGE is not needed on Android 10 (API level 29) or higher. -->
       <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
       <uses-permission android:name="android.permission.INTERNET"/>
       ...
   </manifest>

Paso 2. Toma capturas de pantalla durante la prueba

En cualquier momento de la prueba en el que quieras tomar una captura de pantalla, llama al método Screenshot.capture() de la biblioteca de AndroidX. Esto produce un objeto ScreenCapture. Cuando llamas a process() en el objeto ScreenCapture, se procesa mediante el ScreenCaptureProcessor que está registrado en tu AndroidManifest.xml. Ten en cuenta que se usa BasicScreenCaptureProcessor si no se registran procesadores. Debido a que registraste el FirebaseScreenCaptureProcessor, tus capturas de pantalla se procesarán mediante FirebaseScreenCaptureProcessor y estarán disponibles para ti con los resultados cuando ejecutes la prueba con Firebase Test Lab.

A continuación, se muestran casos de uso de ejemplo para crear una ScreenCapture:

• Realiza una ScreenCapture completa en una API Build.VERSION_CODES.JELLY_BEAN_MR2 y posteriores:

  Screenshot.capture()
  

• Realiza una ScreenCapture de la actividad en cualquier nivel de API. Ten en cuenta que esta es la única opción para los dispositivos que utilizan una versión inferior a Build.VERSION_CODES.JELLY_BEAN_MR2.

  @Rule
    public ActivityTestRule<MainActivity> activityRule = new ActivityTestRule<>(MainActivity.class);
  ...
  Screenshot.capture(activityRule.getActivity());
  ...
  

Ejemplos de casos de uso para procesar una ScreenCapture

• Procesa una ScreenCapture a través de FirebaseScreenCaptureProcessor:

  Screenshot.capture().process();
  

• Procesa una ScreenCapture mediante un ScreenCaptureProcessor especificado (esto te permite omitir el registro del procesador):

  Set<ScreenCaptureProcessor> processors = new HashSet<>();
  processors.add(new FirebaseScreenCaptureProcessor());
  Screenshot.capture().process(processors);
  

• Configura el nombre y el formato de la ScreenCapture, y procésala con el procesador registrado:

  Screenshot.capture().setName("myscreenshot").setFormat(CompressFormat.JPEG).process();
  

Paso 3: Compila y ejecuta tu prueba

1. Compila tu app y prueba los APK (consulta Prueba tu app para obtener instrucciones).

2. Sube los archivos APK al panel de Test Lab de Firebase console.

3. Por último, ejecuta la prueba.

Paso 4: Visualiza las capturas de pantalla de prueba

Una vez que se complete la prueba, podrás ver las capturas de pantalla realizadas en Firebase console.

1. En la pestaña Pruebas, selecciona la prueba completada y, luego, haz clic en la pestaña Resultados.

2. Vuelve a seleccionar la prueba y, luego, haz clic en la pestaña Capturas de pantalla que aparece.

Habilita funciones de prueba adicionales (opcional)

Puedes habilitar las siguientes funciones en tu prueba antes de ejecutarla con Test Lab:

Habilita Orchestrator

Android Test Orchestrator es una herramienta que ejecuta cada una de las pruebas de instrumentación de la app de forma independiente. Test Lab siempre usa la versión más reciente de Orchestrator.

Si quieres habilitar Orchestrator para Test Lab, en configuración de la prueba de instrumentación, haz clic en Opciones adicionales > Ejecutar con Orchestrator.

Precaución: Para evitar que una prueba con mal funcionamiento consuma parte de tu cuota o genere gastos facturables, ejecuta Orchestrator de manera local antes de probarlo en Test Lab. Antes de subir el APK, ejecuta una prueba en tu propia máquina para confirmar que Orchestrator funcione con tu app. Ten en cuenta que las pruebas con Orchestrator tardan un poco más que sin este y podrían afectar la facturación o hacer que las pruebas superen el límite de tiempo de espera.

Cuando usas Orchestrator, obtienes los siguientes beneficios:

• Sin estado compartido: Cada prueba se ejecuta en su propia instancia de instrumentación, por lo que no se acumula el estado compartido entre ellas.
• Fallas aisladas: Si falla una prueba, solo se interrumpe su propia instancia de instrumentación, por lo que las demás pruebas se mantienen activas.

Ten en cuenta que, cuando usas Orchestrator, cada prueba ejecuta su propia instancia de instrumentación, por lo que el proceso de la app se reinicia después de cada caso de prueba. El aumento en los tiempos de ejecución podría afectar el uso de la cuota o el tiempo de facturación y hacer que excedas los límites de tiempo de espera de tus dispositivos. Si reduces el tiempo de inicio de la app, esta sobrecarga se acortará.

Si quieres establecer opciones adicionales para Orchestrator, especifícalas mediante el campo environmentVariables. Por ejemplo, para usar clearPackageData, usa la siguiente opción en gcloud:

--environment-variables clearPackageData=true

Habilita la fragmentación

Con la fragmentación de pruebas, se divide un conjunto de pruebas en subgrupos (fragmentos) que se ejecutan por separado de forma aislada. Test Lab ejecuta automáticamente cada fragmento en paralelo con varios dispositivos y completa todo el conjunto de pruebas en menos tiempo.

Por ejemplo, si creas N fragmentos, para cada dispositivo que selecciones, Test Lab inicia N dispositivos idénticos y ejecuta un subconjunto de las pruebas en cada dispositivo. Esto significa que los casos de prueba fragmentados pueden generar varias ejecuciones de prueba por dispositivo. Sin embargo, los casos de prueba no fragmentados realizan una ejecución de prueba por dispositivo. Para conocer los conceptos de Test Lab, consulta Conceptos clave.

Para habilitar la fragmentación de pruebas en Firebase console, sigue estos pasos:

1. En la configuración de la prueba de instrumentación, haz clic en Opciones adicionales.

2. En la sección Fragmentación, ingresa la cantidad de fragmentos que quieres ejecutar.

Facturación por fragmentos de prueba

Test Lab aprovecha el mecanismo de fragmentación integrado de AndroidJUnitRunner para implementar tus fragmentos. Para evitar que se te cobre por iniciar fragmentos vacíos (fragmentos sin casos de prueba asignados), la cantidad de fragmentos que crees debe ser menor que la cantidad total de casos de prueba. Según cuánto tarde en ejecutarse cada caso de prueba, por lo general, se recomienda asignar de 2 a 10 casos de prueba por fragmento.

Precaución: La fragmentación de pruebas puede tener un costo superior. Aunque la fragmentación de pruebas reduce el tiempo que lleva ejecutar todas las pruebas, la sobrecarga de iniciar tu app en cada fragmento puede aumentar los tiempos de cada dispositivo (el tiempo que tarda un dispositivo en ejecutar sus pruebas) Debido a que los cargos se calculan por minuto para cada fragmento, es posible que aumenten tus cargos totales. Además, los fragmentos se cuentan en tu cuota diaria para la realización de ejecuciones de prueba.

Para obtener más detalles sobre la facturación, consulta el artículo sobre uso, cuotas y facturación.