Learn-skills.dev tdd-workflow
在编写新功能、修复 bug 或重构代码时使用此技能。强制执行具有 80%+ 覆盖率(包括单元测试、集成测试和 E2E 测试)的测试驱动开发。
install
source · Clone the upstream repo
git clone https://github.com/NeverSight/learn-skills.dev
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/NeverSight/learn-skills.dev "$T" && mkdir -p ~/.claude/skills && cp -r "$T/data/skills-md/aaione/everything-claude-code-zh/tdd-workflow" ~/.claude/skills/neversight-learn-skills-dev-tdd-workflow && rm -rf "$T"
manifest:
data/skills-md/aaione/everything-claude-code-zh/tdd-workflow/SKILL.mdsource content
测试驱动开发工作流 (Test-Driven Development Workflow)
此技能确保所有代码开发遵循 TDD 原则,并具有全面的测试覆盖率。
何时激活
- 编写新特性或功能
- 修复 bug 或问题
- 重构现有代码
- 添加 API 端点
- 创建新组件
核心原则
1. 代码之前先写测试 (Tests BEFORE Code)
总是先写测试,然后实施代码以通过测试。
2. 覆盖率要求
- 最低 80% 覆盖率 (unit + integration + E2E)
- 覆盖所有边缘情况
- 测试错误场景
- 验证边界条件
3. 测试类型
单元测试 (Unit Tests)
- 单个函数和工具
- 组件逻辑
- 纯函数
- 助手和实用程序
集成测试 (Integration Tests)
- API 端点
- 数据库操作
- 服务交互
- 外部 API 调用
E2E 测试 (Playwright)
- 关键用户流程
- 完整工作流
- 浏览器自动化
- UI 交互
TDD 工作流步骤
步骤 1: 编写用户旅程
As a [role], I want to [action], so that [benefit] Example: As a user, I want to search for markets semantically, so that I can find relevant markets even without exact keywords.
步骤 2: 生成测试用例
为每个用户旅程创建全面的测试用例:
describe('Semantic Search', () => { it('returns relevant markets for query', async () => { // Test implementation }) it('handles empty query gracefully', async () => { // Test edge case }) it('falls back to substring search when Redis unavailable', async () => { // Test fallback behavior }) it('sorts results by similarity score', async () => { // Test sorting logic }) })
步骤 3: 运行测试 (应该失败)
npm test # Tests should fail - we haven't implemented yet
步骤 4: 实施代码
编写最少代码以通过测试:
// Implementation guided by tests export async function searchMarkets(query: string) { // Implementation here }
步骤 5: 再次运行测试
npm test # Tests should now pass
步骤 6: 重构
在保持测试绿色的同时提高代码质量:
- 移除重复
- 改进命名
- 优化性能
- 增强可读性
步骤 7: 验证覆盖率
npm run test:coverage # Verify 80%+ coverage achieved
测试模式
单元测试模式 (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() }) })
API 集成测试模式
import { NextRequest } from 'next/server' import { GET } from './route' describe('GET /api/markets', () => { it('returns markets successfully', async () => { const request = new NextRequest('http://localhost/api/markets') const response = await GET(request) const data = await response.json() expect(response.status).toBe(200) expect(data.success).toBe(true) expect(Array.isArray(data.data)).toBe(true) }) it('validates query parameters', async () => { const request = new NextRequest('http://localhost/api/markets?limit=invalid') const response = await GET(request) expect(response.status).toBe(400) }) it('handles database errors gracefully', async () => { // Mock database failure const request = new NextRequest('http://localhost/api/markets') // Test error handling }) })
E2E 测试模式 (Playwright)
import { test, expect } from '@playwright/test' test('user can search and filter markets', async ({ page }) => { // Navigate to markets page await page.goto('/') await page.click('a[href="/markets"]') // Verify page loaded await expect(page.locator('h1')).toContainText('Markets') // Search for markets await page.fill('input[placeholder="Search markets"]', 'election') // Wait for debounce and results await page.waitForTimeout(600) // Verify search results displayed const results = page.locator('[data-testid="market-card"]') await expect(results).toHaveCount(5, { timeout: 5000 }) // Verify results contain search term const firstResult = results.first() await expect(firstResult).toContainText('election', { ignoreCase: true }) // Filter by status await page.click('button:has-text("Active")') // Verify filtered results await expect(results).toHaveCount(3) }) test('user can create a new market', async ({ page }) => { // Login first await page.goto('/creator-dashboard') // Fill market creation form await page.fill('input[name="name"]', 'Test Market') await page.fill('textarea[name="description"]', 'Test description') await page.fill('input[name="endDate"]', '2025-12-31') // Submit form await page.click('button[type="submit"]') // Verify success message await expect(page.locator('text=Market created successfully')).toBeVisible() // Verify redirect to market page await expect(page).toHaveURL(/\/markets\/test-market/) })
测试文件组织
src/ ├── components/ │ ├── Button/ │ │ ├── Button.tsx │ │ ├── Button.test.tsx # Unit tests │ │ └── Button.stories.tsx # Storybook │ └── MarketCard/ │ ├── MarketCard.tsx │ └── MarketCard.test.tsx ├── app/ │ └── api/ │ └── markets/ │ ├── route.ts │ └── route.test.ts # Integration tests └── e2e/ ├── markets.spec.ts # E2E tests ├── trading.spec.ts └── auth.spec.ts
Mocking 外部服务
Supabase Mock
jest.mock('@/lib/supabase', () => ({ supabase: { from: jest.fn(() => ({ select: jest.fn(() => ({ eq: jest.fn(() => Promise.resolve({ data: [{ id: 1, name: 'Test Market' }], error: null })) })) })) } }))
Redis Mock
jest.mock('@/lib/redis', () => ({ searchMarketsByVector: jest.fn(() => Promise.resolve([ { slug: 'test-market', similarity_score: 0.95 } ])), checkRedisHealth: jest.fn(() => Promise.resolve({ connected: true })) }))
OpenAI Mock
jest.mock('@/lib/openai', () => ({ generateEmbedding: jest.fn(() => Promise.resolve( new Array(1536).fill(0.1) // Mock 1536-dim embedding )) }))
测试覆盖率验证
运行覆盖率报告
npm run test:coverage
覆盖率阈值
{ "jest": { "coverageThresholds": { "global": { "branches": 80, "functions": 80, "lines": 80, "statements": 80 } } } }
常见测试错误
❌ 错误: 测试实施细节
// Don't test internal state expect(component.state.count).toBe(5)
✅ 正确: 测试用户可见行为
// Test what users see expect(screen.getByText('Count: 5')).toBeInTheDocument()
❌ 错误: 脆弱的选择器
// Breaks easily await page.click('.css-class-xyz')
✅ 正确: 语义选择器
// Resilient to changes await page.click('button:has-text("Submit")') await page.click('[data-testid="submit-button"]')
❌ 错误: 无测试隔离
// Tests depend on each other test('creates user', () => { /* ... */ }) test('updates same user', () => { /* depends on previous test */ })
✅ 正确: 独立测试
// Each test sets up its own data test('creates user', () => { const user = createTestUser() // Test logic }) test('updates user', () => { const user = createTestUser() // Update logic })
持续测试
开发期间的观察模式
npm test -- --watch # Tests run automatically on file changes
Pre-Commit Hook
# Runs before every commit npm test && npm run lint
CI/CD 集成
# GitHub Actions - name: Run Tests run: npm test -- --coverage - name: Upload Coverage uses: codecov/codecov-action@v3
最佳实践
- 先写测试 - 始终 TDD
- 每个测试一个断言 - 关注单一行为
- 描述性测试名称 - 解释测试内容
- 安排-行动-断言 - 清晰的测试结构
- Mock 外部依赖 - 隔离单元测试
- 测试边缘用例 - Null, undefined, empty, large
- 测试错误路径 - 不仅仅是 happy paths
- 保持测试快速 - 单元测试 < 50ms 每个
- 测试后清理 - 无副作用
- 审查覆盖率报告 - 识别差距
成功指标
- 达到 80%+ 代码覆盖率
- 所有测试通过 (green)
- 没有跳过或禁用的测试
- 快速测试执行 (单元测试 < 30s)
- E2E 测试覆盖关键用户流程
- 测试在生产前捕获 bug
记住:测试不是可选的。它们是安全网,使重构更自信、开发更快速、生产更可靠。