ユニットテストフレームワーク

目次

• 概要
• 使用する場面
• クイックスタート
• リファレンスガイド
• ベストプラクティス

概要

業界のベストプラクティスと AAA (Arrange-Act-Assert) パターンに従って、高速で分離された読みやすく保守しやすいユニットテストを記述します。

使用する場面

• 新しいコードのテストを記述する場合
• テストカバレッジを改善する場合
• テスト標準を確立する場合
• テストの安全性を確保してリファクタリングする場合
• TDD (テスト駆動開発) を実装する場合
• テストユーティリティとモックを作成する場合

クイックスタート

最小限の実行例:

// Jest/JavaScript の例
describe("UserService", () => {
  describe("createUser", () => {
    it("should create user with valid data", async () => {
      // Arrange - テストデータと依存関係をセットアップ
      const userData = {
        email: "john@example.com",
        firstName: "John",
        lastName: "Doe",
      };
      const mockDatabase = createMockDatabase();
      const service = new UserService(mockDatabase);

      // Act - テスト対象の関数を実行
      const result = await service.createUser(userData);

      // Assert - 結果を検証
      expect(result.id).toBeDefined();
      expect(result.email).toBe("john@example.com");
      expect(mockDatabase.save).toHaveBeenCalledWith(
        expect.objectContaining(userData),
      );
    });
  });
});

リファレンスガイド

references/ ディレクトリ内の詳細な実装:

ガイド	内容
テスト構造 (AAA パターン)	テスト構造 (AAA パターン)
言語別テストケース	言語別テストケース
モッキング & テストダブル	モッキング & テストダブル
非同期コードのテスト	非同期コードのテスト、テストカバレッジ
エッジケースのテスト	エッジケースのテスト
例: 完全なテストスイート	import { UserService } from "./user-service";

ベストプラクティス

✅ すべきこと

• コードの前またはコードと並行してテストを記述する (TDD)
• テストごとに 1 つのことをテストする
• わかりやすいテスト名を使用する
• AAA パターンに従う
• エッジケースとエラー条件をテストする
• テストを分離して独立させておく
• セットアップ/テアダウンを適切に使用する
• 外部依存関係をモックする
• 重要なパスでは高いカバレッジを目指す
• テストを高速にする (それぞれ 10ms 未満)
• 類似したケースにはパラメータ化されたテストを使用する
• 実装詳細ではなくパブリックインターフェースをテストする

❌ すべきではないこと

• 実装詳細をテストする
• 互いに依存するテストを記述する
• 失敗したテストを無視する
• サードパーティライブラリコードをテストする
• ユニットテストで実際のデータベース/API を使用する
• テストを複雑にしすぎる
• エッジケースをスキップする
• リソースのクリーンアップを忘れる
• すべてをテストする (ビジネスロジックに焦点を当てる)
• 不安定なテストを記述する