com.jupiter.tools.mvc.requester.MvcRequester Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mvc-requester Show documentation
MvcRequester is a tool to make and assert REST-API communication
The newest version!
package com.jupiter.tools.mvc.requester;


import com.fasterxml.jackson.databind.ObjectMapper;
import com.jupiter.tools.mvc.requester.url.UriBuilder;

import org.springframework.test.web.servlet.MockMvc;


/**
 * Created on 30.08.2017.
 * 
 * Wrapper for MockMvc to send request and assert response
 * in more intuitive way.
 *
 * @author Sergey Vdovin
 * @author Korovin Anatoliy
 */
public class MvcRequester {

    private final ObjectMapper sendJsonMapper;
    private final ObjectMapper receiveJsonMapper;
    private final MockMvc mockMvc;
    private final UriBuilder uriBuilder;

    private MvcRequester(MockMvc mockMvc) {

        this.mockMvc = mockMvc;
        this.sendJsonMapper = new ObjectMapper();
        this.receiveJsonMapper = new ObjectMapper();
        this.uriBuilder = new UriBuilder();
    }

    private MvcRequester(MockMvc mockMvc,
                         ObjectMapper sendJsonMapper,
                         ObjectMapper receiveJsonMapper,
                         UriBuilder uriBuilder) {

        this.mockMvc = mockMvc;
        this.sendJsonMapper = sendJsonMapper;
        this.receiveJsonMapper = receiveJsonMapper;
        this.uriBuilder = uriBuilder;
    }

    /**
     * static factory method
     *
     * @param mockMvc {@link MockMvc} which will be used to make a request
     * @return MvcRequester
     */
    public static MvcRequester on(MockMvc mockMvc) {
        return new MvcRequester(mockMvc);
    }

    /**
     * Static factory method, with a definition of {@link ObjectMapper} which will be used to
     * read/write JSON data for requests and from responses.
     *
     * @param mockMvc      {@link MockMvc} which will be used to make a request
     * @param objectMapper {@link ObjectMapper} used to read/write JSON in response/request
     * @return MvcRequester
     */
    public static MvcRequester on(MockMvc mockMvc,
                                  ObjectMapper objectMapper) {

        return new MvcRequester(mockMvc, objectMapper, objectMapper, new UriBuilder());
    }

    /**
     * Static factory method, with a definition of {@link ObjectMapper} which will be used to
     * read/write JSON data for requests and from responses.
     *
     * @param mockMvc           {@link MockMvc} which will be used to make a request
     * @param sendJsonMapper    {@link ObjectMapper} to write JSON data before send it in request
     * @param receiveJsonMapper {@link ObjectMapper} to read JSON data from response
     * @return MvcRequester
     */
    public static MvcRequester on(MockMvc mockMvc,
                                  ObjectMapper sendJsonMapper,
                                  ObjectMapper receiveJsonMapper) {

        return new MvcRequester(mockMvc, sendJsonMapper, receiveJsonMapper, new UriBuilder());
    }

    /**
     * Send request to selected URI
     *
     * @param pattern pattern of the URI to the resource
     * @param args    values of arguments which used in the pattern
     * @return MvcRequestPointed
     */
    public MvcRequestPointed to(String pattern, Object... args) {

        return new MvcRequestPointed(mockMvc,
                                     uriBuilder.build(pattern, args),
                                     sendJsonMapper,
                                     receiveJsonMapper);
    }


}