스프링부트 테스트 코드 적용하기(JUnit5)

 

spring 프로젝트에서 테스트코드가 작성된 것을 봤는데 하나도 이해를 못했다ㅜㅜ  그래서 이번 기회에 제대로 정리해보려고 한다

 

https://www.youtube.com/watch?v=SFVWo0Z5Ppo&list=PLlTylS8uB2fBOi6uzvMpojFrNe7sRmlzU&index=21

// 너무 좋은 강의라서 추천한다!

 

 

 

TDD(Test Driven Development, 테스트 주도 개발)

• 테스트를 먼저 설계 및 구축 후 테스트를 통과할 수 있는 코드를 짜는 것
• 애자일 개발 방식 중 하나
  • 코드 설계 시 원하는 단계적 목표에 대해 설정 -> 진행하고자 하는 것에 대한 결정 방향의 차이를 줄임
  • 최초 목표에 맞는 테스트를 구축, 그에 맞게 코드를 설계 -> 보다 적은 의견충돌을 기대할 수 있다
    (진행방향 충돌 방지)
• 목적
  • 코드의 안정성을 높임
  • 기능을 추가하거나 변경하는 과정에서 발생할 수 있는 side-effect 줄이기
    // A기능을 위해 코드 수정 -> B기능에 영향 갈 수 있음. 그거 방지
  • 코드에 불필요한 내용이 들어가는 것을 비교적 줄임
    // 해당 코드가 작성된 목적을 명확하게 말할 수 있다

 

단위 테스트

• 특정 모듈이 의도된 대로 동작하는지 테스트
• 모든 메소드에 대한 각각의 testcase를 작성한다
• 일반적으로 스프링 부트에서는 spring-boot-starter-test 디펜던시만으로 의존성을 모두 가질 수 있다.
• FIRST원칙
  • Fast: 테스트 코드의 실행은 빠르게 진행
  • Independent: 독립적인 테스트가 가능
  • Repeatable: 테스트는 매번 같은 결과를 만들어야 함
  • Self-Validating: 테스트는 그 자체로 실행하여 결과를 확인할 수 있어야함
  • Timely: 단위 테스트는 비즈니스 코드가 완성되기 전에 구성하고 테스트가 가능해야 함(TDD원칙, 선택)

 

JUnit 이란?

• 자바 진영의 대표적인 Test Framework
• 단위(Unit) 테스트를 위한 도구를 제공
• 어노테이션을 기반으로 테스트 지원
• 단정문(Assertion)으로 테스트 케이스와 기대값에 대해 수행결과 확인가능

 

JUnit4 vs JUnit5

• Spring Boot 2.2버전부터 JUnit 5 버전을 사용함
• JUnit 5은 크게 Jupiter, Platform, Vintage 모듈로 구성됨
• JUnit 5에서는 테스트 작성자를 위한 API모듈, 테스트 실행을 위한 API모듈이 분리됨.
  // 테스트코드 작성에 필요한 Junit-jupiter-api           테스트 실행을 위한 Junit-jupiter-engine

 

	JUnit4	JUnit5
필요버전	Java5 이상	Java8 이상
구조	All in one	Platform, Jupiter, Vintage
어노테이션	@BeforeClass @AfterClass	@BeforeAll @AfterAll
	@Before @After	@BeforeEach @AfterEach
	@Ignore	@Disable
	@Category	@Tag
	@Rule & @ClassRule	@ExtendWith
	@RunWith(Parameterized.class) @Parameterized.Parameters	@ParameterizedTest @ValueSource
Assertion	Assert class	Assertions class
		assertThat 메서드
		assertAll, assertThrows
Assumptions	Assume class	Assumptions class
		assumeNotNll과 assumeNoException 없다?

 

JUnit5 구조 사진 참고: https://www.oreilly.com/library/view/building-web-apps/9781787284661/c06d01b0-529c-42b7-8659-7142a2abcb76.xhtml

 

 

JUnit4 LifeCycle Annotation

@BeforeClass                  //테스트 시작 전 실행되어야하는 메서드: static

@Before                           //각 테스트 메소드가 시작되기 전 실행되어야하는 메소드

@Test

