測(cè)試框架 Mocha 實(shí)例教程

作者： 阮一峰

日期： 2015年12月 3日

Mocha（發(fā)音"摩卡"）誕生于2011年，是現(xiàn)在最流行的javaScript測(cè)試框架之一，在瀏覽器和Node環(huán)境都可以使用。

所謂"測(cè)試框架"，就是運(yùn)行測(cè)試的工具。通過它，可以為Javascript應(yīng)用添加測(cè)試，從而保證代碼的質(zhì)量。

本文全面介紹如何使用Mocha，讓你輕松上手。如果你以前對(duì)測(cè)試一無所知，本文也可以當(dāng)作JavaScript單元測(cè)試入門。值得說明的是，除了Mocha以外，類似的測(cè)試框架還有Jasmine、Karma、Tape等，也很值得學(xué)習(xí)。

一、安裝

我為本文寫了一個(gè)示例庫(kù)Mocha-demos，請(qǐng)先安裝這個(gè)庫(kù)。

$ git clone https://github.com/ruanyf/mocha-demos.git

如果你的電腦沒裝Git，可以直接下載zip壓縮包，進(jìn)行解壓。

然后，進(jìn)入mocha-demos目錄，安裝依賴（你的電腦必須有Node）。

$ cd mocha-demos$ npm install

上面代碼會(huì)在目錄內(nèi)部安裝Mocha，為了操作的方便，請(qǐng)?jiān)谌姝h(huán)境也安裝一下Mocha。

$ npm install --global mocha

二、測(cè)試腳本的寫法

Mocha的作用是運(yùn)行測(cè)試腳本，首先必須學(xué)會(huì)寫測(cè)試腳本。所謂"測(cè)試腳本"，就是用來測(cè)試源碼的腳本。

下面是一個(gè)加法模塊add.js的代碼。

// add.jsfunction add(x, y) { return x + y;}module.exports = add;

要測(cè)試這個(gè)加法模塊是否正確，就要寫測(cè)試腳本。

通常，測(cè)試腳本與所要測(cè)試的源碼腳本同名，但是后綴名為.test.js（表示測(cè)試）或者.spec.js（表示規(guī)格）。比如，add.js的測(cè)試腳本名字就是add.test.js。

// add.test.jsvar add = require('./add.js');var expect = require('chai').expect;describe('加法函數(shù)的測(cè)試', function() { it('1 加 1 應(yīng)該等于 2', function() { expect(add(1, 1)).to.be.equal(2); });});

上面這段代碼，就是測(cè)試腳本，它可以獨(dú)立執(zhí)行。測(cè)試腳本里面應(yīng)該包括一個(gè)或多個(gè)describe塊，每個(gè)describe塊應(yīng)該包括一個(gè)或多個(gè)it塊。

describe塊稱為"測(cè)試套件"（test suite），表示一組相關(guān)的測(cè)試。它是一個(gè)函數(shù)，第一個(gè)參數(shù)是測(cè)試套件的名稱（"加法函數(shù)的測(cè)試"），第二個(gè)參數(shù)是一個(gè)實(shí)際執(zhí)行的函數(shù)。

it塊稱為"測(cè)試用例"（test case），表示一個(gè)單獨(dú)的測(cè)試，是測(cè)試的最小單位。它也是一個(gè)函數(shù)，第一個(gè)參數(shù)是測(cè)試用例的名稱（"1 加 1 應(yīng)該等于 2"），第二個(gè)參數(shù)是一個(gè)實(shí)際執(zhí)行的函數(shù)。

三、斷言庫(kù)的用法

上面的測(cè)試腳本里面，有一句斷言。

expect(add(1, 1)).to.be.equal(2);

所謂"斷言"，就是判斷源碼的實(shí)際執(zhí)行結(jié)果與預(yù)期結(jié)果是否一致，如果不一致就拋出一個(gè)錯(cuò)誤。上面這句斷言的意思是，調(diào)用add(1, 1)，結(jié)果應(yīng)該等于2。

