[springboot-webserivce] GET API test 코드 작성

[2020.12.28] 부터 스프링 부트와 AWS로 혼자 구현하는 웹 서비스 책을 통해 스프링 공부를 시작했다.

공부한 내용을 글로 정리하려고 한다.

그래야 나중에 다시 찾아보며 공부 할 수 있을테니까 !!

🍗 TDD

TDD 는 테스트가 주도하는 개발 을 의미한다.

먼저 무조건 실패하는 경우의 테스트 코드를 작성하고 다음으로 테스트를 통과하는 프로덕션 코드를 작성한다.

테스트가 통과되면 해당 프로덕션 코드를 리팩토링 한다.

이 사이클을 TDD 라고 하는데 먼저 TDD 의 첫 번째 단계인 기능 단위의 테스트 코드를 작성하려고 한다.

테스트 코드는 다음과 같은 이유로 개발에 있어 필수이다.

1. 개발단계 초기에 문제를 발견하게 도와준다.
2. 리팩토링을 하거나 라이브러리 업그레이드 등에서 기존 기능이 올바르게 작동하는지 확인할 수 있다.
3. 기능에 대한 불확실성을 감소 시킨다.

저자의 경험을 예로 들자면 저자는 단위 테스트를 배우기 전에 개발 과정은 이러했다.

1. 코드를 작성
2. 프로그램을 실행
3. Postman 과 같은 API 테스트 도구로 HTTP 요청
4. System.out.println() 을 통해 눈으로 검증
5. 코드 수정

이런 과정으로 개발을 해서 3, 4, 5 번 과정을 거칠 때 마다 톰캣을 껐다 켜야하는 불편함이 있었다고 한다.

하지만 테스트 코드를 작성해서 실행한다면 검증도 자동으로 해줄 뿐만 아니라 이러한 불편함 까지 없어진다.

🥮 JUnit

앞서 말한 테스트 코드를 작성을 도와주는 프레임워크로 xUnit 이 있다.

x 는 개발 환경에 따라 바뀌게 되는데 나는 Java 를 사용하기 때문에 JUnit 을 사용한다.

최신버전은 버전 5까지 있지만 대부분의 회사에서 버전 4를 사용하기 때문에 실습에서도 버전 4를 사용한다.

🧋 Main 클래스, GET API 생성

테스트 코드를 작성하기 위해 우선 Main 클래스와 GET API 를 만들려고 한다.

src/main/java 폴더에 웹 사이트 주소 명의 역순을 이름으로 가지는 패키지를 만든다.

그리고 그 패키지에 Application 클래스를 만든다.

이 클래스가 앞으로 만들 프로젝트의 메인 클래스가 된다.

package com.boks.springboot;

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

// 스프링 부트의 자동 설정, 스프링 Bean 읽기와 생성 모두 자동 설정
// 이 Annotation 부터 설정을 읽기 때문에 이 클래스는 항상 프로젝트 최상단에 있어야 함
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

SpringApplication.run 메소드를 실행시키면 내장 WAS 가 실행된다.

다음으로 방금 만들었던 패키지에 하위 패키지로 controller 클래스들을 담을 web 패키지를 생성한다.

web 패키지에 127.0.0.1:8080/hello 주소로 GET 요청을 보내면 hello 를 반환하는 API 를 만들 것이다.

package com.boks.springboot.web;

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

@RestController  // 컨트롤러를 JSON을 반환하는 컨트롤러로 만들어 줌.
public class HelloController {

    @GetMapping("/hello")  // GET 요청을 받을 수 있는 API를 만들어 줌.
    public String hello() {
        return "hello";
    }
}

여기까지가 Main 클래스와 GET API 를 생성하는 과정이었다.

테스트 코드가 없다면 지금 만든 API 를 테스트 하기 위해 메인 클래스를 통해 WAS 를 실행 시킨 뒤

127.0.0.1:8080/hello 주소로 직접 접속 해 눈으로 확인해야 한다.

하지만 JUnit 을 이용해 테스트 코드를 만든다면 WAS 를 실행 시킬 필요없이 검증을 할 수 있다.

🧁 JUnit을 통한 테스트코드 작성

앞서 만들었던 패키지를 그대로 test 에 만들어 주자.

일반적으로 테스트 클래스는 해당 클래스 이름 뒤에 Test 를 붙인다고 한다.

따라서 HelloControllerTest 클래스를 만들자.

package com.boks.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)  // 스프링 부트 테스트와 JUnit 사이의 연결자 역할
@WebMvcTest(controllers = HelloController.class)  // 여러 스프링 테스트 어노테이션 중 web에 집중
public class HelloControllerTest {

    @Autowired  // 스프링이 관리하는 bean을 주입
    private MockMvc mvc;  // 웹 API를 테스트 하는 경우 사용, 테스트의 시작점

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

        mvc.perform(get("/hello"))  // MockMvc를 통해 /hello 주소로 GET 요청
                .andExpect(status().isOk())  // 이 요청의 상태를 검증, 이 경우 OK 즉 200 인지 확인
                .andExpect(content().string(hello));  // GET을 통해 받은 값이 hello 인지 확인
    }
}

어노테이션이 많아서 복잡해 보일 수 있지만 큰 틀을 보자면

MockMvc 인스턴스를 가지는 mvc 객체를 만들어 perform 메소드를 통해 /hello 주소로 GET 을 요청 한 뒤

요청의 상태를 status().isOk 로 검증을 하고 GET 을 통해 받은 값이 hello 인지 검사하는 코드이다.

returnHello 메소드를 동작하게 되면 테스트를 시작하는데 테스트가 성공적으로 끝나게 되면

테스트 통과를 알 수 있다.

status 가 Ok, 200 이 아니거나 GET 을 통해 받은 값이 hello 가 아니라면 Tests Failed 이 된다.

이 결과를 못믿겠다.. 싶으면 실제로 WAS 를 실행 시켜 직접 확인해도 된다.

Application 클래스를 실행시킨 뒤 127.0.0.1:8080/hello 로 접속을 해보자.

톰캣이 8080 포트로 실행 되었다는 메시지도 보인다.

hello 가 잘 출력 되는 것도 알 수 있다.

테스트 코드로 테스트 후 정말로 못 믿겠다 하는 경우에만 이렇게 직접 눈으로 확인 하자.

수동으로 확인 후 테스트 코드를 작성하는 행위는 절대 금지이다.