vue-34（单元测试 Vue 组件的介绍）-CSDN博客

本文链接：https://blog.csdn.net/u011290209/article/details/149055485

介绍单元测试 Vue 组件是一项构建健壮且可维护应用的关键技能。随着应用复杂性的增加，手动测试变得越来越耗时且容易出错。单元测试提供对单个组件的自动化验证，确保它们按预期行为，并在进行更改时防止回归。本课程将涵盖单元测试的基本概念、设置测试环境以及为 Vue 组件编写有效测试。

理解单元测试

单元测试涉及在隔离状态下测试应用程序的各个单元或组件。在 Vue.js 的上下文中，单元通常是一个组件。其目标是验证每个组件都能正确运行，并且独立于应用程序的其他部分。

单元测试的优势

早期错误检测： 单元测试可以在开发过程的早期识别错误，在它们进入生产环境之前。
代码质量： 编写单元测试能促使开发者编写更干净、更模块化、更易于测试的代码。
回归预防： 单元测试充当安全网，确保在添加新功能或进行更改时，现有功能保持完整。
更快开发： 虽然最初编写测试需要时间，但它最终通过减少调试时间和防止回归来加快开发速度。
文档： 单元测试是一种文档形式，展示了组件的预期使用方式。
重构信心： 单元测试在重构代码时提供信心，因为它们确保更改不会破坏现有功能。

单元测试的关键原则

隔离性： 每个单元测试应该隔离地测试单个组件，不依赖外部依赖或副作用。
自动化： 单元测试应该是自动化的，这样它们就可以快速地重复运行。
可重复性： 单元测试每次运行时都应产生相同的结果，与环境无关。
独立性： 单元测试应相互独立，以便一个测试的失败不会影响其他测试。
清晰性： 单元测试应清晰易懂，以便开发人员能够快速识别和修复任何问题。

单元测试与其他类型测试的对比

区分单元测试与其他类型的测试（如集成测试和端到端测试）非常重要。

| 测试类型 | 范围 | 目的

示例场景

让我们考虑几个单元测试特别有价值的情况：

表单验证： 想象一个负责验证表单用户输入的组件。单元测试可以验证验证逻辑是否正确识别有效和无效输入，以及是否显示适当的错误消息。
数据转换： 假设你有一个组件可以将数据从一种格式转换为另一种格式。单元测试可以确保转换操作正确执行，并且输出数据符合预期格式。
事件处理： 考虑一个在特定操作发生时发出自定义事件的组件。单元测试可以验证事件是否以正确的数据发出，以及父组件是否适当地处理这些事件。

设置测试环境

要开始对 Vue 组件进行单元测试，你需要设置一个测试环境。这通常涉及安装一个测试框架、一个测试运行器以及任何必要的工具。

选择测试框架

Vue.js 有多种测试框架可供选择，每个框架都有其优缺点。其中两种流行的选择是：

Jest: 由 Facebook 开发的一个广泛使用的测试框架。它提供出色的性能、丰富的功能集，以及内置的模拟和代码覆盖率支持。
Mocha: 一个灵活且可扩展的测试框架，可与多种断言库和模拟工具一起使用。

在这个课程中，我们将专注于 Jest，因为它在 Vue.js 社区中是一个流行的选择，并且提供了全面的功能集。

安装 Jest 和 Vue Test Utils

要安装 Jest 和 Vue Test Utils，请在您的项目目录中运行以下命令：

npm install --save-dev @vue/test-utils jest

@vue/test-utils 是测试 Vue 组件的官方工具库。它提供了一套用于挂载组件、与之交互以及断言其行为的辅助函数。

配置 Jest

在安装 Jest 后，您需要将其配置为与 Vue.js 组件一起使用。在您的项目根目录中创建一个 jest.config.js 文件，内容如下：

module.exports = {
  moduleFileExtensions: [
    'js',
    'jsx',
    'json',
    'vue'
  ],
  transform: {
    '^.+\\.vue$': 'vue-jest',
    '.+\\.(css|styl|less|sass|scss|svg|png|jpg|ttf|woff|woff2)$': 'jest-transform-stub',
    '^.+\\.jsx?$': 'babel-jest'
  },
  moduleNameMapper: {
    '^@/(.*)$': '<rootDir>/src/$1'
  },
  snapshotSerializers: [
    'jest-serializer-vue'
  ],
  testMatch: [
    '**/tests/unit/**/*.spec.(js|jsx|ts|tsx)|**/__tests__/*.(js|jsx|ts|tsx)'
  ],
  testURL: 'http://localhost/'
}

此配置告诉 Jest 如何处理不同类型的文件，例如 .vue 组件、CSS 文件和 JavaScript 文件。它还配置了模块名称映射和快照序列化器。

设置测试脚本

将以下脚本添加到你的 package.json 文件中：

"scripts": {
  "test:unit": "jest --clearCache --config jest.config.js",
  "test:unit:watch": "jest --clearCache --config jest.config.js --watchAll"
}

test:unit 脚本使用指定的配置运行 Jest。--clearCache 标志清除 Jest 的缓存，确保你使用最新代码运行测试。test:unit:watch 脚本以监视模式运行 Jest，当你修改代码时，它会自动重新运行测试。