@After                              //각 테스트 메소드 종료 후 실행되어야하는 메소드

@Before

@Test

@After                             

@AfterClass                     //테스트 종료 후 실행되어야하는 메서드: static

 

 

JUnit5 LifeCycle Annotation

@BeforeAll

@BeforeEach

@Test

@AfterEach

@BeforeEach

@Test

@AfterEach

@AfterAll

 

JUnit5 구조

 

JUnit Platform

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

 

JUnit VIntage

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

 

JUnit Jupiter

• TestEngine API 구현체로 JUit 5를 구현하고 있음
• Jupiter-API: 개발자가 테스트코드를 작성할 때 사용
• Jupiter-Engine: Jupiter-API를 사용하여 작성한 테스트 코드를 발견하고 실행하는 역할을 수행
• 테스트의 실제 구현체는 별도 모듈 역할을 수행 -> 모듈 중 하나가 Jupiter-Engine

 

Springboot 테스트를 위한 JUnit5 어노테이션 

@Test	테스트용 메소드 표현
@BeforeAll	테스트 시작 전 실행되어야하는 메서드: static처리 필요
@AfterAll	테스트 종료 후 실행되어야하는 메서드: static처리 필요
@BeforeEach	각 테스트 메소드가 시작되기 전 실행되어야하는 메소
@AfterEach	각 테스트 메소드 종료 후 실행되어야하는 메소드
@SpringBootTest	통합 테스트 용도로 사용됨 @SpringBootApplication을 찾아가 하위의 모든 Bean을 스캔하여 로드 Test용 Application Context를 만들어 Bean을 추가하고, MockBean을 찾아 교체함
@ExtendWIth	메일으로 실행될 Class를 지정 SpringBootTest는 기본적으로 @ExtendWIth가 추가되어 있음
@WebMvcTest(Class명.class)	() 내에 작성된 클래스만 실제로 로드하여 테스트 진행 매개변수를 지정해주지 않으면 컨트롤러와 연관된 Bean이 모두 로드됨. (@Controller @RestController @RestControllerAdvice) 컨트롤러 관련 코드만 테스트하고 싶을 때 @SpringBootTest 대신 사용
@Autowired about Mockbean	Controller의 API를 테스트하는 용도인 MockMvc 객체를 주입 받음 perform() 메소드를 활용하여 컨트롤러의 동작을 확인할 수 있음
@MockBean	테스트할 클래스에서 주입 받고 있는 객체에 대해 가짜 객체를 생성해주는 어노테이션 given() 메소드를 활용하여 가짜 객체의 동작에 대해 정의하여 사용가능
@AutoCOnfigureMockMvc	spring.test.mockmvc의 설정을 로드하면서 MockMvc의 의존성을 자동으로 주입 MockMvc 클래스는 REST API 테스트를 할 수 있는 클래스
@Import	필요한 Class들을 COnfiguration으로 만들어 사용가능 Import된 클래스는 주입으로 사용가능

 

예제 확인

 

Spring Boot 서비스 구조

• client - controller - service - dao - db
• DTO와 Entity가 사용됨

 

Controller Test

 

 

import 문 더보기

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 static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.verify;

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 org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.mockito.BDDMockito;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.gson.Gson;

 

@WebMvcTest(ProductController.class)
class ProductControllerTest {

  @Autowired
  private MockMvc mockMvc;

  @MockBean
  ProductServiceImpl productService;

  ...
 }

 

• WebMvcTest: ProductController 클래스만 실제로 로드하여 테스트를 진행한다
• Autowired로 MocVoc 객체를 주입받는다
• MockBean: ProductServiceImpl 객체에 대한 가짜 객체를 생성해준다. ProductController 클래스 속성으로 정의되어 있기 때문

 

# 데이터 조회 테스트

  @Test
  @DisplayName("Proudct 데이터 가져오기 테스트")
  void getProductTest() throws Exception {

    BDDMockito.given(productService.getProduct(12313)).willReturn(
      new ProductDto(15871, "pen", 5000, 2000)
    );

    long productId = 12313;

    mockMvc.perform(
            get("/api/v1/product-api/product/" + productId))
            .andExpect(status().isOk())
            .andExpect(jsonPath("$.productId").exists())
            .andExpect(jsonPath("$.productName").exists())
            .andExpect(jsonPath("$.productPrice").exists())
            .andExpect(jsonPath("$.productStock").exists())
            .andDo(print());

    verify(productService).getProduct(12313);
  }

 

