封装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

相关文章

HTML5的input标签的`type`属性值详解和代码示例

《HTML5的input标签的`type`属性值详解和代码示例》HTML5的`input`标签提供了多种`type`属性值,用于创建不同类型的输入控件,满足用户输入的多样化需求,从文本输入、密码输入、... 目录一、引言二、文本类输入类型2.1 text2.2 password2.3 textarea(严格

SpringBoot返回文件让前端下载的几种方式

《SpringBoot返回文件让前端下载的几种方式》文章介绍了开发中文件下载的两种常见解决方案,并详细描述了通过后端进行下载的原理和步骤,包括一次性读取到内存和分块写入响应输出流两种方法,此外,还提供... 目录01 背景02 一次性读取到内存,通过响应输出流输出到前端02 将文件流通过循环写入到响应输出流

SpringBoot+Vue3整合SSE实现实时消息推送功能

《SpringBoot+Vue3整合SSE实现实时消息推送功能》在日常开发中,我们经常需要实现实时消息推送的功能,这篇文章将基于SpringBoot和Vue3来简单实现一个入门级的例子,下面小编就和大... 目录前言先大概介绍下SSE后端实现(SpringBoot)前端实现(vue3)1. 数据类型定义2.

JavaWeb 中的 Filter组件详解

《JavaWeb中的Filter组件详解》本文详细介绍了JavaWeb中的Filter组件,包括其基本概念、工作原理、核心接口和类、配置方式以及常见应用示例,Filter可以实现请求预处理、响应后... 目录JavaWeb 中的 Filter 详解1. Filter 基本概念1.1 什么是 Filter1.

2025最新版Android Studio安装及组件配置教程(SDK、JDK、Gradle)

《2025最新版AndroidStudio安装及组件配置教程(SDK、JDK、Gradle)》:本文主要介绍2025最新版AndroidStudio安装及组件配置(SDK、JDK、Gradle... 目录原生 android 简介Android Studio必备组件一、Android Studio安装二、A

前端Visual Studio Code安装配置教程之下载、汉化、常用组件及基本操作

《前端VisualStudioCode安装配置教程之下载、汉化、常用组件及基本操作》VisualStudioCode是微软推出的一个强大的代码编辑器,功能强大,操作简单便捷,还有着良好的用户界面,... 目录一、Visual Studio Code下载二、汉化三、常用组件1、Auto Rename Tag2

vite搭建vue3项目的搭建步骤

《vite搭建vue3项目的搭建步骤》本文主要介绍了vite搭建vue3项目的搭建步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学... 目录1.确保Nodejs环境2.使用vite-cli工具3.进入项目安装依赖1.确保Nodejs环境

Nginx搭建前端本地预览环境的完整步骤教学

《Nginx搭建前端本地预览环境的完整步骤教学》这篇文章主要为大家详细介绍了Nginx搭建前端本地预览环境的完整步骤教学,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录项目目录结构核心配置文件:nginx.conf脚本化操作:nginx.shnpm 脚本集成总结:对前端的意义很多

前端缓存策略的自解方案全解析

《前端缓存策略的自解方案全解析》缓存从来都是前端的一个痛点,很多前端搞不清楚缓存到底是何物,:本文主要介绍前端缓存的自解方案,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录一、为什么“清缓存”成了技术圈的梗二、先给缓存“把个脉”:浏览器到底缓存了谁?三、设计思路:把“发版”做成“自愈”四、代码

通过React实现页面的无限滚动效果

《通过React实现页面的无限滚动效果》今天我们来聊聊无限滚动这个现代Web开发中不可或缺的技术,无论你是刷微博、逛知乎还是看脚本,无限滚动都已经渗透到我们日常的浏览体验中,那么,如何优雅地实现它呢?... 目录1. 早期的解决方案2. 交叉观察者:IntersectionObserver2.1 Inter