Egg单元测试学习

单元测试的好处

  • 代码质量持续有保障

  • 重构正确性保障

  • 增强自信心

  • 自动化运行

对于应用的 Controller、Service、Helper、Extend 等代码,都必须有对应的单元测试保证代码质量

测试框架

  • Mocha

  • AVA

断言库

power-assert

测试约定

测试目录结构

约定 test 目录为存放所有测试脚本的目录。

测试脚本文件统一按 ${filename}.test.js 命名(注意:必须以 .test.js 作为文件后缀)。

测试运行工具

使用egg-bin来运行测试脚本(它会自动将内置的 Mochaco-mochapower-assertnyc 等模块组合引入到测试脚本中)

  1. 配置

    package.json上配置好scripts.test

{
     "scripts": {
     "test": "egg-bin test"
     }
}
  1. 运行测试
npm test

准备测试

mock

app

测试前,创建应用的一个app实例,来访问需要被测试的ControllerMiddlewareService

// test/controller/home.test.js
const { app, mock, assert } = require('egg-mock/bootstrap');
​
describe('test/controller/home.test.js', () => {
 // test cases
});

ctx

结合 egg-mock 提供的 app.mockContext(options) 方法来快速创建一个 ctx 实例

const ctx = app.mockContext();

测试执行顺序

Mocha 使用 before/after/beforeEach/afterEach 来处理前置后置任务,基本能处理所有问题。 每个用例会按 before -> beforeEach -> it -> afterEach -> after 的顺序执行,而且可以定义多个

异步测试

egg-bin支持测试异步调用,支持多种写法:

  • 使用返回Promise的方式

  • 使用callback的方式

  • 使用async

Controller 测试·

Controllerrouter配置紧密相关,需要利用app.httpRequest() SuperTest发起一个真实请求,来将RouterController连接起来,并且可以帮助我们发送各种满足边界条件的请求数据, 以测试 Controller 的参数校验完整性。app.httpRequest() 是 egg-mock 封装的 SuperTest 请求实例。

app.httpRequest()可以发送GETPOSTPUT等HTTP请求

mock CSRF

框架的默认安全插件会自动开启 CSRF 防护。

egg-mock 对 app 增加了 app.mockCsrf() 方法来模拟取 CSRF token 的过程。 这样在使用 SuperTest 请求 app 就会自动通过 CSRF 校验。

Service测试

需要先创建一个 ctx,然后通过 ctx.service.${serviceName} 拿到 Service 实例, 然后调用 Service 方法即可。

Extend测试

应用可以对 Application、Request、Response、Context 和 Helper 进行扩展。我们针对性的编写单元测试

Application

egg-mock 创建 app 的时候,已经将 Application 的扩展自动加载到 app 实例了, 直接使用这个 app 实例访问扩展的属性和方法即可进行测试。

Context

Context 测试只比 Application 多了一个 app.mockContext() 步骤来模拟创建一个 Context 对象。

Request

通过 ctx.request 来访问 Request 扩展的属性和方法,直接即可进行测试。

Response

通过 ctx.response 来访问 Response 扩展的属性和方法,直接即可进行测试。

Helper

通过 ctx 来访问到 Helper,然后调用 Helper 方法测试。(ctx.helper)

Mock方法

egg-mock提供了非常多的mock方法

  • 不想在终端 console 输出任何日志,可以通过 mock.consoleLevel('NONE')来模拟

  • 想模拟一次请求的 Session 数据,可以通过 app.mockSession(data) 来模拟

mock之后会一直生效,为了避免每个单元测试用例之间不相互mock污染,通常我们都会在 afterEach 钩子里面还原掉所有 mock

describe('some test', () => {
 // before hook
​
 afterEach(mock.restore);
​
 // it tests
});

引入 egg-mock/bootstrap 时,会自动在 afterEach 钩子中还原所有的 mock,不需要在测试文件中再次编写

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

推荐阅读更多精彩内容