前端單元測試框架-Mocha

引言

隨着前端工程化這一概念的產生，項目開發中前端的代碼量可謂是‘急劇上升’，所以在這種情況下，我們如何才能保證代碼的質量呢，對於框架，比如React、Vue，因為有自己的語法規則，及時每個開發人員的編碼風格規范各不相同，但最終的產出都大同小異，代碼質量差距不是很大；但對於一些基礎類庫或方法的開發，我們就要謹慎又謹慎，代碼質量一定要高，盡量避免出現Bug。

那我們如何做到產出高質量代碼呢？單元測試才是正解，俗話說‘跳過單元測試和不仔細過冒煙就交由QA測試的，就是在耍流氓’（這句話是我自己編的）；Mocha是針對Javascript的單元測試工具，下面我們就來看看如何使用它

 

概念

Mocha: Javascript測試框架

chai：斷言庫，需配合Mocha使用

 

最簡單的用法

步驟一：安裝

假設我們是在已有項目中進行單元測試

安裝Mocha

/*全局安裝*/
$ npm install --global mocha　　

/*局部安裝*/
$ npm install --save-dev mocha

安裝chai

/*局部安裝*/
$ npm install --save-dev chai

 

全局與局部的區別：若是局部安裝，依賴就會寫入package.json的dependencies或devDependencies中，這樣當別人從你的Github上克隆代碼時，就不需要注意‘依賴包全不全啊’？‘還需不要安裝其他依賴啊？’等等這類的問題，因為'npm install'會將所有依賴下載到本地

 

步驟二：編寫Js源文件與測試文件

源文件

// add.js
1 function add(x, y) {
  return x + y;
}

module.exports = add;

測試文件

 // add.test.js
 1 var add = require('./add.js');
var expect = require('chai').expect;

describe('加法函數的測試', function() {
  it('1 加 1 應該等於 2', function() {
    expect(add(1, 1)).to.be.equal(2);
  });
  it('1 加 -1 應該等於 0', function() {
    expect(add(1, -1)).to.be.equal(0);
  });
});

 

步驟三：運行測試文件

$ mocha add.test.js

運行截圖：

以上就是Mocha最簡單的使用方式，細不細很簡單啊O(∩_∩)O哈哈~，下面我們再看點進階的

 

進階之路

進階一：describe和it是什么？

describe："測試組"，也稱測試塊，表示我要進行一系列測試，相當於一個group

it："測試項"，也稱測試用例，表示這是"一系列測試"中的一項，相當於item，如何測試？測試邏輯？都是在it的回調函數中實現的

 

進階二：什么？describe也有"生命周期"？

每個測試塊（describe）有4個周期，分別是：

describe('test', function() {
  // 在本測試塊的所有測試用例之前執行且僅執行一次
  before(function() {
    
  });
  // 在本測試塊的所有測試用例之后執行且僅執行一次
  after(function() {
    
  });

  // 在測試塊的每個測試用例之前執行（有幾個測試用例it，就執行幾次）
  beforeEach(function() {
    
  });
  // 在測試塊的每個測試用例之后執行（同上）
  afterEach(function() {
    
  });
  
  // 測試用例
  it('test item1', function () {

  })
});

 

進階三：在進階二中周期代碼是ES6風格，需要安裝babel模塊轉碼

這里分兩種情況：1.全局安裝   2.局部安裝

如果是全局方式安裝的babel，那么我們也要使用全局的Mocha來調用babel-core模塊

$ npm install -g babel-core babel-preset-es2015
$ mocha --compilers js:babel-core/register

但如果是局部方式安裝的babel，那么我們就要使用局部的Mocha來調用babel-core模塊

$ npm install --save-dev babel-core babel-preset-es2015
$ ../node_modules/mocha/bin/mocha --compilers js:babel-core/register

為什么呢？因為Mocha是根據自身的路徑來尋找babel模塊的，所以要全局對應全局，局部對應局部

