簡介
mocha是JavaScript的一種單元測試框架,既可以在瀏覽器環(huán)境下運(yùn)行,也可以在Node.js環(huán)境下運(yùn)行。使用mocha,我們就只需要專注于編寫單元測試本身,然后,讓mocha去自動(dòng)運(yùn)行所有的測試,并給出測試結(jié)果。
mocha的特點(diǎn)主要有:
既可以測試簡單的JavaScript函數(shù),又可以測試異步代碼,因?yàn)楫惒绞荍avaScript的特性之一;
可以自動(dòng)運(yùn)行所有測試,也可以只運(yùn)行特定的測試;
可以支持before、after、beforeEach 和 afterEach 來編寫初始化代碼。
Mocha 的安裝與配置
全局安裝Mocha
npm install -g mocha
項(xiàng)目中也安裝Mocha
npm install --save-dev mocha
在package.json中加入下面腳本:
"scripts": {
"test": "mocha"
}
Mocha 的使用
在使用前,我們先看一下我們用來使用的測試項(xiàng)目的結(jié)構(gòu):
如上圖所示,測試文件需要放在test目錄下,mocka運(yùn)行時(shí)會(huì)執(zhí)行test目錄下的所有js文件(僅限于test以下這一層級(jí),對(duì)test/subtest這一層級(jí)并不執(zhí)行)。
其中index.js為我們的被測試代碼:
/**
* 加法函數(shù)
* @param {第一個(gè)數(shù)} a
* @param {第二個(gè)數(shù)} b
*/
function addNum(a,b){
return a+b;
}
module.exports=addNum;
而index.test.js為我們的測試代碼(注意這里的命名加了一個(gè)test,并不是必須的,只是為了好區(qū)分哪些是測試文件):
var addNum=require('../src/index')
describe('測試index.js', function() {
describe('測試addNum函數(shù)', function() {
it('兩數(shù)相加結(jié)果為兩個(gè)數(shù)字的和', function() {
if(addNum(1,2)!==3){
throw new Error("兩數(shù)相加結(jié)果不為兩個(gè)數(shù)字的和");
}
});
});
});
解析一下以上代碼的語法:
測試腳本里面應(yīng)該包括一個(gè)或多個(gè)describe塊,每個(gè)describe塊應(yīng)該包括一個(gè)或多個(gè)it塊。
describe塊稱為"測試套件"(test suite),表示一組相關(guān)的測試。它是一個(gè)函數(shù),第一個(gè)參數(shù)是測試套件的名稱("測試index.js"),第二個(gè)參數(shù)是一個(gè)實(shí)際執(zhí)行的函數(shù)。
it塊稱為"測試用例"(test case),表示一個(gè)單獨(dú)的測試,是測試的最小單位。它也是一個(gè)函數(shù),第一個(gè)參數(shù)是測試用例的名稱("兩數(shù)相加結(jié)果為兩個(gè)數(shù)字的和"),第二個(gè)參數(shù)是一個(gè)實(shí)際執(zhí)行的函數(shù)。
在上面的例子中,測試addNum函數(shù),如果運(yùn)行錯(cuò)誤就拋出異常
此時(shí)運(yùn)行
npm test
就可得到以下結(jié)果
為了看一下運(yùn)行錯(cuò)誤的結(jié)果,此時(shí)我們修改index.js的代碼為:
function addNum(a,b){
return a+b-1;
}
module.exports=addNum;
再次運(yùn)行
npm test
結(jié)果如下:
Mocha與斷言庫chai
在上面的Mocha例子中,測試失敗用拋異常來處理,多少有點(diǎn)繁瑣,所以就有了斷言庫的出現(xiàn)。介紹一個(gè)常用的斷言庫chai??梢院唵卫斫鉃檫@就是對(duì)我們上面拋異常方法的一個(gè)封裝,當(dāng)判斷失敗時(shí)會(huì)拋出一個(gè)異常。
首先安裝chai:
npm install --save-dev chai
接著讓我們用chai修改一下上面的index.test.js:
var expect = require('chai').expect;
var addNum=require('../src/index')
describe('測試index.js', function() {
describe('測試addNum函數(shù)', function() {
it('兩數(shù)相加結(jié)果為兩個(gè)數(shù)字的和', function() {
expect(addNum(1,2)).to.be.equal(3);
});
});
});
上面的語法很接近自然語言,expect(期待)一個(gè)表達(dá)式的結(jié)果equal(等于)一個(gè)表達(dá)式。
運(yùn)行
npm test
得到以下結(jié)果:
可以看出圖中的斷言庫還打印出了期望的結(jié)果3和實(shí)際的結(jié)果2,如果用判斷來拋異常的話會(huì)繁瑣得多。
以上語法為chai的expect語法,它還有should語法和asset語法:
var assert = require('chai').assert;
assert.typeOf(foo, 'string');
assert.equal(foo, 'bar');
assert.lengthOf(foo, 3)
assert.property(tea, 'flavors');
assert.lengthOf(tea.flavors, 3);
Mocha的更多使用
如果想測試單一的測試js,可以用:
mocha test/index.test.js
或者多個(gè)js
mocha test/index.test.js test/add.test.js
也可以用通配符測試某個(gè)文件夾下所有的js和jsx:
mocha 'test/some/*.@(js|jsx)'
Mocha與ES6
在上面我們用的并非是ES6的語法,那么讓我們把其中的代碼都改為ES6的語法。
其中index.js為:
/**
* 加法函數(shù)
* @param {第一個(gè)數(shù)} a
* @param {第二個(gè)數(shù)} b
*/
export default (a,b)=>{
return a+b-1;
}
而index.test.js為:
import {assert} from 'chai'
import addNum from '../src/index'
describe('測試index.js',()=> {
describe('測試addNum函數(shù)', ()=> {
it('兩數(shù)相加結(jié)果為兩個(gè)數(shù)字的和', ()=> {
assert.equal(addNum(1,2),3)
})
})
})
此時(shí)直接運(yùn)行mock肯定是不行的,我們現(xiàn)需要安裝一下babel:
npm install babel-core babel-preset-es2015 --save-dev
然后,在項(xiàng)目目錄下面,新建一個(gè).babelrc文件:
{
"presets": [ "es2015" ]
}
接著講package.json中的腳本改為:
"scripts": {
"test": "mocha --compilers js:babel-core/register"
},
其中--compilers參數(shù)用來指定測試腳本的轉(zhuǎn)碼器,這行命令的意思是運(yùn)行mocha時(shí)先用babel-core/register模塊,處理一下.js文件
注意:--compilers將會(huì)在未來被移除,官方稱它是redundant(累贅的),而作為替代方案的是
"scripts": {
"test": "mocha --require babel-core/register"
},
命令變得更加簡單了
Mocha測試用例執(zhí)行的超時(shí)和高亮
Mocha默認(rèn)每個(gè)測試用例最多執(zhí)行2000毫秒,如果到時(shí)沒有得到結(jié)果,就報(bào)錯(cuò)。以下命令設(shè)置超時(shí)時(shí)間為5000:
mocha -t 5000 index.test.js
Mocha默認(rèn)會(huì)高亮顯示超過75毫秒的測試用例,以下命令設(shè)置高亮判斷的臨界值:
mocha -s 1000 index.test.js
Mocha測試的鉤子
Mocha在describe塊之中,提供測試用例的四個(gè)鉤子:before()、after()、beforeEach()和afterEach()。它們會(huì)在指定時(shí)間執(zhí)行。
describe('測試index.js',()=> {
before(()=>console.info("在本區(qū)塊的所有測試用例之前執(zhí)行"))
after(()=>console.info("在本區(qū)塊的所有測試用例之后執(zhí)行"))
beforeEach(()=>console.info("在本區(qū)塊的每個(gè)測試用例之前執(zhí)行"))
afterEach(()=>console.info("在本區(qū)塊的每個(gè)測試用例之后執(zhí)行"))
describe('測試addNum函數(shù)', ()=> {
it('兩數(shù)相加結(jié)果為兩個(gè)數(shù)字的和', ()=> {
assert.equal(addNum(1,2),3)
})
})
})