AgentSkillsCN

tdd-workflow

在新功能开发、Bug修复,或代码重构时,可优先使用此技能。通过单元测试、集成测试与端到端测试,实现80%以上的测试覆盖率,切实践行测试驱动开发(TDD)。

SKILL.md
--- frontmatter
name: tdd-workflow
description: 新機能の開発、バグ修正、コードのリファクタリング時に使用するスキル。ユニット、統合、E2Eテストを含む80%以上のカバレッジでテスト駆動開発を実践する。

テスト駆動開発ワークフロー

すべてのコード開発が包括的なテストカバレッジを伴うTDD原則に従うことを保証するスキル。

発動タイミング

  • 新機能や機能の開発
  • バグや問題の修正
  • 既存コードのリファクタリング
  • APIエンドポイントの追加
  • 新しいコンポーネントの作成

基本原則

1. コードの前にテスト

常にテストを先に書き、テストが通るようにコードを実装する。

2. カバレッジ要件

  • 最低80%カバレッジ(ユニット + 統合 + E2E)
  • すべてのエッジケースをカバー
  • エラーシナリオをテスト
  • 境界条件を検証

3. テストの種類

ユニットテスト

  • 個別の関数とユーティリティ
  • コンポーネントロジック
  • 純粋関数
  • ヘルパーとユーティリティ

統合テスト

  • APIエンドポイント
  • データベース操作
  • サービス間のインタラクション
  • 外部API呼び出し

E2Eテスト(Playwright)

  • クリティカルなユーザーフロー
  • 完全なワークフロー
  • ブラウザオートメーション
  • UIインタラクション

TDDワークフロー手順

ステップ1: ユーザージャーニーを書く

code
As a [role], I want to [action], so that [benefit]

例:
As a user, I want to search for markets semantically,
so that I can find relevant markets even without exact keywords.

ステップ2: テストケースを生成

各ユーザージャーニーについて包括的なテストケースを作成:

typescript
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: テストを実行(失敗するはず)

bash
npm test
# Tests should fail - we haven't implemented yet

ステップ4: コードを実装

テストが通る最小限のコードを書く:

typescript
// Implementation guided by tests
export async function searchMarkets(query: string) {
  // Implementation here
}

ステップ5: テストを再実行

bash
npm test
# Tests should now pass

ステップ6: リファクタリング

テストをグリーンに保ちながらコード品質を改善:

  • 重複を除去
  • 命名を改善
  • パフォーマンスを最適化
  • 可読性を向上

ステップ7: カバレッジを確認

bash
npm run test:coverage
# Verify 80%+ coverage achieved

テストパターン

ユニットテストパターン(Jest/Vitest)

typescript
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統合テストパターン

typescript
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)

typescript
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/)
})

テストファイルの構成

code
src/
├── components/
│   ├── Button/
│   │   ├── Button.tsx
│   │   ├── Button.test.tsx          # ユニットテスト
│   │   └── Button.stories.tsx       # Storybook
│   └── MarketCard/
│       ├── MarketCard.tsx
│       └── MarketCard.test.tsx
├── app/
│   └── api/
│       └── markets/
│           ├── route.ts
│           └── route.test.ts         # 統合テスト
└── e2e/
    ├── markets.spec.ts               # E2Eテスト
    ├── trading.spec.ts
    └── auth.spec.ts

外部サービスのモック

Supabaseモック

typescript
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モック

typescript
jest.mock('@/lib/redis', () => ({
  searchMarketsByVector: jest.fn(() => Promise.resolve([
    { slug: 'test-market', similarity_score: 0.95 }
  ])),
  checkRedisHealth: jest.fn(() => Promise.resolve({ connected: true }))
}))

OpenAIモック

typescript
jest.mock('@/lib/openai', () => ({
  generateEmbedding: jest.fn(() => Promise.resolve(
    new Array(1536).fill(0.1) // Mock 1536-dim embedding
  ))
}))

テストカバレッジの検証

カバレッジレポートの実行

bash
npm run test:coverage

カバレッジしきい値

json
{
  "jest": {
    "coverageThresholds": {
      "global": {
        "branches": 80,
        "functions": 80,
        "lines": 80,
        "statements": 80
      }
    }
  }
}

避けるべき一般的なテストの間違い

間違い: 実装の詳細をテスト

typescript
// Don't test internal state
expect(component.state.count).toBe(5)

正しい: ユーザーに見える振る舞いをテスト

typescript
// Test what users see
expect(screen.getByText('Count: 5')).toBeInTheDocument()

間違い: 壊れやすいセレクタ

typescript
// Breaks easily
await page.click('.css-class-xyz')

正しい: セマンティックセレクタ

typescript
// Resilient to changes
await page.click('button:has-text("Submit")')
await page.click('[data-testid="submit-button"]')

間違い: テストの分離がない

typescript
// Tests depend on each other
test('creates user', () => { /* ... */ })
test('updates same user', () => { /* depends on previous test */ })

正しい: 独立したテスト

typescript
// Each test sets up its own data
test('creates user', () => {
  const user = createTestUser()
  // Test logic
})

test('updates user', () => {
  const user = createTestUser()
  // Update logic
})

継続的テスト

開発中のウォッチモード

bash
npm test -- --watch
# Tests run automatically on file changes

プリコミットフック

bash
# Runs before every commit
npm test && npm run lint

CI/CD統合

yaml
# GitHub Actions
- name: Run Tests
  run: npm test -- --coverage
- name: Upload Coverage
  uses: codecov/codecov-action@v3

ベストプラクティス

  1. テストを先に書く - 常にTDD
  2. テストごとに1つのアサーション - 単一の振る舞いに集中
  3. 説明的なテスト名 - テスト内容を明確に
  4. Arrange-Act-Assert - 明確なテスト構造
  5. 外部依存をモック - ユニットテストを分離
  6. エッジケースをテスト - null、undefined、空、大きな値
  7. エラーパスをテスト - ハッピーパスだけでなく
  8. テストを高速に保つ - ユニットテストは各50ms未満
  9. テスト後にクリーンアップ - 副作用を残さない
  10. カバレッジレポートをレビュー - ギャップを特定

成功メトリクス

  • 80%以上のコードカバレッジ達成
  • すべてのテストが通過(グリーン)
  • スキップまたは無効化されたテストがない
  • 高速なテスト実行(ユニットテストは30秒未満)
  • E2Eテストがクリティカルなユーザーフローをカバー
  • テストが本番前にバグをキャッチ

重要: テストはオプションではありません。安心なリファクタリング、迅速な開発、本番の信頼性を実現するセーフティネットです。