跳转到主要内容

测试指南

如何测试使用 Dropup 的组件。

设置​

安装测试依赖：

npm install -D vitest @testing-library/react @testing-library/user-event jsdom

配置 Vitest：

// vitest.config.ts
import { defineConfig } from 'vitest/config';
import react from '@vitejs/plugin-react';

export default defineConfig({
  plugins: [react()],
  test: {
    environment: 'jsdom',
    setupFiles: './src/test/setup.ts',
  },
});
// src/test/setup.ts
import '@testing-library/jest-dom';

基本组件测试​

// components/Uploader.tsx
import { useDropup } from '@samithahansaka/dropup';

export function Uploader() {
  const { files, getDropProps, getInputProps } = useDropup({
    accept: 'image/*',
  });

  return (
    <div {...getDropProps()} data-testid="dropzone">
      <input {...getInputProps()} data-testid="file-input" />
      <p>拖放图片到此处</p>

      <ul data-testid="file-list">
        {files.map(file => (
          <li key={file.id} data-testid="file-item">
            {file.name}
          </li>
        ))}
      </ul>
    </div>
  );
}
// components/Uploader.test.tsx
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { describe, it, expect } from 'vitest';
import { Uploader } from './Uploader';

describe('Uploader', () => {
  it('渲染拖放区域', () => {
    render(<Uploader />);
    expect(screen.getByTestId('dropzone')).toBeInTheDocument();
    expect(screen.getByText('拖放图片到此处')).toBeInTheDocument();
  });

  it('接受文件输入', async () => {
    const user = userEvent.setup();
    render(<Uploader />);

    const input = screen.getByTestId('file-input');
    const file = new File(['test'], 'test.png', { type: 'image/png' });

    await user.upload(input, file);

    expect(screen.getByTestId('file-item')).toHaveTextContent('test.png');
  });

  it('接受多个文件', async () => {
    const user = userEvent.setup();
    render(<Uploader />);

    const input = screen.getByTestId('file-input');
    const files = [
      new File(['test1'], 'photo1.png', { type: 'image/png' }),
      new File(['test2'], 'photo2.png', { type: 'image/png' }),
    ];

    await user.upload(input, files);

    const items = screen.getAllByTestId('file-item');
    expect(items).toHaveLength(2);
  });
});

测试拖放​

import { render, screen, fireEvent } from '@testing-library/react';
import { describe, it, expect } from 'vitest';
import { Uploader } from './Uploader';

describe('拖放', () => {
  it('拖动时显示拖动状态', () => {
    render(<Uploader />);

    const dropzone = screen.getByTestId('dropzone');

    fireEvent.dragEnter(dropzone, {
      dataTransfer: {
        types: ['Files'],
        items: [{ kind: 'file' }],
      },
    });

    expect(dropzone).toHaveAttribute('data-dragging', 'true');
  });

  it('处理文件拖放', () => {
    render(<Uploader />);

    const dropzone = screen.getByTestId('dropzone');
    const file = new File(['test'], 'dropped.png', { type: 'image/png' });

    fireEvent.drop(dropzone, {
      dataTransfer: {
        files: [file],
        types: ['Files'],
      },
    });

    expect(screen.getByText('dropped.png')).toBeInTheDocument();
  });
});

测试验证​

// components/ValidatedUploader.tsx
import { useDropup } from '@samithahansaka/dropup';
import { useState } from 'react';

export function ValidatedUploader() {
  const [errors, setErrors] = useState<string[]>([]);

  const { files, getDropProps, getInputProps } = useDropup({
    accept: 'image/*',
    maxSize: 1024 * 1024, // 1MB

    onValidationError: (validationErrors) => {
      const messages = validationErrors.flatMap(e => e.errors);
      setErrors(messages);
    },
  });

  return (
    <div {...getDropProps()} data-testid="dropzone">
      <input {...getInputProps()} data-testid="file-input" />

      {errors.length > 0 && (
        <ul data-testid="error-list">
          {errors.map((error, i) => (
            <li key={i} data-testid="error-item">{error}</li>
          ))}
        </ul>
      )}
    </div>
  );
}
// components/ValidatedUploader.test.tsx
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { describe, it, expect } from 'vitest';
import { ValidatedUploader } from './ValidatedUploader';

describe('验证', () => {
  it('拒绝错误的文件类型', async () => {
    const user = userEvent.setup();
    render(<ValidatedUploader />);

    const input = screen.getByTestId('file-input');
    const file = new File(['test'], 'document.pdf', { type: 'application/pdf' });

    await user.upload(input, file);

    expect(screen.getByTestId('error-list')).toBeInTheDocument();
  });

  it('拒绝超过大小限制的文件', async () => {
    const user = userEvent.setup();
    render(<ValidatedUploader />);

    const input = screen.getByTestId('file-input');
    // 创建一个 2MB 的文件（超过 1MB 限制）
    const content = new Array(2 * 1024 * 1024).fill('a').join('');
    const file = new File([content], 'large.png', { type: 'image/png' });

    await user.upload(input, file);

    expect(screen.getByTestId('error-list')).toBeInTheDocument();
  });
});

测试上传​

// components/UploadingComponent.tsx
import { useDropup } from '@samithahansaka/dropup';

export function UploadingComponent() {
  const { files, actions, state, getDropProps, getInputProps } = useDropup({
    upload: { url: '/api/upload' },
  });

  return (
    <div {...getDropProps()} data-testid="dropzone">
      <input {...getInputProps()} data-testid="file-input" />

      {files.map(file => (
        <div key={file.id} data-testid="file-status">
          {file.status === 'uploading' && `上传中: ${file.progress}%`}
          {file.status === 'complete' && '完成！'}
          {file.status === 'error' && `错误: ${file.error?.message}`}
        </div>
      ))}

      <button
        onClick={() => actions.upload()}
        disabled={state.isUploading}
        data-testid="upload-btn"
      >
        上传
      </button>
    </div>
  );
}
// components/UploadingComponent.test.tsx
import { render, screen, waitFor } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { UploadingComponent } from './UploadingComponent';