为组件编写单元测试

现在你已经设置好了测试环境，可以开始为你的 Vue 组件编写单元测试了。

创建测试文件

在你的项目根目录下创建一个 tests/unit 目录。在这个目录中，创建一个与你要测试的组件同名，后缀为 .spec.js 的文件。例如，如果你要测试一个名为 MyComponent.vue 的组件，创建一个名为 MyComponent.spec.js 的文件。

基础测试结构

一个典型的单元测试文件由以下部分组成：

导入语句： 导入你想要测试的组件，以及从 @vue/test-utils 中需要的任何工具。
测试套件： 使用 describe 函数将相关的测试分组在一起。
测试用例： 使用 it 函数来定义单个测试用例。
断言： 使用断言函数（例如，expect）来验证组件是否按预期工作。

这里有一个基本示例：

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

describe('MyComponent.vue', () => {
  it('renders props.msg when passed', () => {
    const msg = 'Hello Jest'
    const wrapper = shallowMount(MyComponent, {
      propsData: { msg }
    })
    expect(wrapper.text()).toMatch(msg)
  })
})

在这个例子中，我们使用 shallowMount 来为 MyComponent 组件创建一个浅包装器。浅渲染只渲染组件本身，而不会渲染其子组件。这对于隔离被测试的组件很有用。然后我们将 msg 属性传递给组件，并断言组件正确地渲染了属性值。

安装组件

@vue/test-utils 提供了多种用于安装组件的函数：

mount: 挂载组件及其所有子组件。
shallowMount: 不渲染其子组件地挂载组件。
shallowMountView: 将组件渲染为字符串，不创建 Vue 实例。

选择使用哪种挂载函数取决于具体的测试用例。通常情况下，shallowMount 更适合单元测试，因为它提供了更好的隔离性和性能。

与组件交互

@vue/test-utils 提供了一套用于与组件交互的方法，例如：

find: 在组件模板中查找一个元素。
findAll: 在组件模板中查找所有匹配选择器的元素。
trigger: 在一个元素上触发一个事件。
setData: 设置组件的数据。
setProps: 设置组件的属性。

这里是如何使用这些方法的示例：

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

describe('MyComponent.vue', () => {
  it('increments the count when the button is clicked', async () => {
    const wrapper = shallowMount(MyComponent)
    await wrapper.find('button').trigger('click')
    expect(wrapper.vm.count).toBe(1)
  })
})

在这个例子中，我们在组件的模板中找到一个按钮元素，并在其上触发 click 事件。然后我们断言组件的 count 数据属性已经被增加。

断言组件行为

Jest 提供了一套丰富的断言函数，用于验证组件是否按预期工作。一些常用的断言函数包括：

toBe: 检查两个值是否严格相等。
toEqual: 检查两个值是否深度相等。
toMatch: 检查字符串是否匹配正则表达式。
toContain: 检查数组是否包含特定值。
toBeTruthy: 检查一个值是否为真值。
toBeFalsy: 检查一个值是否为假值。
toHaveBeenCalled: 检查一个函数是否被调用。
toHaveBeenCalledWith: 检查一个函数是否被使用特定参数调用。

这里是如何使用这些断言函数的一个示例：

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

describe('MyComponent.vue', () => {
  it('emits a custom event when the button is clicked', async () => {
    const wrapper = shallowMount(MyComponent)
    await wrapper.find('button').trigger('click')
    expect(wrapper.emitted().customEvent).toBeTruthy()
  })
})

在这个例子中，我们断言当按钮被点击时，组件会发出一个 customEvent 事件。

测试属性

测试属性涉及验证组件是否正确渲染属性值，以及它是否适当处理属性更新。

// MyComponent.vue
<template>
  <div>
    <h1>{{ title }}</h1>
    <p>{{ message }}</p>
  </div>
</template>

<script>
export default {
  props: {
    title: {
      type: String,
      required: true
    },
    message: {
      type: String,
      default: 'Default message'
    }
  }
}
</script>

// MyComponent.spec.js
import { shallowMount } from '@vue/test-utils'
import MyComponent from '@/components/MyComponent.vue'

describe('MyComponent.vue', () => {
  it('renders the title prop', () => {
    const title = 'My Title'
    const wrapper = shallowMount(MyComponent, {
      propsData: { title }
    })
    expect(wrapper.find('h1').text()).toBe(title)
  })

  it('renders the message prop', () => {
    const message = 'My Message'
    const wrapper = shallowMount(MyComponent, {
      propsData: { title: 'Some Title', message }
    })
    expect(wrapper.find('p').text()).toBe(message)
  })

  it('renders the default message if no message prop is provided', () => {
    const wrapper = shallowMount(MyComponent, {
      propsData: { title: 'Some Title' }
    })
    expect(wrapper.find('p').text()).toBe('Default message')
  })

  it('updates the title when the title prop changes', async () => {
    const wrapper = shallowMount(MyComponent, {
      propsData: { title: 'Initial Title' }
    })
    await wrapper.setProps({ title: 'Updated Title' })
    expect(wrapper.find('h1').text()).toBe('Updated Title')
  })
})

