单元测试
如果你听说过“测试驱动开发”(TDD:Test-Driven Development),单元测试就不陌生。
单元测试是用来对一个模块、一个函数或者一个类来进行正确性检验的测试工作。
比如对函数abs(),我们可以编写出以下几个测试用例:
输入正数,比如1、1.2、0.99,期待返回值与输入相同;
输入负数,比如-1、-1.2、-0.99,期待返回值与输入相反;
输入0,期待返回0;
输入非数值类型,比如null、[]、{},期待抛出Error。
把上面的测试用例放到一个测试模块里,就是一个完整的单元测试。
如果单元测试通过,说明我们测试的这个函数能够正常工作。如果单元测试不通过,要么函数有bug,要么测试条件输入不正确,总之,需要修复使单元测试能够通过。
单元测试通过后有什么意义呢?如果我们对abs()函数代码做了修改,只需要再跑一遍单元测试,如果通过,说明我们的修改不会对abs()函数原有的行为造成影响,如果测试不通过,说明我们的修改与原有行为不一致,要么修改代码,要么修改测试。
这种以测试为驱动的开发模式最大的好处就是确保一个程序模块的行为符合我们设计的测试用例。在将来修改的时候,可以极大程度地保证该模块行为仍然是正确的。
mocha
单独写一个test.js的缺点是没法自动运行测试,而且,如果第一个assert报错,后面的测试也执行不了了。
mocha是JavaScript的一种单元测试框架,既可以在浏览器环境下运行,也可以在Node.js环境下运行。官方文档:https://mochajs.org/
使用mocha,我们就只需要专注于编写单元测试本身,然后,让mocha去自动运行所有的测试,并给出测试结果。
mocha的特点主要有:
既可以测试简单的JavaScript函数,又可以测试异步代码,因为异步是JavaScript的特性之一;
可以自动运行所有测试,也可以只运行特定的测试;
可以支持before、after、beforeEach和afterEach来编写初始化代码。
我们会详细讲解如何使用mocha编写自动化测试,以及如何测试异步代码。
安装
npm install -g mocha
工程结构
hello-test/
|
+- .vscode/
| |
| +- launch.json <– VSCode 配置文件
|
+- hello.js <– 待测试js文件
|
+- test/ <– 存放所有test
| |
| +- hello-test.js <– 测试文件
|
+- package.json <– 项目描述文件
|
+- node_modules/ <– npm安装的所有依赖包
其中,被测试文件:
// hello.js
module.exports = function (...rest) {
var sum = 0;
for (let n of rest) {
sum += n;
}
return sum;
};
测试文件:
// hello-test.js
const assert = require('assert'); //node自带的断言库
const sum = require('../hello'); //需要测试的模块
// 测试hello模块中的sum函数
describe('#hello.js', () => {
describe('#sum()', () => {
it('sum() should return 0', () => {
assert.strictEqual(sum(), 0);
});
it('sum(1) should return 1', () => {
assert.strictEqual(sum(1), 1);
});
it('sum(1, 2) should return 3', () => {
assert.strictEqual(sum(1, 2), 3);
});
it('sum(1, 2, 3) should return 6', () => {
assert.strictEqual(sum(1, 2, 3), 6);
});
});
});
describe和it
断定库(BDD - style):
判定测试用例是否通过,默认下可以用nodejs的assert库,与此同时,Mocha支持我们使用不同的断定库,现在可以支持下面的断定库,每个断定库的用法有一些差异,自己可以参考相应的文档。
- should.js(https://github.com/shouldjs/should.js) BDD style shown throughout these docs (BDD模式,本文档用的都是这个断定库)
describe
声明了一个测试集合(TestSuit),且可以嵌套管理,it
声明定义了一个具体的测试用例。describe可以任意嵌套,以便把相关测试看成一组测试。
运行mocha测试的三种方法
1、 可以打开命令提示符,切换到hello-test目录,然后执行命令:
C:\...\hello-test> node_modules\mocha\bin\mocha
mocha就会自动执行test文件夹下的所有测试,然后输出如下:
#hello.js
#sum()
✓ sum() should return 0
✓ sum(1) should return 1
✓ sum(1, 2) should return 3
✓ sum(1, 2, 3) should return 6
4 passing (7ms)
2、 在package.json中添加npm命令:
{
...
"scripts": {
"test": "mocha"
},
...
}
然后在hello-test目录下执行命令:
C:\...\hello-test> npm test
可以得到和上面一样的输出。这种方式通过npm执行命令,输入的命令比较简单。
3、 在VS code 中创建配置文件.vscode/launch.json
,然后编写两个配置选项:
{
"version": "0.2.0",
"configurations": [
{
"name": "Run",
"type": "node",
"request": "launch",
"program": "${workspaceRoot}/hello.js",
"stopOnEntry": false,
"args": [],
"cwd": "${workspaceRoot}",
"preLaunchTask": null,
"runtimeExecutable": null,
"runtimeArgs": [
"--nolazy"
],
"env": {
"NODE_ENV": "development"
},
"externalConsole": false,
"sourceMaps": false,
"outDir": null
},
{
"name": "Test",
"type": "node",
"request": "launch",
"program": "${workspaceRoot}/node_modules/mocha/bin/mocha",
"stopOnEntry": false,
"args": [],
"cwd": "${workspaceRoot}",
"preLaunchTask": null,
"runtimeExecutable": null,
"runtimeArgs": [
"--nolazy"
],
"env": {
"NODE_ENV": "test"
},
"externalConsole": false,
"sourceMaps": false,
"outDir": null
}
]
}
before和after
在测试前初始化资源,测试后释放资源是非常常见的。mocha提供了before、after、beforeEach和afterEach来实现这些功能。
我们把hello-test.js改为:
const assert = require('assert');
const sum = require('../hello');
describe('#hello.js', () => {
describe('#sum()', () => {
before(function () {
console.log('before:');
});
after(function () {
console.log('after.');
});
beforeEach(function () {
console.log(' beforeEach:');
});
afterEach(function () {
console.log(' afterEach.');
});
it('sum() should return 0', () => {
assert.strictEqual(sum(), 0);
});
it('sum(1) should return 1', () => {
assert.strictEqual(sum(1), 1);
});
it('sum(1, 2) should return 3', () => {
assert.strictEqual(sum(1, 2), 3);
});
it('sum(1, 2, 3) should return 6', () => {
assert.strictEqual(sum(1, 2, 3), 6);
});
});
});
再次运行,可以看到每个test执行前后会分别执行beforeEach()
和afterEach()
,以及一组test执行前后会分别执行before()
和after()
:
#hello.js
#sum()
before:
beforeEach:
✓ sum() should return 0
afterEach.
beforeEach:
✓ sum(1) should return 1
afterEach.
beforeEach:
✓ sum(1, 2) should return 3
afterEach.
beforeEach:
✓ sum(1, 2, 3) should return 6
afterEach.
after.
4 passing (8ms)
异步测试
如何测试异步函数(带async
的函数)?
如果要测试同步函数,我们传入无参数函数即可:
it('test sync function', function () {
// TODO:
assert(true);
});
如果要测试异步函数,我们要传入的函数需要带一个参数,通常命名为done
:
it('test async function', function (done) {
fs.readFile('filepath', function (err, data) {
if (err) {
done(err);
} else {
done();
}
});
});
测试异步函数需要在函数内部手动调用done()
表示测试成功,done(err)
表示测试出错。
对于用ES7的async编写的函数,我们可以这么写:
it('#async with done', (done) => {
(async function () {
try {
let r = await hello();
assert.strictEqual(r, 15);
done();
} catch (err) {
done(err);
}
})();
});
重点在这里:::::测试!!!
还有一种更简单的写法,就是直接把async函数当成同步函数来测试:
it('#async function', async () => {
let r = await hello();
assert.strictEqual(r, 15);
});