02장 정리

1. 테스트 코드의 중요성

견고한 서비스를 위해선 TDD와 테스트 코드가 필수적이고, 채용 과제에 단위 테스트를 요구하는 회사도 있다고 합니다.

2. TDD와 단위 테스트

TDD

• 테스트가 주도하는 개발
• 테스트 코드를 먼저 작성하는 것부터 시작

TDD의 사이클

• 항상 실패하는 테스트 먼저 작성 (Red)
• 테스트가 통과하는 프로덕션 코드 작성 (Green)
• 테스트가 통과하면 프로덕션 코드 리팩토링 (Refactor)

단위 테스트

• TDD의 첫번째 단계인 기능 단위의 테스트 코드를 작성하는 것

왜 단위 테스트가 필요한가?

• 톰캣을 올렸다 내리고 print로 찍어보는 노가다를 안해도 됨
• 개발 단계 초기에 문제 발견
• 리팩토링, 업그레이드 시에 작동 문제 없는지 확인
• 기능의 불확실성 감소
• 단위 테스트를 문서로도 사용 가능

3. 직접 테스트 해보자

메인 클래스 생성

src > main > java 에 새 패키지를 추가한 뒤, 하위에 자바 클래스를 생성한 후 하단의 코드를 작성합니다.

Application.java

package com.hellspring;

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

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

Application 클래스는 프로젝트의 메인 클래스입니다.

@SpringBootApplication 은 스프링 자동 설정 데코레이터이며, 이 데코레이터가 위치한 지점부터 적용되기 때문에 프로젝트 최상단에 위치해야 합니다.

SpringApplication.run 은 내장 WAS(Web Application Server)를 실행합니다. 이 경우 톰캣은 설치할 필요가 없습니다.

테스트 Controller 생성

이전에 생성한 패키지의 하위에 새 패키지 web을 생성합니다. 그 다음 web에 HelloController 자바 클래스를 생성하여 하단의 코드를 작성합니다.

HelloController.java

package com.hellspring.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을 반환하는 컨트롤러로 만들어줌

GetMapping

• HTTP Get 요청을 받을 수 있는 API를 만들어줌

아하! 그렇다면...

네 맞습니다. /hello로 Get이 요청되면 hello문자열을 json 형태로 반환하는 것입니다.

테스트 코드 생성

WAS를 실행하지 않고, 테스트 코드로 검증해봅니다.

src > test > java 에 이전의 패키지를 그대로 생성한 후, 해당 패키지에 테스트 클래스를 생성합니다.
테스트 클래스명은 일반적으로 대상 클래스명 + Test 로 짓습니다.

클래스가 생성되었다면 하단의 코드를 작성해줍니다.

HelloControllerTest.java

package com.hellspring.web;

import org.junit.jupiter.api.Test;
// import org.junit.runner.RunWith;
import org.junit.jupiter.api.extension.ExtendWith;
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.context.junit.jupiter.SpringExtension;
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;

@ExtendWith(SpringExtension.class)
@WebMvcTest(controllers = HelloController.class)
public class HelloControllerTest {
    @Autowired
    private MockMvc mvc;

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

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

책에서는 JUnit4 기준으로 RunWith, SpringRunner를 사용하고 있지만, 이는 JUnit5에서 각각 ExtendWith, SpringExtension으로 변경되었으므로 작성 시 유의합니다.

그 다음 코드에 하이라이팅 되어있는 라인의 ▶ 버튼을 눌러 Test 클래스를 Run 합니다. 이후 ✔️Tests Passed 표시가 뜨면 테스트를 통과한 것입니다.

4. 롬복

롬복이란?

Getter, Setter, 기본생성자, toString 등을 어노테이션으로 자동 생성해주는 자바 라이브러리

롬복 설치하기

라이브러리 설치

dependencies에 다음의 코드를 추가합니다.

build.gradle

implementation 'org.projectlombok:lombok'

플러그인 설치

Settings > Plugins (또는 ctrl + shift + A > Plugins) 에서 install 하라고 나와있지만 이미 되어있네..'ㅁ'?

어노테이션 기능 활성화

hoxy..? 하면서 Settings > Build, Execution, Deployment > Compiler > Annotation Processors를 확인해봅니다.

• Enable annotation processing

그럼 그렇지, 인텔리제이에 지성이 깃들었을리가 없습니다. 체크해줍시다.

롬복으로 전환하기

안전하게 롬복으로 전환하기 위해 여기서도 테스트 코드를 사용합니다.

Dto 클래스 생성하기

src > main > java > ... > web 의 하위에 dto를 생성한 후, 해당 패키지에 HelloResponseDto 클래스를 생성합니다.

HelloResponseDto.java

package com.hellspring.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로 선언된 필드에 한해 생성자 생성

Dto에 적용한 롬복 테스트하기

src > test > java > ... > web > dto 패키지에 HelloResponseDtoTest 클래스를 생성합니다.

HelloResponseDtoTest.java

package com.hellspring.web.dto;

import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;

public class HelloResponseDtoTest {
    @Test
    public void lombok_test() {
        String name = "test";
        int amount = 1000;

        HelloResponseDto dto = new HelloResponseDto(name, amount);

        assertThat(dto.getName()).isEqualTo(name);
        assertThat(dto.getAmount()).isEqualTo(amount);
    }
}

assertThat

• 테스트 라이브러리 assertj의 테스팅 메소드
• 테스트 대상 = 파라미터
• 메소드 체이닝 ok (isEqualTo 등 뒤에 이어붙이기 가능)

Controller에 Dto 추가하기

HelloController.java에 다음의 코드를 추가합니다.

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

RequestParam

• 외부에서 API로 넘긴 파라미터를 가져옵니다.

추가한 API 테스트하기

HelloControllerTest.java

...
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.hamcrest.Matchers.is;

...
public class HelloControllerTest {
    ...

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

param

• API 테스트에 사용될 request 파라미터를 설정
• String 값만 허용하기에, 숫자/날짜 등의 데이터는 문자열로 변환하여 넘겨주어야 합니다.

jsonPath

• json 응답값을 필드 별로 검증할 수 있는 메소드
• $를 기준으로 필드명 명시

이제 ▶ 버튼을 눌러 추가한 테스트를 실행해봅니다. ✔️Tests Passed 표시가 뜨나요? 그럼 드디어 챕터 2가 끝났습니다!

불시에 gradle dependency가 맛가도 샷건치지 않고 묵묵히 고치는 나에게 칭찬합니다