測試框架Mocha
現(xiàn)在流行的JavaScript測試框架之一现恼,在瀏覽器和Node環(huán)境中都可以使用叉袍。
一喳逛、安裝
我為本文寫了一個示例庫Mocha-demos棵里,請先安裝這個庫。
$ git clone https://github.com/ruanyf/mocha-demos.git
如果你的電腦沒裝Git典蝌,可以直接下載zip壓縮包骏掀,進行解壓。
然后笑陈,進入mocha-demos目錄,安裝依賴(你的電腦必須有Node)甲脏。
npm install
上面代碼會在目錄內部安裝Mocha,為了操作的方便娜氏,請在全面環(huán)境也安裝一下Mocha贸弥。
$ npm install --global mocha
二海渊、測試腳本的寫法
Mocha的作用是運行測試腳本臣疑,首先必須學會寫測試腳本。所謂"測試腳本"郁岩,就是用來測試源碼的腳本问慎。
add.js
function add(x,y){
return x+y;
}
module.exports=add;
測試腳本
add.test.js
var add=require('./add.js');
var expect=require('chai').expect;
describe('加法函數(shù)的測試',function(){
it('1+1=2',function(){
expect(add(1,1)).to.be.equal(2);
});
});
上面這段代碼挤茄,就是測試腳本穷劈,它可以獨立執(zhí)行。測試腳本里面應該包括一個或多個describe塊挖腰,每個describe塊應該包括一個或多個it塊猴仑。
describe塊稱為"測試套件"(test suite),表示一組相關的測試疾渣。它是一個函數(shù)榴捡,第一個參數(shù)是測試套件的名稱("加法函數(shù)的測試")朱浴,第二個參數(shù)是一個實際執(zhí)行的函數(shù)。
it塊稱為"測試用例"(test case)项乒,表示一個單獨的測試檀何,是測試的最小單位廷支。它也是一個函數(shù),第一個參數(shù)是測試用例的名稱("1 加 1 應該等于 2")砚殿,第二個參數(shù)是一個實際執(zhí)行的函數(shù)似炎。
三悯姊、斷言庫的用法
斷言:判斷源碼的實際執(zhí)行結果與預期結果是否一致悯许,如果不一致則拋出一個錯誤。
所有的測試用例(it塊)都應該含有一句或多句的斷言瘩扼。它是編寫測試用例的關鍵集绰。斷言功能由斷言庫來實現(xiàn)谆棺,Mocha本身不帶斷言庫,所以必須先引入斷言庫碍岔。
var expect=require('chai').expect;
斷言庫有很多種蔼啦,Mocha并不限制使用哪一種。上面的代碼引入的斷言庫是chai奈籽,并且指定使用它的expect斷言風格唠摹。
expect斷言的優(yōu)點是很接近自然語言奉瘤。
// 相等或不相等
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/);
基本上盗温,expect斷言的寫法都是一樣的成肘。頭部是expect方法双霍,尾部是斷言方法,比如equal,a/an,ok,match等染坯,兩者之間使用to或to.be連接单鹿。
四深纲、Mocha的基本用法
$ mocha add.test.js
加法函數(shù)的測試
? 1 加 1 應該等于 2
1 passing (8ms)
mocha命令后緊跟腳本的路徑和文件名,可以指定多個測試腳本儒喊。
$mocha file1 file2 file3
Mocha默認運行test子目錄里面的測試腳本澄惊,所以,一般都會把測試腳本放到test目錄里面肛搬,然后執(zhí)行mocha就不需要參數(shù)了温赔。
這時可以看到鬼癣,test子目錄里面的測試腳本執(zhí)行了。但是拜秧,你打開test子目錄枉氮,會發(fā)現(xiàn)下面還有一個test/dir子目錄暖庄,里面還有一個測試腳本multiply.test.js培廓,并沒有得到執(zhí)行。原來泣港,Mocha默認只執(zhí)行test子目錄下面第一層的測試用例当纱,不會執(zhí)行更下層的用例霞怀。
為了改變這種行為,就必須加上--recursive參數(shù)廉沮,這時test子目錄下面所有的測試用例----不管在哪一層----都會執(zhí)行滞时。
$ mocha --recursive//回歸的滤灯,遞歸的
五曼玩、通配符
命令行指定測試腳本時黍判,可以使用通配符顷帖,同時指定多個文件渤滞。
mocha test/unit/*.js
六妄呕、命令行參數(shù)
除了前面介紹的--recursive,Mocha還可以加上其他命令行參數(shù)绪励。
6.1 --help, -h
--help或-h參數(shù)优炬,用來查看Mocha的所有命令行參數(shù)厅贪。
6.2 --reporter, -R
--reporter參數(shù)用來指定測試報告的格式,默認是spec格式葵硕。
6.3 --growl, -G
打開--growl參數(shù)贯吓,就會將測試結果在桌面顯示。
6.4 --watch介评,-w
--watch參數(shù)用來監(jiān)視指定的測試腳本爬舰。只要測試腳本有變化情屹,就會自動運行Mocha。
$ mocha --watch
上面命令執(zhí)行以后椅文,并不會退出。你可以另外打開一個終端窗口皆刺,修改test目錄下面的測試腳本add.test.js,比如刪除一個測試用例毒坛,一旦保存煎殷,Mocha就會再次自動運行腿箩。
6.6 --grep, -g
--grep參數(shù)用于搜索測試用例的名稱(即it塊的第一個參數(shù)),然后只執(zhí)行匹配的測試用例弓乙。
$ mocha --grep "1 加 1"
上面代碼只測試名稱中包含"1 加 1"的測試用例暇韧。
6.7 --invert, -i
--invert參數(shù)表示只運行不符合條件的測試腳本浓瞪,必須與--grep參數(shù)配合使用。
$ mocha --grep "1 加 1" --invert
七涂乌,配置文件mocha.opts
Mocha允許在test目錄下面英岭,放置配置文件mocha.opts诅妹,把命令行參數(shù)寫在里面。請先進入demo03目錄尖殃,運行下面的命令赵刑。
$ mocha --recursive --reporter tap --growl
上面這個命令有三個參數(shù)--recursive般此、--reporter tap牵现、--growl瞎疼。
然后壁畸,把這三個參數(shù)寫入test目錄下的mocha.opts文件捏萍。
--reporter tap
--recursive
--growl
然后,執(zhí)行mocha就能取得與第一行命令一樣的效果令杈。
$ mocha
如果測試用例不是存放在test子目錄逗噩,可以在mocha.opts寫入以下內容异雁。
server-tests
--recursive
上面代碼指定運行server-tests目錄及其子目錄之中的測試腳本。
八纲刀、ES6測試
如果測試腳本是用ES6寫的,那么運行測試之前芥挣,需要先用Babel轉碼耻台。
test/add.test.js
import add from '../src/add.js';
import chai from 'chai';
let expect = chai.expect;
describe('加法函數(shù)的測試', function() {
it('1 加 1 應該等于 2', function() {
expect(add(1, 1)).to.be.equal(2);
});
});
ES6轉碼盆耽,需要安裝Babel摄杂。
$ npm install babel-core babel-preset-es2015 --save-dev
然后循榆,在項目目錄下面,新建一個.babelrc配置文件映挂。
{
"presets": [ "es2015" ]
}
最后,使用--compilers參數(shù)指定測試腳本的轉碼器帽撑。
$ ../node_modules/mocha/bin/mocha --compilers js:babel-core/register
上面代碼中鞍时,--compilers參數(shù)后面緊跟一個用冒號分隔的字符串逆巍,冒號左邊是文件的后綴名锐极,右邊是用來處理這一類文件的模塊名。上面代碼表示味咳,運行測試之前槽驶,先用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'
九、異步測試
Mocha默認每個測試用例最多執(zhí)行2000毫秒疗隶,如果到時沒有得到結果,就報錯翼闹。對于涉及異步操作的測試用例斑鼻,這個時間往往是不夠的,需要用-t或--timeout參數(shù)指定超時門檻猎荠。
進入demo05子目錄坚弱,打開測試腳本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參數(shù)些楣,改變默認的超時設置。
$ mocha -t 5000 timeout.test.js
上面命令將測試的超時時限指定為5000毫秒。
另外嘶居,上面的測試用例里面,有一個done函數(shù)樱报。it塊執(zhí)行的時候,傳入一個done參數(shù)盗飒,當測試結束的時候,必須顯式調用這個函數(shù),告訴Mocha測試結束了痕囱。否則,Mocha就無法知道弦悉,測試是否結束,會一直等到超時報錯污秆。你可以把這行刪除試試看疾层。
Mocha默認會高亮顯示超過75毫秒的測試用例予弧,可以用-s或--slow調整這個參數(shù)井厌。
$ mocha -t 5000 -s 1000 timeout.test.js
上面命令指定高亮顯示耗時超過1000毫秒的測試用例器赞。
下面是另外一個異步測試的例子async.test.js。
it('異步請求應該返回一個對象', function(done){
request
.get('https://api.github.com')
.end(function(err, res){
expect(res).to.be.an('object');
done();
});
});
運行下面命令,可以看到這個測試會通過畔柔。
$ mocha -t 10000 async.test.js
另外肠槽,Mocha內置對Promise的支持嘴拢,允許直接返回Promise赌结,等到它的狀態(tài)改變庄涡,再執(zhí)行斷言,而不用顯式調用done方法忧风。請看promise.test.js呕诉。
it('異步請求應該返回一個對象', function() {
return fetch('https://api.github.com')
.then(function(res) {
return res.json();
}).then(function(json) {
expect(json).to.be.an('object');
});
});
十、測試用例的鉤子
Mocha在describe塊之中夜畴,提供測試用例的四個鉤子:before()央碟、after()菱涤、beforeEach()和afterEach()。它們會在指定時間執(zhí)行。
describe('hooks', function() {
before(function() {
// 在本區(qū)塊的所有測試用例之前執(zhí)行
});
after(function() {
// 在本區(qū)塊的所有測試用例之后執(zhí)行
});
beforeEach(function() {
// 在本區(qū)塊的每個測試用例之前執(zhí)行
});
afterEach(function() {
// 在本區(qū)塊的每個測試用例之后執(zhí)行
});
// test cases
});
進入demo06子目錄摘符,可以看到下面兩個例子蠢古。首先是beforeEach的例子beforeEach.test.js。
// beforeEach.test.js
describe('beforeEach示例', function() {
var foo = false;
beforeEach(function() {
foo = true;
});
it('修改全局變量應該成功', function() {
expect(foo).to.be.equal(true);
});
});
上面代碼中,beforeEach會在it之前執(zhí)行,所以會修改全局變量。
另一個例子beforeEach-async.test.js則是演示,如何在beforeEach之中使用異步操作。
// beforeEach-async.test.js
describe('異步 beforeEach 示例', function() {
var foo = false;
beforeEach(function(done) {
setTimeout(function() {
foo = true;
done();
}, 50);
});
it('全局變量異步修改應該成功', function() {
expect(foo).to.be.equal(true);
});
});
十一、測試用例管理
大型項目有很多測試用例。有時漓拾,我們希望只運行其中的幾個,這時可以用only方法。describe塊和it塊都允許調用only方法,表示只運行某個測試套件或測試用例。
進入demo07子目錄,測試腳本test/add.test.js就使用了only秆吵。
it.only('1 加 1 應該等于 2', function() {
expect(add(1, 1)).to.be.equal(2);
});
it('任何數(shù)加0應該等于自身', function() {
expect(add(1, 0)).to.be.equal(1);
});
上面代碼中烈疚,只有帶有only方法的測試用例會運行。
$ mocha test/add.test.js
加法函數(shù)的測試
? 1 加 1 應該等于 2
1 passing (10ms)
此外,還有skip方法,表示跳過指定的測試套件或測試用例。
it.skip('任何數(shù)加0應該等于自身', function() {
expect(add(1, 0)).to.be.equal(1);
});
上面代碼的這個測試用例不會執(zhí)行度液。
http://www.ruanyifeng.com/blog/2015/12/a-mocha-tutorial-of-examples.html
npm install --save-dev chai