[Spring MVC] 체이닝을 통해 MockMvc 테스트 간편화시키기

 

 

 

저는 컨트롤러를 테스트 할 때, MockMvc + RestDocs를 이용해서 테스트와 문서화를 진행하고 있습니다.

(RestAssured은 아직 써본적이 없고, 언젠가 공부해야지 하고 일단을 미뤄둔 상태입니당..ㅠㅠ)

 

아무튼 MockMvc를 이용해서 테스트를 진행하는데, 저만 그런건지는 모르겠지만, 해당 과정이 잘 익숙해지지도 않을 뿐더러, static import가 너무 많고, 같은 코드의 중복이 너무 많아져서 조금 귀찮아 하던 상태였습니다.

 

그래서 이를 개선하고자, 메서드 체이닝을 적용하여 조금 생각 없이? MockMvc 테스트를 진행할 수 있도록 구현해 보았는데요, 이러한 과정을 공유해보고자 글을 작성합니다.

(코드가 조금 안 이쁠 수 있고, 제가 주로 쓰는 기능들에 대해서만 간편화를 하고자 하였기 때문에 기능이 조금 부족할 수 있지만, 이를 확장하기도 어렵지 않을 것입니다.)

 

 

 

 

 

 

 

🧐 테스트의 일반적인 과정

저는 MockMvc 테스트코드를 작성할 때 일반적으로 다음과 같은 과정을 통해 작성합니다.

• mockMvc.perform(HttpMethod(URL, 경로 변수 설정))
• header 설정 [저는 주로 인증을 위한 AccessToken만을 설정합니다]
• content 설정 [대체로 JSON으로 설정하거나, 혹은 설정하지 않습니다]
• 예상하는 반환 Status 설정
• 이후 문서화 작업

 

 

예를 들어 다음과 같습니다.

@Test
void 인증된_사용자의_올바른_모임_생성_요청인_경우_모임을_생성하고_201을_반환한다() throws Exception {
    final Long memberId = 1L;
    setAuthentication(memberId); // 인증 정보 세팅

    ResultActions resultActions = mockMvc.perform(post(CREATE_CLUB_URL)
                                   .header(HttpHeaders.AUTHORIZATION, BEARER_ACCESS_TOKEN)
                                   .contentType(MediaType.APPLICATION_JSON)
                                   .content(objectMapper.writeValueAsString(correctRequest))
    ).andExpect(status().isCreated());

    resultActions.andDo(document(/* 문서화 */));
}

@Test
void 대상의_역할_변경_성공_시_200을_반환한다() throws Exception {
    // given
    doNothing().when(changeParticipantRoleUseCase).command(any());
    setAuthentication(memberId);

    // when
    ResultActions resultActions = mockMvc.perform(
            post(CHANGE_PARTICIPANT_ROLE_URL, clubId, participantId, clubRoleId)
                    .header(HttpHeaders.AUTHORIZATION, BEARER_ACCESS_TOKEN)
    ).andExpect(status().isOk());

    // then
    resultActions.andDo(document(/* 문서화 */));
}

 

 

위 반복되는 과정들이 조금 귀찮고 복잡하다고 느껴서 이를 간편화 하려고 합니다.

 

 

 

 

 

 

 

 

 

🧐 체이닝을 통한 간편화

바로 결과 코드부터 보면 다음과 같아집니다.

@Test
void 인증된_사용자의_올바른_모임_생성_요청인_경우_모임을_생성하고_201을_반환한다() throws Exception {

	ResultActions resultActions = postRequest()
                    .url(CREATE_CLUB_URL)
                    .login()
                    .jsonContent(correctRequest)
                    .expectStatus(HttpStatus.CREATED);
	resultActions.andDo(document(/* 문서화 */));
}

@Test
void 대상의_역할_변경_성공_시_200을_반환한다() throws Exception {
    // given
    doNothing().when(changeParticipantRoleUseCase).command(any());

    // when
    ResultActions resultActions = postRequest()
                .url(CHANGE_PARTICIPANT_ROLE_URL, clubId, participantId, clubRoleId)
                .login()
                .noContent()
                .expectStatus(OK);
    // then
    resultActions.andDo(document(/* 문서화 */));
}

 

사실 이만 봐서는 별 차이가 없다고 느낄 수 있지만, 해당 방식의 장점은 메서드 체이닝을 통해, 다음 과정을 조금 생각 없이? 바로바로 진행할 수 있다는 것에 있습니다.

 

 

 

 

 

이를 직접 코드를 작성하는 과정으로 비교해 보도록 하겠습니다.

 

 

 

 

 

 

 

 

 

😭 기존 코드를 작성하는 과정

