使用 Mocha 测试框架测试 GraphQL API-JavaScript中文网-JavaScript教程资源分享门户

GraphQL 是一种查询语言，它可以让我们更灵活地获取数据。它的出现使得前端开发人员可以更加高效地获取数据，而 GraphQL API 的测试也变得越来越重要。本文将介绍如何使用 Mocha 测试框架来测试 GraphQL API。

Mocha 简介

Mocha 是一个 JavaScript 测试框架，它可以运行在浏览器和 Node.js 环境中。Mocha 的特点是易于使用、灵活和可扩展。它支持多种测试类型，例如单元测试、集成测试和端到端测试等。

Mocha 的测试用例可以使用多种断言库，例如 Node.js 内置的 assert 库、Chai 库和 Should.js 库等。这些库可以帮助我们编写更加清晰和易于维护的测试用例。

GraphQL API 的测试

GraphQL API 的测试可以分为两个方面：查询测试和变更测试。查询测试是测试查询语句是否返回正确的数据，变更测试是测试变更操作是否正确地修改了数据。

在进行 GraphQL API 的测试之前，我们需要先了解 GraphQL 的基本语法。GraphQL 查询语句由字段和参数组成，字段表示我们需要获取的数据，参数表示我们需要传递给查询的参数。

例如，下面是一个查询用户信息的 GraphQL 查询语句：

query getUser($id: ID!) {
  user(id: $id) {
    name
    email
    age
  }
}

在这个查询语句中，我们查询了用户的姓名、电子邮件和年龄。我们还传递了一个参数 $id，它表示我们需要查询的用户的 ID。

在进行 GraphQL API 的测试之前，我们需要先创建一个 GraphQL API。在本文中，我们将使用 Apollo Server 来创建 GraphQL API。

// javascriptcn.com 代码示例
const { ApolloServer, gql } = require('apollo-server');

const users = [
  {
    id: '1',
    name: 'Alice',
    email: 'alice@example.com',
    age: 20,
  },
  {
    id: '2',
    name: 'Bob',
    email: 'bob@example.com',
    age: 25,
  },
];

const typeDefs = gql`
  type Query {
    user(id: ID!): User
    users: [User]
  }

  type User {
    id: ID!
    name: String!
    email: String!
    age: Int!
  }
`;

const resolvers = {
  Query: {
    user: (parent, args, context, info) => {
      return users.find((user) => user.id === args.id);
    },
    users: (parent, args, context, info) => {
      return users;
    },
  },
};

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

server.listen().then(({ url }) => {
  console.log(`Server ready at ${url}`);
});

在这个示例代码中，我们创建了一个 user 查询和一个 users 查询。user 查询接受一个参数 id，它表示我们需要查询的用户的 ID。users 查询不接受任何参数，它返回所有用户的信息。

现在我们可以使用 Mocha 测试框架来测试这个 GraphQL API 了。

使用 Mocha 测试 GraphQL API

首先，我们需要安装 Mocha 和 Chai：

npm install --save-dev mocha chai

接下来，我们创建一个测试文件 test.js：

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

const typeDefs = gql`
  type Query {
    user(id: ID!): User
    users: [User]
  }

  type User {
    id: ID!
    name: String!
    email: String!
    age: Int!
  }
`;

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

const { query } = createTestClient(server);

describe('GraphQL API', () => {
  describe('Query', () => {
    it('should return a user', async () => {
      const { data } = await query({
        query: gql`
          query getUser($id: ID!) {
            user(id: $id) {
              name
              email
              age
            }
          }
        `,
        variables: { id: '1' },
      });

      expect(data.user.name).to.equal('Alice');
      expect(data.user.email).to.equal('alice@example.com');
      expect(data.user.age).to.equal(20);
    });

    it('should return all users', async () => {
      const { data } = await query({
        query: gql`
          query {
            users {
              name
              email
              age
            }
          }
        `,
      });

      expect(data.users).to.have.lengthOf(2);
      expect(data.users[0].name).to.equal('Alice');
      expect(data.users[0].email).to.equal('alice@example.com');
      expect(data.users[0].age).to.equal(20);
      expect(data.users[1].name).to.equal('Bob');
      expect(data.users[1].email).to.equal('bob@example.com');
      expect(data.users[1].age).to.equal(25);
    });
  });
});

在这个测试文件中，我们使用了 describe 和 it 函数来组织测试用例。我们首先测试了 user 查询是否能够正确地返回用户信息，然后测试了 users 查询是否能够正确地返回所有用户的信息。

我们使用了 Chai 断言库来编写测试用例。例如，我们使用了 expect 函数来判断查询结果是否符合预期。

我们还使用了 createTestClient 函数来创建一个测试客户端。这个测试客户端可以发送 GraphQL 查询语句，并且返回查询结果。我们将这个测试客户端传递给了 Apollo Server，以便进行测试。

现在我们可以使用 Mocha 来运行这个测试文件了：

npx mocha test.js

如果测试通过，我们将会看到输出：

GraphQL API
  Query
    ✓ should return a user
    ✓ should return all users


  2 passing (70ms)

总结

本文介绍了如何使用 Mocha 测试框架来测试 GraphQL API。我们首先了解了 Mocha 的基本用法和 GraphQL 的基本语法，然后编写了测试用例来测试 GraphQL API。使用 Mocha 测试框架可以帮助我们编写更加清晰和易于维护的测试用例，同时也可以提高测试效率。

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