nodejs学习笔记——利用Mocha做单测

前言

Mocha（发音"摩卡"）诞生于2011年，是现在最流行的JavaScript测试框架之一，在浏览器和Node环境都可以使用。

所谓"测试框架"，就是运行测试的工具。通过它，可以为JavaScript应用添加测试，从而保证代码的质量。假设我们使用TDD作nodejs开发，可以选择Mocha作测试工具。

---

Mocha

基本用法

先写好test.js单测文件。在控制台run mocha test.js 即可

断言库

Mocha推荐了几种断言库。
should.js、expect.js、chai、better-assert、unexpected等
以should举例（阮老师的例子选用了chai）

var should = require('should');
 
var user = {
    name: 'tj'
  , pets: ['tobi', 'loki', 'jane', 'bandit']
};
 
user.should.have.property('name', 'tj');
user.should.have.property('pets').with.lengthOf(4);

例子里就和英文表达一样，user应该有属性name和tj，pets属性应该带有4个长度。基本的作用就是不需要额外再去写对应的error了，统一用断言库也更加凡用。

命令行参数

• --recursive测试路径下所有文件，不配置只会执行第一层测试用例
• --reporter spec，-R指定测试报告的格式，默认是spec格式
• --watch，-w监听改动自动运行
• --bail，-b指定只要有一个测试用例没有通过，就停止执行后面的测试用例。这对持续集成很有用。
• --grep，-g用于搜索测试用例的名称（即it块的第一个参数），然后只执行匹配的测试用例。
• --invert，-i表示只运行不符合条件的测试脚本，必须与--grep参数配合使用。（条件反一反）

es6测试

如果测试脚本是用ES6写的，那么运行测试之前，需要先用Babel转码。安装Babel，配置babel.rc。
以前会在执行命令的时候加上参数--compilers js:babel-core/register，转码后跑脚本。Mocha的compilers-deprecation里面提到现在--compilers是多余的不建议继续再使用下去，用--require可以完美覆盖我们所需的所有场景。
例如上面的例子

// 使用compilers
mocha --compilers js:babel-core/register --recursive ./test
// 使用require，(** ≈ recursive) 
mocha --require babel-core/register "test/**/*.js"
// 默认情况下Mocha只支持.js文件，官方建议
// 交给glob来处理 (https://www.npmjs.com/package/glob)
mocha --require coffee-script/register "test/**/*.{js,coffee}"

钩子

describe('hooks', function() {
  before(function() {
    // 在本区块所有测试用例之前执行
  });
  after(function() {
    // 在本区块所有测试用例之后执行
  });
  beforeEach(function() {
    // 在本区块每个测试用例之前执行
  });
  afterEach(function() {
    // 在本区块每个测试用例之后执行
  });
  // test cases
});

管理

利用only只执行、skip跳过指定用例。

---

sinon

Sinon具有独立的fake、spies、stub、mock功能，Sinon本身不是测试框架，它提供了帮助测试的功能。常用来处理测试接口请求、跟踪、数据库处理等操作。

var mock;
mock = sinon.mock(require('mysql'))
mock.expects('query').with(queryString, queryParams).yields(null, rows);
// 拦截mysql的query方法，返回mock数据，不对数据库进行实际操作
mock.verify()
// 校验是否按预期值，例如没有执行mysql.query
mock.restore()
// 测试结束后恢复mysql功能，例如写在after中，否则容易影响到其他单测

该例子中，借助sinon的mock方法，queryString, queryParams为用户输入，rows为输出。
当单测时引入mysql调用query方法，会被sinon自动拦截到。
简单概括就是借助sinon我们可以轻易完成单测中的数据库调用、请求模拟，因为在接口或者是sql语句完善的前提下不需要在去调用，同时不想因为跑单测影响到即便是测试环境的数据库表。
如果是需要替换单个方法建议使用stub更精确，mock更适用于简单的替换多个方法。

sinon的具体用法建议移步Sinon.JS官方文档查阅详细内容

---

nyc

原来叫Istanbul？后来因为政治原因改名为nyc
便于查看单测覆盖率，找出未覆盖到的代码行数。

// package.json
"test": "mocha --recursive",
"coverage": "nyc npm run test"

使用方法非常简单，可以在package.json中添加指令，支持直接调用npm命令。

---

心得

TDD的开发模式，在前端日常开发中尤其是一些业务性很强的场景很难派上用场，一是有dead line的威胁，二是业务的变化性不可预测。但是nodejs这种做的是后端的事情，写单测其实是很合理的事情。
在没有dead line的威胁，tdd特别适合思路发散、常常迷糊的人。它让人有安全感，有这一个明确的思路去执行，更确定自己的想法落实了。
置于单测的书写也很流畅，describe描述测试内容，it描述测试出错信息，也可以借助断言库去表达，整个流程下来语义化很强。

---

参考

Mocha官网
阮一峰-测试框架 Mocha 实例教程
阮一峰-持续集成
Sinon.JS