如何测试 NestJS 应用？

Question

如何测试 NestJS 应用？

Accepted Answer

NestJS 提供了一个内置的**测试实用程序 (`@nestjs/testing`)**，与 Jest 集成，其**依赖注入架构使测试特别清晰** — 你创建一个测试模块并为依赖注入 mock。测试分为单元测试（隔离）和 e2e 测试（完整应用）。

## 测试服务（带有 mock 依赖）

```ts
import { Test } from "@nestjs/testing";

describe("UsersService", () => {
  let service: UsersService;
  let mockRepo = { find: jest.fn(), save: jest.fn() };

beforeEach(async () => {
    const module = await Test.createTestingModule({
      providers: [
        UsersService,
        // inject a MOCK for the repository — no real database needed
        { provide: getRepositoryToken(User), useValue: mockRepo },
      ],
    }).compile();

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

it("returns all users", async () => {
    mockRepo.find.mockResolvedValue([{ id: 1, name: "Ann" }]);
    const result = await service.findAll();
    expect(result).toHaveLength(1);
    expect(mockRepo.find).toHaveBeenCalled();
  });
});
```

关键优势：NestJS 的 DI 让你能够**通过测试模块的 providers 将真实依赖替换为 mock** — 因此你可以在隔离状态下测试服务，而无需真实数据库或外部服务。

## 轻松 mock 依赖

```ts
// provide a fake for ANY dependency by its token
{ provide: EmailService, useValue: { send: jest.fn() } }
{ provide: ConfigService, useValue: { get: () => "test-value" } }
```

由于类不构造其依赖（DI 负责），替换 mock 很简单 — 这是干净单元测试的基础。

## 端到端 (e2e) 测试 — 完整应用通过 HTTP

```ts
import * as request from "supertest";

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

beforeAll(async () => {
    const module = await Test.createTestingModule({
      imports: [AppModule],        // the whole app
    }).compile();
    app = module.createNestApplication();
    await app.init();
  });

it("GET /users", () => {
    return request(app.getHttpServer())   // make a real HTTP request
      .get("/users")
      .expect(200)
      .expect(res => expect(res.body).toBeInstanceOf(Array));
  });

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

**E2E 测试**启动完整应用并发送真实 HTTP 请求（通过 `supertest`），验证整个流程（路由 → guards → pipes → 处理程序 → 响应）协同工作。

## 测试策略

```text
Unit tests  → services, guards, pipes in isolation (mock dependencies) — fast, numerous
Integration → a controller + its real service together via the testing module
E2E tests   → full app over HTTP (supertest) — verify real request flows, fewer
Use a TEST database (or mocks) for e2e; override providers for external services.
```

## 为什么这很重要

测试对于可靠的应用至关重要，NestJS 的架构使其特别清晰 — 理解如何测试对代码质量很重要，同时因为框架是*为可测试性而设计*的。

核心见解是**依赖注入使 mock 变得微不足道**：由于类声明其依赖，而 DI 提供它们，`@nestjs/testing` 模块让你可以通过其令牌将任何依赖（数据库仓储、外部服务、配置）替换为 mock，实现快速、隔离的服务、guards 和 pipes 的**单元测试**，无需真实基础设施。

这种可测试性是 DI 基础框架（如 NestJS）受重视的重要原因。

补充单元测试，**e2e 测试**（启动完整应用并通过 `supertest` 发送真实 HTTP 请求）验证整个请求管道 — 路由、guards、验证、处理程序 — 协同正确工作。

了解测试实用程序（`Test.createTestingModule`、用于 mock 的 provider 覆盖）、如何编写单元和 e2e 测试，以及明智的测试策略（多个快速隔离的单元测试、少量完整 e2e 测试、测试数据库）是专业 NestJS 开发的标志。

它反映了成熟的工程实践，并充分利用了使 NestJS 的结构化、DI 驱动设计有价值的要素，使其成为重要的高级主题。