[Trouble Shooting] ItemTest 테스트코드 관련 트러블 슈팅

이번 플러스주차 개인과제는 지금까지 배운 JPA심화, 테스트 코드, 성능최적화 개념들을 기반으로 진행되었다.

 

과제를 진행하던 중 테스트 코드 실행 과정에서 발생한 문제를 해결한 내용을 정리해보고자 한다.

 

[Github 링크]

 

---

1. 문제 상황

📍 ItemTest 클래스에서 예외 발생 테스트 실패

item.setStatus(null);

- ItemTest 클래스에서 status 필드를 null로 설정하면 PersistenceException이 발생할 것으로 예상했다.

- 하지만 테스트 실행 결과, AssertionError가 발생했다.[더보기 참고]

😢 [문제 코드] : ItemTest 클래스

@DataJpaTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
class ItemTest {

    @Autowired
    private ItemRepository itemRepository;

    @Test
    @DisplayName("status 값이 null일 경우 예외 발생 확인 ")

    // status 값이 없는 경우 테스트 진행
    void statusIsEmpty_shouldFail() {
        Item item = new Item();
        item.setName("Test Item");
        item.setDescription("Test Description");
        item.setStatus(null);

        // 어떤 코드가 실행될 때 에러가 발생하는지 확인
        assertThatThrownBy(() -> itemRepository.saveAndFlush(item))
                .isInstanceOf(PersistenceException.class);

    }

 

🚨 [에러 메세지] 테스트 실행 결과

java.lang.AssertionError: 
Expecting code to raise a throwable.

 

 

---

2. 원인 분석

1) Hibernate의 기본값 설정 문제

- Item 클래스의 status 필드는 다음과 같이 설정되어 있었다.

@Column(nullable = false, columnDefinition = "varchar(20) default 'PENDING'")
private String status;

❓ 문제점

- @Column(생략....)은 데이터베이스 테이블을 생성할 때 적용되는 SQL 제약조건이다.

-  Hibernate나 JPA는 기본값을 적용하지 않는다.

- 따라서, status 필드값은 null이 설정된 상태 그대로 데이터베이스에 전달되어 PersistenceException이 발생하지 않고 그대로 전달되었다.

 

2) @DataJpaTest의 특성 간과

- @DataJpaTest는 JPA Repository기능을 테스트하는데 최적화된 어노테이션이다.

- 하지만, 데이터베이스의 제약조건을 검증하는 것이 아닌 직접 SQL을 실행을 검증하기에는 적합하지 않았다.

---

3. 해결방안

ItemTest 클래스에서 JPA Repository를 사용해 status 필드에 null 값을 설정한 뒤 예외가 발생하는지 검증하려고 했다.

하지만 Repository 테스트만으로는 데이터베이스의 제약 조건 위반 여부를 명확하게 테스트하기 어려워

이를 해결하기 위해 JPQL로 쿼리를 직접 실행하는 ItemJPQLTest 클래스를 새로 생성하여 진행했다.

 

 ItemJPQLTest 클래스는 EntityManager를 사용하여 status 필드를 강제로 null로 설정하는 JPQL 쿼리를 작성하고 실행했다.

강제로 null을 설정했기 때문에 NOT NULL 제약 조건이 작동하여 예외가 발생하는지 정확하게 검증할 수 있었다.

// 강제 null 적용
assertThatThrownBy(() -> {
    int updatedCount = entityManager.createQuery(
                    "UPDATE Item i SET i.status = null WHERE i.id = :id")
            .setParameter("id", item.getId())
            .executeUpdate();  //  쿼리 실행

}).isInstanceOf(PersistenceException.class);

 

📎 JPQL과 EntityManager을 사용한 이유는?

위에서 말했듯이 Hibernate가 Repository를 통해 저장할 때 기본값이나 제약 조건을 적용하지 않기 때문이다.

때문에 직접 쿼리를 실행해야 NOT NULL과 같은 제약 조건이 제대로 작동하는지 확인할 수 있을 것 같았다.

🙂 [성공 코드] : ItemJPQLTest 클래스

@ActiveProfiles("test")
@SpringBootTest
@Transactional
class ItemJPQLTest {

    @PersistenceContext
    private EntityManager entityManager;

    @Test
    @DisplayName("JPQL UPDATE를 이용하여 status를 null로 설정시 예외 발생 확인")
    void updateStatusToNull_shouldNull() {
        Item item = new Item();
        item.setName("Test Item");
        item.setDescription("Test Description");
        item.setStatus("ACTIVE");

        entityManager.persist(item);
        entityManager.flush();      // 강제 반영

        // 강제 null 적용
        assertThatThrownBy(() -> {
            int updatedCount = entityManager.createQuery(
                            "UPDATE Item i SET i.status = null WHERE i.id = :id")
                    .setParameter("id", item.getId())
                    .executeUpdate();  //  쿼리 실행

        }).isInstanceOf(PersistenceException.class);

        }
    }

---

4. 결과

PersistenceException이 정상적으로 작동하여 테스트가 통과되었다.

 

---

5. 배울 점

아... 처음에 테스트코드 특강을 보고 무작정 @DataJpaTest를 사용했고, JPA Repository 테스트에 특화된 어노테이션이라고 한다.(첫 단추부터 잘못 맞췄던 것이다.)

@DataJpaTest 어노테이션은 데이터베이스와의 상호작용을 최소화하고 Repository 기능만 검증하는데 주로 사용된다고 한다.

 

EntityManager와 JPQL을 사용하면 데이터베이스 레벨에서의 제약 조건 검증을 명확히 테스트할 수 있었다.