💣 webflux test - Githubissues

Webflux 환경에서 Test

@ExtendWith(~.class)

@ExtendWith (SpringExtension.class), @ExtendWith (MockitoExtension.class) 으로 설정하는 경우가 많은데 각 Extension.class에서 Spring context와 junit5을 통합해서 사용하도록 제공하고 있다 (Mockito가 더 가볍습니다)
Spring 환경에서 junit을 사용하도록 지원한다고 이해하였습니다.
JUnit4를 사용할 경우 @RunWith(SpringRunner.class) 를 사용
@SpringBootTest, @WebfluxTest 어노테이션을 열어보면 @ExtendWith (SpringExtension.class) 를 확인 할 수 있었습니다.

@WebfluxTest

MVC에서 @WebMvcTest와 유사한 어노테이션으로 명시한 컨트롤러에 대해서 빈을 등록합니다. (여러개도 가능)
Service 계층은 mocking 해야합니다.
여담으로 security 관련하여 security config가 반영이 되지 않아 별도로 코드를 추가해줘야하는데, 글이 spring boot 2.xxx 이라 3.xxx는 확인해 볼 필요가 있습니다.
그리고 mocking 하는 것이 unit test 관점에서 필요없는 설정 과정을 제외한다는 점에서 이점이 있는데, 여러 테스트를 모두 진행한다는 점에서 spring boot 가 애플리케이션 컨텍스트를 캐싱하는데 mock 에 대해서 별도로 등록을 해야하기 때문에 오히려 성능이 낮아질 수 도 있다네요

@Import

특정 컴포넌트를 원하는 config (test 용 config)로 import할 수 있습니다.
참조한 예제에서 Service를 mocking하지 않고, service는 Import 하고, repository를 mocking하는 방식으로 구현되어서 import를 사용한 것 같네요
빈 등록 용도로 사용해야되는 이유는 아직 모르겠네요(만약 mock class를 따로 test 용으로 구현했다면 사용할 수 있을것 같네요)

reference

https://velog.io/@geunwoobaek/Spring-Junit5-Test%EC%A0%95%EB%A6%AC ExtendWith https://mangkyu.tistory.com/244 WebMvcTest

통합 테스트

목표는 API level에서 테스트를 수행하는 것 입니다.

