封装Vue组件库(五)、Jest 组件单元测试

2024-08-23 01:38

本文主要是介绍封装Vue组件库(五)、Jest 组件单元测试,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

Jest - Vue 组件的单元测试

单元测试就是对一个函数的输入和输出进行测试。

使用断言的方式,根据输入判断实际的输出和预测的输出是否相同。

使用单元测试的目的,是用来发现模块内部可能存在的各种错误。

组件的单元测试指的是使用单元测试工具,对组件的各种状态和行为进行测试,确保组件发布之后在项目中使用组件的过程中不会导致程序出现错误。

组件的单元测试的好处

  • 提供描述组件行为的文档
    • 对组件的单元测试,其实就是一种组件使用方式的文档
  • 节省手动测试的时间
  • 减少研发新特性时产生的 bug
  • 改进设计
  • 促进重构

配置组件单元测试的环境

安装依赖

  • Vue Test Utils Vue 组件单元测试的官方库。(Github)
    • 它需要结合一个单元测试框架一起使用,例如 Jest
  • Jest Facebook 出的单元测试框架(官网)
    • 它和Vue的结合比较方便,配置最少
    • 它可以进行单元测试,但是并不支持单文件组件,所以还需要一个预处理器,把vue单文件组件编译之后的结果(JS代码)交给 Jest 处理。
  • vue-jest Vue 官方提供的一个为 Jest 服务的预处理器
    • 它支持单文件组件的大多数功能
  • babel-jest 对测试代码中的ES6语法进行降级处理
# 在工作区根目录安装开发依赖
yarn add jest @vue/test-utils vue-jest babel-jest -D -W

当前项目示例使用了 yarn workspaces 所以要使用 -W 指定依赖安装到 workspace root,否则会报错。

配置测试脚本

项目根目录 package.json

"scripts": {"test": "jest",// ...
}

Jest 配置文件

项目根目录创建 jest.config.js

module.exports = {// 运行 jest 的时候寻找测试文件的路径testMatch: ['**/__tests__/**/*.[jt]s?(x)'],// 测试文件中导入文件的后缀,配置.vuemoduleFileExtensions: ['js','json',// 告诉 Jest 处理 `*.vue` 文件'vue'],// 转换:通过正则配置匹配的文件,交给哪个模块处理transform: {// 用 `vue-jest` 处理 `*.vue` 文件'.*\\.(vue)$': 'vue-jest',// 用 `babel-jest` 处理 js'.*\\.(js)$': 'babel-jest'}
}

当前项目示例每个组件包中的测试目录是 __test__ ,需要调整为 __tests__

Babel 配置文件

项目根目录创建 babel.config.js

module.exports = {presets: [['@babel/preset-env']]
}

Babel 桥接

当前使用 storybook 初始化的项目中安装了 babel7。

但是 vue-jest 依赖的是 babel6。

此时运行测试的时候会提示找不到 babel。

解决这个问题需要安装 babel 的桥接:

yarn add babel-core@bridge -D -W

vue-jest 和 Vue Test Utils 文档中有相关的介绍:

  • vue-jest - Usage with Babel 7
  • Vue Test Utils - Using with Babel

Jest 和 Vue Test Utils 常用 API

Jest 常用 API

  • 全局函数
    • describe(name, fn) 把相关测试组合在一起
    • test(name, fn) 测试方法
    • expect(value) 断言
  • 匹配器
    • toBe(value) 判断值是否相等
    • toEqual(obj) 判断对象是否相等
    • toContain(value) 判断数组或字符串中是否包含value
  • 快照
    • toMatchSnapshot() 记录快照
      • 第一次调用会把 expect 中的值以字符串的形式存储到一个.snap文件中
      • 之后再运行快照,会对比当前 expect 函数中的值 和 快照文件中的结果
      • 如果相同,测试通过,如果不同,测试失败。
      • 重新生成快照文件 yarn jest -u

Vue Test Utils 常用 API

  • mount() 创建一个包含被挂载和渲染的 Vue 组件的 Wrapper
  • Wrapper 是一个包裹器,除了记录组件生成的实例外,还记录了很多对组件中 DOM 元素操作的方法,方便测试组件生成的内容。
    • vm wrapper 包裹的组件实例
    • props() 返回Vue实例的 props 对象,或指定prop的值,方便测试组件的状态
    • html() 组件生成的 HTML 标签(字符串)
    • find() 通过选择器返回匹配到的组件中的 DOM 元素
    • trigger() 触发 DOM 原生事件。触发自定义事件使用 wrapper.vm.$emit()

编写测试文件

假设测试 Input 组件。

目录结构:

|- packages
|  |- input
|  |  |- __tests__
|  |  |  |- input.test.js # 约定测试文件都已 .test.js 结尾
|  |  |- src
|  |  |  |- input.vue
|  |  |- index.js
|  |  |- package.json
#... 其他文件:stories 版权 md文档等
// input.vue
<template><div><input :type="type" v-bind="$attrs" @input="handleInput" /></div>
</template><script>
export default {name: 'MyInput',inheritAttrs: false,model: {prop: 'value',event: 'input'},props: {value: {},type: {type: String,default: 'text'}},methods: {handleInput($event) {this.$emit('input', $event.target.value)}}
}
</script>

编写测试文件:

