[도전 기술!] 테스트 코드

안녕하세요? 주니하랑 입니다.

본 내용은 주니하랑이 Web 개발 프로젝트를 하면서 도전했던 기술들에 대한 내용을 정리하는 곳 입니다!

이 글은 함께 프로젝트 했던 Back End 꿈나무 Crew가 작성한 것이에요.

주니하랑도 Back End 개발을 맡았었답니다!

저희 프로젝트에서는 JUnit 과 Mockito를 사용하여 테스트 코드를 작성하였습니다.

 

 

---

 

 

👨‍💻 결론

---

테스트 코드를 각 계층마다 작성함으로써 개발 시간이 단축되는 효과를 얻을 수 있었습니다.

테스트를 쉽게하기 위해서, 어플리케이션 코드를 쉽게 짜게 되었고 결국 테스트 코드를 짜기 위해 노력하다 보니, 어플리케이션 코드가 깔끔해지는 것을 경험할 수 있었습니다.

무엇보다도 서버를 실행시키지 않아도, DB에 값을 넣지 않아도, 직접 눈으로 확인하지 않아도 테스트 코드만 실행시키면 여러 단위테스트를 몇 초 만에 완료할 수 있었습니다.

테스트 코드는 협업시 문서로 사용이 가능하기 때문에 가독성이 높게, F.I.R.S.T 원칙에 잘 맞춰서 작성해야 한다는걸 느낄 수 있었습니다.

 

👨‍💻 테스트 코드를 왜 작성해야 할까요?

---

API를 개발하면서 테스트 코드는 꼭 작성되어야 한다고 생각하였습니다.

테스트 코드를 짜지 않고 테스트를 진행할 경우 서버를 켜고, DB에 값을 넣는 작업이 이루어져야 합니다. 그리고 개발자가 정상적으로 로직이 처리 되었는지 직접 눈으로 확인해야합니다.

하지만 테스트 코드를 작성한다면 서버를 실행하지 않고도, DB에 값을 넣지 않아도 빠른 시간안에 테스트를 진행할 수 있다는 것을 느끼게 되었습니다. 테스트 코드를 실행 시키기만 하면 수십ms 안에 테스트를 진행할 수 있게 됩니다.

또한 테스트 코드 자체가 문서로서의 역할도 가능하기 때문에 협업의 생산성을 높힐 수 있었습니다.

 

👨‍💻 웹 계층 마다 테스트 코드를 어떻게 작성했나요?

---

Controller Layer

@WebMvcTest 단위테스트를 작성하였습니다.

스프링 애플리케이션을 실행하는 것이 아닌 가짜 객체인 MockMvc를 만들어서 MVC 동작을 테스트 하였습니다.

다음과 같이 MockMvc를 이용해 브라우저에서 발생하는 요청을 가상으로 만들고 컨트롤러가 응답하는 내용을 기반으로 검증을 수행하였습니다.

@Autowired
MockMvc mvc;

@MockBean
MessageSenderService messageSenderService;


@Test
public void 쪽지_전송_성공() throws Exception {


        DefaultRes result = new DefaultRes(HttpStatus.OK.value(), "전송성공");

        given(messageSenderService.messageSender(any())).willReturn(result);


        mvc.perform(post("/api/users/messages")
                .contentType(MediaType.APPLICATION_JSON)
                .content("{\n" +
                        "  \"content\": \"안녕하세요\",\n" +
                        "  \"receiver_id\": 1,\n" +
                        "  \"sender_id\": 2\n" +
                        "}"))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.message", equalTo(result.getMessage())));

    }

 

Service Layer

Service Layer가 잘 작동하는지 확인하기 위해 Service Layer만 독립적으로 테스트를 진행하였습니다.

즉, 실제 비지니스 로직이 잘 작성 되었는지 확인하는 테스트 코드를 작성하였습니다.

다음과 같이 given, when, then 으로 나눠 작성하였습니다.

필요한 데이터를 미리 기입하고, 비지니스 로직이 올바르게 처리되는 지 테스트하는 코드를 작성하였습니다.

@Test
public void 쪽지_전송_성공(){

//given
User user1 =newUser();
User user2 =newUser();

given(userRepository.findById(1L)).willReturn(Optional.of(user1));
given(userRepository.findById(2L)).willReturn(Optional.of(user2));

//when
DefaultRes defaultRes = messageSenderService.messageSender(new MessageSenderRequestDto(1L, 2L, "안녕하세요"));

//then
assertThat(defaultRes.getMessage()).isEqualTo("전송성공");
assertThat(defaultRes.getStatusCode()).isEqualTo(200);
}

@Test
public void 쪽지_전송_실패_발신자없음(){

//given
User user1 =newUser();
User user2 =newUser();

given(userRepository.findById(1L)).willReturn(Optional.of(user1));
given(userRepository.findById(2L)).willReturn(Optional.of(user2));

//when
DefaultRes defaultRes = messageSenderService.messageSender(new MessageSenderRequestDto(3L, 2L, "안녕하세요"));

//then
assertThat(defaultRes.getMessage()).isEqualTo("발신자정보없음");
assertThat(defaultRes.getStatusCode()).isEqualTo(422);

}

 

 

Repository Layer

@DataJpaTest 어노테이션을 사용하여 JPA 관련 테스트 설정만 로드하여 테스트 코드를 작성하였습니다.

데이터소스의 설정이 정상적인지, JPA를 사용하여 데이터를 제대로 생성, 수정, 삭제하는지 등의 테스트를 진행하였습니다.

테스트 코드 실행 후 자동 rollBack이 되기 때문에 DB에 side effect가 발생하지 않습니다.

또한, Querydsl 코드를 구현하고 올바른 쿼리가 실행 되는지에 대한 테스트 코드를 작성하였습니다.

 

@Test
void 회원_저장(){

   //given
   User user = User.builder()
		               .email("test@test.com")
		               .password("1234")
	                 .name("test")
	                 .nickName("테스터")
	                 .phoneNumber("010-1234-5678")
	                 .grade(UserGrade.USER)
	                 .build();

    //when
    User saveUser = userRepository.save(user);

     //then
     assertThat(user).isEqualTo(saveUser);

}

 

 

---

 

주니하랑의 글이 마음에 드셨나요? 구독과 공감! 그리고, 댓글은 주니하랑에게 많은 힘이 됩니다