NodeJs下的測(cè)試框架Mocha

Bamboy 發(fā)布于2019-08-20 14:27 / 973人閱讀

摘要：測(cè)試實(shí)際值是否為，和作用一致使用等值比較操作符測(cè)試真實(shí)值是否淺層地，強(qiáng)制性地和預(yù)期值相等。測(cè)試真實(shí)值是否深層次地和預(yù)期值相等。

本人的博客http://www.wjs.photo/,感興趣的可以看看哦，基于NodeJs框架ThinkJs

介紹和代碼下載

Mocha在2011年發(fā)布，是目前最為流行的javascript框架之一，在本文我們重點(diǎn)介紹它在NodeJs上的使用。

如果你需要下載實(shí)例代碼，可以通過(guò)這個(gè)鏈接 gitClone 或者下載zip壓縮包

下載代碼后安裝依賴(lài)：

$ cd DemoOfMocha
$ npm install

代碼目錄結(jié)構(gòu)如圖所示：

您可以按照代碼目錄結(jié)構(gòu)在根目錄新建lib文件夾和test文件夾，再在test文件夾中新建lib文件夾，然后通過(guò)npm init命令來(lái)生成package.json，也可以先將代碼下載下來(lái)跑一下

第一個(gè)測(cè)試

現(xiàn)在在lib目錄下新建一個(gè)sum.js文件

exports.sum =function (a,b) {
    return a+b
}

接下來(lái)測(cè)試這個(gè)腳本，在test目錄下的lib文件夾中新建測(cè)試腳本：sum.js

//test/lib/sum.js

var sum = require("../../lib/sum")
var assert = require("assert")

describe("和函數(shù)的測(cè)試",function () {
    it("1加1應(yīng)該等于2",function () {
        var expect=10;
        assert.equal(sum(1,1),expect);
    })
})

上面的代碼是測(cè)試腳本，測(cè)試腳本可以獨(dú)立執(zhí)行，測(cè)試腳本里應(yīng)該包含一個(gè)或者多個(gè) describe 塊，每個(gè)describe塊也應(yīng)該包含一個(gè)或者多個(gè) it 塊

describe 塊是“ 測(cè)試套件”，表示一組相關(guān)的測(cè)試，是一個(gè)函數(shù)，第二個(gè)是實(shí)際可以執(zhí)行的函數(shù)

It 塊是“測(cè)試用例” 表示一個(gè)多帶帶的測(cè)試，測(cè)試的最小單位，也是一個(gè)函數(shù)，第一參數(shù)是測(cè)試用例的名稱(chēng)或說(shuō)明，第二個(gè)參數(shù)是實(shí)際可以執(zhí)行的函數(shù)

assert 是斷言包（斷言包有很多種，這里我使用NodeJs自帶的斷言包），判斷測(cè)試代碼的執(zhí)行結(jié)果和預(yù)期的結(jié)果是否一致，不一致的話拋出一個(gè)錯(cuò)誤，在我們的測(cè)試腳本中，sum(1,1)，結(jié)果應(yīng)該等于2

我們?cè)谶@里介紹一下Assert的斷言模塊的一些函數(shù)

assert.fail(actual, expected, message, operator)
使用指定操作符測(cè)試actual（真實(shí)值）是否和expected（期望值）一致。

assert.ok(value, [message])
測(cè)試實(shí)際值是否為true，和assert.equal(true, value, message);作用一致

assert.equal(actual, expected, [message])
使用等值比較操作符( == )測(cè)試真實(shí)值是否淺層地（shallow），強(qiáng)制性地（coercive）和預(yù)期值相等。

assert.notEqual(actual, expected, [message])
使用不等比較操作符( != )測(cè)試真實(shí)值是否淺層地（shallow），強(qiáng)制性地（coercive）和預(yù)期值不相等。

assert.deepEqual(actual, expected, [message])
測(cè)試真實(shí)值是否深層次地和預(yù)期值相等。

assert.notDeepEqual(actual, expected, [message])
測(cè)試真實(shí)值是否深層次地和預(yù)期值不相等。

assert.strictEqual(actual, expected, [message])
使用嚴(yán)格相等操作符 ( === )測(cè)試真實(shí)值是否嚴(yán)格地（strict）和預(yù)期值相等。