所有的測(cè)試用例（it塊）都應(yīng)該含有一句或多句的斷言。它是編寫測(cè)試用例的關(guān)鍵。斷言功能由斷言庫(kù)來實(shí)現(xiàn)，Mocha本身不帶斷言庫(kù)，所以必須先引入斷言庫(kù)。

var expect = require('chai').expect;

斷言庫(kù)有很多種，Mocha并不限制使用哪一種。上面代碼引入的斷言庫(kù)是chai，并且指定使用它的expect斷言風(fēng)格。

expect斷言的優(yōu)點(diǎn)是很接近自然語言，下面是一些例子。

// 相等或不相等expect(4 + 5).to.be.equal(9);expect(4 + 5).to.be.not.equal(10);expect(foo).to.be.deep.equal({ bar: 'baz' });// 布爾值為trueexpect('everthing').to.be.ok;expect(false).to.not.be.ok;// typeofexpect('test').to.be.a('string');expect({ foo: 'bar' }).to.be.an('object');expect(foo).to.be.an.instanceof(Foo);// includeexpect([1,2,3]).to.include(2);expect('foobar').to.contain('foo');expect({ foo: 'bar', hello: 'universe' }).to.include.keys('foo');// emptyexpect([]).to.be.empty;expect('').to.be.empty;expect({}).to.be.empty;// matchexpect('foobar').to.match(/^foo/);

基本上，expect斷言的寫法都是一樣的。頭部是expect方法，尾部是斷言方法，比如equal、a/an、ok、match等。兩者之間使用to或to.be連接。

如果expect斷言不成立，就會(huì)拋出一個(gè)錯(cuò)誤。事實(shí)上，只要不拋出錯(cuò)誤，測(cè)試用例就算通過。

it('1 加 1 應(yīng)該等于 2', function() {});

上面的這個(gè)測(cè)試用例，內(nèi)部沒有任何代碼，由于沒有拋出了錯(cuò)誤，所以還是會(huì)通過。

四、Mocha的基本用法

有了測(cè)試腳本以后，就可以用Mocha運(yùn)行它。請(qǐng)進(jìn)入demo01子目錄，執(zhí)行下面的命令。

$ mocha add.test.js 加法函數(shù)的測(cè)試 ? 1 加 1 應(yīng)該等于 2 1 passing (8ms)

上面的運(yùn)行結(jié)果表示，測(cè)試腳本通過了測(cè)試，一共只有1個(gè)測(cè)試用例，耗時(shí)是8毫秒。

mocha命令后面緊跟測(cè)試腳本的路徑和文件名，可以指定多個(gè)測(cè)試腳本。

$ mocha file1 file2 file3

Mocha默認(rèn)運(yùn)行test子目錄里面的測(cè)試腳本。所以，一般都會(huì)把測(cè)試腳本放在test目錄里面，然后執(zhí)行mocha就不需要參數(shù)了。請(qǐng)進(jìn)入demo02子目錄，運(yùn)行下面的命令。

$ mocha 加法函數(shù)的測(cè)試 ? 1 加 1 應(yīng)該等于 2 ? 任何數(shù)加0應(yīng)該等于自身 2 passing (9ms)

這時(shí)可以看到，test子目錄里面的測(cè)試腳本執(zhí)行了。但是，你打開test子目錄，會(huì)發(fā)現(xiàn)下面還有一個(gè)test/dir子目錄，里面還有一個(gè)測(cè)試腳本multiply.test.js，并沒有得到執(zhí)行。原來，Mocha默認(rèn)只執(zhí)行test子目錄下面第一層的測(cè)試用例，不會(huì)執(zhí)行更下層的用例。

為了改變這種行為，就必須加上--recursive參數(shù)，這時(shí)test子目錄下面所有的測(cè)試用例----不管在哪一層----都會(huì)執(zhí)行。

