[스프링] 스프링 부트와 AWS로 혼자 구현하는 웹 서비스 - 스프링 부트에서 테스트 코드 작성하기

June·2021년 3월 2일

[스프링] 스프링 부트와 AWS로 혼자 구현하는 웹 서비스

목록 보기

2/10

요즘은 코딩 테스트를 알고리즘이 아닌 프로젝트를 만들고, 단위 테스트를 필수조건으로 두는 경우도 있다.

테스트 코드 소개

TDD와 단위 테스트는 다른 이야기다. TDD는 테스트가 주도하는 개발이다. 테스트 코드를 먼저 작성하는 것부터 시작한다.

반면 단위 테스틑 TDD의 첫 번째 단계인 기능 단위의 테스트 코드를 작성하는 것을 이야기한다. TDD와 달리 테스트 코드를 꼭 먼저 작성해야 하는 것도 아니고, 리팩토링도 포함되지 ㅇ낳는다. 순수하게 테스트 코드만 작성하는 것을 이야기한다.

테스트 코드 작성의 장점

단위 테스트는 개발단계 초기에 문제를 발견하게 도와준다.

단위 테스트는 개발자가 나중에 코드를 리팩토링하거나 라이브러리 업그레이드 등에서 기존 기능이 올바르게 작동하는지 확인할 수 있다.

단위 테스트는 기능에 대한 불확실성을 감소시킬 수 있다.

단위 테스트는 시스템에 대한 실제 문서를 제공한다. 즉, 단위 테스트 자체가 문서로 사용할 수 있다.

Hello Controller 테스트 코드 작성하기

package com.jojoldu.book.springboot;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

Application 클래스는 앞으로 만들 프로젝트의 메인 클래스가 된다. @SpringBootApplication으로 인해 스프링 부트의 자동 설정, 스프링 Bean 읽기와 생성을 모두 자동으로 설정된다. 특히나 @SpringBootApplication이 있는 위치부터 설정을 읽어가기 때문에 이 클래스는 항상 프로젝트 최상단에 위치해야 한다.

main 메소드에서 실행하는 SpringApplication.run으로 인해 내장 WAS (Web Application Server)를 실행한다. 내장 WAS란 별도로 외부에 WAS를 두지 않고 애플리케이션을 실행할 때 내부에서 WAS를 실행하는 것을 이야기한다. 이렇게 되면 항상 서버에 톰캣을 설치할 필요가 없게 되고, 스프링 부트로 만들어진 Jar 파일 (실행 가능한 Java 패키징 파일)로 실행하면 된다.

꼭 스필 부트에서만 내장 WAs를 사용할 수 있는 것은 아니짐나, 스프링 부트에서는 내장 WAS를 사용하는 것을 권장하고 있다. 이유는 언제 어디서나 같은 환경에서 스프링 부트를 배포할 수 있기 때문이다.
외장 WAS를 쓴다고 하면 모든 서버는 WAS의 종류와 버전, 설정을 일치시켜야만 하기 때문에 번거롭다.

/web/HelloController

package com.jojoldu.book.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";
    }
}

@RestController

컨트롤러를 JSON을 반환하는 컨트롤러로 만들어 준다

예전에는 @ResponseBody를 각 메소드마다 선언했던 것을 한번에 사용할 수 있게 해준다고 생각하면 된다.

@GetMapping

HTTP Method인 Get의 요청을 받을 수 있는 API를 만들어 준다.

예전에는 @RequestMapping(method = RequestMethod.GET)으로 사용되었다. 이제 이 프로젝트는 /hello로 요청이 오면 문자열 hello를 반환하는 기능을 가지게 되었다.

HelloController 클래스 명에 커서를 놔두고 Ctrl+Enter를 누르고 테스트 코드를 만드는 옵션을 선택하자.

src/test/java/com/jojoldu/book/springboot/web/HelloControllerTest

package com.jojoldu.book.springboot.web;

import junit.framework.TestCase;
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 org.springframework.test.web.servlet.ResultActions;
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)  // 1
@WebMvcTest(controllers = HelloController.class)  // 2
public class HelloControllerTest extends TestCase {
    
