2025년 2월 6일

TIL: NestJS 댓글 서비스 유닛 테스트

오늘은 NestJS의 CommentsService 유닛 테스트를 작성했다.
NestJS의 @nestjs/testing 모듈을 활용하여 댓글 생성, 조회, 수정, 삭제 기능을 검증하는 테스트 코드를 작성했다.

---

1. 테스트 환경 설정 (beforeEach & afterEach)

• Test.createTestingModule()을 이용해 테스트용 모듈을 생성하고 CommentsService를 주입했다.
• getRepositoryToken(Comment)을 이용해 TypeORM 레포지토리를 주입했고, Jest의 mock 기능을 활용해 가짜(repository) 데이터를 만들었다.
• 각 테스트 실행 후 jest.clearAllMocks()를 호출하여 모든 Mock 데이터를 초기화했다.

---

2. 댓글 생성 테스트 (createComment)

✅ 성공 케이스:

• mockCommentRepository.create()와 mockCommentRepository.save()를 사용하여 댓글을 생성한 후,
• 생성된 댓글이 정확하게 저장되고 반환되는지 검증했다.

✅ 예외 처리 케이스:

• 댓글이 비어 있을 경우 (EmptyCommentException), 예외가 발생해야 한다.
• 댓글이 50자를 초과할 경우 (CommentLengthExceededException), 예외가 발생해야 한다.

---

3. 댓글 조회 테스트 (getCommentById)

✅ 성공 케이스:

• 특정 id로 댓글을 조회하면 올바른 데이터를 반환하는지 확인했다.

✅ 예외 처리 케이스:

• 존재하지 않는 댓글을 조회할 경우, CommentNotFoundException 예외가 발생해야 한다.

---

4. 댓글 수정 테스트 (updateComment)

✅ 성공 케이스:

• 기존 댓글의 내용을 변경하면, 업데이트된 내용이 올바르게 반영되는지 확인했다.

✅ 예외 처리 케이스:

• 댓글 작성자가 아닌 사용자가 댓글을 수정하려 하면, CommentPermissionException 예외가 발생해야 한다.

---

5. 댓글 삭제 테스트 (deleteComment)

✅ 성공 케이스:

• mockCommentRepository.delete()를 호출하여 정상적으로 댓글이 삭제되는지 확인했다.

✅ 예외 처리 케이스:

• 존재하지 않는 댓글을 삭제하려 하면 CommentPermissionException 예외가 발생해야 한다.

---

오늘 배운 점

1. NestJS에서 유닛 테스트를 설정하는 방법 (TestingModule, getRepositoryToken).
2. Jest의 mock 기능을 활용하여 TypeORM 레포지토리를 가짜(mock) 데이터로 대체하는 방법.
3. 예외 처리를 검증하는 테스트 코드 (rejects.toThrow).
4. CRUD 기능을 테스트할 때 주요 검증 포인트 (정상 동작 + 예외 케이스).

NestJS에서 서비스 로직을 안전하게 개발하려면 유닛 테스트가 필수라는 점을 다시 한 번 깨달았다.
앞으로도 다양한 유닛 테스트를 작성하며 테스트 커버리지를 높이는 방법을 익혀야겠다!

---

import { Test, TestingModule } from '@nestjs/testing'; // NestJS의 테스트 모듈을 가져옴
import { CommentsService } from './comments.service'; // 테스트할 CommentsService 가져옴
import { getRepositoryToken } from '@nestjs/typeorm'; // TypeORM에서 레포지토리를 주입받기 위한 getRepositoryToken 사용
import { Comment } from './entities/comment.entity'; // 댓글 엔티티(Comment) 가져옴
import {
  CommentNotFoundException,
  CommentPermissionException,
  EmptyCommentException,
  CommentLengthExceededException,
} from 'src/common/exceptions/comment.exception'; // 댓글 관련 예외 가져옴