해당 메서드를 외우지 않으면 get(),  post() 등을 찾는 것부터 한번 멈칫하게됩니다.

 

 

import를 해주어야 합니다

 

 

이후 url을 세팅합니다

 

 

perform의 괄호 말고, post()의 괄호에 header() 사용 후 세팅합니다.

 

 

 

json을 위해 conten와 contentType을 정해주어야 합니다.

 

 

 

objectMapper를 통해 변환 과정이 필요합니다.

 

 

 

andExpect에서 또 한번 메서드를 외우지 않으면 멈칫합니다.

 

 

static import를 또 한번 해주어야 합니다.

 

 

완료되었습니다.

 

 

 

 

 

😊 간편화

요청 보낼 메서드로 시작하여, 이후 가능한 메서드가 url을 세팅해주는 메서드밖에 없습니다.

 

url 세팅 이후에는 로그인을 처리할것인지 처리하지 않을 것인지 결정합니다.

 

이후에는 content를 결정하거나, 혹은 바로 결과로 넘어갈 수 있습니다.

(현재 json만 설정할 수 있도록 구현하였지만, 이는 메서드를 추가함으로써 충분히 확장 가능합니다.)

 

 

결과로는 자주 사용하는 것들만 설정해 주었습니다.

 

 

 

두 방식을 비교해 봤을 때, 확실히 간편해 진 것을 알 수 있습니다.

또한 무엇보다도 메서드를 외워야하는 귀찮음과, static import를 해야하는 귀찮음이 사라졌습니다 :)

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

🧐 대략적인 구조

• RequestBuilder : 설정에 필요한 모든 정보들을 저장합니다. 아래 단계들을 진행하며 RequestBuilder가 필요로 하는 설정들을 세팅해나갑니다.
• Method : 요청을 보낼 HttpMethod를 설정하는 단계입니다. 이후 EndPoint로 진행됩니다.
• EndPoint : 요청을 보낼 URL을 설정하는 단계입니다. 이후 Authentication으로 진행됩니다.
• Authentication : 로그인 여부를 설정하는 단계입니다. 이후 Content로 진행됩니다.
• Content : content를 설정합니다. 이후 Expect로 진행됩니다.
• Expect: 요청에 대한 예상 결과를 설정하는 단계입니다. 이후 지금까지의 설정을 바탕으로 MockMvc.perform을 수행합니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

🧐 구현 과정

해당 코드는 저의 프로젝트에 조금 최적화되어 있지만, 대략적인 느낌만 가져가면 다른 프로젝트에서도 충분히 사용할 수 있다고 생각합니다.

public class RequestBuilder {

    /* 인증을 위한 AccessToken 만드는 서비스 */
    private CreateTokenUseCase createTokenUseCase = new CreateToken(new MockJwtProperties());


    private MockMvc mockMvc;
    private ObjectMapper objectMapper;

    /* 요청 보낼 url */
    private String url;
    
    /* 경로 변수들 */
    private List<Object> urlVariables;
    
    /* 요청 보낼 HttpMethod */
    private HttpMethod method;
    
    /* header에 설정해줄 값 */
    private Map<String, Object> headers = new HashMap<>();
    
    private MediaType contentType;
    
    /* body에 담길 content */
    private Object content;
    
    /* 예상 반환 status */
    private HttpStatus status;

    private RequestBuilder(final MockMvc mockMvc, final ObjectMapper mapper) {
        this.mockMvc = mockMvc;
        this.objectMapper = mapper;
    }

    /* 생성 이후 HttpMethod를 정의하도록 합니다. */
    public static Method request(final MockMvc mockMvc, final ObjectMapper objectMapper) {
        return new RequestBuilder(mockMvc, objectMapper)
                .request();
    }

    /* 생성과 동시에 HttpMethod를 Get으로 설정한 후, url을 입력받을 수 있도록 합니다. */
    public static EndPoint getRequest(final MockMvc mockMvc, final ObjectMapper objectMapper) {
        return new RequestBuilder(mockMvc, objectMapper)
                .request()
                .get();
    }

    public static EndPoint postRequest(final MockMvc mockMvc, final ObjectMapper objectMapper) {
        return new RequestBuilder(mockMvc, objectMapper)
                .request()
                .post();
    }

    public static EndPoint deleteRequest(final MockMvc mockMvc, final ObjectMapper objectMapper) {
        return new RequestBuilder(mockMvc, objectMapper)
                .request()
                .delete();
    }

    private Method request() {
        return new Method();
    }

    /* HttpMethod를 정하는 단계입니다. */
    public class Method {
        public EndPoint method(final HttpMethod methodInput) {
            method = methodInput;
            return new EndPoint();
        }

        public EndPoint get() {
            method = GET;
            return new EndPoint();
        }

