PUBLISHED

13. Jest 테스트 구성

작성일: 2024.12.07

Nest.js#jest#test
13. Jest 테스트 구성

이 포스트를 시작하기에 앞서 한 가지 분명히 밝혀두고 싶은 점이 있다. 나는 컨트롤러(혹은 GraphQL 기준으로는 리졸버) 와 레포지토리 클래스에 대한 테스트를 거의 작성하지 않는다.

이유는 단순하다. 애플리케이션에서 가장 많은 비즈니스 규칙이 응집되어 있는 곳은 서비스 계층이며, 테스트 비용 대비 효율을 고려했을 때 이 계층을 집중적으로 검증하는 것이 가장 낫다고 생각하기 때문이다. 컨트롤러는 요청을 받아 서비스로 위임하고 응답을 반환하는 역할에 가깝고, 레포지토리는 데이터 접근 로직에 가깝다. 이 둘은 서비스 계층이 정상적으로 동작한다는 전제하에 상대적으로 변동 가능성이 낮다. 그래서 내가 작성하는 테스트는 대부분 서비스 ∙ 헬퍼 ∙ 유틸리티 클래스에 집중되어 있다.

환경 변수 설정

테스트 환경에서도 환경 변수가 필요한 경우가 많다. 물론 테스트 코드에서 값을 직접 하드코딩할 수도 있지만, 아래와 같은 방식을 사용하면 환경 변수 노출 없이 .env.test 파일의 값을 가져올 수 있다.

untitled
TS
describe('', () => {
  let jwt: ConfigType<typeof jwtConfig>;

  beforeEach(async () => {
    const module: TestingModule = await Test.createTestingModule({
      imports: [
        ConfigModule.forRoot({
          envFilePath: '.env.test',
        }),
      ],
      providers: [
        {
          provide: jwtConfig.KEY,
          useValue: jwtConfig(),
        },
      ],
    }).compile();

    jwt = module.get(jwtConfig.KEY);
  });
});

이 방식의 장점은 다음과 같다.

프로바이더 모의(Mock)

Nest.js는 DI 컨테이너를 기반으로 동작한다. 따라서 테스트를 작성할 때 가장 중요한 것은 어떤 프로바이더를 실제 구현으로 쓰고, 어떤 프로바이더를 모의 객체로 대체할 것인가를 결정하는 일이다.

Nest.js는 이를 위해 Test.createTestingModule이라는 전용 API를 제공한다. 이 메서드를 통해 테스트에 필요한 모듈을 구성하고, 각종 프로바이더를 자유롭게 등록하거나 대체할 수 있다.

유닛 테스트에서는 보통 테스트 대상이 아닌 의존성은 모두 모의 객체로 대체한다. 이를 구현하는 방식으로는 크게 세 가지가 있다.

useValue

useValue는 정적인 객체를 그대로 주입하는 방식이다. 가장 단순하면서도 실무에서 가장 자주 쓰게 되는 방식이다.

untitled
TS
describe('BookService', () => {
  let bookService: BookService;
  let bookRepository: BookRepository;

  beforeEach(async () => {
    const module: TestingModule = await Test.createTestingModule({
      providers: [
        BookService,
        {
          provide: BookRepository,
          useValue: {
            getBookByIsbn: jest.fn(),
            createBook: jest.fn(),
            getBookFromAladin: jest.fn(),
            getBookListFromAladin: jest.fn(),
          },
        },
      ],
    }).compile();

    bookService = module.get(BookService);
    bookRepository = module.get(BookRepository);
  });
});

테스트 중 특정 메서드가 호출되었는지 확인하거나, 반환값을 자유롭게 바꿔야 할 때 매우 유용하다.

useClass

useClass는 실제 클래스 대신 대체 클래스를 주입하는 방식이다. 모의 클래스 내부에 기본 동작을 정의해두고, 테스트마다 그 동작을 활용할 수 있다.

untitled
TS
class MockBookRepository {
  getBookByIsbn = jest.fn((isbn13: string) => {
    if (isbn13 === '') throw new NotFoundException();
    return Book;
  });

  getBookListByKeyWord = jest.fn();
  createBook = jest.fn();
}
untitled
TS
describe('BookService', () => {
  let bookService: BookService;
  let bookRepository: BookRepository;

  beforeEach(async () => {
    const module: TestingModule = await Test.createTestingModule({
      providers: [
        BookService,
        {
          provide: BookRepository,
          useClass: MockBookRepository,
        },
      ],
    }).compile();

    bookService = module.get(BookService);
    bookRepository = module.get(BookRepository);
  });
});

여러 테스트에서 동일한 기본 동작을 재사용하고 싶을 때 적합하다.

useFactory

useFactory는 팩토리 함수를 사용해 런타임에 값을 생성하는 방식이다. 테스트마다 서로 다른 의존성을 주입해야 하거나, 초기화 과정이 복잡한 경우에 사용할 수 있다.

untitled
TS
const MockBookRepository = (book: Book) => ({
  getBookByIsbn: jest.fn((isbn13: string) => {
    if (isbn13 === '') throw new NotFoundException('Book not found');
    return book;
  }),
  getBookListByKeyWord: jest.fn(),
  createBook: jest.fn(),
});
untitled
TS
beforeEach(async () => {
  const module: TestingModule = await Test.createTestingModule({
    providers: [
      BookService,
      {
        provide: BookRepository,
        useFactory: () => MockBookRepository(book),
      },
    ],
  }).compile();
});

개인적으로는 가장 덜 사용하는 방식이지만, 필요할 때는 확실히 쓸모가 있다.

기본 구조

반드시 이렇게 해야 하는 것은 아니지만, 나는 모든 테스트 전에 beforeEach로 모듈을 새로 초기화하는 방식을 선호한다. 이렇게 하면 테스트 간에 발생할 수 있는 side effect를 확실히 차단할 수 있다.

untitled
TS
describe('AuthService', () => {
  let authService: AuthService;
  let authRepository: AuthRepository;
  let jwt: ConfigType<typeof jwtConfig>;

  beforeEach(async () => {
    const module: TestingModule = await Test.createTestingModule({
      imports: [
        ConfigModule.forRoot({
          envFilePath: '.env.test',
        }),
      ],
      providers: [
        AuthService,
        {
          provide: AuthRepository,
          useValue: {
            createUser: jest.fn(),
            getUser: jest.fn(),
          },
        },
        {
          provide: jwtConfig.KEY,
          useValue: jwtConfig(),
        },
      ],
    }).compile();

    authService = module.get(AuthService);
    authRepository = module.get(AuthRepository);
    jwt = module.get(jwtConfig.KEY);
  });

  describe('signIn', () => {});
  describe('signUp', () => {});
});

모든 테스트에 test.only를 남겨두는 것보다, 이 방식이 훨씬 안전하고 예측 가능하다. 테스트는 언제나 독립적으로 실행될 수 있어야 한다고 생각하기 때문이다.