使用 Espresso Device API 测试屏幕配置更改

当设备发生常见配置更改（例如旋转和屏幕展开）时，使用 Espresso Device API 测试应用。Espresso Device API 是推荐的工具，可用于模拟设备级操作以及 Jetpack Compose 测试规则。如果您不熟悉如何为 Jetpack Compose 编写界面测试 ，请参阅测试 Compose 布局。

Espresso Device API 可让您在虚拟设备上模拟配置更改并同步执行测试，因此一次只会发生一个界面操作或断言，并且测试结果会更可靠。如果您不熟悉如何使用 Espresso 编写界面 测试，请参阅其文档。

如需使用 Espresso Device API，您需要满足以下条件：

  • Android Studio Iguana 或更高版本
  • Android Gradle 插件 8.3 或更高版本
  • Android 模拟器 33.1.10 或更高版本
  • 运行 API 级别 24 或更高版本的 Android 虚拟设备

为 Espresso Device API 设置项目

如需设置项目以使其支持 Espresso Device API，请执行以下操作：

  1. 如需让测试将命令传递给测试设备，请将 INTERNET 和 ACCESS_NETWORK_STATE 权限添加到 androidTest 源代码集中的清单文件：

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

  2. 在 gradle.properties 文件中启用 enableEmulatorControl 实验性标志：

      android.experimental.androidTest.enableEmulatorControl=true

  3. 在模块级 build 脚本中启用 emulatorControl 选项：

    Kotlin

      testOptions {
    emulatorControl {
      enable = true
    }
  }

    Groovy

      testOptions {
    emulatorControl {
      enable = true
    }
  }

  4. 在模块级 build 脚本中，将 Espresso Device 库导入到您的项目：

    Kotlin

    dependencies {
  androidTestImplementation("androidx.test.espresso:espresso-device:1.0.1")
}

    Groovy

    dependencies {
  androidTestImplementation 'androidx.test.espresso:espresso-device:1.0.1'
}

针对常见配置更改进行测试

Espresso Device API 具有多种屏幕方向和可折叠状态，可用于模拟设备配置更改。以下示例展示了如何触发这些设备状态，以及如何使用 Compose 测试规则验证由此产生的界面更改。

针对屏幕旋转进行测试

以下示例展示了如何测试设备屏幕旋转时应用会发生什么情况：

  1. 首先，定义 Compose 测试规则，并将设备设置为一致的初始状态（例如纵向模式）：

    import androidx.compose.ui.test.assertIsDisplayed
import androidx.compose.ui.test.assertDoesNotExist
import androidx.compose.ui.test.junit4.createComposeRule
import androidx.compose.ui.test.onNodeWithTag
import androidx.test.espresso.device.EspressoDevice.onDevice
import androidx.test.espresso.device.action.ScreenOrientation
import androidx.test.espresso.device.rules.ScreenOrientationRule
import org.junit.Rule
import org.junit.Test

class MyConfigurationTest {

    // 1. Define the Compose test rule
    @get:Rule
    val composeTestRule = createComposeRule()

    // 2. Define the Espresso Device rule for a consistent starting state
    @get:Rule
    val screenOrientationRule = ScreenOrientationRule(ScreenOrientation.PORTRAIT)
}

  2. 创建一个测试，该测试会在测试作业期间将设备设置为横向屏幕方向：

    @Test
fun myRotationTest() {
  ...
  // Sets the device to landscape orientation during test execution.
  onDevice().setScreenOrientation(ScreenOrientation.LANDSCAPE)
  ...
}

  3. 屏幕旋转后，使用 composeTestRule 检查可组合项是否按预期适应新状态。

    @Test
fun myRotationTest() {
  ...
  // Sets the device to landscape orientation during test execution.
  onDevice().setScreenOrientation(ScreenOrientation.LANDSCAPE)
  composeTestRule.onNodeWithTag("NavRail").assertIsDisplayed()
  composeTestRule.onNodeWithTag("BottomBar").assertDoesNotExist()
}

针对屏幕展开进行测试

以下示例展示了如何测试当应用在可折叠设备上且屏幕展开时会发生什么情况：

  1. 首先，通过调用 onDevice().setClosedMode() 在设备处于折叠状态时进行测试。确保可组合项适应紧凑型屏幕宽度。

    @Test
fun myUnfoldedTest() {
  onDevice().setClosedMode()
  composeTestRule.onNodeWithTag("BottomBar").assertIsDisplayed()
  composeTestRule.onNodeWithTag("NavRail").assertDoesNotExist()
  ...
}

  2. 如需转换为完全展开状态，请调用 onDevice().setFlatMode()。检查可组合项是否适应展开型大小类别。

    @Test
fun myUnfoldedTest() {
  onDevice().setClosedMode()
  ...
  onDevice().setFlatMode()
  composeTestRule.onNodeWithTag("NavRail").assertIsDisplayed()
  composeTestRule.onNodeWithTag("BottomBar").assertDoesNotExist()
}

指定测试所需的设备

如果您在不可折叠的设备上运行执行折叠操作的测试，则测试可能会失败。如需仅执行与正在运行的设备相关的测试，请使用 @RequiresDeviceMode 注解。测试运行程序会自动跳过在不支持被测配置的设备上运行测试。您可以将设备要求规则添加到每个测试或整个测试类。

例如，如需指定测试应仅在支持展开为平面配置的设备上运行，请将以下 @RequiresDeviceMode 代码添加到测试中：

@Test
@RequiresDeviceMode(mode = FLAT)
fun myUnfoldedTest() {
  ...
}