提升代码质量——使用Jest和Sinon给已有的代码添加单元测试

概述

在平常的功能开发中，咱们的代码测试都依赖于本身或者QA进行测试。这些操做不只费时费力，并且还依赖开发者自身的驱动。在开发一些第三方依赖的库时，咱们也没有办法给第三方提供完整的代码质量报告。

如今，咱们可使用单元测试来提升本身的代码质量。下面，我将本身在使用Jest和Sinon.js配置和编写单元测试中的收获的经验和踩到的坑进行总结，根据从零开始配置和编写单元测试这一条线来进行分享。

经过本文，你能够解决如下问题：

• Jest与Sinon.js是什么？
• 如何配置Jest与Sinon.js，从而编写单元测试？
• 如何解决进行单元测试中遇到的常见问题？

Jest与Sinon.js是什么

Jest是FaceBook推出的一个针对JavaScript进行单元测试的库，它提供了断言、函数模拟等API来对你本身编写的业务逻辑代码进行测试后。

Sinon.js是一个用来作独立测试和模拟的JavaScript库。它在单元测试的编写中一般用来模拟HTTP等相关请求。

为何没有用其余的单元测试框架

在最开始的框架选择中，我先尝试了可以并行测试，大大提升单元测试速度的ava框架。它能知足平常的普通需求如utils工具集的测试，也可以配置Sinon.js来进行HTTP模拟测试。

可是，在处理webpack alias的问题时，经过官方issue中的极其复杂的配置也没有可以解决出现Cannot find module的问题（其中一个解决此问题的插件babel-plugin-webpack-loaders中居然是推荐直接使用Jest，囧）。

而在Jest中，能够很方便的经过一些简单配置，就可以识别在文件中使用的webpack alias，相关的具体方法将会在后面章节进行具体描述。

而对于其余的测试框架如：Mocha或者Chai等，没有进行具体的了解，所以在这里很少作评价。

如何配置Jest与Sinon.js，从而编写单元测试？

Jest配置

安装依赖包

须要使用Jest，首先你须要进行安装，执行如下命令:

npm install jest -D
复制代码

若是你的项目中存在.babelrc文件（使用了babel 6）时，不论你测试的代码是否经过babel进行编译，你都须要安装额外的几个包：

npm install babel-jest babel-core regenerator-runtime -D
复制代码

若是你使用的是babel 7，则须要安装下面几个包：

npm install babel-jest 'babel-core@^7.0.0-0' @babel/core regenerator-runtime -D
复制代码

package.json文件配置

在安装完成依赖包之后，若是你有相关的jest配置项须要设置，你还能够在package.json文件中配置以下字段：

{
  "jest": {
    
  }
}
复制代码

.babelrc文件只须要保存以前的配置，不须要作任何修改便可生效。

Sinon.js配置

依赖包安装

安装配置完了Jest，让咱们来看下Sinon.js。须要使用Sinon.js，咱们首先须要进行安装：

npm install sinon -D
复制代码

配置完成后，须要在使用的地方进行引入，以下所示：

const sinon = require('sinon');
复制代码

在个人项目中，主要是使用Sinon.js来模拟HTTP请求。在Sinon.js的文档中，有专门关于XMLHttpRequest对象的模拟的章节，在下一章中，咱们将会针对项目中sinon.js的使用进行简单的介绍。

编写单元测试

在本章中，咱们会针对如何编写单元测试文件进行一个具体的讲解，其中包含：

• 同步函数测试
• 异步函数测试
• HTTP测试

同时，咱们会对当中使用到的Jest和Sinon.js的API会进行简单介绍，若是须要使用其余的API，能够自行阅读Jest和Sinon.js的文档。

经过上面三类测试，咱们基本可以覆盖现有项目中的全部代码。

同步函数测试

同步函数的测试过程是这几个中最简单的一部分，咱们能够测试函数返回值，也可以测试传入的高阶函数。下面咱们经过一个具体的例子来看下。

源代码文件，一个纯函数：

// user.js
export default function(obj) {
    return 'hjava';
}

export function handleUserData(callback) {
    callback('hjava');
}
复制代码

针对上面的源代码文件编写的一个单元测试文件：

// user.test.js
import userFunc, {handleUserData} from './user';

// test是一个注册的全局方法
test('user', () => {
    expect(userFunc()).toBe('hjava'); // 判断userFunc的执行结果等于'hjava'
    
    let callback = jest.fn(); // jest是一个注册的全局变量
    handleUserData(callback);

    expect(callback.mock.calls.length).toBe(1); // 判断callback函数被调用了一次
    expect(callback.mock.calls[0][0]).toBe('hjava'); // 判断了callback函数的第一次被调用的第一个参数为'hjava'
});
复制代码

从上面的示例中咱们能够看到，针对同步的纯函数，咱们能够经过很简单的单元测试模型来验证它的功能。

异步函数测试

异步函数主要分为两种——Callback方式和Promise方式。这两种方式都很简单，下面咱们对两种方式进行具体的介绍。详细内容能够见Jest文档中的测试异步代码。

Callback方式

// user.js
export default function(callback) {
    setTimeout(()=>{
        callback({username: 'hjava'});
    }, 1000);
}
复制代码

