카테켐 | [STEP2 cloncoding] 4주차 과제 - (2)

4주차

카카오 테크 캠퍼스 2단계 - BE - 4주차 클론 과제

 

과제명

1. 컨트롤러 단위 테스트

 

과제 설명

1. 컨트롤러 단위테스트를 작성한뒤 소스코드를 업로드하시오.

2. stub을 구현하시오.

 

과제 상세 : 과제를 진행할 때, 유념해야할 것

컨트롤러 단위테스트가 구현되었는가?

Mockito를 이용하여 stub을 구현하였는가?

인증이 필요한 컨트롤러를 테스트할 수 있는가?

200 ok만 체크한 것은 아닌가? (해당 컨트롤러에서 제일 필요한 데이터에 대한 테스트가 구현되었는가?)

모든 요청과 응답이 json으로 처리되어 있는가?

 

---

1. 컨트롤러 단위 테스트

---

01) 컨트롤러 단위테스트를 작성한뒤 소스코드를 업로드하시오.

 

---

🔍 기존 코드 분석

 

GlobalExceptionHandler

 

@RequiredArgsConstructor
@Component
public class GlobalExceptionHandler {

    private final ErrorLogJPARepository errorLogJPARepository;

    public ResponseEntity<?> handle(RuntimeException e, HttpServletRequest request){
        if(e instanceof Exception400){
            Exception400 ex = (Exception400) e;
            return new ResponseEntity<>(
                    ex.body(),
                    ex.status()
            );
        }else if(e instanceof Exception401){
            Exception401 ex = (Exception401) e;
            return new ResponseEntity<>(
                    ex.body(),
                    ex.status()
            );
        }else if(e instanceof Exception403){
            Exception403 ex = (Exception403) e;
            return new ResponseEntity<>(
                    ex.body(),
                    ex.status()
            );
        }else if(e instanceof Exception404){
            Exception404 ex = (Exception404) e;
            return new ResponseEntity<>(
                    ex.body(),
                    ex.status()
            );
        }else if(e instanceof Exception500){
            ErrorLog errorLog = ErrorLog.builder()
                    .message(e.getMessage())
                    .userAgent(request.getHeader("User-Agent"))
                    .userIp(request.getRemoteAddr())
                    .build();
            errorLogJPARepository.save(errorLog);
            Exception500 ex = (Exception500) e;
            return new ResponseEntity<>(
                    ex.body(),
                    ex.status()
            );
        }else{
            ErrorLog errorLog = ErrorLog.builder()
                    .message(e.getMessage())
                    .userAgent(request.getHeader("User-Agent"))
                    .userIp(request.getRemoteAddr())
                    .build();
            errorLogJPARepository.save(errorLog);
            return new ResponseEntity<>(
                    "unknown server error",
                    HttpStatus.INTERNAL_SERVER_ERROR
            );
        }
    }
}

 

예외 처리를 담당하는 GlobalExceptionHandler 클래스이다. 특정 예외 종류에 따라 적절한 HTTP 상태 코드와 응답을 생성한다. 각 예외에 대한 처리 방법은 다음과 같다.

 

handle 메서드가 RuntimeException과 HttpServletRequest를 파라미터로 받는다. RuntimeException을 처리하고 ResponseEntity를 반환하는 역할을 한다.

 

• Exception400~404의 경우, 예외 객체인 ex에서 응답 데이터와 상태 코드를 가져와 ResponseEntity를 생성한다.
• Exceotion500이 경우에는, 예외 객체인 ex에서 응답 데이터와 상태 코드를 가져온 뒤, 에러 로그를 생성하여 데이터베이스에 저장한 뒤, ResponseEntity를 생성한다.
• 그 외에 예외가 발생하면, "unknown server error" 메시지와 HttpStatus.INTERNAL_SERVER_ERROR 상태 코드를 반환하며, 동시에 에러 로그를 생성하여 데이터베이스에 저장한다.

 

UserRestControllerTest

 

// GlobalExceptionHandler와 UserRestController를 SpringContext에 등록합니다.

@Import({
        SecurityConfig.class,
        GlobalExceptionHandler.class
})
@WebMvcTest(controllers = {UserRestController.class})
public class UserRestControllerTest {

