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

来源:http://www.cnblogs.com/51test/archive/2017/07/10/7146503.html
-Advertisement-
Play Games

敏捷軟體開發中,最重要實踐的就是測試驅動開發,在單元測試層面,我們試著實現一個重要的指標就是測試覆蓋率。測試覆蓋率衡量我們的代碼是否已經全部被測試到了。 但是指標本身不是目的,藉助測試覆蓋率檢查,我們希望發現那些未被測試覆蓋的代碼,從而去思考如何測試那些代碼的邏輯,進而更好的設計重構代碼,讓代碼有更 ...


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

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


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • let / var 可以重覆聲明 let 有塊級作用域 沒有前置功能 不能重覆聲明 / var a=1; console.log(a);//1 let b=2; console.log(b);//2 if(a==1){ var z=2; } console.log(z);//2 / if(a1==1 ...
  • ES6 scope(作用域) 作用域 : 1.全局作用域(global) 2.函數作用域(function) 全局作用域 var a=1; console.log(a);//1 //{}表示語句塊 if(a==1){ var b=2; console.log(b);//2 } console.log ...
  • js中var、let、const的區別 主要內容是:js中三種定義變數的方式const, var, let的區別。 var定義的變數可以修改,如果不初始化會輸出undefined,不會報錯。 var分為兩種:局部作用域和函數作用域 let是塊級作用域,函數內部使用let定義後,對函數外部無影響。 l ...
  • [TOC] 1、開發環境準備 1.1 安裝nodejs 首先安裝Nodejs,直接去nodejs官網下載https://nodejs.org/en/,預設會安裝Npm,所以這裡可以不用單獨安裝。 1.2 使用淘寶Npm鏡像 由於國內網路原因,如果直接使用Npm安裝依賴包會因為網路和牆的原因導致不成功 ...
  • 原生函數 常用的原生函數 String() Number() Boolean() Array() Object() Function() RegExp() Date() Error() Symbol() 內部屬性 [Class] 所有typeof 返回值為object 的對象都包含一個內部屬性[Cl ...
  • 最近在使用ng2做前端。發現表單驗證這塊除了官網上給的示例,驗證required。其他的都要自己寫邏輯來實現。開發起來不是很方便。所以在網上找了下ng2表單驗證的資源,覺得ng2-validation不錯。所以做的例子。以便以後使用,也怕時間久了忘腦後去。 示例代碼鏈接 首先從npm包管理伺服器上下 ...
  • 需求分析: 對於網頁中的圖片進行連續放大(便於用戶清晰查看內容)、縮小,旋轉等操作,可以使用viewjs圖片查看器插件實現。 viewjs官方網址:https://github.com/fengyuanchen/viewerjs 具體使用方法請參照官網說明。 下麵做2個簡單的示例: 1、示例一:單一 ...
  • 終端輸入fg,然後再試npm run dev,就OK了 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...