JsonFieldMatcher의 사용

[unikal1]

보통 json 응답에 대하여 이를 검증하기 위해서 다음과 같은 방식을 사용합니다.

    @Test
    void handleBaseException() throws Exception {
        mockMvc.perform(get("/test/base"))
                .andExpect(jsonPath("$.code").value("RIS-01");
    }

다만, json 필드 안의 내용이 너무 많아지면 이를 검증하기 위한 코드가 너무 많아지기에, 해당 클래스를 사용하는게 어떨까요.

public class JsonFieldResultMatcher implements ResultMatcher {
    private final List<ResultMatcher> matchers;

    public JsonFieldResultMatcher(List<ResultMatcher> matchers) {
        this.matchers = matchers;
    }

    @Override
    public void match(@NotNull MvcResult result) throws Exception {
        for (ResultMatcher matcher : matchers) {
            matcher.match(result);
        }
    }

    public static ResultMatcher hasStatus(ErrorCode errorCode) {
        return result -> {
            HttpStatus expectedStatus = errorCode.getHttpStatus();
            int actualStatus = result.getResponse().getStatus();
            Assertions.assertEquals(expectedStatus.value(), actualStatus,
                    "Expected status code " + expectedStatus.value() + " but got " + actualStatus);
        };
    }

    public static ResultMatcher hasKey(String key, String value) {
        List<ResultMatcher> matchers = new ArrayList<>();
        matchers.add(MockMvcResultMatchers.jsonPath("$." + key).value(value));
        return new JsonFieldResultMatcher(matchers);
    }

    public static ResultMatcher hasKey(String outputString) {
        return result -> Assertions.assertEquals(outputString, result.getResponse().getContentAsString());
    }

    public static ResultMatcher hasKey(ErrorCode errorCode) {
        List<ResultMatcher> matchers = new ArrayList<>();
        matchers.add(MockMvcResultMatchers.jsonPath("$.code").value(errorCode.getCode()));
        matchers.add(MockMvcResultMatchers.jsonPath("$.status").value("fail"));
        matchers.add(MockMvcResultMatchers.jsonPath("$.message").value(errorCode.getMessage()));
        return new JsonFieldResultMatcher(matchers);
    }

    public static ResultMatcher hasKey(Object dto) throws JsonProcessingException {
        List<ResultMatcher> matchers = new ArrayList<>();
        ObjectMapper mapper = new ObjectMapper();
        mapper.registerModule(new JavaTimeModule());
        mapper.findAndRegisterModules();

        @SuppressWarnings("unchecked")
        Map<String, Object> map = mapper.convertValue(dto, Map.class);

        for (Map.Entry<String, Object> entry : map.entrySet()) {
            String key = entry.getKey();
            Object value = entry.getValue();

            if (value != null) {
                if (value instanceof String) {
                    matchers.add(MockMvcResultMatchers.jsonPath("$." + key).value(value));
                } else if (value instanceof Integer || value instanceof Long || value instanceof Boolean) {
                    matchers.add(MockMvcResultMatchers.jsonPath("$." + key).value(value));
                } else if (value instanceof LocalDate) {
                    DateTimeFormatter formatter = DateTimeFormatter.ISO_LOCAL_DATE;
                    String formattedDate = ((LocalDate) value).format(formatter);
                    matchers.add(MockMvcResultMatchers.jsonPath("$." + key).value(formattedDate));
                } else if (value instanceof LocalDateTime) {
                    DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss");
                    String formattedDateTime = ((LocalDateTime) value).truncatedTo(ChronoUnit.SECONDS).format(formatter);
                    matchers.add(MockMvcResultMatchers.jsonPath("$." + key).value(formattedDateTime));
                } else {
                    matchers.add(MockMvcResultMatchers.jsonPath("$." + key).value(value));
                }
            }
        }

        return new JsonFieldResultMatcher(matchers);
    }

    public static ResultMatcher hasKey(List<?> dtos) throws Exception {
        ObjectMapper mapper = new ObjectMapper();
        List<ResultMatcher> matchers = new ArrayList<>();

        // 리스트의 크기를 검증합니다.
        matchers.add(MockMvcResultMatchers.jsonPath("$.length()").value(dtos.size()));

        for (int i = 0; i < dtos.size(); i++) {
            Object dto = dtos.get(i);

            @SuppressWarnings("unchecked")
            Map<String, Object> map = mapper.convertValue(dto, Map.class);

            for (Map.Entry<String, Object> entry : map.entrySet()) {
                Object value = entry.getValue();

                if (value != null) {
                    if (value instanceof LocalDate) {
                        DateTimeFormatter formatter = DateTimeFormatter.ISO_LOCAL_DATE;
                        String formattedDate = ((LocalDate) value).format(formatter);
                        matchers.add(MockMvcResultMatchers.jsonPath("$[" + i + "]." + entry.getKey()).value(formattedDate));
                    } else if (value instanceof LocalDateTime) {
                        DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss");
                        String formattedDateTime = ((LocalDateTime) value).truncatedTo(ChronoUnit.SECONDS).format(formatter);
                        matchers.add(MockMvcResultMatchers.jsonPath("$[" + i + "]." + entry.getKey()).value(formattedDateTime));
                    } else {
                        matchers.add(MockMvcResultMatchers.jsonPath("$[" + i + "]." + entry.getKey()).value(value));
                    }
                }
            }
        }

        return new JsonFieldResultMatcher(matchers);
    }

    public static ResultMatcher hasKey(Page<?> page) throws Exception {
        ObjectMapper mapper = new ObjectMapper();

        List<ResultMatcher> matchers = new ArrayList<>();

        matchers.add(MockMvcResultMatchers.jsonPath("$.totalElements").value(page.getTotalElements()));
        matchers.add(MockMvcResultMatchers.jsonPath("$.totalPages").value(page.getTotalPages()));
        matchers.add(MockMvcResultMatchers.jsonPath("$.size").value(page.getSize()));
        matchers.add(MockMvcResultMatchers.jsonPath("$.number").value(page.getNumber()));
        matchers.add(MockMvcResultMatchers.jsonPath("$.numberOfElements").value(page.getNumberOfElements()));
        matchers.add(MockMvcResultMatchers.jsonPath("$.first").value(page.isFirst()));
        matchers.add(MockMvcResultMatchers.jsonPath("$.last").value(page.isLast()));
        matchers.add(MockMvcResultMatchers.jsonPath("$.empty").value(page.isEmpty()));

        List<?> content = page.getContent();
        matchers.add(MockMvcResultMatchers.jsonPath("$.content.length()").value(content.size()));

        for (int i = 0; i < content.size(); i++) {
            Object dto = content.get(i);

            @SuppressWarnings("unchecked")
            Map<String, Object> map = mapper.convertValue(dto, Map.class);

            for (Map.Entry<String, Object> entry : map.entrySet()) {
                Object value = entry.getValue();

                if (value != null) {
                    if (value instanceof LocalDate) {
                        DateTimeFormatter formatter = DateTimeFormatter.ISO_LOCAL_DATE;
                        String formattedDate = ((LocalDate) value).format(formatter);
                        matchers.add(MockMvcResultMatchers.jsonPath("$.content[" + i + "]." + entry.getKey()).value(formattedDate));
                    } else if (value instanceof LocalDateTime) {
                        DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss");
                        String formattedDateTime = ((LocalDateTime) value).truncatedTo(ChronoUnit.SECONDS).format(formatter);
                        matchers.add(MockMvcResultMatchers.jsonPath("$.content[" + i + "]." + entry.getKey()).value(formattedDateTime));
                    } else {
                        matchers.add(MockMvcResultMatchers.jsonPath("$.content[" + i + "]." + entry.getKey()).value(value));
                    }
                }
            }
        }

        return new JsonFieldResultMatcher(matchers);
    }

}

기존에 사용했던 코드이고, 현재 프로젝트 상황에 맞게 바꾸긴 했습니다. 예상치 못한 오류 발생 시 수정이 필요하긴 합니다.

코드 자체는 다음과 같은 목적을 위해 작동합니다.

• ErrorCode 를 입력받아, 응답과 ErrorCode의 값을 비교
• 객체를 입력받아, 응답과 객체의 값을 비교
• 객체의 List를 입력받아, 응답과 리스트 값을 비교
• Page를 입력받아, 응답과 page 값을 비교

정도가 있습니다. 음, 작동 방식은 저도 한번 정리할 겸, 최대한 적어보겠습니다.

---

작동 방식

테스트코드에서 사용하는 andExpect 는 ResultMatcher 를 매개변수로 받습니다. 이때 jsonPath().value()는 ResultMatcher의 구현체인 JsonPathResultMatcher 를 반환합니다.
andExpect 는 mockMvc에서 제공하는 함수형 인터페이스 ResultActions에 속해있으며, 유일한 추상 메서드입니다.(그래서 함수형 인터페이스죠). 이에 대한 구현체 중 하나인 MockMvc 에는 다음과 같은 코드가 있습니다

        return new ResultActions() {
            public ResultActions andExpect(ResultMatcher matcher) throws Exception {
                matcher.match(mvcResult);
                return this;
            }

            public ResultActions andDo(ResultHandler handler) throws Exception {
                handler.handle(mvcResult);
                return this;
            }

            public MvcResult andReturn() {
                return mvcResult;
            }
        };

중요한 것만 보자면, 이는 perform 메서드의 반환 정의 부분이며, andExpect를 하게 되면, 매개변수로 받은 ResultMatcher의 match 메서드를 호출하는 것을 볼 수 있습니다. 당연히 모든 ResultMatcher의 구현체는 해당 메서드를 오버라이드 하도록 강제되어 있습니다. 즉, 일반적인 흐름은 다음과 같습니다.

1. mockMvc 실행
2. perform 메서드 호출 -> ResultActions 반환 (익명 클래스 사용) / ResultMatcher의 match 메서드를 호출하는 andExpect 메서드를 정의한다
3. ResultActions의 andExpect 실행
4. jsonPath().value() 가 ResultMatcher 를 반환
5. match 메서드가 실행되며 ResultMatcher에서 응답과 값을 비교
6. ResultMatcher 는 역시나 함수형 인터페이스이며 match 메서드가 존재. 이에 대한 구현체는 match 메서드를 가져야 함 (실제 비교되는 과정은, ResultMatcher의 구현체 별로 다릅니다. 보통의 경우 jsonPath().value()는 내부 코드를 뜯어보면 JsonPathResultMatcher 를 사용하는데, 여기서 value 메서드를 보면 jsonPathHelper.assertValue 를 통해 값을 검증합니다. 결론적으로, "실질적인 값의 비교" 는 여기서 진행한다고 보면 됩니다.)

이제 제가 작성한 코드를 보겠습니다. override 된 match 메서드는 내부 필드인 List<ResultMatcher> matchers 에 대하여, 각각에 대해 match 메서드를 실행합니다.

hasStatus는 ResultMatcher가 함수형 인터페이스이기 때문에,
람다식을 이용하여 match(result) 메서드를 즉석에서 구현한 익명 구현체를 반환합니다.

    public static ResultMatcher hasStatus(ErrorCode errorCode) {
        return result -> {
            HttpStatus expectedStatus = errorCode.getHttpStatus();
            int actualStatus = result.getResponse().getStatus();
            Assertions.assertEquals(expectedStatus.value(), actualStatus,
                    "Expected status code " + expectedStatus.value() + " but got " + actualStatus);
        };
    }

결국, result -> { ... } 람다는 match(MvcResult)의 구현이며,
andExpect(...) 내부에서 호출되어 실제 테스트 검증을 수행하게 됩니다.

hasKey 메서드는 일종의 팩토리 메서드 패턴의 메서드 역할이며, 자기 자신을 반환합니다. 이때, 앞서 말했던 List 에 값을 넣고, 인스턴스를 생성하여 반환합니다. 모든 ResultMatcher는 사실상 MockMvcResultMatchers.jsonPath에서 반환되는 값이며, 여기서의 match 메서드를 실질적으로 사용합니다.

hasKey 메서드에서 몇몇가지 사유로 인하여 (대표적으로 직렬화, 날짜 변환 문제) 이를 해결하기 위한 코드도 존재합니다. 다만 이는 직관적으로 명시가 되어 있으니 코드를 참조해주세요.

[unikal1]

다른 의견 있으시면 말해주세요.

[s0o0bn]

오... 장난 아니네요

사실 그동안 프로젝트 하면서 테스트 코드는 철저하게 챙기지 못해서 아는 바가 많지 않습니다.
기껏해야 도메인 쪽 서비스, 레포지토리 메서드 단위 테스트 정도만 해두긴 했습니다 엉성하긴 하지만,,
그래서 이 부분 관련해서는 제가 배워가야 할 거 같네요. 바로 이해하기가 좀 어렵긴한데, 차근차근 이해해보겠습니다.

쨌든 위 클래스 활용해서 mvc 테스트 추상화? 하는 건 아주 좋은 거 같습니다.

[sjhlko]

쌈뽕하네요 저도 저거 매 컨트롤러마다 테스트 하면서 무의미한 반복 코드 작성 계속 했던 기억이 있습니다 최고입니다