$ mocha --recursive 加法函數(shù)的測(cè)試 ? 1 加 1 應(yīng)該等于 2 ? 任何數(shù)加0應(yīng)該等于自身 乘法函數(shù)的測(cè)試 ? 1 乘 1 應(yīng)該等于 1 3 passing (9ms)

五、通配符

命令行指定測(cè)試腳本時(shí)，可以使用通配符，同時(shí)指定多個(gè)文件。

$ mocha spec/{my,awesome}.js$ mocha test/unit/*.js

上面的第一行命令，指定執(zhí)行spec目錄下面的my.js和awesome.js。第二行命令，指定執(zhí)行test/unit目錄下面的所有js文件。

除了使用Shell通配符，還可以使用Node通配符。

$ mocha 'test/**/*.@(js|jsx)'

上面代碼指定運(yùn)行test目錄下面任何子目錄中、文件后綴名為js或jsx的測(cè)試腳本。注意，Node的通配符要放在單引號(hào)之中，否則星號(hào)（*）會(huì)先被Shell解釋。

上面這行Node通配符，如果改用Shell通配符，要寫成下面這樣。

$ mocha test/{,**/}*.{js,jsx}

六、命令行參數(shù)

除了前面介紹的--recursive，Mocha還可以加上其他命令行參數(shù)。請(qǐng)?jiān)?code style="margin: auto 3px; padding: 0px 5px; list-style-type: none; border: none; color: rgb(17, 17, 17); display: inline-block; font-size: 15.6px; background-color: pink; border-radius: 5px; transition: all 1s;">demo02子目錄里面，運(yùn)行下面的命令，查看效果。

6.1 --help, -h

--help或-h參數(shù)，用來查看Mocha的所有命令行參數(shù)。

$ mocha --help

6.2 --reporter, -R

--reporter參數(shù)用來指定測(cè)試報(bào)告的格式，默認(rèn)是spec格式。

$ mocha# 等同于$ mocha --reporter spec

除了spec格式，官方網(wǎng)站還提供了其他許多報(bào)告格式。

$ mocha --reporter tap1..2ok 1 加法函數(shù)的測(cè)試 1 加 1 應(yīng)該等于 2ok 2 加法函數(shù)的測(cè)試 任何數(shù)加0應(yīng)該等于自身# tests 2# pass 2# fail 0

上面是tap格式報(bào)告的顯示結(jié)果。

--reporters參數(shù)可以顯示所有內(nèi)置的報(bào)告格式。

$ mocha --reporters

使用mochawesome模塊，可以生成漂亮的HTML格式的報(bào)告。

$ npm install --save-dev mochawesome$ ../node_modules/.bin/mocha --reporter mochawesome

上面代碼中，mocha命令使用了項(xiàng)目?jī)?nèi)安裝的版本，而不是全局安裝的版本，因?yàn)?code style="margin: auto 3px; padding: 0px 5px; list-style-type: none; border: none; display: inline-block; font-size: 15.6px; background-color: pink; border-radius: 5px;">mochawesome模塊是安裝在項(xiàng)目?jī)?nèi)的。

然后，測(cè)試結(jié)果報(bào)告就在mochaawesome-reports子目錄生成。

6.3 --growl, -G

打開--growl參數(shù)，就會(huì)將測(cè)試結(jié)果在桌面顯示。

$ mocha --growl

6.4 --watch，-w

--watch參數(shù)用來監(jiān)視指定的測(cè)試腳本。只要測(cè)試腳本有變化，就會(huì)自動(dòng)運(yùn)行Mocha。

$ mocha --watch

上面命令執(zhí)行以后，并不會(huì)退出。你可以另外打開一個(gè)終端窗口，修改test目錄下面的測(cè)試腳本add.test.js，比如刪除一個(gè)測(cè)試用例，一旦保存，Mocha就會(huì)再次自動(dòng)運(yùn)行。