assert.notStrictEqual(actual, expected, [message])
使用嚴(yán)格不相等操作符 ( !== )測(cè)試真實(shí)值是否嚴(yán)格地（strict）和預(yù)期值不相等。

assert.throws(block, [error], [message])
預(yù)期block時(shí)拋出一個(gè)錯(cuò)誤（error）， error可以為構(gòu)造函數(shù)，正則表達(dá)式或者其他驗(yàn)證器。

接下來(lái)我們?cè)趐ackage.json中更新一下scripts字段

{
  "name": "DemoOfMocha",
  "version": "1.0.0",
  "description": "demo of mocha",
  "main": "index.js",
  "directories": {
    "test": "test"
  },
  "dependencies": {},
  "devDependencies": {},
  "scripts": {
    "test": "NODE_ENV=test mocha test/**/*.js"
  },
  "keywords": [
    "deom",
    "mocha"
  ],
  "author": "wjszxli",
  "license": "ISC"
}

我們通過(guò)npm命令去安裝MochaJS

$ npm install mocha --save-dev

我們添加了運(yùn)行測(cè)試的命令，接下來(lái)通過(guò)命令來(lái)獲得測(cè)試報(bào)告

$ npm test

測(cè)試報(bào)告如下：

這樣，我們第一個(gè)測(cè)試就成功了

讓測(cè)試報(bào)告變得更漂亮

我們可以使用mochawesome模塊，生成漂亮的HTML格式的報(bào)告，如圖：

通過(guò)如下命令進(jìn)行安裝mochawesome

$ npm install --save-dev mochawesome

然后更新在package.json中的scripts字段

  "name": "DemoOfMocha",
  "version": "1.0.0",
  "description": "demo of mocha",
  "main": "index.js",
  "directories": {
    "test": "test"
  },
  "dependencies": {},
  "devDependencies": {
    "mocha": "^3.2.0",
    "mochawesome": "^2.0.4"
  },
  "scripts": {
    "test": "NODE_ENV=test mocha test/**/*.js --reporter mochawesome"
  },
  "keywords": [
    "deom",
    "mocha"
  ],
  "author": "wjszxli",
  "license": "ISC”
}

運(yùn)行測(cè)試命令，測(cè)試報(bào)表就在mochawesome-reports中生成了

用瀏覽器打開(kāi)下的html頁(yè)面，我們會(huì)看到漂亮的測(cè)試報(bào)告

異步測(cè)試

Mocha默認(rèn)每個(gè)測(cè)試用例最多執(zhí)行2000毫秒，2000毫秒之后沒(méi)有得到結(jié)果，就會(huì)報(bào)錯(cuò)，如果涉及到異步操作的測(cè)試用例，2000毫秒是不夠的，這個(gè)時(shí)候我們需要用 -t 或 —timeout 參數(shù)指定超時(shí)門(mén)檻

我們可以修改在package.json中的scripts字段（我們這里改成3000毫秒）

"scripts": {
  "test": "NODE_ENV=test mocha -t 3000 timeout test/**/*.js --reporter mochawesome”
},

寫(xiě)一個(gè)異步測(cè)試腳本

//test/lib/timeout.js


var assert = require("assert")

describe("測(cè)試應(yīng)該3000毫秒后結(jié)束",function () {
    it("測(cè)試應(yīng)該3000毫秒后結(jié)束",function (over) {
        var a=false;
        var b = function () {
            a=true;
            assert.ok(a);
            over();
        };
        setTimeout(b,2500);
    })
})

這個(gè)測(cè)試用例在執(zhí)行 it 塊的時(shí)候傳入了一個(gè)參數(shù) over，在測(cè)試結(jié)束的時(shí)候必須顯式的調(diào)用這個(gè)函數(shù)，告訴Mocha測(cè)試結(jié)束了，否則Mocha就會(huì)等到超時(shí)結(jié)束的時(shí)候報(bào)錯(cuò)。

輸入命令運(yùn)行測(cè)試用例

我們也可以測(cè)試異步請(qǐng)求內(nèi)部地址或者外部的接口，這里我們請(qǐng)求內(nèi)部地址為例子：
在根目錄新建：app.js

