使用 Chai 和 SuperTest 进行接口测试时遇到的响应数据不一致问题解析

在前端开发过程中，接口测试是必不可少的一环。Chai 和 SuperTest 是常用的接口测试工具之一。然而，在实际测试中，会遇到响应数据不一致的问题，即代码中预期的数据和服务器返回的数据不同，造成测试无法通过。本文将探讨这个问题的原因和解决方法，帮助大家更好地使用 Chai 和 SuperTest 进行接口测试。

问题分析

通常，我们会使用 SuperTest 发送 HTTP 请求，得到的响应数据是一个 JSON 对象。而在使用 Chai 断言时，我们需要对响应数据进行解析，取出我们需要的数据进行验证。例如：

// javascriptcn.com 代码示例
const { expect } = require('chai');
const request = require('supertest');

describe('GET /api/books', () => {
  it('should return a list of books', (done) => {
    request(app)
      .get('/api/books')
      .expect(200)
      .end((err, res) => {
        if (err) return done(err);

        const books = res.body.books;

        expect(Array.isArray(books)).to.be.true;
        expect(books.length).to.be.above(0);
        expect(books[0]).to.have.property('title');
        expect(books[0]).to.have.property('author');

        done();
      });
  });
});

这段代码中，我们发送了一个 GET 请求，期望服务器返回状态码为 200，并且返回一个包含图书列表的 JSON 对象。在断言部分，我们使用 Chai 对响应数据进行解析，并进行各项验证。

但是，如果服务器返回的数据结构和我们预期的不一致，就会导致测试失败。例如，服务器返回的数据可能会多出一些字段，或者缺少一些我们需要的字段。这时，我们就需要对响应数据进行适当的处理，才能进行正确的断言。

下面是一些常见的响应数据不一致的情况：

• 字段缺失：服务器返回的数据中，缺少了我们需要的某个字段，导致断言失败。
• 字段多余：服务器返回的数据中，包含了我们不需要的或者多余的字段，也会导致断言失败。
• 字段类型不一致：服务器返回的数据中，某个字段的类型和我们预期的不一致，也会导致断言失败。

以上问题都需要我们针对性地解析和处理响应数据，才能进行断言。下面，我们将给出一些解决方法。

解决方案

使用 Joi 库进行数据验证

Joi 是一个 JavaScript 库，用于验证和解析数据。它可以方便地对数据进行验证，并且支持对数据类型、结构、枚举值、默认值等进行声明式定义。通过使用 Joi，我们可以对服务器返回的数据结构进行统一的验证，不仅可以防止代码中的错误，也可以简化数据解析的流程，提高代码的可维护性。

例如，在之前的例子中，我们可以使用 Joi 来验证图书列表的数据结构，代码如下：

// javascriptcn.com 代码示例
const Joi = require('joi');

const bookSchema = Joi.object({
  title: Joi.string().required(),
  author: Joi.string().required(),
});

const booksSchema = Joi.array().items(bookSchema);

describe('GET /api/books', () => {
  it('should return a list of books', (done) => {
    request(app)
      .get('/api/books')
      .expect(200)
      .end((err, res) => {
        if (err) return done(err);

        const { error, value } = booksSchema.validate(res.body.books);

        expect(error).to.be.null;
        expect(Array.isArray(value)).to.be.true;
        expect(value.length).to.be.above(0);
        expect(value[0]).to.have.property('title');
        expect(value[0]).to.have.property('author');

        done();
      });
  });
});

在这段代码中，我们首先定义了一个图书对象的数据结构，包含了 title 和 author 两个字段，这个数据结构通过 Joi.object 方法来实现。接着，我们定义了一个图书列表的数据结构，通过 Joi.array 和 .items(bookSchema) 实现。最后，在进行断言前，我们使用 .validate 方法对响应数据进行验证，并返回验证结果。如果验证失败，那么 error 就不为空。否则，value 就是验证通过之后的数据。

使用 Joi 进行数据验证不仅可以增强代码的可维护性和健壮性，而且可以便捷地检查数据类型和结构，避免了因为数据格式不同而导致的断言失败。

使用 Lodash 来处理响应数据

Lodash 是一个流行的 JavaScript 实用工具库。它提供了许多工具函数，用于操作数据、数组、对象、字符串、函数等多种类型。在处理响应数据时，Lodash 提供了许多常用的函数，例如 pick、omit、get、has、isEqual、flatten 等，可以方便地进行数据操作。

例如，我们可以使用 pick 函数来从响应数据中筛选出需要的属性，如下所示：

// javascriptcn.com 代码示例
const _ = require('lodash');

describe('GET /api/books', () => {
  it('should return a list of books', (done) => {
    request(app)
      .get('/api/books')
      .expect(200)
      .end((err, res) => {
        if (err) return done(err);

        const books = _.map(res.body.books, book => _.pick(book, ['title', 'author']));

        expect(Array.isArray(books)).to.be.true;
        expect(books.length).to.be.above(0);
        expect(books[0]).to.have.property('title');
        expect(books[0]).to.have.property('author');

        done();
      });
  });
});

在这段代码中，我们使用了 Lodash 的 map 和 pick 函数。map 函数用于遍历数组，pick 函数用于从对象中挑选某些属性，返回一个新的对象。通过使用这两个函数，我们就得到了一个新的图书列表，只包含 title 和 author 两个属性。

Lodash 提供了许多函数，可以方便地进行数据操作。它可以大大简化代码，提高编码效率，并使代码更加易读。

总结

在进行接口测试时，响应数据不一致是一个常见的问题。对于这个问题，我们可以采用 Joi 库和 Lodash 库进行处理，以获得更好的代码可维护性和健壮性。在实践中，我们可以根据具体情况进行选择，选择合适的方案进行处理，从而达到更好的测试效果。

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