在 Jest 中测试失败时如何打印请求和响应？

Question

我正在使用 Supertest 和 Jest 来测试 Node.js API。

样本测试具有以下格式

it('Read a note for a user', (done) => {
      request(graphqlURL)
        .post('/graphql')
        .set(baseHeaders())
        .send({
          query: graphQLQuery
        })
        .end((err, res) => {
          expect(res.status).toBe(200);          
          done();
        })

    });

当前当期望失败时，会记录以下内容

expect(received).toBe(expected) // Object.is equality

    Expected: 200
    Received: 404

我还想在失败的测试旁边记录请求和响应，以便在调试时获得更多上下文。

有没有办法也打印那些，仅用于失败的测试？

Answer 1

如果您为正文添加额外的期望，如果它与期望的不匹配，它将被记录下来。在状态码期望之前有这个期望会导致你想要的效果。

Answer 2

expect 通过在期望失败时抛出 Error 来工作。

Error 的 message 属性是打印在测试报告中的内容。

我想如果您想使用 现有 期望并且只是想用附加数据增加失败消息，您可以捕获 Error，将附加数据附加到 message 属性，然后像这样再次抛出Error：

it('Read a note for a user', (done) => {
  request(graphqlURL)
    .post('/graphql')
    .set(baseHeaders())
    .send({
      query: graphQLQuery
    })
    .end((err, res) => {
      try {
        expect(res.status).toBe(200);
      } catch (err) {
        // --- add additional data to the error message here ---
        err.message = `${err.message}\n\nfailing query: ${graphQLQuery}`;
        throw err;  // throw the error so test fails as expected
      }
      done();
    })
});

Answer 3

您可以创建一个custom matcher，在期望失败时记录响应：

expect.extend({
  statusCode(expected, response) {
    const { status } = response
    const pass = expected === status

    if (pass) {
      return {
        message: () =>
          `expected ${status} to be ${expected}`,
        pass: true
      }
    } else {
      return {
        message: () =>
          `expected ${status} to be ${expected}. Response: ${response}`,
        pass: false
      }
    }
  }
})

然后在您的测试中，使用自定义匹配器而不是典型的expect：

it('Read a note for a user', (done) => {
  request(graphqlURL)
    .post('/graphql')
    .set(baseHeaders())
    .send({
      query: graphQLQuery
    })
    .end((err, res) => {
      expect.statusCode(200, res)     
      done()
    })
})

很遗憾，there isn't really a way to access the HTTP request using supertest。但是您可以在自定义匹配器的签名中添加有关您确实拥有的请求的任意信息。

Answer 4

您可以像这样打印响应：

it('Read a note for a user', (done) => {
  request(graphqlURL)
    .post('/graphql')
    .set(baseHeaders())
    .send({
      query: graphQLQuery
    })
    .end((err, res) => {
      if(!expect(res.status).toBe(200)) console.log('res',res) // print response
      expect(res.status).toBe(200);          
      done();
    })

  });