Bibliotecas y herramientas para probar diferentes tamaños de pantalla

Android proporciona una variedad de herramientas y APIs que pueden ayudarte a crear pruebas para diferentes tamaños de pantalla y ventana.

Anular configuración de dispositivo

El elemento DeviceConfigurationOverride componible te permite anular atributos de configuración para probar varios tamaños de pantalla y ventana en los diseños de Compose. La anulación de ForcedSize se ajusta a cualquier diseño en el espacio disponible, lo que te permite ejecutar cualquier prueba de IU en cualquier tamaño de pantalla. Por ejemplo, puedes usar un factor de forma de teléfono pequeño para ejecutar todas las pruebas de IU, incluidas las pruebas de IU para teléfonos grandes, plegables y tablets.

   DeviceConfigurationOverride(
        DeviceConfigurationOverride.ForcedSize(DpSize(1280.dp, 800.dp))
    ) {
        MyScreen() // Will be rendered in the space for 1280dp by 800dp without clipping.
    }
Figura 1: Se usa DeviceConfigurationOverride para ajustar un diseño de tablet en un dispositivo de factor de forma más pequeño, como en \*Now in Android*.

Además, puedes usar este elemento componible para configurar la escala de fuentes, los temas y otras propiedades que quizás desees probar en diferentes tamaños de ventana.

Robolectric

Usa Robolectric para ejecutar pruebas de IU basadas en objetos View o Compose en la JVM de forma local. No se requieren dispositivos ni emuladores. Puedes configurar Robolectric para usar tamaños de pantalla específicos, entre otras propiedades útiles.

En el siguiente ejemplo de Now in Android, Robolectric está configurado para emular un tamaño de pantalla de 1,000 x 1,000 dp con una resolución de 480 dpi:

@RunWith(RobolectricTestRunner::class)
// Configure Robolectric to use a very large screen size that can fit all of the test sizes.
// This allows enough room to render the content under test without clipping or scaling.
@Config(qualifiers = "w1000dp-h1000dp-480dpi")
class NiaAppScreenSizesScreenshotTests { ... }

También puedes establecer los calificadores del cuerpo de la prueba, como se hace en este fragmento del ejemplo de Now in Android:

val (width, height, dpi) = ...

// Set qualifiers from specs.
RuntimeEnvironment.setQualifiers("w${width}dp-h${height}dp-${dpi}dpi")

Ten en cuenta que RuntimeEnvironment.setQualifiers() actualiza los recursos del sistema y de la aplicación con la nueva configuración, pero no activa ninguna acción en las actividades activas ni en otros componentes.

Puede obtener más información en la documentación de Configuración del dispositivo de Robolectric.

Dispositivos administrados por Gradle

El complemento de Android para Gradle dispositivos administrados por Gradle (GMD) te permite definir las especificaciones de los emuladores y dispositivos reales en los que se ejecutan las pruebas instrumentadas. Crea especificaciones para dispositivos con diferentes tamaños de pantalla para implementar una estrategia de prueba en la que ciertas pruebas se deban ejecutar en determinados tamaños de pantalla. Si usas GMD con integración continua (CI), puedes asegurarte de que se ejecuten las pruebas adecuadas cuando sea necesario, lo que permite aprovisionar e iniciar emuladores y simplificar la configuración de CI.

android {
    testOptions {
        managedDevices {
            devices {
                // Run with ./gradlew nexusOneApi30DebugAndroidTest.
                nexusOneApi30(com.android.build.api.dsl.ManagedVirtualDevice) {
                    device = "Nexus One"
                    apiLevel = 30
                    // Use the AOSP ATD image for better emulator performance
                    systemImageSource = "aosp-atd"
                }
                // Run with ./gradlew  foldApi34DebugAndroidTest.
                foldApi34(com.android.build.api.dsl.ManagedVirtualDevice) {
                    device = "Pixel Fold"
                    apiLevel = 34
                    systemImageSource = "aosp-atd"
                }
            }
        }
    }
}

Puedes encontrar varios ejemplos de GMD en el proyecto testing-samples.

