[영상후기] 테스트 코드 적용하기 (JUnit, TDD) [ 스프링 부트 (Spring Boot) ]

TDD 간단 정리

• 테스트 주도 개발
• 테스트를 먼저 설계 및 구축 후 테스트를 통과할 수 있는 코드를 짜는 것
• 코드 작성 후 테스트를 진행하는 지금까지 사용된 일반적인 방식과 다소 차이가 있음
• 애자일 개발 방식 중 하나
  • 코드 설계시 원하는 단계적 목표에 대해 설정하여 진행하고자 하는 것에 대한 결정 방향의 갭을 줄이고자 함
  • 최종 목표에 맞춘 테스트를 구축하여 그에 맞게 코드를 설계하기 때문에 적은 의견 충돌 기대(방향 일치로 인한 피드백과 진행 방향의 충돌 방지)

테스트 코드 작성 목적

• 코드의 안정성을 높일 수 있음
• 기능을 추가하거나 변경하는 과정에서 발생할 수 있는 Side-Effect를 줄일 수 있음
• 해당 코드가 작성된 목적을 명확하게 표현할 수 있음
  • 코드에 불필요한 내용이 들어가는 것을 비교적 줄일 수 있음
    • 테스트 코드만 작성하면 됨
    • 기능 개발하면서 ~~도 좋겠는데? 하면서 이것 저것 추가 하는것 보다 딱 테스트 코드 통과용 처럼 필요한 부분만 추가

JUnit이란?

• Java 진영의 대표적 Test Framework
• 단위 테스트를 위한 도구 제공
  • 단위 테스트
    • 코드의 특정 모듈이 의도된 대로 동작하는지 테스트 하는 절차를 의미
    • 모든 함수와 메소드에 대한 각각의 테스트 케이스를 작성하는 것
• 어노테이션 기반 테스트 지원
• 단정문(Assert)로 테스트 케이스의 기대값에 대해 수행 결과를 확인할 수 있음
• Spring Boot 2.2 버전부터 JUnit 5 버전 사용
• JUnit 5는 크게 Jupiter, Platform, Vintage 모듈로 구성됨
  • Vintage : JUnit4를 호환하기 위한 모듈

JUnit 모듈 설명

JUnit Jupiter

• TestEngine API 구현체로 JUnit5를 구현하고 있음
• 테스트의 실제 구현체는 별도 모듈 역할을 수행하는데 그 모듈 중 하나다 Jupiter-Engine임
• 이 모듈은 Jupiter-API를 사용하여 작성한 테스트 코드를 발견하고 실행하는 역할 수행
• 개발자가 테스트 코드를 작성할 때 사용됨

JUnit Platform

• Test를 실행하기 위한 뼈대
• Test를 발견하고 테스트 계획을 생성하는 TestEngine 인터페이스를 가지고 있음
• TestEngine을 통해 Test를 발견하고 수행 및 결과를 보고함
• 각종 IDE 연동을 보조하는 역할 수행(콘솔 출력 등)
• Platform = TestEngine API + Console Launcher + JUnit 4 Based Runner 등
• 플랫폼을 주피터가 구현하고 있다 생각해도 될듯

JUnit Vintage

• TestEngin API의 구현체로 JUnit 3, 4를 구현하고 있음
• 기존 JUnit 3, 4 버전으로 작성된 테스트 코드를 실행할 때 사용됨
• Vintage-Engine 모듈을 포함하고 있음

JUnit LifeCycle Annotation

• JUnit5는 아래와 같은 테스트 라이프 사이클을 가지고 있음
• @Test : 테스트용 메서드를 표현하는 어노테이션
• @BeforeEach : 각 테스트 메소드가 시작되기 전에 실행되어야 하는 메서드를 표현
• @AfterEach : 각 테스트 메소드가 시작된 후 실행되어야 하는 메서드를 표현
• @BeforeAll : 테스트 시작 전에 실행되어야 하는 메서드를 표현(static 처리 필요)
• @AfterAll : 테스트 종료 후에 실행되어야 하는 메서드를 표현(static 처리 필요)

JUnit Main Annotation

• @SpringBootTest

  • 통합 테스트 용도로 사용됨
  • @SpringBootApplication을 찾아가 하위의 모든 Bean을 스캔하여 로드함
  • 그 후 Test용 Application Context를 만들어 Bean을 추가하고, MockBean을 찾아 교체

• @ExtendWith

  • JUnit4에서 @RunWith로 사용되던 어노테이션이 ExtendWith로 변경됨
  • @ExtendWith는 메인으로 실행될 Class를 지정할 수 있음
  • @SpringBootTest는 기본적으로 @ExtendWith가 추가되어 있음

• @WebMvcTest(Class명.class)

  • ()에 작성된 클래스만 실제로 로드하여 테스트 진행
  • 매개변수를 지정해주지 않으면 @Controller, @RestController, @RestControllerAdvice 등 컨트롤러와 연관된 Bean이 모두 로드됨
  • 스프링의 모든 Bean을 로드하는 @SpringBootTest 대신 컨트롤러 관련 코드만 테스트할 경우 사용

