Spring Boot 테스트 @DataJpaTest로 발생하는 데이터베이스 오류 해결하기

스프링 프레임워크에서 데이터베이스 관련 테스트를 진행할 때, 간혹 org.hibernate.exception.SQLGrammarException 오류가 나와서 당황할 수 있다.

그리고 해당 내용에 대한 해결과정이 블로그들에 제대로 나와있지 않아 많이 고생을 했다..

그 배경 내용에 대해

 

같이 공부해면서 오류에 대해 파악해보자!

---

 

이 오류는 데이터베이스에 필요한 시퀀스나 테이블이 존재하지 않을 때 주로 발생하는데
특히, @DataJpaTest를 사용하여 JPA 구성 요소를 테스트하는 경우,
테스트 환경 설정이 올바르게 이루어지지 않았을 때 이러한 문제가 발생한다.

우선 @DataJpaTest 에대해 알아보도록 해보자.

DataJpaTest란?

@DataJpaTest는 Spring Boot에서 JPA 관련 구성 요소를 테스트할 때 사용하는 주요 어노테이션입니다. 이 어노테이션은 테스트 중인 JPA 구성 요소만을 로드하며, 임베디드 데이터베이스를 사용해 데이터베이스와 독립적인 테스트를 가능하게 한다.

발생 가능한 오류 시나리오

1. 시퀀스 누락 오류:이 오류는 @GeneratedValue 어노테이션으로 ID를 관리할 때 필요한 시퀀스가 데이터베이스에 생성되어 있지 않을 경우 발생한다. 
   org.hibernate.exception.SQLGrammarException: could not prepare statement [Sequence "FRANCHISE_SEQ" not found; SQL statement: select next value for franchise_seq [90036-214]] [select next value for franchise_seq]
2. 테이블 누락 오류:이 오류는 테스트 중 필요한 데이터베이스 테이블이 존재하지 않을 때 나타난다.
   org.hibernate.exception.SQLGrammarException: could not prepare statement [Table "FRANCHISE" not found (this database is empty); SQL statement: /* insert for enha.eodilo.domain.Franchise *]

시퀀스 누락 오류 화면

테이블 누락 오류 화면

데이터베이스 전략에 따른 다른 오류 발생

H2 데이터베이스를 사용하는 경우, @GeneratedValue에 별도의 전략(strategy)을 지정하지 않으면 기본값으로 시퀀스를 사용한다.

만약 전략을 IDENTITY로 설정하거나, MySQL 같은 다른 데이터베이스의 기본 전략을 사용할 경우, 테이블이 존재하지 않아 Table not found 오류가 발생할 수 있다.

이러한 문제는 테스트 시 JPA가 자동으로 테이블을 생성하지 않을 때 발생하며, 특히 ddl-auto가 none이나 validate로 설정된 경우 발생하게 된다.

해당내용은 아래 포스팅 참조

https://jakezo.tistory.com/44

즉, @GeneratedValue 사용시

strategy 가 SEQUENCE 면 1번인 시퀀스 누락 오류가 발생하고
strategy 가 IDENTITY 면 2번인 테이블 누락 오류가 발생한다는 뜻,

전략설정(h2는 기본값이 sequence다)

이제 해당 오류에 대해 해결법을 알아보도록 하겠습니다.

1. SQL 스크립트, Flyway, Liquibase 등을 사용하여 테스트 실행 전에 스키마를 준비

SQL 스크립트 사용하기 예시

저의 경우에는 SQL 스크립트로 예시를 만들어 보았습니다.
Spring Boot 프로젝트에서는 src/main/resources 디렉토리 아래에 schema.sql 파일을 두고 이 파일에 테이블 생성 쿼리를 작성할 수 있습니다. 테스트 환경에서는 src/test/resources에 schema.sql을 두어 테스트 전용 스키마를 설정할 수 있습니다.예를 들어, 다음과 같은 schema.sql을 사용할 수 있습니다.

CREATE TABLE franchise ( 
franchise_id BIGINT AUTO_INCREMENT PRIMARY KEY, 
admin_id BIGINT, 
name VARCHAR(255), 
kind VARCHAR(255),
...
);

DROP SEQUENCE IF EXISTS franchise_SEQ;  
CREATE SEQUENCE franchise_SEQ INCREMENT BY 50;

2. @DataJpaTest에 properties 설정 추가

테스트 어노테이션에 직접 프로퍼티를 추가하여, 테스트 중 ID 생성 전략 등을 변경할 수 있습니다.

@DataJpaTest(properties = { "spring.jpa.hibernate.ddl-auto=update"})

3. 테스트 전용 application.yml 설정

spring:
    jpa:  
      hibernate:  
        ddl-auto: update

ddl-auto 를 none이나 validate 가 아닌 값으로 변경한다.

이 방법들을 통해, 테스트 환경에서 @GeneratedValue 어노테이션이 적용된 엔티티의 ID가 올바르게 관리되며, 필요한 데이터베이스 테이블과 시퀀스가 존재하지 않는 문제를 사전에 방지할 수 있습니다.