// CommentsService의 유닛 테스트를 작성하는 블록
describe('댓글 서비스(CommentsService)', () => {
  let service: CommentsService; // CommentsService 인스턴스

  // CommentsService에서 사용할 가짜(mock) 댓글 저장소(repository) 생성
  const mockCommentRepository = {
    create: jest.fn(), // 댓글 생성 함수 mock
    save: jest.fn(), // 댓글 저장 함수 mock
    findBy: jest.fn(), // 여러 개의 댓글을 조회하는 함수 mock
    findOneBy: jest.fn(), // 단일 댓글 조회 함수 mock
    update: jest.fn(), // 댓글 수정 함수 mock
    delete: jest.fn(), // 댓글 삭제 함수 mock
  };

  // 각 테스트 실행 전 초기화 작업 수행
  beforeEach(async () => {
    const module: TestingModule = await Test.createTestingModule({
      providers: [
        CommentsService, // 테스트할 서비스 주입
        {
          provide: getRepositoryToken(Comment), // Comment 엔티티의 레포지토리 주입
          useValue: mockCommentRepository, // mockCommentRepository를 사용하여 가짜 데이터 주입
        },
      ],
    }).compile();

    service = module.get<CommentsService>(CommentsService); // 서비스 인스턴스 가져오기
  });

  // 각 테스트 실행 후 모든 mock을 초기화
  afterEach(() => {
    jest.clearAllMocks();
  });

  // 댓글 생성 테스트
  describe('createComment (댓글 생성)', () => {
    it('댓글을 정상적으로 생성해야 한다.', async () => {
      const cardId = 1;
      const userId = 1;
      const content = 'Test comment'; // 생성할 댓글 내용
      const createdComment = { id: 1, cardId, userId, content }; // 예상 결과

      mockCommentRepository.create.mockReturnValue(createdComment); // mock 데이터 반환 설정
      mockCommentRepository.save.mockResolvedValue(createdComment); // 저장 후 반환할 데이터 설정

      const result = await service.createComment(cardId, userId, content); // 댓글 생성 실행

      expect(mockCommentRepository.create).toHaveBeenCalledWith({
        cardId,
        userId,
        content,
      }); // create 함수가 올바르게 호출되었는지 확인
      expect(mockCommentRepository.save).toHaveBeenCalledWith(createdComment); // save 함수가 올바르게 호출되었는지 확인
      expect(result).toEqual(createdComment); // 결과가 예상과 일치하는지 검증
    });

    it('댓글 내용이 비었을 때 예외가 발생해야 한다.', async () => {
      await expect(service.createComment(1, 1, '')).rejects.toThrow(
        EmptyCommentException,
      ); // 빈 댓글 예외 발생 검증
    });

    it('댓글 내용이 50자를 초과할 경우 예외가 발생해야 한다.', async () => {
      const longContent = 'a'.repeat(51); // 51자 이상 입력
      await expect(service.createComment(1, 1, longContent)).rejects.toThrow(
        CommentLengthExceededException,
      ); // 길이 초과 예외 검증
    });
  });

  // 특정 ID의 댓글 조회 테스트
  describe('getCommentById (댓글 단건 조회)', () => {
    it('ID로 댓글을 조회해야 한다.', async () => {
      const comment = { id: 1, cardId: 1, userId: 1, content: 'Test' }; // 예상되는 댓글 데이터
      mockCommentRepository.findOneBy.mockResolvedValue(comment); // 댓글 조회 mock 데이터 설정

      const result = await service.getCommentById(1); // 댓글 조회 실행

      expect(mockCommentRepository.findOneBy).toHaveBeenCalledWith({ id: 1 }); // findOneBy가 올바르게 호출되었는지 검증
      expect(result).toEqual(comment); // 결과 검증
    });

    it('댓글이 존재하지 않으면 예외가 발생해야 한다.', async () => {
      mockCommentRepository.findOneBy.mockResolvedValue(null); // 댓글이 없을 경우
      await expect(service.getCommentById(1)).rejects.toThrow(
        CommentNotFoundException,
      ); // 예외 발생 검증
    });
  });

  // 댓글 수정 테스트
  describe('updateComment (댓글 수정)', () => {
    it('댓글을 정상적으로 수정해야 한다.', async () => {
      const comment = { id: 1, userId: 1, content: 'Old Comment' }; // 기존 댓글 데이터
      mockCommentRepository.findOneBy.mockResolvedValue(comment); // 기존 댓글 조회 설정
      mockCommentRepository.update.mockResolvedValue({}); // 업데이트 실행
      mockCommentRepository.findOneBy.mockResolvedValue({
        ...comment,
        content: 'Updated Comment',
      }); // 업데이트 후 데이터 반환

      const result = await service.updateComment(1, 1, 'Updated Comment'); // 댓글 수정 실행

      expect(mockCommentRepository.update).toHaveBeenCalledWith(
        { id: 1 },
        { content: 'Updated Comment' },
      ); // update 함수가 올바르게 호출되었는지 확인
      expect(result).toEqual({ ...comment, content: 'Updated Comment' }); // 결과 검증
    });

    it('댓글 작성자가 아니면 수정할 수 없어야 한다.', async () => {
      const comment = { id: 1, userId: 2, content: 'Old Comment' }; // 다른 사용자의 댓글
      mockCommentRepository.findOneBy.mockResolvedValue(comment);
      await expect(
        service.updateComment(1, 1, 'Updated Comment'),
      ).rejects.toThrow(CommentPermissionException); // 권한 예외 검증
    });
  });

  // 댓글 삭제 테스트
  describe('deleteComment (댓글 삭제)', () => {
    it('댓글을 정상적으로 삭제해야 한다.', async () => {
      const comment = { id: 1, userId: 1, content: 'To be deleted' }; // 삭제할 댓글
      mockCommentRepository.findOneBy.mockResolvedValue(comment); // 댓글 조회 mock 설정
      mockCommentRepository.delete.mockResolvedValue({}); // 삭제 실행 mock 설정

      const result = await service.deleteComment(1, 1); // 댓글 삭제 실행

      expect(mockCommentRepository.delete).toHaveBeenCalledWith({ id: 1 }); // delete 함수가 올바르게 호출되었는지 확인
      expect(result).toEqual({ id: 1, message: '삭제되었습니다.' }); // 삭제 결과 검증
    });

    it('존재하지 않는 댓글을 삭제하려 하면 예외가 발생해야 한다.', async () => {
      mockCommentRepository.findOneBy.mockResolvedValue(null); // 존재하지 않는 댓글
      await expect(service.deleteComment(1, 1)).rejects.toThrow(
        CommentPermissionException,
      ); // 예외 검증
    });
  });
});