E2E 테스트 구현

E2E 테스트를 구현할 때 상태 준비, 요청 시나리오, 실패 응답, 데이터 정리 기준을 묶었습니다.

이 절에서는 사용자 관점에서 애플리케이션의 전체 흐름을 검증하는 E2E(End-to-End) 테스트 구현 방법을 다룹니다.

단위 테스트가 개별 코드 조각의 정확성을 보장한다면, E2E 테스트는 선택한 애플리케이션 경계를 실제 요청으로 통과하며 모듈 연결과 저장 결과를 함께 검증합니다.

이는 애플리케이션이 프로덕션 환경에서 사용자에게 어떤 경험을 제공할지 미리 확인하는 중요한 단계입니다.

E2E 테스트란?

E2E 테스트(End-to-End Test)는 애플리케이션의 시작부터 끝까지의 전체 워크플로우를 시뮬레이션하여 시스템이 의도한 대로 동작하는지 검증하는 테스트 유형입니다.

NestJS와 Supertest를 사용하는 이 절의 E2E 테스트는 브라우저를 구동하지 않고 Nest 애플리케이션의 HTTP 경계까지 검증합니다. 실제 브라우저 상호작용과 프론트엔드까지 포함하는 시스템 E2E는 Playwright나 Cypress 같은 별도 도구의 범위입니다.

• 사용자 관점: 실제 사용자가 겪을 수 있는 시나리오를 재현합니다.
• 선택한 시스템 경계 검증: 전체 AppModule을 사용할 수도 있고, 목적에 맞는 모듈만 로드하거나 외부 프로바이더를 대체할 수도 있습니다.
• 통합된 동작 확인: 여러 컴포넌트가 올바르게 통합되어 작동하는지 확인합니다.
• 느린 실행 속도: 실제 시스템을 구동해야 하므로 단위 테스트나 통합 테스트보다 실행 시간이 오래 걸립니다.
• 취약한 안정성(Flakiness): 네트워크 지연, 외부 서비스의 상태, 비동기 작업 등으로 인해 불안정한 테스트(Flaky Test)가 발생할 수 있습니다.

NestJS 백엔드 애플리케이션에서 E2E 테스트는 주로 HTTP/REST API 엔드포인트를 호출해 서버 응답을 검증하는 방식으로 진행됩니다.

프론트엔드가 있는 경우 Cypress, Playwright 같은 도구를 함께 사용해 브라우저 상호작용까지 포함할 수 있습니다.

NestJS는 기본적으로 Jest와 Supertest 라이브러리를 사용해 E2E 테스트 환경을 제공합니다.

다음 기준선은 테스트 환경과 데이터 준비부터 HTTP 호출, 검증, 정리까지 Nest/Supertest E2E의 책임 경계를 보여줍니다.

NestJS E2E 테스트 환경 설정

새 NestJS 프로젝트를 생성하면 test 폴더에 app.e2e-spec.ts 파일과 jest-e2e.json 설정 파일이 기본으로 제공됩니다.

{
  "moduleFileExtensions": ["js", "json", "ts"],
  "rootDir": ".",
  "testEnvironment": "node",
  "testRegex": "\\.e2e-spec\\.ts$",
  "transform": {
    "^.+\\.(t|j)s$": "ts-jest"
  }
}

• testRegex: \.e2e-spec\.ts$ 패턴으로 끝나는 파일만 E2E 테스트로 인식하여 실행합니다. 이는 단위 테스트와 E2E 테스트를 분리하여 실행할 때 유용합니다.
• rootDir가 test 폴더라면 <rootDir>/src는 test/src를 뜻합니다. 별칭이 필요하면 실제 소스 위치인 <rootDir>/../src/$1처럼 프로젝트 구조에 맞춰 명시해야 하며, 이 예제는 상대 import를 사용하므로 별도 매핑을 두지 않습니다.

E2E 테스트 작성: AppController 예시

