单元测试涵义
单元测试是用来对一个模块、一个函数或者一个类来进行正确性检验的测试工作
单元测试举例——
比如对函数abs(),我们可以编写出以下几个测试用例:
- 输入正数,比如1、1.2、0.99,期待返回值与输入相同;
- 输入负数,比如-1、-1.2、-0.99,期待返回值与输入相反;
- 输入0,期待返回0;
- 输入非数值类型,比如null、[]、{},期待抛出Error。
把上面的测试用例放到一个测试模块里,就是一个完整的单元测试
如果单元测试通过,说明我们测试的这个函数能够正常工作。如果单元测试不通过,要么函数有bug,要么测试条件输入不正确,总之,需要修复使单元测试能够通过
单元测试的意义——
如果我们对abs()函数代码做了修改,只需要再跑一遍单元测试,如果通过,说明我们的修改不会对abs()函数原有的行为造成影响,如果测试不通过,说明我们的修改与原有行为不一致,要么修改代码,要么修改测试
mocha
mocha是JavaScript的一种单元测试框架,既可以在浏览器环境下运行,也可以在Node.js环境下运行
使用mocha,我们就只需要专注于编写单元测试本身,然后让mocha去自动运行所有的测试,并给出测试结果
mocha的主要特点:
既可以测试简单的JavaScript函数,又可以测试异步代码,因为异步是JavaScript的特性之一;
可以自动运行所有测试,也可以只运行特定的测试;
可以支持before、after、beforeEach和afterEach来编写初始化代码
安装
方式一:
使用npm全局安装
npm install --global mocha
方式二:
作为项目的依赖进行安装
npm install --save-dev mocha
断言
Mocha允许用户使用任意喜欢的断言库
Node.js内置了assert模块用来进行断言
assert模块断言一个表达式为true,如果断言失败就抛出Error
单独写一个测试的缺点是没法自动运行测试,而且,如果有多个assert断言,那么当第一个assert报错了,后面的测试将不会被执行(执行不了)
例子如下:
const assert = require('assert');
const sum = require('./hello');
assert.strictEqual(sum(), 0);
assert.strictEqual(sum(1), 1);
assert.strictEqual(sum(1, 2), 3);
assert.strictEqual(sum(1, 2, 3), 6);
如果有很多测试需要运行,就必须把这些测试全部组织起来,然后统一执行,并且得到执行结果。这就是我们为什么要用mocha来编写并运行测试
尝试例子及使用方法
例子
Getting Started
$ npm install mocha
$ mkdir test
$ $EDITOR test/test.js # or open with your favorite editor
test.js:
var assert = require('assert');
describe('Array', function() {
describe('#indexOf()', function() {
it('should return -1 when the value is not present', function() {
assert.equal([1, 2, 3].indexOf(4), -1);
});
});
});
使用方法
方法一:
打开cmd,并切换路径到当前js文件目录
运行命令行:./node_modules/mocha/bin/mocha
结果显示:
$ ./node_modules/mocha/bin/mocha
Array
#indexOf()
✓ should return -1 when the value is not present
1 passing (9ms)
方法二:
设置package.json
"scripts": {
"test": "mocha"
}
运行命令行
npm test
同步代码
mocha测试同步函数,只需要在it()
方法中传入无参数函数就可以了
it('test sync function', function () {
// TODO:
assert(true);
});
异步代码
可以使用mocha测试异步代码,而且很简单——只需要在测试完成的时候调用一下回调函数即可
通过添加一个回调函数(通常命名为done)给it()
方法,Mocha就会知道它应该等这个回调函数被调用的时候才能完成测试
describe('User', function() {
describe('#save()', function() {
it('should save without error', function() {
var user = new User('Luna')
user.save(function(err) {
if(err) done(err);
else done()
}//回调函数)
})
})
})
由于done()
函数接受一个err,所以可以采用更加简单的方法测试异步代码
describe('User', function() {
describe('#save()', function() {
it('should save without error', function(done) {
var user = new User('Luna')
user.save(done)
})
})
})
it('test async function', function (done) {
fs.readFile('filepath', function (err, data) {
if (err) {
done(err);
} else {
done();
}
});
});
测试异步函数需要在函数内部手动调用done()表示测试成功,done(err)表示测试出错
钩子函数Hooks
由于默认使用BDD风格的接口,Mocha提供了一些钩子函数:before(),after(),beforeEach()和afterEach()。这些钩子函数可以用于设置测试的先决条件或者对测试进行清理
describe('hooks', function() {
before(function() {
// 在这个区块内的所有测试之前运行
})
after(function () {
// 在这个区块内的所有测试之后运行
})
beforeEach(function () {
// 在这个区块内的每个测试运行之前运行
})
afterEach(function () {
// 在这个区块内的每个测试之后运行
})
})
测试可以出现在before,after或者和你的钩子函数交替出现。钩子函数会按照它们被定义的顺序运行。一般就是,before()(只运行一次)->beforeEach()->afterEach()->after()(只运行一次)
使用async/await
如果你的js运行环境支持async/await,也可以像下面这样写异步测试
beforeEach(async function() {
await db.clear();
await db.save([tobi, loki, jane]);
});
//每一个测试前都会调用beforeEach()内规定的方法
describe('#find()', function() {
it('responds with matching records', async function() {
const users = await db.find({ type: 'User' });
users.should.have.length(3);
});
});
箭头函数=>
由于this的词法作用域的问题,箭头函数是不能够访问mocha的上下文的,所以向Mocha传递箭头函数是不好的
例如,由于箭头函数本身的机制,下面的代码会失败
describe('my suite', () => {
it('my test', () => {
// should set the timeout of this test to 1000 ms; instead will fail
this.timeout(1000);
assert.ok(true);
});
});
如果你不需要使用mocha的上下文,可以使用箭头函数。然而,如果你以后需要使用这个上下文的话,重构会变得十分困难