Librerie e strumenti per testare diverse dimensioni dello schermo

Android offre una varietà di strumenti e API che consentono di creare test per schermi e finestre di dimensioni diverse.

Override configurazione dispositivo

L'elemento componibile DeviceConfigurationOverride ti consente di eseguire l'override degli attributi di configurazione per testare diverse dimensioni di schermo e finestra nei layout di Compose. L'override di ForcedSize si adatta a qualsiasi layout nello spazio disponibile, consentendoti di eseguire qualsiasi test UI su qualsiasi dimensione dello schermo. Ad esempio, puoi utilizzare un fattore di forma di smartphone di piccole dimensioni per eseguire tutti i test dell'interfaccia utente, inclusi quelli relativi a telefoni di grandi dimensioni, pieghevoli e tablet.

   DeviceConfigurationOverride(
        DeviceConfigurationOverride.ForcedSize(DpSize(1280.dp, 800.dp))
    ) {
        MyScreen() // Will be rendered in the space for 1280dp by 800dp without clipping.
    }
Figura 1. Utilizzo di DeviceConfigurationOverride per adattarsi a un layout di tablet all'interno di un dispositivo con fattore di forma più piccolo, come in \*Ora su Android*.

Inoltre, puoi utilizzare questo componibile per impostare la scala del carattere, i temi e altre proprietà che potresti voler testare su dimensioni di finestre diverse.

Robolettrico

Utilizza Robolectric per eseguire Compose o test dell'interfaccia utente basati sulle visualizzazioni sulla JVM localmente, senza bisogno di dispositivi o emulatori. Puoi configurare Robolectric in modo che utilizzi dimensioni dello schermo specifiche, tra le altre proprietà utili.

Nel seguente esempio di Now in Android, Robolectric è configurato per emulare una dimensione dello schermo di 1000 x 1000 dp con una risoluzione di 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 { ... }

Puoi anche impostare i qualificatori dal corpo del test come in questo snippet dall'esempio Now in Android:

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

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

Tieni presente che RuntimeEnvironment.setQualifiers() aggiorna le risorse di sistema e delle applicazioni con la nuova configurazione, ma non attiva alcuna azione su attività attive o altri componenti.

Per saperne di più, consulta la documentazione sulla configurazione del dispositivo Robolectric.

Dispositivi gestiti da Gradle

Il plug-in Android Gradle per i dispositivi gestiti da Gradle (GMD) consente di definire le specifiche degli emulatori e dei dispositivi reali su cui vengono eseguiti i test strumentati. Crea le specifiche per i dispositivi con schermi di dimensioni diverse al fine di implementare una strategia di test in cui determinati test devono essere eseguiti su schermi di determinate dimensioni. Utilizzando GMD con integrazione continua (CI), puoi assicurarti che vengano eseguiti i test appropriati quando richiesto, eseguendo il provisioning e avviando gli emulatori e semplificando la configurazione di 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"
                }
            }
        }
    }
}

Puoi trovare diversi esempi di GMD nel progetto testing-samples.

Firebase Test Lab

Utilizza Firebase Test Lab (FTL) o un servizio di device farm simile per eseguire i test su dispositivi reali specifici a cui potresti non avere accesso, ad esempio pieghevoli o tablet di varie dimensioni. Firebase Test Lab è un servizio a pagamento con un livello senza costi. FTL supporta anche l'esecuzione di test sugli emulatori. Questi servizi migliorano l'affidabilità e la velocità dei test instrumentati perché possono eseguire in anticipo il provisioning di dispositivi ed emulatori.

Per informazioni sull'utilizzo di FTL con GMD, consulta Scalare i test con i dispositivi gestiti da Gradle.

Applica il filtro di test con l'esecutore del test

Una strategia di test ottimale non dovrebbe verificare la stessa cosa due volte, quindi la maggior parte dei test UI non deve essere eseguita su più dispositivi. In genere, i test dell'interfaccia utente vengono filtrati eseguendoli tutti o la maggior parte su un fattore di forma di uno smartphone e solo un sottoinsieme su dispositivi con schermi di dimensioni diverse.

Puoi annotare determinati test in modo che vengano eseguiti solo con determinati dispositivi e poi passare un argomento all'unità AndroidJUnitRunner utilizzando il comando che esegue i test.

Ad esempio, puoi creare annotazioni diverse:

annotation class TestExpandedWidth
annotation class TestCompactWidth