// user.test.js
import userFunc from './user';

test('user', () => {
    userFunc((data) => {
        expect(data).toEqual({username: 'hjava'}); // 对象比较用beEqual()
    });
});
复制代码

Promise方式

// user.js
export default function(callback) {
    return Promise.resolve({username: 'hjava'});
}

复制代码

// user.test.js
import userFunc from './user';

test('user', () => {
    userFunc().then((data) => {
        expect(data).toEqual({username: 'hjava'});
    });
});
复制代码

HTTP测试

在测试HTTP请求相关参数的过程当中，咱们须要模拟XMLHttpRequest对象，从而拦截相关的HTTP请求，获取请求数据。正好Sinon.js可以作到这一点。下面咱们经过一个示例来看下相关的逻辑：

// user.js
export default function(callback) {
    this.sendRequest('/user/get', callback); // 发送请求来获取用户数据，成功后执行callback回调函数
}
复制代码

// user.test.js
import Sinon from 'sinon';
import userFunc from 'user';

let XHR;
let requests = [];
// beforeEach是Jest提供的函数，在每一个测试执行前都会执行一次
beforeEach(() => {
    XHR = sinon.useFakeXMLHttpRequest(); //建立一个模拟的XMLHttpRequest对象

    XHR.onCreate = function (xhr) {
        requests.push(xhr);
    };
});

// afterEach是Jest提供的函数，在每一个测试执行后都会执行一次
afterEach(() => {
    XHR.restore();
});

test('user', () => {
    let callback = jest.fn();

    HTTPCommon.deleteRemoteSession({
        data: {},
        success: callback
    });

    expect(requests.length).toBe(1);

    requests[0].respond(200, {"Content-Type": 'application/json'}, 'hjava'); // 模拟返回值

    expect(callback.mock.calls[0][0]).toBe('hjava');
});
复制代码

如何解决进行单元测试中遇到的常见问题？

在本章中，咱们总结了以下问题来进行介绍，但愿你们再遇到相同问题时可以快速解决：

• 如何统计Jest单元测试覆盖率
• 如何设置单元测试文件不使用本地的babel配置
• 如何设置单元测试文件使用本地的babel配置
• 如何处理代码中引用的webpack alias问题

如何统计单元测试覆盖率？

不像ava同样，须要使用syc来进行计算，Jest内置了统计单元测试覆盖率的工具，只须要简单配置便可达到相关的要求。具体配置以下：

// package.json
{
  "jest": {
    "collectCoverage": true, // 是否开启统计单元测试覆盖率
    "collectCoverageFrom": [ // 指定统计单元测试覆盖率文件
      "**/src/**.js"
    ],
  }
}
复制代码

如何设置单元测试文件不使用ES2015配置

若是你的项目中有.babelrc文件，而你不但愿单元测试文件受到babel文件的影响，你能够在jest的配置项中增长transform字段，具体配置以下:

// package.json
{
  "jest": {
    "transform": {}
  }
}
复制代码

如何设置单元测试使用ES2015配置

若是你的单元测试文件中须要使用ES2015后经过babel来进行编译，那么须要对.babelrc文件的配置进行部分修改。

若是你以前在.babelrc文件中，把modules字段设置为false，那么你须要在test环境下从新开启，具体代码以下：

// .babelrc
{
  "presets": [["env", {"modules": false}]],
  "env": {
    "test": {
      "presets": [["env"]]
    }
  }
}
复制代码

若是你使用的是babel 7的话（安装时多安装过相关依赖包），你须要设置的presets字段的值应该为@babel/env，具体代码以下：

// .babelrc
{
  "presets": [["env", {"modules": false}]],
  "env": {
    "test": {
      "presets": [["@babel/env"]]
    }
  }
}
复制代码

如何处理代码中引用的webpack alias问题

若是咱们在项目中使用了webpack，那么咱们很大几率会使用到alias相关属性来定义路径。可是，在单元测试框架中，它并不可以识别这种路径，就会出现Cannot find module 'xxx' from 'yyy'的报错。

不像ava框架须要安装插件和进行复杂的配置，咱们只须要在Jest中配置moduleNameMapper属性便可知足需求。具体示例以下：

// webpack.config.js
{
    alias: {
        '@__dir':process.cwd()
    }
}
复制代码

//package.json
{
    "jest": {
        "moduleNameMapper": {
        "@__dir(.*)$": "<rootDir>$1" //正则匹配方式，对应webpack alias
        }
    }
}
复制代码

总结

编写测试是一个很好的习惯。

不少人常常都说要对本身的代码进行质量监控，可是又不知道该如何下手。经过这篇文章，你应该学会了如何针对已有代码从零开始编写一套完整的单元测试用例。

若是有任何疑问，欢迎留言或者私信进行沟通与交流。

关于Jest是如何测试JavaScript代码以及Sinon是如何模拟XMLHttpRequest请求的，咱们将会在后面几篇博客中给你们带来相关的源码解析，有兴趣的同窗能够关注我，留意后续的文章。

附录

• Jest
• Sinon.js
• ava
• ava关于配置解决webpack alias的issue
• Mocha
• Chai