這里少了很重要的一步：在測試之前，需要配置babel轉碼規則，在項目根目錄，記住‘一定要是根目錄’，新建.babelrc文件，這個文件是供babel使用的

// .babelrc
{
  "presets": [ "es2015" ] //這里制定使用es2015規則轉碼
}

 

進階四：測試還可以是異步的？

異步測試與普通測試有什么不同：測試用例的回調函數中多了一個參數done

var add = require('../src/add.js');
var expect = require('chai').expect;

describe('加法函數的測試', function() {
  // 異步測試
  it('1 加 1 應該等於 2', function(done) {
    var clock = setTimeout(function () {
      expect(add(1, 1)).to.be.equal(2);
      done(); // 通知Mocha測試結束
    },1000);
  });

  // 同步測試
  it('1 加 0 應該等於 1', function() {
    expect(add(1, 0)).to.be.equal(1);
  });
});

異步測試需要注意一點：必須手動調用done，否則該異步測試就會失敗，見下方代碼與運行截圖：

代碼：

var add = require('../src/add.js');
var expect = require('chai').expect;

describe('加法函數的測試', function() {
  // 異步測試
  it('1 加 1 應該等於 2', function(done) {
    var clock = setTimeout(function () {
      expect(add(1, 1)).to.be.equal(2);
      //done();我們不主動調用done，看看會發生什么？
    },1000);
  });

  // 同步測試
  it('1 加 0 應該等於 1', function() {
    expect(add(1, 0)).to.be.equal(1);
  });
});

運行截圖：

從運行結果不難看出，測試用例1失敗了，而且Mocha提示我們：如果是異步測試或鈎子，那么一定要確保done方法被調用，否則測試就會失敗，但並不會影響其他用例

那么，異步測試有哪些應用場景呢？那就是測試數據接口，我們可以這樣：

it('異步請求測試', function() {
  return fetch('https://api.github.com')
    .then(function(res) {
      return res.json();
    }).then(function(json) {
      expect(json).to.be.an('object'); // 測試接口返回的是否為對象類型的數據，也就是json格式
    });
});

 

進階五：如果我們想只執行某個測試用例呢？或者除了某個用例，其他的都執行

Mocha有兩個用例管理api：only和skip

1.如果只想執行某個用例，我們就用only方式調用它：

var add = require('../src/add.js');
var expect = require('chai').expect;

describe('加法函數的測試', function() {
  // 一個測試組中不是只能有一個only，可以有多個only方式執行的用例
  it.only('1 加 1 應該等於 2', function() {
    expect(add(1, 1)).to.be.equal(2);
  });


  it.only('1 加 0 應該等於 1', function() {
    expect(add(1, 0)).to.be.equal(1);
  });

  // 但如果組內已經有了only，那么非only方式執行的用例就一定不會被執行，切記
  it('1 加 -1 應該等於 0', function() {
    expect(add(1, -1)).to.be.equal(0);
  });

});

運行截圖：

可以看出，第三個用例並沒有被執行

2.如果想跳過某個用例，我們就用skip方式調用它：

var add = require('../src/add.js');
var expect = require('chai').expect;

describe('加法函數的測試', function() {

  it('1 加 1 應該等於 2', function() {
    expect(add(1, 1)).to.be.equal(2);
  });

  // 同理，skip方式執行的用例在同一組內也可以有多個
  it.skip('1 加 0 應該等於 1', function() {
    expect(add(1, 0)).to.be.equal(1);
  });


  it.skip('1 加 -1 應該等於 0', function() {
    expect(add(1, -1)).to.be.equal(0);
  });

});

運行截圖：

第2，3個用例被跳過了

 

 

結語

以上就是Mocha測試框架的簡單介紹，測試api不只有文中的to.be.equal，文中只是"千牛一毛"，還有很多api以及更高級的使用特性，詳細可參照官方網站：http://mochajs.org/

本文章內容參照了阮一峰老師的文章《測試框架 Mocha 實例教程》，感興趣的同學可以看一下