// 模拟 fetch
const mockFetch = vi.fn();
global.fetch = mockFetch;

describe('上传', () => {
  beforeEach(() => {
    mockFetch.mockReset();
  });

  it('成功上传文件', async () => {
    mockFetch.mockResolvedValue({
      ok: true,
      json: () => Promise.resolve({ url: 'https://example.com/file.png' }),
    });

    const user = userEvent.setup();
    render(<UploadingComponent />);

    // 添加文件
    const input = screen.getByTestId('file-input');
    const file = new File(['test'], 'test.png', { type: 'image/png' });
    await user.upload(input, file);

    // 点击上传
    await user.click(screen.getByTestId('upload-btn'));

    // 等待完成
    await waitFor(() => {
      expect(screen.getByTestId('file-status')).toHaveTextContent('完成！');
    });

    expect(mockFetch).toHaveBeenCalledWith('/api/upload', expect.anything());
  });

  it('处理上传错误', async () => {
    mockFetch.mockRejectedValue(new Error('网络错误'));

    const user = userEvent.setup();
    render(<UploadingComponent />);

    const input = screen.getByTestId('file-input');
    await user.upload(input, new File(['test'], 'test.png', { type: 'image/png' }));

    await user.click(screen.getByTestId('upload-btn'));

    await waitFor(() => {
      expect(screen.getByTestId('file-status')).toHaveTextContent('错误');
    });
  });
});

模拟 useDropup​

对于隔离的单元测试：

// __mocks__/@samithahansaka/dropup.ts
import { vi } from 'vitest';

export const useDropup = vi.fn(() => ({
  files: [],
  state: {
    isDragging: false,
    isDragAccept: false,
    isDragReject: false,
    isUploading: false,
    progress: 0,
    status: 'idle',
  },
  actions: {
    upload: vi.fn(),
    cancel: vi.fn(),
    remove: vi.fn(),
    reset: vi.fn(),
    retry: vi.fn(),
    addFiles: vi.fn(),
    updateFileMeta: vi.fn(),
  },
  getDropProps: vi.fn(() => ({})),
  getInputProps: vi.fn(() => ({ type: 'file' })),
  openFileDialog: vi.fn(),
}));
// 在测试中使用
import { vi } from 'vitest';
import { useDropup } from '@samithahansaka/dropup';

vi.mock('@samithahansaka/dropup');

const mockUseDropup = vi.mocked(useDropup);

describe('使用模拟的 hook', () => {
  it('渲染带文件的组件', () => {
    mockUseDropup.mockReturnValue({
      files: [
        { id: '1', name: 'test.png', status: 'idle', progress: 0, size: 1000, type: 'image/png' },
      ],
      // ... 其他值
    });

    render(<Uploader />);
    expect(screen.getByText('test.png')).toBeInTheDocument();
  });
});

使用 MSW 测试​

使用 Mock Service Worker 进行真实的 API 测试：

// src/test/handlers.ts
import { http, HttpResponse } from 'msw';

export const handlers = [
  http.post('/api/upload', async ({ request }) => {
    const formData = await request.formData();
    const file = formData.get('file') as File;

    return HttpResponse.json({
      url: `https://example.com/uploads/${file.name}`,
    });
  }),

  http.post('/api/upload-error', () => {
    return HttpResponse.json(
      { error: '上传失败' },
      { status: 500 }
    );
  }),
];
// src/test/setup.ts
import { setupServer } from 'msw/node';
import { handlers } from './handlers';

export const server = setupServer(...handlers);

beforeAll(() => server.listen());
afterEach(() => server.resetHandlers());
afterAll(() => server.close());

使用 Playwright 进行 E2E 测试​

// e2e/upload.spec.ts
import { test, expect } from '@playwright/test';

test.describe('文件上传', () => {
  test('上传文件', async ({ page }) => {
    await page.goto('/upload');

    // 获取文件输入框
    const fileInput = page.locator('input[type="file"]');

    // 上传文件
    await fileInput.setInputFiles({
      name: 'test.png',
      mimeType: 'image/png',
      buffer: Buffer.from('fake image content'),
    });

    // 验证文件出现在列表中
    await expect(page.locator('text=test.png')).toBeVisible();

    // 点击上传按钮
    await page.click('button:has-text("上传")');

    // 等待成功
    await expect(page.locator('text=完成')).toBeVisible();
  });

  test('拖放上传', async ({ page }) => {
    await page.goto('/upload');

    const dropzone = page.locator('[data-testid="dropzone"]');

    // 创建文件数据
    const buffer = Buffer.from('test content');

    // 模拟拖放
    const dataTransfer = await page.evaluateHandle(() => new DataTransfer());

    await page.dispatchEvent('[data-testid="dropzone"]', 'drop', {
      dataTransfer,
    });

    // 验证文件已添加
    await expect(page.locator('[data-testid="file-item"]')).toBeVisible();
  });
});

最佳实践​

  1. 测试行为，而非实现 - 关注用户看到和做的事情
  2. 使用 data-testid 确保可靠性 - 避免通过 CSS 类测试
  3. 模拟网络请求 - 使用 MSW 或 vi.mock 处理 API 调用
  4. 测试边界情况 - 空状态、错误、大文件
  5. 测试可访问性 - 键盘导航、屏幕阅读器
编辑此页
最后更新 于 由 Samitha Widanage