• @Autowired about Mockbean

  • Controller의 API를 테스트하는 용도인 MockMvc 객체를 주입 받음
  • perform() 메서드를 활용하여 컨트롤러의 동작을 확인할 수 있음
    • .andExpect(), andDo, andReturn() 등의 메서드를 같이 활용함

	@Autowired
	private MockMvc mvc;
    
		ResultActions resultActions = mvc
			.perform(post("/answer/create/3")
				.with(csrf()) // CSRF 키 생성
				.param("content", "테스트답변1"))
			.andDo(print());

• @MockBean

  • 테스트할 클래스에서 주입 받고 있는 객체에 대해 가짜 객체를 생성해주는 어노테이션
    • 컨트롤러 테스트를 할 때는 서비스 등의 의존성을 실제 객체가 아닌 가짜 객체를 이용
  • 해당 객체는 실제 행위를 하지 않음
  • given() 메소드를 활용하여 가짜 객체의 동작에 대해 정의하여 사용할 수 있음

• @AutoConfigureMoockMvc

  • spring.test.mockmvc의 설정을 로드하면서 MockMvc의 의존성을 자동으로 주입
  • MockMvc 클래스는 REST API 테스트를 할 수 있는 클래스

• @Import

  • 필요한 Class들을 Configuration으로 만들어 사용할 수 있음
  • Configuration Component 클래스도 의존성 설정할 수 있음
  • Import된 클래스는 주입으로 사용 가능

---

통합 테스트

• 여러 기능을 조합하여 전체 비즈니스 로직이 제대로 동작하는지 확인하는 것을 의미
• @SpringBootTest를 사용하여 진행
  • @SpringBootTest는 @SpringBootApplication을 찾아가서 모든 Bean을 로드하게 됨
  • 대규모 프로젝트에서 사용할 경우, 테스트를 실행할 때마다 모든 빈을 스캔하고 로드하는 작업이 반복되어 매번 무거운 작업을 수행해야 함
    • 무거운 작업을 수행하는 것을 피하기 위해 단위 테스트를 진행하기도 함

---

단위 테스트

• 프로젝트에 필요한 모든 기능에 대한 테스트를 각각 진행하는 것을 의미
• 일반적으로 스프링 부트에서는 org.springframework.boot:spring-boot-starter-test 디펜던시만으로 의존성을 모두 가질 수 있음
• F.I.R.S.T 원칙
  • Fast : 테스트 코드의 실행력은 빠르게 진행되어야 함
  • Independent : 독립적인 테스트가 가능해야 함
  • Repeatable : 테스트는 매번 같은 결과를 만들어야 함
  • Self-Validating : 테스트는 그 자체로 실행하여 결과를 확인할 수 있어야 함
  • Timely : 단위 테스트는 비즈니스 코드가 완성되기 전에 구성하고 테스트가 가능해야 함
    • 코드가 완성되기 전부터 테스트가 따라와야 한다는 TDD의 원칙을 담고 있음

---

예시 1 - LifeCycle

• @Test 의 기본 DisplayName은 메서드 이름이 출력됨
• @Disabled : 테스트 실행하지 않게 설정하는 어노테이션

예시 1 - Controller Test

• static import : 코드 길이를 줄이기 위해 종종 사용하곤 함

• ProductController 내부에 ProductService를 의존성 주입 하고있어 Mock 객체를 생성하기 위해 @MockBean 사용

• mokito : Mock 객체 생성 및 사용에 도움을 주는 라이브러리

  • given : Mock 객체가 특정 상황에서 해야하는 행위를 정의하는 메서드
  • perform : restAPI test할 수 있는 환경을 만들어 줌
    • builder 구조이기에 .으로 구분
    • '$.'으로 JSON의 key값 조회
  • verify : 메소드가 실행되었는지 체크

package studio.thinkground.aroundhub.controller;

import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.verify;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.gson.Gson;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MockMvc;
import studio.thinkground.aroundhub.data.dto.ProductDto;
import studio.thinkground.aroundhub.service.impl.ProductServiceImpl;

@WebMvcTest(ProductController.class) // 테스트하고자 하는 Class명을 넣어주면 됨
//@AutoConfigureWebMvc // 이 어노테이션을 통해 MockMvc를 Builder 없이 주입받을 수 있음
public class ProductControllerTest {

  @Autowired
  private MockMvc mockMvc;

  // ProductController에서 잡고 있는 Bean 객체에 대해 Mock 형태의 객체를 생성해줌
  @MockBean
  ProductServiceImpl productService;

