UI Automator 测试多个应用的界面

r囧r小猫 2023-10-11 12:44 45阅读 0赞

## 测试多个应用的界面 ##

> 通过涉及多个应用程序中用户交互的用户界面`（UI）`测试，您可以验证当用户流跨入其他应用程序或进入系统`UI`时，您的应用程序的行为是否正确。  
> 这种用户流程的一个示例是消息传递应用程序，该应用程序允许用户输入文本消息,启动Android联系人选择器，以便用户可以选择收件人以将邮件发送到  
> 然后将控制权返回给原始应用，以供用户提交消息。

本课介绍如何使用`AndroidX Test`提供的`UI Automator`测试框架编写此类`UI`测试。`UI Automator API`使您可以与设备上的可见元素进行交互,无论关注哪个`Activity`  
您的测试可以使用方便的描述符（例如，该组件中显示的文本或其内容描述）来查找`UI`组件。`UI Automator`测试可以在运行`Android 4.3`（API级别18）或更高版本的设备上运行。

`UI Automator`测试框架是基于工具的`API`，可与`AndroidJUnitRunner`测试运行器一起使用。

在使用`UI Automator`构建UI测试之前，请确保按照配置AndroidX测试项目中所述配置测试源代码的位置和项目依赖项。[详细配置][Link 1]

### 添加依赖 ###

dependencies {
        ...
        androidTestImplementation 'androidx.test.uiautomator:uiautomator:2.2.0'
    }

为了优化`UI Automator`测试，您应该首先检查目标应用的`UI`组件，并确保它们可访问。这些优化技巧将在接下来的两节中介绍

### 检查设备上的用户界面: ###

在设计测试之前,检查设备上可见的UI组件。为了确保您的`UI Automator`测试可以访问这些组件，检查这些组件是否具有可见的文本标签，`android：contentDescription`值，或两者皆有

`uiautomatorviewer`工具提供了方便的可视界面，用于检查布局层次结构并查看在设备前景上可见的UI组件的属性。此信息使您可以使用UI `Automator`创建更细粒度的测试。例如，您可以创建与特定可见属性匹配的UI选择器。

启动可视化工具`uiautomatorviewer`  
\- 在物理设备上启动目标应用  
\- 将设备连接到开发机器。  
\- 打开一个终端窗口，然后导航到`<android-sdk> / tools /`目录。文件目录在 `<android-sdk>/tools/bin`，譬如我的是在：C:\\Users\\username\\AppData\\Local\\Android\\Sdk\\tools\\bin  
\- 使用此命令运行工具: `uiautomatorviewer`

查看应用程序的UI属性:  
\- 点击 `Device Screenshot` 按钮.  
\- 将鼠标悬停在左侧面板中的快照上，以查看`uiautomatorviewer`工具标识的UI组件。这些属性在右下方的面板中列出，布局层次结构在右上方的面板中。  
\- （可选）单击“切换`NAF`节点”按钮以查看`UI Automator`无法访问的UI组件。这些组件可能仅提供有限的信息

### 确保您的活动是可访问的： ###

`UI Automator`测试框架在已实现`Android`无障碍功能的应用程序上表现更好，当您使用`View`类型的`UI`元素或`SDK`中`View`的子类时，您无需实现可访问性支持，因为这些类已经为您完成了此工作。

但是，某些应用程序使用自定义`UI`元素来提供更丰富的用户体验。  
此类元素将不提供自动辅助功能支持。如果您的应用程序包含不是`SDK`的`View`子类的实例，请确保通过完成以下步骤为这些元素添加辅助功能：

*  创建一个继承自`ExploreByTouchHelper`的具体类
 *  通过调用`setAccessibilityDelegate（）`将新类的实例与特定的自定义`UI`元素相关联。

### 创建一个UI Automator测试类 ###

`UI Automator`测试类的编写方式应与`JUnit 4`测试类的编写方式相同。要了解有关创建`JUnit 4`测试类以及使用`JUnit 4`断言和注释的更多信息,[请点击][Link 2]

在测试类定义的开头添加`@RunWith（AndroidJUnit4.class）`注解。您还需要指定`AndroidX Test`中提供的`AndroidJUnitRunner`类作为默认的测试运行器。在设备或仿真器上的Run UI Automator测试中将更详细地描述此步骤。

在`UI Automator`测试类中实现以下编程模型：

*  通过调用`getInstance（）`方法并将其传递给`Instrumentation`对象作为参数，从而获取`UiDevice`对象以访问要测试的设备。
 *  通过调用`findObject（）`方法，获取一个`UiObject`对象以访问设备上显示的UI组件（例如，前景中的当前视图）。
 *  通过调用`UiObject`方法，模拟特定的用户交互以在该UI组件上执行；例如，调用`performMultiPointerGesture（）`以模拟多点触摸手势，并调用`setText（）`来编辑文本字段。您可以根据需要重复在步骤2和3中调用API，以测试涉及多个UI组件或一系列用户操作的更复杂的用户交互。
 *  在执行这些用户交互之后，检查UI是否反映了预期的状态或行为。

