Jest中Mock网络请求
Jest中Mock网络请求
最近需要将一个比较老的库修改为TS
并进行单元测试,修改为TS
还能会一点,单元测试纯粹是现学现卖了,初学Jest
框架,觉得在单元测试中比较麻烦的就是测试网络请求,所以记录一下Mock
掉Axios
发起网络请求的一些方式。初学两天的小白,如有问题还请指出。
描述
文中提到的示例全部在 jest-axios-mock-server仓库 中,直接使用包管理器安装就可以启动示例,例如通过yarn
安装:
$ yarn install
在package.json
中指定了一些命令,分别如下:
npm run build
:rollup
的打包命令。npm run test:demo1
: 简单地mock
封装的网络请求库。npm run test:demo2
: 采用重新实现并hook
的方式完成mock
。npm run test:demo3
: 使用Jest
中的库完成demo2
的实现。npm run test:demo4-5
: 启动一个node
服务器,通过axios
的proxy
将网络请求进行代理,转发到启动的node
服务器,通过设置好对应的单元测试请求与响应的数据,利用对应关系实现测试,也就是jest-axios-mock-server
完成的工作。
在这里我们封装了一层axios
,比较接近真实场景,可以查看test/demo/wrap-request.ts
文件,实际上只是简单的在内部创建了一个axios
实例,并且转发了一下响应的数据而已,test/demo/index.ts
文件简单地导出了一个counter
方法,这里对于这两个参数有一定的处理然后才发起网络请求,之后对于响应的数据也有一定的处理,只是为了模拟一下相关的操作而已。
// test/demo/wrap-request.ts
import axios, { AxiosRequestConfig } from "axios";
const instance = axios.create({
timeout: 3000,
});
export const request = (options: AxiosRequestConfig): Promise<any> => {
// do something wrap
return instance.request(options).then(res => res.data);
};
// test/demo/index.ts
import { request } from "./wrap-request";
export const counter = (id: number, number: number): Promise<{ result: number; msg: string }> => {
const operate = number > 0 ? 1 : -1;
return request({
url: "https://www.example.com/api/setCounter",
method: "POST",
data: { id, operate },
})
.then(res => {
if (res.result === 0) return { result: 0, msg: "success" };
if (res.result === -100) return { result: -100, msg: "need login" };
return { result: -999, msg: "fail" };
})
.catch(err => {
return { result: -999, msg: "fail" };
});
};
此处的Jest
使用了JSDOM
模拟的浏览器环境,在jest.config.js
中配置的setupFiles
属性中配置了启动文件test/config/setup.js
,在此处初始化了JSDOM
。
import { JSDOM } from "jsdom";
const config = {
url: "https://www.example.com/",
domain: "example.com",
};
const dom = new JSDOM("", config);
global.document = dom.window.document;
global.document.domain = config.domain;
global.window = dom.window;
global.location = dom.window.location;
demo1: 简单Mock网络请求
在test/demo1.test.js
中进行了简单的mock
处理,通过npm run test:demo1
即可尝试运行,实际上是将包装axios
的wrap-request
库进行了一个mock
操作,在Jest
启动时会进行编译,在这里将这个库mock
掉后,所有在之后引入这个库的文件都是会获得mock
后的对象,也就是说我们可以认为这个库已经重写了,重写之后的方法都是JEST
的Mock Functions
了,可以使用诸如mockReturnValue
一类的函数进行数据模拟,关于Mock Functions
可以参考https://www.jestjs.cn/docs/mock-functions
。
// test/demo1.test.js
import { counter } from "./demo";
import { request } from "./demo/wrap-request";
jest.mock("./demo/wrap-request");
describe("Simple mock", () => {
it("test success", () => {
request.mockResolvedValue({ result: 0 });
return counter(1, 2).then(res => {
expect(res).toStrictEqual({ result: 0, msg: "success" });
});
});
it("test need login", () => {
request.mockResolvedValue({ result: -100 });
return counter(1, 2).then(res => {
expect(res).toStrictEqual({ result: -100, msg: "need login" });
});
});
it("test something wrong", () => {
request.mockResolvedValue({ result: 1111111 });
return counter(1, 2).then(res => {
expect(res).toStrictEqual({ result: -999, msg: "fail" });
});
});
});
在这里我们完成了返回值的Mock
,也就是说对于wrap-request
库中的request
返回的值我们都能进行控制了,但是之前也提到过对于传入的参数也有一定的处理,这部分内容我们还没有进行断言,所以对于这个我们同样需要尝试进行处理。
demo2: hook网络请求
demo2
通过npm run test:demo2
即可尝试运行,在上边提到了我们可以处理返回值的情况,但是没法断言输入的参数是否正确进行了处理,所以我们需要处理一下这种情况,所幸Jest
提供了一种可以直接实现被Mock
的函数库的方式,当然实际上Jest
还提供了mockImplementation
的方式,这个是在demo3
中使用的方式,在这里我们重写了被mock
的函数库,在实现的时候也可以使用jest.fn
完成Implementations
,这里通过在返回之前写入了一个hook
函数,并且在各个test
时再实现断言或者是指定返回值,这样就可以解决上述问题,实际上就是实现了Jest
中Mock Functions
的mockImplementation
。
// test/demo2.test.js
import { counter } from "./demo";
import * as request from "./demo/wrap-request";
jest.mock("./demo/wrap-request", () => {
let hook = () => ({ result: 0 });
return {
setHook: cb => (hook = cb),
request: (...args) => {
return new Promise(resolve => {
resolve(hook(...args));
});
},
};
});
describe("Simple mock", () => {
it("test success", () => {
request.setHook(() => ({ result: 0 }));
return counter(1, 2).then(res => {
expect(res).toStrictEqual({ result: 0, msg: "success" });
});
});
it("test need login", () => {
request.setHook(() => ({ result: -100 }));
return counter(1, 2).then(res => {
expect(res).toStrictEqual({ result: -100, msg: "need login" });
});
});
it("test something wrong", () => {
request.setHook(() => ({ result: 1111111 }));
return counter(1, 2).then(res => {
expect(res).toStrictEqual({ result: -999, msg: "fail" });
});
});
it("test param transform", () => {
return new Promise(done => {
request.setHook(({ data }) => {
expect(data).toStrictEqual({ id: 1, operate: 1 });
done();
return { result: 0 };
});
counter(1, 1000);
});
});
});
demo3: 使用Jest的mockImplementation
demo3
通过npm run test:demo3
即可尝试运行,在demo2
中的例子实际上是写复杂了,在Jest
中Mock Functions
有mockImplementation
的实现,直接使用即可。
// test/demo3.test.js
import { counter } from "./demo";
import { request } from "./demo/wrap-request";
jest.mock("./demo/wrap-request");
describe("Simple mock", () => {
it("test success", () => {
request.mockImplementation(() => Promise.resolve({ result: 0 }));
return counter(1, 2).then(res => {
expect(res).toStrictEqual({ result: 0, msg: "success" });
});
});
it("test need login", () => {
request.mockImplementation(() => Promise.resolve({ result: -100 }));
return counter(1, 2).then(res => {
expect(res).toStrictEqual({ result: -100, msg: "need login" });
});
});
it("test something wrong", () => {
request.mockImplementation(() => Promise.resolve({ result: 1111111 }));
return counter(1, 2).then(res => {
expect(res).toStrictEqual({ result: -999, msg: "fail" });
});
});
it("test param transform", () => {
return new Promise(done => {
request.mockImplementation(({ data }) => {
expect(data).toStrictEqual({ id: 1, operate: 1 });
done();
return Promise.resolve({ result: 0 });
});
counter(1, 1000);
});
});
});
demo4-5: 真实发起网络请求
demo4
与demo5
通过npm run test:demo4-5
即可尝试运行,采用这种方式是进行了真正的数据请求,在这里会利用axios
的代理,将内部的数据请求转发到指定的服务器端口,当然这个服务器也是在本地启动的,通过指定对应的path
相关的请求与响应数据进行测试,如果请求的数据不正确,则不会正常匹配到相关的响应数据,这样这个请求会直接返回500
,返回的响应数据如果不正确的话也会在断言时被捕捉。在这里就使用到了jest-axios-mock-server
库,首先我们需要指定三个文件,分别对应每个单元测试文件启动前执行,Jest
测试启动前执行,与Jest
测试完成后执行的三个生命周期进行的操作,分别是jest.config.js
配置文件的setupFiles
、globalSetup
、globalTeardown
三个配置项。
首先是setupFiles
,在这里我们除了初始化JSDOM
之外,还需要对axios
的默认代理进行操作,因为采用的方案是使用axios
的proxy
进行数据请求的转发,所以才需要在单元测试的最前方设定代理值。
// test/config/setup.js
import { JSDOM } from "jsdom";
import { init } from "../../src/index";
import axios from "axios";
const config = {
url: "https://www.example.com/",
domain: "example.com",
};
const dom = new JSDOM("", config);
global.document = dom.window.document;
global.document.domain = config.domain;
global.window = dom.window;
global.location = dom.window.location;
init(axios);
之后便是globalSetup
与globalTeardown
两个配置项,在这里指的是Jest
单元测试启动前与全部测试完毕后进行的操作,我们将服务器启动与关闭的操作都放在这里,请注意,在这两个文件运行的文件是单独的一个独立context
,与任何进行的单元测试的context
都是无关的,包括setupFiles
配置项指定的文件,所以在此处所有的数据要么是通过在配置文件中指定,要不就是通过网络在服务器端口之间进行传输。
// test/config/global-setup.js
import { run } from "../../src";
export default async () => {
await run();
};
// test/config/global-teardown.js
import { close } from "../../src";
export default async function () {
await close();
}
对于配置端口与域名信息,将其直接放置在jest.config.js
中的globals
字段中了,对于debug
这个配置项,建议和test.only
配合使用,在调用服务器信息的过程中可以打印出相关的请求信息。
// jest.config.js
module.exports = {
// ...
globals: {
host: "127.0.0.1",
port: "5000",
debug: false,
},
// ...
}
当然,或许会有提出为什么不在每个单元测试文件的beforeAll
与afterAll
生命周期启动与关闭服务器,首先这个方案我也尝试过,首先对于每个测试文件将服务器启动结束后再关闭虽然相对比较耗费时间,但是理论上还是合理的,毕竟要进行数据隔离的话确实是没错,但是在afterAll
关闭的时候就出了问题,因为node
服务器在关闭时调用的close
方法并不会真实地关闭服务器以及端口占用,他只是停止处理请求了,端口还是被占用,当启动第二个单元测试文件时会抛出端口正在被占用的异常,虽然现在已经有一些解决的方案,但是我尝试过后并不理想,会偶现端口依旧被占用的情况,尤其是在node
开机后第一次被运行的情况,异常的概率比较大,所以效果不是很理想,最终还是采用了这种完全隔离的方案,具体相关的问题可以参考https://stackoverflow.com/questions/14626636/how-do-i-shutdown-a-node-js-https-server-immediately
。
由于采用的是完全隔离的方案,所以我们想给测试的请求进行请求与响应数据的传输的时候,只有两个方案,要么在服务器启动的时候,也就是test/config/global-setup.js
文件中将数据全部指定完成,要么就是通过网络进行数据传输,即在服务器运行的过程中通过指定path
然后该path
的网络请求会携带数据,在服务器的闭包中会把这个数据请求指定,当然在这里两种方式都支持,我觉得还是在每个单元测试文件中指定一个自己的数据比较合适,所以在这里仅示例了在单元测试文件中指定要测试的数据。关于要测试的数据,指定了一个DataMapper
类型,以减少类型出错导致的异常,在这里示例了两个数据集,另外在匹配query
和data
时是支持正则表达式的,对于DataMapper
类型的结构还是比较标准的。
// test/data/demo1.data.ts
import { DataMapper } from "../../src";
const data: DataMapper = {
"/api/setCounter": [
{
request: {
method: "POST",
data: '{"id":1,"operate":1}',
},
response: {
status: 200,
json: {
result: 0,
},
},
},
{
request: {
method: "POST",
data: /"id":2,"operate":-1/,
},
response: {
status: 200,
json: {
result: -100,
},
},
},
],
};
export default data;
// test/data/demo2.data.ts
import { DataMapper } from "../../src";
const data: DataMapper = {
"/api/setCounter": [
{
request: {
method: "POST",
data: /"id":3,"operate":-1/,
},
response: {
status: 200,
json: {
result: -100,
},
},
},
],
};
export default data;
最后进行的两个单元测试中就在beforeAll
中指定了要测试的数据,要注意这里是return setSuitesData(data)
,因为要在数据设置成功响应以后在进行单元测试,之后就是正常的请求与响应以及断言测试是否正确了。
// test/demo4.test.js
import { counter } from "./demo";
import { setSuitesData } from "../src/index";
import data from "./data/demo1.data";
beforeAll(() => {
return setSuitesData(data);
});
describe("Simple mock", () => {
it("test success", () => {
return counter(1, 2).then(res => {
expect(res).toStrictEqual({ result: 0, msg: "success" });
});
});
it("test need login", () => {
return counter(2, -3).then(res => {
expect(res).toStrictEqual({ result: -100, msg: "need login" });
});
});
});
// test/demo5.test.js
import { counter } from "./demo";
import { setSuitesData } from "../src/index";
import data from "./data/demo2.data";
beforeAll(() => {
return setSuitesData(data);
});
describe("Simple mock", () => {
it("test success", () => {
return counter(3, -30).then(res => {
expect(res).toStrictEqual({ result: -100, msg: "need login" });
});
});
it("test no match response", () => {
return counter(6, 2).then(res => {
expect(res).toStrictEqual({ result: -999, msg: "fail" });
});
});
});
BLOG
https://github.com/WindrunnerMax/EveryDay/
参考
https://www.jestjs.cn/docs/mock-functions
https://stackoverflow.com/questions/41316071/jest-clean-up-after-all-tests-have-run
https://stackoverflow.com/questions/14626636/how-do-i-shutdown-a-node-js-https-server-immediately
Jest中Mock网络请求的更多相关文章
- swift中第三方网络请求库Alamofire的安装与使用
swift中第三方网络请求库Alamofire的安装与使用 Alamofire是swift中一个比较流行的网络请求库:https://github.com/Alamofire/Alamofire.下面 ...
- React Native中的网络请求fetch和简单封装
React Native中的网络请求fetch使用方法最为简单,但却可以实现大多数的网络请求,需要了解更多的可以访问: https://segmentfault.com/a/1190000003810 ...
- Cocos2d-X多线程(4) 在子线程中进行网络请求
新版本的android系统已经不允许在UI线程中进行网络请求了,必须新建一个线程. 代码实操: 头文件: #ifndef __TestThreadHttp_SCENE_H__ #define __Te ...
- iOS中的网络请求 和 网络监测
1.网络监测 //根据主机名判断网络是否连接 Reachability *reach = [Reachability reachabilityWithHostName:@"www.baidu ...
- Android中解析网络请求的URL
近期正在做Android网络应用的开发,使用了android网络请求方面的知识.如今向大家介绍网络请求方面的知识.我们知道android中向server端发送一个请求,(这就是我们通常所说的POST请 ...
- iOS项目中的网络请求和上下拉刷新封装
代码地址如下:http://www.demodashi.com/demo/11621.html 一.运行效果图 现在的项目中不可避免的要使用到网络请求,而且几乎所有软件都有上下拉刷新功能,所以我在此对 ...
- ios中封装网络请求类
#import "JSNetWork.h" //asiHttpRequest #import "ASIFormDataRequest.h" //xml 的解析 ...
- 在iOS9中 xcode7 网络请求 如图片请求不显示等
Application Transport Security has blocked a cleartext HTTP (http://) resource load since it is inse ...
- flutter中的网络请求和下拉刷新上拉加载,toast的案例
添加依赖 pull_to_refresh: ^1.5.6 dio: ^2.1.0 fluttertoast: ^3.0.1 DioUtil import 'package:dio/dio.dart'; ...
随机推荐
- 浅谈Blazor开发的那些事
在这篇文章中,我们将解决一些常见的Blazor问题.具体来说就是"什么是Blazor",但更重要的是"为什么要用Blazor".既然我们已经有了Angular. ...
- Vue 动态绑定CSS样式
今天在做项目上遇见了一个需求,通过不能的进度类型展示不同的进度形态,进度形态通过背景色和背景色上的文字显示. 效果图: 由于Element UI版本我用的是2.5.4 使用进度条的话 就没有2.9. ...
- linux命令打基础
目录 一.shell概述 二.linux命令分类 三.linux命令行 3.1 格式 3.2 编辑Linux命令行 四.Linux基础命令 4.1 pwd:查看当前的工作目录 4.2 cd:切换工作目 ...
- 建立安全SSL连接PostgreSQL数据库服务器
建立安全SSL连接PostgreSQL数据库服务器当前物联网的挑战之一就是提供最高的安全级别.这就是为什么需要开启SSL连接到 PostgreSQL. 当你想要安全的存储数据到PostgreSQL数据 ...
- java使用Selenium操作谷歌浏览器学习笔记(三)键盘操作
我们用Selenium打开网页后,可能需要在输入框输入一些内容等等,这时候就需要键盘操作了 使用sendKEys进行键盘操作,在bing的搜索框中输入内容并点击跳转 1 import org.open ...
- 如何在idea中配置Tomcat服务器
.IDEA 中动态 web 工程的操作 a)IDEA 中如何创建动态 web 工程 1.创建一个新模块: 2.选择你要创建什么类型的模块 3.输入你的模块名,点击[Fin ...
- 【笔记】Ada Boosting和Gradient Boosting
Ada Boosting和Gradient Boosting Ada Boosting 除了先前的集成学习的思路以外,还有一种集成学习的思路boosting,这种思路,也是集成多个模型,但是和bagg ...
- clickhouse的windowFunnel(漏斗)
1.WindowFunnel 关于官网的解释: Returned value:Integer. The maximum number of consecutive triggered conditio ...
- JmoVxia
关于我 网名:季末微夏 英文:JmoVxia 签名:路漫漫其修远兮,吾将上下而求索 标签:iOS开发(ma)工程师(nong).技术爱好者 联系我 邮箱:JmoVxia@gmail.com Githu ...
- Vue CLI安装报错 npm ERR! Exit handler never called!
安装Vue CLI时报错: npm install –g vue-cli 试了四种办法 1.把全局安装-g放到后面 npm install @vue/cli –g 2.命令行输入 npm 缓存清理命令 ...