在Node.js服务器上使用supertest/superagent读取响应输出缓冲区/流

Question

我正在尝试编写一个测试，以检查API路由是否输出了具有正确内容的ZIP文件。

我使用mocha和supertest进行测试，并希望实际读取输出流/缓冲区，读取ZIP文件内容并查看内容是否正确。

有什么建议吗？当我尝试读取res.body时，它只是一个空对象。

  request(app)
    .get( "/api/v1/orders/download?id[]=1&id=2" )
    .set( "Authorization", authData )
    .expect( 200 )
    .expect( 'Content-Type', /application\/zip/ )
    .end( function (err, res) {
      if (err) return done( err );

      console.log( 'body:', res.body )

      // Write the temp HTML file to filesystem using utf-8 encoding
      var zip = new AdmZip( res.body );
      var zipEntries = zip.getEntries();

      console.log( 'zipentries:', zipEntries );

      zipEntries.forEach(function(zipEntry) {
        console.log(zipEntry.toString()); // outputs zip entries information
      });

      done();
    });

- ragulka

Answer 1

在@Beau的回答基础上，以下代码可用于将任何二进制响应内容作为缓冲区获取，您可以在request.end()中进一步检查：

扩展 @Beau 的答案，下面的代码可以用来获取任何二进制响应内容，并以缓冲区的形式进行进一步检查：request.end()

function binaryParser(res, callback) {
    res.setEncoding('binary');
    res.data = '';
    res.on('data', function (chunk) {
        res.data += chunk;
    });
    res.on('end', function () {
        callback(null, new Buffer(res.data, 'binary'));
    });
}

// example mocha test
it('my test', function(done) {
    request(app)
        .get('/path/to/image.png')
        .expect(200)
        .expect('Content-Type', 'image.png')
        .buffer()
        .parse(binaryParser)
        .end(function(err, res) {
            if (err) return done(err);

            // binary response data is in res.body as a buffer
            assert.ok(Buffer.isBuffer(res.body));
            console.log("res=", res.body);

            done();
        });
});

- rcoup

---

这个很好用，不过我不得不在请求中添加 .buffer()。 - Nate

与@Nate一起，来自[docs]（http://visionmedia.github.io/superagent/#parsing-response-bodies），“如果未启用响应缓冲（.buffer（false）），则响应事件将在等待主体解析器完成之前发出，因此response.body将不可用”。 - ZachB

@ZachB 所以是 .buffer().parse(binaryParser) 吗？ - rcoup

@rcoup 是的，文档上说需要，但在快速测试中似乎没有问题。更长的响应可能需要它...？ - ZachB

Answer 2

如测试二进制响应与supertest所述，将.responseType('blob')设置在请求上会导致req.body成为一个Buffer。

https://visionmedia.github.io/superagent/#binary

it('test', async () => {
  await request(app)
    .get('/api/some-zip')
    .responseType('blob')
    .expect(200)
    .expect('Content-Type', /application\/zip/)
    .expect(( res) => {
      const zipEntries = new AdmZip(res.body).getEntries().map(e => e.entryName);
      expect(zipEntries).toEqual(expect.arrayContaining(['zipfile1.pdf', 'zipfile2.pdf']));
  });
});

- Boris

Answer 3

我认为你需要创建自己的解析器来处理application/zip，并使用它来获取实际的响应数据；例如，JSON解析器在这里。一旦你拥有了它，你可以通过将其传递给request.parse来使用它；所以你的测试代码将变成：

request(app)
  .get( "/api/v1/orders/download?id[]=1&id=2" )
  .set( "Authorization", authData )
  .expect( 200 )
  .expect( 'Content-Type', /application\/zip/ )
  .parse( function (res, fn) {
    res.data = '';
    res.on( 'data', function (chunk) { res.data += chunk; } );
    res.on( 'end', function () {
      try {
        fn( null, new AdmZip( res.data ) );
      } catch ( err ) {
        fn( err );
      }
    });
  })
  .end( function (err, res) {
    if (err) return done( err );

    console.log( 'body:', res.body )

    // Write the temp HTML file to filesystem using utf-8 encoding
    var zipEntries = res.body.getEntries();

    console.log( 'zipentries:', zipEntries );

    zipEntries.forEach(function(zipEntry) {
      console.log(zipEntry.toString()); // outputs zip entries information
    });

    done();
  });

为了找到答案，我主要依靠检查superagent测试套件。 :)

- Beau

Answer 4

我曾经遇到过一个类似的情况，需要编写一个测试来检查 zip 文件的内容。这是我的做法。

    it('test', async function () {
        let data = '';
        const res = await request(app)
            .get('/api/some-zip')
            .parse((res, callback) => {
                res.setEncoding('binary');
                res.on('data', function (chunk) {
                    data += chunk;
                });
                res.on('end', function () {
                    callback(null, Buffer.from(data, 'binary'));
                });
            })
        const zip = new AdmZip(res.body)
        const zipEntries = zip.getEntries();

        expect(zipEntries[0].name).to.equal('zipfile1.pdf');
        expect(zipEntries[1].name).to.equal('zipfile2.pdf');
    });

我使用了async/await语法

- David Storm

Answer 5

现有的答案对我没有用。我最终做的是：

// parses response.body buffer into a data object
const parsePDF = response => {
  return new Promise((resolve, reject) => {
    // code that parses response.body as buffer
    // and calls resolve(data); when done
    // or reject(err); on error
  })
};

const binaryParser = require('superagent-binary-parser');

// test snippet
request(app)
    .get('/some/api/returning/pdf')
    .expect(200)
    .expect('content-type', 'application/pdf')
    .parse(binaryParser)
    .buffer()
    .then(parsePDF)
    .then((pdf) => {
      chai.expect(pdf.pages.length).to.be.equal(5);
    })

- Edi