Usali in diversi test:

class MyTestClass {

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

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

}

Potrai quindi utilizzare la proprietà android.testInstrumentationRunnerArguments.annotation durante i test per filtrare quelli specifici. Ad esempio, se utilizzi dispositivi gestiti da Gradle:

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

Se non utilizzi GMD e gestisci gli emulatori su CI, assicurati prima che l'emulatore o il dispositivo corretti siano pronti e connessi, quindi passa il parametro a uno dei comandi Gradle per eseguire test instrumentati:

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

Tieni presente che il dispositivo Espresso (vedi la prossima sezione) può anche filtrare i test utilizzando le proprietà del dispositivo.

Dispositivo per caffè espresso

Utilizza Dispositivo Espresso per eseguire azioni sugli emulatori nei test utilizzando qualsiasi tipo di test con strumenti, tra cui test di Espresso, Compose o di UI Automator. Queste azioni potrebbero includere l'impostazione delle dimensioni dello schermo o l'attivazione/disattivazione di stati o posture pieghevoli. Ad esempio, puoi controllare un emulatore pieghevole e impostarlo in modalità da tavolo. Il dispositivo Espresso contiene anche regole JUnit e annotazioni necessarie per richiedere determinate funzionalità:

@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()))
    }
}

Tieni presente che il dispositivo Espresso è ancora in fase alpha e presenta i seguenti requisiti:

  • Plug-in Android Gradle 8.3 o versioni successive
  • Emulatore Android 33.1.10 o versioni successive
  • Dispositivo virtuale Android con livello API 24 o successivo

Filtra test

Il dispositivo Espresso può leggere le proprietà dei dispositivi connessi per consentirti di filtrare i test utilizzando le annotazioni. Se i requisiti annotati non vengono soddisfatti, i test vengono ignorati.

Annotazione Richiede DeviceMode

L'annotazione RequiresDeviceMode può essere utilizzata più volte per indicare un test che verrà eseguito solo se tutti i valori DeviceMode sono supportati sul dispositivo.

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()))
    }
}

Annotazione Richiedi Display

L'annotazione RequiresDisplay ti consente di specificare la larghezza e l'altezza dello schermo del dispositivo utilizzando le classi di dimensioni, che definiscono i bucket di dimensioni in base alle classi di dimensioni delle finestre ufficiali.

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

Ridimensiona i display

Utilizza il metodo setDisplaySize() per ridimensionare le dimensioni dello schermo in fase di runtime. Utilizza il metodo in combinazione con la classe DisplaySizeRule, per assicurarti che tutte le modifiche apportate durante i test vengano annullate prima del test successivo.

@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.
    }
}

Il ridimensionamento di un display con setDisplaySize() non influisce sulla densità del dispositivo; pertanto, se una dimensione non rientra nel dispositivo target, il test non va a buon fine con UnsupportedDeviceOperationException. Per impedire l'esecuzione di test in questo caso, utilizza l'annotazione RequiresDisplay per filtrarli:

@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.
    }
}

Tester del ripristino dello stato

La classe StateRestorationTester viene utilizzata per testare il ripristino dello stato per i componenti componibili senza ricreare le attività. Ciò rende i test più veloci e più affidabili, poiché la ricreazione dell'attività è un processo complesso con più meccanismi di sincronizzazione:

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

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

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

Libreria per i test delle finestre

La libreria Window Testing contiene utilità che ti aiutano a scrivere test che si basano su o verificano le funzionalità relative alla gestione delle finestre, come l'incorporamento delle attività o le caratteristiche pieghevoli. L'elemento è disponibile tramite il repository Maven di Google.

Ad esempio, puoi utilizzare la funzione FoldingFeature() per generare un elemento FoldingFeature personalizzato, che puoi utilizzare nelle anteprime di Compose. In Java, utilizza la funzione createFoldingFeature().

In un'anteprima di Compose, potresti implementare FoldingFeature nel seguente modo:

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

Inoltre, puoi emulare le funzionalità del display nei test della UI utilizzando la funzione TestWindowLayoutInfo(). L'esempio seguente simula un elemento FoldingFeature con una cerniera verticale di HALF_OPENED al centro dello schermo, quindi verifica se il layout è quello previsto:

Scrittura

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()
    }
}

Visualizzazioni

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()))
    }
}

Puoi trovare altri esempi nel progetto WindowsManager.

Risorse aggiuntive

Documentazione

Campioni

Codelab