Firebase Test Lab

Usa Firebase Test Lab (FTL), o un servicio similar, para ejecutar las pruebas en dispositivos reales específicos a los que quizás no tengas acceso, como dispositivos plegables o tablets de diferentes tamaños. Firebase Test Lab es un servicio pagado con un nivel gratuito. FTL también admite la ejecución de pruebas en emuladores. Estos servicios mejoran la confiabilidad y velocidad de las pruebas de instrumentación, ya que pueden aprovisionar dispositivos y emuladores con anticipación.

Para obtener información sobre el uso de FTL con GMD, consulta Ajusta tus pruebas con dispositivos administrados por Gradle.

Cómo filtrar pruebas con el ejecutor de pruebas

Una estrategia de prueba óptima no debería verificar lo mismo dos veces, por lo que la mayoría de las pruebas de la IU no necesitan ejecutarse en varios dispositivos. Por lo general, debes filtrar las pruebas de la IU ejecutando todas o la mayoría de ellas en un factor de forma de teléfono y solo un subconjunto en dispositivos con diferentes tamaños de pantalla.

Puedes anotar que ciertas pruebas se ejecuten solo con ciertos dispositivos y, luego, pasar un argumento a AndroidJUnitRunner con el comando que las ejecuta.

Por ejemplo, puedes crear diferentes anotaciones:

annotation class TestExpandedWidth
annotation class TestCompactWidth

Úsalas en diferentes pruebas:

class MyTestClass {

    @Test
    @TestExpandedWidth
    fun myExample_worksOnTablet() {
        ...
    }

    @Test
    @TestCompactWidth
    fun myExample_worksOnPortraitPhone() {
        ...
    }

}

Luego, puedes usar la propiedad android.testInstrumentationRunnerArguments.annotation cuando ejecutes las pruebas para filtrar pruebas específicas. Por ejemplo, si usas dispositivos administrados por Gradle, haz lo siguiente:

$ ./gradlew pixelTabletApi30DebugAndroidTest -Pandroid.testInstrumentationRunnerArguments.annotation='com.sample.TestExpandedWidth'

Si no usas GMD y administras emuladores en CI, primero asegúrate de que el emulador o dispositivo correcto esté listo y conectado y, luego, pasa el parámetro a uno de los comandos de Gradle para ejecutar pruebas instrumentadas:

$ ./gradlew connectedAndroidTest -Pandroid.testInstrumentationRunnerArguments.annotation='com.sample.TestExpandedWidth'

Ten en cuenta que el dispositivo Espresso (consulta la siguiente sección) también puede filtrar pruebas mediante las propiedades del dispositivo.

Dispositivo Espresso

Usa Espresso Device para realizar acciones en emuladores durante pruebas con cualquier tipo de pruebas de instrumentación, incluidas las pruebas Espresso, Compose o UI Automator. Estas acciones pueden incluir configurar el tamaño de la pantalla o activar o desactivar los estados o las posiciones plegables. Por ejemplo, puedes controlar un emulador de dispositivos plegables y configurarlos en el modo de mesa. El dispositivo Espresso también contiene reglas y anotaciones de JUnit para requerir ciertas funciones:

@RunWith(AndroidJUnit4::class)
class OnDeviceTest {

    @get:Rule(order=1) val activityScenarioRule = activityScenarioRule<MainActivity>()

    @get:Rule(order=2) val screenOrientationRule: ScreenOrientationRule =
        ScreenOrientationRule(ScreenOrientation.PORTRAIT)

    @Test
    fun tabletopMode_playerIsDisplayed() {
        // Set the device to tabletop mode.
        onDevice().setTabletopMode()
        onView(withId(R.id.player)).check(matches(isDisplayed()))
    }
}

Ten en cuenta que Espresso Device aún se encuentra en la etapa alfa y tiene los siguientes requisitos:

  • Complemento de Android para Gradle 8.3 o una versión posterior
  • Android Emulator 33.1.10 o una versión posterior
  • Dispositivo virtual Android que ejecute el nivel de API 24 o uno posterior

