SuperTest

通过superagent实现简易HTTP断言。由Forward Email和Lad维护。

关于

这个模块的目的是为HTTP测试提供高层抽象，同时仍允许您使用superagent提供的低层API。

入门

将SuperTest作为npm模块安装，并将其保存到package.json文件中作为开发依赖项：

npm install supertest --save-dev

安装完成后，只需调用require('supertest');即可引用。

示例

您可以将http.Server或Function传递给request()- 如果服务器尚未监听连接，它会为您绑定到一个临时端口，因此无需跟踪端口。

SuperTest可以与任何测试框架一起使用，以下是一个不使用任何测试框架的示例：

const request = require('supertest');
const express = require('express');

const app = express();

app.get('/user', function(req, res) {
  res.status(200).json({ name: 'john' });
});

request(app)
  .get('/user')
  .expect('Content-Type', /json/)
  .expect('Content-Length', '15')
  .expect(200)
  .end(function(err, res) {
    if (err) throw err;
  });

要启用http2协议，只需在request或request.agent中添加选项：

const request = require('supertest');
const express = require('express');

const app = express();

app.get('/user', function(req, res) {
  res.status(200).json({ name: 'john' });
});

request(app, { http2: true })
  .get('/user')
  .expect('Content-Type', /json/)
  .expect('Content-Length', '15')
  .expect(200)
  .end(function(err, res) {
    if (err) throw err;
  });

request.agent(app, { http2: true })
  .get('/user')
  .expect('Content-Type', /json/)
  .expect('Content-Length', '15')
  .expect(200)
  .end(function(err, res) {
    if (err) throw err;
  });

以下是使用mocha的示例，注意您可以直接将done传递给任何.expect()调用：

describe('GET /user', function() {
  it('响应json', function(done) {
    request(app)
      .get('/user')
      .set('Accept', 'application/json')
      .expect('Content-Type', /json/)
      .expect(200, done);
  });
});

您可以使用auth方法以与superagent相同的方式传递HTTP用户名和密码：

describe('GET /user', function() {
  it('响应json', function(done) {
    request(app)
      .get('/user')
      .auth('username', 'password')
      .set('Accept', 'application/json')
      .expect('Content-Type', /json/)
      .expect(200, done);
  });
});

需要注意的一点是，如果您不添加状态码期望（即.expect(302)），superagent现在会将任何HTTP错误（任何非2XX响应代码）作为第一个参数发送给回调。

如果您使用.end()方法，失败的.expect()断言不会抛出错误 - 它们会将断言作为错误返回给.end()回调。为了使测试用例失败，您需要重新抛出或将err传递给done()，如下所示：

describe('POST /users', function() {
  it('响应json', function(done) {
    request(app)
      .post('/users')
      .send({name: 'john'})
      .set('Accept', 'application/json')
      .expect('Content-Type', /json/)
      .expect(200)
      .end(function(err, res) {
        if (err) return done(err);
        return done();
      });
  });
});

您也可以使用promises：

describe('GET /users', function() {
  it('响应json', function() {
    return request(app)
      .get('/users')
      .set('Accept', 'application/json')
      .expect('Content-Type', /json/)
      .expect(200)
      .then(response => {
         expect(response.body.email).toEqual('foo@bar.com');
      })
  });
});

或async/await语法：

describe('GET /users', function() {
  it('响应json', async function() {
    const response = await request(app)
      .get('/users')
      .set('Accept', 'application/json')
    expect(response.headers["Content-Type"]).toMatch(/json/);
    expect(response.status).toEqual(200);
    expect(response.body.email).toEqual('foo@bar.com');
  });
});

期望按定义顺序运行。这个特性可以用于在执行断言之前修改响应体或头部。

describe('POST /user', function() {
  it('user.name应该不区分大小写匹配"john"', function(done) {
    request(app)
      .post('/user')
      .send('name=john') // x-www-form-urlencoded 上传
      .set('Accept', 'application/json')
      .expect(function(res) {
        res.body.id = '某个固定id';
        res.body.name = res.body.name.toLowerCase();
      })
      .expect(200, {
        id: '某个固定id',
        name: 'john'
      }, done);
  });
});

您可以用superagent做的任何事，都可以用supertest做 - 例如多部分文件上传！

request(app)
  .post('/')
  .field('name', '我的超棒头像')
  .field('complex_object', '{"attribute": "value"}', {contentType: 'application/json'})
  .attach('avatar', 'test/fixtures/avatar.jpg')
  ...

如果您正在测试相同的主机，每次传递app或url是不必要的，您可以简单地用初始化的app或url重新分配request变量，每次调用request.VERB()都会创建一个新的Test。

request = request('http://localhost:5555');

request.get('/').expect(200, function(err){
  console.log(err);
});

request.get('/').expect('heya', function(err){
  console.log(err);
});

这是一个使用mocha的示例，展示了如何保持请求及其cookie：

const request = require('supertest');
const should = require('should');
const express = require('express');
const cookieParser = require('cookie-parser');

describe('request.agent(app)', function() {
  const app = express();
  app.use(cookieParser());

  app.get('/', function(req, res) {
    res.cookie('cookie', 'hey');
    res.send();
  });

  app.get('/return', function(req, res) {
    if (req.cookies.cookie) res.send(req.cookies.cookie);
    else res.send(':(')
  });

  const agent = request.agent(app);

  it('应保存cookie', function(done) {
    agent
    .get('/')
    .expect('set-cookie', 'cookie=hey; Path=/', done);
  });

  it('应发送cookie', function(done) {
    agent
    .get('/return')
    .expect('hey', done);
  });
});

还有另一个由文件agency.js介绍的示例

这里是一个在请求中设置2个cookie的示例。

agent(app)
  .get('/api/content')
  .set('Cookie', ['nameOne=valueOne;nameTwo=valueTwo'])
  .send()
  .expect(200)
  .end((err, res) => {
    if (err) {
      return done(err);
    }
    expect(res.text).to.be.equal('hey');
    return done();
  });

API

您可以使用任何superagent方法，包括.write()、.pipe()等，并在.end()回调中执行断言，以满足低层需求。

.expect(status[, fn])

断言响应状态码。

.expect(status, body[, fn])

断言响应状态码和主体。

.expect(body[, fn])

使用字符串、正则表达式或解析的主体对象断言响应主体文本。

.expect(field, value[, fn])

使用字符串或正则表达式断言头部字段的值。

.expect(function(res) {})

传递自定义断言函数。它将被给予响应对象进行检查。如果检查失败，抛出错误。

request(app)
  .get('/')
  .expect(hasPreviousAndNextKeys)
  .end(done);

function hasPreviousAndNextKeys(res) {
  if (!('next' in res.body)) throw new Error("缺少next键");
  if (!('prev' in res.body)) throw new Error("缺少prev键");
}

.end(fn)

执行请求并调用fn(err, res)。

注释

灵感来自api-easy，但去除了vows耦合。

许可证

MIT