阅读 8260

学习Vue应用测试,让你的项目更加健壮和稳定

Vue应用测试

本篇文章由阅读《Vue.js应用测试》书籍、学习《Vue Test Utils》官网知识以及实际工作经验总结而来,阅读书籍请支持正版。
如果你觉得写的不错,请到我的Github给我一个star

测试介绍

前端应用程序主要编写三种测试类型:单元测试快照测试端到端测试。本篇文章着重介绍Vue组件的单元测试快照测试,对于端到端测试请自行搜索相关内容。

对于不同类型的测试,我们应该正确对待它们,并能够根据它们各自的优缺点进行比例混合。在一个测试金字塔中,单元测试需要占大部分比例,因为它们在开发应用程序时可以提供快速的反馈。快照测试的覆盖范围比较广,因此我们并不需要太多的快照测试。以Vue组件为例,一个Vue组件可能只需要一个到三个的快照测试用例。端到端测试用例虽然对应用程序非常有用,但由于它可能很慢而且会不稳定,因此端到端测试比例应该是最少的。

代码覆盖率是度量一个应用程序或者库质量的一个重要指标,通常而言0%表示未进行任何代码测试,100%意味着在测试用例执行时,每一行代码都被执行过了。100%覆盖率可能同0%覆盖率一样可怕,因为这可能会给你一种错觉:它会让你以为你的程序永远不会出错,然而实际情况很可能是你对场景进行了错误的判断,进而得出了错误的结论。例如:当你测试一个API接口时,你假定该API接口永远都不会返回错误信息,然而当API接口在正式环境中,它确实返回了错误信息。

对一个完整的应用程序而言,你可能会花费少量的时间就能让测试覆盖率达到80%~90%,然而剩下的10%~20%也可能会让你花费数倍的时间来完成,甚至根本达不到。就像你很轻松就能拧干毛巾里面大部分的水,然而拧干剩下的一小部分依然是一件十分困难的事情。

Vue应用中,对于UI组件来说,我们并不推荐一味的追求行级覆盖率,因为过度注重覆盖率可能会严重导致我们过分关注组件内部的实现细节,从而导致过多的繁琐测试。取而代之的是,我们希望把组件测试撰写为断言组件的公共接口,并在一个黑盒中去处理它,一个简单的UI组件测试用例将断言一些输入(用户交互Prop输入等)提供给组件之后,并期望组件得到预期的结果(渲染结果响应事件等)。

端到端测试

端到端测试是最直观且容易理解的测试类型,在前端应用程序中,端到端测试可以从用户的视角,通过浏览器自动检查应用程序是否正常工作。

一个端到端测试的测试案例如下:

function testCalc (browser) {
  browser.url('http://localhost:8080')
         .click('#button')
         .click('#button-plus')
         .click('#button')
         .assert.containsText('#result', '2')
         .end();
}
复制代码

我们可以从以上一个小小的案例进行总结:

优点

  • 编写测试用例非常节省时间。
  • 可以随意根据自己的需求进行调整。

缺点

  • 测试用例运行可能不是很快:启动浏览器会花费几秒、不同网站不同速度又会存在不同的耗时。
  • 端到端的调试工作会很困难:在上面的例子中,在本地环境上面进行调试尚且是一个很糟糕的过程,如果测试是在持续集成的服务器上失败那么更可以说是一场灾难。
  • 端到端可能成为flaky测试:flaky测试表示即使被测应用程序正常运行,测试仍然频繁失败,其中失败的原因取决于多种因素:代码执行时间过长或API暂时失效。

单元测试

单元测试是对应用程序最小的部分运行测试的过程。通常来说,测试的单元是一个函数,但在Vue应用程序中,组件也算是一个被测单元。

一个单元测试的测试案例如下:

// math.js
export function add (a, b) {
  return a + b
}

// math.spec.js
import { add } from 'math.js'
describe('math.js', () => {
  it('add func', () => {
    expect(add(1, 2)).toBe(3)
  })
})
复制代码

我们可以对单元测试进行总结:

优点:

  • 运行速度快:不同于端到端测试,单元测试用例运行速度很快。
  • 友好的应用辅助效果:当团队出现新人时,他可以从单元测试中迅速了解项目需求。

缺点:

  • 重构代码困难:如果要将一个已经具备单元测试的复杂功能拆分,需要在更改代码的同时更改对应的单元测试。
  • 无法整体测试:由于单元测试只能针对程序的各个单元分开进行测试,各个单元测试通过并不意味着当他们组合起来就一定没有问题。

快照测试

快照测试会给运行中的应用程序拍一张"照片",并将其与之前保存的"照片"进行比较,如果二者不相同则测试失败。 在之后,我们会使用Jest自动化测试框架来对Vue组件进行快照测试。

安装

官方自动化测试仓库

如果你仅仅只是为了学习vue-test-utils,那么可以尝试官方提供的一份极简的测试仓库。

git clone https://github.com/vuejs/vue-test-utils-getting-started
cd vue-test-utils-getting-started
npm install
复制代码

在你成功安装后,你的项目目录结构如下所示:

|-- vue-test-utils-getting-started
|   |-- .babelrc      # babel配置
|   |-- .gitignore    # git配置
|   |-- counter.js    # 组件
|   |-- test.js       # 测试文件
|   |-- package.json
|   |-- README.md
复制代码

注意:需要注意的是,此种方式可能并不直接支持我们使用.vue文件的形式,如果需要支持.vue文件,需要我们进行一些额外的配置。

使用官方脚手架安装

如果你是Vue-Cli的热爱者,那么通过Vue-Cli4.0+可以快速创建一个包含test测试相关的项目配置。

# 创建项目
$ vue create vue-jest

# 选择自定义配置
  default (babel, eslint)  
> Manually select features 

# 选择安装feature,也可以根据自己的喜好去安装
 (*) Babel
 ( ) TypeScript
 ( ) Progressive Web App (PWA) Support        
 ( ) Router
 ( ) Vuex
 ( ) CSS Pre-processors
 (*) Linter / Formatter
>(*) Unit Testing
 ( ) E2E Testing

 # 选择测试框架,我们选择jest
   Mocha + Chai
> Jest
复制代码

安装完毕后,会在根目录下存在一个tests的目录,其中里面包含一个简单的测试用例example.spec.js: ::: tip 可以使用npm run test:unit来运行测试用例。 :::

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'

describe('HelloWorld.vue', () => {
  it('renders props.msg when passed', () => {
    const msg = 'new message'
    const wrapper = shallowMount(HelloWorld, {
      propsData: { msg }
    })
    expect(wrapper.text()).toMatch(msg)
  })
})
复制代码

现有Vue项目中添加Jest测试

如果你是在现有Vue项目需要添加Jest自动化测试框架,可以在该项目中运行如下命令:

# 请确保你的Vue-Cli安装了最新版本
$ vue add unit-jest
复制代码

