tdd-workflow (测试驱动开发工作流)

测试驱动开发 (TDD) 工作流

本技能确保所有代码开发遵循 TDD 原则，并具有全面的测试覆盖率。

何时激活

• 编写新特性或功能
• 修复 Bug 或问题
• 重构现有代码
• 添加 API 端点
• 创建新组件

核心原则

1. 先写测试，再写代码 (Tests BEFORE Code)

始终先编写测试，然后实现代码以使测试通过。

2. 覆盖率要求

• 最低 80% 覆盖率 (单元 + 集成 + E2E)
• 覆盖所有边缘情况
• 测试错误场景
• 验证边界条件

3. 测试类型

单元测试 (Unit Tests)

• 独立函数和工具
• 组件逻辑
• 纯函数
• 辅助函数和工具

集成测试 (Integration Tests)

• API 端点
• 数据库操作
• 服务交互
• 外部 API 调用

E2E 测试 (Playwright)

• 关键用户流程
• 完整工作流
• 浏览器自动化
• UI 交互

TDD 工作流步骤

步骤 1: 编写用户旅程 (User Journeys)

作为 [角色]，我想要 [行动]，以便 [收益]

示例：
作为用户，我想要进行语义化的市场搜索，
以便即使没有确切的关键词也能找到相关的市场。

步骤 2: 生成测试用例

为每个用户旅程创建全面的测试用例：

describe('Semantic Search', () => {
  it('returns relevant markets for query', async () => {
    // 测试实现
  })

  it('handles empty query gracefully', async () => {
    // 测试边缘情况
  })

  it('falls back to substring search when Redis unavailable', async () => {
    // 测试回退行为
  })

  it('sorts results by similarity score', async () => {
    // 测试排序逻辑
  })
})

步骤 3: 运行测试 (应失败)

npm test
# 测试应失败 - 我们尚未实现

步骤 4: 实现代码

编写最少量的代码以使测试通过：

// 由测试引导的实现
export async function searchMarkets(query: string) {
  // 在此实现
}

步骤 5: 再次运行测试

npm test
# 测试现在应通过

步骤 6: 重构

在保持测试通过的前提下提高代码质量：

• 消除重复
• 改进命名
• 优化性能
• 增强可读性

步骤 7: 验证覆盖率

npm run test:coverage
# 验证是否达到 80%+ 覆盖率

测试模式

单元测试模式 (Jest/Vitest)

import { render, screen, fireEvent } from '@testing-library/react'
import { Button } from './Button'

describe('Button Component', () => {
  it('renders with correct text', () => {
    render(<Button>Click me</Button>)
    expect(screen.getByText('Click me')).toBeInTheDocument()
  })

  it('calls onClick when clicked', () => {
    const handleClick = jest.fn()
    render(<Button onClick={handleClick}>Click</Button>)

    fireEvent.click(screen.getByRole('button'))

    expect(handleClick).toHaveBeenCalledTimes(1)
  })

  it('is disabled when disabled prop is true', () => {
    render(<Button disabled>Click</Button>)
    expect(screen.getByRole('button')).toBeDisabled()
  })
})