Espresso 基础知识

本文档介绍了如何使用 Espresso API 完成常见的自动化测试任务。

Espresso API 鼓励测试作者从用户与应用互动时可能执行的操作(查找界面元素并与之互动)的角度进行思考。同时,该框架会阻止直接访问应用的 activity 和视图,因为在界面线程之外保留这些对象并对其进行操作是导致测试不稳定的主要原因。因此,您不会在 Espresso API 中看到 getView() 和 getCurrentActivity() 等方法。您仍然可以通过实现自己的 ViewAction 和 ViewAssertion 子类来安全地对视图执行操作。

API 组件

Espresso 的主要组件包括:

  • Espresso - 与视图交互的入口点(通过 onView() 和 onData())。此外,还会提供不一定与任何视图相关联的 API,例如 pressBack()。
  • ViewMatchers - 实现 Matcher<? super View> 接口的对象集合。您可以将其中一个或多个传递给 onView() 方法,以在当前视图层次结构中找到视图。
  • ViewActions - 可传递给 ViewInteraction.perform() 方法的 ViewAction 对象的集合,例如 click()。
  • ViewAssertions - 可传递给 ViewInteraction.check() 方法的 ViewAssertion 对象的集合。大多数情况下,您将使用 matches 断言,该断言使用视图匹配器来断言当前所选视图的状态。

示例:

// withId(R.id.my_view) is a ViewMatcher.
// click() is a ViewAction.
// matches(isDisplayed()) is a ViewAssertion.
onView(withId(R.id.my_view))
    .perform(click())
    .check(matches(isDisplayed()))

查找视图

在绝大多数情况下,onView() 方法采用一个 Hamcrest 匹配器,该匹配器应与当前视图层次结构中的一个(且仅一个)视图匹配。匹配器功能强大,使用过 Mockito 或 JUnit 的用户应该对它们很熟悉。如果您不熟悉 Hamcrest 匹配器,建议您先快速浏览此演示文稿。

通常,所需的视图具有唯一的 R.id,简单的 withId 匹配器会缩小视图搜索范围。不过,在许多合理的情况下,您无法在测试开发时确定 R.id。例如,特定视图可能没有 R.id,或者 R.id 不是唯一的。这可能会导致常规插桩测试变得脆弱且难以编写,因为访问视图的常规方法(使用 findViewById())不起作用。因此,您可能需要访问包含该视图的 Activity 或 Fragment 的私有成员,或者找到具有已知 R.id 的容器并导航到其内容以找到特定视图。

Espresso 允许您使用现有 ViewMatcher 对象或您自己的自定义对象来缩小视图范围,从而巧妙地解决了此问题。

按 R.id 查找视图就像调用 onView() 一样简单:

onView(withId(R.id.my_view))

有时,会在多个视图之间共享 R.id 值。发生这种情况时,尝试使用特定 R.id 会导致异常,例如 AmbiguousViewMatcherException。异常消息会为您提供当前视图层次结构的文本表示,您可以搜索并找到与非唯一 R.id 匹配的视图:

java.lang.RuntimeException:
androidx.test.espresso.AmbiguousViewMatcherException
This matcher matches multiple views in the hierarchy: (withId: is <123456789>)

...

+----->SomeView{id=123456789, res-name=plus_one_standard_ann_button,
visibility=VISIBLE, width=523, height=48, has-focus=false, has-focusable=true,
window-focus=true, is-focused=false, is-focusable=false, enabled=true,
selected=false, is-layout-requested=false, text=,
root-is-layout-requested=false, x=0.0, y=625.0, child-count=1}
****MATCHES****
|
+------>OtherView{id=123456789, res-name=plus_one_standard_ann_button,
visibility=VISIBLE, width=523, height=48, has-focus=false, has-focusable=true,
window-focus=true, is-focused=false, is-focusable=true, enabled=true,
selected=false, is-layout-requested=false, text=Hello!,
root-is-layout-requested=false, x=0.0, y=0.0, child-count=1}
****MATCHES****

