TypeScript 単体テスト

TypeScript プロジェクトにおける単体テストの実践で、コード品質を保証します。

単体テストはコードの正確性を検証でき、TypeScript の型システムとテストフレームワークが完璧に組み合わさり、型安全なテストコードを書くことができます。


SVG 図解:単体テストのフロー 背景 タイトル TypeScript 単体テストのフロー ソースコード ソースコード src/utils/calculator.ts src/services/userService.ts 完全な型注釈 矢印 テストコード テストコード *.test.ts describe() / it() expect() アサーション 矢印 テスト結果 テスト結果 ✓ 成功 / ✗ 失敗 カバレッジレポート エラースタックトレース 下半分:テスト原則 単体テストの原則 原則1 各テストは1つのことだけを検証する 原則2 Arrange-Act-Assert 構造 原則3 テストは互いに独立しているべき 矢印マーカー

なぜ単体テストが必要か

単体テストはコード品質を保証する重要な手段であり、コードの正確性を検証し、バグの発生を防ぐことができます。

TypeScript プロジェクトでは、テストコードも型システムの恩恵を受けます:型エラーはコンパイル時に発見され、IDE がスマートなヒントを提供し、テストコードがより信頼性の高いものになります。

さらに、テストコードは最良のドキュメントでもあり、テストを通じて関数・クラスの期待される動作を理解することができます。

品質保証:単体テストは回帰問題を素早く発見し、コードの変更が既存機能を壊さないことを保証します。


テストフレームワークの設定

Jest は TypeScript プロジェクトで最も人気のあるテストフレームワークです。

Jest のインストール

# Jest と関連依存関係をインストール
# - ts-jest:Jest が TypeScript を実行できるようにする
# - @types/jest:Jest の型定義
npm install --save-dev jest ts-jest @types/jest

# Jest 設定を初期化
npx ts-jest config:init

ts-jest:これはプリプロセッサで、Jest が TypeScript ファイルを手動コンパイルなしで直接実行できるようにします。


jest.config.js の設定

Jest テスト環境を設定します。

jest.config.js

module.exports = {
    // ts-jest プリセットを使用
    preset: 'ts-jest',
    // テスト環境:node または browser
    testEnvironment: 'node',
    // テストファイルのディレクトリ
    roots: ['<rootDir>/src'],
    // テストファイルのマッチパターン
    testMatch: ['**/__tests__/**/*.ts'],
    // サポートするファイル拡張子
    moduleFileExtensions: ['ts', 'js', 'json'],
    // カバレッジを収集するファイル
    collectCoverageFrom: [
        'src/**/*.ts',
        '!src/**/*.d.ts'  // 型宣言ファイルを除外
    ]
}

設定の説明:テストファイルは通常 __tests__ ディレクトリに置くか、.test.ts で終わる名前にします。


関数のテスト

まずテストが必要なビジネスコードを書きます。

src/utils/calculator.ts

// 電卓クラス
export class Calculator {
    // 加算
    add(a: number, b: number): number {
        return a + b;
    }

    // 減算
    subtract(a: number, b: number): number {
        return a - b;
    }

    // 乗算
    multiply(a: number, b: number): number {
        return a * b;
    }

    // 除算
    divide(a: number, b: number): number {
        if (b === 0) {
            throw new Error("Cannot divide by zero");
        }
        return a / b;
    }
}

次に対応するテストコードを書きます。

src/utils/calculator.test.ts

import { Calculator } from "./calculator";

// テストスイート:Calculator クラスのテスト
describe("Calculator", () => {
    let calculator: Calculator;

    // 各テストの前に新しい Calculator インスタンスを作成
    beforeEach(() => {
        calculator = new Calculator();
    });

    // 加算テスト
    describe("add", () => {
        it("should add two numbers", () => {
            expect(calculator.add(2, 3)).toBe(5);
        });

        it("should handle negative numbers", () => {
            expect(calculator.add(-1, 1)).toBe(0);
        });
    });

    // 除算テスト
    describe("divide", () => {
        it("should divide two numbers", () => {
            expect(calculator.divide(10, 2)).toBe(5);
        });

        it("should throw error when dividing by zero", () => {
            // エラーがスローされることを期待
            expect(() => calculator.divide(10, 0)).toThrow();
        });
    });
});

