[삽질록] Spring Security 인증 구현 하고 insert 테스트 오류 (AuditorAware)

🆘 문제상황

spring security로 인증을 구현 후 기존의 Test를 돌렸더니 insert 에서 에러가 발생했다.

기존 코드

/*
단위 테스트에서는 spring 컨테이너를 사용하면 안된다.
@DataJpaTest: repository 객체를 의존주입 받을 수 있게 해준다. | @Transactional 을 갖고있어서 테스트 이후 자동 롤백 가능
 */
@DisplayName("JPA 연결 테스트")
@Import(JpaConfig.class)
@DataJpaTest
public class JpaRepositoryTest {

    @Autowired private PostRepository postRepository;
    @Autowired private PostCommentRepository postCommentRepository;
    @Autowired private HashtagRepository hashtagRepository;
    @Autowired private LikeRepository likeRepository;
    @Autowired private PostHashtagRepository postHashtagRepository;
    @Autowired private UserAccountRepository userAccountRepository;

    @PersistenceContext
    private EntityManager entityManager;

    @DisplayName("insert 테스트")
    @Test
    void givenTestData_whenInserting_thenWorksFine() {
        // Given
        long previousCnt = postRepository.count();
        String username = "ella";
        UserAccount userAccount = userAccountRepository.findById(username).orElseThrow();
        Post post = Post.of(userAccount, "new post", "new content");

        // When
        postRepository.save(post);

        // Then
        assertThat(postRepository.count()).isEqualTo(previousCnt + 1);
    }
}

@EnableJpaAuditing // @EnableJpaAuditing: JPA Auditing(감사 기능)을 활성화 -> 엔티티가 생성되거나 수정될 때, 자동으로 날짜와 시간을 기록해준다.
@Configuration
public class JpaConfig {
    @Bean
    public AuditorAware<String> auditorAware() {
        //return () -> Optional.of("ella"); 
        // 기존코드였는데 spring security 적용 후 아래와 같이 변경됨     
    
        return () -> Optional.ofNullable(SecurityContextHolder.getContext())
                .map(SecurityContext::getAuthentication)
                .filter(Authentication::isAuthenticated)
                .map(Authentication::getPrincipal)
                .map(BoardPrincipal.class::cast) // .map(x -> (BoardPrincipal)x)
                .map(BoardPrincipal::getUsername);
    }
}

문제 원인

JpaConfig 의 AuditorAware<String>

: 현재 감사를 수행하는 사람(감사자)의 이름을 제공하는 인터페이스
: 감사를 수행하는 사람의 정보를 제공함으로써 누가 데이터를 생성하고 수정했는지 기록할 수 있다.

→ 스프링 시큐리티로 인증 기능을 붙이면서 해당 부분이 변경됨
→ @DataJpaTest는 기본적으로 JPA와 관련된 설정만 로드하고, Spring Security와 관련된 빈이나 설정은 기본적으로 포함되지 않는다!

⇒ SecurityContextHolder를 사용하는 코드가 @DataJpaTest 환경에서 실행될 때 보안 컨텍스트(SecurityContext)가 제대로 설정되지 않음
⇒ AuditorAware에서 보안 컨텍스트를 참조하는 코드는 null 값을 반환함

 

✅ 해결

단순히 JPA 기능을 테스트하려는 경우이므로,
@DataJpaTest에서 보안 컨텍스트에 의존하지 않는 코드를 사용하자

→ jpa에서 오디팅에서 security로부터의 영향에서 자유로워질 수 있게
따로 auditorAware를 테스트 전용 config로 등록해서 사용하자

1. @Import(JpaConfig.class) → @Import(JpaRepositoryTest.TestJpaConfig.class)
2. TestJpaConfig를 아래에 추가

/*
단위 테스트에서는 spring 컨테이너를 사용하면 안된다.
@DataJpaTest: repository 객체를 의존주입 받을 수 있게 해준다. | @Transactional 을 갖고있어서 테스트 이후 자동 롤백 가능
 */
@DisplayName("JPA 연결 테스트")
@Import(JpaRepositoryTest.TestJpaConfig.class) //📌📌📌
@DataJpaTest
public class JpaRepositoryTest {

    @Autowired private PostRepository postRepository;
    @Autowired private PostCommentRepository postCommentRepository;
    @Autowired private HashtagRepository hashtagRepository;
    @Autowired private LikeRepository likeRepository;
    @Autowired private PostHashtagRepository postHashtagRepository;
    @Autowired private UserAccountRepository userAccountRepository;

    @PersistenceContext
    private EntityManager entityManager;

    @DisplayName("insert 테스트")
    @Test
    void givenTestData_whenInserting_thenWorksFine() {
        // Given
        long previousCnt = postRepository.count();
        String username = "ella";
        UserAccount userAccount = userAccountRepository.findById(username).orElseThrow();
        Post post = Post.of(userAccount, "new post", "new content");

        // When
        postRepository.save(post);

        // Then
        assertThat(postRepository.count()).isEqualTo(previousCnt + 1);
    }
    // 📌📌📌
    // insert test시 auditing 무시하도록
    @EnableJpaAuditing
    @TestConfiguration // 빈으로 등록하되, 테스트할때만 빈으로 등록해라
    // jpa에서 오디팅에서 security로부터의 영향에서 자유로워질 수 있게 따로 auditorAware를 테스트 전용 config로 등록해서 사용
    static class TestJpaConfig {
        @Bean
        AuditorAware<String> auditorAware() {
            return () -> Optional.of("ella");
        }
    }
}