Vitest 单元测试方案

创作时间:

作者:

@小白创作中心

Vitest 单元测试方案

引用

CSDN

https://blog.csdn.net/hlsxjh/article/details/143647047

Vitest 单元测试方案

Vitest 是一个面向 Vite 的极快的单元测试框架。它利用了 Vite 的优势,提供了一种全新的测试体验。本文将介绍如何在项目中集成和使用 Vitest 进行单元测试。

安装 Vitest

npm install -D vitest

配置 Vitest

在项目根目录下创建 vitest.config.js 文件,用于配置 Vitest。

import path from 'path';

export default {
  test: {
    globals: true,
    environment: 'happy-dom',
    restoreMocks: true,
    include: ['**/*.{test,spec,type-test}.{js,mjs,cjs,ts,tsx,jsx}'],
    coverage: {
      exclude: ['tests/**', '.eslintrc.cjs'],
      reporter: ['cobertura', 'text', 'html', 'clover', 'json'],
    },
    setupFiles: `${path.resolve(__dirname, 'tests/setup.ts')}`,
    snapshotFormat: {
      printBasicPrototype: true,
    },
    alias: [],
  },
};

配置 Vitest公共文件

在项目根目录下创建 setup-test.ts 文件，用于统一处理定时器，原生事件，以及在vitest环境下无法模拟的事件

import { vi, describe, it, expect } from 'vitest';
import '@testing-library/jest-dom/vitest';
import MockAdapter from 'axios-mock-adapter';
import axios from 'axios';
import { configure } from '.';

export const mock = new MockAdapter(axios);

configure({
  renderMode: 'global',
  enableMultipleSelection: false,
});

beforeEach(() => {
  mock.reset();
  console.error = vi.fn();
  console.warn = vi.fn();
  vi.useFakeTimers();
  window.requestIdleCallback = vi.fn();
  document.execCommand = vi.fn();
  window.onresize = vi.fn();
  vi.setSystemTime(new Date(1680278400000));
});

afterEach(() => {
  mock.reset();
  vi.useRealTimers();
});

window.vi = vi;
window.describe = describe;
window.it = it;
window.expect = expect;

单元测试分类

单元测试：主要是对项目里的最小组件或模块进行测试，一般是在非浏览器环境下的测试
集成测试：一般是对单元测试下的多个最小单元组成的较大组件或模块进行小型的组合测试，一般是在非浏览器环境下的测试。
端到端测试 (E2E) : 从用户的视角出发，基于整个页面或者应用，模拟用户操作测试，一般是在浏览器环境下的测试

如何编写单元测试

在项目 src 目录平级的位置，新建 tests 文件夹，tests 文件夹下新建 mocks 文件夹

mocks 下主要存放对应单元测试模拟数据的文件
tests 下主要存放对应的单元测试文件

如何模拟接口请求

在项目中引入 axios-mock-adapter 第三方工具库，在进行测试的 test 文件下新建 Mock 文件夹，然后新建 test-demo-mock.ts 文件。

import { mock } from '../../../src/setup-test';

export const TestDemoMock = {
  getUsersTitle: (status: number) => {
    mock.onGet('/users/title').reply(status, { title: '江雾' });
  },
};

编写测试用例

新建一个 test-demo.tsx 文件，编写React组件

import axios from 'axios';
import { useEffect, useState } from 'react';

const TextDemo: React.FC = () => {
  const [title, setTitle] = useState('测试');

  const getTitleValue = async () => {
    const response = await axios.get('/users/title');
    const { status, data } = response;
    if (status === 200) {
      setTitle(data.title);
    } else {
      // error
      setTitle('接口异常');
    }
  };

  const changeBtn = () => {
    setTitle('江雾');
  };

  return (
    <div className="test-dome-content">
      <span className="title">{title}</span>
      <button className="refresh-button" onClick={getTitleValue}>
        refresh
      </button>
      <button onClick={changeBtn} className="change-btn">
        change
      </button>
    </div>
  );
};

export default TextDemo;

新建 test-demo.test.ts 单元测试文件

import { fireEvent, render } from '@testing-library/react';
import TextDemo from '../../src/test-demo';
import { TestDemoMock } from './Mock/test-demo-mock';

describe('getUser', () => {
  it('mount title', async () => {
    const { container } = render(<TextDemo />);
    // 初始化期望 页面标题为测试
    const title = document.body.querySelector('.test-dome-content .title');
    expect(title?.innerHTML).toBe('测试');
  });

  it('change title', async () => {
    await TestDemoMock.getUsersTitle(200);
    render(<TextDemo />);
    // 初始化期望 页面标题为测试
    const title = document.body.querySelector('.test-dome-content .title');
    expect(title?.innerHTML).toBe('测试');
    // 点击按钮
    const btn = document.body.querySelector(
      '.test-dome-content .refresh-button'
    );
    fireEvent.click(btn!);
    await vi.waitFor(() => {
      const targetTitle = document.body.querySelector(
        '.test-dome-content .title'
      );
      expect(targetTitle?.innerHTML).toBe('江雾');
    });
  });

  it('change title error', async () => {
    // 模拟接口请求
    await TestDemoMock.getUsersTitle(201);
    render(<TextDemo />);
    // 初始化期望 页面标题为测试
    const title = document.body.querySelector('.test-dome-content .title');
    expect(title?.innerHTML).toBe('测试');
    // 点击按钮
    const btn = document.body.querySelector(
      '.test-dome-content .refresh-button'
    );
    fireEvent.click(btn!);
    // 期望接口失败内容为接口异常
    await vi.waitFor(() => {
      const title = document.body.querySelector('.test-dome-content .title');
      expect(title?.innerHTML).toBe('接口异常');
    });
  });
});