【前端單元測試入門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

結果如下:


image.png

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

得到以下結果:


斷言庫chai結果

可以看出圖中的斷言庫還打印出了期望的結果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僅測試當前用例等玩法就不講述了。

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容