测试事件

测试事件涉及验证组件在特定操作发生时是否发出正确的事件以及正确的数据。

// MyComponent.vue
<template>
  <button @click="handleClick">Click me</button>
</template>

<script>
export default {
  methods: {
    handleClick() {
      this.$emit('custom-event', { message: 'Hello from component' })
    }
  }
}
</script>

// MyComponent.spec.js
import { shallowMount } from '@vue/test-utils'
import MyComponent from '@/components/MyComponent.vue'

describe('MyComponent.vue', () => {
  it('emits a custom event when the button is clicked', async () => {
    const wrapper = shallowMount(MyComponent)
    await wrapper.find('button').trigger('click')
    expect(wrapper.emitted('custom-event')).toBeTruthy()
  })

  it('emits the custom event with the correct payload', async () => {
    const wrapper = shallowMount(MyComponent)
    await wrapper.find('button').trigger('click')
    expect(wrapper.emitted('custom-event')[0][0]).toEqual({ message: 'Hello from component' })
  })
})

测试方法

测试方法包括验证组件的方法是否执行正确的操作并返回预期的值。

// MyComponent.vue
<template>
  <div>
    <p>{{ formattedMessage }}</p>
  </div>
</template>

<script>
export default {
  data() {
    return {
      message: 'hello world'
    }
  },
  computed: {
    formattedMessage() {
      return this.formatMessage(this.message)
    }
  },
  methods: {
    formatMessage(message) {
      return message.toUpperCase()
    }
  }
}
</script>

// MyComponent.spec.js
import { shallowMount } from '@vue/test-utils'
import MyComponent from '@/components/MyComponent.vue'

describe('MyComponent.vue', () => {
  it('formats the message correctly', () => {
    const wrapper = shallowMount(MyComponent)
    expect(wrapper.vm.formatMessage('test')).toBe('TEST')
  })

  it('renders the formatted message', () => {
    const wrapper = shallowMount(MyComponent)
    expect(wrapper.find('p').text()).toBe('HELLO WORLD')
  })
})

模拟依赖以进行隔离测试

在单元测试中，将正在测试的组件与其依赖项隔离至关重要。这确保了测试专注于组件的逻辑，并且不会因外部依赖项的问题而失败。模拟是一种技术，用于用受控的替代品替换真实依赖项，使您能够模拟不同的场景，并验证组件在每个场景中的行为是否正确。

为什么要使用模拟依赖？

隔离性： 模拟确保测试仅关注组件的逻辑，防止外部因素影响测试结果。
可控性： 模拟允许你模拟不同场景和边缘情况，这些情况可能难以或不可能用真实依赖来重现。
速度： 模拟可以通过用快速、可预测的替代品替换慢速或不可靠的依赖来显著加快测试速度。
稳定性： 模拟通过消除对外部系统（这些系统可能不可用或意外变化）的依赖，使测试更加稳定。

嘲讽技巧

可以使用多种技术来在单元测试中模拟依赖项：

手动模拟： 手动创建模拟对象或函数。
Jest Mocks: 使用 Jest 的内置模拟功能。

手动模拟

手动模拟涉及创建模拟对象或函数来模仿真实依赖项的行为。这种技术适用于简单的依赖项或当你需要精细控制模拟行为时。

// MyComponent.vue
<template>
  <div>
    <p>{{ fetchData }}</p>
  </div>
</template>

<script>
import { fetchData } from '@/services/api'

export default {
  data() {
    return {
      fetchData: null
    }
  },
  async mounted() {
    this.fetchData = await fetchData()
  }
}
</script>

// api.js
export const fetchData = async () => {
  const response = await fetch('https://api.example.com/data')
  const data = await response.json()
  return data
}

// MyComponent.spec.js
import { shallowMount } from '@vue/test-utils'
import MyComponent from '@/components/MyComponent.vue'
import * as api from '@/services/api'

jest.mock('@/services/api', () => ({
  fetchData: jest.fn(() => Promise.resolve('Mocked data'))
}))

describe('MyComponent.vue', () => {
  it('renders the fetched data', async () => {
    const wrapper = shallowMount(MyComponent)
    await wrapper.vm.$nextTick() // Wait for the component to update after the data is fetched
    expect(wrapper.find('p').text()).toBe('Mocked data')
  })
})

Jest Mocks

Jest 提供了内置的模拟功能，使得模拟依赖变得容易。你可以使用 jest.mock 自动模拟一个模块，或使用 jest.fn 创建一个模拟函数。

// MyComponent.spec.js
import { shallowMount } from '@vue/test-utils'
import MyComponent from '@/components/MyComponent.vue'
import * as api from '@/services/api'

// Mock the fetchData function
api.fetchData = jest.fn(() => Promise.resolve('Mocked data'))

describe('MyComponent.vue', () => {
  it('renders the fetched data', async () => {
    const wrapper = shallowMount(MyComponent)
    await wrapper.vm.$nextTick() // Wait for the component to update after the data is fetched
    expect(wrapper.find('p').text()).toBe('Mocked data')
  })
})