前端单元测试框架Jest初识

对于一个完整的前端工程,单元测试是不可缺少的一部分。但我们之所以很少使用单元测试,是对单元测试的认知不够,所以接下来,我们了解一下什么是单元测试。

前端单元测试是什么?

检测目标是否符合标准而用专业的工具和方法验证,最终得到特定结果。
对于前端开发来讲,特定目标是指代码,工具就是我们需要用到的测试框架(库)、测试用例等。

常用工具

MochaJest,在开发中,我推荐使用Jest,从下载量和stats量来看,Jest也远高于Mocha。参见:jest vs mocha

原理以及如何使用

test

第一步:yarn add --dev jest
第二步:添加命令
{
  "scripts": {
    "test": "jest"
  }
}
第三步: 配置

jest.config.js

module.exports = {
  // 是否显示覆盖率报告
  collectCoverage: true,
};

配置jest.config.js也可以使用 npx jest --init 命令帮我们初始化配置


image.png

通过 ts-jest 使用 TypeScript

yarn add ts-jest -D

添加配置 preset: "ts-jest"

babel.config.js

module.exports = {
  presets: [
    ["@babel/preset-env", { targets: { node: "current" } }],
    "@babel/preset-typescript",
  ],
};
第四步:编写测试代码

创建ts文件
图片一

创建*.test.ts测试文件,注意命名时遵循xxx.test.ts的命名规则
图片二
第五步:运行

yarn test
image.png
  • %stmts是语句覆盖率:是不是每个语句都执行了
  • %Branch分支覆盖率:是不是每个if代码块都执行了
  • %Funcs函数覆盖率:是不是每个函数都调用了
  • %Lines行覆盖率:是不是每一行都执行了
  • Uncovered Line #s:没有执行的代码行
断言

“断言”通常用于判断在某些逻辑条件下会执行某种预期的结果,Jest框架内置了丰富的断言语句Expect
测试值的时候我们通常会使用expect来断言值的内容,用下面代码段举例,有一个sumAdd函数会反回数字加一的值,我们测试的代码

describe("index.ts", () => {
  test("test index", () => {
    // toBe 匹配器有种类似于object.is或者===
    expect(sumAdd(1)).toBe(2);
  });

  test("test index NaN", () => {
    expect(sumAdd(NaN)).toBe(0);
  });
});

在以上情况toBe是匹配器功能,匹配我们函数返回值和预期的值是否相等。像这样的匹配器官方提供很多,值得一提的匹配器是.toMatchInlineSnapshot,用来确保值与最近的快照匹配,用法例如以下代码段

describe("index.ts", () => {
  test("test index", () => {
    // toBe 匹配器有种类似于object.is或者===
    expect(sumAdd(1)).toBe(2);
    expect(sumAdd(1)).toMatchSnapshot();
  });

  test("test index NaN", () => {
    expect(sumAdd(NaN)).toBe(0);
    expect(sumAdd(NaN)).toMatchSnapshot();
  });
});

在运行yarn test之后,会在同级目录产生一个份文件,保存快照,后面每次运行快照时都会对比,可以执行yarn test – -u或者手动删除快照文件,如果代码有更新,我们可以jest --updateSnapshot更新缓存的文件
image.png

index.test.ts.snap就是我们快照的内容
image.png

参考源码位置:
image.png

image.png
生命周期勾子

jest提供了一些测试的生命周期API,可以辅助我们在每个case的开始结束做一些处理。列举4个主要的生命周期勾子:

  • afterAll:当前文件中的所有测试执行完成后执行 fn,如果 fn 是promise,jest 会等待timeout 毫秒,默认 5000
  • afterEach:每个 test 执行完后执行 fn,timeout 含义同上
  • beforeAll:同 afterAll,不同之处在于在所有测试开始前执行
  • beforeEach:同 afterEach,不同之处在于在每个测试开始前执行
image.png

参考源码位置:
image.png
模拟函数

使用模拟函数通过jest.fn()创建,如果没有函数定义会返回undefined,通过日志打印返回值如下:


image.png

假设我们要测试某循环函数的内部实现,这个函数为传入的数组中的每个元素调用一次回调函数,我们可以使用jest.fn()模拟回调函数,来测试循环函数的内部实现

image.png

所有的 mock 函数都有这个特殊的 .mock属性,它保存了关于此函数如何被调用、调用时的返回值的信息。Mock 有返回值,并且在测试期间也可以将测试值注入代码。


image.png

总结:以上是全文内容,简述关于Jest使用流程和方法,相信阅读之后您也可以尝试一下编写测试代码的快乐。

参考文章:https://juejin.cn/post/7039108357554176037

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,053评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,527评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,779评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,685评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,699评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,609评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,989评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,654评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,890评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,634评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,716评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,394评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,976评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,950评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,191评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,849评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,458评论 2 342

推荐阅读更多精彩内容