mocha、chai、sinon和istanbul實現100%單元測試覆蓋率


敏捷軟件開發中,最重要實踐的就是測試驅動開發,在單元測試層面,我們試着實現一個重要的指標就是測試覆蓋率。測試覆蓋率衡量我們的代碼是否已經全部被測試到了。

但是指標本身不是目的,借助測試覆蓋率檢查,我們希望發現那些未被測試覆蓋的代碼,從而去思考如何測試那些代碼的邏輯,進而更好的設計重構代碼,讓代碼有更高的質量[1]

談到測試,正好最近在看《數學之美》,書中談到的關於信息的一段話。我們要把代碼的行為從不確定性,變成確定性,也是一樣。從黑盒變成白盒,沒有什么神奇的力量,唯有提供足夠的信息,而測試中的斷言就是信息,測試覆蓋率也是信息,測試覆蓋率可以認為是一種間接的信息,可以消除一部分不確定性,而充分的斷言,則提供了更直接的信息。加上測試覆蓋率檢查,就能夠提供足夠的信息,來斷言代碼的行為是否符合期望。

測試的相關技術

IstanbulJavaScript程序的代碼覆蓋率工具,以土耳其最大城市伊斯坦布爾命名。Istanbul會對代碼進行轉換,生成語法樹,然后在相應位置注入統計代碼,執行之后根據注入的全局變量的值,統計代碼執行的次數;在對代碼的轉換完成之后,Istanbul會調用test runner,例如mocha,執行轉換之后的代碼的測試,生成測試報告。

Mocha是一種測試框架,也就是運行測試的工具,類似Jasmine、Karma和Ava。跟JUnit的注解一樣,mocha作為執行器,用descibeit方法,來定義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 coveragenpm 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


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM