A brief introduction to the testing framework Mocha under NodeJs-JS Tutorial-php.cn

Introduction and code download

Mocha was released in 2011 and is currently one of the most popular javascript frameworks. In this article we focus on its use on NodeJs.

If you need to download the example code, you can find it by going to the official website. https://mochajs.org/

After downloading the code, install the dependencies:

$ cd DemoOfMocha
$ npm install

Copy after login

The code directory structure is as shown in the figure:

A brief introduction to the testing framework Mocha under NodeJs

You can create a new lib folder and test folder in the root directory according to the code directory structure, then create a new lib folder in the test folder, and then use the npm init command to Generate package.json, you can also download the code and run it first

First test

Now create a new sum.js file in the lib directory

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

Copy after login

Next, test this script and create a new test script in the lib folder under the test directory: sum.js

//test/lib/sum.js

var sum = require(&#39;../../lib/sum&#39;)
var assert = require(&#39;assert&#39;)

describe(&#39;和函数的测试&#39;,function () {
 it(&#39;1加1应该等于2&#39;,function () {
 var expect=10;
 assert.equal(sum(1,1),expect);
 })
})

Copy after login

The above code is a test script. The test script can be executed independently. The test script should contain one or more describe blocks, and each describe block should also contain one or more it blocks

## The #describe block is a "test suite", which represents a group of related tests, which is a function, and the second one is the function that can actually be executed

It block is a "test case" which represents a single test, the test The smallest unit is also a function. The first parameter is the name or description of the test case, and the second parameter is the actual executable function

assert is the assertion package (there are many types of assertion packages, here I use NodeJs to With the assertion package), it is judged whether the execution result of the test code is consistent with the expected result. If it is inconsistent, an error will be thrown. In our test script, sum(1,1), the result should be equal to 2

Here we introduce some functions of Assert's assertion module

assert.fail(actual, expected, message, operator)

Copy after login

Use the specified operator to test whether actual (real value) is equal to expected (expected value) consistent.

assert.ok(value, [message])

Copy after login

Test whether the actual value is true, which has the same effect as assert.equal(true, value, message);

assert.equal(actual, expected, [message])

Copy after login

Use the equality comparison operator (==) to test whether the actual value is shallow, coercive and equal to the expected value.

assert.notEqual(actual, expected, [message])

Copy after login

Use the inequality comparison operator (!=) to test whether the actual value is shallow (shallow), coercive (coercive) and the expected value is not equal.

assert.deepEqual(actual, expected, [message])

Copy after login

Test whether the actual value is deeply equal to the expected value.

assert.notDeepEqual(actual, expected, [message])

Copy after login

Test whether the actual value is deeply unequal to the expected value.

assert.strictEqual(actual, expected, [message])

Copy after login

Use the strict equality operator ( === ) to test whether the actual value is strictly equal to the expected value.

assert.notStrictEqual(actual, expected, [message])

Copy after login

Use the strict inequality operator ( !== ) to test whether the actual value is strictly not equal to the expected value.

assert.throws(block, [error], [message])

Copy after login

Throws an error (error) when a block is expected. The error can be a constructor, a regular expression or other validator.

Next we update the scripts field in package.json

{
 "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"
}

Copy after login

We install MochaJS through the npm command

$ npm install mocha --save-dev

Copy after login

We added the command to run the test, and then use the command to obtain the test report

$ npm test

Copy after login

The test report is as follows:

A brief introduction to the testing framework Mocha under NodeJs

In this way, our first test was successful

Let the test report become more beautiful

We can use the mochawesome module to generate a beautiful report in HTML format, as shown in the figure:

A brief introduction to the testing framework Mocha under NodeJs

Install mochawesome through the following command

$ npm install --save-dev mochawesome

Copy after login

Then update the scripts field in package.json

 "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”
}

Copy after login

Run the test command , the test report is generated in mochawesome-reports

A brief introduction to the testing framework Mocha under NodeJs

Open the html page with a browser, we will see a beautiful test report

A brief introduction to the testing framework Mocha under NodeJs

异步测试

Mocha默认每个测试用例最多执行2000毫秒，2000毫秒之后没有得到结果，就会报错，如果涉及到异步操作的测试用例，2000毫秒是不够的，这个时候我们需要用 -t 或 —timeout 参数指定超时门槛

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

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

Copy after login

写一个异步测试脚本

//test/lib/timeout.js


var assert = require(&#39;assert&#39;)

describe(&#39;测试应该3000毫秒后结束&#39;,function () {
 it(&#39;测试应该3000毫秒后结束&#39;,function (over) {
 var a=false;
 var b = function () {
  a=true;
  assert.ok(a);
  over();
 };
 setTimeout(b,2500);
 })
})

Copy after login

这个测试用例在执行 it 块的时候传入了一个参数 over，在测试结束的时候必须显式的调用这个函数，告诉Mocha测试结束了，否则Mocha就会等到超时结束的时候报错。

输入命令运行测试用例

A brief introduction to the testing framework Mocha under NodeJs

我们也可以测试异步请求内部地址或者外部的接口，这里我们请求内部地址为例子：

在根目录新建：app.js

var express = require(&#39;express&#39;)
var app = express();

app.get(&#39;/api/test&#39;,function (req,res) {
 res.send({})
})

var port = process.env.PORT || 3000

if (process.env.NODE_ENV !== &#39;test&#39;) {
 app.listen(port);
 console.log(&#39;start from http://www.php.cn/:&#39; + port)
} else {
 module.exports = app;
}

Copy after login

在test目录下的lib文件夹中新建 async.js

//test/lib/async.js

var http = require(&#39;http&#39;)
var assert = require(&#39;assert&#39;)
var request = require(&#39;superagent&#39;);

describe("测试异步请求",function () {
 it("测试异步请求返回一个对象",function (next) {
 request
  .get(&#39;http://localhost:3000/api/test&#39;)
  .end(function(err, res){
  //expect(res).to.be.an(&#39;object&#39;);
  console.log(res.body);
  assert.deepEqual(res.body,Object)
  next();
  });
 })
})

Copy after login

测试结果

A brief introduction to the testing framework Mocha under NodeJs

Mocha支持对Promist的测试，允许直接返回Promise,等到他的状态发生变化之后，再执行断言

//test/lib/promise.js

var fetch = require(&#39;node-fetch&#39;);
var http = require(&#39;http&#39;)
var assert = require(&#39;assert&#39;)

describe(&#39;Promise 异步测试&#39;,function () {
 it(&#39;异步Promise返回一个对象&#39;,function () {
 return fetch(&#39;http://localhost:3000/api/test&#39;)
  .then(function(res) {
  return res.json();
  }).then(function(json) {
  console.log(json)
  assert.deepEqual(json,{});
  });
 })
})

Copy after login

执行测试

A brief introduction to the testing framework Mocha under NodeJs

测试的钩子

在 describe 块之中，有四个测试用例的钩子：before()、after()、beforeEach()和afterEach()。它们会在指定时间执行。

describe(&#39;hooks&#39;, function() { 
 before(function() { 
 // 在当前区块的所有测试用例之前执行 
 }); 
 after(function() { 
 // 在当前区块的所有测试用例之后执行 
 }); 
 beforeEach(function() { 
 // 在当前区块的每个测试用例之前执行 
 }); 
 afterEach(function() { 
 // 在当前区块的每个测试用例之后执行 
 }); 
 //测试用例 
});

Copy after login

在test目录下的lib文件夹中新建 hooks.js

//test/lib/hooks.js
var assert = require(&#39;assert&#39;)

describe(&#39;hook示例&#39;, function() {
 var foo = false;

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

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

Copy after login

测试结果

A brief introduction to the testing framework Mocha under NodeJs

测试用例管理

如果项目有很多测试用例，但有的时候只希望运行其中几个，这个时候可以用 only 方法，describe 块和 it 块都允许 only 方法，表示只允许运行带有 only 的测试用例

在test目录下的lib文件夹中新建 only.js

//test/lib/only.js

var sum = require(&#39;../../lib/sum&#39;)
var assert = require(&#39;assert&#39;)

describe(&#39;和函数的测试&#39;,function () {
 it(&#39;1加2应该等于3&#39;,function () {
 var expect=3;
 assert.equal(sum(1,2),expect);
 })

 it.only(&#39;3加4应该等于7&#39;,function () {
 var expect=7;
 assert.equal(sum(3,4),expect);
 })
})

Copy after login

测试结果：

A brief introduction to the testing framework Mocha under NodeJs

还有 skip 方法，表示跳过指定的测试用例

在test目录下的lib文件夹中新建 skip.js

//test/lib/only.js

var sum = require(&#39;../../lib/sum&#39;)
var assert = require(&#39;assert&#39;)

describe(&#39;和函数的测试&#39;,function () {
 it(&#39;5加6应该等于11&#39;,function () {
 var expect=11;
 assert.equal(sum(5,6),expect);
 })

 it.skip(&#39;7加8应该等于15&#39;,function () {
 var expect=15;
 assert.equal(sum(7,8),expect);
 })
})

Copy after login

测试结果如下，跳过的用 - 号表示

A brief introduction to the testing framework Mocha under NodeJs