AppController의 간단한 HTTP 엔드포인트를 테스트하는 예시를 통해 E2E 테스트의 기본 구조를 이해해 보겠습니다.

import { Controller, Get, Post, Body } from '@nestjs/common';
import { AppService } from './app.service';

@Controller('app')
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get('hello')
  getHello(): string {
    return this.appService.getHello();
  }

  @Post('sum')
  sumNumbers(@Body() data: { a: number; b: number }): number {
    return this.appService.sum(data.a, data.b);
  }
}

import { Injectable } from '@nestjs/common';

@Injectable()
export class AppService {
  getHello(): string {
    return 'Hello World!';
  }

  sum(a: number, b: number): number {
    return a + b;
  }
}

프로덕션과 E2E가 같은 HTTP 계약을 사용하도록 main.ts에만 있던 명령형 bootstrap 설정을 함수로 분리합니다. 전역 filter와 interceptor를 코드에서 직접 등록한다면 이 함수에 함께 두고, DI가 필요하면 APP_FILTER, APP_INTERCEPTOR 프로바이더로 등록합니다.

import {
  INestApplication,
  ValidationPipe,
} from '@nestjs/common';

export function configureApp(app: INestApplication): void {
  app.setGlobalPrefix('api');
  app.useGlobalPipes(new ValidationPipe({ transform: true, whitelist: true }));
}

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { configureApp } from './configure-app';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  configureApp(app);
  await app.listen(process.env.PORT ?? 3000);
}

void bootstrap();

NestJS가 기본으로 제공하는 app.e2e-spec.ts 파일을 수정하여 사용하거나, 새로운 E2E 테스트 파일을 생성할 수 있습니다.

import { Test, TestingModule } from '@nestjs/testing';
import { INestApplication } from '@nestjs/common';
import request from 'supertest';
import { AppModule } from './../src/app.module';
import { configureApp } from './../src/configure-app';

describe('AppController (e2e)', () => {
  let app: INestApplication;

  // 각 테스트 스위트가 시작되기 전에 단 한 번 실행됩니다.
  // NestJS 애플리케이션을 초기화하고 HTTP 요청을 보낼 준비를 합니다.
  beforeAll(async () => {
    const moduleFixture: TestingModule = await Test.createTestingModule({
      imports: [AppModule],
    }).compile();

    app = moduleFixture.createNestApplication();
    configureApp(app);
    await app.init();
  });

  // 각 테스트 스위트가 끝난 후 단 한 번 실행됩니다.
  // NestJS 애플리케이션을 종료하여 리소스를 정리합니다.
  afterAll(async () => {
    await app.close();
  });

  // --- GET /api/app/hello 엔드포인트 테스트 ---
  it('/api/app/hello (GET)', () => {
    return request(app.getHttpServer()) // Supertest를 사용하여 HTTP 서버에 요청
      .get('/api/app/hello') // global prefix를 포함한 실제 HTTP 계약
      .expect(200) // HTTP 상태 코드 200 (OK) 예상
      .expect('Hello World!'); // 응답 본문이 'Hello World!'인지 예상
  });

  // --- POST /api/app/sum 엔드포인트 테스트 ---
  it('/api/app/sum (POST)', () => {
    return request(app.getHttpServer())
      .post('/api/app/sum')
      .send({ a: 5, b: 7 }) // 요청 본문 (JSON) 전송
      .expect(201) // HTTP 상태 코드 201 (Created) 예상 (NestJS는 기본적으로 POST에 201 반환)
      .expect('12'); // 응답 본문이 '12' (문자열로 반환됨)인지 예상
  });

  // --- 존재하지 않는 경로 테스트 (404 Not Found) ---
  it('/non-existent-path (GET) should return 404', () => {
    return request(app.getHttpServer())
      .get('/non-existent-path')
      .expect(404); // HTTP 상태 코드 404 (Not Found) 예상
  });
});