        public EndPoint post() {
            method = POST;
            return new EndPoint();
        }

        public EndPoint delete() {
            method = DELETE;
            return new EndPoint();
        }
    }

	/* URL을 정하는 단계입니다 */
    public class EndPoint {
        public Authentication url(final String urlInput, final Object... urlVariablesInput) {
            url = urlInput;
            urlVariables = Arrays.asList(urlVariablesInput);
            return new Authentication();
        }
    }

	/* 인증 여부를 결정하는 단계입니다. */
    public class Authentication {
        
        /* 로그인 시, AccessToken을 새로 발급하여 Header에 설정합니다. */
        public Content login() {
            Claims claims = new Claims();
            claims.addClaims(MEMBER_ID_CLAIM, "1");
            AccessToken accessToken = new AccessToken(createTokenUseCase.command(new CreateTokenUseCase.Command(claims)));
            headers.put(HttpHeaders.AUTHORIZATION, "Bearer " + accessToken.token());
            return new Content();
        }

        public Content noLogin() {
            return new Content();
        }
    }

    /* Content Body를 세팅합니다. */
    public class Content {
        /* JSON을 세팅합니다. */
        public Expect jsonContent(final Object object) {
            contentType = MediaType.APPLICATION_JSON;
            content = object;
            return new Expect();
        }
        
        /* 다음 단계로 진행합니다. */
        public Expect expect() {
            return new Expect();
        }
        
        /* Content 관련해서 추가하고 싶으면 이곳에 더 추가할 수 있습니다. */
    }

	/* 예상 결과를 설정합니다. */
    public class Expect {
        public ResultActions expectStatus(HttpStatus expectStatus) throws Exception {
            status = expectStatus;
            return makeRequest();
        }

        public ResultActions ok() throws Exception {
            status = HttpStatus.OK;
            return makeRequest();
        }

        public ResultActions created() throws Exception {
            status = HttpStatus.CREATED;
            return makeRequest();
        }

        public ResultActions unAuthorized() throws Exception {
            status = HttpStatus.UNAUTHORIZED;
            return makeRequest();
        }

        public ResultActions forbidden() throws Exception {
            status = HttpStatus.FORBIDDEN;
            return makeRequest();
        }

        public ResultActions badRequest() throws Exception {
            status = HttpStatus.BAD_REQUEST;
            return makeRequest();
        }

        public ResultActions notFound() throws Exception {
            status = HttpStatus.NOT_FOUND;
            return makeRequest();
        }

        public ResultActions conflict() throws Exception {
            status = HttpStatus.CONFLICT;
            return makeRequest();
        }
    }

    /* 체이닝의 마지막 단계로, 실제 결과를 만들어냅니다. */
    private ResultActions makeRequest() throws Exception {
        MockHttpServletRequestBuilder request = RestDocumentationRequestBuilders.request(method, url, urlVariables.toArray());
        for (String header : headers.keySet()) {
            request.header(header, headers.get(header));
        }

        if (content != null) {
            request.contentType(contentType)
                    .content(objectMapper.writeValueAsString(content));
        }

        return mockMvc.perform(request)
                .andExpect(status().is(status.value()));
    }
}

 

위 코드는 단지 제가 특히 많이 반복되어 사용하는 코드들을 간편하하기위해 작성한 코드이므로, 많은 기능이 없습니다.

그러나 새로운 단계를 만들거나, 기존 단계에 메서드를 추가함으로써 기능 확장이 어렵지 않으며, 만약 기능 추가가 어려워지는 경우에는 기존의 방법처럼 MockMvc를 그냥 사용하면 됩니다 :)

 

 

 

 

이제 Controller 테스트를 위한 추상 클래스를 하나 생성해 주도록 하겠습니다.

@AutoConfigureRestDocs
public abstract class ControllerTest {

    @Autowired
    protected MockMvc mockMvc;

    @Autowired
    protected ObjectMapper objectMapper;

    protected RequestBuilder.Method request() {
        return RequestBuilder.request(mockMvc, objectMapper);
    }

    protected RequestBuilder.EndPoint getRequest() {
        return RequestBuilder.getRequest(mockMvc, objectMapper);
    }

    protected RequestBuilder.EndPoint postRequest() {
        return RequestBuilder.postRequest(mockMvc, objectMapper);
    }

    protected RequestBuilder.EndPoint deleteRequest() {
        return RequestBuilder.deleteRequest(mockMvc, objectMapper);
    }
}

 

 

 

이제 컨트롤러를 테스트하는 코드에서 이를 상속받아 사용할 수 있습니다.

사용 예시는 다음과 같습니다.

 

 

 

 

 

봐주셔서 감사하고, 혹시 개선점이 있다면 말씀해주시면 감사하겠습니다.