Configuration

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public TestClass(){ ....

@SpringBootTest: 통합 테스트 설정을 위한 어노테이션입니다 내부적으로 @ExtendWith(SpringExtension.class) 와 같은 어노테이션이 있습니다.
WebClient를 사용하기 위해서 SpringBootTest.WebEnvironment.RANDOM_PORT 와 같이 포트 지정을 해줘야합니다.(지정 안하면 denpendency error 발생)

Field

@Autowired
private ApplicationContext applicationContext;

@Autowired
WebTestClient webTestClient;

@Autowired
UserRepository userRepository;```
- ApplicationContext : 스프링 컨테이너 주입 (안해도 @SpringBootTest에 의해 자동으로 설정되는 거 같다)
- WebTestClient: API 호출 객체

### InitDb
```java
@PostConstruct
public void initDB(){
    Mono<Void> saveUsers = userRepository.save(user1)
            .then(userRepository.save(user2))
            .then();
    StepVerifier.create(saveUsers)
            .expectSubscription()
            .verifyComplete();
}

사전에 db에 값을 넣기 위한 방법
reactive하기 구현하지 않으면 db에 값이 들어가지 않습니다....

Test Example

@Test
@DisplayName("get 요청으로 유저를 가져올 수 있다.")
public void test1(){
    webTestClient = WebTestClient.bindToApplicationContext(applicationContext).configureClient().responseTimeout(Duration.ofHours(1)).build();
    webTestClient.get()
            .uri("/user/1")
            .accept(MediaType.APPLICATION_JSON)
            .exchange()
            .expectStatus().isOk()
            .expectHeader().contentType(MediaType.APPLICATION_JSON)
            .expectBody(User.class)
            .isEqualTo(user1);
}

applicationContext의 정보를 webTestClient 에 주입하는 것을 이해했습니다.

Transactional

redis는 트랜잭션이 없는 것으로 알고 있어서
만약 spring data redis를 사용하면 영속성 관리가 되서 사용할 수 있을 거 같습니다.
구현할때 @Transactional 붙이면 error 발생
Transactional이 처리되어 있지 않기 때문에 롤백되지 않습니다....

예외 처리

테스트 코드를 작성하면서 느낀건데 예외처리가 안되 있는 경우, response가 200인데 empty한 것이 확인 되었습니다...
원인 파악 불가

구현하면서 느낀것

비동기여서 그런건지 webflux 생태계가 그런건지 모르겠는데, 검증을 안하는 경우가 있습니다....
로직을 전부 실행하기 전에 끝내 버리는 거 같은데 일일히 확인하면서 짜니까 시간이 오래걸렸습니다

단위 테스트

목표는 API를 mockbean을 통해 테스트를 수행하는 것 입니다.

GET

@Test
@DisplayName("unit test-API test 저장된 유저를 찾아야한다.")
public void test2() {

    //given
    String userId = "1";
    Mockito.when(userService.findOne("1")).thenReturn(Mono.just(user));
    //when
    webTestClient.get()
            .uri("/user/1")
            .exchange()
            .expectStatus().isOk()
            .expectBody()
            .jsonPath("$.userId").isEqualTo(userId);
    //then
    Mockito.verify(userService, Mockito.times(1)).findOne(userId);
}

exchange기점으로 request와 response영역이 구분됩니다.
POST
```
@Autowired
private ApplicationContext applicationContext;
```

@Autowired WebTestClient webTestClient;

@Autowired UserRepository userRepository;```

ApplicationContext : 스프링 컨테이너 주입 (안해도 @SpringBootTest에 의해 자동으로 설정되는 거 같다)
WebTestClient: API 호출 객체

InitDb

    @Test
    @DisplayName("unit test-API test user를 저장했을 때 user에 대한 return 값을 받아 와야 한다. " +
            "작업이 필요합니다")
    public void test1() {

        //given
        Mockito.when(userService.create(postMapUserRequest)).thenReturn(Mono.just(postMapUserResponse));
        //when
        webTestClient.post()
                .uri("/user")
                .contentType(MediaType.APPLICATION_JSON)
                .accept(MediaType.APPLICATION_JSON)
                .body(Mono.just(postMapUserRequest), PostMapUserRequest.class)
                .exchange()

                .expectStatus().isOk()
                .expectHeader().contentType(MediaType.APPLICATION_JSON)
                .expectBody(UserService.class)
        Mockito.verify(userService, Mockito.times(1)).create(refEq(postMapUserRequest));
    }

POST의 경우 문제가 몇가지 있는데 expectBody부터 제대로 실행이 되지 않습니다.(검증되지 않고 무조건 성공됨)
예를 들어 exceptBody를 다른 클래스로 명시해도 테스트가 실패 되지 않습니다.
그리고 .consumWith()와 json() response를 확인해도 null로 예외가 발생합니다.
response가 오는 것은 확인되었는데...
Mockito.verify(userService, Mockito.times(1)).create(refEq(postMapUserRequest)); 에서 refEq을 사용하였는데 API를 호출하는 역직렬화과정에서 객체가 달라져서 객체 주소가 달라집니다

WebSocket Test

목표는 websocket통신을 integration level에서 테스트를 수행하는 것 입니다.

WebSocket

@DisplayName("[integration test] 저장된 map 유저 정보를 websocket로 받아야 한다.")
@Test
public void test1() throws URISyntaxException {
    int connectionTimeSecond=1;
    AtomicInteger counter = new AtomicInteger(0);

    WebSocketClient client = new ReactorNettyWebSocketClient();
    Exception exception = assertThrows(IllegalStateException.class, () -> client.execute(getUrl("/map"), session -> session.receive()
            .doOnNext(data -> {
                List<UserResponseDto> userResponseDtos = JsonUtil.jsonToUserList(data.getPayloadAsText());
                assertTrue(verifyResponse(userResponseDtos,userResponseDtoList));
                counter.incrementAndGet();

            })
            .then()).block(Duration.ofSeconds(connectionTimeSecond)
    )
    );
    String expectedMessage = "Timeout on blocking read for 1";
    String actualMessage = exception.getMessage();
    assertTrue(actualMessage.contains(expectedMessage));
}

WebSocketClient 을 통해 Client을 생성합니다
client.excute을 통해 websocket 연결을 시작합니다
connection이 closed되지 않아 시간 제한을 설정해야 합니다.
시간 제한을 설정하면 timeout blocking exception이 발생합니다. IllegalStateException.class
따라서 assertThrows을 통해 exception발생을 검증하고 message을 receivced할때 마다 message을 역직렬화하여 검증합니다

생각해볼 문제

테스트코드에서 block을 크게 걱정 없이 사용해도 될까(비동기 이슈를 잡지 못하기 때문에)
더 나은 테스트 방법?

POST

expectbody().json() jsonPath()가 문제 없이 작동 되는 것이 확인됨

KU-Taverse / game-server-BE-

💣 webflux test #3

Webflux 환경에서 Test

@ExtendWith(~.class)

@WebfluxTest

@Import

reference

통합 테스트

Configuration

Field

Test Example

Transactional

예외 처리

구현하면서 느낀것

단위 테스트

GET

POST

InitDb

WebSocket Test

WebSocket

생각해볼 문제

POST