[SpringBoot] 공식 문서 요약(3)

SpringBoot Document Review 3

https://docs.spring.io/spring-boot/docs/2.1.13.RELEASE/reference/html/

Testing

https://docs.spring.io/spring-boot/docs/2.1.13.RELEASE/reference/html/boot-features-testing.html

1) Test Scope Dependencies

- spring-boot-starter-test라는 Starter는 Spring Boot 테스트 모듈과 다른 테스팅 라이브러리들을 지원한다.

※ scope은 일반적으로 <scope>test<scope>로 적용하며, 기능들을 src/test 에서만 사용할 수 있다는 뜻이다.

2) Test Spring Applications

- 모의 객체(Mock Object) : 개발한 프로그램을 테스트 할 경우 테스트를 수행할 모듈과 연결되는 외부의 다른 서비스나 모듈들을 실제 사용하는 모듈을 사용하지 않고 실제의 모듈을 흉내내는 가짜 모듈을 작성하여 테스트의 효용성을 높이는데 사용하는 객체

- 배포할 필요 없이 통합 테스팅을 수행하는데 유용한 테스트 모듈을 지원한다.

3) Test Spring Boot Applications

(1) 기본 소개

- src/main/java에 있는 패키지와 동일한 이름의 패키지를 src/test/java에 생성해주고 테스트 클래스를 생성한다.

- spring-test의 @ContextConfiguration 대신 @SpringBootTest를 사용할 수 있다.

- @SpringBootTest의 인자로 webEnvironment 속성을 적용하여 다양한 테스트를 실행할 수 있다. 기본값인 MOCK 옵션의 경우에는 mock 서블릿 환경을 제공해주고 Embedded servlet container는 작동하지 않기 때문에, 커스터마이징한 servlet은 src/test에서는 적용되지 않는다. 그리고 RANDOM_PORT, DEFINED_PORT 옵션은 실제 서블릿 환경을 제공해준다. (더 자세한 속성값은 문서 참고)

- @SpringBootTest(properties="spring.main.web-application-type=reactive") 속성으로 반응형 웹을 테스트할 수 있다.

- @Transactional 테스트는 일반적으로 각 테스트 메소드가 끝날 때 트랜잭션이 롤백되는데, RANDOM_PORT, DEFINED_PORT 방식에서는 롤백되지 않는다.

- @SpringBootTest 클래스에 @RunWith(SpringRunner.class)를 추가하지 않으면 다른 어노테이션들이 무시될 것이다.

- 테스트 메소드에는 @Test 어노테이션을 붙여야 한다.

(2) Web Application Type 탐지 제공

- MVC를 사용한다면 MVC 기반의 application context가 설정되고, WebFlux를 사용한다면 WebFlux 기반의 application context가 설정된다. 우선 순위는 MVC가 더 높다.

(3) Test Configuration 탐지 제공

- Spring Boot에서 테스트를 할 때에는 굳이 @Configuration클래스의 위치를 @ContextConfiguration(classes=...)에 명시해주거나, test안에서 @Configuration클래스를 사용하지 않아도 된다. 대신 @*Test 어노테이션을 붙여서 설정 파일들을 알아서 찾게 해주면 된다.

- 일부분만 따로 테스트하고 싶다면, main메소드가 있는 클래스에 configuration 설정을 추가하는 것은 자제해야 한다.

- @SpringBootTest에서 @TestConfiguration 내부 클래스를 사용한다면, 설정이 애플리케이션의 기본 설정에 추가된다. 반면에 @Configration 내부 클래스를 사용한다면, 애플리케이션의 기본 설정을 자신이 대체함으로써 자신이 메인 설정이 되기 때문에 다른 Bean들이 무시될 수 있다.

※ 이들을 내부 클래스로 두지 않으면 스캔 대상에서 제외된다.

※ @TestConfiguration 내부 클래스는 static으로 둔다.

- Spring의 Test Framework는 application context를 캐싱하기 때문에, 같은 Bean 설정 파일을 쓰는 Test들끼리 재사용할 수 있다.

