使用 Jest 测试 GraphQL 服务的最佳实践-JavaScript中文网-JavaScript教程资源分享门户

GraphQL 是一种用于 API 的查询语言，它提供了一种更高效、更强大的方式来获取数据。在开发一个 GraphQL 服务时，测试是非常重要的一部分。在本文中，我们将介绍如何使用 Jest 测试 GraphQL 服务的最佳实践。

安装 Jest 和相关依赖

首先，我们需要安装 Jest 和相关依赖。运行以下命令：

npm install --save-dev jest jest-graphql

其中，jest 是 Jest 的主要依赖，jest-graphql 是一个 Jest 插件，可以用于测试 GraphQL 服务。

配置 Jest

我们需要在项目根目录下创建一个 jest.config.js 文件，并添加以下内容：

// javascriptcn.com 代码示例
module.exports = {
  testEnvironment: 'node',
  testMatch: ['**/__tests__/**/*.test.js'],
  moduleNameMapper: {
    '^@/(.*)$': '<rootDir>/src/$1'
  },
  transform: {
    '\\.(gql|graphql)$': 'jest-raw-loader'
  }
}

其中，testEnvironment 设置为 node，表示我们将在 Node.js 环境下运行测试。testMatch 指定了 Jest 测试文件的匹配模式，这里我们将测试文件放在 __tests__ 目录下，并以 .test.js 结尾。moduleNameMapper 是一个模块名称映射表，用于将 @/ 开头的模块路径映射到 src/ 目录下。transform 用于转换 .gql 和 .graphql 文件，将其转换为字符串，以便在测试中使用。

编写测试用例

现在，我们可以开始编写测试用例了。在 __tests__ 目录下创建一个 example.test.js 文件，并添加以下内容：

// javascriptcn.com 代码示例
const { createTestClient } = require('apollo-server-testing')
const { ApolloServer, gql } = require('apollo-server')
const typeDefs = require('@/schema')
const resolvers = require('@/resolvers')

const server = new ApolloServer({
  typeDefs,
  resolvers
})

const { query } = createTestClient(server)

describe('Example GraphQL API', () => {
  test('Get example data', async () => {
    const GET_EXAMPLE_DATA = gql`
      query {
        exampleData {
          id
          name
        }
      }
    `

    const { data } = await query({ query: GET_EXAMPLE_DATA })
    expect(data.exampleData).toEqual({ id: '1', name: 'Example' })
  })
})

在这个测试用例中，我们使用了 apollo-server-testing 库提供的 createTestClient 方法来创建一个测试客户端，该客户端可以用于发送 GraphQL 查询。我们还创建了一个 ApolloServer 实例，并将其传递给测试客户端。我们编写了一个名为 Get example data 的测试用例，该用例通过发送一个查询，来测试我们的 GraphQL API 是否能够正确地返回数据。

运行测试

现在，我们可以运行测试了。在终端中运行以下命令：

npx jest

Jest 将自动查找所有的测试文件，并运行测试。如果测试通过，将输出以下内容：

// javascriptcn.com 代码示例
 PASS  __tests__/example.test.js
  Example GraphQL API
    ✓ Get example data (4 ms)

Test Suites: 1 passed, 1 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        2.569 s
Ran all test suites.

总结

在本文中，我们介绍了如何使用 Jest 测试 GraphQL 服务的最佳实践。我们安装了 Jest 和相关依赖，并配置了 Jest。我们编写了一个测试用例，使用 apollo-server-testing 库提供的 createTestClient 方法来创建一个测试客户端，并发送一个查询来测试我们的 GraphQL API 是否能够正确地返回数据。最后，我们运行了测试，并查看了测试结果。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/65702babd2f5e1655d8def8b