// input.test.js
// 导入组件
import input from '../src/input.vue'
// 导入 Vue Test Utils 中的 API 挂在组件
import { mount } from '@vue/test-utils'// 通过 describe 创建一个代码块
// 把 input 的相关测试都放到这个代码块中
describe('my-input', () => {// 测试1:测试 input 组件是否生成的是预期的文本框test('input-text', () => {// 在内存中挂在组件,并获取返回的包裹器const wrapper = mount(input)// 断言:包裹器获取的html字符串中包含指定内容expect(wrapper.html()).toContain('input type="text"')})// 测试2:测试密码文本框test('input-password', () => {// propsData 设置组件的props属性const wrapper = mount(input, {propsData: {type: 'password'}})expect(wrapper.html()).toContain('input type="password"')})// 测试3:测试组件状态(value值)test('input-value', () => {const wrapper = mount(input, {propsData: {type: 'password',value: 'admin'}})expect(wrapper.props('value')).toBe('admin')})// 测试4:快照对比test('input-snapshot', () => {const wrapper = mount(input, {propsData: {type: 'password',value: 'admin'}})// 首次执行该测试,会在当前test.js所在目录创建 __snapshots__ 目录// 目录中存放的就是快照文件 input.test.js.snap// 当前测试用例存储的快照内容是组件实例的 DOM// 之后再执行该测试,就会用 expect 传入的值,对比快照文件中的内容// 如果一样,测试成功,如果不一样,测试失败// 可以修改 propsData 的参数查看对比结果// 重新生成快照: `yarn jest -u`expect(wrapper.vm.$el).toMatchSnapshot()})})

这篇关于封装Vue组件库(五)、Jest 组件单元测试的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1097993

相关文章

Golang如何对cron进行二次封装实现指定时间执行定时任务

《Golang如何对cron进行二次封装实现指定时间执行定时任务》:本文主要介绍Golang如何对cron进行二次封装实现指定时间执行定时任务问题,具有很好的参考价值,希望对大家有所帮助,如有错误... 目录背景cron库下载代码示例【1】结构体定义【2】定时任务开启【3】使用示例【4】控制台输出总结背景

前端如何通过nginx访问本地端口

《前端如何通过nginx访问本地端口》:本文主要介绍前端如何通过nginx访问本地端口的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、nginx安装1、下载(1)下载地址(2)系统选择(3)版本选择2、安装部署(1)解压(2)配置文件修改(3)启动(4)

HTML中meta标签的常见使用案例(示例详解)

《HTML中meta标签的常见使用案例(示例详解)》HTMLmeta标签用于提供文档元数据,涵盖字符编码、SEO优化、社交媒体集成、移动设备适配、浏览器控制及安全隐私设置,优化页面显示与搜索引擎索引... 目录html中meta标签的常见使用案例一、基础功能二、搜索引擎优化(seo)三、社交媒体集成四、移动

HTML input 标签示例详解

《HTMLinput标签示例详解》input标签主要用于接收用户的输入,随type属性值的不同,变换其具体功能,本文通过实例图文并茂的形式给大家介绍HTMLinput标签,感兴趣的朋友一... 目录通用属性输入框单行文本输入框 text密码输入框 password数字输入框 number电子邮件输入编程框

HTML img标签和超链接标签详细介绍

《HTMLimg标签和超链接标签详细介绍》:本文主要介绍了HTML中img标签的使用,包括src属性(指定图片路径)、相对/绝对路径区别、alt替代文本、title提示、宽高控制及边框设置等,详细内容请阅读本文,希望能对你有所帮助... 目录img 标签src 属性alt 属性title 属性width/h

CSS3打造的现代交互式登录界面详细实现过程

《CSS3打造的现代交互式登录界面详细实现过程》本文介绍CSS3和jQuery在登录界面设计中的应用,涵盖动画、选择器、自定义字体及盒模型技术,提升界面美观与交互性,同时优化性能和可访问性,感兴趣的朋... 目录1. css3用户登录界面设计概述1.1 用户界面设计的重要性1.2 CSS3的新特性与优势1.

Python中对FFmpeg封装开发库FFmpy详解

《Python中对FFmpeg封装开发库FFmpy详解》:本文主要介绍Python中对FFmpeg封装开发库FFmpy,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录一、FFmpy简介与安装1.1 FFmpy概述1.2 安装方法二、FFmpy核心类与方法2.1 FF

HTML5 中的<button>标签用法和特征

《HTML5中的<button>标签用法和特征》在HTML5中,button标签用于定义一个可点击的按钮,它是创建交互式网页的重要元素之一,本文将深入解析HTML5中的button标签,详细介绍其属... 目录引言<button> 标签的基本用法<button> 标签的属性typevaluedisabled

HTML5实现的移动端购物车自动结算功能示例代码

《HTML5实现的移动端购物车自动结算功能示例代码》本文介绍HTML5实现移动端购物车自动结算,通过WebStorage、事件监听、DOM操作等技术,确保实时更新与数据同步,优化性能及无障碍性,提升用... 目录1. 移动端购物车自动结算概述2. 数据存储与状态保存机制2.1 浏览器端的数据存储方式2.1.

基于 HTML5 Canvas 实现图片旋转与下载功能(完整代码展示)

《基于HTML5Canvas实现图片旋转与下载功能(完整代码展示)》本文将深入剖析一段基于HTML5Canvas的代码,该代码实现了图片的旋转(90度和180度)以及旋转后图片的下载... 目录一、引言二、html 结构分析三、css 样式分析四、JavaScript 功能实现一、引言在 Web 开发中,