※ Application context : Application의 상태를 포함하고 있는 정보의 접근을 제공

(4) Text Configuration 제외하기

- 만약 애플리케이션에서 component scanning을 사용하고 있다면(@SpringBootApplication, @ComponentScan 등), 특정 테스트를 위해 만들어둔 Configuration 클래스들이 어딘가에서 선택될 수 있다.

- @TestConfiguration 클래스를 내부 클래스로 두지 않았다면 src/test/java에서 스캔되지 않는다. 대신, @Import 어노테이션을 이용하면 이 @TestConfiguration 클래스를 개별적으로 호출할 수 있다.

- @SpringBootApplication이 아닌 @ComponentScan을 직접 사용한다면 TypeExcludeFilter을 등록해야 한다.

(5) running 서버 테스트하기

https://docs.spring.io/spring-boot/docs/2.1.13.RELEASE/reference/html/boot-features-testing.html#boot-features-testing-spring-boot-applications-testing-with-running-server

- 이 경우에는 @SpringBootTest의 webEnvironment 속성값으로 RANDOM_PORT를 주는 것을 권장한다. 랜덤 포트는 @LocalServerPort으로 가져올 수 있다.

- REST 요청 테스트 : WebFlux 환경에서는 WebTestClient 객체를, Spring MVC 환경에서는 TestRestTemplate 객체를 @Autowired로 받아와서 사용하면 된다. 각각의 예제는 위 링크에서 확인할 수 있다.

※ TestRestTemplate 객체는 WebFlux 환경에서도 @autowired로 받을 수 있다.

(6) Mocking and Spying Beans

- 실제 환경에서 발생하기 어려운 예외 케이스를 시뮬레이션하기에 유용하다.

- 개발자는 MockBean, SpyBean의 어떤 메소드를 대상으로 입력값에 따른 리턴값을 조작하면서 테스트할 수 있게 된다.

- 테스트 클래스에서 @MockBean을 이용하여 구현이 안된 새로운 모의 Bean을 추가하거나 이름을 강제 지정하고 교체할 수 있다.

- @MockBean은 given에서 선언한 코드 외에는 전부 사용할 수 없다.

- 기본적인 Mocking 방식은 일반적으로 테스트 Annotation에 자동 세팅되어 있는데, 다른 방식으로 따로 설정하고 싶다면 @TestExecutionListeners를 사용하면 된다.

- 테스트 클래스에서 @SpyBean을 이용하여 기존의 bean을 SpyBean으로 감싸줄 수 있다.

- @SpyBean은 given에서 선언한 코드 외에는 전부 실제 객체의 것을 사용한다.

- @SpyBean은 test에서 한 클래스당 하나씩 생성할 수 있다.

- @MockBean, @SpyBean을 사용하면 테스트마다 Application context를 생성한다. 원래 Spring에서는 테스트마다 Applicatoin context를 캐싱해두고 같은 설정을 공유하는 테스트에서는 context를 재사용한다.

(7) Auto-configured Tests

- 테스트의 일부(slicing)에 대한 설정 부분만 로드하고 싶을 때 사용된다.

- spring-boot-test-autoconfigure 모듈은 여러 Test 어노테이션들과 여러 AutoConfigure 어노테이션들을 제공한다.

※ AutoConfigure 어노테이션들을 @SpringBootTest에 적용함으로써 slicing을 적용하지 않을 수도 있다.

- Test 어노테이션들은 excludeAutoConfiguration 속성이나 @ImportAutoConfiguration#exclude 어노테이션을 제공하여 일부 설정을 배제할 수 있도록 한다.

(8) Auto-configured JSON Tests

- @JsonTest으로 JSON의 직렬화/역직렬화를 테스트할 수 있으며, 사용 가능한 JSON mapper으로 자동 설정해준다.

※ JSON mapper libraries : Jackson, Gson, Jsonb

- @AutoConfigureJsonTesters : auto-configuration되는 요소들을 재설정

