vue中如何使用jest單元測試

更新時間：2022年08月15日 15:32:45 作者：風舞紅楓

這篇文章主要介紹了vue中如何使用jest單元測試，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

文檔推薦

學習新知識，有中文文檔當然是最好的啦！

Vue Test Utils
jest中文文檔

組件掛載相關(guān)方法

shallowMount

shallowMount：

創(chuàng)建一個包含被掛載和渲染的 Vue 組件的 Wrapper。與之對應的還有一個mount。

shallowMount與mount的區(qū)別：

在文檔中描述為"不同的是被存根的子組件"，大白話就是shallowMount不會加載子組件，不會被子組件的行為屬性影響該組件。

為什么使用shallowMount而不使用mount：

我認為單元測試的重點在"單元"二字，而不是"測試"，想測試子組件再為子組件寫對應的測試代碼即可。

import { shallowMount } from '@vue/test-utils'
import Foo from './Foo.vue'
describe('Foo', () => {
? ? const wrapper = shallowMount(Foo)
})

Wrapper(這里只記錄一些我經(jīng)常使用的)

Wrapper：Wrapper 是一個包括了一個掛載組件或 vnode，以及測試該組件或 vnode 的方法。
Wrapper.vm：這是該 Vue 實例。你可以通過 wrapper.vm 訪問一個實例所有的方法和屬性。
Wrapper.classes：返回是否擁有該class的dom或者類名數(shù)組。
Wrapper.find：返回第一個滿足條件的dom。
Wrapper.findAll：返回所有滿足條件的dom。
Wrapper.html：返回html字符串。
Wrapper.text：返回內(nèi)容字符串。
Wrapper.setData：設(shè)置該組件的初始data數(shù)據(jù)。
Wrapper.setProps：設(shè)置該組件的初始props數(shù)據(jù)。
Wrapper.trigger：用來觸發(fā)事件。

<template>
?? ?<div class="jest">
?? ??? ?<div class="name">{{name}}</div>
?? ??? ?<div class="name">{{name}}{{text}}</div>
?? ??? ?<div class="text" @click="add">{{text}}</div>
?? ?</div>
</template>
<script src="./script.js">
export default {
?? ?name:"Foo",
?? ?props:{
?? ??? ?name:{
?? ??? ??? ?type: String,
?? ??? ??? ?default: '王大大'
?? ??? ?}
?? ?},
? ? data() {
? ? ? ? return {
? ? ? ? ? ? text: 123
? ? ? ? }
? ? },
? ? methods:{
? ? ?? ?add(){
?? ??? ??? ?this.text += 1
?? ??? ?}
? ? }
}
</script>

import { shallowMount } from '@vue/test-utils'
import Foo from './Foo.vue'
describe('Foo', () => {
? ? const wrapper = shallowMount(Foo)
? ? console.log(Wrapper.classes())?? ?//['jest','name','test']
? ? console.log(Wrapper.classes('jest'))?? ?//true
? ? console.log(Wrapper.find('name').text())?? ?//返回第一個class是name的dom的內(nèi)容 ? 王大大
? ? console.log(Wrapper.findAll('name'))?? ?//返回dom數(shù)組
? ? console.log(Wrapper.findAll('name').at(0))?? ?//取dom數(shù)組中的第一個
? ? Wrapper.setData({text : 1})
? ? console.log(Wrapper.vm.text)?? ?//1
? ? Wrapper.setProps({name : "李大大"})
? ? console.log(Wrapper.vm.name)?? ?//李大大
? ? Wrapper.find('text').trigger("click")
? ? console.log(Wrapper.vm.text) // 2
})

掛載選項

就是shallowMount或者mount的時候可以設(shè)置一些初始化內(nèi)容。具體可以初始化的全部內(nèi)容請查詢文章開始的文檔。

import { shallowMount } from '@vue/test-utils'
import Foo from './Foo.vue'
const wrapper = shallowMount(Foo, {
?? ?data() {
?? ??? ?return {
?? ??? ??? ?bar: 'my-override'
?? ??? ?}
? },
? propsData: {
?? ??? ?msg: 'aBC'
? }
? mocks: {
? ? ? ? $route: {
? ? ? ? ? ? query: {
? ? ? ? ? ? ? ? aaa: '1',
? ? ? ? ? ? }
? ? ? ? },
? ? ? ? $router: {
? ? ? ? ? ? push: jest.fn(),
? ? ? ? ? ? replace: jest.fn(),
? ? ? ? }
? ? }
})

jest-api

