NestJSテスト入門

Cannot find name 'describe'.
Cannot find name 'jest'.
Cannot find name 'expect'.

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

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

{
  "compilerOptions": {
    "types": ["node", "jest"]
  }
}

api-sample/
├─ src/
│  └─ users/
│     └─ users.service.spec.ts   # 【単体】pnpm test（src の *.spec.ts）
└─ test/
   └─ users.e2e-spec.ts          # 【E2E】pnpm run test:e2e（test の *.e2e-spec.ts）

// =============================================================================
// 【単体テスト】ファイル: src/users/users.service.spec.ts
// 実行: pnpm test（Jest が **src 配下の *.spec.ts** を拾う）
// 中身: UsersService だけを TestingModule で組み立て、Prisma は jest.fn() のモック。
//       HTTP サーバーは立てず、DB にも接続しない。
// =============================================================================
import { NotFoundException } from "@nestjs/common";
import { Test, TestingModule } from "@nestjs/testing";
import { PrismaService } from "../prisma/prisma.service";
import { UsersService } from "./users.service";

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

  // PrismaService の代わり。DB の代わりに返す値をテスト側で決める
  const prisma = {
    user: {
      findMany: jest.fn(),
      findUnique: jest.fn(),
      create: jest.fn(),
      update: jest.fn(),
      delete: jest.fn(),
    },
  };

  beforeEach(async () => {
    jest.clearAllMocks();

    // 単体テスト用のミニマルな Nest モジュール（本番の AppModule は import しない）
    const module: TestingModule = await Test.createTestingModule({
      providers: [
        UsersService,
        // 本物の PrismaService の代わりにモックを注入
        { provide: PrismaService, useValue: prisma },
      ],
    }).compile();

    service = module.get(UsersService);
  });

  it("findAll returns users", async () => {
    const users = [
      {
        id: "u_1",
        email: "taro@example.com",
        name: "Taro",
        createdAt: new Date(),
        updatedAt: new Date(),
      },
    ];

    prisma.user.findMany.mockResolvedValueOnce(users);

    await expect(service.findAll()).resolves.toEqual(users);
    // Service が Prisma に渡した引数（orderBy / select など）を検証
    expect(prisma.user.findMany).toHaveBeenCalledWith({
      orderBy: { createdAt: "desc" },
      select: { id: true, email: true, name: true, createdAt: true, updatedAt: true },
    });
  });

  it("findOne throws NotFoundException when user does not exist", async () => {
    prisma.user.findUnique.mockResolvedValueOnce(null);

    await expect(service.findOne("not-exist")).rejects.toBeInstanceOf(NotFoundException);
  });
});

pnpm test

npm run test

pnpm test users.service

Cannot find module './internal/class.js' from 'generated/prisma/client.ts'

"moduleNameMapper": {
  "^(\\.{1,2}/.*)\\.js$": "$1"
}

Nest can't resolve dependencies of the UsersController (?). Please make sure that the argument UsersService at index [0] is available in the RootTestModule module.

// =============================================================================
// 【単体テスト】ファイル: src/users/users.controller.spec.ts（Nest CLI 生成物の修正例）
// 実行: pnpm test（**src 配下の *.spec.ts**）
// 中身: Controller だけを TestingModule に載せ、UsersService はモックで差し替え。
//       ルートの HTTP や AppModule は使わない（E2E ではない）。
// =============================================================================
import { Test, TestingModule } from "@nestjs/testing";
import { UsersController } from "./users.controller";
import { UsersService } from "./users.service";

describe("UsersController", () => {
  let controller: UsersController;

  // Controller が呼ぶ UsersService の振る舞いはここでは検証しないので空の jest.fn()
  const mockUsersService = {
    findAll: jest.fn(),
    findOne: jest.fn(),
    create: jest.fn(),
    update: jest.fn(),
    remove: jest.fn(),
  };

  beforeEach(async () => {
    const module: TestingModule = await Test.createTestingModule({
      controllers: [UsersController],
      providers: [{ provide: UsersService, useValue: mockUsersService }],
    }).compile();

    controller = module.get<UsersController>(UsersController);
  });

  it("should be defined", () => {
    expect(controller).toBeDefined();
  });
});

// =============================================================================
// 【E2Eテスト】ファイル: test/users.e2e-spec.ts
// 実行: pnpm run test:e2e（Jest が **test 配下の *.e2e-spec.ts** を拾う設定が多い）
// 中身: 本番に近い **AppModule 全体**を起動（Prisma・Guard・Filter も含む）。
//       Supertest で実 HTTP の GET/POST を送り、ステータスと JSON を検証する。
// =============================================================================
import { INestApplication, ValidationPipe } from "@nestjs/common";
import { Test, TestingModule } from "@nestjs/testing";
import request from "supertest";
import { AppModule } from "../src/app.module";
import { GlobalExceptionFilter } from "../src/common/filters/http-exception.filter";

describe("Users (e2e)", () => {
  let app: INestApplication;

  beforeAll(async () => {
    // E2E ではここで本物の AppModule を読み込む（単体テストとの大きな違い）
    const moduleFixture: TestingModule = await Test.createTestingModule({
      imports: [AppModule],
    }).compile();

    app = moduleFixture.createNestApplication();

    // main.ts と揃える（ここを省略すると E2E だけバリデーション挙動が本番とズレる）
    app.useGlobalPipes(
      new ValidationPipe({
        whitelist: true,
        forbidNonWhitelisted: true,
        transform: true,
      }),
    );

    app.useGlobalFilters(new GlobalExceptionFilter());

    await app.init();
  });

  afterAll(async () => {
    await app.close();
  });

  it("GET /users returns 200", () => {
    // 【E2Eの核】HTTP クライアントとしてサーバーに叩きにいく（単体ではやらない）
    return request(app.getHttpServer()).get("/users").expect(200);
  });

  it("POST /users creates a user", async () => {
    const email = `e2e-${Date.now()}@example.com`;

    const response = await request(app.getHttpServer())
      .post("/users")
      .send({
        email,
        name: "E2E Taro",
        password: "password123",
      })
      .expect(201);

    expect(response.body).toMatchObject({
      email,
      name: "E2E Taro",
    });
    expect(response.body.passwordHash).toBeUndefined();
  });
});

"moduleNameMapper": {
  "^src/(.*)$": "<rootDir>/../src/$1",
  "^(\\.{1,2}/.*)\\.js$": "$1"
}

pnpm run test:e2e

npm run test:e2e

TypeError: A dynamic import callback was invoked without --experimental-vm-modules

"test:e2e": "NODE_OPTIONS=--experimental-vm-modules jest --config ./test/jest-e2e.json"

"test": "NODE_OPTIONS=--experimental-vm-modules jest"

"test:e2e": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --config ./test/jest-e2e.json"