在学习nodejs的过程中经常看到Mocha,学习后写了下面这篇文章。
一.Mocha框架的简介
Mocha是现在流行的JavaScript测试框架之一,在浏览器和node环境都可以使用。官方文档在https://mochajs.org/,一个测试框架需要大概包含以下内容:
1.用于写测试用例的宏,属性或者函数。
2.断定库,用于测试是否可以通过。
3.辅助库,如hook库(测试前后调用某些函数或者方法),异常检查(某些函数在某些参数的情况下抛出异常), 输入组合(支持多排列的参数输入组合)等。
4.支持IDE的集成。
二.Mocha的具体使用
(1)写测试用例
Mocha的作用是运行测试脚本,“测试脚本”是用来测试源码的脚本。
下面是一个加法模块add.js
// add.js
function add(x, y) {
return x + y;
}
module.exports = add;
要测试一个模块是否正确需要写测试脚本。通常,测试脚本与所要测试的源码脚本同名,但是后缀名是.test.js(表示测试)或者.spec.js(表示规格)
// add.test.js
var add = require('./add.js');
var expect = require('chai').expect;
describe('加法函数的测试', function() {
it('1 加 1 应该等于 2', function() {
expect(add(1, 1)).to.be.equal(2);
});
});
上面这段代码就是测试脚本,他可以独立执行,测试脚本里应该包括一个或多个describe块,每个describe块应该包括一个或多个it块。
describe块称为“测试套件”(test suite),表示一组相关的测试。它是一个函数,第一个参数是测试套件的名称(“加法函数的测试”),第二个参数是一个实际执行的函数。
it块称为“测试用例(test case)”表示一个单独的测试,是测试的最小单位。他也是一个函数,第一个参数是测试用例的名称,第二个参数是一个实际执行的函数。
(2)断言库的用法
上面的测试脚本里面,有一句断言。
expect(add(1, 1)).to.be.equal(2);
所谓”断言”,就是判断源码的实际执行结果与预期结果是否一致,如果不一致就抛出一个错误。上面这句断言的意思是,调用add(1, 1),结果应该等于2。
所有的测试用例(it块)都应该含有一句或多句的断言。它是编写测试用例的关键。断言功能由断言库来实现,Mocha本身不带断言库,所以必须先引入断言库
var expect = require('chai').expect;
断言库有很多种,Mocha并不限制使用哪一种。上面代码引入的断言库是chai,并且指定使用它的expect断言风格。
参考其他的库:
1 should.js(https://github.com/shouldjs/should.js) BDD style shown throughout these docs (BDD模式,本文档用的都是这个断定库)
2 better-assert(https://github.com/tj/better-assert) c-style self-documenting assert()(C-模型下的断定库)
3 expect.js (https://github.com/Automattic/expect.js)expect() style assertions (expect模式的断定库)
4 unexpected(http://unexpected.js.org/) the extensible BDD assertion toolkit
5 chai(https://github.com/chaijs) expect(), assert() and should style assertions
(3)Mocha的基本用法
有了测试脚本以后,就可以用Mocha运行它。进入项目录,执行下面的命令:
$ mocha add.test.js
加法函数的测试
✓ 1 加 1 应该等于 2
1 passing (8ms)
上面的运行结果表示,测试脚本通过了测试,一共只有1个测试用例,耗时是8毫秒。
mocha命令后面紧跟测试脚本的路径和文件名,可以指定多个测试脚本。
$ mocha file1 file2 file3
Mocha默认运行test子目录里面的测试脚本。所以,一般都会把测试脚本放在test目录里面,然后执行mocha就不需要参数了。进入根目录,执行以下命令:
$ mocha
加法函数的测试
✓ 1 加 1 应该等于 2
✓ 任何数加0应该等于自身
2 passing (9ms)
注意:Mocha默认只执行test子目录下面第一层的测试用例,不会执行更下层的用例。为了改变这种行为,就必须加上–recursive参数,这时test子目录下面所有的测试用例—-不管在哪一层—-都会执行。
$ mocha --recursive
(4)配置文件mocha.opts
Mocha允许在test目录下面,放置配置文件mocha.opts,把命令行参数写在里面.进入根目录,执行下面的命令
$ mocha --recursive --reporter tap --growl
上面这个命令有三个参数–recursive、–reporter tap、–growl。
然后,把这三个参数写入test目录下的mocha.opts文件。
--reporter tap
--recursive
--growl
然后,执行mocha就能取得与第一行命令一样的效果。
$ mocha
如果测试用例不是存放在test子目录,可以在mocha.opts写入以下内容。
server-tests
--recursive
上面代码指定运行server-tests目录及其子目录之中的测试脚本。
(5)ES6测试
如果测试脚本是用ES6写的,那么运行测试之前,需要先用Babel转码。
安装Babel
$ npm install babel-core babel-preset-es2015 --save-dev
然后,在项目目录下面,新建一个.babelrc配置文件。
{
"presets": [ "es2015" ]
}
最后,使用–compilers参数指定测试脚本的转码器。
$ ../node_modules/mocha/bin/mocha --compilers js:babel-core/register
上面代码中,–compilers参数后面紧跟一个用冒号分隔的字符串,冒号左边是文件的后缀名,右边是用来处理这一类文件的模块名。上面代码表示,运行测试之前,先用babel-core/register模块,处理一下.js文件。由于这里的转码器安装在项目内,所以要使用项目内安装的Mocha;如果转码器安装在全局,就可以使用全局的Mocha。
下面是另外一个例子,使用Mocha测试CoffeeScript脚本。测试之前,先将.coffee文件转成.js文件。
$ mocha --compilers coffee:coffee-script/register
注意,Babel默认不会对Iterator、Generator、Promise、Map、Set等全局对象,以及一些全局对象的方法(比如Object.assign)转码。如果你想要对这些对象转码,就要安装babel-polyfill。
$ npm install babel-polyfill --save
然后,在你的脚本头部加上一行。
import 'babel-polyfill'
(6)异步测试
Mocha默认每个测试用例最多执行2000毫秒,如果到时没有得到结果,就报错。对于涉及异步操作的测试用例,这个时间往往是不够的,需要用-t或–timeout参数指定超时门槛。
//timeout.test.js
it('测试应该5000毫秒后结束', function(done) {
var x = true;
var f = function() {
x = false;
expect(x).to.be.not.ok;
done(); // 通知Mocha测试结束
};
setTimeout(f, 4000);
});
上面的测试用例,需要4000毫秒之后,才有运行结果。所以,需要用-t或–timeout参数,改变默认的超时设置。
$ mocha -t 5000 timeout.test.js
上面命令将测试的超时时限指定为5000毫秒。
另外,上面的测试用例里面,有一个done函数。it块执行的时候,传入一个done参数,当测试结束的时候,必须显式调用这个函数,告诉Mocha测试结束了。否则,Mocha就无法知道,测试是否结束,会一直等到超时报错
(7)测试用例的钩子
Mocha在describe块之中,提供测试用例的四个钩子:before()、after()、beforeEach()和afterEach()。它们会在指定时间执行。
describe('hooks', function() {
before(function() {
// 在本区块的所有测试用例之前执行
});
after(function() {
// 在本区块的所有测试用例之后执行
});
beforeEach(function() {
// 在本区块的每个测试用例之前执行
});
afterEach(function() {
// 在本区块的每个测试用例之后执行
});
// test cases
});