📄 테스트 코드와 모킹

현재 상황

기존에는 In-memory로 데이터를 저장하고 있었으나, 현재는 MySQL로 데이터를 저장하도록 수정하였음

그러나 아직 merge하지 않았고, 이를 검증하기 어려운 상태이다.

• local에 있는 프론트 코드로 검증 : 현재는 random-name api에서 에러가 발생하여 검증하기 힘든 상황
• postman으로 검증 : 수동으로 확인해야 함

그래서 이를 해결하고자 unit test 코드를 작성하려고 한다.

---

테스트 환경

실제 DB에 값이 저장되면 안 되므로, Mock DB를 사용한다. 도커를 통해 Testcontainer를 띄우고 테스트하는 방법도 있으나 시간 관계상 패스한다.

기본적인 컨셉 : 비교군(StudyRoomRepository)와 대조군(Repository)를 두어 이를 비교한다.

// 비교군
let studyRoomRepository: StudyRoomRepository;

// 대조군
let repository: Repository<StudyRoom>;

1. Custom Mock Repository 주입

테스트 시작 전

1. Test.createTestingModule을 통해 테스트 모듈을 설정한다.
2. providers를 통해 비교군과 대조군의 의존성을 주입한다.
   • 비교군 : 그대로 넣는다.
   • 대조군 : 실제 DB를 사용하면 안 되므로, 기본 Repository와 StudyRoom entity에 대한 의존성을 주입한다.
     • getRepositoryToken : TypeORM에서 특정한 엔티티에 대한 레포지토리를 식별하기 위한 토큰을 의미한다. 현재 테스트 코드에서는 StudyRoomRepository를 테스트하는 것이기 때문에 해당 엔티티와 대응하는 StudyRoom에 대한 토큰을 사용한다.
     • useClass : TypeORM에서 어떤 class(현재 테스트에서는 repository에 해당한다)를 사용할 것인지 설정하는 옵션이다.
3. compile을 통해 설정한 테스트 모듈을 생성하고, 필요한 의존성을 모두 주입한다.
4. 위에서 생성된 테스트 모듈을 실제 repository에 주입한다.

let studyRoomRepository: StudyRoomRepository;
let mockRepository: jest.Mocked<Repository<StudyRoom>>;

beforeEach(async () => {
	const module: TestingModule = await Test.createTestingModule({
		providers: [
	    StudyRoomRepository,
	    {
		    provide: getRepositoryToken(StudyRoom),
	      useValue: {
		      create: jest.fn(),
		      save: jest.fn(),
	        findOne: jest.fn(),
	      },
	    },
	  ],
  }).compile();

	studyRoomRepository = module.get<StudyRoomRepository>(StudyRoomRepository);
	mockRepository = module.get<Repository<StudyRoom>>(
		getRepositoryToken(StudyRoom),
	) as jest.Mocked<Repository<StudyRoom>>;
});

• 장점
  • DB 연결 없이 빠르게 테스트 가능
  • 외부 종속성을 최소화한다.
• 단점
  • 실제 DB 동작을 검증하지는 않고, 단순 의존성 주입용이다.
  • 특정 반환값을 원한다면 mock.fn으로 설정해야 한다.
• 단위 테스트할 때 적합하다.

2. In-Memory DB Repository 주입

beforeAll(async () => {
	const module: TestingModule = await Test.createTestingModule({
		imports: [
			TypeOrmModule.forRoot({
				type: 'sqlite',
				database: ':memory:', // 메모리 데이터베이스 사용
        entities: [StudyRoom], // 엔티티 등록
        synchronize: true, // 스키마 동기화
      }),
      TypeOrmModule.forFeature([StudyRoomRepository]), // 테스트할 레포지토리 등록
      ],
    }).compile();

    studyRoomRepository = module.get<StudyRoomRepository>(StudyRoomRepository);
	});

• 장점
  • TypeORM의 실제 동작을 검증할 수 있다.
  • 메모리 내에서 작동해서 빠르고, 테스트 간 데이터 간섭이 없다.
  • TypeORM 스키마 동기화(synchronize: true)로 테이블 자동 생성 가능
• 단점
  • 설정이 복잡하다.
• 통합 테스트할 때 적합하다.

3. 원본 Repository 주입

beforeEach(async () => {
	const module: TestingModule = await Test.createTestingModule({
		providers: [DataRepository],
	}).compile();
	
	dataRepository = module.get(DataRepository);
});

• 장점
  • 실제 DB와 가장 근접한 테스트
  • TypeORM의 동작 뿐만 아니라 쿼리 실행 결과까지 확인 가능
  • 외부 데이터베이스에서의 동작을 정확히 검증
• 단점
  • 외부 DB에 의존하므로 외부 의존성이 높다.
  • 테스트 환경 설정이 복잡하다.
  • 테스트 속도가 느리다.
  • 다른 테스트와 데이터 충돌 가능성이 있다.
• End-to-End 테스트에 적합하다.

4. Testconainer 활용

beforeAll(async () => {
  const container = await new GenericContainer("mysql")
    .withExposedPorts(3306)
    .withEnv("MYSQL_ROOT_PASSWORD", "root")
    .withEnv("MYSQL_DATABASE", "test_db")
    .start();

  const port = container.getMappedPort(3306);
  const host = container.getHost();

  const module: TestingModule = await Test.createTestingModule({
    imports: [
      TypeOrmModule.forRoot({
        type: 'mysql',
        host,
        port,
        username: 'root',
        password: 'root',
        database: 'test_db',
        entities: [StudyRoom],
        synchronize: true,
      }),
      TypeOrmModule.forFeature([StudyRoomRepository]),
    ],
  }).compile();

  studyRoomRepository = module.get<StudyRoomRepository>(StudyRoomRepository);
});

• 장점
  • 실제 DB 환경에서 테스트를 수행한다.
  • 개발 환경이 달라져도, 동일한 환경에서 테스트가 가능하다.
  • 테스트 후 컨테이너가 종료되므로 깔끔한 정리가 가능하다.
• 단점
  • 컨테이너를 띄우고 관리하는 시간이 추가로 소요된다.
  • 테스트 환경 설정이 복잡하다.
• 보다 정교한 통합 테스트에 적합하다.

---

참고 문서

https://stackoverflow.com/questions/55366037/inject-typeorm-repository-into-nestjs-service-for-mock-data-testing

https://docs.nestjs.com/techniques/database

https://docs.nestjs.com/fundamentals/custom-providers

https://velog.io/@lsjbh45/Nest.jsTypeORM-Repository%EC%9D%98-%EC%9D%BC%EB%B6%80%EB%A7%8C%EC%9D%84-mocking%ED%95%B4-Custom-Repository%EC%9D%98-method%EB%93%A4-test%ED%95%98%EA%B8%B0

---

단위 테스트를 하는 이유

• Repository

  • DB와의 상호작용이 예상대로 동작하는지 확인하기 위해
  • In-memory DB나 다른 DB 의존성을 주입하여 테스트

  ⇒ 배포 환경을 모방하여 안정성과 호환성을 검증하기 위해 다른 DB를 사용

• Service

  • 비즈니스 로직이 의도한 대로 동작하는지 확인하기 위해
  • Custom Repository를 의존성 주입하여 테스트

  ⇒ Repository layer를 Mocking

• Controller

  • API 요청 및 응답이 예상대로 처리되는지 확인하기 위해
  • Custom Service를 의존성 주입하여 테스트

  ⇒ Service layer를 Mocking