Pruebas de filtro

El dispositivo Espresso puede leer las propiedades de los dispositivos conectados para permitirte filtrar las pruebas con anotaciones. Si no se cumplen los requisitos anotados, se omiten las pruebas.

Anotación RequiresDeviceMode

Se puede usar la anotación RequiresDeviceMode varias veces para indicar una prueba que se ejecutará solo si el dispositivo admite todos los valores de DeviceMode.

class OnDeviceTest {
    ...
    @Test
    @RequiresDeviceMode(TABLETOP)
    @RequiresDeviceMode(BOOK)
    fun tabletopMode_playerIdDisplayed() {
        // Set the device to tabletop mode.
        onDevice().setTabletopMode()
        onView(withId(R.id.player)).check(matches(isDisplayed()))
    }
}

Anotación RequiresDisplay

La anotación RequiresDisplay te permite especificar el ancho y la altura de la pantalla del dispositivo mediante clases de tamaño, que definen los buckets de dimensiones según las clases de tamaño de ventana oficiales.

class OnDeviceTest {
    ...
    @Test
    @RequiresDisplay(EXPANDED, COMPACT)
    fun myScreen_expandedWidthCompactHeight() {
        ...
    }
}

Cambia el tamaño de las pantallas

Usa el método setDisplaySize() para cambiar el tamaño de las dimensiones de la pantalla durante el tiempo de ejecución. Usa el método junto con la clase DisplaySizeRule, lo que garantiza que se deshagan cualquier cambio realizado durante las pruebas antes de la siguiente prueba.

@RunWith(AndroidJUnit4::class)
class ResizeDisplayTest {

    @get:Rule(order = 1) val activityScenarioRule = activityScenarioRule<MainActivity>()

    // Test rule for restoring device to its starting display size when a test case finishes.
    @get:Rule(order = 2) val displaySizeRule: DisplaySizeRule = DisplaySizeRule()

    @Test
    fun resizeWindow_compact() {
        onDevice().setDisplaySize(
            widthSizeClass = WidthSizeClass.COMPACT,
            heightSizeClass = HeightSizeClass.COMPACT
        )
        // Verify visual attributes or state restoration.
    }
}

Cuando cambias el tamaño de una pantalla con setDisplaySize(), no se modifica la densidad del dispositivo. Por lo tanto, si una dimensión no se ajusta al dispositivo de destino, la prueba falla con una UnsupportedDeviceOperationException. Para evitar que se ejecuten pruebas en este caso, usa la anotación RequiresDisplay para filtrarlas:

@RunWith(AndroidJUnit4::class)
class ResizeDisplayTest {

    @get:Rule(order = 1) var activityScenarioRule = activityScenarioRule<MainActivity>()

    // Test rule for restoring device to its starting display size when a test case finishes.
    @get:Rule(order = 2) var displaySizeRule: DisplaySizeRule = DisplaySizeRule()

    /**
     * Setting the display size to EXPANDED would fail in small devices, so the [RequiresDisplay]
     * annotation prevents this test from being run on devices outside the EXPANDED buckets.
     */
    @RequiresDisplay(
        widthSizeClass = WidthSizeClassEnum.EXPANDED,
        heightSizeClass = HeightSizeClassEnum.EXPANDED
    )
    @Test
    fun resizeWindow_expanded() {
        onDevice().setDisplaySize(
            widthSizeClass = WidthSizeClass.EXPANDED,
            heightSizeClass = HeightSizeClass.EXPANDED
        )
        // Verify visual attributes or state restoration.
    }
}

Prueba de restauración del estado

La clase StateRestorationTester se usa para probar el restablecimiento del estado de los componentes componibles sin volver a crear actividades. Esto hace que las pruebas sean más rápidas y confiables, ya que la recreación de actividades es un proceso complejo con varios mecanismos de sincronización:

@Test
fun compactDevice_selectedEmailEmailRetained_afterConfigChange() {
    val stateRestorationTester = StateRestorationTester(composeTestRule)

    // Set content through the StateRestorationTester object.
    stateRestorationTester.setContent {
        MyApp()
    }

    // Simulate a config change.
    stateRestorationTester.emulateSavedInstanceStateRestore()
}