### 访问UI组件 ###

`UiDevice`对象是访问和操纵设备状态的主要方式。在测试中，您可以调用`UiDevice`方法来检查各种属性的状态，  
例如当前方向或显示大小。您的测试可以使用`UiDevice`对象执行设备级别的操作，例如将设备强制旋转，按`D-pad`硬件按钮以及按`Home`和`Menu`按钮。

从设备的主屏幕开始测试是一种很好的做法。在主屏幕（或您在设备中选择的其他起始位置）上，您可以调用UI Automator API提供的方法来选择特定的UI元素并与之交互。

以下代码段显示了您的测试如何获取`UiDevice`实例并模拟按下`Home`按钮的方式：

import org.junit.Before
    import androidx.test.runner.AndroidJUnit4
    import androidx.test.uiautomator.UiDevice
    import androidx.test.uiautomator.By
    import androidx.test.uiautomator.Until
    ...
    
    private const val BASIC_SAMPLE_PACKAGE = "com.example.android.testing.uiautomator.BasicSample"
    private const val LAUNCH_TIMEOUT = 5000L
    private const val STRING_TO_BE_TYPED = "UiAutomator"
    
    @RunWith(AndroidJUnit4::class)
    @SdkSuppress(minSdkVersion = 18)
    class ChangeTextBehaviorTest2 {
    
        private lateinit var device: UiDevice
    
        @Before
        fun startMainActivityFromHomeScreen() {
            // Initialize UiDevice instance
            device = UiDevice.getInstance(InstrumentationRegistry.getInstrumentation())
    
            // Start from the home screen
            device.pressHome()
    
            // Wait for launcher
            val launcherPackage: String = device.launcherPackageName
            assertThat(launcherPackage, notNullValue())
            device.wait(
                    Until.hasObject(By.pkg(launcherPackage).depth(0)),
                    LAUNCH_TIMEOUT
            )
    
            // Launch the app
            val context = ApplicationProvider.getApplicationContext<Context>()
            val intent = context.packageManager.getLaunchIntentForPackage(
                    BASIC_SAMPLE_PACKAGE).apply {
                // Clear out any previous instances
                addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK)
            }
            context.startActivity(intent)
    
            // Wait for the app to appear
            device.wait(
                    Until.hasObject(By.pkg(BASIC_SAMPLE_PACKAGE).depth(0)),
                    LAUNCH_TIMEOUT
            )
        }
    
    }

在示例中，`@ SdkSuppress（minSdkVersion = 18）`语句有助于确保测试仅在`UI Automator`框架要求的情况下才能在具有`Android 4.3`（API级别18）或更高版本的设备上运行。

使用`findObject（）`方法检索`UiObject`，该`UiObject`表示与给定选择器条件匹配的视图。  
您可以根据需要重复使用在应用程序测试的其他部分中创建的`UiObject`实例。  
请注意，每次您的测试使用`UiObject`实例单击UI元素或查询属性时，`UI Automator`测试框架都会在当前显示中搜索匹配项。

以下代码段显示了您的测试如何构建代表应用程序中“取消”按钮和“确定”按钮的`UiObject`实例。

val cancelButton: UiObject = device.findObject(
            UiSelector().text("Cancel").className("android.widget.Button")
    )
    val okButton: UiObject = device.findObject(
            UiSelector().text("OK").className("android.widget.Button")
    )
    
    // Simulate a user-click on the OK button, if found.
    if (okButton.exists() && okButton.isEnabled) {
        okButton.click()
    }

#### 指定选择器 ####

如果要访问应用程序中的特定UI组件，使用`UiSelector`类。此类表示对当前显示的UI中特定元素的查询。

如果找到多个匹配元素，则将布局层次结构中的第一个匹配元素作为目标`UiObject`返回。  
构造`UiSelector`时，可以将多个属性链接在一起以优化搜索。如果找不到匹配的UI元素，则引发`UiAutomatorObjectNotFoundException`。

您可以使用`childSelector（）`方法来嵌套多个`UiSelector`实例。  
例如，下面的代码示例演示您的测试如何指定搜索以在当前显示的UI中找到第一个`ListView`，然后在该`ListView`中进行搜索以找到带有文本属性`Apps`的UI元素。

val appItem: UiObject = device.findObject(
            UiSelector().className("android.widget.ListView")
                    .instance(0)
                    .childSelector(
                            UiSelector().text("Apps")
                    )
    )

