模拟GraphQL响应（实验性）

QueueTestNetworkTransport是一个高级测试API，允许您指定由您的GraphQL客户端实例返回的ApolloClient响应。

另请参阅MockServer，该程序创建了一个完整的HTTP服务器并帮助测试特定的服务器行为，如错误情况、HTTP标头和超时。

将依赖项添加到您的项目build.gradle文件中：

build.gradle[.kts]

1
dependencies {
2
  testImplementation("com.apollographql.apollo3:apollo-testing-support:3.8.5")
3
}
4

5
// Also add jcenter() to your repositories
6
// See https://github.com/Kotlin/kotlinx-nodejs/issues/16
7
repositories {
8
  mavenCentral()
9
  jcenter()
10
}

通过将其传递给ApolloClient构建器来启用QueueTestNetworkTransport：

1
val apolloClient = ApolloClient.Builder()
2
    .networkTransport(QueueTestNetworkTransport())
3
    .build()

您可以使用enqueueTestResponse扩展函数来指定要返回的GraphQL响应：

1
val testQuery = GetHeroQuery("001")
2
val testData = GetHeroQuery.Data {
3
  hero = droidHero {
4
    name = "R2D2"
5
  }
6
}
7
apolloClient.enqueueTestResponse(testQuery, testData)
8

9
val actual = apolloClient.query(testQuery).execute().data!!
10
assertEquals(testData.hero.name, actual.hero.name)

您可以将ApolloResponse传递给enqueueTestResponse函数，也可以作为快捷方式直接传递Data，如上所示。如果您传递了一个Data，您还需要传递一个操作的引用，因为ApolloResponse在底层创建，这需要引用它。

为了帮助您创建模拟响应数据，您可以使用测试构建器。

高级使用

QueueTestNetworkTransport按入队顺序返回响应。

在某些测试中，将响应映射到操作可能更方便。

要实现这一点，请使用MapTestNetworkTransport，并调用registerTestResponse扩展函数：

1
val apolloClient = ApolloClient.Builder().networkTransport(MapTestNetworkTransport()).build()
2

3
apolloClient.registerTestResponse(query1, testData1)
4
apolloClient.registerTestResponse(query2, testData2)
5

6
val actual1 = apolloClient.query(query1).execute().data
7
val actual2 = apolloClient.query(query2).execute().data
8
// Execute query1 again, which is mapped to testData1
9
val actual3 = apolloClient.query(query1).execute().data
10

11
assertEquals(testData1, actual1)
12
assertEquals(testData2, actual2)
13
assertEquals(testData1, actual3)

如果您需要更多控制要返回的响应，您可以实现自己的NetworkTransport并将其传递给ApolloClient构建器：

1
private class CustomTestNetworkTransport : NetworkTransport {
2
  override fun <D : Operation.Data> execute(request: ApolloRequest<D>): Flow<ApolloResponse<D>> {
3
    return flowOf(
4
        ApolloResponse.Builder(
5
          /* Your custom logic here */
6
        ).build() as ApolloResponse<D>
7
    )
8
  }
9

10
override fun dispose() {}
11
}
12

13
apolloClient = ApolloClient.Builder()
14
    .networkTransport(CustomTestNetworkTransport())
15
    .build()

注意，如果您使用自定义的NetworkTransport，则无法调用enqueueTestResponse()或registerTestResponse()，因为它们期望传输是QueueTestNetworkTransport或MapTestNetworkTransport。

模拟HTTP响应

数据构建器