Biblioteca de Window Testing

La biblioteca de pruebas de Windows contiene utilidades para ayudarte a escribir pruebas que se basen en funciones relacionadas con la administración de ventanas o que las verifiquen, como la incorporación de actividades o las funciones plegables. El artefacto está disponible a través del repositorio de Maven de Google.

Por ejemplo, puedes usar la función FoldingFeature() para generar un objeto FoldingFeature personalizado, que puedes usar en las vistas previas de Compose. En Java, usa la función createFoldingFeature().

En una vista previa de Compose, puedes implementar FoldingFeature de la siguiente manera:

@Preview(showBackground = true, widthDp = 480, heightDp = 480)
@Composable private fun FoldablePreview() =
    MyApplicationTheme {
        ExampleScreen(
            displayFeatures = listOf(FoldingFeature(Rect(0, 240, 480, 240)))
        )
 }

Además, puedes emular las funciones de pantalla en las pruebas de la IU con la función TestWindowLayoutInfo(). En el siguiente ejemplo, se simula un FoldingFeature con una bisagra vertical HALF_OPENED en el centro de la pantalla y, luego, se verifica si el diseño es el esperado:

Redactar

import androidx.window.layout.FoldingFeature.Orientation.Companion.VERTICAL
import androidx.window.layout.FoldingFeature.State.Companion.HALF_OPENED
import androidx.window.testing.layout.FoldingFeature
import androidx.window.testing.layout.TestWindowLayoutInfo
import androidx.window.testing.layout.WindowLayoutInfoPublisherRule

@RunWith(AndroidJUnit4::class)
class MediaControlsFoldingFeatureTest {

    @get:Rule(order=1)
    val composeTestRule = createAndroidComposeRule<ComponentActivity>()

    @get:Rule(order=2)
    val windowLayoutInfoPublisherRule = WindowLayoutInfoPublisherRule()

    @Test
    fun foldedWithHinge_foldableUiDisplayed() {
        composeTestRule.setContent {
            MediaPlayerScreen()
        }

        val hinge = FoldingFeature(
            activity = composeTestRule.activity,
            state = HALF_OPENED,
            orientation = VERTICAL,
            size = 2
        )

        val expected = TestWindowLayoutInfo(listOf(hinge))
        windowLayoutInfoPublisherRule.overrideWindowLayoutInfo(expected)

        composeTestRule.waitForIdle()

        // Verify that the folding feature is detected and media controls shown.
        composeTestRule.onNodeWithTag("MEDIA_CONTROLS").assertExists()
    }
}

Vistas

import androidx.window.layout.FoldingFeature.Orientation
import androidx.window.layout.FoldingFeature.State
import androidx.window.testing.layout.FoldingFeature
import androidx.window.testing.layout.TestWindowLayoutInfo
import androidx.window.testing.layout.WindowLayoutInfoPublisherRule

@RunWith(AndroidJUnit4::class)
class MediaControlsFoldingFeatureTest {

    @get:Rule(order=1)
    val activityRule = ActivityScenarioRule(MediaPlayerActivity::class.java)

    @get:Rule(order=2)
    val windowLayoutInfoPublisherRule = WindowLayoutInfoPublisherRule()

    @Test
    fun foldedWithHinge_foldableUiDisplayed() {
        activityRule.scenario.onActivity { activity ->
            val feature = FoldingFeature(
                activity = activity,
                state = State.HALF_OPENED,
                orientation = Orientation.VERTICAL)
            val expected = TestWindowLayoutInfo(listOf(feature))
            windowLayoutInfoPublisherRule.overrideWindowLayoutInfo(expected)
        }

        // Verify that the folding feature is detected and media controls shown.
        onView(withId(R.id.media_controls)).check(matches(isDisplayed()))
    }
}

Puedes encontrar más muestras en el proyecto WindowManager.

Recursos adicionales

Documentación

Ejemplos

Codelabs