使用带有 Express Rest 的 Mocha 进行单元测试 API

Question

我正在学习单元测试。到目前为止，我能够运行像 "Add two numbers and test if they are above 0" 这样的简单测试，但我想使用 TDD 构建一个 REST API。到目前为止我有这个：

我的 routes/index.js 文件：

var express = require('express');
var router = express.Router();

/* GET home page. */
router.get('/', function (req, res, next) {
    res.send({val: true});
});

module.exports = router;

我的 index.test.js 文件：

var mocha = require('mocha');
var assert = require('chai').assert;
var index = require('../routes/index');

describe('Index methods', () => {
    it('Returns true', done => {
        index
            .get('http://localhost:3000')
            .end(function (res) {
                expect(res.status).to.equal(200);
                done();
            })
    })
});

我使用教程来执行此操作，但是当我尝试运行时，我得到：

TypeError: index.get(...).end is not a function

所以我猜是出了什么问题，但不知道是什么。这是我学习 TDD 的第一天，所以如果您发现任何愚蠢的事情请告诉我。

这样做：

it('Returns true', done => {
    var resp = index.get('http://localhost:3000/');
    assert.equal(resp.val === true);
    done();
})

也会导致错误：

AssertionError: expected false to equal undefined

Answer 1

const chai = require('chai');
const expect = require('chai').expect;
const chaiHttp = require('chai-http');
chai.use(chaiHttp);

首先安装 chai

it('Returns true', done => {
            return chai.request(index)
                .get('/')
                .then(function (res) {
                    expect(res.status).to.equal(200);
                    done();
                })
        })

Answer 2

var mocha = require('mocha');
var assert = require('chai').assert;
var index = require('./index');
var req = require('supertest');

describe('Index methods', () => {
    it('Returns true', done => {
        req(index)
            .get('/')
            .end(function (res) {
                expect(res.status).to.equal(200);
                done();
            })
    })
});

也在你的终端输入npm i supertest --save-dev

Answer 3

1。安装 mocha

的开发依赖

chai: 节点和浏览器的断言库，
chai-http：Chai 断言库的 HTTP 响应断言。

2。您需要导出服务器，

'use strict';
/*eslint no-console: ["error", { allow: ["warn", "error", "log"] }] */
const express = require('express');
const app = express();
//...
const config = require('config');

const port = process.env.PORT || config.PORT || 3000;

//....
app.listen(port);
console.log('Listening on port ' + port);

module.exports = app;

3。将您的测试写成：

如果您的测试脚本是 users.spec.js，它应该以：

// During the rest the en variable is set to test
/* global describe it beforeEach */
process.env.NODE_ENV = 'test';

const User = require('../app/models/user');

// Require the dev-dependencies
const chai = require('chai');
const chaiHttp = require('chai-http');

// You need to import your server
const server = require('../server');

const should = chai.should();
// Set up the chai Http assertion library
chai.use(chaiHttp);

// Your tests
describe('Users', () => {
    beforeEach((done) => {
        User.remove({}, (err) => {
            done();
        });
    });
    
    /**
     * Test the GET /api/users
     */
    describe('GET /api/users', () => {
        it('it should GET all the users', (done) => {
            chai.request(server)
                .get('/api/users')
                .end((err, res) => {
                    res.should.have.status(200);
                    res.body.should.be.a('array');
                    res.body.length.should.be.eql(0);
                    done();
                });
        });
    });
    // More test...
});

你可以看看我的仓库，Github - Book Store REST API

Answer 4

检查服务器是否运行的简单测试用例。

const chai = require('chai'),
chaiHttp = require('chai-http'),
server = require('../app'),
faker = require('faker'),
should = chai.should();

chai.use(chaiHttp);

describe('Init', function () {

it('check app status', function (done) {
  chai.request(server).get('/').end((err, res) => {
    should.not.exist(err);
    res.should.have.status(200);
    done();
  })
});

});

获取 API

的测试用例

describe('/Get API test', function () {

  it('Check the api without user id parameter', function (done) {
    chai.request(server).get('/post-list').end((err, res) => {
      should.not.exist(err);
      res.should.have.status(401);
      res.body.should.be.a('object');
      res.body.should.have.property('message');
      res.body.should.have.property('message').eql('User Id parameter is missing');
      done();
    })
  });

  it('Check the api with user id. Success', function (done) {
    chai.request(server).get('/post-list?user_id=1').end((err, res) => {
      should.not.exist(err);
      res.should.have.status(200);
      res.body.should.be.a('object');
      res.body.should.have.property('userId');
      res.body.should.have.property('title');
      res.body.should.have.property('body');
      done();
    })
  });

});

Post API

的测试用例

describe('/POST API test', function () {

  it('Check the api without parameters . failure case', function (done) {
    chai.request(server).post('/submit-data').send({}).end((err, res) => {
      should.not.exist(err);
      res.should.have.status(401);
      res.body.should.be.a('object');
      res.body.should.have.property('message');
      res.body.should.have.property('message').eql('Mandatory params are missing!');
      done();
    })
  });

  it('Check the API with valid parameters. Success', function (done) { 
    chai.request(server).post('/submit-data').send({name:faker.name.firstName(),email:faker.internet.email()}).end((err, res) => { 
      should.not.exist(err);
      res.should.have.status(200);
      res.body.should.be.a('object');
      res.body.should.have.property('message');
      res.body.should.have.property('message').eql('data saved successfully');
      done();
    })
  });

});

根据 API 中可用的不同用例添加测试用例。

在此处找到基本术语并完成示例应用程序以继续：https://medium.com/@pankaj.itdeveloper/basics-about-writing-tests-in-nodejs-api-application-4e17a1677834

使用带有 Express Rest 的 Mocha 进行单元测试 API

Unit testing using Mocha with Express Rest API

javascript

node.js

express

mocha.js

tdd

1。安装 mocha

2。您需要导出服务器，

3。将您的测试写成：