Java Test 코드 작성 방법과 JUnit

카테고리 없음

Java Test 코드 작성 방법과 JUnit

계란💕 2022. 10. 19. 12:04

TDD(Test Driven Development, 테스트 주도 개발)란?
- 테스트 주도 개발이라는 의미를 가진다.
- 테스트를 먼저 작성하고나서 테스트를 통과할 수 있는 코드를 짜는 것이다.
- 코드 작성 후, 테스트를 진행하는 일반적인 방식과 차이가 있다.
- 애자일 개발 방식 중 하나이다.
  - 코드 설계 시 원하는 단계적 목표에 대해 설정하여 진행하고자 하는 것에 대한 결정 방향의 갭을 줄이고자 한다.
  - 최초 목표에 맞춘 테스트를 구축하여 그에 맞게 코드를 설계하기 때문에 의견 충돌을 줄일 수 있다.
- 테스트 코드를 작성하는 이유는?
  - 코드의 안정성을 높인다.
  - 기능 추가하거나 변경하는 과정에서 side effect를 줄일 수 있다.
  - 해당 코드가 작성된 목적을 명확하게 표현 가능

JUnit이란?
- Java 진영의 대표적인 Test Framework
- 단위 테스트(unit test)를 위한 도구를 제공한다.
  - 단위 테스트: 코드의 특정 모듈이 의도한대로 작동하는지 테스트하는 절차
  - 모든 함수의 메서드에 대한 각각의 테스트 케이스를 작성하는 것
- 어노테이션을 기반으로 테스트를 지원한다.
- 단정문(assert)으로 테스트 케이스의 기댓값에 대한 수행 결과를 확인할 수 있다.
- JUnit 5는 크게 Jupiter, Platform, Vintage 모듈로 구성된다.

JUnit 모듈 설명
- JUnit Jupiter: TestEngine API 구현체로 JUnit5를 구현하고 있다.
  - 테스트의 실제 구현체는 별도 모듈 역할을 수행하는데 그 모듈 중 하나가 Jupiter Engine이다.
  - 이 모듈은 Jupiter API를 사용해서 작성한 테스트 코드를 발견하고 실행하는 역할을 수행한다.
  - 테스트 코드 작성할 때 사용한다.
- JUnit platform: test 실행하기 위한 뼈대를 가지고 있다.
  - test를 발견하고 테스트 계획을 생성하는 TestEngine 인터페이스를 가지고 있다.
  - TestEnginr을 통해 test를 발견하고 수행 및 결과를 보고한다.
  - 각종 IDE 연동을 보조하는 역할을 수행한다. (콘솔 출력 )
  - (platformn = testEngine API + console launcher + JUnit 4 based runner 등)
  - Jupiter가 platform을 구현한다.
- JUnit Vintage
  - TestEngine API 구현체로 JUnit 3, 4를 구현하고 있다.
  - 기존 JUnit 3, 4 버전으로 작성된 테스트 코드를 실행할 때, 사용된다.
  - vintage-engine 모듈을 포함하고 있다.

JUnit LifeCycle annotation (JUnit 5)
- @Test:테스트용 메서드를 표현
- @BeforeEach: 각 테스트 메서드가 시작되기 전에 실행되어야하는 메서드를 표현
- @AfterEach: 각 테스트 메서드가 시작된 후, 실행되어야하는 메서드를 표현
- @BeforeAll: 테스트 시작 전에 실행되어야 하는 메서드 표현, static 처리가 필요하다.
- @AfterAll: 테스트 종료 후에 실행되어야 하는 메서드 표현, static 처리가 필요하다.

JUnit Main annotation
- @SpringBootTest
  - 통합 테스트 용도로 사용된다.
  - @SpringBootApplication을 찾아가 하위의 모든 bean을 스캔하여 로드함.
  - 그 다음, test 용 Application Context를 만들어 bean을 추가하고 MockBean을 찾아서 교체한다.
- @ExtendWith
  - JUnit 4에서 @RunWith로 사용되던 어노테이션이 @ExtendWith로 변경
  - @ExtendWith는 메인으로 실행될 클래스를 지정한다.
  - @SpringBootTest는 기본적으로 @ExtendWith를 포함하고 있다.
- @WebMvcTest("클래스명".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
  - 필요한 클래스들을 configuration으로 만들어 사용할 수 있다.
  - configuration component 클래스도 의존성을 설정할 수 있다.
  - import 된 클래스는 주입으로 사용 가능 (@Autiwored)

통합 테스트
- 통합 테스트는 여러 기능을 조합하여 전체 비즈니스 로직이 제대로 동작하는 지 확인한다.
- 통합 테스트의 경우, @SpringBootTest를 사용해서 진행한다.
  - @SpringBootTest는 @SpringBootApplication을 찾아가서 모든 bean을 로드하게 된다.
  - 이 방법을 대규모 프로젝트에서 사용할 경우, 테스트를 실행할 때마다 모든 bean을 스캔하고 로드하는 작업이 반복되어 매번 무거운 작업을 수행해야한다.
단위 테스트
- 단위 테스트는 프로젝트에 필요한 모든 기능에 대한 테스트를 각각 진행하는 것을 의미한다.
- 일반적으로 스프링 부트에서는 "spring-boot-starter-test" 디펜던시만으로 의존성을 모두 가질 수 있다.
- F.I.R.S.T 원칙
  - fast: 테스트 코드의 실행은 빠르게 진행되어야한다.
  - independent: 독립적인 테스트가 가능해야한다.
  - repeatable: 테스트 매번 같은 결과를 만들어야한다.
  - self-validating: 테스트를 그 자체로 실행해서 결과를 확인할 수 있어야한다.
  - timely: 단위 테스트는 비즈니스 코드가 완성되기 전에 구성하고 테스트가 가능해야한다.
    - 코드가 완성되기 전에 테스트가 따라와야한다는 TDD 원칙을 담고 있다.

테스트 관련 메서드

given(): Mock 객체가 특정 상황에서 해야하는 행위를 정의하는 메서드이다.
andExpect(): 기대하는 값이 나왔는지 체크할 수 있는 메서드

테스트 관련 메서드

@MockBean, @Mock 의 차이는?
- @MockBean: 스프링 부트 컨테이너가 필요하고 컨테이너에 존재해야하는 경우에 쓴다.
  - 경로: org.springframework.boot.test.mock.mockito.MockBean => @Mock과 다르게 spring 영역에 있다.
  - 스프링 컨텍스트에 mock 객체를 등록하고 스프링 컨텍스트에 의해 @Autowired가 동작할 때, 등록된 mock 객체를 사용할 수 있도록 동작한다.
- @Mock:
  - 경로: org.mockito.Mock => 모키토 라이브러리 내에 위치한다.
  - Mockito.mock() 를 대체 가능하다.

Ex) 테스트