此条命令执行以后,会自动帮助我们安装@vue/cli-plugin-unit-jest,同时会帮助我们进行jest测试相关的配置,并且它也会帮我们在根目录下新建tests文件夹,包含测试用例example.spec.js: ::: tip 可以使用npm run test:unit来运行测试用例。 :::

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'

describe('HelloWorld.vue', () => {
  it('renders props.msg when passed', () => {
    const msg = 'new message'
    const wrapper = shallowMount(HelloWorld, {
      propsData: { msg }
    })
    expect(wrapper.text()).toMatch(msg)
  })
})
复制代码

以下测试案例均依据以上第二或第三种方式进行测试环境配置。

VsCode编辑器插件

对于使用VsCode编辑器,可以通过安装Jest插件,它可以在我们不运行npm run test:unit命令的时候就提示测试用例是否通过。

测试覆盖率和测试报告

在根目录下的jest.config.js中,我们进行如下配置:

module.exports = {
  preset: '@vue/cli-plugin-unit-jest/presets/typescript-and-babel',
  snapshotSerializers: ['jest-serializer-vue'],
  moduleNameMapper: {
    '^@/(.*)$': '<rootDir>/src/$1'
  },
  testMatch: [
    '**/tests/unit/**/*.spec.(js|jsx|ts|tsx)|**/__tests__/*.(js|jsx|ts|tsx)'
  ],
  collectCoverage: true,
  coverageDirectory: '<rootDir>/tests/unit/coverage',
  collectCoverageFrom: [
    'src/components/**/*.vue',
    'src/utils/**/*.ts',
    'src/store/modules/*.ts',
    '!src/utils/axios.ts',
    '!src/utils/notify.ts'
  ]
}
复制代码

对以上配置的解释如下:

  • snapshotSerializers: Vue组件进行Jest快照序列化的工具配置。
  • moduleNameMapper:模块别名配置。
  • testMatch:测试文件查找规则,可以是统一放在src/tests目录下,也可以就近放在__tests__目录下。
  • collectCoverage:是否进行测试覆盖率收集。
  • coverageDirectory:测试报告存放位置。
  • collectCoverageFrom:测试哪些文件和不测试哪些文件,你可以根据你的团队或者个人偏好进行设置。

在完善以上配置后,你可以在终端运行npm run test:unit命令,随后你将得到类似下面这样的测试报告:

在以上测试报告中,我们明显可以看到有一些没有覆盖到的代码,这时我们可以在src/tests/units/coverage/lcov-report目录下找到我们对应的测试文件,随后点开。这里以base/scroll/index.vue为例,它有如下两个文件:

  • index.html: 此处是对scroll/index.vue组件测试的一个总结报告,如下:

  • index.vue.html:此处是对scroll/index.vue组件测试的一个详细描述,其中对于没有覆盖到的代码进行不同颜色的标识,如下:

测试组件渲染输出

组件挂载

对于不包含子组件的组件来说,使用shallowMountmount对组件的效果是一样的。二者的区别在于,shallowMount只渲染组件本身,但会保留子组件在组件中的存根。

区别这两种方法的目的在于,当我们只想对某个孤立的组件进行测试的时候,一方面可以避免其子组件的影响,另一方面对于包含许多子组件的组件来说,完全渲染子组件会导致组件的渲染树过大,这可能会影响到我们的测试速度。

在组件挂载后,我们可以通过wrapper.vm访问到组件的实例,通过wrapper.vm进而可以访问到组件所有的propsdatamethods等等。

注意: 在我们使用mount或者shallowMount的时候,我们可以期望组件响应几乎所有的Vue生命周期函数,但除非手动调用wrapper.destory()函数,否则组件的beforeDestroy()destroyed()不会被触发。

