测试构建器（实验性）

⚠️ 测试构建器是基于响应的并且可能会生成大量代码。向前发展，我们建议使用数据构建器，它们更容易使用。此页面仅供参考。

.css-154yii{-webkit-text-decoration:underline;text-decoration:underline;text-decoration-style:dotted;text-decoration-thickness:1.5px;text-decoration-color:var(--chakra-colors-gray-300);text-underline-offset:0.2em;}.css-154yii:hover,.css-154yii[data-hover]{cursor:help;}.chakra-ui-dark .css-154yii:not([data-theme]),[data-theme=dark] .css-154yii:not([data-theme]),.css-154yii[data-theme=dark]{text-decoration-color:var(--chakra-colors-blue-400);}Apollo Kotlin 提供了 测试构建器，它们允许您使用默认值创建您的 GraphQL 模型类的实例。测试构建器和具有大量字段或深度嵌套层次结构的模型一起测试尤其有用。它们会自动填充所需字段的值，并为其他字段自动设置模拟值。__typename 字段，并在可能的情况下移除合并的字段冗余。

启用测试构建器

默认情况下，测试构建器是 未启用 的，因为它们不是每个应用程序都需要的，并且会生成额外的代码。要启用它们，将 generateTestBuilders 选项设置为 true:

build.gradle[.kts]

1
apollo {
2
  service("service") {
3
    // ...
4

5
    // Enable test builder generation
6
    generateTestBuilders.set(true)
7
  }
8
}

这将为您的操作中使用的每个模型生成一个构建器 DSL。这些 DSL 依赖于每个模型的字段。使用 DSL，您可以设置特定测试所需字段的值，而为其他字段自动设置模拟值。

示例用法

假设我们要构建一个测试，该测试使用以下查询的模拟结果:

1
query HeroForEpisode($ep: Episode!) {
2
  hero(episode: $ep) {
3
    firstName
4
    lastName
5
    age
6
    
7
    ship {
8
      model
9
      speed
10
    }
11

12
    friends {
13
      firstName
14
      lastName
15
    }
16

17
    ... on Droid {
18
      primaryFunction
19
    }
20

21
    ... on Human {
22
      height
23
    }
24
  }
25
}

以下是我们可以如何使用针对该模拟结果的相应测试构建器的示例

1
// Import the query's test builder
2
import com.example.test.HeroForEpisodeQuery_TestBuilder.Data
3

4
@Test
5
fun test() {
6
  val data = HeroForEpisodeQuery.Data {
7
    // Set values for particular fields of the query
8
    hero = humanHero {
9
      firstName = "John"
10
      age = 42
11
      friends = listOf(
12
        humanFriend {
13
          firstName = "Jane"
14
        },
15
        humanFriend {
16
          lastName = "Doe"
17
        }
18
      )
19
      ship = ship {
20
        model = "X-Wing"
21
      }
22
    }
23
  }
24

25
  assertEquals("John", data.hero.firstName)
26
  assertEquals(42, data.hero.age)
27
}

在本示例中，hero 字段是一个具有指定firstName和age值的Human对象。字段lastName和height将自动填充模拟值。类似地，船的速度、第1个朋友的姓氏和第2个朋友的名字也将自动填充。

您可以将上面的humanHero替换为droidHero来创建一个Droid对象，或者指定otherHero来创建既不是Human也没有是Droid的对象。

配置默认字段值

要将默认值分配给字段，测试构建器使用TestResolver接口的实现。默认情况下，它们使用DefaultTestResolver的实例。

DefaultTestResolver为每个String字段提供了作为其默认值的字段名，并且在分配默认值给Int字段时增加一个计数器。它为其他类型定义了类似的默认行为。

您可以创建自己的自定义 TestResolver实现（可选地扩展DefaultTestResolver以开始）。然后，您将这个实现作为参数传递到Data函数中，如下所示：

1
// A TestResolver implementation that assigns -1 to all Int fields
2
val myTestResolver = object : DefaultTestResolver() {
3
  override fun resolveInt(path: List<Any>): Int {
4
    return -1
5
  }
6
}
7

8
@Test
9
fun test() {
10
  val data = HeroForEpisodeQuery.Data(testResolver = myTestResolver) {
11
    hero = humanHero {
12
      firstName = "John"
13
    }
14
  }
15

16
  // Unspecified Int field is -1
17
  assertEquals(-1, data.hero.age)
18
}

下一步

开始学习