匹配器

使用不同匹配器可以測試輸入輸出的值是否符合預期。

toBe：判斷是否相等
toBeNull：判斷是否為null
toBeUndefined：判斷是否為undefined
toBeDefined：與上相反
toBeNaN：判斷是否為NaN
toBeTruthy：判斷是否為true
toBeFalsy：判斷是否為false
toContain：數(shù)組用，檢測是否包含
toHaveLength：數(shù)組用，檢測數(shù)組長度
toEqual：對象用，檢測是否相等
toThrow：異常匹配（沒用過）

describe('Foo', () => {
?? ?expect(2 + 2).toBe(4)
?? ?expect(null).toBeNull()
?? ?expect(undefined).toBeUndefined()
?? ?let a = 1;
?? ?expect(a).toBeDefined()
?? ?a = 'ada';
?? ?expect(a).toBeNaN()
?? ?a = true;
?? ?expect(a).toBeTruthy()
?? ?a = false;
?? ?expect(a).toBeFalsy()
?? ?a ?= [1,2,3];
?? ?expect(a).toContain(2)
?? ?expect(a).toHaveLength(3)
?? ?a = {a:1};
?? ?expect(a).toEqual({a:1})
})

mock函數(shù)

例如：在一個vue組件中，ajax請求、路由跳轉(zhuǎn)是常常用到的，但是在單測代碼中，我們并不能正確的知道他是否執(zhí)行并達到了預期的效果，這時就需要mock函數(shù)。在上文掛載選項中的mocks.$router就是一種mock函數(shù)的應用實例。

mock函數(shù)自然是要使用該函數(shù)，下面是一些函數(shù)的常用匹配器

toBeCalledTimes：判斷函數(shù)被執(zhí)行的次數(shù)
toBeCalled：判斷函數(shù)是否被執(zhí)行

<template>
?? ?<div class="jest" @click="go"></div>
</template>
<script src="./script.js">
export default {
?? ?name:"Foo",
? ? methods:{
? ? ?? ?go(){
?? ??? ??? ?this.$router.push({path:"/a"})
?? ??? ?}
? ? }
}
</script>

import { shallowMount } from '@vue/test-utils'
import Foo from './Foo.vue'
const wrapper = shallowMount(Foo, {
? mocks: {
? ? ? ? $router: {
? ? ? ? ? ? push: jest.fn(),
? ? ? ? ? ? replace: jest.fn(),
? ? ? ? }
? ? }
})
wrapper.find(“jest").trigger("click");
expect(wrapper.vm.$router.push).toBeCalled();
wrapper.find(“jest").trigger("click");
expect(wrapper.vm.$router.push).toBeCalledTimes(2);

promise模擬

jest.mock('@root/api'); //模擬api請求函數(shù)
import {getList} from '@root/api';
const listJson = JSON.parse(require('fs').readFileSync('./mock/getList.json')); //引入mock好的json數(shù)據(jù)
getList.mockResolvedValue(Promise.resolve(listJson)); //模擬promise返回
getList().then(res => {
?? ?expect(res).toEqual(listJson);
})

為什么要使用單測

說了這么多，那為什么要使用單測呢。在看完上面的描述我想大家也是一頭郁悶，單測有用嗎？答案當然是有。下面舉個例子：

<template>
?? ?<div class="jest"></div>
</template>
<script src="./script.js">
import {getList} from '@root/api';
export default {
?? ?name:"Foo",
? ? created(){
? ? ?? ?getList()
? ? ?? ?.then(res => {
? ? ?? ??? ?this.initData(res)
? ? ?? ?})
? ? },
? ? methods:{
?? ??? ?initData(data){
?? ??? ??? ?data.name = '王大大';
?? ??? ?}
?? ?}
}
</script>

import { shallowMount } from '@vue/test-utils'
import Foo from './Foo.vue'
const wrapper = shallowMount(Foo)

這時候就會報錯data.name，因為data不一定有值。正確案例如下

<template>
?? ?<div class="jest"></div>
</template>
<script src="./script.js">
import {getList} from '@root/api';
export default {
?? ?name:"Foo",
? ? created(){
? ? ?? ?getList()
? ? ?? ?.then(res => {
? ? ?? ??? ?this.initData(res)
? ? ?? ?})
? ? },
? ? methods:{
?? ??? ?initData(data = {}){
?? ??? ??? ?data.name = '王大大';
?? ??? ?}
?? ?}
}
</script>

說白了就是讓你的代碼邏輯更符合預期結(jié)果。