import { shallowMount, mount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'

describe('HelloWorld.vue', () => {
  it('test shallowMount', () => {
    const wrapper = shallowMount(HelloWorld)
    // 判断组件是否挂载
    expect(wrapper.exists()).toBe(true)
    
    // 访问vm实例
    console.log(wrapper.vm)
  })
  it('test mount', () => {
    const wrapper = mount(HelloWorld)
    // 判断组件是否挂载
    expect(wrapper.exists()).toBe(true)
  })
})
复制代码

渲染文本测试

在组件挂载后,返回的包裹器有一个wrapper.text()方法,他返回组件渲染后的文本内容。

假设有如下组件:

<template>
 <div>{{msg}}</div>
</template>
<script>
export default {
  data () {
    return {
      msg: 'Hello, Vue and Jest...'
    }
  }
}
</script>
复制代码

那么我们就可以撰写如下测试用例:

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'

describe('HelloWorld.vue', () => {
  it('test text', () => {
    const msg = 'Hello, Vue and Jest...'
    const wrapper = shallowMount(HelloWorld)
    // 更推荐具有扩展性的toContain匹配器而不是toBe
    expect(wrapper.text()).toBe(msg)       // 严格相等
    expect(wrapper.text()).toContain(msg)  // 是否包含
  })
})
复制代码

渲染HTML结构测试

在组件挂载后,返回的包裹器有一个wrapper.html()方法,他返回组件渲染后的DOM结构。

HelloWorld.vue组件做如下改动:

<template>
  <div>
    <span class="item">item</span>
    {{msg}}
  </div>
</template>
<script>

export default {
  data () {
    return {
      msg: 'Hello, Vue and Jest...'
    }
  }
}
</script>
复制代码

那么我们就可以撰写如下测试用例:

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'

describe('HelloWorld.vue', () => {
  it('test html', () => {
    const wrapper = shallowMount(HelloWorld)
    expect(wrapper.html()).toContain('<span class="item">item</span>')
  })
})
复制代码

DOM属性测试和Class测试

在组件挂载后,返回的包裹器有一个wrapper.attributes()方法,他返回组件渲染后的DOM属性对象,attributes()方法如果提供了属性名参数,则直接返回此属性的值,否则返回全部属性的对象,wrapper.classes()方法类似。

依然以以上HelloWorld.vue组件为例,如果我们要测试span标签是否有.item样式,是否有id,可以进行如下测试:

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'

describe('HelloWorld.vue', () => {
  it('test attribute and class', () => {
    const wrapper = shallowMount(HelloWorld)
    // 查找第一个span标签
    const dom = wrapper.find('span')
    expect(dom.classes()).toContain('item')
    expect(dom.attributes().id).toBeFalsy()
  })
})
复制代码

Props测试

在组件挂载后,返回的包裹器有一个wrapper.props()方法,他返回组件实例的所有propsprops()方法如果提供了参数,则直接返回此参数的值,否则返回全部。

我们对HelloWorld.vue组件做进一步的调整:

<template>
  <div>
    <span class="item">item</span>
    {{msg}}
    <span>{{name}}</span>
    <span>{{age}}</span>
  </div>
</template>
<script>

export default {
  props: ['name', 'age'],
  data () {
    return {
      msg: 'Hello, Vue and Jest...'
    }
  }
}
</script>
复制代码

随后我们撰写如下测试用例:

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'

describe('HelloWorld.vue', () => {
  it('test props', () => {
    const wrapper = shallowMount(HelloWorld, {
      propsData: {
        name: 'AAA',
        age: 23
      }
    })
    expect(wrapper.props('name')).toBe('AAA')
    expect(wrapper.props().age).toBe(23)
  })
})

复制代码

Style测试

返回的包裹器中包含一个element属性,它是对当前DOM节点的应用,可以使用element.style访问该DOM节点的内联样式

假设我们对HelloWorld.vue做如下调整:

<template>
  <div class="hello">
    <h1 style="width: 100px;height: 50px;">{{ msg }}</h1>
  </div>
</template>

<script>
export default {
  name: 'HelloWorld',
  props: {
    msg: String
  }
}
</script>
复制代码

基于以上组件,我们可以撰写如下测试用例:

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'

describe('HelloWorld.vue', () => {
  it('test style', () => {
    const wrapper = shallowMount(HelloWorld)
    const style = wrapper.find('h1').element.style
    expect(style.width).toBe('100px')
    expect(style.height).toBe('50px')
  })
})

复制代码

测试组件方法

测试一个组件的自有方法的方式很简单,但实际上一个方法通常是具有依赖的。依赖是指:在被测代码单元控制之外的任何代码,依赖有很多种存在形式,例如:浏览器方法、被导入的模块和被注入的Vue实例属性。显而易见,要测试这些具有依赖的方法,无疑会引入一个更复杂的环境,因此我们要很小心的去处理。

私有和公共方法

对于一个组件而言,绝大部分可能是私有方法,私有方法指的是只会在组件内部使用的方法,与私有方法相对来说有一个公共方法,公共方法会被外部调用。

测试规则:

  • 私有方法:私有方法一般只会在组件内部进行调用,它是组件内实现细节的,通常而言可以不用为其撰写测试用例,但也不是绝对的。
  • 公共方法:公共方法会被外部组件进行调用,因此需要为公共方法撰写测试用例。

假设我们有如下loading.vue组件:

<template>
  <div v-show="showLoading" class="loading-box">
    {{loadingText}}
  </div>
</template>

<script>
export default {
  data () {
    return {
      loadingText: '',
      showLoading: false
    }
  },
  methods: {
    show () {
      this.showLoading = true
      this.getLoadingText()
    },
    hide () {
      this.showLoading = false
      this.getLoadingText()
    },
    getLoadingText () {
      this.loadingText = this.showLoading ?  `loading show text` : ''
    }
  }
}
</script>
复制代码

组件方法分析:

  • 私有方法:getLoadingText(),我们不需要为其撰写测试用例。
  • 公共方法:show()hide(),我们需要为其撰写测试用例。

那么根据以上规则,我们可以撰写一下测试用例:

import { shallowMount } from '@vue/test-utils'
import Loading from '@/components/loading.vue'

describe('loading.vue', () => {
  let wrapper
  beforeEach(() => {
    wrapper = shallowMount(Loading)
  })
  it('show func', async () => {
    expect(wrapper.vm.loadingText).toBe('')
    expect(wrapper.vm.showLoading).toBe(false)
    expect(wrapper.isVisible()).toBe(false)

    wrapper.vm.show()
    await wrapper.vm.$nextTick()
    expect(wrapper.vm.showLoading).toBe(true)
    expect(wrapper.isVisible()).toBe(true)
  })

  it('hide func', async () => {
    wrapper.setData({
      showLoading: true
    })
    await wrapper.vm.$nextTick()
    expect(wrapper.vm.showLoading).toBe(true)
    expect(wrapper.isVisible()).toBe(true)

    wrapper.vm.hide()
    await wrapper.vm.$nextTick()
    expect(wrapper.vm.showLoading).toBe(false)
    expect(wrapper.isVisible()).toBe(false)
  })
})
复制代码

测试代码分析:

  • beforeEach():它是Jest的钩子函数,会在执行每一个测试用例之前调用,在这个钩子函数中我们重新挂载组件,避免多个测试用例互相影响。
  • async/await:因为我们调用了公共方法,它修改了组件的数据,进而会触发DOM更新,因此我们需要调用组件的$nextTick()方法,以确保我们获取到了正确DOM的状态。
  • isVisible():判断一个DOM元素是否可见,在loading组件中,因为我们使用了v-show指令,所以使用isVisible()更加语义化一些,我们可以也可以使用exists()v-if指令来代替。
  • setData():手动修改组件中data的值,用法与Vue.set()类似。不过需要注意的时,setData()方法是异步的,需要配合$nextTick()一起使用。

测试定时器函数

使用假定时器函数

JavaScript中定时器函数有setTimeoutsetInterval,如果我们不对定时器函数做处理的话,当一个组件有一个延时1000mssetTimeout时,则意味着我们测试程序必须等待1000ms,如果系统中存在很多个setTimeout函数,那么对于以速度、高效率的单元测试来说无疑是一场灾难。

在不减慢测试速度的情况下测试定时器函数,看起来唯一的办法就是让异步的定时器替换为同步的定时器函数,如下:

setTimeout = () => { console.log('replace setTimeout') }
复制代码

我们可以使用Jest库提供的jest.useFakeTimers(),当这个方法被调用时Jest提供的假定时器会替换全局定时器函数来工作,然后我们可以使用jest.runTimersToTime()来推进时间。

假设我们有如下组件:

<template>
  <div class="hello">
    {{timeText}}<br/>
    {{percent}}
  </div>
</template>

<script>
export default {
  name: 'HelloWorld',
  data () {
    return {
      percent: 0,
      timeText: ''
    }
  },
  methods: {
    start () {
      this.percent = 0
      this.timer = setInterval(() => {
        this.percent++
        if (this.percent >= 100) {
          this.finish()
        }
      }, 100)
    },
    finish () {
      this.percent = 100
      clearInterval(this.timer)
    }
  },
  mounted () {
    setTimeout(() => {
      this.timeText = 'setTimeout text'
    }, 1000)
  }
}
</script>
复制代码

那么我们可以撰写如下测试用例:

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'

describe('HelloWorld.vue', () => {
  let wrapper
  beforeEach(() => {
    jest.useFakeTimers()
    wrapper = shallowMount(HelloWorld)
  })
  it('test setTimeout async timer', () => {
    expect(wrapper.vm.timeText).toBe('')
    jest.runTimersToTime(1000)
    expect(wrapper.vm.timeText).toBe('setTimeout text')
  })
  it('test setInterval async timer', () => {
    expect(wrapper.vm.percent).toBe(0)
    wrapper.vm.start()
    jest.runTimersToTime(100)
    expect(wrapper.vm.percent).toBe(1)
    jest.runTimersToTime(900)
    expect(wrapper.vm.percent).toBe(10)
    jest.runTimersToTime(2000)
    expect(wrapper.vm.percent).toBe(30)
  })
})
复制代码

测试代码分析:

  • beforeEach:因为我们在两个测试用例中都要使用Jest提供的假定时器函数,因此我们可以在beforeEach钩子函数中来使用。同样的道理,我们在beforeEach钩子函数中重新挂载组件,避免多个测试用例互相影响。
  • jest.runTimersToTime():意味着推进时间,在第二个用例中:当第一次推进时间100ms时,percent值为1;当第二次推进时间900ms时,此时算上第一次推进100ms,一共1000ms,因此percent值为10。

使用spy测试

当我们运行以上测试用例会发现测试用例已经全部测试通过了,但此时我们不能被暂时的胜利冲昏头脑,我们还需要测试clearInterval()是否成功执行,以确保我们没有写一个无限运行的定时器。

在发现以上问题后,我们需要解决以下几个问题:

  • 如何测试clearInterval()函数被执行了。
  • 如何测试clearInterval()携带的参数。

要解决以上第一个问题,我们需要使用Jest提供的jest.spyOn()函数,然后对window.clearInterval()进行间谍伪造,如下:

jest.spyOn(window, 'clearInterval')
复制代码

要解决第二个问题,我们可以使用Jest提供的mockReturnValue函数来模拟任何我们想要的返回值,如下:

setInterval.mockReturnValue(996)
复制代码

在解决完以上两个问题后,我们新增一个测试用例,如下:

it('clearInterval success when percent >= 100', () => {
  jest.spyOn(window, 'clearInterval')
  setInterval.mockReturnValue(996)
  wrapper.vm.start()
  wrapper.vm.finish()
  expect(wrapper.vm.percent).toBe(100)
  expect(window.clearInterval).toHaveBeenCalledWith(996)
})
复制代码

测试代码分析:当我们的测试代码使用了我们不能控制的API时,我们可以使用spy来伪装,随后判断我们伪装的API是否被调用。

模拟代码

Vue开发中,为Vue实例添加一些属性或者方法是一种常见的方式,例如:

import { Message } from 'element-ui'
Vue.prototype.$message = Message

this.$message.success('保存成功')
复制代码

那么我们如何为这些实例属性添加单元测试呢?答案是mocks,它可以为Vue实例提供额外的属性。假如我们有如下message.vue组件:

<template>
  <div>
    <button id="success" @click="handleSuccessClick">成功</button>
    <button id="warning" @click="handleWarningClick">警告</button>
    <button id="error" @click="handleErrorClick">错误</button>
    <button id="info" @click="handleInfoClick">消息</button>
  </div>
</template>

<script>
export default {
  methods: {
    handleSuccessClick () {
      this.$message.success('成功')
    },
    handleWarningClick () {
      this.$message.warning('警告')
    },
    handleErrorClick () {
      this.$message.error('错误')
    },
    handleInfoClick () {
      this.$message.info('消息')
    }
  }
}
</script>
复制代码

由于我们就是要mock来自第三方的插件,因此我们在测试用例中并不需要安装element-ui,所以我们可撰写如下测试用例:

import { shallowMount } from '@vue/test-utils'
import Message from '@/components/message.vue'

describe('message.vue', () => {
  it('add mocks', () => {
    const message = {
      success: jest.fn(),
      warning: jest.fn(),
      error: jest.fn(),
      info: jest.fn()
    }
    const wrapper = shallowMount(Message, {
      mocks: {
        $message: message
      }
    })
    const successBtn = wrapper.find('#success')
    const warningBtn = wrapper.find('#warning')
    const errorBtn = wrapper.find('#error')
    const infoBtn = wrapper.find('#info')

    successBtn.trigger('click')
    expect(message.success).toHaveBeenCalledTimes(1)

    warningBtn.trigger('click')
    expect(message.warning).toHaveBeenCalledTimes(1)

    errorBtn.trigger('click')
    expect(message.error).toHaveBeenCalledTimes(1)

    infoBtn.trigger('click')
    expect(message.info).toHaveBeenCalledTimes(1)
  })
})
复制代码

模拟模块依赖

在一个组件中,我们无法将其单独的隔离开进行测试,因为组件往往有一些被导入的模块,而这些模块就成为了这个模块的依赖。在大多数情况下,在单元测试中有模块依赖是一件好事,但也有一些模块存在副作用。例如:发送HTTP请求,我们不可能在单元测试用例中为组件真正的发送HTTP请求,这是不合理的,因此我们需要有一种模拟模块依赖的手段来解决这种问题。

假如我们有以下HelloWorld.vue组件

<template>
  <ul>
    <li
      v-for="(item, index) in lessonList"
      :key="index"
      class="lesson-item"
    >{{item.title}}</li>
  </ul>
</template>

<script>
import { getLessonList } from '@/api/api.js'
export default {
  data () {
    return {
      lessonList: []
    }
  },
  methods: {
    getLessonData () {
      getLessonList().then(res => {
        const { status, data } = res
        if (status === 200) {
          this.lessonList = data.data
        }
      })
    }
  },
  mounted () {
    this.getLessonData()
  }
}
</script>
复制代码

新建src/api/api.js文件,并添加如下代码:

import axios from 'axios'

export function getLessonList () {
  return axios.get('http://www.dell-lee.com/react/api/list.json')
}
复制代码

问题分析:

  • 第一步:我们要解决getLessonList方法返回假数据问题。
  • 第二步:我们要解决HelloWorld.vue组件正确渲染我们的假数据问题。

对于第一个问题,我们需要新建src/api/__mocks__/api.js文件夹,注意:

  • __mocks__是固定写法,它能被Jest进行识别。
  • __mocks__/api.js,其中__mocks__目录下的文件名要和我们模拟的模块文件名相同。
export const getLessonList = jest.fn(() => {
  const lessonResult = {
    success: true,
    data: [
      { id: 1, title: '深入理解ES6' },
      { id: 2, title: 'JavaScript高级程序设计' },
      { id: 3, title: 'CSS揭秘' },
      { id: 4, title: '深入浅出Vue.js' }
    ]
  }
  return Promise.resolve(lessonResult)
})
复制代码

第二个问题,我们可以使用getLessonList.mockResolvedValueOnce()方法来传入我们模拟的数据。再解决完以上几个问题后,我们可以撰写如下测试用例:

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'
import { getLessonList } from '../../src/api/api.js'
jest.mock('../../src/api/api.js')
describe('HelloWorld.vue', () => {
  const lessonResult = {
    success: true,
    data: [
      { id: 1, title: '深入理解ES6' },
      { id: 2, title: 'JavaScript高级程序设计' },
      { id: 3, title: 'CSS揭秘' },
      { id: 4, title: '深入浅出Vue.js' }
    ]
  }
  
  it('mock http modules', async () => {
    expect.assertions(1)
    const result = await getLessonList()
    expect(result).toEqual(lessonResult)
  })
  it('render mock http module result', async () => {
    const mockAxiosResult = {
      status: 200,
      data: lessonResult
    }
    getLessonList.mockResolvedValueOnce(mockAxiosResult)
    const wrapper = shallowMount(HelloWorld)
    await wrapper.vm.$nextTick()
    const lessonItems = wrapper.findAll('.lesson-item')
    const lessonList = lessonResult.data
    for (let i = 0; i < lessonItems.length; i++) {
      const item = lessonItems.at(i)
      expect(item.text()).toBe(lessonList[i].title)
    }
  })
})
复制代码

挂载选项和改变组件状态

在我们以上的测试用例中,我们已经尝试过在组件挂载的时候提供propsData或者mocks,我们还可以挂载以下常见的几种其它选项。

  • data:在挂载阶段提供的data中的属性,会被合并、覆盖到当前组件的data中,如下:
  • slots:如果被挂载的组件有插槽内容,那么可以在挂载阶段手动提供slots
  • stubs:如果被挂载的组件存在子组件,那么可以在挂载阶段手动提供子组件的存根,例如:stubs: ['my-child', 'transition', 'router-view', 'router-link']等。
  • localVue:提供一个本地的Vue实例,防止污染全局的Vue,这在使用第三方插件:Vue-RouterVuexelement-ui等非常适用。

挂载Data

假如我们有如下组件:

<template>
  <div></div>
</template>

<script>
export default {
  data () {
    return {
      bar: 'bar',
      foo: 'foo'
    }
  }
}
</script>
复制代码

现在我们在测试用例中通过挂载data,来测试组件:

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'
describe('HelloWorld.vue', () => {
  it('mount data', () => {
    const wrapper = shallowMount(HelloWorld, {
      data () {
        return {
          foo: 'foo override',
          baz: 'baz'
        }
      }
    })
    expect(wrapper.vm.bar).toBe('bar')
    expect(wrapper.vm.foo).toBe('foo override')
    expect(wrapper.vm.baz).toBe('baz')
  })
})
复制代码

挂载Slots

假如我们有如下组件:

<template>
  <div>
    <div class="header-slot">
      <slot name="header" />
    </div>
    <div class="default-slot">
      <slot />
    </div>
     <div class="footer-slot">
      <slot name="footer" />
    </div>
  </div>
</template>

<script>
export default {}
</script>
复制代码

那么我们挂载对应的插槽,撰写如下测试用例:

import { mount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'
describe('HelloWorld.vue', () => {
  it('mount data', () => {
    const headerSlot = {
      template: `<div>header slot</div>`
    }
    const defaultSlot = {
      template: `<div>default slot</div>`
    }
    const footerSlot = {
      template: `<div>footer slot</div>`
    }
    const wrapper = mount(HelloWorld, {
      slots: {
        default: defaultSlot,
        header: headerSlot,
        footer: footerSlot
      }
    })
    expect(wrapper.find('.header-slot').html()).toContain(headerSlot.template)
    expect(wrapper.find('.default-slot').html()).toContain(defaultSlot.template)
    expect(wrapper.find('.footer-slot').html()).toContain(footerSlot.template)
  })
})

复制代码

挂载Stubs

就像我们上面已经提到的那样,stubs可以用来存根子组件,包括:普通子组件、transitionrouter-linkrouter-view,它提供了我们用来覆盖全局或者局部注册组件的能力。

如果一个组件使用了router-link或者router-view,但我们又不想要在测试用例中安装Vue-Router,那么可以像下面这样进行存根:

const wrapper = shallowMount(HelloWorld, {
  stubs: ['router-link', 'router-view']
})
复制代码

挂载第三方应用

有时候我们在开发Vue应用的时候,会经常用到第三方插件,例如:Vue-RouterVuex以及element-ui等等。那么,如何在一个测试用例中优雅的安装这些第三方应用呢?

可以使用createLocalVue()方法创建一个本地的Vue实例,用来替换全局的Vue,随后在挂载组件的时候传递这个本地Vue,如下:

import { shallowMount, createLocalVue } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'
import Vuex from 'vuex'
import Router from 'vue-router'
import ElementUI from 'element-ui'
const localVue  = createLocalVue()
localVue.use(Vuex)
localVue.use(Router)
localVue.use(ElementUI)

describe('HelloWorld.vue', () => {
  it('use localVue', () => {
    const wrapper = shallowMount(HelloWorld, {
      localVue
    })
  })
})
复制代码

改变组件状态

在组件挂载后,可以使用如下几种set方法来改变组件中的数据。

  • setChecked:设置checkbox或者radio元素的checked的值并更新v-model
  • setSelected:设置一个option元素并更新v-model
  • setValue:设置一个文本控件或select元素的值并更新v-model
  • setProps:设置包裹器的vm实例中propss并更新。
  • setData:设置包裹器中vm实例中的data并更新。

注意:由于Vue组件更新DOM是异步的,因此如果我们要测试组件更改数据后的DOM,我们应该使用$nextTick()

假设我们有如下组件:

<template>
  <div>
    <input v-model="radio" type="radio" :value="true" />
    <select v-model="select">
      <option :value="1">选项一</option>
      <option :value="2">选项而</option>
    </select>
    <input v-model="txt" type="text">
  </div>
</template>

<script>
export default {
  props: {
    msg: String
  },
  data () {
    return {
      foo: '',
      radio: false,
      select: '',
      txt: ''
    }
  }
}
</script>
复制代码

随后,我们可以在组件挂载之后撰写如下测试用例来测试组件:

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'

describe('HelloWorld.vue', () => {
  it('change component data', () => {
    const wrapper = shallowMount(HelloWorld)
    const radioInput = wrapper.find('input[type="radio"]')
    const options = wrapper.find('select').findAll('option')
    const textInput = wrapper.find('input[type="text"]')
    radioInput.setChecked()
    options.at(1).setSelected()
    textInput.setValue('txt value')
    expect(wrapper.vm.radio).toBe(true)
    expect(wrapper.vm.select).toBe(2)
    expect(wrapper.vm.txt).toBe('txt value')

    wrapper.setProps({
      msg: 'msg value'
    })
    expect(wrapper.vm.msg).toBe('msg value')

    wrapper.setData({
      foo: 'foo value'
    })
    expect(wrapper.vm.foo).toBe('foo value')
  })
})
复制代码

测试事件

Vue应用程序中,我们主要会遇到两种类型的事件:原生DOM事件自定义Vue事件

原生DOM事件

通常而言原生DOM事件主要作为单元测试的输入,常见的原生DOM事件有:单击一个元素触发click事件、光标悬浮在元素上会触发mouseenter事件、在键盘按下任意键会触发keyup/keydown事件以及提交一个表单会触发submit事件等等。

Vue-Test-Utils中,每个包装器都有一个trigger方法,用于在包装元素上分发一个合成事件。所谓合成事件指的是在JavaScript中创建的事件,它的处理方式与浏览器分发事件的处理方式相同,区别在于原生事件通过EventLoop异步调用事件处理程序,而合成事件则是同步调用事件处理程序。

trigger方法可用于模拟几乎任何原生DOM事件,例如clickkeydownmouseenter等。假设我们有这样一个需求,点击元素一下实现数字自增:

<template>
  <div>
    {{count}}
    <button @click="count++">自增</button>
  </div>
</template>

<script>
export default {
  props: {
    msg: String
  },
  data () {
    return {
      count: 0
    }
  }
}
</script>
复制代码

那么我们可以在以上组件的基础上撰写测试click原生事件的单元测试:

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'
describe('HelloWorld.vue', () => {
  it('测试原生click事件', async () => {
    const wrapper = shallowMount(HelloWorld)
    const btn = wrapper.find('button')
    expect(wrapper.vm.count).toBe(0)
    btn.trigger('click')
    expect(wrapper.vm.count).toBe(1)
    await wrapper.vm.$nextTick()
    expect(wrapper.text()).toContain(1)
  })
})
复制代码

传递事件参数

在触发事件的同时,我们也可以选择传递事件参数,trigger()方法接受第二个可选的options参数,其中的属性会在分发事件时设置到$event对象上:

// 传递事件参数
btn.trigger('click', { count: 10 })

// 获取事件参数
handleIncrementClick ($event) {
  console.log($event.count)
}
复制代码

注意:我们不能在options选项中设置事件目标target的值,如果我们trigger的是一个表单元素,想要在trigger之前修改其表单的值。一方面,我们可以使用前面介绍过的几个set方法,另一方面,我们可以修改element元素上的值以达到我们的目的:

// setValue改变元素的值
input.setValue(100)
btn.trigger('click')

// element元素改变元素的值
input.element.value = 100
btn.trigger('click')
复制代码

自定义事件

在一个Vue应用程序中,自定义事件比原生DOM事件更加强大,因为自定义事件可以和父组件通信。Vue中自定义事件系统有两个部分:监听自定义事件的父组件和发射事件的组件本身,这意味着同样是一个自定义事件,当它处于不同的角色时它的定位是不一样的:

  • 对于发射事件的组件本身来说,发射事件是组件的输出。
  • 对于监听自定义事件的父组件来说,发射的事件是组件的输入。

Vue-Test-Utils中,一个组件它发射的事件可以通过wrapper.emitted()获取,它的返回值是一个对象,其中事件名作为对象的键名,对应的参数作为键的值,例如:

wrapper.vm.$emit('change', 100)
wrapper.vm.$emit('update:visible', false)

const emitted = wrapper.emitted()
console.log(emitted)
/*
{
  'change': [[100]],
  'update:visible': [[false]]  
}
*/
复制代码

我们先来看第一场情况,组件自身向外触发事件:

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'
describe('HelloWorld.vue', () => {
  it('emit触发事件', () => {
    const wrapper = shallowMount(HelloWorld)
    wrapper.vm.$emit('change', 100)
    wrapper.vm.$emit('update:visible', false)

    const emitted = wrapper.emitted()

    expect(emitted['change']).toBeTruthy()
    expect(emitted['change'][0]).toEqual([100])

    expect(emitted['update:visible']).toBeTruthy()
    expect(emitted['update:visible'][0]).toEqual([false])
  })
})
复制代码

接下来我们来看第二种子组件派发事件,父组件监听事件的情况,假设我们有如下父组件:

<template>
  <div>
    <child-component @custom="onCustom" />
    <p v-if="emitted">Emitted!</p>
  </div>
</template>

<script>
  import ChildComponent from './ChildComponent'

  export default {
    name: 'ParentComponent',
    components: { ChildComponent },
    data() {
      return {
        emitted: false
      }
    },
    methods: {
      onCustom() {
        this.emitted = true
      }
    }
  }
</script>
复制代码

那么我们可以撰写如下测试用例:

import { mount } from '@vue/test-utils'
import ParentComponent from '@/components/ParentComponent'
import ChildComponent from '@/components/ChildComponent'

describe('ParentComponent', () => {
  it("displays 'Emitted!' when custom event is emitted", () => {
    const wrapper = mount(ParentComponent)
    wrapper.find(ChildComponent).vm.$emit('custom')
    expect(wrapper.html()).toContain('Emitted!')
  })
})
复制代码

测试用例说明:find()方法不仅可以传递我们熟知的标准选择器:元素标签,类名等还可以传递一个组件,传递组件返回的是一个组件的包装器。

测试Vuex

在一个Vue应用程序中经常会使用到Vuex,我们有下面这几种方式来测试Vuex

  • 单独测试store中的每一个部分:我们可以把store中的mutationsactionsgetters单独划分,分别进行测试。
  • 组合测试store:我们不拆分store,而是把它当做一个整体,我们测试store实例,进而希望它能按期望输出。

单独测试store中的每一部分的好处是:单元测试可以小而且聚焦,当一个单元测试用例失败时,我们能够十分确切的知道错在哪里。缺点是:我们经常需要模拟Vuex的某些功能,而越多的模拟意味着越偏离实际,有时候很可能模拟错误而引入bug
组合测试store的好处是:这种方法更加健壮,因为我们不需要在重新编写、模拟Vuex的功能。

测试Mutations

对于一个mutation而言,它只是一个函数,因此mutation的单元测试非常简单。我们只需要传递参数,然后期望state能正确输出。假设一个mutation代码如下:

// mutations.js
setToken (state, token) {
  state.token = token
}
复制代码

我们可以基于以上代码撰写如下单元测试:

import mutations from './mutations.js'
describe('mutations', () => {
  it('test setToken mutations', () => {
    const token = '123456'
    const state = {
      token: ''
    }
    mutations.setToken(state, token)
    expect(state.token).toBe(token)
  })
})
复制代码

测试Getters

mutations一样,getters也是一个普通的函数,它始终返回一个值。因此这使得测试getters变得简单化,我们只需要断言getter函数的返回值即可。假设我们有如下getters代码:

// getters.js
export const passList = state => {
  return state.students.filter(stu => stu.score >= 60)
}
复制代码

我们可以基于以上代码撰写如下单元测试:

import getters from './getters.js'
describe('getters', () => {
  it('test passList getters', () => {
    const students = [
      { name: 'AAA', score: 59 },
      { name: 'BBB', score: 70 },
      { name: 'CCC', score: 10 }
    ]
    const state = {
      students: students
    }
    const result = getters.passList(state)
    expect(result).toEqual(students[1])
  })
})
复制代码

测试Actions

不同于mutations,我们单独模拟actions要稍微复杂一点,假设我们有如下actions代码:

// actions.js
export const login = ({ commit }, { userInfo, token }) {
  commit('setUserInfo', userInfo)
  commit('setToken', token)
}
复制代码

我们可以基于以上代码撰写如下单元测试:

import actions from './actions.js'
describe('actions', () => {
  const loginResult = {
    userInfo: { name: 'AAA', age: 23 },
    token: '123456'
  }
  it('test login action', () => {
    expect.assertions(1)
    const context = {
      commit: jest.fn()
    }
    actions.login(context, loginResult)
    expect(context.commit).toHaveBeenCalledWith('setToken', loginResult.token)
  })
})
复制代码

测试Vuex Store实例

组合测试store一个需要注意的点是,我们需要使用localVue而不是全局Vue上挂载我们的Vuex,假设我们有如下代码:

test('increment updates state.count by 1', () => {
  Vue.use(Vuex)
  const store = new Vuex.store({storeConfig})
  expect(store.state.count).toBe(0)

  store.commit('increment')
  expect(store.state.count).toBe(1)
})
复制代码

当我们运行以上代码进行单独测试时,而确实能按照我们的期望进行输出,但存在一个致命问题:如果我们有多个测试用例,因为store对象是引用类型,我们在第一个测试用例修改的值,会影响其他测试用例。

一个可行的办法时,我们每次使用store时,都使用cloneDeep(store)后的副本,这样确实能解决对象引用的问题,但Vue-Test-Utils提供了一种更友好的方式来处理这类问题:localVue

localVue我们在之前已经提到过,我们可以按照之前介绍的方式来改造以上测试用例:

import { createLocalVue } from '@vue/test-utils'

const localVue = createLocalVue()
localVue.use(Vuex)

test('increment updates state.count by 1', () => {
  const store = new Vuex.store({storeConfig})
  expect(store.state.count).toBe(0)

  store.commit('increment')
  expect(store.state.count).toBe(1)
})
复制代码

要测试一个完整的store,我们假设有如下代码:

import * as types from './mutation-types.js'
import {
  setToken,
  getToken,
  removeToken,
  setUserInfo,
  getUserInfo,
  removeUserInfo
} from '@/utils/cache.js'
const state = {
  token: getToken(),
  userInfo: getUserInfo()
}
const mutations = {
  [types.SET_TOKEN] (state, token) {
    state.token = token
  },
  [types.SET_USER_INFO] (state, userInfo) {
    state.userInfo = userInfo
  }
}
const actions = {
  login ({ commit }, { token, userInfo }) {
    commit(`${types.SET_TOKEN}`, setToken(token))
    commit(`${types.SET_USER_INFO}`, setUserInfo(userInfo))
  },
  logout ({ commit }) {
    commit(`${types.SET_TOKEN}`, removeToken())
    commit(`${types.SET_USER_INFO}`, removeUserInfo())
  }
}
复制代码

我们同时定义getters.js代码如下:

export const token = (state) => state.token

export const userInfo = (state) => state.userInfo
复制代码

因此我们可以撰写以下测试整体store的代码:

import store from './store/index.js'
import * as types from './store/mutation-types.js'
import * as getters from './store/getters.js'

describe('test store', () => {
  beforeEach(() => {
    localStorage.clear()
  })
  it('test login action', () => {
    const loginResult = {
      userInfo: { name: 'AAA', age: 23 },
      token: '123456'
    }
    expect(getters.token).toBe('')
    expect(getters.userInfo).toEqual({})

    store.dispatch('login', loginResult)
    expect(getters.token).toBe(loginResult.token)
    expect(getters.userInfo).toEqual(loginResult.userInfo)
  })
  it('test logout action', () => {
    store.dispatch('logout')
    expect(getters.token).toBe('')
    expect(getters.userInfo).toEqual({})
  })
})
复制代码

测试Vue-Router

Vue-Router被安装到Vue以后,它会添加两个实例属性:$route$router,这两个属性一旦被添加则不允许再重写。

  • $route:包含了当前匹配路由的信息,其中包含路由参数中的任何动态字段。
  • $router:是当前路由实例,它包含了可以控制当前路由的所有方法,例如:pushreplaceback等。

测试$route

当我们的组件使用了$route实例属性,则该属性将成为组件的依赖,我们在之前已经介绍过,处理依赖的一种可行的方式就是模拟,假设我们有如下组件:

<template>
  <div>
    <p v-if="$route.query && $route.query.id">get detail</p>
    <p v-else>need passed id</p>
  </div>
</template>
复制代码

我们可以看到以上组件使用到了$route实例属性,因此我们为上面的组件撰写如下测试代码:

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'

describe('HelloWorld.vue', () => {
  let $route 
  beforeEach(() => {
    $route = {
      query: {}
    }
  })
it('no passed $route.query.id', () => {
    const wrapper = shallowMount(HelloWorld, {
      mocks: {
        $route
      }
    })
    expect(wrapper.text()).toContain('need passed id')
  })
  it('passed $route.query.id', () => {
    $route.query.id = 123
    const wrapper = shallowMount(HelloWorld, {
      mocks: {
        $route
      }
    })
    expect(wrapper.text()).toContain('get detail')
  })
})
复制代码

测试$router

在以上测试$route组件的基础上,我们进一步修改代码:

<template>
  <div>
    <p v-if="$route.query.id">get detail</p>
    <p v-else>need passed id</p>
  </div>
</template>
<script>
export default {
  mounted () {
    if (!this.$route.query.id) {
      this.$router.replace('/home')
    }
  }
}
</script>
复制代码

那么我们测试$router的代码可以像下面这样写:

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'

describe('HelloWorld.vue', () => {
  let $route
  let $router
  beforeEach(() => {
    $route = {
      query: {}
    }
    $router = {
      replace: jest.fn()
    }
  })
  it('replace home when no id', () => {
    const wrapper = shallowMount(HelloWorld, {
      mocks: {
        $route,
        $router
      }
    })
    expect($router.replace).toHaveBeenCalled()
  })
})

复制代码

测试RouterLink

依旧以上面组件代码为例,我们添加router-link,当没有传递id参数时,我们让用户手动点击返回:

<template>
  <div>
    <p v-if="$route.query.id">get detail</p>
    <p v-else>
      need passed id
      <router-link to="/home">返回</router-link>
    </p>
  </div>
</template>
复制代码

我们都知道,在安装了Vue-Router后,我们就可以使用router-linkrouter-view等内置组件,但是如果我们不做其他处理的话,我们并不能把router-link当做一个组件,进而根据wrapper.findComponent()方法去找到它。

Vue-Test-Utils中,我们可以使用studs存根router-link,然后使用RouterLinkStub控制router-link渲染:

import { shallowMount, RouterLinkStub } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'
const wrapper = shallowMount(HelloWorld, {
  stubs: {
    RouterLink: RouterLinkStub
  }
})
复制代码

那么我们的测试代码如下:

import { shallowMount, RouterLinkStub } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'

describe('HelloWorld.vue', () => {
  it('render router-link', () => {
    const $route = {
      query: {}
    }
    const wrapper = shallowMount(HelloWorld, {
      stubs: {
        RouterLink: RouterLinkStub
      },
      mocks: {
        $route
      }
    })
    expect(wrapper.findComponent(RouterLinkStub).props().to).toBe('/home')
  })
})
复制代码

注意:如果我们要找元素标签推荐使用wrapper.find()方法,如果要找组件推荐使用wrapper.findComponent()

测试Mixins和Filters

测试mixin

测试mixin的过程很简单:在组件中或全局注册mixin、挂载组件、最后检查mixin是否产生了预期的行为。

假设我们有如下titleMixin代码:

/// mixin.js
export const titleMixin = {
  mounted () {
    const title = this.title
    if (title) {
      document.title = title
    }
  }
}
复制代码

然后我们在组件使用该mixin

<template>
  <div>
    Hello,Vue.js
  </div>
</template>
<script>
import { titleMixin } from '@/mixin/index.js'
export default {
  mixins: [titleMixin],
  data () {
    return {
      title: '测试title mixin'
    }
  }
}
</script>
复制代码

最后,我们撰写测试titleMixin的测试用例:

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'
describe('HelloWorld.vue', () => {
  it('test mixin', () => {
    const wrapper = shallowMount(HelloWorld)
    expect(document.title).toBe('测试title mixin')
  })
})
复制代码

测试filters

测试filters的方式同mixins十分相似,假设我们有如下反转字符串filter代码:

export const reverseStr = (str) => {
  if (!str) {
    return
  }
  if (typeof str !== 'string') {
    return str
  }
  return str.split('').reverse().join('')
}
复制代码

接下来,我们在组件中使用该filter

<template>
  <div>
    <span>{{msg | reverseStr}}</span>
    <span>{{age | reverseStr}}</span>
  </div>
</template>
<script>
import { reverseStr } from '@/filters/index.js'
export default {
  filters: {
    reverseStr
  },
  data () {
    return {
      age: 23,
      msg: 'ABC',
    }
  }
}
</script>
复制代码

最后,我们为以上组件编写测试用例:

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'
describe('HelloWorld.vue', () => {
  it('test filters', () => {
    const wrapper = shallowMount(HelloWorld)
    expect(wrapper.text()).toContain('CBA')
    expect(wrapper.text()).toContain('23')
  })
})
复制代码

快照测试

一个对快照测试简单的解释就是获取代码的快照,并将其与以前保存的快照进行比较,如果新的快照与前一个快照不匹配,测试会失败。快照测试对于测试一个组件来说,相对比较有用,因为如果添加了快照测试,它能防止我们错误的修改了组件。

Jest自动化测试框架中,我们可使用以下代码为组件进行快照:

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'

it('match snapshot', () => {
  const wrapper = shallowMount(HelloWorld)
  expect(wrapper.element).toMatchSnapshot()
})
复制代码

以上快照测试的流程如下:

  1. 运行快照测试。
  2. 生成输出。
  3. 之前是否有快照存在。
  4. 不存在,创建快照,测试通过
  5. 存在则继续与之前的快照进行比对,是否相同。
  6. 相同,测试通过。
  7. 不相同,测试失败。

一个快照测试的示例如下:

exports[`HelloWorld.vue match snapshot 1`] = `
<div>
  <span
    class="item"
  >
    item
  </span>
  Hello, Vue and Jest...
</div>
`;
复制代码

静态组件快照

静态组件:指的是总是渲染相同输出的组件,它不接受任何prop,也没有任何state,组件内也没有任何逻辑,并且总是会渲染相同的HTML元素。为静态组件编写单元测试完全没有必要,但对于一个组件来说,为其编写一个快照测试则十分有必要。

假设我们有如下的静态组件:

<template>
  <transition>
    <svg class="spinner" width="44px" height="44px" viewBox="0 0 44 44">
      <circle class="path" fill="none" stroke-width="4" stroke-linecap="round" cx="22" cy="22" r="20">
    </svg>
  </transition>
</template>
复制代码

我们编写如下静态快照测试用例:

import { shallowMount } from '@vue/test-utils'
import Spinner from '@/components/spinner.vue'

describe('spinner.vue', () => {
  it('match snapshot', () => {
    const wrapper = shallowMount(Spinner)
    expect(wrapper.element).toMatchSnapshot()
  })
})
复制代码

动态组件快照

动态组件:指的是那些包含逻辑和状态的组件,比如点击按钮会传递props的值或更改组件数据。为动态组件编写测试用例时,应该尝试捕获最重要的几条分支逻辑。因为对于一个大的组件而言,它会受props,自身data或者其他数据影响组件的渲染结果,而我们又不可能为每一种分支逻辑都撰写一个快照测试。

假设我们有如下组件代码:

<template>
  <div>
    <div v-if="age < 10"> child person </div>
    <div v-else-if="age>=10&&age<30">youth person</div>
    <div>{{msg}}</div>
  </div>
</template>
<script>
export default {
  props: {
    msg: {
      type: String,
      default: 'default msg'
    }
  },
  data () {
    return {
      age: 11
    }
  }
}
</script>
复制代码

我们依据以上代码撰写下面2个快照测试用例:

import { shallowMount } from '@vue/test-utils'
import HelloWorld from '@/components/HelloWorld.vue'

describe('HelloWorld.vue', () => {
  let wrapper
  beforeEach(() => {
    wrapper = shallowMount(HelloWorld)
  })
  it('match msg snapshot', () => {
    expect(wrapper.element).toMatchSnapshot()
  })
  it('match age snapshot', async () => {
    wrapper.setData({
      age: 6
    })
    await wrapper.vm.$nextTick()
    expect(wrapper.element).toMatchSnapshot()
  })
})
复制代码

运行npm run test:unit后,我们将得到如下快照:

exports[`HelloWorld.vue match age snapshot 1`] = `
<div>
  <div>
     child person 
  </div>
   
  <div>
    default msg
  </div>
</div>
`;

exports[`HelloWorld.vue match msg snapshot 1`] = `
<div>
  <div>
    youth person
  </div>
   
  <div>
    default msg
  </div>
</div>
`;
复制代码

更新快照

我们已经在上面分别介绍了静态组件和动态组件撰写快照测试的方法,我们也了解了快照测试对于一个组件的意义:当一个快照测试用例失败时,它提示我们组件相较于上一次做了修改。如果是计划外的,测试会捕获异常并将它输出提示我们。如果是计划内的,那么我们就需要更新快照。

更新快照主要有2种情况:

  • 全部更新:我们可以使用npm run test:unit -- -u命令批量更新我们的快照,但这种方式是十分危险的,因为很可能其中某一个组件是计划外的更新,此时如果执行批量更新快照则会生成一个错误的快照文件。
  • 交互式更新:我们可以使用npm run test:unit -- --watch命令进行Jest交互式更新,i键浏览所有失败的快照文件,u键使用最新值来更新之前保存的快照。其它按键请参照Jest官网上面的内容。