测试 API

与 UI 元素交互主要有三种方式

  • 查找器 允许您选择一个或多个元素(或语义树中的节点)以对其进行断言或执行操作。
  • 断言 用于验证元素是否存在或是否具有某些属性。
  • 操作 在元素上注入模拟的用户事件,例如点击或其他手势。

其中一些 API 接受一个 SemanticsMatcher 来引用语义树中的一个或多个节点

查找器

您可以使用 onNodeonAllNodes 分别选择一个或多个节点,但您也可以使用便利查找器进行最常见的搜索,例如 onNodeWithTextonNodeWithContentDescription。您可以在 Compose 测试备忘单 中浏览完整列表。

选择单个节点

composeTestRule.onNode(<<SemanticsMatcher>>, useUnmergedTree = false): SemanticsNodeInteraction
// Example
composeTestRule
    .onNode(hasText("Button")) // Equivalent to onNodeWithText("Button")

选择多个节点

composeTestRule
    .onAllNodes(<<SemanticsMatcher>>): SemanticsNodeInteractionCollection
// Example
composeTestRule
    .onAllNodes(hasText("Button")) // Equivalent to onAllNodesWithText("Button")

未合并的树

某些节点合并其子节点的语义信息。例如,带有两个文本元素的按钮会合并文本元素标签

MyButton {
    Text("Hello")
    Text("World")
}

从测试中,使用 printToLog() 显示语义树

composeTestRule.onRoot().printToLog("TAG")

此代码打印以下输出

Node #1 at (...)px
 |-Node #2 at (...)px
   Role = 'Button'
   Text = '[Hello, World]'
   Actions = [OnClick, GetTextLayoutResult]
   MergeDescendants = 'true'

如果您需要匹配未合并树的节点,可以将 useUnmergedTree 设置为 true

composeTestRule.onRoot(useUnmergedTree = true).printToLog("TAG")

此代码打印以下输出

Node #1 at (...)px
 |-Node #2 at (...)px
   OnClick = '...'
   MergeDescendants = 'true'
    |-Node #3 at (...)px
    | Text = '[Hello]'
    |-Node #5 at (83.0, 86.0, 191.0, 135.0)px
      Text = '[World]'

useUnmergedTree 参数在所有查找器中都可用。例如,这里它用于 onNodeWithText 查找器中。

composeTestRule
    .onNodeWithText("World", useUnmergedTree = true).assertIsDisplayed()

断言

通过在由查找器(使用一个或多个匹配器)返回的 SemanticsNodeInteraction 上调用 assert() 来检查断言

// Single matcher:
composeTestRule
    .onNode(matcher)
    .assert(hasText("Button")) // hasText is a SemanticsMatcher

// Multiple matchers can use and / or
composeTestRule
    .onNode(matcher).assert(hasText("Button") or hasText("Button2"))

您还可以使用便利函数进行最常见的断言,例如 assertExistsassertIsDisplayedassertTextEquals。您可以在 Compose 测试备忘单 中浏览完整列表。

还有一些函数可以检查节点集合上的断言

// Check number of matched nodes
composeTestRule
    .onAllNodesWithContentDescription("Beatle").assertCountEquals(4)
// At least one matches
composeTestRule
    .onAllNodesWithContentDescription("Beatle").assertAny(hasTestTag("Drummer"))
// All of them match
composeTestRule
    .onAllNodesWithContentDescription("Beatle").assertAll(hasClickAction())

操作

要在节点上注入操作,请调用 perform…() 函数

composeTestRule.onNode(...).performClick()

以下是一些操作示例

performClick(),
performSemanticsAction(key),
performKeyPress(keyEvent),
performGesture { swipeLeft() }

您可以在 Compose 测试备忘单 中浏览完整列表。

匹配器

提供各种匹配器来测试您的 Compose 代码。

分层匹配器

分层匹配器允许您向上或向下遍历语义树并执行匹配。

fun hasParent(matcher: SemanticsMatcher): SemanticsMatcher
fun hasAnySibling(matcher: SemanticsMatcher): SemanticsMatcher
fun hasAnyAncestor(matcher: SemanticsMatcher): SemanticsMatcher
fun hasAnyDescendant(matcher: SemanticsMatcher):  SemanticsMatcher

以下是一些使用这些匹配器的示例

composeTestRule.onNode(hasParent(hasText("Button")))
    .assertIsDisplayed()

选择器

创建测试的另一种方法是使用选择器,它可以使某些测试更具可读性。

composeTestRule.onNode(hasTestTag("Players"))
    .onChildren()
    .filter(hasClickAction())
    .assertCountEquals(4)
    .onFirst()
    .assert(hasText("John"))

您可以在 Compose 测试备忘单 中浏览完整列表。

其他资源

  • 在 Android 上测试应用:主要的 Android 测试登录页面提供了更广泛的测试基础知识和技巧。
  • 测试基础知识了解有关测试 Android 应用的核心概念的更多信息。
  • 本地测试您可以在自己的工作站上本地运行一些测试。
  • 仪器测试最好也运行仪器测试。也就是说,直接在设备上运行的测试。
  • 持续集成持续集成允许您将测试集成到部署管道中。
  • 测试不同的屏幕尺寸由于用户可以使用许多设备,因此您应该测试不同的屏幕尺寸。
  • Espresso:虽然旨在用于基于视图的 UI,但 Espresso 知识对于 Compose 测试的某些方面仍然很有帮助。