Jest 模拟 localStorage 等浏览器api

引言

在使用 Jest 对前端代码进行测试时,由于前端代码在浏览器中运行,常常需要用到localStorage,Session,Cookie,indexedDB,Web SQL,操作dom元素等等或者是其他的依赖库,Jest是利用Node.js运行的,node环境并不存在这些东西,我们就需要对它们进行Mock。

以 localStorage 为例

方案1:js-dom

  1. npm i js-dom -D

  2. jest.config.js中配置

    testEnvironment: "jsdom"
    
  3. 测试代码中就可以直接调用localStorage.setItem(key, value)等api

注意: 模拟的localStorage,是在每个测试文件执行前单独加载一次,成为被每个测试文件的一个js模块,因此模拟的localStorage仅可被同一个测试文件中的不同测试单元共享,不能跨文件共享localStorage,其他 api 模拟也是一个道理

js-dom 是一个在node环境下实现了 Web Api 的js库,包含了storage,cookie,dom等,比较完整,如果测试代码中包含了非常多的 web api 调用,建议引入像js-dom这样实现了相关mock的js库。

方案2: 亲手模拟

  1. 创建localStorage.js,在其中进行简单的实现

    Object.defineProperty(global, 'localStorage', {
        value: {
          store: {},
          setItem(key, value) {
            this.store[key] = value;
          },
          getItem(key) {
            return this.store[key];
          },
          removeItem(key) {
            delete this.store[key];
          },
          getAll(){
            return this.store;
          },
          clear() {
            this.store = {}
          }
        },
        configurable: true,
    })
    
  2. 如果,测试代码中有调用对localStorage操作进行了封装的方法,用和第1步相同的方式把封装的 方法/对象 挂载到全局
    我这里封装一个 storage.js

    Object.defineProperty(global, 'storage', {
        value: {
          set(key, value){
            localStorage.setItem(key, value);
          },
          get : (key) => {
            return localStorage.getItem(key);
          },
          del : (key) => {
            localStorage.removeItem(key); 
          },
          getAll : () => {
            return localStorage.getAll();
          },
        },
        configurable: true,
    })
    
  3. jest.config.js 中配置

    setupFiles: [
        "./test/utils/storage.js",
        "./test/utils/localStorage.js"
    ],
    

    放在 setupFilesAfterEnv 中也行,区别不大,setupFiles是在执行时引入测试框架之前就加载

  4. 测试代码中就可以调用 localStorage 和 storage

如果我在测试时,只需要少数的简单的 web api,那完全不需要 js-dom 等庞大的js库,亲手实现即可,需要的多且复杂就不建议

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

推荐阅读更多精彩内容