[SpringBoot] 스프링 부트 테스트 코드

테스트 코드란?

테스트 코드는 작성한 코드가 의도대로 잘 작동하는지 확인하는 코드이다. 

테스트 코드는 test 디렉터리에서 작업한다. 테스트 코드 패턴은 여러가지가 있는데 보편적으로 사용되는 패턴은 

"given-when-then" 패턴이다. 

 

@DisplayName("Save New Pet")
	@Test
    public void savePetTest(){
    	// given : 반려동물을 저장하기 위한 준비 과정
        final String name = "BlackCherry";
        final int age = 4;
        
        final Pet pet = new Pet(name, age);
        
        // when : 실제로 저장
        final long saveId = petService.save(pet)
        
        // then : 추가가 잘 되었는지 확인
        final Pet savePet = petService.findById(saveId).get();
        assertThat(savePet.getName()).isEqualTo(name);
        assertThat(savePet.getAge()).isEqualTo(age);
    }

 

스프링 부트는 애플리케이션을 테스트하기 위한 도구와 애너테이션 스타터인 spring-boot-starter-test를 제공한다. 

★JUnit : 자바 프로그래밍 언어용 단위 테스트 프레임워크
Spring Test & Spring Boot Test : 스프링 부트 애플리케이션 통합 테스트 제공
★AssertJ : 검증문인 Assertion을 작성하는데 사용
Hamcrest : 표현식을 이해하기 쉽게 만드는 데 사용되는 Matcher 라이브러리
Mockito : 테스트에 사용할 가짜 객체인 Mock을 쉽게 만들과 관리하며, 검증할 수 있게 지원하는 프레임워크
JSONassert : JSON용 Assertion Library
JSONPath : JSON 데이터에서 특정 데이터를 선택하고 검색하기 위한 라이브러리

JUnit

JUnit은 자바 언어를 위한 단위 테스트 프레임워크이다. 

JUnit의 특징
- 테스트 방식을 구분할 수 있는 애너테이션 제공
- @Test 애너테이션으로 메서드 호출시마다 새 인스턴스 생성. 독립 테스트 가능
- 예상 결과를 검증하는 어셜션 메서드 제공'
- 사용방법이 단순하고, 테스트 코드 작성 시간이 적음
- 자동 실행, 자체 결과를 확인하고 즉각적 피드백 제공

 

public class JUnitTest{
	@Display("1+2=3?") // 테스트 이름
    @Test // 테스트 메서드
    public void junitTest(){
    	int a = 1;
        int b = 2;
        int sum = 3;
        
        Assertions.assertEquals(sum, a+b); // 값이 같은지 확인
    }
    
    @Display("1+2=4?")
    @Test
    public void junitFailedTest(){
    	int a = 1;
        int b = 2;
        int sum = 4;
        
        Assertions.assertEquals(sum, a+b);
    }
}

@DisplayName 애너테이션은 테스트 이름을 명시해준다. 

@Test 애너테이션을 붙인 메서드는 테스트를 위한 메서드가 된다. 테스트 끼리 영향을 주지 않도록 각 테스트를 실행할 때마다 테스트를 위한 실행 객체를 만들고 테스트가 종료되면 실행 객체는 삭제된다. 

JUnit에서 제공하는 검증 메서드인 assertEquals는 인수로 받은 두 인자가 같은지를 확인해 준다. 

 

테스트는 애너테이션에 따라 실행 순서가 정해진다. 

import org.junit.jupiter.api*;

public class JUnitCycleTest{
	@BeforeAll // 전체 테스트 실행 전 1회 실행하므로 static으로 선언
    static void beforeAll(){
    	System.out.println("@BeforeAll");
    }
    
    @BeforeEach // 테스트 케이스 시작하기 전마다 실행
    public void beforEach(){
    	System.out.println("@BeforeEach");
    }
    
    @Test
    public void test1(){
    	System.out.println("test1");
    }
    
    @Test
    public void test1(){
    	System.out.println("test1");
    }
    
    @AfterAll // 전체 테스트를 마치고 종료전 1회 실행하므로 static으로 선언
    static void afterAll(){
    	System.out.println("@AfterAll");
    }
    
    @AfterEach // 테스트 케이스 종료 전마다 실행
    public void afterEach(){
    	System.out.println("@AfterEach");
    }
}

@BeforeAll 

전체 테스트를 실행하기전에 최초 1회 실행한다. 

데이터베이스를 연결하거나 테스트 환경을 초기화할 때 사용한다. 

전체 테스트 실행 주기에서 한 번만 호출되어야 하기 때문에 메서드를 static으로 선언한다. 