通过查看视图的各种属性,您可能会发现可明确识别的属性。在上面的示例中,其中一个视图包含文本 "Hello!"。您可以使用此功能,通过组合匹配器来缩小搜索范围:

onView(allOf(withId(R.id.my_view), withText("Hello!")))

您也可以选择不反转任何匹配器:

onView(allOf(withId(R.id.my_view), not(withText("Unwanted"))))

如需了解 Espresso 提供的常见视图匹配器,请在 IDE 中检查 androidx.test.espresso.matcher.ViewMatchers 或参阅 Espresso 备忘单。

注意事项

  • 在行为良好的应用中,用户可以与之互动的所有视图都应包含说明性文字或内容说明。如需了解详情,请参阅提高应用的无障碍性。如果您无法使用 withText() 或 withContentDescription() 缩小搜索范围,请考虑将其视为无障碍功能 bug。
  • 使用描述性最弱的匹配器来查找您要查找的一个视图。请勿过度指定,因为这会迫使框架执行不必要的工作。例如,如果某个视图可通过其文本进行可明确识别个人身份,则您无需指定该视图也可从 TextView 分配。对于许多视图,视图的 R.id 应该足够。
  • 如果目标视图位于 AdapterView(例如 ListView、GridView 或 Spinner)内,onView() 方法可能不起作用。在这些情况下,您应改用 onData()。

对视图执行操作

找到目标视图的合适匹配器后,您可以使用 perform 方法对该视图执行 ViewAction 实例。

例如,要点击视图,请编写以下代码:

onView(...).perform(click())

您可以通过一次 perform 调用来执行多项操作:

onView(...).perform(typeText("Hello"), click())

如果您正在使用的视图位于 ScrollView(垂直或水平)内,请考虑在需要显示该视图的操作(例如 click() 和 typeText())之前执行 scrollTo()。这可确保在继续执行其他操作之前显示视图:

onView(...).perform(scrollTo(), click())

如需了解 Espresso 提供的常见视图操作,请在 IDE 中检查 androidx.test.espresso.action.ViewActions 或参阅 Espresso 备忘单。

检查视图断言

您可以使用 check() 方法将断言应用于当前所选视图。最常用的断言是 matches() 断言。它使用 ViewMatcher 对象来断言当前所选视图的状态。

例如,如需检查视图是否包含文本 "Hello!",请编写以下代码:

onView(...).check(matches(withText("Hello!")))

如果您要断言 "Hello!" 是视图的内容,则编写以下代码的做法不妥:

// Don't use assertions like withText inside onView.
onView(allOf(withId(...), withText("Hello!"))).check(matches(isDisplayed()))

另一方面,如果您想断言包含文本 "Hello!" 的视图可见(例如,在视图可见性标志发生更改后),则该代码没有问题。

视图断言简单测试

在此示例中,SimpleActivity 包含一个 Button 和一个 TextView。点击该按钮后,TextView 的内容会更改为 "Hello Espresso!"。

使用 Espresso 进行测试的方法如下:

点击按钮

第一步是查找有助于找到按钮的属性。SimpleActivity 中的按钮具有唯一的 R.id,这符合预期。

onView(withId(R.id.button_simple))

现在执行点击:

onView(withId(R.id.button_simple)).perform(click())

验证 TextView 文本

包含要验证的文本的 TextView 也具有唯一的 R.id:

onView(withId(R.id.text_simple))

现在验证内容文本:

onView(withId(R.id.text_simple)).check(matches(withText("Hello Espresso!")))

检查适配器视图中的数据加载

AdapterView 是一种特殊类型的小部件,可从适配器动态加载其数据。最常见的 AdapterView 示例是 ListView。与 LinearLayout 等静态 widget 不同,只有一部分 AdapterView 子级可能会加载到当前视图层次结构中。简单的 onView() 搜索不会找到当前未加载的视图。