• Test: 테스트코드를 작성한다
• DisplayName: 테스트 이름을 정해준다
• given:
  - Mock 객체가 특정 상황에서 해야하는 행위를 정의.
  - 코드에서는 productService가 getProduct를 호출했을 때 return할 값을 지정해준다. 
  - mock 객체에서 특정 메소드가 실행되는 경우 실제 return 값을 줄 수 없기 때문에 직접 지정해주는 것
• mockMvc.perform으로 restapi의 기능을 테스트해본다. get으로 url접속함
  andExpect: 기대하는 값이 나왔는지 체크해본다. status가 ok인지,  productId가 존재하는지 체크 등
• verify로 해당 객체의 메소드가 실행되었는지 체크해준다. 

 

# 데이터 생성 테스트

  @Test
  @DisplayName("Product 데이터 생성 테스트")
  void createProductTest() throws Exception {
    given(productService.saveProduct(15871, "pen",5000, 2000)).willReturn(
            new ProductDto(15871, "pen",5000, 2000)
    );

    ProductDto productDto = ProductDto.builder().productId(1111).productName("pen")
            .productPrice(5000).productStock(2000).build();
    Gson gson = new Gson();
    String content = gson.toJson(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);
  }

 

• given으로 메소드의 return 값을 지정해준다
• Dto를 만들어서 json으로 변환해준다. Gson 라이브러리를 사용하였다
  // ObjectMapper().writeValueAsString으로 변환할 수도 있음
• perform으로 기능을 테스트. post로 url을 접속했을 때  기대값을 쭉쭉 적어준다. 
• verify로 메소드 실행을 테스트

 

Service Test

 

import 문 더보기

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;

 

 

@ExtendWith(SpringExtension.class)
@Import({ProductDataHandler.class, ProductServiceImpl.class})
class ProductServiceImplTest {
  @MockBean
  ProductDataHandlerImpl productDataHandler;

  @Autowired
  ProductServiceImpl productService; 
  
  ...
}

 

• SpringExtension 클래스를 메인으로 실행함
  // mockito 어노테이션을 사용할 때 ExtendWith(SpringExtension.class)를 사용한다고 한다
  // SpringBootTest 에 포함되어있음
• ProductDataHandler와 ProductServiceImpl 클래스를 Configuration으로 만들어 사용할 수 있다.
  주입으로 사용이 가능
• MockBean: ProductDataHandlerImpl을 가짜 객체로 만들어준다. (ServiceImpl에 핸들러가 속성으로 있음)
• @Autowired로 서비스를 주입받는다. 테스트와 관련된 객체를 주입받아야함.

 

# 데이터 조회 테스트

 

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

    ProductDto productDto = productService.getProduct(123);

    Assertions.assertEquals(productDto.getProductId(), 123);
    Assertions.assertEquals(productDto.getProductPrice(), 2000);

    verify(productDataHandler).getProductEntity(123);
  }

 

• when: given 대신 사용이 가능하다. mock 객체에 대한 return 값을 지정해준다.
• Assertions 로 두 값이 같은지 비교한다
• verify로 메소드 실행 확인

 

# 데이터 생성 테스트

 

  @Test
  void saveProductTest() {
    Mockito.when(productDataHandler.saveProductEntity(123, "pen", 2000, 3000))
            .thenReturn(new ProductEntity(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);
  }

 

• 조회와 거의 동일하다

 

 

 

 

 

참고:

https://junit.org/junit5/docs/current/user-guide/

https://www.softwaretestinghelp.com/junit-annotations-tutorial/

https://www.luxoft-training.com/news/junit-5-usage-and-first-test/

https://jade314.tistory.com/entry/Junit-5

https://www.youtube.com/watch?v=SFVWo0Z5Ppo&list=PLlTylS8uB2fBOi6uzvMpojFrNe7sRmlzU&index=21