var express = require("express")
var app = express();

app.get("/api/test",function (req,res) {
    res.send({})
})

var port = process.env.PORT || 3000

if (process.env.NODE_ENV !== "test") {
    app.listen(port);
    console.log("start from http://localhost:" + port)
} else {
        module.exports = app;
}

在test目錄下的lib文件夾中新建 async.js

//test/lib/async.js

var http = require("http")
var assert = require("assert")
var request = require("superagent");

describe("測(cè)試異步請(qǐng)求",function () {
    it("測(cè)試異步請(qǐng)求返回一個(gè)對(duì)象",function (next) {
        request
            .get("http://localhost:3000/api/test")
            .end(function(err, res){
                //expect(res).to.be.an("object");
                console.log(res.body);
                assert.deepEqual(res.body,Object)
                next();
            });
    })
})

測(cè)試結(jié)果

Mocha支持對(duì)Promist的測(cè)試，允許直接返回Promise,等到他的狀態(tài)發(fā)生變化之后，再執(zhí)行斷言

//test/lib/promise.js

var fetch = require("node-fetch");
var http = require("http")
var assert = require("assert")

describe("Promise 異步測(cè)試",function () {
    it("異步Promise返回一個(gè)對(duì)象",function () {
        return fetch("http://localhost:3000/api/test")
            .then(function(res) {
                return res.json();
            }).then(function(json) {
                console.log(json)
                assert.deepEqual(json,{});
            });
    })
})

執(zhí)行測(cè)試

測(cè)試的鉤子

在 describe 塊之中，有四個(gè)測(cè)試用例的鉤子：before()、after()、beforeEach()和afterEach()。它們會(huì)在指定時(shí)間執(zhí)行。

describe("hooks", function() {   
  before(function() {    
   // 在當(dāng)前區(qū)塊的所有測(cè)試用例之前執(zhí)行  
 });   
  after(function() {     
   // 在當(dāng)前區(qū)塊的所有測(cè)試用例之后執(zhí)行   
 });   
  beforeEach(function() {    
  // 在當(dāng)前區(qū)塊的每個(gè)測(cè)試用例之前執(zhí)行   
 });   
  afterEach(function() {    
  // 在當(dāng)前區(qū)塊的每個(gè)測(cè)試用例之后執(zhí)行   
 }); 
  //測(cè)試用例  
});

在test目錄下的lib文件夾中新建 hooks.js

//test/lib/hooks.js
var assert = require("assert")

describe("hook示例", function() {
    var foo = false;

    beforeEach(function() {
        foo = true;
    });

    it("修改foo要成功", function() {
        assert.ok(foo)
    });
});

測(cè)試結(jié)果

測(cè)試用例管理

如果項(xiàng)目有很多測(cè)試用例，但有的時(shí)候只希望運(yùn)行其中幾個(gè)，這個(gè)時(shí)候可以用 only 方法，describe 塊和 it 塊都允許 only 方法，表示只允許運(yùn)行帶有 only 的測(cè)試用例

在test目錄下的lib文件夾中新建 only.js

//test/lib/only.js

var sum = require("../../lib/sum")
var assert = require("assert")

describe("和函數(shù)的測(cè)試",function () {
    it("1加2應(yīng)該等于3",function () {
        var expect=3;
        assert.equal(sum(1,2),expect);
    })

    it.only("3加4應(yīng)該等于7",function () {
        var expect=7;
        assert.equal(sum(3,4),expect);
    })
})

測(cè)試結(jié)果：

還有 skip 方法，表示跳過(guò)指定的測(cè)試用例

在test目錄下的lib文件夾中新建 skip.js

//test/lib/only.js

var sum = require("../../lib/sum")
var assert = require("assert")

describe("和函數(shù)的測(cè)試",function () {
    it("5加6應(yīng)該等于11",function () {
        var expect=11;
        assert.equal(sum(5,6),expect);
    })

    it.skip("7加8應(yīng)該等于15",function () {
        var expect=15;
        assert.equal(sum(7,8),expect);
    })
})

測(cè)試結(jié)果如下，跳過(guò)的用 - 號(hào)表示