Espresso 通过提供单独的 onData() 入口点来处理此问题,该入口点能够先加载有问题的适配器项,在对其或其任何子项进行操作之前将其置于焦点。

警告:如果 AdapterView 的自定义实现违反了继承协定(尤其是 getItem() API),则 onData() 方法可能会出现问题。在这种情况下,最佳做法是重构应用代码。如果无法做到这一点,您可以实现匹配的自定义 AdapterViewProtocol。如需了解详情,请参阅 DataInteraction.usingAdapterViewProtocol() 并检查 androidx.test.espresso:espresso-core 中的 androidx.test.espresso.action.AdapterViewProtocols。

适配器视图简单测试

这个简单的测试演示了如何使用 onData()。SimpleActivity 包含一个 Spinner,其中包含一些表示咖啡饮料类型的项。选择某个项后,TextView 会更改为 "One %s a day!",其中 %s 表示所选项。

此测试的目标是打开 Spinner,选择特定内容,并验证 TextView 是否包含该内容。由于 Spinner 类基于 AdapterView,因此建议使用 onData()(而非 onView())来匹配项。

打开项目选择视图

onView(withId(R.id.spinner_simple)).perform(click())

选择项目

对于内容选择,Spinner 会创建一个包含其内容的 ListView。 此视图可能非常长,并且元素可能不会添加到视图层次结构中。通过使用 onData(),我们可以强制将所需元素放入视图层次结构中。Spinner 中的项是字符串,因此我们要匹配与字符串 "Americano" 相等的项:

onData(
    allOf(
        `is`(instanceOf(String::class.java)),
        `is`("Americano")
    )
).perform(click())

验证文本是否正确

onView(withId(R.id.spinnertext_simple))
    .check(matches(withText(containsString("Americano"))))

调试

当测试失败时,Espresso 会提供有用的调试信息。

日志记录

Espresso 会将所有视图操作记录到 logcat。例如:

ViewInteraction: Performing 'single click' action on view with text: Espresso

查看层次结构

当 onView() 失败时,Espresso 会在异常消息中输出视图层次结构。

  • 如果 onView() 找不到目标视图,则会抛出 NoMatchingViewException。您可以检查异常字符串中的视图层次结构,以分析匹配器为何未匹配任何视图。
  • 如果 onView() 找到多个与给定匹配器匹配的视图,则会抛出 AmbiguousViewMatcherException。系统会输出视图层次结构,并使用 MATCHES 标签标记所有匹配的视图:
java.lang.RuntimeException:
androidx.test.espresso.AmbiguousViewMatcherException
This matcher matches multiple views in the hierarchy: (withId: is <123456789>)

...

+----->SomeView{id=123456789, res-name=plus_one_standard_ann_button,
visibility=VISIBLE, width=523, height=48, has-focus=false, has-focusable=true,
window-focus=true, is-focused=false, is-focusable=false, enabled=true,
selected=false, is-layout-requested=false, text=,
root-is-layout-requested=false, x=0.0, y=625.0, child-count=1}
****MATCHES****
|
+------>OtherView{id=123456789, res-name=plus_one_standard_ann_button,
visibility=VISIBLE, width=523, height=48, has-focus=false, has-focusable=true,
window-focus=true, is-focused=false, is-focusable=true, enabled=true,
selected=false, is-layout-requested=false, text=Hello!,
root-is-layout-requested=false, x=0.0, y=0.0, child-count=1}
****MATCHES****

在处理复杂的视图层次结构或微件的意外行为时,使用 Android Studio 中的 Hierarchy Viewer 寻求解释总是很有帮助。

适配器视图警告

Espresso 会向用户发出有关存在 AdapterView 微件的警告。当 onView() 操作抛出 NoMatchingViewException 且视图层次结构中存在 AdapterView widget 时,最常见的解决方案是使用 onData()。异常消息将包含一条警告,其中列出了适配器视图。 您可以使用此信息来调用 onData() 以加载目标视图。

其他资源

如需详细了解如何在 Android 测试中使用 Espresso,请参阅以下资源。

示例