6.5 --bail, -b

--bail參數(shù)指定只要有一個(gè)測(cè)試用例沒有通過，就停止執(zhí)行后面的測(cè)試用例。這對(duì)持續(xù)集成很有用。

$ mocha --bail

6.6 --grep, -g

--grep參數(shù)用于搜索測(cè)試用例的名稱（即it塊的第一個(gè)參數(shù)），然后只執(zhí)行匹配的測(cè)試用例。

$ mocha --grep "1 加 1"

上面代碼只測(cè)試名稱中包含"1 加 1"的測(cè)試用例。

6.7 --invert, -i

--invert參數(shù)表示只運(yùn)行不符合條件的測(cè)試腳本，必須與--grep參數(shù)配合使用。

$ mocha --grep "1 加 1" --invert

七，配置文件mocha.opts

Mocha允許在test目錄下面，放置配置文件mocha.opts，把命令行參數(shù)寫在里面。請(qǐng)先進(jìn)入demo03目錄，運(yùn)行下面的命令。

$ mocha --recursive --reporter tap --growl

上面這個(gè)命令有三個(gè)參數(shù)--recursive、--reporter tap、--growl。

然后，把這三個(gè)參數(shù)寫入test目錄下的mocha.opts文件。

--reporter tap--recursive--growl

然后，執(zhí)行mocha就能取得與第一行命令一樣的效果。

$ mocha

如果測(cè)試用例不是存放在test子目錄，可以在mocha.opts寫入以下內(nèi)容。

server-tests--recursive

上面代碼指定運(yùn)行server-tests目錄及其子目錄之中的測(cè)試腳本。

八、ES6測(cè)試

如果測(cè)試腳本是用ES6寫的，那么運(yùn)行測(cè)試之前，需要先用Babel轉(zhuǎn)碼。進(jìn)入demo04目錄，打開test/add.test.js文件，可以看到這個(gè)測(cè)試用例是用ES6寫的。

import add from '../src/add.js';import chai from 'chai';let expect = chai.expect;describe('加法函數(shù)的測(cè)試', function() { it('1 加 1 應(yīng)該等于 2', function() { expect(add(1, 1)).to.be.equal(2); });});

ES6轉(zhuǎn)碼，需要安裝Babel。

$ npm install babel-core babel-PReset-es2015 --save-dev

然后，在項(xiàng)目目錄下面，新建一個(gè).babelrc配置文件。

{ "presets": [ "es2015" ]}

最后，使用--compilers參數(shù)指定測(cè)試腳本的轉(zhuǎn)碼器。

$ ../node_modules/mocha/bin/mocha --compilers js:babel-core/register

上面代碼中，--compilers參數(shù)后面緊跟一個(gè)用冒號(hào)分隔的字符串，冒號(hào)左邊是文件的后綴名，右邊是用來處理這一類文件的模塊名。上面代碼表示，運(yùn)行測(cè)試之前，先用babel-core/register模塊，處理一下.js文件。由于這里的轉(zhuǎn)碼器安裝在項(xiàng)目?jī)?nèi)，所以要使用項(xiàng)目?jī)?nèi)安裝的Mocha；如果轉(zhuǎn)碼器安裝在全局，就可以使用全局的Mocha。

下面是另外一個(gè)例子，使用Mocha測(cè)試CoffeeScript腳本。測(cè)試之前，先將.coffee文件轉(zhuǎn)成.js文件。

$ mocha --compilers coffee:coffee-script/register

注意，Babel默認(rèn)不會(huì)對(duì)Iterator、Generator、Promise、Map、Set等全局對(duì)象，以及一些全局對(duì)象的方法（比如Object.assign）轉(zhuǎn)碼。如果你想要對(duì)這些對(duì)象轉(zhuǎn)碼，就要安裝babel-polyfill。

$ npm install babel-polyfill --save

然后，在你的腳本頭部加上一行。

import 'babel-polyfill'

