2장: 테스트 코드 작성하기

Table of Contents

 

테스트 코드란

TDD

테스트 코드를 먼저 작성하는 테스트 주도 개발

1. 항상 실패하는 테스트 코드 작성

2. 테스트가 통과하는 프로덕션 코드 작성

3. 테스트가 통과하면 프로덕션 코드 리팩토링

 

이렇게 세 단계를 돌아가면서 개발하는 과정을 거친다.

 

단위테스트

- 기능 단위의 테스트 코드를 작성하는 것

- 필요성

•  개발 단계 초기에 문제 발견하도록 도와줌
• 추후 코드 리팩토링, 라이브러리 업그레이드 등에서 기존 기능의 동작을 확인 가능
• 기능에 대한 불확실성 감소시킴
• 시스템에 대한 실제 문서로 제공 가능

- 자바에서는 JUnit이라는 테스트 프레임워크가 사용됨

Controller 작성

일반적으로 패키지명은 웹 사이트 주소의 역순으로 설정

메인 클래스

package com.oliviarla.springboot;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.data.jpa.repository.config.EnableJpaAuditing;

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

@SpringBootApplication
- 스프링 부트의 자동 설정, 스프링 Bean 읽기 및 생성을 자동으로 설정함
- 메인 클래스가 있는 위치부터 설정을 읽어나가므로 프로젝트 최상단에 위치해야함

내장 WAS
- 별도로 외부에 WAS를 두지 않고 애플리케이션 실행 시 내부에서 실행됨
- 언제 어디서나 같은 환경에서 스프링 부트 배포 가능
- 외장 WAS 사용할 경우 모든 서버의 WAS 종류, 버전, 설정을 일치시켜야 하므로 복잡한 작업 소요됨 -> 내장 WAS로 해결 가능

 

컨트롤러 클래스

package com.oliviarla.springboot.web;

import com.oliviarla.springboot.web.dto.HelloResponseDto;
import lombok.RequiredArgsConstructor;
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";
    }
}

@RestController
- JSON을 반환하는 컨트롤러로 설정

@GetMapping
- HTTP Get 메소드의 요청을 받을 수 있는 API 메소드를 만들어 주는 어노테이션
- localhost:8080/hello 라는 url로 요청이 온다면 "hello"를 반환하는 기능을 제공함

 

테스트 클래스

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

    @Autowired //스프링이 관리하는 Bean 주입받음
    private MockMvc mvc;

    @Test
    public void return_hello() throws Exception{
        String hello = "hello";

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

MockMvc 클래스를 사용해 웹 API를 테스트하는 코드

@WebMvcTest: Web에 집중하여 테스트 할 수 있는 어노테이션

mvc.perform 메소드에서는...
- HTTP Header의 status가 200인지 확인
- Hello 컨트롤러에서 반환된 content가 "hello"와 일치하는지 확인

 

먼저 테스트코드로 검증한 후 신뢰가 가지 않는다면 프로젝트를 실행해 확인하는 방향으로 개발해야 함!

Lombok

자바 개발 시 자주 사용하는 Getter, Setter, 기본 생성자, toString 등을 어노테이션을 통해 자동 생성해줌

 

build.gradle에 의존성 추가

implementation 'org.projectlombok:lombok'

 

+) 롬복 플러그인 설치를 할 수 있으나 프로젝트 진행해봤을 때 설치하지 않아도 불편함 없이 진행되었으므로 생략합니다 🙂

 

Lombok 활용하기

롬복을 적용해 클래스를 생성해본다.

 

DTO 클래스

package com.oliviarla.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 없는 필드는 포함되지 않음)

 

컨트롤러 클래스 수정

package com.oliviarla.springboot.web;

import com.oliviarla.springboot.web.dto.HelloResponseDto;
import lombok.RequiredArgsConstructor;
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 helloResponseDto(@RequestParam("name") String name, @RequestParam("amount") int amount){
        return new HelloResponseDto(name, amount);
    }
}

파라미터 값으로 입력된 name, amount 값을 사용한 HelloResponseDto 객체를 생성해 반환

ex) "localhost:8080/hello/dto?name=kim&amount=1" 라는 URL 요청 시 HelloResponseDto(kim,1) 이라는 객체가 반환됨

 

 

테스트 클래스에 메소드 추가

@Test
    public void return_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)));
    }

파라미터 값으로 name과 amount 변수의 값을 전달하고, GET으로 얻은 JSON 응답 값과 일치하면 테스트가 통과하게 된다.

 

MVC의 param 값은 String만 허용되므로 int, date 형식을 사용하려면 String으로 형변환 후 사용해야 함.

 

 

마치며

보통 자바에서 테스트 코드를 작성할 때 Assertj의 AssertThat 메소드를 많이 사용하지만, 스프링 부트에서 테스트 코드를 작성할 때는 API 테스트에 적합한 MockMvc의 메소드를 사용하여 편리하게 단위테스트를 진행할 수 있다!