tdd-workflow

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

このスキルにより、すべてのコード開発で包括的なテストカバレッジを確保し、TDD の原則に従うことができます。

有効化するタイミング

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

基本原則

1. コードを書く前にテストを書く

必ず最初にテストを書き、その後、テストに合格するコードを実装します。

2. カバレッジ要件

• カバレッジは最低 80%（ユニット＋インテグレーション＋E2E）
• すべてのエッジケースを網羅
• エラーシナリオをテスト
• 境界条件を検証

3. テストの種類

ユニットテスト

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

インテグレーションテスト

• 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

外部サービスのモック

Supabase のモック

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

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

OpenAI のモック

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

コミット前フック

# 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

ベストプラクティス

1. テストを先に書く - 常に TDD を実践する
2. テストごとにアサーションを 1 つにする - 1 つの動作に集中する
3. 説明的なテスト名を付ける - テスト対象を明確にする
4. Arrange-Act-Assert - テストの構成を明確にする
5. 外部依存関係をモックする - ユニットテストを分離する
6. エッジケースをテストする - null、undefined、空、大きな値
7. エラー経路をテストする - 正常系だけでなくエラー系もテストする
8. テストを高速に保つ - ユニットテストは 1 件あたり 50ms 未満
9. テスト後に後片付けをする - 副作用を残さない
10. カバレッジレポートを確認する - 不足箇所を特定する

成功指標

• コードカバレッジ 80% 以上を達成
• すべてのテストに合格（グリーン）
• スキップまたは無効化されたテストがない
• テストを高速に実行（ユニットテストは 30s 未満）
• E2E テストで重要なユーザーフローを網羅
• 本番環境に入る前にテストでバグを検出

---

覚えておいてください：テストは任意ではありません。安心してリファクタリングを行い、迅速に開発し、本番環境の信頼性を確保するためのセーフティネットです。