@BeforeEach

테스트 케이스를 실행하기 전마다 실행된다. 테스트에 사용되는 객체를 초기화하거나, 테스트에 필요한 값을 미리 넣을 수 있다. 

@AfterAll

전체 테스트를 마치고 종료하기전에 실행됨. 

데이터베이스를 종료하거나 공통적으로 사용하는 자원을 해제할 때 사용가능하다.

@AfterEach

각 테스트 케이스를 종료하기 전 매번 실행된다. 테스트 이후 특정 데이터를 삭제하는 경우에 사용한다. 

AssertJ

AssetJ는 JUnit과 함께 사용해 검증문의 가독성을 높여주는 라이브러리이다. 

assertThat(a+b).isEqualTo(sum);

 

AssertJ에는 다양한 메서드들이 존재한다. 

메서드 이름	설명
isEqualTo(A)	A 값과 같은지 검증
isNotEqualTo(A)	A값과 다른지 검증
contains(A)	A값을 포함하는지 검증
doesNotContains(A)	A값을 포함하지 않는지 검증
startsWith(A)	접두사가 A인지 검증
endsWith(A)	접미사가 A인지 검증
isEmpty()	비어있는 값인지 검증
isNotEmpty	비어있지 않은 값인지 검증
isPositive()	양수인지 검증
isNegative()	음수인지 검증
isGreaterThan(1)	1보다 큰 값인지 검증
isLessThen(1)	1보다 작은 값인지 검증

테스트 코드 작성하기

클래스 이름 위에 마우스 커서를 놓고 Alt+Enter를 누르면 테스트케이스를 작성하는 창이 생긴다. 

OK를 누르게 되면 `클래스이름Test.java` 파일이 test/java/패키지 아래에 생성된다. 

@SpringBootTest // 테스트용 애플리케이션 컨텍스트
@AutoConfigurationMocMvc // MockMVC 생성 및 자동 구현
class TestControllerTest{
	@Autowired
    protected MockMvc mockMvc;
    
    @Autowired
    private WebApplicationContext context;
    
    @Autowired
    private PetRepository petRepository;
    
    @BeforeEach
    public void mockMvcSetUp(){
    	this.mockMvc = MockMvcBuilders.webAppContextSetup(context).build();
    }
    
    @AfterEach
    public void cleanUp(){
    	petRepository.deleteAll();
    }
    
    @DisplayName("getAllPets test")
    @Test
    public void getAllPets() throws Exception{
    	// given
        final String url = "/test";
        Pet savedPet = petRepository.save(new Pet(1l, "Rose"));
        
        // when
        final ResultActions result = mockMvc.perform((get(url)
        	.accept(MediaType.APPLICATION_JSON));   
    }
    
    // then
    result
    	.andExpect(status().isOk())
        .andExpect(jsonPath("$[0].id").value(savePet.getId()))
        .andExpect(jsonPath("$[0].name").value(savePet.getName()));
}

• @SpringBootTest
  • @SpringBootTest 애너테이션은 메인 애플리케이션 클래스에 추가하는 애너테이션인 @SpringBootApplication이 있는 클래스를 찾고 그 클래스에 포함되어 있는 빈을 찾고 테스트용 애플리케이션 컨텍스트를 만든다.
• @AutoConfigureMockMvc
  • @AutoConfigureMockMvc은 MockMvc를 생성하고 자동으로 구성하는 애너테이션이다. 
  • MockMvc는 애플리케이션을 서버에 배포하지 않고도 테스트용 MVC환경을 통해 요청 및 전송, 응답 기능을 제공하는 유틸리티 클래스이다. 
  • 컨트롤러를 테스트할 때 사용된다. 
• perform()
  • 요청을 전송하는 메서드이다. 
  • ResultActions 객체를 결과로 받아오며 ResultActions는 반환값을 검증하고 확인하는 andExpect() 메서드를 제공한다. 
• accept()
  • 요청을 보낼 때 무슨 타입으로 응답을 받을지 결정하는 메서드이다. 
  • 위 코드에서는 JSON으로 받는다. 
• andExpect()
  • 메서드 응답을 검증
• jsonPath("$[0].${필드명}")
  • JSON 응답값을 가져오는 역할을 수행

 

** HTTP 주요 응답 코드 검증 **

매핑 메서드	코드
isOK()	200 OK
isCreated()	201 Created
isBadRequest()	400 Bad Request
isForbidden()	403 Forbidden
isNotFound()	404 Not Found
is4xxClientError()	400번대 코드
isInternalServerError()	500 Internal Server Error
is5xxServerError()	500번대 코드