Vue-Test-Utils + Jest 单元测试入门与实践

Vue-Test-Utils + Jest 单元测试入门与实践

创建Vue项目

在终端用vue-cli创建一个项目

$vue create vue-test

选择Manually select features进行手动选择功能配置:

vue-test 1.png

勾选 BabelTypeScriptRouterUnit Testing

vue-test 2.png

选择Jest:

vue-test 3.png

选择In dedicated config files将各配置信息配置在对应的 config文件里:

? Where do you prefer placing config for Babel, PostCSS, ESLint, etc.? (Use arrow keys)
❯ In dedicated config files
  In package.json

输入n,不保存预设:

? Save this as a preset for future projects? (y/N) n

创建成功

vue-test 4.png

查看部分配置文件

jest.config.js

默认如下:

module.exports = {
  preset: "@vue/cli-plugin-unit-jest/presets/typescript-and-babel",
};

我们可以按实际需求添加其它配置项:

module.exports = {
  preset: "@vue/cli-plugin-unit-jest/presets/typescript-and-babel",
  testMatch: ["**/tests/unit/**/*.spec.[jt]s?(x)"],
  transformIgnorePatterns: ["<rootDir>/node_modules/"],
  moduleFileExtensions: [
        'js',
        'vue'
    ],
    transform: {
        '^.+\\.vue$': '<rootDir>/node_modules/vue-jest',
        '^.+\\.js$': '<rootDir>/node_modules/babel-jest'
    },
    moduleNameMapper: {
        '^@/(.*)$': '<rootDir>/src/$1'
    },
    snapshotSerializers: [
        'jest-serializer-vue'
    ]
};
  • testMatch 匹配哪些文件进行测试
  • transformIgnorePatterns 不进行匹配的目录
  • moduleFileExtensions告诉Jest需要匹配的文件后缀
  • transform匹配到 .vue 文件的时候用 vue-jest处理, 匹配到.js文件的时候用 babel-jest 处理
  • moduleNameMapper 处理webpack的别名,比如:将@表示 /src目录
  • snapshotSerializers将保存的快照测试结果进行序列化,使得其更美观

测试用例

vs code打开项目你会发现根目录下有一目录test/unit,里面就有一个已经生成的测试用例。

vue-test 5.png

新建终端:运行单元测试。这里会根据jest.config.jstestMatch配置的条件进行运行。当前匹配的是所有tests/unit下的测试文件

$yarn test:unit
vue test 6.png

指定运行某个测试文件

新建一个couter.vue文件简单的界面,点击按钮数目加1。在tests/unit目录下新建一个测试文件couter.spec.ts

//couter.vue
<template>
  <div>
    <span class="count">{{ count }}</span>
    <button @click="increment">Increment</button>
  </div>
</template>

<script>
export default {
  data() {
    return {
      count: 0
    };
  },
  methods: {
    increment() {
      this.count++;
    }
  }
};
</script>

//couter.spec.ts
import { mount } from "@vue/test-utils";
import Couter from "@/views/Couter.vue";

describe("Couter.vue", () => {
  const wrapper = mount(Couter);
  it("测试累加", () => {
    wrapper.setData({ count: 13 });
    const button = wrapper.find("button");
    button.trigger("click");
    expect((wrapper.vm as any).count).toBe(14);
  });
});

所有目前tests/unit目录下有两个测试文件,如果还用yarn test:unit命令的话就会跑所有测试文件。那么我们怎么指定运行一个文件呢,看下面命令:

$yarn  jest  -- **/tests/unit/**/couter.spec.ts
vue test 7.png

测试用例一些API介绍

  • shallowMount 将会创建一个包含被挂载和渲染的 Vue 组件的 Wrapper,只存根当前组件,不包含子组件。
  • describe(name, fn) 这边是定义一个测试套件,test ToDoList 是测试套件的名字,fn 是具体的可执行的函数
  • it(name, fn) 是一个测试用例,输入框初始值为空字符串 是测试用例的名字,fn 是具体的可执行函数;一个测试套件里可以保护多个测试用例。
  • expect 是 Jest 内置的断言风格,业界还存在别的断言风格比如 Should、Assert 等。
  • toBe 是 Jest 提供的断言方法, 更多的可以到Jest Expect 查看具体用法。
  • setValue 可以设置一个文本控件的值并更新 v-model 绑定的数据。
  • .to-do-text 是一个 CSS 选择器;Vue-Test-Utils 提供了 find 方法来通过查找选择器,来返回一个 Wrapper;选择器可以是 CSS 选择器、可以是 Vue 组件也可以是一个对象,这个对象包含了组件的 name 或 ref 属性,比如可以这样用:wrapper.find({ name: 'my-button' })
  • wrapper.vm 是一个 Vue 实例,只有 Vue 组件的包裹器才有 vm 这个属性;通过 wrapper.vm 可以访问所有 Vue 实例的属性和方法。比如:wrapper.vm.data、wrapper.vm.nextTick()。
  • trigger 方法可以用来触发一个 DOM 事件,这里触发的事件都是同步的,所以不必将断言放到 $nextTick() 里去执行;同时支持传入一个对象,当捕获到事件的时候,可以获取到传入对象的属性。可以这样写:wrapper.trigger('click', {name: "bubuzou.com"})

更多用法vue-test-utils官方文档

参考原文

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

推荐阅读更多精彩内容