스프링 부트 테스트 코드 작성 방법

목차

---

• TDD의 정의
• Controller 테스트 코드 작성
• JUnit 소개
  • Junit Annotation
• 객체 생성 테스트
  • assert 메서드

---

TDD

• “테스트 주도 개발: 테스트가 개발을 이끌어 나간다.” 라고 정의할 수 있다.
• 메소드나 함수같은 프로그램 모듈을 작성할 때, 작성 종료조건을 먼저 정해놓고 코딩을 시작한다’는 의미로 받아들이면 편하다.
• RED: 항상 실패하는 테스트를 먼저 작성
• GREEN: 테스트에 통과하는 프로덕션 코드 작성
• REFACTOR: 테스트가 통과하면 프로덕션 코드를 리팩토링

위의 레드 그린 사이클처럼 테스트 코드를 작성하고 그걸 통과하는 코드를 만드는 과정을 반복하면서 제대로 동작하는지에 대한 피드백을 적극적으로 받는다.

TDD를 사용하는 이유

• 개발 단계 초기에 문제를 발견하게 해준다.
• 추후에 코드를 리팩토링하거나 라이브러리 업그레이드 등에서 기존기능이 올바르게 작동하는지 확인할 수 있다.
• 기능에 대한 불확실성을 감소시켜준다.
• 시스템에 대한 실제 문서를 제공한다.

Controller Test Class 작성

HelloController Class

package com.swchoi.webservice.springboot.web;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @GetMapping("/hello")
    public String hello(){
        return "hello";
    }
}

HelloControllerTest Class

package com.swchoi.webservice.springboot.web;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@RunWith(SpringRunner.class)
@WebMvcTest(controllers = HelloController.class)
public class HelloControllerTest {

    @Autowired
    private MockMvc mvc;

    @Test
    public void hello가_리턴된다() throws  Exception {
        String hello = "hello";

        mvc.perform(get("/hello"))
                .andExpect(status().isOk())
                .andExpect(content().string(hello));
    }
}

• @RunWith(SpringRunner.class)
  • 테스트를 진행할 때 JUnit에 내장된 실행자 외에 다른 실행자를 실행시킴
• @WebMvcTest
  • 여러 스프링 테스트 어노테이션 중, Web(Spring MVC)에 집중할 수 있는 어노테이션이다.
  • 선언할 경우 @Controller, @ControllerAdvice 등을 사용할 수 있다.
  • 하지만 @Service, @Component, @Repository 등은 사용할 수 없다.
• MockMvc mcv
  • 웹 API를 테스트할 때 사용
  • 스프링 MVC 테스트의 시작점
  • 이 클래스를 통해 HTTP GET, POST 등에 대한 API 테스트를 진행할 수 있다.
• mvc.perform(get(”/hello”))
  • MockMvc를 통해 /hello 주소로 HTTP GET 요청을 한다.
  • 체이닝이 지원되어 아래와 같이 여러 검증 기능을 이어서 선언할 수 있다.
• .andExpect(status().isOk())
  • mvc.perform의 결과를 검증한다
  • HTTP Header의 Status를 검증한다
• .andExpect(content().string(hello))
  • mvc.perform의 결과를 검증한다.
  • 응답 본문의 내용을 검증한다.

---

Junit 소개

• 자바 프로그래밍 언어용 단위 테스트 프레임워크이다.
• 어노테이션을 기반으로 테스트를 지원한다
• 단정문(Assert)를 통해서 테스트 케이스의 기대값에 대해 수행 결과를 확인할 수 있다.
• Junit5은 크게 Jupiter, Platform, Vintage 모듈로 구성되어 있다.

Junit Jupiter

• TestEngine API 구현체

Junit Platform

• test를 실행하기 위한 뼈대
• 각종 IDE 연동을 보조하는 역할

Junit Vintage

• TestEngine 구현체 JUnit 3,4를 구현하고 있음

Junit Annotation

@SpringBootTest

• 통합 테스트 용도로 사용됨
• @SpringBootApplication을 찾아가 하위의 모든 Bean을 스캔하여 로드함

@ExtendWith

• 메인으로 실행될 Class를 지정할 수 있음
• SpringBootTest는 기본적으로 ExtendWith가 추가되어 있음

@WebMvcTest(Class명.class)

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

@MockBean

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

@AutoConfigureMockMvc

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

@Import

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

객체 생성 테스트

@Test
	@DisplayName("Post 생성 테스트")
	void CreatePost(){
		System.out.println("## Create Post 시작 ##");
		System.out.println();
		
		Long userId = 123456L;
		User user = new User("Test", "123", UserRole.USER, "nickName");
		PostRequestDto postRequestDto = new PostRequestDto();
		postRequestDto.setTitle("test 제목");
		postReqeustDto.steContent("test 내용");
		
		Post post = new Post(postRequestDto, user);

		assertEquals(post.getImg(), "/img/no-pic.png");
		assertEquals(post.getTitle(), "Test");
	}