実行結果:

Calculator
  add
    ✓ should add two numbers
    ✓ should handle negative numbers
  divide
    ✓ should divide two numbers
    ✓ should throw error when dividing by zero

describe/it:describe はテストをグループ化するために使い、it(または test)は個々のテストケースを定義するために使います。


Service のテスト

Service 層のビジネスロジックをテストします。

src/services/userService.ts

// ユーザー型
export interface User {
    id: number;
    name: string;
}

// ユーザーサービス・クラス
export class UserService {
    private users: User[] = [];
    private nextId = 1;

    // ユーザーを作成
    createUser(name: string): User {
        const user = { id: this.nextId++, name };
        this.users.push(user);
        return user;
    }

    // ユーザーを取得
    getUser(id: number): User | undefined {
        return this.users.find(u => u.id === id);
    }

    // すべてのユーザーを取得
    getAllUsers(): User[] {
        return [...this.users];
    }
}

src/services/userService.test.ts

import { UserService } from "./userService";

describe("UserService", () => {
    let service: UserService;

    beforeEach(() => {
        service = new UserService();
    });

    describe("createUser", () => {
        it("should create a user with id", () => {
            const user = service.createUser("Alice");
            expect(user.id).toBe(1);
            expect(user.name).toBe("Alice");
        });

        it("should increment id for each user", () => {
            const user1 = service.createUser("Alice");
            const user2 = service.createUser("Bob");
            expect(user2.id).toBe(user1.id + 1);
        });
    });

    describe("getUser", () => {
        it("should return user by id", () => {
            const created = service.createUser("Alice");
            const found = service.getUser(created.id);
            // オプショナルチェーンと toBe を使用
            expect(found?.name).toBe("Alice");
        });

        it("should return undefined for non-existent id", () => {
            const found = service.getUser(999);
            expect(found).toBeUndefined();
        });
    });
});

実行結果:

UserService
  createUser
    ✓ should create a user with id
    ✓ should increment id for each user
  getUser
    ✓ should return user by id
    ✓ should return undefined for non-existent id

テストの分離:各テストケースは独立しているべきで、beforeEach を使用して各テストがクリーンな状態を持つことを保証します。


Mock

Mock を使用して外部 API、データベースなどの依存関係をモックします。

実例

// Mock 関数:モック関数を作成
const mockCallback = jest.fn(x => x * 2);

// モック関数を使用
[1, 2, 3].forEach(mockCallback);

// 関数が3回呼び出されたことを検証
expect(mockCallback).toHaveBeenCalledTimes(3);
// 関数が呼び出されたときの引数を検証
expect(mockCallback).toHaveBeenCalledWith(2);

// Mock モジュール:モジュール全体をモック
jest.mock("./api", () => ({
    fetchUser: jest.fn(() => Promise.resolve({ id: 1, name: "Alice" }))
}));

実行結果:

✓ mock 函数被调用 3 次

Mock の用途:テストするコードが外部システムに依存している場合、Mock を使用して依存関係を分離し、対象コードのロジックのみをテストできます。


注意事項

  • テストファイルの場所:__tests__ ディレクトリに置くか、.test.ts サフィックスを使用
  • テストの命名:期待される動作を説明する説明的なテスト名を使用
  • 独立したテスト:各テストは独立して実行でき、他のテストに依存しない
  • カバレッジ:コアなビジネスロジックのテストカバレッジに注目

ベストプラクティス:テストは高速で、信頼性が高く、互いに独立しているべきです。AAA 原則に従います:Arrange(準備)、Act(実行)、Assert(検証)。


まとめ

単体テストは TypeScript のコード品質を保証する重要な手段です。

  • Jest:最も人気のある TypeScript テストフレームワーク
  • describe:関連するテストをグループ化するために使用
  • it/test:個々のテストケースを定義
  • expect:テスト結果を検証
  • Mock:外部依存関係をモック

提案:重要なビジネスロジックにテストを書き、コードの変更がバグを引き起こさないことを保証します。

その他の拡張