• import request from 'supertest';: HTTP 요청을 보내고 응답을 검증하는 데 사용되는 Supertest 라이브러리의 기본 export를 임포트합니다.
• Test.createTestingModule({ imports: [AppModule] }).compile();: 테스트가 선택한 모듈 그래프를 컴파일합니다. 전체 AppModule을 사용할 수 있지만, 목적에 따라 일부 모듈만 선택하거나 overrideProvider()로 제어하기 어려운 외부 의존성을 대체할 수 있습니다.
• configureApp(app): createNestApplication()은 main.ts의 명령형 코드를 자동 실행하지 않습니다. 프로덕션과 테스트가 프로젝트에서 실제 사용하는 global prefix, pipe, filter, interceptor 설정을 공유해야 같은 HTTP 계약을 검증할 수 있습니다.
• await app.init();: 선택한 애플리케이션 그래프의 lifecycle과 route를 초기화합니다. 프로덕션 포트에 listen()하지 않으며 브라우저를 실행하지도 않습니다.
• await app.close();: Nest가 관리하는 lifecycle과 연결을 종료합니다. 테스트가 생성한 DB row, queue message, 파일, 외부 sandbox 데이터까지 되돌리거나 삭제해 주는 명령은 아니므로 이 상태는 별도로 정리해야 합니다.
• request(app.getHttpServer()): Supertest의 핵심 부분입니다. app.getHttpServer()를 통해 NestJS가 사용하는 Node.js HTTP 서버 인스턴스를 가져와 Supertest에 전달하면, Supertest가 해당 서버에 직접 요청을 보냅니다.
• .get('/api/app/hello'), .post('/api/app/sum'): global prefix를 포함한 HTTP 메서드와 경로를 지정합니다.
• .send({ a: 5, b: 7 }): POST 요청의 경우, 요청 본문 데이터를 전송합니다.
• .expect(200), .expect(201), .expect(404): 예상되는 HTTP 상태 코드를 검증합니다.
• .expect('Hello World!'), .expect('12'): 예상되는 응답 본문을 검증합니다. Supertest는 JSON 응답 검증도 지원합니다(예: .expect({ id: 1, name: 'Test User' })).

이 짧은 sum 예제의 인라인 객체 타입에는 런타임 validation metadata가 없으므로, 정상 POST 테스트는 공유 bootstrap과 route 계약을 확인할 뿐 ValidationPipe의 변환·whitelist 규칙 자체를 입증하지 않습니다. 그 규칙까지 검증하려면 데코레이터가 있는 DTO를 사용하고 잘못된 body가 400이 되는 사례를 별도로 단언해야 합니다.

E2E 테스트는 별도의 Jest 설정 파일을 사용하므로, package.json에 정의된 스크립트를 사용합니다.

npm run test:e2e

콘솔에 테스트 통과 결과가 나타날 것입니다.

데이터베이스 연동 E2E 테스트 시 고려사항

실제 애플리케이션의 E2E 테스트는 데이터베이스를 포함하는 경우가 많습니다.

이때는 DB 연결만 분리하는 데서 끝내지 말고, seed와 외부 의존성, queue·파일, mock 기록, 열린 handle까지 자원별 준비·격리·정리·실패 신호를 정해야 합니다.

• 독립적인 테스트 데이터: 결정적인 factory와 고유 key로 필요한 데이터만 준비하고, 테스트 완료 후 row·queue message·임시 파일처럼 테스트가 만든 영속 상태를 명시적으로 정리합니다.
  • DB 격리 전략: 트랜잭션 rollback은 빠르지만 애플리케이션과 테스트가 같은 연결·트랜잭션 경계를 공유할 때만 유효합니다. 병렬 worker에는 worker별 schema·database·container가 더 명확할 수 있으며, Testcontainers는 강력한 선택지이지만 Docker 기동 비용과 CI 제약을 함께 평가해야 합니다.