assertEquals 함수를 이용해 기대값과 맞는 값이 들어가는지 테스트를 해 볼 수 있다.

assert 메서드

• assertEquals(a, b) - a와 b의 값이 동일한지 확인
• assertSame(a, b) - a와 b의 객체가 동일한지 확인
• assertNull(a) - a가 null인지 확인
• assertNotNull(a) - a가 notnull인지 확인
• assertTrue(a): a가 true인지 확인
• assertFalse(a): a가 false인지 확인
• assertThrows(error e, logic b) - b 로직시에 e 익셉션이 발생하는지 확인

legalStateException e = assertThrows(IllegalStateException.class,
	() -> memberService.join(member2)); // 예외가 발생해야 함

assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");

• assertThat - AssertJ 라이브러리에 포함된 메서드, 어떤 조건이 참인지 확인

import static org.assertj.core.api.Assertions.*;

IllegalStateException e = assertThrows(IllegalStateException.class,
	() -> memberService.join(member2)); // 예외가 발생해야 함

asserThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");

Junit 유효성 테스트

Validation 테스트 코드

유효성 검사 클래스

@Component
public class PostValidator {
    public static void validatePostInput(PostRequestDto requestDto, Long userId) {
        if (userId == null || userId <= 0) {
            System.out.println(userId);
            throw new IllegalArgumentException("회원 Id 가 유효하지 않습니다.");
        }

        if (requestDto.getTitle() == null || requestDto.getTitle().isEmpty()) {
            throw new IllegalArgumentException("저장할 수 있는 상품명이 없습니다.");
        }

        if (requestDto.getContent() == null || requestDto.getContent().isEmpty()) {
            throw new IllegalArgumentException("저장할 수 있는 상품설명이 없습니다.");
        }

        if (requestDto.getImg()!=null && !MyURLValidator.isValidUrl(requestDto.getImg().toString())) {
            throw new IllegalArgumentException("상품 이미지 URL 포맷이 맞지 않습니다.");
        }
    }
}

public class MyURLValidator {
    public static boolean isValidUrl(String url)
    {
        try {
            new URL(url).toURI();
            return true;
        }
        catch (URISyntaxException exception) {
            return false;
        }
        catch (MalformedURLException exception) {
            return false;
        }
    }
}

• 객체 생성시 validation 검사를 하고, Test시 원하는 에러메시지를 반환하는지 확인한다

public Post(PostRequestDto postRequestDto, User user){
	PostValidator.validatePostInput(postRequestDto, user.getId());
	
	this.user = user;
	this.title = postRequestDto.getTitle();
	this.content = postRequestDto.getContent();
}

@Nested
@DisplayName("게시글 객체 생성")
class CreateUserProduct {

	private Long userId;
	private String title;
	private String content;
	private MultipartFile img;
	private User user;
	
	@BeforeEach
	void setUp() {
		title = "제목"
		content = "테스트 내용"
		user = new User("Test", "123", UserRole.USER, "nickName");
		user.setId(123456L);
	}
	
	@Test
	@DisplayName("Post 생성 정상 테스트")
	void CreatePost() {
		System.out.println("## Create Post 시작 ##");
		System.out.println();

		PostRequestDto postReqeustDto = new PostRequestDto();
		postRequestDto.setTitle(title);
		postRequestDto.setContent(content);
		
		Post post = new Post(postRequestDto, user);
	
		assertEquals(post.getImg(), "/img/no-pic.png");
		assertEquals(post.getTitle(), title);
}

@Nested
@DisplayName("실패 케이스")
class FailCases {
	@Nested
	@DisplayName("회원 Id")
	class userId {
		@Test
		@DisplayName("null")
		void fail1() {
			// given
			user.setId(null);
		
			PostRequestDto requestDto = new PostRequestDto(
		title, content);
		
		// when
		Exception exception = assertThrows(IllegalArgumentException.class, () ->
			new Post(requestDto, user);
		});
		
		// then
		assertEquals("회원 Id가 유효하지 않습니다", exception.getMessage());
.....

@Nested 어노테이션은 @Test를 그룹으로 묶어 마치 클래스처럼 사용할 수 있게 만드는 어노테이션이다.

참고 링크

---

[Spring boot] 테스트 코드 작성 (1) - Junit을 이용한 Unit Test(단위 테스트) / Assert 메소드

https://thalals.tistory.com/273

Spring Boot 테스트 코드 작성

https://velog.io/@swchoi0329/Spring-Boot-테스트-코드-작성