Spring Security 테스트 문제 - WithSecurityContextFactory

[f1v3-dev]

문제 원인

• Controller Layer 에서 JwtAuthenticationFiler 를 통해 SecurityContextHolder 에 넣어준 값을 사용 (@AuthenticationPrincipal)
• 하지만, 테스트 코드의 경우 JwtAuthenticationFiler 를 거치지 않아 문제가 발생함.
• 어떤 API를 호출하든 302 REDIRECT 로 로그인 페이지로 보내지게 되는 문제가 발생함.

어떻게 해결할 수 있을까?

접근방법 1. 직접 값을 넣어주기

• 회원 정보가 필요하는 컨트롤러일 경우 테스트하기 전, SecurityContextHolder에 값을 넣어주는 방식

기존에 이와 같이 해결하려 하였으나, 중복된 코드가 많이 발생하여 간단하게 해결하고 싶어 적용하지 않음.

접근방법 2. @WithMockUser

• 가장 간단한 방법으로, UserDetails 객체를 만들어 줄 수 있음.
• username, password, roles 에 관한 정보를 가짜 객체(Mock) 으로 만들어줌.

하지만, 프로젝트의 Member는 UserDetails 를 상속하지 않아 다른 방식으로 SecurityContextHolder 에 값을 넣어줘야 함.

접근방법 3. WithSecurityContextFactory

• 테스트에서 사용할 어노테이션을 만들어 테스트 코드에 Mock User 를 넣어주는 방식

문제 해결

위의 3가지 방식 중 3번 방식을 통해 어노테이션을 만들고, 회원에 대한 정보를 넣어주는 방식으로 적용하였습니다.

JjakkakMockUser.java

/**
 * MockUser 어노테이션입니다.
 *
 * @author 정승조
 * @version 2024. 08. 05.
 */
@Retention(RetentionPolicy.RUNTIME)
@WithSecurityContext(factory = JjakkakMockSecurityContext.class)
public @interface JjakkakMockUser {

    String nickname() default "seungjo";

    long kakaoId() default 1234567890;
}

JjakkakMockSecurityContext.java

/**
 * 테스트에서 사용할 MockUser 어노테이션에 SecurityContext 값을 설정하는 클래스입니다.
 *
 * @author 정승조
 * @version 2024. 08. 05.
 */
/**
 * 테스트에서 사용할 MockUser 어노테이션에 SecurityContext 값을 설정하는 클래스입니다.
 *
 * @author 정승조
 * @version 2024. 08. 05.
 */
@RequiredArgsConstructor
public class JjakkakMockSecurityContext implements WithSecurityContextFactory<JjakkakMockUser> {

    private final MemberRepository memberRepository;


    @Override
    public SecurityContext createSecurityContext(JjakkakMockUser annotation) {

        Member member = Member.builder()
                .memberNickname(annotation.nickname())
                .kakaoId(annotation.kakaoId())
                .build();

        memberRepository.save(member);

        SimpleGrantedAuthority role = new SimpleGrantedAuthority("ROLE_USER");
        UsernamePasswordAuthenticationToken authToken = new UsernamePasswordAuthenticationToken(member.getMemberId(), null, List.of(role));

        SecurityContext context = SecurityContextHolder.createEmptyContext();
        context.setAuthentication(authToken);

        return context;
    }
}

이렇게 테스트용 SecurityContext를 만들어 MockUser를 만드는 방식으로 사용하였습니다.

테스트 예시

카테고리 조회 테스트

    @Test
    @DisplayName("카테고리 단건 조회 - 성공")
    @JjakkakMockUser
    void get_success() throws Exception {

        // given (1L, "학교")
        when(categoryService.getCategory(anyLong())).thenReturn(CategoryDummy.getCategoryResponseDto());

        // expected
        mockMvc.perform(get("/api/v1/categories/{id}", 1L))
                .andExpectAll(
                        status().isOk(),
                        jsonPath("$.categoryId").value(1),
                        jsonPath("$.categoryName").value("학교")
                )
                .andDo(restDocs.document(
                        pathParameters(
                                parameterWithName("id").description("카테고리 아이디")),
                        responseFields(
                                fieldWithPath("categoryId").description("카테고리 아이디"),
                                fieldWithPath("categoryName").description("카테고리 이름")
                        )
                ));
    }

---

더 나아가서

WithSecurityContextFactory 인터페이스 내부를 살펴보면

package org.springframework.security.test.context.support;

import java.lang.annotation.Annotation;

import org.springframework.security.core.context.SecurityContext;
import org.springframework.security.test.context.TestSecurityContextHolder;

/**
 * An API that works with WithUserTestExcecutionListener for creating a
 * {@link SecurityContext} that is populated in the {@link TestSecurityContextHolder}.
 *
 * @param <A>
 * @author Rob Winch
 * @since 4.0
 * @see WithSecurityContext
 * @see WithMockUser
 * @see WithUserDetails
 */
public interface WithSecurityContextFactory<A extends Annotation> {

	/**
	 * Create a {@link SecurityContext} given an Annotation.
	 * @param annotation the {@link Annotation} to create the {@link SecurityContext}
	 * from. Cannot be null.
	 * @return the {@link SecurityContext} to use. Cannot be null.
	 */
	SecurityContext createSecurityContext(A annotation);

}

인터페이스의 Javadoc 내용을 보면 아래와 같다.

• TestSecurityContextHolder 에 채워진 SecurityContext 를 만들기 위해 WithUserTestExecutionListener 와 함께 작동하는 API
• 말 그대로 테스트의 SecurityContext 를 만들어주는 역할을 한다.