인프런 커뮤니티 질문&답변

안녕하세요 좋은 강의 덕분에 테스트에 대해 많이 알게 되었습니다 :)

스프링 시큐리티를 포함한 테스트와 관련해서 질문을 드려보고자 글을 쓰게 되었습니다. (강의에서는 스프링 시큐리티를 사용하지 않지만 테스트와 관련해서 물어볼 곳이 마땅치 않아 이 곳에 글을 남기는 점 양해해주시면 감사하겠습니다)

@RequiredArgsConstructor
@RestController
@RequestMapping("/api")
@Slf4j
public class AuthController {

    private final AuthService authService;

    @PostMapping("/auth/sign-up")
    public String signUp(@RequestBody SignUpRequest request) {
       authService.signUp(request);
       return "회원가입 성공";
    }
}

현재 회원가입을 하는 컨트롤러의 메서드는 다음과 같습니다.

@Service
@RequiredArgsConstructor
@Slf4j
@Transactional(readOnly = true)
public class AuthService {

    private final UserRepository userRepository;
    private final PasswordEncoder passwordEncoder;

    @Transactional
    public void signUp(SignUpRequest request) {

       if (userRepository.findByEmail(request.getEmail()).isPresent()) {
          throw new AlreadyExistException("이미 존재하는 이메일입니다.");
       }

       if (userRepository.findByNickname(request.getNickname()).isPresent()) {
          throw new AlreadyExistException("이미 존재하는 닉네임입니다.");
       }

       User user = User.builder()
          .name(request.getName())
          .email(request.getEmail())
          .password(request.getPassword())
          .nickname(request.getNickname())
          .role(UserRole.USER)
          .build();

       user.passwordEncode(passwordEncoder);
       userRepository.save(user);
    }
}

그리고 실제 회원가입이 진행되는 로직은 이렇습니다.

그리고 제가 WebMvcTest 어노테이션을 사용해서 테스트 코드를 작성한 건 다음과 같습니다.

@ActiveProfiles("test")
@AutoConfigureMockMvc
@WebMvcTest(AuthController.class)
class AuthControllerTestWithWebMvcTest {

    @Autowired
    protected MockMvc mockMvc;

    @Autowired
    protected ObjectMapper objectMapper;

    @MockBean
    private AuthService authService;

    @MockBean
    private UserRepository userRepository;


    @DisplayName("회원가입 한다.")
    @CustomMockUser // 회원가입을 해야되는데 인증이 필요하다? -> 논리적으로 말이 안 됨 -> 올바른 테스트?
    @Test
    void signUp() throws Exception {
       // given
       SignUpRequest request = SignUpRequest.builder()
          .name("zun")
          .email("zun@test.com")
          .password("12345")
          .nickname("zunny")
          .build();

       // then
       mockMvc.perform(post("/api/auth/sign-up")
             .content(objectMapper.writeValueAsString(request))
             .contentType(APPLICATION_JSON)
             .with(csrf())
          )
          .andExpect(status().isOk())
          .andDo(print());
    }

}

보시다시피 회원가입 API에 요청이 제대로 되는지를 확인하기 위해 @CustomMockUser 라는 어노테이션을 사용하고 있습니다. (이 어노테이션은 테스트에서 인증을 처리하기 위해 만든 어노테이션입니다. 호돌맨님 강의를 참고해서 만들었습니다.)

제가 혼란스러운 부분은 테스트코드에 써놓은 주석처럼 회원가입이 제대로 되는지를 테스트하기 위한 컨트롤러 코드인데 이걸 통과시키기 위해 인증을 담당하는 @CustomMockUser를 사용하는 것이 올바른 테스트인가 하는 의문입니다.

@WebMvcTest를 사용하지 않고 @SpringBootTest를 사용하면 다음처럼 할 수가 있습니다.

@ActiveProfiles("test")
@AutoConfigureMockMvc
@SpringBootTest
class AuthControllerTest {

    @Autowired
    private UserRepository userRepository;

    @Autowired
    private ObjectMapper objectMapper;

    @Autowired
    private MockMvc mockMvc;

    @BeforeEach
    void tearDown() {
       userRepository.deleteAllInBatch();
    }

    @DisplayName("회원가입 한다.")
    @Test
    void signUp() throws Exception {
       //given
       SignUpRequest request = SignUpRequest.builder()
          .name("zun")
          .email("zun@test.com")
          .password("12345")
          .nickname("zunny")
          .build();

       //expected
       mockMvc.perform(post("/api/auth/sign-up")
             .content(objectMapper.writeValueAsString(request))
             .contentType(APPLICATION_JSON)
          )
          .andExpect(status().isOk())
          .andDo(print());
    }

}

혹시 이와 관련해서 우빈님은 어떻게 생각하시는지, 그리고 스프링 시큐리티를 사용하는 프로젝트에서는 컨트롤러 쪽 테스트를 어떻게 하는 것이 좋은지 알려주시면 감사하겠습니다!