Вы можете протестировать приложение Compose, используя хорошо зарекомендовавшие себя подходы и шаблоны.
Тестируйте по отдельности
ComposeTestRule позволяет запустить действие, показывающее любую composable-функцию: все приложение, один экран или небольшой элемент. Также рекомендуется убедиться, что ваши composable-функции правильно инкапсулированы и работают независимо, что упрощает и делает более целенаправленным тестирование пользовательского интерфейса.
Это не значит, что нужно создавать только модульные тесты интерфейса. Тесты пользовательского интерфейса, охватывающие большие части вашего пользовательского интерфейса, также очень важны.
Доступ к заданию и ресурсам после настройки собственного контента
Часто вам нужно задать тестируемый контент с помощью composeTestRule.setContent, а также получить доступ к ресурсам действия, например чтобы убедиться, что отображаемый текст соответствует строковому ресурсу. Однако вы не можете вызвать setContent для правила, созданного с помощью createAndroidComposeRule(), если действие уже вызывает его.
Для этого обычно создают AndroidComposeTestRule с помощью пустого действия, например ComponentActivity.
class MyComposeTest { @get:Rule val composeTestRule = createAndroidComposeRule<ComponentActivity>() @Test fun myTest() { // Start the app. composeTestRule.setContent { MyAppTheme { MainScreen(uiState = exampleUiState, /*...*/) } } val continueLabel = composeTestRule.activity.getString(R.string.next) composeTestRule.onNodeWithText(continueLabel).performClick() } }
Обратите внимание, что в файл AndroidManifest.xml приложения нужно добавить ComponentActivity. Чтобы включить ее, добавьте в модуль следующую зависимость:
debugImplementation("androidx.compose.ui:ui-test-manifest:$compose_version")
Свойства пользовательской семантики
Вы можете создать собственные свойства семантики, чтобы предоставлять информацию для тестов.
Для этого определите новый SemanticsPropertyKey и сделайте его доступным с помощью SemanticsPropertyReceiver.
// Creates a semantics property of type Long. val PickedDateKey = SemanticsPropertyKey<Long>("PickedDate") var SemanticsPropertyReceiver.pickedDate by PickedDateKey
Теперь используйте это свойство в модификаторе semantics:
val datePickerValue by remember { mutableStateOf(0L) } MyCustomDatePicker( modifier = Modifier.semantics { pickedDate = datePickerValue } )
В тестах используйте SemanticsMatcher.expectValue, чтобы подтвердить значение свойства:
composeTestRule .onNode(SemanticsMatcher.expectValue(PickedDateKey, 1445378400)) // 2015-10-21 .assertExists()
Проверка восстановления состояния
Убедитесь, что состояние элементов Compose правильно восстанавливается при повторном создании действия или процесса. Выполняйте такие проверки, не полагаясь на воссоздание действий с помощью класса StateRestorationTester.
Этот класс позволяет симулировать повторное создание composable-функции. Это особенно полезно для проверки реализации rememberSaveable.
class MyStateRestorationTests { @get:Rule val composeTestRule = createComposeRule() @Test fun onRecreation_stateIsRestored() { val restorationTester = StateRestorationTester(composeTestRule) restorationTester.setContent { MainScreen() } // TODO: Run actions that modify the state // Trigger a recreation. restorationTester.emulateSavedInstanceStateRestore() // TODO: Verify that state has been correctly restored. } }
Тестирование разных конфигураций устройств
Приложения для Android должны адаптироваться к различным условиям: размерам окон, региональным настройкам, размерам шрифтов, тёмным и светлым темам и т. д. Большинство этих условий основаны на значениях, заданных пользователем на уровне устройства и доступных в текущем экземпляре Configuration. Тестирование различных конфигураций непосредственно в тесте затруднено, поскольку тест должен настраивать свойства на уровне устройства.
DeviceConfigurationOverride – это API, предназначенный только для тестирования. Он позволяет локально симулировать различные конфигурации устройств для тестируемого контента @Composable.
Объект-компаньон DeviceConfigurationOverride имеет следующие функции расширения, которые переопределяют свойства конфигурации на уровне устройства:
DeviceConfigurationOverride.DarkMode()– переопределяет системную тему на тёмную или светлую.DeviceConfigurationOverride.FontScale()– переопределяет системный масштаб шрифта.DeviceConfigurationOverride.FontWeightAdjustment()– переопределяет системную настройку насыщенности шрифта.DeviceConfigurationOverride.ForcedSize()– задает определенный размер пространства независимо от размера устройства.DeviceConfigurationOverride.LayoutDirection()– переопределяет направление макета (слева направо или справа налево).DeviceConfigurationOverride.Locales()– переопределяет региональные настройки.DeviceConfigurationOverride.RoundScreen()– переопределяет, является ли экран круглым.
Чтобы применить определенное переопределение, оберните тестируемый контент в вызов функции верхнего уровня DeviceConfigurationOverride(), передав переопределение в качестве параметра.
Например, в следующем коде применяется переопределение DeviceConfigurationOverride.ForcedSize(), чтобы изменить плотность локально и принудительно отобразить composable-функцию MyScreen в большом горизонтальном окне, даже если устройство, на котором выполняется тест, не поддерживает этот размер окна напрямую:
composeTestRule.setContent { DeviceConfigurationOverride( DeviceConfigurationOverride.ForcedSize(DpSize(1280.dp, 800.dp)) ) { MyScreen() // Will be rendered in the space for 1280dp by 800dp without clipping. } }
Чтобы применить несколько переопределений одновременно, используйте DeviceConfigurationOverride.then():
composeTestRule.setContent { DeviceConfigurationOverride( DeviceConfigurationOverride.FontScale(1.5f) then DeviceConfigurationOverride.FontWeightAdjustment(200) ) { Text(text = "text with increased scale and weight") } }
Специальная обработка сбоев в тестах
Отладка тестов пользовательского интерфейса часто требует проверки состояния экрана и иерархии композиции при сбое утверждения.
Compose предоставляет встроенный конвейер обработки сбоев для упрощения диагностики. Вы можете автоматически делать скриншоты и фиксировать иерархии интерфейса при сбоях или зарегистрировать специальные обработчики, чтобы передавать телеметрию сбоев во внешние инструменты.
Настройте обработку сбоев
Чтобы настроить обработку сбоев, передайте объект TestFailurePolicy в ComposeUiTestConfig.
Как собирать встроенные артефакты сбоев
Чтобы при сбое тестирования создавались скриншоты и иерархии интерфейса, задайте свойства screenshotCaptureMode и uiHierarchyCaptureMode в файле TestFailurePolicy.
class MyComposeTest { private val customConfig = ComposeUiTestConfig( failurePolicy = TestFailurePolicy( screenshotCaptureMode = TestFailurePolicy.CaptureMode.Enabled, uiHierarchyCaptureMode = TestFailurePolicy.CaptureMode.Enabled ) ) @Test fun myFirstTest() = runComposeUiTest(config = customConfig) { // ... } }
Используйте собственный обработчик ошибок
Чтобы задать пользовательское поведение при сбоях тестирования, добавьте TestFailureHandler в список failureHandlers. Каждый обработчик получает объект FailureContext, который содержит исходную ошибку и список артефактов, созданных предыдущими обработчиками конвейера.
class MyComposeTestWithHandler { private val customConfig = ComposeUiTestConfig( failurePolicy = TestFailurePolicy( screenshotCaptureMode = TestFailurePolicy.CaptureMode.Enabled, failureHandlers = listOf( TestFailureHandler { context -> val screenshot = context.artifacts.firstOrNull { it.type == FailureArtifact.Type.Screenshot } // ... } ) ) ) @get:Rule val rule = createComposeRule(config = customConfig) // ... }
Как настроить запись для всего набора тестов
Вы можете включить сохранение артефактов сбоев для всего набора тестов, передав аргументы средства запуска инструментирования в файле build.gradle модуля. Это устраняет необходимость обновлять отдельные тестовые файлы.
// build.gradle.kts
android {
defaultConfig {
// ...
testInstrumentationRunnerArguments["androidx.compose.ui.test.failure.isUiHierarchyCaptureEnabled"] = "true"
testInstrumentationRunnerArguments["androidx.compose.ui.test.failure.isScreenshotCaptureEnabled"] = "true"
}
}
Приоритет конфигураций
Фреймворк оценивает как локальные аргументы TestFailurePolicy, так и аргументы на уровне набора:
- Если вы явно зададите режим
CaptureMode.Enabled/Disabledв тестовом файлеfailurePolicy, это переопределит аргумент средства запуска. - Если вы зададите для режима значение
CaptureMode.Unspecified(или оставите дляfailurePolicyзначениеnull), фреймворк вернется к аргументу runner.
Дополнительные ресурсы
- Тестирование приложений для Android. Основная целевая страница, на которой можно найти общую информацию об основах и методах тестирования.
- Основы тестирования. Узнайте больше об основных концепциях тестирования приложений для Android.
- Локальные тесты. Некоторые тесты можно запускать локально на рабочей станции.
- Инструментальные тесты. Рекомендуем также проводить инструментальные тесты. То есть тесты, которые запускаются непосредственно на устройстве.
- Непрерывная интеграция. Непрерывная интеграция позволяет интегрировать тесты в конвейер развертывания.
- Протестируйте разные размеры экрана. Поскольку пользователи могут заходить на ваш сайт с самых разных устройств, необходимо проверить, как он выглядит на экранах разных размеров.
- Espresso. Хотя этот фреймворк предназначен для интерфейсов на основе View, он может быть полезен для некоторых аспектов тестирования Compose.