  // http://localhost:8080/api/v1/product-api/product/{productId}
  @Test
  @DisplayName("Product 데이터 가져오기 테스트")
  void getProductTest() throws Exception {

    // given : Mock 객체가 특정 상황에서 해야하는 행위를 정의하는 메소드
    given(productService.getProduct("12315")).willReturn(
        new ProductDto("15871", "pen", 5000, 2000));

    String productId = "12315";

    // andExpect : 기대하는 값이 나왔는지 체크해볼 수 있는 메소드
    mockMvc.perform(
            get("/api/v1/product-api/product/" + productId))
        .andExpect(status().isOk())
        .andExpect(jsonPath("$.productId").exists()) // json path의 depth가 깊어지면 .을 추가하여 탐색할 수 있음 (ex : $.productId.productIdName)
        .andExpect(jsonPath("$.productName").exists())
        .andExpect(jsonPath("$.productPrice").exists())
        .andExpect(jsonPath("$.productStock").exists())
        .andDo(print());

    // verify : 해당 객체의 메소드가 실행되었는지 체크해줌
    verify(productService).getProduct("12315");
  }


  // http://localhost:8080/api/v1/product-api/product
  @Test
  @DisplayName("Product 데이터 생성 테스트")
  void createProductTest() throws Exception {
    //Mock 객체에서 특정 메소드가 실행되는 경우 실제 Return을 줄 수 없기 때문에 아래와 같이 가정 사항을 만들어줌
    given(productService.saveProduct("15871", "pen", 5000, 2000)).willReturn(
        new ProductDto("15871", "pen", 5000, 2000));

    ProductDto productDto = ProductDto.builder().productId("15871").productName("pen")
        .productPrice(5000).productStock(2000).build();
    // google에서 JSON 변환 쉽게 해주는 라이브러리
    Gson gson = new Gson();
    String content = gson.toJson(productDto);

    // 아래 코드로 json 형태 변경 작업을 대체할 수 있음
    // String json = new ObjectMapper().writeValueAsString(productDto);

    mockMvc.perform(
            post("/api/v1/product-api/product")
                .content(content)
                .contentType(MediaType.APPLICATION_JSON))
        .andExpect(status().isOk())
        .andExpect(jsonPath("$.productId").exists())
        .andExpect(jsonPath("$.productName").exists())
        .andExpect(jsonPath("$.productPrice").exists())
        .andExpect(jsonPath("$.productStock").exists())
        .andDo(print());

    verify(productService).saveProduct("15871", "pen", 5000, 2000);
  }

}

---

예시 2 - Service Test

• @SpringBootTest : 매개변수가 있으면 해당 class bean만 가져옴
  • 없으면 전체 bean
  • @ExtendWith가 SpringBootTest 내에 있으니 특정 클래스 지정에 사용해도 됨
• 테스트 할 객체를 주입 받아야 함(컨트롤러 테스트가 아니니)

package studio.thinkground.aroundhub.service.impl;

import static org.mockito.Mockito.verify;

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mockito;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.context.annotation.Import;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import studio.thinkground.aroundhub.data.dto.ProductDto;
import studio.thinkground.aroundhub.data.entity.Product;
import studio.thinkground.aroundhub.data.handler.impl.ProductDataHandlerImpl;

//@SpringBootTest(classes = {ProductDataHandlerImpl.class, ProductServiceImpl.class})
@ExtendWith(SpringExtension.class)
@Import({ProductDataHandlerImpl.class, ProductServiceImpl.class})
public class ProductServiceImplTest {

  @MockBean
  ProductDataHandlerImpl productDataHandler;

  @Autowired
  ProductServiceImpl productService;

  @Test
  public void getProductTest() {
    //given
    Mockito.when(productDataHandler.getProductEntity("123"))
        .thenReturn(new Product("123", "pen", 2000, 3000));

    ProductDto productDto = productService.getProduct("123");

    Assertions.assertEquals(productDto.getProductId(), "123");
    Assertions.assertEquals(productDto.getProductName(), "pen");
    Assertions.assertEquals(productDto.getProductPrice(), 2000);
    Assertions.assertEquals(productDto.getProductStock(), 3000);

    verify(productDataHandler).getProductEntity("123");
  }

  @Test
  public void saveProductTest() {
    //given
    Mockito.when(productDataHandler.saveProductEntity("123", "pen", 2000, 3000))
        .thenReturn(new Product("123", "pen", 2000, 3000));

    ProductDto productDto = productService.saveProduct("123", "pen", 2000, 3000);

    Assertions.assertEquals(productDto.getProductId(), "123");
    Assertions.assertEquals(productDto.getProductName(), "pen");
    Assertions.assertEquals(productDto.getProductPrice(), 2000);
    Assertions.assertEquals(productDto.getProductStock(), 3000);

    verify(productDataHandler).saveProductEntity("123", "pen", 2000, 3000);
  }
}

---

• 이전 JUnit5 테코톡 영상도 참고하면 좋을 것 같습니다!
  • [영상후기] [10분 테코톡] 🌊 바다의 JUnit5 사용법