테스트를 위해 정의했던 Public 메서드

테스트를 위해 정의했던 Public 메서드

Service 레이어에 대한 테스트 코드를 작성을 위해 Mockito 라이브러리를 활용했다.

협력 객체인 Repository 레이어에 대한 Stubbing을 진행했는데, 실제 데이터베이스에서 저장된 후 반환되는 것이 아니기 때문에 실제 저장되어 있던 것처럼 구성을 해야했다.

이때, 주로 고민이 된던 것은 'Entity에 id는 어떻게 설정해줘야 하는 것인가?' 였다.

누구나 고민이 되는 내용이지 않을까.. 싶다.

아래는 게시글을 저장할 때, 필수로 포함되어야하는 카테고리 Entity 이다.

// Category.java

@Entity
public class Category {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;

    public Category(String name) {
        this.name = name;
    }
}

Category 객체는 카테고리가 저장될 때, 고유 식별자가 자동적으로 생성되어 저장된다.(GenerationType.IDENTITY 속성을 통해 고유 식별자 생성을 데이터베이스에 위임했다.)

또한, Setter메서드와 생성자를 열어두지도 않았으므로 개발자가 임의로 고유 식별자는 지정할 수 없다.

그러나, 도입부에 언급했듯이 Repository를 Stubbing하기 위해 실제 데이터베이스에 저장되어 있던 처럼 구성해야한다고 했다.

아래와 같이 id 필드를 임의로 설정할 수 없는데, 어떻게 해야할까?

Category 일번_카테고리 = new Category("DAILY"); // 가능

Category 이번_카테고리 = new Category(1L, "DAILY"); // 불가능

우선, 내가 알고있었던 방법은 두가지이다.

1. Setter 메서드 정의
2. id를 인자로 받는 생성자 정의

필자가 Stubbing 했던 방법

게시글 서비스(PostService) 레이어에서 게시글을 저장하는 비즈니스 로직이 다음과 같은 프로세스라고 가정해보자.

1. 게시글을 작성한 사용자 번호에 해당하는 사용자를 데이터베이스에서 조회(MemberRepository)
2. 게시글에 설정된 카테고리 번호에 해당하는 카테고리를 데이터베이스에서 조회(CategoryRepository)
3. 게시글 저장(PostRepository)

3가지 협력 객체 중 Stubbing 해야하는 객체는 1번과 2번에서 사용된 Repository 객체이다.

그렇다면, 테스트 코드에서 사전에 아래와 같이 Stubbing 하면된다.

// ServiceMockTest.java

@BeforeEach
void 사전_스텁_설정() {
    Long 사용자_번호 = 1L;
    Long 카테고리_번호 = 1L;

    Member 사용자 = new Member("홍길동", "gildong@test.com");
    Category 카테고리 = new Poat("DAILY");

    사용자.updateId(사용자_번호);
    카테고리.updateId(카테고리_번호);

    when(memberRepository.findById(사용자_번호)).thenReturn(Optional.of(사용자));
    when(categoryRepository.findById(카테고리_번호)).thenReturn(Optional.of(카테고리));
}

위처럼 id를 인자로 받는 생성자를 따로 열어주지 않았으니, Entity 객체에 updateId 메서드를 정의해줘야 한다.

@Entity
public class Category {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;

    public Post updateId(Long id) {
        this.id = id;
        return this;
    }
}

테스트를 위한 public 메서드를 만들면서, Stubbing 했었고 굉장히 찝찝했었다.

리뷰어님께 이에 대해서 의견을 부탁드렸고, ReflectionTestUtils을 추천해주셨다.

제 생각을 말씀드리면, Test 만을 위해 public 메소드를 만드는 것은 최대한 지양해야 된다고 생각합니다.
특히나 JPA 같이 ID 라는 식별자를 중요하게 다루는 시스템에 ID 를 수정해도 될 것 같은 메소드를 열어두는 것 좋지 않다고 생각해요 😅

따라서, 테스트만을 위해 public 메서드를 만들지 않으면서 어떻게 Stubbing할 수 있을까? 라는 고민을 하고 있다면 아래와 같이 사용하면 된다.

@BeforeEach
void 사전_스텁_설정() {
    Long 사용자_번호 = 1L;
    Long 카테고리_번호 = 1L;

    Member 사용자 = new Member("홍길동", "gildong@test.com");
    Category 카테고리 = new Poat("DAILY");

    ReflectionTestUtils.setField(사용자, "id", 사용자_번호);
    ReflectionTestUtils.setField(카테고리, "id", 카테고리_번호);

    사용자.updateId(사용자_번호);
    카테고리.updateId(카테고리_번호);

    when(memberRepository.findById(사용자_번호)).thenReturn(Optional.of(사용자));
    when(categoryRepository.findById(카테고리_번호)).thenReturn(Optional.of(카테고리));
}