    @Autowired  //3 
    private MockMvc mvc;  // 4
    
    @Test
    public void hello가_리턴된다() throws Exception {
        String hello = "hello";

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

@RunWith(SpringRunner.class)

테스트를 진행할 때 JUnit에 내장된 실행자 외에 다른 실행자를 실행시킨다.

여기서는 SpringRunner라는 스프링 실행자를 사용한다.

즉, 스프링 부트 테스트와 JUnit 사이에 연결자 역할을 한다.

@WebMvcTest

여러 스프링 테스트 어노테이션 중, Web(Spring MVC)에 집중할 수 있는 어노테이션이다.

선언할 경우 @Controller, @ControllerAdvice 등을 사용할 수 있다.

단, @Service, @Component, @Repository 등은 사용할 수 없다.

여기서는 컨트롤러만 사용하기 때문에 선언한다.

@Autowired

스프링이 관리하는 빈(Bean)을 주입 받는다

private MockMvc mvc

웹 API를 테스트할 때 사용한다.

스프링 MVC 테스트의 시작점이다.

이 클래스를 통해 HTTP GET, POST 등에 대한 API를 테스트할 수 있다.

mvc.perform(get("/hello"))

MockMvc를 통해 /hello 주소로 HTTP GET 요청을 한다.

체이닝이 지원되어 아래와 같이 여러 검증 기능을 이어서 선언할 수 있다.

.andExpect(status().isOk())

mvc.perform의 결과를 검증한다

HTTP Header의 Status를 검증한다

우리가 흔히 알고 있는 200, 404, 500 등의 상태를 검증한다

여기선 OK 즉, 200인지 아닌지를 검증한다.

.andExpect(content().string(hello))

mvc.perform의 결과를 검증한다

응답 본문의 내용을 검증한다

Controller에서 "hello"를 리턴하기 때문에 이 값이 맞는지 검증한다.

테스트 코드도 잘 작동하고 실제로 수동으로 localhost:8080/hello로 들어가도 hello가 나오는 것을 알 수 있다. 브라우저로 한 번씩 검증은 하되, 테스트 코드는 꼭 따라 해야한다. 추가로 절대 수동으로 검증하고 테스트 코드를 작성하지 않는다.. 테스트 코드로 먼저 검증 후, 프로젝트를 실행해 확인한다.

롬복 소개 및 설치하기

롬복은 자바 개발할 때 자주 사용하는 코드 Getter, Setter, 기본생성자, toString 등을 어노테이션으로 자동 생성해준다.

compile('org.projectlombok:lombok')

dependencies에 추가해준다.

Ctrl + Shift + A에서 plugins를 선택하고 marketplace에서 "lombok"을 검새갛여 install하고 재시작한다.

Setting-> annotation processor -> enable annotation processing 체크

Hello Controller 코드를 롬복으로 전환하기

먼저 web 패키지에 dto 패키지를 추가한다. 앞으로 모든 응답 DTO는 이 Dto 패키지에 추가한다. 이 패키지에 HelloResponseDto를 생성한다.

src/main/java/com/jojoldu/book/springboot/web/dto
HelloResponseDto

package com.jojoldu.book.springboot.web.dto;

import lombok.Getter;
import lombok.RequiredArgsConstructor;

@Getter
@RequiredArgsConstructor
public class HelloResponseDto {
    
    private final String name;
    private final int amount;
}

@Getter

선언된 모든 필드의 get 메소드를 생성해 준다.

@RequiredArgsConstructor

선언된 모든 final 필드가 포함된 생성자를 생성해 준다.

final이 없는 필드는 생성자에 포함되지 않는다.

src/test/java/com/jojoldu/book/springboot/web/dto
HelloResponseDtoTest

package com.jojoldu.book.springboot.web.dto;

import junit.framework.TestCase;
import org.assertj.core.api.Assertions;
import org.junit.Test;

public class HelloResponseDtoTest extends TestCase {
    
    @Test
    public void 롬복_기능_테스트() {
        //given
        String name = "test";
        int amount = 1000;
        
        //when
        HelloResponseDto dto = new HelloResponseDto(name, amount);
        
        //then
        Assertions.assertThat(dto.getName()).isEqualTo(name); // 1, 2
        Assertions.assertThat(dto.getAmount()).isEqualTo(amount);
        
    }
}

만약 여기서 에러가 난다면 build.gradle에 dependencies를 아래와 같이 맞추자

dependencies {
    compile('org.springframework.boot:spring-boot-starter-web')
    testCompile('org.springframework.boot:spring-boot-starter-test')
    //롬복 관련
    compile('org.projectlombok:lombok')
    testCompile "org.projectlombok:lombok"
    annotationProcessor('org.projectlombok:lombok')
    testAnnotationProcessor('org.projectlombok:lombok')
}

assertThat

assertj라는 테스트 검증 라이브러리의 검증 메소드이다.

검증하고 싶은 대상을 메소드 인자로 받는다.

메소드 체이닝이 지원되어 isEquatTo와 같이 메소드를 이어서 사용할 수 있다.

isEqualTo

assertj의 등등 비교 메소드이다.

assertThat에 있는 값과 isEqualTo 값을 비교해서 같을 때만 성공이다.

이 책은 Junit의 기본 assertThat이 아닌 assertj의 assertThat을 사용했다. assertj 역시 Junit에서 자동으로 라이브러리 등록을 해준다. Junit과 비교하여 assertj의 장점은 다음과 같다.

CoreMatchers와 달리 추가적으로 라이브러리가 필요하지 않다.
- Junit의 assertThat을 쓰게 되면 is()와 같이 CoreMatchers 라이브러리가 필요하다.
자동완성이 좀 더 확실하게 지원된다.
- IDE에서는 CoreMatchers와 같은 Matchers 라이브러리의 자동완성 지원이 약하다.

테스트를 퇑가하면 롬복의 @Getter로 get메소드가, @RequiredArgsConstructor로 생성자가 자동으로 생성되는 것이 증명되었다.

그럼 HelloController에도 새로 만든 ResponseDto를 사용하도록 코드를 추가해보자.

package com.jojoldu.book.springboot.web;

import com.jojoldu.book.springboot.web.dto.HelloResponseDto;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

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

    @GetMapping("/hello/dto")
    public HelloResponseDto helloDto(@RequestParam("name") String name, // 1
                                    @RequestParam("amount") int amount) {
        return new HelloResponseDto(name, amount);
    }
}

@RequestParam

외부에서 API로 넘긴 파라미터로 가져오는 어노테이션이다.

여기서는 외부에서 name (@RequestParam("name"))이란 이름으로 넘긴 파라미터를 메소드 파라미터 name(String name)에 저장하게 된다.

name과 amount는 API를 호출하는 곳에서 넘겨준 값들이다. 추가된 API를 테스트하는 코드를 HelloControllerTest에 추가한다.

package com.jojoldu.book.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.hamcrest.CoreMatchers.is;
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.jsonPath;
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));
    }

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

        mvc.perform(
            get("/hello/dto")
                .param("name", name)
                .param("amount", String.valueOf(amount)))
            .andExpect(status().isOk())
            .andExpect(jsonPath("$.name", is(name)))
            .andExpect(jsonPath("$.amount", is(amount)));
    }
}

param
- API 테스트할 때 사용될 요청 파라미터를 설정한다
- 단, 값은 String만 허용된다
- 그래서 숫자/날짜 등의 데이터도 등록할 때는 문자열로 변경해야만 가능하다
jsonPath
- JSON 응답ㄱ밧을 필드별로 검증할 수 있는 메소드이다.
- $를 기준으로 필드명을 명시한다
- 여기서는 name과 amount를 검증하니 $.name, $.amount로 검증한다.

June

이전 포스트

[스프링] 스프링 부트와 AWS로 혼자 구현하는 웹 서비스 - 인텔리제이로 스프링부트 시작하기

다음 포스트

[스프링] 스프링 부트와 AWS로 혼자 구현하는 웹 서비스 - 스프링 부트에서 테스트 코드 작성하기