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

发表于 4年以前  | 总阅读数:1345 次

概述

在日常的功能开发中,我们的代码测试都依赖于自己或者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,可以自行阅读JestSinon.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请求的,我们将会在后面几篇博客中给大家带来相关的源码解析,有兴趣的同学可以关注我,留意后续的文章。

附录

本文由哈喽比特于4年以前收录,如有侵权请联系我们。
文章来源:https://github.com/HJava/myBlog

 相关推荐

刘强东夫妇:“移民美国”传言被驳斥

京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。

发布于:6月以前  |  808次阅读  |  详细内容 »

博主曝三大运营商,将集体采购百万台华为Mate60系列

日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。

发布于:6月以前  |  770次阅读  |  详细内容 »

ASML CEO警告:出口管制不是可行做法,不要“逼迫中国大陆创新”

据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。

发布于:6月以前  |  756次阅读  |  详细内容 »

抖音中长视频App青桃更名抖音精选,字节再发力对抗B站

今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。

发布于:6月以前  |  648次阅读  |  详细内容 »

威马CDO:中国每百户家庭仅17户有车

日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。

发布于:6月以前  |  589次阅读  |  详细内容 »

研究发现维生素 C 等抗氧化剂会刺激癌症生长和转移

近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。

发布于:6月以前  |  449次阅读  |  详细内容 »

苹果据称正引入3D打印技术,用以生产智能手表的钢质底盘

据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。

发布于:6月以前  |  446次阅读  |  详细内容 »

千万级抖音网红秀才账号被封禁

9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...

发布于:6月以前  |  445次阅读  |  详细内容 »

亚马逊股东起诉公司和贝索斯,称其在购买卫星发射服务时忽视了 SpaceX

9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。

发布于:6月以前  |  444次阅读  |  详细内容 »

苹果上线AppsbyApple网站,以推广自家应用程序

据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。

发布于:6月以前  |  442次阅读  |  详细内容 »

特斯拉美国降价引发投资者不满:“这是短期麻醉剂”

特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。

发布于:6月以前  |  441次阅读  |  详细内容 »

光刻机巨头阿斯麦:拿到许可,继续对华出口

据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。

发布于:6月以前  |  437次阅读  |  详细内容 »

马斯克与库克首次隔空合作:为苹果提供卫星服务

近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。

发布于:6月以前  |  430次阅读  |  详细内容 »

𝕏(推特)调整隐私政策,可拿用户发布的信息训练 AI 模型

据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。

发布于:6月以前  |  428次阅读  |  详细内容 »

荣耀CEO谈华为手机回归:替老同事们高兴,对行业也是好事

9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。

发布于:6月以前  |  423次阅读  |  详细内容 »

AI操控无人机能力超越人类冠军

《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。

发布于:6月以前  |  423次阅读  |  详细内容 »

AI生成的蘑菇科普书存在可致命错误

近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。

发布于:6月以前  |  420次阅读  |  详细内容 »

社交媒体平台𝕏计划收集用户生物识别数据与工作教育经历

社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”

发布于:6月以前  |  411次阅读  |  详细内容 »

国产扫地机器人热销欧洲,国产割草机器人抢占欧洲草坪

2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。

发布于:6月以前  |  406次阅读  |  详细内容 »

罗永浩吐槽iPhone15和14不会有区别,除了序列号变了

罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。

发布于:6月以前  |  398次阅读  |  详细内容 »
 目录