Dto을 리턴하는 메서드 getProduct()를 이용하면 어떤 Dto가 자동으로 생성되서 반환될 것이다.
get() 이라는 http 리퀘스트를 날린다.
andExpect(): 기대하는 값이 나왔는지 체크하는 메서드이다.
$를 이용해서 json의 key 값을 조회한다. exists()로 존재하는지 확인한다.
기본적으로 json 형태의 body를 받는다.
verify(): 해당 객체의 메서드가 실행됐는지 체크해준다.

// productId, productName, productPrice, productStock 순서대로

// given
given(productService.getProduct("12345")).willReturn(
    new ProductDto("12345", "pen", 5000, 2000)
);

// when
String productId = "12345";
mockMvc.perform(get("/api/v1/product-api/product/" + productId)).andExpect(status().isOk())
                                                                .andExpect(jsonPath("$.productIf").exists())
                                                                .andExpect(jsonPath("$.productName").exists())
                                                                .andExpect(jsonPath("$.productStock").exists())
                                                                .andDo(print());
// then            
verify(productService).getProduct("12345");

Ex) MemberServiceImplTest

@ExtendWith(클래스명): 메인으로 실행할 클래스를 의미한다.

<hide/>
package com.rezero.inandout.member.service;

import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;

import com.rezero.inandout.member.entity.Member;
import com.rezero.inandout.member.model.JoinMemberInput;
import com.rezero.inandout.member.repository.MemberRepository;
import java.time.LocalDate;
import java.util.Optional;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;


@DisplayName("MemberServiceImpl 테스트")
@ExtendWith(MockitoExtension.class)
class MemberServiceImplTest {

    @Mock
    private MemberRepository memberRepository;

    @Mock
    private BCryptPasswordEncoder bCryptPasswordEncoder;

    @InjectMocks
    private MemberServiceImpl memberService;

    @Test
    @DisplayName("회원가입")
    void join() {

        // given
        given(memberRepository.findByEmail(anyString())).willReturn(Optional.empty());
        Member member = Member.builder()
            .email("egg@naver.com")
            .phone("010-2222-0000")
            .password(bCryptPasswordEncoder.encode("abc!@#12"))
            .build();
        memberRepository.save(member);

        // when
        JoinMemberInput memberInput = JoinMemberInput.builder()
            .email("egg@naver.com")
            .address("서울특별시")
            .phone("010-2222-0000")
            .birth(LocalDate.from(LocalDate.of(2000, 9, 30)))
            .gender("남")
            .nickName("원빈")
            .password("abc!@#12")
            .build();
        memberService.join(memberInput);

        // then
        verify(memberRepository, times(1)).save(member);

    }
}

Ex) MemberControllerTest

<hide/>
package com.rezero.inandout.member.controller;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.times;
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.status;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.rezero.inandout.member.model.JoinMemberInput;
import com.rezero.inandout.member.repository.MemberRepository;
import com.rezero.inandout.member.service.MemberServiceImpl;
import java.time.LocalDate;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.mockito.ArgumentCaptor;
import org.mockito.Mockito;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
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;


@WebMvcTest(MemberController.class)
@DisplayName("MemberController 테스트")
@AutoConfigureMockMvc(addFilters = false)
class MemberControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @Autowired
    ObjectMapper mapper;

    @MockBean
    private MemberServiceImpl memberServiceImpl;

    @MockBean
    private MemberRepository memberRepository;

    @Test
    void signUp() throws Exception {

        // given
        JoinMemberInput memberInput = JoinMemberInput.builder()
            .email("egg@naver.com")
            .address("서울특별시")
            .phone("010-2222-0000")
            .birth(LocalDate.from(LocalDate.of(2000, 9, 30)))
            .gender("남")
            .nickName("원빈")
            .password("1")
            .build();

        String memberInputJson = mapper.writeValueAsString(memberInput);

        //when
        mockMvc.perform(
                post("/api/signup")
                    .contentType(MediaType.APPLICATION_JSON)
                    .content(memberInputJson))
            .andExpect(status().isOk())
            .andDo(print());
        ArgumentCaptor<JoinMemberInput> captor = ArgumentCaptor.forClass(JoinMemberInput.class);

        //then
        Mockito.verify(memberServiceImpl, times(1)).join(captor.capture());
        assertEquals(captor.getValue().getEmail(), memberInput.getEmail());

    }
}

출처 - https://www.youtube.com/watch?v=SFVWo0Z5Ppo

YouTube

www.youtube.com

저작자표시