[Spring] 테스트 코드 적용하기

테스트 코드 적용하기

 

TDD에 대한 간단한 정리

- 테스트 주도 개발이라는 의미

- 테스트를 먼저 설계 및 구축 후 테스트를 통과할 수 있는 코드를 작성

- 코드 작성 후 테스트를 진행하는 방법

- 애자일 개발 방식 중 하나

1. 코드 설계 시 원하는 단계적 목표에 대해 설정하여 진행하고자 하는 것에 대한 결정 방향의 갭을 줄이고자 함
2. 최초 목표에 맞춘 테스트를 구축하여 그에 맞게 코드를 설계하기 때문에 보다 적은 의견 충돌을 기대할 수 있음(방향 일치로 인한 피드백과 진행 방향의 충돌 방지)

 

 

728x90

 

 

테스트 코드 작성 목적

- 코드의 안정성을 높일 수 있음

- 기능을 추가하거나 변경하는 과정에서 발생할 수 있는 Side-Effect를 줄일 수 있음

- 해당 코드가 작성된 목적을 명확하게 표현할 수 있음(코드에 불필요한 내용이 들어가는 것을 비교적 줄일 수 있음)

 

 

JUnit이란?

- Java 진영의 대표적인 Test Framework

- 단위 테스트를 위한 도구 제공

- 어노테이션을 기반으로 테스트를 지원

- 단정문(Assert)으로 테스트 케이스의 기대값에 대해 수행 결과를 확인할 수 있음

- Spring Boot 2.2 버전부터 JUnit 5 버전을 사용

 

 

JUnit 모듈 설명

JUnit Jupiter

- TestEngine API 구현체

- 개발자가 테스트 코드를 작성할 때 사용된다.

 

JUnit Platform

- Test를 실행하기 위한 뼈대

- Test를 발견하고 테스트 계획을 생성하는 TestEngine 인터페이스를 갖고 있음

 

JUnit Vintage

- TestEngine API 구현체로 JUnit3, 4를 구현하고 있음

 

 

JUnit LifeCycle Annotation

- JUnit 5의 테스트 라이프 사이클

 

 

JUnit Main Annotation

@SpringBootTest

- 통합 테스트 용도

- @SpringBootApplication을 찾아 하위의 모든 Bean을 스캔

- Test용 Application Context를 만들어 Bean을 추가하고, MockBean을 찾아서 교체

 

@ExtendWith

- JUnit 4에서 @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() 등의 메소드를 같이 활용함

 

@MockBean

- 테스트할 클래스에서 주입 받고 있는 객체에 대해 가짜 객체를 생성해주는 어노테이션

- 해당 객체는 실제 행위를 하지 않음

- given() 메소드를 활용하여 가짜 객체의 동작에 대해 정의하여 사용할 수 있음

 

@AutoConfigureMockMvc

- spring.test.mockmvc의 설정을 로드하면서 MockMvc의 의존성을 자동으로 주입

- MockMvc 클래스는 REST API 테스트를 할 수 있는 클래스

 

@Import

- 필요한 Class들을 Configuration으로 만들어 사용할 수 있음

- Configuration Component 클래스도 의존성 설정할 수 있음

- Import된 클래스는 주입으로 사용 가능

 

 

통합 테스트

- 통합 테스트는 여러 기능을 조합하여 전체 비즈니스 로직이 제대로 동작하는지 확인하는 것을 의미

- 통합 테스트의 경우, @SpringBootTest를 사용하여 진행

 

 

단위 테스트

- 단위 테스트는 프로젝트에 필요한 모든 기능에 대한 테스트를 각각 진행하는 것을 의미

- 일반적으로 스프링 부트에서는 'org.springframework.boot:spring-boot-starter-test' 디펜던시만으로 의존성을 모두 가질 수 있다.

 

F.I.R.S.T 원칙

- Fast: 테스트 코드의 실행은 빠르게 진행되어야 한다.

- Independent: 독립적인 테스트가 가능해야 한다.

- Repeatable: 테스트는 매번 같은 결과를 만들어야 한다.

- Self-Validating: 테스트는 그 자체로 실행하여 결과를 확인할 수 있어야 한다.

- Timely: 단위 테스트는 비즈니스 코드가 완성되기 전에 구성하고 테스트가 가능해야 한다.

 

 

Test 코드 작성

import org.junit.jupiter.api.*;

public class TestLifeCycle {
    @BeforeAll
    static void beforeAll() {
        System.out.println("## BeforeAll Annotation 호출 ##");
        System.out.println();
    }

    @AfterAll
    static void afterAll() {
        System.out.println("## afterAll Annotation 호출 ##");
        System.out.println();
    }

    @BeforeEach
    void beforeEach() {
        System.out.println("## beforeEach Annotation 호출 ##");
        System.out.println();
    }

    @AfterEach
    void afterEach() {
        System.out.println("## afterEach Annotation 호출 ##");
        System.out.println();
    }

    @Test
    void test1() {
        System.out.println("## test1 시작 ##");
        System.out.println();
    }

    @Test
    @DisplayName("Test Case 2!!!")
    void test2() {
        System.out.println("## test2 시작 ##");
        System.out.println();
    }

    @Test
    @Disabled
        // Disabled Annotation : 테스트를 실행하지 않게 설정하는 어노테이션
    void test3() {
        System.out.println("## test3 시작 ##");
        System.out.println();
    }

}

 

 

- 위 코드를 작성하고 테스트를 진행하면 이렇게 뜬다.

 

Controller, Service Test 코드 작성

- Controller

package hello.hellospring.controller;

import com.google.gson.Gson;
import hello.hellospring.dto.ProductDto;
import hello.hellospring.service.ProductServiceImpl;
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 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;

@WebMvcTest(ProductController.class)
//@AutoConfigureWebMvc // 이 어노테이션을 통해 MockMvc를 Builder 없이 주입받을 수 있음
public class ProductControllerTest {
    @Autowired
    private MockMvc mockMvc;

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

    @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");
    }

    @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();

        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);
    }

 

 

- Service

package hello.hellospring.service.impl;

import hello.hellospring.domain.Product;
import hello.hellospring.dto.ProductDto;
import hello.hellospring.handler.impl.ProductDataHandlerImpl;
import hello.hellospring.service.ProductServiceImpl;
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.context.SpringBootTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.context.annotation.Import;
import org.springframework.test.context.junit.jupiter.SpringExtension;

import static org.mockito.Mockito.verify;

//@SpringBootTest(classes = {ProductDataHandlerImpl, ProductDataHandlerImpl.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);
    }

}

 

 

 

 

- 참고

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