mocha、chai、sinon和istanbul實現100%單元測試覆蓋率
敏捷軟體開發中,最重要實踐的就是測試驅動開發,在單元測試層面,我們試著實現一個重要的指標就是測試覆蓋率。測試覆蓋率衡量我們的程式碼是否已經全部被測試到了。
但是指標本身不是目的,藉助測試覆蓋率檢查,我們希望發現那些未被測試覆蓋的程式碼,從而去思考如何測試那些程式碼的邏輯,進而更好的設計重構程式碼,讓程式碼有更高的質量[1]。
談到測試,正好最近在看《數學之美》,書中談到的關於資訊的一段話。我們要把程式碼的行為從不確定性,變成確定性,也是一樣。從黑盒變成白盒,沒有什麼神奇的力量,唯有提供足夠的資訊,而測試中的斷言就是資訊,測試覆蓋率也是資訊,測試覆蓋率可以認為是一種間接的資訊,可以消除一部分不確定性,而充分的斷言,則提供了更直接的資訊。加上測試覆蓋率檢查,就能夠提供足夠的資訊,來斷言程式碼的行為是否符合期望。
測試的相關技術
Istanbul
是JavaScript
程式的程式碼覆蓋率工具,以土耳其最大城市伊斯坦布林命名。Istanbul會對程式碼進行轉換,生成語法樹,然後在相應位置注入統計程式碼,執行之後根據注入的全域性變數的值,統計程式碼執行的次數;在對程式碼的轉換完成之後,Istanbul會呼叫test
runner
,例如mocha
,執行轉換之後的程式碼的測試,生成測試報告。
Mocha
是一種測試框架,也就是執行測試的工具,類似Jasmine、Karma和Ava。跟JUnit的註解一樣,mocha作為執行器,用descibe
和it
方法,來定義test
suit,為不同的測試分組。mocha本身並不提供assert
chai
使用,當然也可以使用nodejs提供的assert模組
。
在我們的程式碼中,總會有一些複雜的邏輯或者依賴io、網路的非同步程式碼,用直接的方法難以測試,這時可以通過sinon
簡化複雜程式碼的測試。Sinon通過建立Test
Double也就是測試替身
,將我們程式碼中依賴的一些函式或者類,替換成測試替身,而我們可以對測試替身的行為進行設定,模擬我們的程式碼需要的結果,從而讓難以測試的程式碼邏輯被執行。
為nodejs專案配置測試環境
1 安裝相應的依賴包
mocha和istanbul可以全域性安裝,也可以只在當前專案安裝。
npm install --save-dev mocha chai sinon istanbul
安裝完成之後,在package.json
檔案的scripts下,新增執行測試和測試覆蓋率檢查的命令
{
...
"scripts":{
"coverage": "istanbul cover _mocha -- -R spec --timeout 5000 --recursive",
"coverage:check": "istanbul check-coverage",
}
...
}
執行npm run coverage
和npm run coverage:check
,就可以生成測試報告,前者生成測試報告,後者則是檢查測試覆蓋率是否達到要求。
2 配置Istanbul
istanbul相關的執行引數,可以在命令列下執行時傳遞引數來制定,也可以在yaml格式的.istanbul.yml
檔案中配置。簡單貼出一些重要的配置項
instrumentation:
root: . # 執行的根目錄
extensions:
- .js # 檢查覆蓋率的檔案擴張名
excludes: ['**/benchmark/**']
... ...
reporting:
print: summary
reports: [lcov, text, html, text-summary] # 生成報告的格式
dir: ./coverage # 生成報告儲存的目錄
watermarks: # 在不同覆蓋率下會顯示使用不同顏色
statements: [80, 95]
... ...
check:
global:
statements: 100
branches: 100
lines: 100
functions: 100
最後的check是專案要通過覆蓋率檢查需要達到的測試覆蓋率,測試覆蓋率包括四個維度,分別是語句覆蓋率、分支覆蓋率、行覆蓋率和函式覆蓋率。如果達不到設定的指標,在執行的時候會報錯,專案的測試就無法通過自動化的持續整合。
編寫測試程式碼
敏捷軟體開發中的測試驅動開發,意在通過先寫測試,根據呼叫者的契約,設計如何實現程式碼,從而寫出更加容易測試的程式碼,提高程式碼的質量。也是我們練習測試的應該考慮的方向。
1 一段簡單的mocha測試程式碼
利用chai提供的expect斷言,我們可以用BDD的方式,寫出更加符合程式碼預期行為的測試用例。
var chai = require('chai')
chai.should()
var expect = chai.expect
var assert = chai.assert
describe('basic test', function () {
describe('simple', function () {
it('data check', function () {
var data = { name: "test" }
assert.isNotNull(data, 'data should not be null')
expect(data).to.be.an('object')
expect(data).to.have.all.keys(['name'])
expect(data).to.deep.include({name: 'test'});
});
});
});
2 用Sinon模擬檔案讀寫
... 同上 ...
var sinon = require('sinon')
var fs = require('fs')
describe('sinon', function () {
it("should mock readFile", function(done){
sinon.stub(fs, 'readFile').callsFake(function (path, callback) { callback(new Error('read error')) })
fs.readFile("any file path", function(err,data){
assert.isNotNull(err)
done()
})
assert(fs.readFile.calledOnce)
});
});
在mocha測試框架中,如果我們呼叫的是非同步的程式碼,那麼需要顯示的呼叫it回撥函式的done方法,告訴mocha非同步呼叫什麼時候結束。否則的話,測試會掛起,直到設定的超時時間結束。
Sinon將測試替身分為spy、stub和mock,其中:
- Spy, 可以提供函式呼叫的資訊,但不會改變函式的行為
- Stub, 提供函式的呼叫資訊,並且可以像示例程式碼中一樣,讓被stubbed的函式返回任何我們需要的行為。
- Mock, 通過組合spies和stubs,使替換一個完整物件更容易。
本文的討論篇幅有限,暫時不詳細介紹各種sinon的使用方法,以後再通過其他文章專門介紹。
持續整合
完成所有程式碼之後,我們可以將程式碼釋出到github,然後使用持續整合工具travis檢查程式碼,將生成的測試報告上傳到coverall上,這樣就可以在專案中顯示專案狀態和測試覆蓋率的badges。
具體使用方法,可以參看官方網站,使用coveralls需要在專案中安裝依賴包npm i -D coveralls
。並且新增package.json執行指令碼istanbul cover ./node_modules/mocha/bin/_mocha
--report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
通常的nodejs專案.travis.yml
配置如下:
language: node_js
node_js:
- "7.6.0"
install:
- npm install
script:
- npm test
after_script:
- npm run coverall
原文地址:http://www.51test.space/archives/2543