Be/feature/#496 채팅 모듈 e2e 테스트

[kimyu0218]

resolved #496

변경 사항

• 채팅 모듈 단위 테스트 - 로그인 기능 추가로 서비스 전폭 수정
• 타로 모듈 e2e 테스트 - sqlite 메모리 DB를 이용하도록 리팩토링
• 채팅 모듈 e2e 테스트 - sqlite 메모리 DB와 쿠키 파서를 이용하여 구현

고민과 해결 과정

메모리 DB를 이용한 e2e 테스트

단위 테스트를 진행하면서도 레포지토리를 모킹하는 게 마음에 걸렸다. 모킹 함수를 만들어 실제 데이터베이스에 접근하지 못하도록 구현했지만, 레포지토리에서 무조건 특정 리턴값을 반환하도록 만드는 것이 결국 실제 로직과 다를 수 있다는 생각이 떠나지 않았다.

이번에 e2e 테스트를 진행하면서 메모리 DB를 도입했는데 모듈에 mysql가 아닌 sqlite를 연결해줌으로써 레포지토리를 모킹할 필요가 없어졌다. 메모리 DB이기 때문에 DB를 열심히 조작해도 실제 DB에 반영되지 않기 때문이다.

테스트 DB가 아닌 메모리 DB를 사용한 이유

- 메모리 DB는 디스크보다 I/O 작업 속도가 빠르기 때문에 테스트 시간을 단축할 수 있다
- 테스트 간 데이터베이스가 완전히 격리되므로 한 테스트에서 조작한 데이터가 다른 테스트에 영향을 미치지 않는다
- 별도의 설치나 설정 없이 사용할 수 있다  

ChatModule은 다음과 같이 구성되어 있다. (TypeORM의 데이터베이스 연결 부분은 AppModule에서 이루어지고 있다.)

@Module({
  imports: [TypeOrmModule.forFeature([ChattingRoom, ChattingMessage, Member])],
  controllers: [ChatController],
  providers: [ChatService],
})
export class ChatModule {}

모듈별로 e2e 테스트를 진행할 예정이므로 테스트 모듈에 데이터베이스 연결 과정을 넣었다. 그 외의 설정들은 ChatModule과 동일하게 작성했다. 메모리 DB를 연결해줬기 때문에 테스트 모듈에서 데이터베이스를 조작해도 실제 DB에 반영되지 않는다.

beforeAll(async () => {
  const moduleRef = await Test.createTestingModule({
    imports: [
      TypeOrmModule.forRoot({
        type: 'sqlite',
        database: ':memory:',
        entities: [__dirname + '/../src/**/entities/*.entity.{js,ts}'],
        synchronize: true,
      }),
      TypeOrmModule.forFeature([ChattingRoom, ChattingMessage, Member]),
    ],
    providers: [ChatService, JwtAuthGuard, JwtStrategy],
    controllers: [ChatController],
  }).compile();

  app = moduleRef.createNestApplication();
  ...
  await app.init();
});

필요한 데이터는 beforeAll이나 beforeEach로 쌓아주기

모듈별로 필요한 테스트 데이터들은 TypeORM의 Entity Manager를 이용하여 미리 데이터베이스에 추가해줬다.

entityManager = moduleRef.get(EntityManager);

const member: Member = new Member();
member.email = '[email protected]';
member.providerId = PROVIDER_ID.KAKAO;
await entityManager.save(member); // 멤버 데이터 쌓기

const room: ChattingRoom = new ChattingRoom();
room.id = id;
room.participant = member;
savedRoom = await entityManager.save(room); // 방 데이터 쌓기 

(선택) 테스트 결과

ChatService 단위 테스트 전폭 수정	TarotModule e2e 테스트 리팩토링	ChatModule e2e 테스트 작성

[cloudflare-workers-and-pages]

Deploying with    Cloudflare Pages

Latest commit:	aa47c9e
Status:	✅  Deploy successful!
Preview URL:	https://39e89a05.web09-magicconch.pages.dev
Branch Preview URL:	https://be-feature--496-------e2e.web09-magicconch.pages.dev

View logs

[kimyu0218]

💬 여기서 사용한 scenario는 스크럼 때 공유한 시나리오랑은 달라!! 아직 scenario를 반영해서 수정하진 않았어. e2e 테스트 다 작성한 후에 리팩토링 해보려구!!

[Doosies]

💬 e2e테스트를 진행할 때 메모리DB를 안쓸이유가 없네!! 👍 👍