九、異步測(cè)試

Mocha默認(rèn)每個(gè)測(cè)試用例最多執(zhí)行2000毫秒，如果到時(shí)沒有得到結(jié)果，就報(bào)錯(cuò)。對(duì)于涉及異步操作的測(cè)試用例，這個(gè)時(shí)間往往是不夠的，需要用-t或--timeout參數(shù)指定超時(shí)門檻。

進(jìn)入demo05子目錄，打開測(cè)試腳本timeout.test.js。

it('測(cè)試應(yīng)該5000毫秒后結(jié)束', function(done) { var x = true; var f = function() { x = false; expect(x).to.be.not.ok; done(); // 通知Mocha測(cè)試結(jié)束 }; setTimeout(f, 4000);});

上面的測(cè)試用例，需要4000毫秒之后，才有運(yùn)行結(jié)果。所以，需要用-t或--timeout參數(shù)，改變默認(rèn)的超時(shí)設(shè)置。

$ mocha -t 5000 timeout.test.js

上面命令將測(cè)試的超時(shí)時(shí)限指定為5000毫秒。

另外，上面的測(cè)試用例里面，有一個(gè)done函數(shù)。it塊執(zhí)行的時(shí)候，傳入一個(gè)done參數(shù)，當(dāng)測(cè)試結(jié)束的時(shí)候，必須顯式調(diào)用這個(gè)函數(shù)，告訴Mocha測(cè)試結(jié)束了。否則，Mocha就無法知道，測(cè)試是否結(jié)束，會(huì)一直等到超時(shí)報(bào)錯(cuò)。你可以把這行刪除試試看。

Mocha默認(rèn)會(huì)高亮顯示超過75毫秒的測(cè)試用例，可以用-s或--slow調(diào)整這個(gè)參數(shù)。

$ mocha -t 5000 -s 1000 timeout.test.js

上面命令指定高亮顯示耗時(shí)超過1000毫秒的測(cè)試用例。

下面是另外一個(gè)異步測(cè)試的例子async.test.js。

it('異步請(qǐng)求應(yīng)該返回一個(gè)對(duì)象', function(done){ request .get('https://api.github.com') .end(function(err, res){ expect(res).to.be.an('object'); done(); });});

運(yùn)行下面命令，可以看到這個(gè)測(cè)試會(huì)通過。

$ mocha -t 10000 async.test.js

另外，Mocha內(nèi)置對(duì)Promise的支持，允許直接返回Promise，等到它的狀態(tài)改變，再執(zhí)行斷言，而不用顯式調(diào)用done方法。請(qǐng)看promise.test.js。

it('異步請(qǐng)求應(yīng)該返回一個(gè)對(duì)象', function() { return fetch('https://api.github.com') .then(function(res) { return res.json(); }).then(function(json) { expect(json).to.be.an('object'); });});

十、測(cè)試用例的鉤子

Mocha在describe塊之中，提供測(cè)試用例的四個(gè)鉤子：before()、after()、beforeEach()和afterEach()。它們會(huì)在指定時(shí)間執(zhí)行。

describe('hooks', function() { before(function() { // 在本區(qū)塊的所有測(cè)試用例之前執(zhí)行 }); after(function() { // 在本區(qū)塊的所有測(cè)試用例之后執(zhí)行 }); beforeEach(function() { // 在本區(qū)塊的每個(gè)測(cè)試用例之前執(zhí)行 }); afterEach(function() { // 在本區(qū)塊的每個(gè)測(cè)試用例之后執(zhí)行 }); // test cases});

進(jìn)入demo06子目錄，可以看到下面兩個(gè)例子。首先是beforeEach的例子beforeEach.test.js。

// beforeEach.test.jsdescribe('beforeEach示例', function() { var foo = false; beforeEach(function() { foo = true; }); it('修改全局變量應(yīng)該成功', function() { expect(foo).to.be.equal(true); });});

上面代碼中，beforeEach會(huì)在it之前執(zhí)行，所以會(huì)修改全局變量。

另一個(gè)例子beforeEach-async.test.js則是演示，如何在beforeEach之中使用異步操作。

// beforeEach-async.test.jsdescribe('異步 beforeEach 示例', function() { var foo = false; beforeEach(function(done) { setTimeout(function() { foo = true; done(); }, 50); }); it('全局變量異步修改應(yīng)該成功', function() { expect(foo).to.be.equal(true); });});

十一、測(cè)試用例管理

大型項(xiàng)目有很多測(cè)試用例。有時(shí)，我們希望只運(yùn)行其中的幾個(gè)，這時(shí)可以用only方法。describe塊和it塊都允許調(diào)用only方法，表示只運(yùn)行某個(gè)測(cè)試套件或測(cè)試用例。

進(jìn)入demo07子目錄，測(cè)試腳本test/add.test.js就使用了only。

it.only('1 加 1 應(yīng)該等于 2', function() { expect(add(1, 1)).to.be.equal(2);});it('任何數(shù)加0應(yīng)該等于自身', function() { expect(add(1, 0)).to.be.equal(1);});

上面代碼中，只有帶有only方法的測(cè)試用例會(huì)運(yùn)行。

$ mocha test/add.test.js 加法函數(shù)的測(cè)試 ? 1 加 1 應(yīng)該等于 2 1 passing (10ms)

此外，還有skip方法，表示跳過指定的測(cè)試套件或測(cè)試用例。

it.skip('任何數(shù)加0應(yīng)該等于自身', function() { expect(add(1, 0)).to.be.equal(1);});

上面代碼的這個(gè)測(cè)試用例不會(huì)執(zhí)行。

十二、瀏覽器測(cè)試

除了在命令行運(yùn)行，Mocha還可以在瀏覽器運(yùn)行。

首先，使用mocha init命令在指定目錄生成初始化文件。

$ mocha init demo08

運(yùn)行上面命令，就會(huì)在demo08目錄下生成index.html文件，以及配套的腳本和樣式表。

<!DOCTYPE html><html>  <body>    <h1>Unit.js tests in the browser with Mocha</h1>    <div id="mocha"></div>    <script src="mocha.js"></script>    <script>      mocha.setup('bdd');    </script>    <script src="tests.js"></script>    <script>      mocha.run();    </script>  </body></html>
然后，新建一個(gè)源碼文件add.js。
// add.jsfunction add(x, y) {  return x + y;}
然后，把這個(gè)文件，以及斷言庫(kù)chai.js，加入index.html。
<script>  mocha.setup('bdd');</script><script src="add.js"></script><script src="http://chaijs.com/chai.js"></script><script src="tests.js"></script><script>  mocha.run();</script>
最后，在tests.js里面寫入測(cè)試腳本。
var expect = chai.expect;describe('加法函數(shù)的測(cè)試', function() {  it('1 加 1 應(yīng)該等于 2', function() {    expect(add(1, 1)).to.be.equal(2);  });  it('任何數(shù)加0等于自身', function() {    expect(add(1, 0)).to.be.equal(1);    expect(add(0, 0)).to.be.equal(0);  });});
現(xiàn)在，在瀏覽器里面打開index.html，就可以看到測(cè)試腳本的運(yùn)行結(jié)果。
十三、生成規(guī)格文件
Mocha支持從測(cè)試用例生成規(guī)格文件。
進(jìn)入demo09子目錄，運(yùn)行下面的命令。
$ mocha --recursive -R markdown > spec.md
上面命令根據(jù)test目錄的所有測(cè)試腳本，生成一個(gè)規(guī)格文件spec.md。-R markdown參數(shù)指定規(guī)格報(bào)告是markdown格式。
如果想生成HTML格式的報(bào)告spec.html，使用下面的命令。
$ mocha --recursive -R doc > spec.html