• 환경 변수 관리: 테스트 환경에서 데이터베이스 연결 정보, 외부 서비스 API 키 등 환경 변수를 다르게 설정해야 합니다. config 모듈을 활용하거나, dotenv를 사용하여 test.env 파일 등을 활용할 수 있습니다.
• 외부 서비스 경계: 검증 목적에 따라 공급자의 sandbox를 사용하거나 제어 가능한 test double로 대체합니다. 결제·SMS처럼 비용, quota, 비결정성이 큰 의존성을 무조건 실제 호출하는 것은 좋은 E2E의 조건이 아닙니다.
• mock lifecycle: 호출 이력만 비우는 clear, 구현까지 초기화하는 reset 중 필요한 정책을 정하고 beforeEach에서 일관되게 적용합니다. mockRestore()로 원래 구현을 복원할 수 있는 것은 jest.spyOn()으로 만든 spy이며, 직접 대입한 jest.fn()은 원래 값을 별도로 보관해 복원해야 합니다.

NestJS의 Test.createTestingModule에서 특정 프로바이더만 오버라이드(override)해 모킹된 버전을 주입할 수 있습니다.

import { Test, TestingModule } from '@nestjs/testing';
import { INestApplication } from '@nestjs/common';
import request from 'supertest';
import { AppModule } from './../src/app.module';
import { configureApp } from './../src/configure-app';
import { EmailService } from './../src/email/email.service'; // 이메일 서비스 (외부 의존성)

// 이메일 서비스를 모킹하여 실제 이메일 전송을 방지
const mockEmailService = {
  sendEmail: jest.fn(() => Promise.resolve('Email sent successfully')),
};

describe('User Registration (e2e)', () => {
  let app: INestApplication;

  beforeAll(async () => {
    const moduleFixture: TestingModule = await Test.createTestingModule({
      imports: [AppModule],
    })
      .overrideProvider(EmailService) // EmailService를 오버라이드
      .useValue(mockEmailService) // 모킹된 EmailService 사용
      .compile();

    app = moduleFixture.createNestApplication();
    configureApp(app);
    await app.init();
  });

  beforeEach(() => {
    mockEmailService.sendEmail.mockClear();
  });

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

  it('/api/register (POST) should register user and send email', () => {
    return request(app.getHttpServer())
      .post('/api/register')
      .send({ username: 'testuser', email: 'test@example.com', password: 'password123' })
      .expect(201)
      .expect(res => {
        expect(res.body.message).toBe('User registered successfully');
      })
      .then(() => {
        // 모킹된 이메일 서비스의 sendEmail 메서드가 호출되었는지 검증
        expect(mockEmailService.sendEmail).toHaveBeenCalledTimes(1);
        expect(mockEmailService.sendEmail).toHaveBeenCalledWith('test@example.com', 'Welcome testuser!');
      });
  });
});

overrideProvider()를 사용하면 전체 AppModule을 로드하면서도 특정 프로바이더만 가짜 구현으로 대체할 수 있습니다.

이는 실제 데이터베이스 연결은 사용하되, 외부 API 호출과 같은 특정 로직만 모킹하고 싶을 때 유용합니다.

이 예제에서도 app.close()는 Nest lifecycle과 연결을 닫을 뿐입니다. 등록된 사용자 row나 외부 sandbox 기록을 정리하려면 해당 자원의 API 또는 저장소를 테스트 teardown에서 별도로 호출해야 합니다.

E2E 테스트는 실제 요청 흐름, 모듈 연결, 데이터 저장소 연동을 함께 검증하는 테스트입니다.

실행 속도와 유지보수 비용이 높을 수 있으므로 핵심 사용자 흐름과 장애 가능성이 큰 경로를 우선 대상으로 삼아야 합니다.

Jest와 Supertest는 NestJS 애플리케이션의 HTTP 경계를 검증하는 데 사용할 수 있습니다.

이것으로 8장 테스팅 전략의 두 번째 절을 마칩니다.

다음 절에서는 테스트 커버리지 도구를 사용하여 테스트 코드의 품질을 측정하고 개선하는 방법에 대해 알아보겠습니다.