    // 객체의 모든 메서드는 추상메서드로 구현됩니다. (가짜로 만들면)
    // 해당 객체는 SpringContext에 등록됩니다.
    @MockBean
    private UserService userService;

    @MockBean
    private ErrorLogJPARepository errorLogJPARepository;

    // @WebMvcTest를 하면 MockMvc가 SpringContext에 등록되기 때문에 DI할 수 있습니다.
    @Autowired
    private MockMvc mvc;

    // @WebMvcTest를 하면 ObjectMapper가 SpringContext에 등록되기 때문에 DI할 수 있습니다.
    @Autowired
    private ObjectMapper om;

    @Test
    public void t1(){}

    @Test
    public void join_test() throws Exception {
        // given
        UserRequest.JoinDTO requestDTO = new UserRequest.JoinDTO();
        requestDTO.setEmail("ssarmango@nate.com");
        requestDTO.setPassword("meta1234!");
        requestDTO.setUsername("ssarmango");
        String requestBody = om.writeValueAsString(requestDTO);

        // when
        ResultActions result = mvc.perform(
                MockMvcRequestBuilders
                        .post("/join")
                        .content(requestBody)
                        .contentType(MediaType.APPLICATION_JSON)
        );

        String responseBody = result.andReturn().getResponse().getContentAsString();
        System.out.println("테스트 : "+responseBody);

        // then
        result.andExpect(MockMvcResultMatchers.jsonPath("$.success").value("true"));
    }

    @Test
    public void login_test() throws Exception {
        // given
        UserRequest.LoginDTO loginDTO = new UserRequest.LoginDTO();
        loginDTO.setEmail("ssar@nate.com");
        loginDTO.setPassword("meta1234!");
        User user = User.builder().id(1).roles("ROLE_USER").build();
        String requestBody = om.writeValueAsString(loginDTO);

        // stub -> 가정법
        String jwt = JWTProvider.create(user);
        Mockito.when(userService.login(any())).thenReturn(jwt); // token

        // when
        ResultActions result = mvc.perform(
                MockMvcRequestBuilders
                        .post("/login")
                        .content(requestBody)
                        .contentType(MediaType.APPLICATION_JSON)
        );
        String responseBody = result.andReturn().getResponse().getContentAsString();
        String responseHeader = result.andReturn().getResponse().getHeader(JWTProvider.HEADER);
        System.out.println("테스트 : "+responseBody);
        System.out.println("테스트 : "+responseHeader);

        // then
        result.andExpect(MockMvcResultMatchers.jsonPath("$.success").value("true"));
        Assertions.assertTrue(jwt.startsWith(JWTProvider.TOKEN_PREFIX));
    }

    @Test
    public void length_test(){
        String value = "Bearer eyJ0eX";
        System.out.println(value.substring(0,6));
    }

}

 

User에 대한 기능들을 controller 단위테스트를 수행하는 클래스이다. 해당 클래스에서는 @WebMvcTest를 사용하여 UserRestController 클래스의 테스트를 수행한다. `UserRestController`와 `GlobalExceptionHandler`를 Spring 컨텍스트에 등록하고, 이를 이용하여 컨트롤러를 테스트한다.

join_test()

회원가입에 필요한 테스트이다. UserRequest.JoinDTO 객체를 생성하고, 해당 객체를 JSON 형태로 변환하여 POST 요청으로 전송한다. 또한, 응답으로 오는 JSON 결과를 검증한다.

login_test()

로그인 요청에 대한 테스트로, UserRequest.LoginDTO 객체를 생성하고, 해당 객체를 JSON 형태로 변환하여 POST 요청으로 전송한다. 로그인 요청에 대한 응답으로 생성되는 JWT 토큰을 검증하고, 토큰의 형식을 확인합니다.

length_test()

 

문자열 길이에 대한 테스트로, 주어진 문자열에서 일부를 잘라내어 검증한다.

Spring 컨텍스트를 활용하여 컨트롤러의 동작을 검증하고, 각 요청과 응답에 대한 상태 및 결과를 확인한다. 특히 MockBean을 사용하여 UserService와 ErrorLogJPARepository를 가짜 객체로 대체하여 테스트를 진행하는데, 실제 데이터베이스에 영향을 주지 않고, 예상된 결과를 테스트할 수 있다.

 

---