- @JsonTest를 사용하면 JacksonTester, GsonTester, JsonbTester, BasicJsonTester같은 JSON helper클래스의 helper field들을 @Autowired로 가져올 수 있다.

- @JsonTest를 사용하지 않고 인스턴스를 직접 생성하는 경우에는, @Before 메소드의 내부에서 JSON helper의 initFields 메소드를 호출해서 사용할 수 있다. 이 방법은 Json만 테스트할 경우에 사용할 수 있고, 매우 빠르다.

예제

@RunWith(SpringRunner.class)
@JsonTest
public class SampleJsonTest{
    @Autowired
    JacksonTester<Sample> sampleJsonTester;
    
    //@RunWith, @JsonTest, @Autowired을 사용하지 않는다면
    /*
    @Before
    public void setup(){
    	JacksonTester.initFields(this, new ObjectMapper()); //모든 tester들을 instantiate
    }
    */
    
    @Test
    public void testJson() throws IOException{
    	Sample sample = new Sample();
        sample.setName("jooyeok");
        sample.setAge("24");
        
        assertThat(this.sampleJsonTester.write(sample))
            .hasJsonPathStringValue("@.name")
            .extractingJsonPathStringValue("@.name").isEqualTo("jooyeok");
        assertThat(this.sampleJsonTester.write(sample))
            .hasJsonPathNumberValue("@.age")
            .extractingJsonPathNumberValue("@.age").isEqualTo("24");
    }
}

(9) Auto-configured Spring MVC Tests

https://docs.spring.io/spring-boot/docs/2.1.13.RELEASE/reference/html/boot-features-testing.html#boot-features-testing-spring-boot-applications-testing-autoconfigured-mvc-tests

- @WebMvcTest 어노테이션으로 MVC Controller들이 잘 동작하는지 확인할 수 있다. 단, 이 어노테이션을 사용하면 - 일반적인 Component Bean들은 불러오지 않는다. 추가적인 설정들은 @Import를 이용하여 추가하면 된다.

※ 스캔되는 어노테이션 및 Bean 목록은 문서 참조

- @WebMvcTest는 단일 컨트롤러를 대상으로 테스트하는 용도이며, @MockBean과 같이 사용할 수 있다.

- @WebMvcTest는 MockMvc를 자동 설정한다. Mock MVC는 전체 HTTP 서버를 구동할 필요 없는 빠른 MVC 컨트롤러 테스트 방식을 제공한다.

- @AutoConfigureMockMvc를 사용하면 MockMvc를 non-@WebMvcTest 환경에서도 쓸 수 있다. 또, auto-configure된 요소들을 재설정할 수도 있다.

- HtmlUnit이나 Selenium을 사용하면 auto-configuration은 WebClient bean과 WebDriver bean을 제공한다. WebDriver을 싱글톤으로 주고 싶다면 WebDriver @Bean에 @Scope("singleton")을 붙이면 된다.

(10) Auto-configured Spring WebFlux Tests

https://docs.spring.io/spring-boot/docs/2.1.13.RELEASE/reference/html/boot-features-testing.html#boot-features-testing-spring-boot-applications-testing-with-running-server

- @WebFluxTest 어노테이션으로 WebFlux 컨트롤러가 잘 동작하는지 확인할 수 있다. 단, 이 어노테이션을 사용하면 일반적인 Component Bean들은 스캔되지 않는다. 추가적인 설정들은 @Import를 이용하여 추가하면 된다.

- @WebFluxTest는 단일 컨트롤러를 대상으로 테스트하는 용도이며, @MockBean과 같이 사용할 수 있다.

- @WebFluxTest는 WebTestClient를 설정한다. WebTestClient는 전체 HTTP 서버를 구동할 필요 없는 빠른 WebFlux 컨트롤러 테스트 방식을 제공한다.

- @AutoConfigureWebTestClient는 WebTestClient를 autowired 할 수 있게 해주며, non-@WebFluxTest 환경에서도 쓸 수 있다.

(11) Auto-configured Data JPA Tests

- @DataJpaTest를 사용하여 JPA 어플리케이션을 테스트할 수 있다.