【前端單元測試入門01】Mocha與chai

Mocha 的簡介

Mocha是流行的JavaScript測試框架之一，經過它添加和運行測試，從而保證代碼質量

Mocha 的安裝與配置

全局安裝Mocha

npm install -g mocha

項目中也安裝Mocha

npm install --save-dev mocha

在package.json中加入下面腳本：

"scripts": {
    "test": "mocha"
}

Mocha 的使用

在使用前，咱們先看一下咱們用來使用的測試項目的結構：

如上圖所示，測試文件須要放在test目錄下，mocka運行時會執行test目錄下的全部js文件（僅限於test如下這一層級，對test/subtest這一層級並不執行）。

其中index.js爲咱們的被測試代碼：

/**
 * 加法函數
 * @param {第一個數} a 
 * @param {第二個數} b 
 */
function addNum(a,b){
    return a+b;
}
module.exports=addNum;

而index.test.js爲咱們的測試代碼(注意這裏的命名加了一個test，並非必須的，只是爲了好區分哪些是測試文件)：

var addNum=require('../src/index')

describe('測試index.js', function() {
  describe('測試addNum函數', function() {
    it('兩數相加結果爲兩個數字的和', function() {
       if(addNum(1,2)!==3){
         throw new Error("兩數相加結果不爲兩個數字的和")；
       }
    });
  });
});

解析一下以上代碼的語法：

測試腳本里面應該包括一個或多個describe塊，每一個describe塊應該包括一個或多個it塊。
describe塊稱爲"測試套件"（test suite），表示一組相關的測試。它是一個函數，第一個參數是測試套件的名稱（"測試index.js"），第二個參數是一個實際執行的函數。
it塊稱爲"測試用例"（test case），表示一個單獨的測試，是測試的最小單位。它也是一個函數，第一個參數是測試用例的名稱（"兩數相加結果爲兩個數字的和"），第二個參數是一個實際執行的函數。

在上面的例子中，測試addNum函數，若是運行錯誤就拋出異常

此時運行

npm test

就可獲得如下結果

爲了看一下運行錯誤的結果，此時咱們修改index.js的代碼爲：

function addNum(a,b){
    return a+b-1;
}
module.exports=addNum;

再次運行

npm test

結果以下：

Mocha與斷言庫chai

在上面的Mocha例子中，測試失敗用拋異常來處理，多少有點繁瑣，因此就有了斷言庫的出現。
這裏咱們介紹一個經常使用的斷言庫chai。
能夠簡單理解爲這就是對咱們上面拋異常方法的一個封裝，當判斷失敗時會拋出一個異常。
首先安裝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函數', function() {
    it('兩數相加結果爲兩個數字的和', function() {
      expect(addNum(1,2)).to.be.equal(3);
    });
  });
});

上面的語法很接近天然語言，expect（期待）一個表達式的結果equal（等於）一個表達式。
運行

npm test

獲得如下結果：

能夠看出圖中的斷言庫還打印出了指望的結果3和實際的結果2。
若是用判斷來拋異常的話會繁瑣得多。

以上語法爲chai的expect語法，它還有should語法和asset語法。
若是是之前用過java和.NET的話，對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

或者多個js

mocha test/index.test.js test/add.test.js

固然也能夠用通配符測試某個文件夾下全部的js和jsx：

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

Mocha與ES6

在上面咱們用的並不是是ES6的語法，那麼讓咱們把其中的代碼都改成ES6的語法。
其中index.js爲：

/**
 * 加法函數
 * @param {第一個數} a 
 * @param {第二個數} 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函數', ()=> {
    it('兩數相加結果爲兩個數字的和', ()=> {
      assert.equal(addNum(1,2),3)
    })
  })
})

此時直接運行mock確定是不行的，咱們現須要安裝一下babel：

npm install babel-core babel-preset-es2015 --save-dev

而後，在項目目錄下面，新建一個.babelrc文件：

{
  "presets": [ "es2015" ]
}

接着講package.json中的腳本改成：

"scripts": {
  "test": "mocha --compilers js:babel-core/register"
},

其中--compilers參數用來指定測試腳本的轉碼器，這行命令的意思是運行mocha時先用babel-core/register模塊，處理一下.js文件

注意：
--compilers將會在將來被移除，官方稱它是redundant（累贅的），而做爲替代方案的是

"scripts": {
  "test": "mocha --require babel-core/register"
},

命令變得更加簡單了

Mocha測試用例執行的超時和高亮

Mocha默認每一個測試用例最多執行2000毫秒，若是到時沒有獲得結果，就報錯。如下命令設置超時時間爲5000：

mocha -t 5000 index.test.js

Mocha默認會高亮顯示超過75毫秒的測試用例，如下命令設置高亮判斷的臨界值：

mocha -s 1000 index.test.js

Mocha測試的鉤子

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

describe('測試index.js',()=> {
  before(()=>console.info("在本區塊的全部測試用例以前執行"))

  after(()=>console.info("在本區塊的全部測試用例以後執行"))

  beforeEach(()=>console.info("在本區塊的每一個測試用例以前執行"))

  afterEach(()=>console.info("在本區塊的每一個測試用例以後執行"))

  describe('測試addNum函數', ()=> {
    it('兩數相加結果爲兩個數字的和', ()=> {
      assert.equal(addNum(1,2),3)
    })
  })
})

小結

關於mock和chai經常使用的一些玩法都講了，更多的關於mock的測試結果輸出格式，以及skip跳過測試和only僅測試當前用例等玩法就不講述了。