Jestによるテストの基礎

# pnpm
pnpm add -D jest @types/jest ts-jest

# npm
npm install -D jest @types/jest ts-jest

{
  "scripts": {
    "test": "jest"
  },
  "jest": {
    "preset": "ts-jest"
  }
}

// src/math.spec.ts

describe("add", () => {
  it("1 + 2 は 3 になる", () => {
    expect(1 + 2).toBe(3);
  });

  it("負の数でも動く", () => {
    expect(-1 + -2).toBe(-3);
  });
});

pnpm test

PASS  src/math.spec.ts
  add
    ✓ 1 + 2 は 3 になる (2 ms)
    ✓ 負の数でも動く (1 ms)

// src/matchers.spec.ts

describe("マッチャー早見", () => {
  it("プリミティブ値の比較", () => {
    expect(1 + 1).toBe(2);          // ===（完全一致）
    expect(null).toBeNull();
    expect(undefined).toBeUndefined();
    expect(true).toBeTruthy();
    expect(0).toBeFalsy();
  });

  it("オブジェクトや配列の比較", () => {
    expect({ a: 1 }).toEqual({ a: 1 });  // 深い比較（toBe は参照比較なので NG）
    expect([1, 2, 3]).toContain(2);
  });

  it("文字列の部分一致", () => {
    expect("hello world").toContain("world");
    expect("hello world").toMatch(/world/);
  });

  it("数値の範囲", () => {
    expect(3.14).toBeCloseTo(3.1, 1);   // 小数点以下1桁で近似比較
    expect(5).toBeGreaterThan(4);
    expect(3).toBeLessThanOrEqual(3);
  });

  it("例外のテスト", () => {
    const throwError = () => {
      throw new Error("oops");
    };
    expect(throwError).toThrow("oops");
  });
});

// src/counter.spec.ts

class Counter {
  private count = 0;
  increment() { this.count++; }
  get value() { return this.count; }
}

describe("Counter", () => {
  let counter: Counter;

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

  it("初期値は 0", () => {
    expect(counter.value).toBe(0);
  });

  it("increment すると 1 になる", () => {
    counter.increment();
    expect(counter.value).toBe(1);
  });

  it("2回 increment すると 2 になる", () => {
    counter.increment();
    counter.increment();
    expect(counter.value).toBe(2);
  });
});

// src/notifier.spec.ts

type Notifier = {
  send: (message: string) => void;
};

class UserService {
  constructor(private notifier: Notifier) {}

  register(name: string) {
    // 何かのビジネスロジック...
    this.notifier.send(`${name} さんが登録しました`);
  }
}

describe("UserService", () => {
  it("登録時に Notifier.send が呼ばれる", () => {
    const mockNotifier = { send: jest.fn() };  // 偽物の Notifier
    const service = new UserService(mockNotifier);

    service.register("Taro");

    // 呼ばれたか
    expect(mockNotifier.send).toHaveBeenCalled();
    // 何を渡して呼ばれたか
    expect(mockNotifier.send).toHaveBeenCalledWith("Taro さんが登録しました");
    // 何回呼ばれたか
    expect(mockNotifier.send).toHaveBeenCalledTimes(1);
  });
});

const mockFetch = jest.fn();

// 一度だけ返す値
mockFetch.mockResolvedValueOnce({ data: "hello" });

// 常に返す値
mockFetch.mockResolvedValue({ data: "always" });

// 一度だけ例外を投げる
mockFetch.mockRejectedValueOnce(new Error("network error"));

beforeEach(() => {
  jest.clearAllMocks();  // 呼び出し履歴・戻り値をリセット
});

// src/async.spec.ts

async function fetchUser(id: number): Promise<{ id: number; name: string }> {
  // 実際はAPIコールだが、ここではシミュレート
  if (id === 0) throw new Error("user not found");
  return { id, name: "Taro" };
}

describe("fetchUser", () => {
  it("ユーザーを返す", async () => {
    const user = await fetchUser(1);
    expect(user).toEqual({ id: 1, name: "Taro" });
  });

  it("id=0 のとき例外を投げる", async () => {
    await expect(fetchUser(0)).rejects.toThrow("user not found");
  });

  it("resolves で成功を検証する別の書き方", async () => {
    await expect(fetchUser(1)).resolves.toMatchObject({ name: "Taro" });
  });
});

# ファイル名で絞り込む
pnpm test counter

# テスト名で絞り込む（-t フラグ）
pnpm test -- -t "increment"

# ファイルを --watch モードで実行
pnpm test -- --watch

describe("Counter", () => {      // ← "Counter" が describe のテスト名
  it("increment すると 1 になる", () => {   // ← これが it のテスト名
    ...
  });
});

it.only("このテストだけ実行される", () => {
  expect(1).toBe(1);
});

pnpm test -- --coverage

----------|---------|----------|---------|---------|
File      | % Stmts | % Branch | % Funcs | % Lines |
----------|---------|----------|---------|---------|
counter.ts|     100 |      100 |     100 |     100 |
----------|---------|----------|---------|---------|