NestJS 애플리케이션은 어떻게 테스트하나요?

Question

Accepted Answer

NestJS는 Jest와 통합된 내장 **테스트 유틸리티(`@nestjs/testing`)**를 제공하며, 그 **dependency-injection 아키텍처는 테스트를 특히 깔끔하게 만듭니다** — 테스트 module을 생성하고 의존성에 mock을 주입합니다. 테스트는 단위 테스트(격리)와 e2e 테스트(전체 앱)로 나뉩니다.

## service 단위 테스트 (의존성 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,
        // repository에 MOCK 주입 — 실제 데이터베이스 불필요
        { 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는 테스트 module의 provider를 통해 실제 의존성을 **mock으로 교체**하게 합니다 — 그래서 실제 데이터베이스나 외부 service 없이 service를 격리하여 테스트합니다.

## 의존성 쉽게 mock하기

```ts
// 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],        // 전체 앱
    }).compile();
    app = module.createNestApplication();
    await app.init();
  });

it("GET /users", () => {
    return request(app.getHttpServer())   // 실제 HTTP 요청 생성
      .get("/users")
      .expect(200)
      .expect(res => expect(res.body).toBeInstanceOf(Array));
  });

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

**E2E 테스트**는 전체 애플리케이션을 부트스트랩하고 (`supertest`를 통해) 실제 HTTP 요청을 만들어, 전체 흐름(라우팅 → guard → pipe → 핸들러 → 응답)이 함께 작동하는지 검증합니다.

## 테스트 전략

```text
단위 테스트  → service, guard, pipe를 격리하여 (의존성 mock) — 빠르고 많음
통합        → controller + 실제 service를 테스트 module을 통해 함께
E2E 테스트   → HTTP를 통한 전체 앱 (supertest) — 실제 요청 흐름 검증, 적음
e2e에는 테스트 데이터베이스(또는 mock) 사용; 외부 service는 provider override.
```

## 왜 중요한가

테스트는 신뢰할 수 있는 애플리케이션에 필수적이며, NestJS의 아키텍처는 이를 눈에 띄게 깔끔하게 만듭니다 — 테스트 방법을 이해하는 것은 코드 품질을 위해서도, 프레임워크가 테스트 가능성을 *위해 설계되었기* 때문에도 중요합니다.

핵심 통찰은 **dependency injection이 mocking을 사소하게 만든다**는 것입니다: 클래스가 의존성을 선언하고 DI가 그것을 제공하기 때문에, `@nestjs/testing` module은 어떤 의존성(데이터베이스 repository, 외부 service, 구성)이든 token으로 mock으로 교체하게 하여, 실제 인프라 없이 service, guard, pipe의 빠르고 격리된 **단위 테스트**를 가능하게 합니다.

이 테스트 가능성은 NestJS 같은 DI 기반 프레임워크가 가치 있는 주요 이유입니다.

단위 테스트를 보완하여, **e2e 테스트**(전체 앱을 부트스트랩하고 `supertest`를 통해 실제 HTTP 요청을 만듦)는 전체 요청 파이프라인 — 라우팅, guard, 검증, 핸들러 — 이 함께 올바르게 작동하는지 검증합니다.

테스트 유틸리티(`Test.createTestingModule`, mocking을 위한 provider override), 단위 테스트와 e2e 테스트 모두 작성하는 방법, 그리고 합리적인 테스트 전략(빠르고 격리된 많은 단위 테스트, 더 적은 전체 e2e 테스트, 테스트 데이터베이스)을 아는 것은 전문적인 NestJS 개발의 특징입니다.

이는 성숙한 엔지니어링 실무를 반영하고 NestJS의 구조화된 DI 기반 설계를 가치 있게 만드는 바로 그것을 활용하여, 중요한 시니어 수준 주제가 됩니다.