作为最佳做法，指定选择器时，应使用资源ID（如果已将其分配给UI元素）而不是文本元素或内容描述符。  
并非所有元素都有文本元素（例如，工具栏中的图标）。文本选择器很脆弱，如果对UI进行很小的更改，可能会导致测试失败。  
它们也可能无法跨不同的语言扩展；您的文本选择器可能不匹配翻译后的字符串。

在选择器条件中指定对象状态可能很有用。  
例如，如果要选择所有选中元素的列表，以便可以取消选中它们，请在参数设置为true的情况下调用`checked（）`方法。

### 执行动作 ###

一旦测试获得了`UiObject`对象，就可以调用`UiObject`类中的方法以在由该对象表示的UI组件上执行用户交互。您可以指定以下操作：

*  `click（）`：单击UI元素可见边界的中心。
 *  `dragTo（）`：将此对象拖动到任意坐标。
 *  `setText（）`：清除字段内容后，在可编辑字段中设置文本。相反，`clearTextField（）`方法清除可编辑字段中的现有文本。
 *  `swipeUp（）`：在`UiObject`上执行向上滑动操作。同样，`swipeDown（），swipeLeft（）和swipeRight（）`方法执行相应的操作。

`UI Automator`测试框架允许您通过`getContext（）`获取`Context`对象，而无需使用外壳命令来发送`Intent`或启动`Activity`。

以下代码段显示了您的测试如何使用Intent启动被测试的应用。当您只想测试计算器应用程序而不必关心启动器时，此方法很有用。

fun setUp() {
        ...
    
        // Launch a simple calculator app
        val context = getInstrumentation().context
        val intent = context.packageManager.getLaunchIntentForPackage(CALC_PACKAGE).apply {
            addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK)
        }
        // Clear out any previous instances
        context.startActivity(intent)
        device.wait(Until.hasObject(By.pkg(CALC_PACKAGE).depth(0)), TIMEOUT)
    }

### 对集合执行操作 ###

如果要模拟用户对一系列项目（例如，音乐专辑中的歌曲或收件箱中的电子邮件列表）的交互，  
请使用`UiCollection`类。要创建`UiCollection`对象，请指定一个`UiSelector`来搜索UI容器或其他子UI元素的包装，例如包含子UI元素的布局视图。

以下代码段显示了您的测试如何构建一个`UiCollection`来表示在`FrameLayout`中显示的视频专辑：

val videos = UiCollection(UiSelector().className("android.widget.FrameLayout"))
    
    // Retrieve the number of videos in this collection:
    val count = videos.getChildCount(
            UiSelector().className("android.widget.LinearLayout")
    )
    
    // Find a specific video and simulate a user-click on it
    val video: UiObject = videos.getChildByText(
            UiSelector().className("android.widget.LinearLayout"),
            "Cute Baby Laughing"
    )
    video.click()
    
    // Simulate selecting a checkbox that is associated with the video
    val checkBox: UiObject = video.getChild(
            UiSelector().className("android.widget.Checkbox")
    )
    if (!checkBox.isSelected) checkBox.click()

### 对滚动视图执行操作 ###

使用`UiScrollable`类模拟整个显示的垂直或水平滚动。当UI元素位于屏幕外并且需要滚动以使其可见时，此技术很有用。

以下代码段显示了如何模拟向下滚动“设置”菜单并单击“关于数位板”选项：

val settingsItem = UiScrollable(UiSelector().className("android.widget.ListView"))
    val about: UiObject = settingsItem.getChildByText(
            UiSelector().className("android.widget.LinearLayout"),
            "About tablet"
    )
    about.click()

### 验证结果 ###

`InstrumentationTestCase`扩展了`TestCase`，因此您可以使用标准的`JUnit Assert`方法来测试应用程序中的UI组件是否返回了预期的结果。  
以下代码段显示了测试如何在计算器应用中找到多个按钮，依次单击它们，然后验证是否显示了正确的结果。

private const val CALC_PACKAGE = "com.myexample.calc"
    
    fun testTwoPlusThreeEqualsFive() {
        // Enter an equation: 2 + 3 = ?
        device.findObject(UiSelector().packageName(CALC_PACKAGE).resourceId("two")).click()
        device.findObject(UiSelector().packageName(CALC_PACKAGE).resourceId("plus")).click()
        device.findObject(UiSelector().packageName(CALC_PACKAGE).resourceId("three")).click()
        device.findObject(UiSelector().packageName(CALC_PACKAGE).resourceId("equals")).click()
    
        // Verify the result = 5
        val result: UiObject2 = device.findObject(By.res(CALC_PACKAGE, "result"))
        assertEquals("5", result.text)
    }

[Link 1]: https://developer.android.google.cn/training/testing/set-up-project
[Link 2]: https://developer.android.google.cn/training/testing/unit-testing/instrumented-unit-tests.html#build