mocha是一个功能丰富的javascript测试框架,运行在node.js和浏览器中,使异步测试变得简单有趣。Mocha测试连续运行,允许灵活和准确的报告,同时将未捕获的异常映射到正确的测试用例。
参考:https://mochajs.cn/
http://t.zoukankan.com/Leo_wl-p-5734889.html
https://www.ruanyifeng.com/blog/2015/12/a-mocha-tutorial-of-examples.html
测试脚本的写法
测试框架的作用是运行测试脚本,首先必须学会写测试脚本。下面是一个加法模块add.js
的代码。
// add.js
function add(x, y) {
return x + y;
}
module.exports = add;
通常,单元测试脚本与所要测试的源码脚本同名。比如,add.js
的测试脚本名字就是add.test.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),表示一个单独的测试,是测试的最小单位。它也是一个函数,第一个参数是测试用例的名称("1 加 1 应该等于 2"),第二个参数是一个实际执行的函数。
断言库的用法
所谓"断言",就是判断源码的实际执行结果与预期结果是否一致,如果不一致就抛出一个错误。
例如:expect(add(1, 1)).to.be.equal(2);
所有的测试用例(it块)都应该含有一句或多句的断言。它是编写测试用例的关键。断言功能由断言库来实现,Mocha本身不带断言库,所以必须先引入断言库。var expect = require('chai').expect;
断言库有很多种,Mocha并不限制使用哪一种。上面代码引入的断言库是chai
,并且指定使用它的expect
断言风格。
expect
断言的优点是很接近自然语言,下面是一些例子。
// 相等或不相等
expect(4 + 5).to.be.equal(9);
expect(4 + 5).to.be.not.equal(10);
expect(foo).to.be.deep.equal({ bar: 'baz' });
// 布尔值为true
expect('everthing').to.be.ok;
expect(false).to.not.be.ok;
// typeof
expect('test').to.be.a('string');
expect({ foo: 'bar' }).to.be.an('object');
expect(foo).to.be.an.instanceof(Foo);
// include
expect([1,2,3]).to.include(2);
expect('foobar').to.contain('foo');
expect({ foo: 'bar', hello: 'universe' }).to.include.keys('foo');
// empty
expect([]).to.be.empty;
expect('').to.be.empty;
expect({}).to.be.empty;
// match
expect('foobar').to.match(/^foo/);
钩子函数
mocha提供4种钩子函数:before()、after()、beforeEach()、afterEach()
,这些钩子函数可以用来在用例集/用例函数开始执行之前/结束执行之后,进行一些环境准备或者环境清理的工作。
describe('hooks', function() {
before(function() {
// runs before all tests in this block
});
after(function() {
// runs after all tests in this block
});
beforeEach(function() {
// runs before each test in this block
});
afterEach(function() {
// runs after each test in this block
});
// test cases
});
钩子函数不仅能是同步函数,也可能是异步的函数,就像前边的异步测试用例函数一样。如果我们在开始之前,需要做一些异步的操作,例如在数据库里边准备一些模拟数据,就需要用到这种场景了:
describe('Connection', function() {
var db = new Connection,
tobi = new User('tobi'),
loki = new User('loki'),
jane = new User('jane');
beforeEach(function(done) {
db.clear(function(err) {
if (err) return done(err);
db.save([tobi, loki, jane], done);
});
});
前边讲的钩子函数都是定义在用例集函数里边的,如果在用例集函数之外定义钩子函数,那么这个钩子函数将会对所有的mocha单元测试用例生效。若编写了多个用例集js文件,无论在哪一个用例集文件中,用例集函数之外定义钩子函数,都会对所有用例函数生效。
前边讲到,用例集函数是可以嵌套的,而mocha会生成一个包在最外面的describe函数,把所有的用例集包含起来,那么在其中定义的钩子函数也就对所有的用例函数生效了~
beforeEach(function() {
console.log('before every test in every file');
});
mocha使用命令和参数
mocha命令的基本格式是:mocha [debug] [options] [files]
options包括下面这些:
-W, --WATCH
用例一旦更新立即执行
-B, --BAIL
如果只对第一个抛出的异常感兴趣,可以使用此命令。
-D, --DEBUG
开启nodejs的debug模式,可以在debugger语句处暂停执行。
--GLOBALS
names是一个以逗号分隔的列表,如果你的模块需要暴露出一些全局的变量,可以使用此命令,例如mocha --globals app,YUI。
这个命令还可以接受通配符,例如--globals '*bar。参数传入 * 的话,会忽略所有全局变量。--CHECK-LEAKS
默认情况下,mocha并不会去检查应用暴露出来的全局变量,加上这个配置后就会去检查,此时某全局变量如果没>有用上面的--GLOBALS去配置为可接受,mocha就会报错
-R, --REQUIRE
这个命令可以用来引入一些依赖的模块,比如should.js等,这个命令相当于在测试目录下每个js文件头部运行一下>require('should.js'),模块中对Object、Array等对象的扩展会生效,也可以用--require ./test/helper.js这样的命令去引>入指定的本地模块。
但是... 很鸡肋的是,如果要引用模块导出的对象,还是需要require,var should = require('should')这样搞。-R, --REPORTER
这个命令可以用来指定报告格式,默认是“spec”。可以使用第三方的报告样式,例如:
npm install mocha-lcov-reporter,--reporter mocha-lcov-reporter-T, --TIMEOUT
用来指定用例超时时间
-S, --SLOW
用来指定慢用例判定时间,默认是75ms
Mocha的脚本运行方法
有了测试脚本以后,就可以用Mocha运行它。
$ mocha add.test.js
加法函数的测试
✓ 1 加 1 应该等于 2
1 passing (8ms)
mocha命令后面紧跟测试脚本的路径和文件名,可以指定多个测试脚本。
$ mocha file1 file2 file3
Mocha默认运行test子目录里面的测试脚本。所以,一般都会把测试脚本放在test目录里面,然后执行mocha就不需要参数了。
$ mocha
加法函数的测试
✓ 1 加 1 应该等于 2
✓ 任何数加0应该等于自身
2 passing (9ms)