使用MockMVC和Spring REST文档时，请重复使用Spring引导错误

Question

im编写一个控制器的控制器，该控制器抛出了自定义异常(在我的情况下为AuthenticationException(，该测试用@ResponseStatus(value = HttpStatus.BAD_REQUEST)

注释

调用使用卷曲的端点，即卷曲的工作正常，我得到了预期的结果，下面显示了一个示例：

{
  "timestamp": 1494185397677,
  "status": 400,
  "error": "Bad Request",
  "exception": "com.example.exception.AuthenticationException",
  "message": "These are not the credentials you are looking for",
  "path": "/status/throw/2"
}

当我使用使用willThrow()的Mockito编写测试时，我没有获得Spring Boot生成的任何输出，而只是我的异常类中注释的响应代码。

这是我的测试：

@Test
public void throwsShouldShowResponseBody() throws Exception {
    given(this.service.getAccStatus())
            .willThrow(AuthenticationException.class);
    this.mvc.perform(get("/status/throw/2"))
            .andExpect(status().isBadRequest())
            .andDo(document("bad-credentials"));
}

查看类似的问题，似乎这可能是由MockMVC不遵循重定向引起的，我认为Spring Boot用来推动/错误，但我的问是，无论如何我都可以做这项工作，所以我不必写这项工作@ControllerAdvice类，与Spring Boot已经提供的类似于ErrorAttributes的东西。我不想更改春季启动在错误上生成的输出。

谢谢 -

Answer 1

正如您所注意到的，使用MockMvc时，记录Spring Boot的错误响应有点棘手。这是因为Spring引导将请求转发到映射到/error的错误控制器，而MockMvc默认情况下不会转发。

记录错误响应的一种方法是使用适当配置的请求直接调用/error。在春季休息文档的一个样本中，有一个例子：

@Test
public void errorExample() throws Exception {
    this.mockMvc
        .perform(get("/error")
            .requestAttr(RequestDispatcher.ERROR_STATUS_CODE, 400)
            .requestAttr(RequestDispatcher.ERROR_REQUEST_URI, "/notes")
            .requestAttr(RequestDispatcher.ERROR_MESSAGE, "The tag 'http://localhost:8080/tags/123' does not exist"))
        .andExpect(status().isBadRequest())
        .andExpect(jsonPath("error", is("Bad Request")))
        .andExpect(jsonPath("timestamp", is(notNullValue())))
        .andExpect(jsonPath("status", is(400)))
        .andExpect(jsonPath("path", is(notNullValue())))
        .andDo(this.documentationHandler.document(
            responseFields(
                fieldWithPath("error").description("The HTTP error that occurred, e.g. `Bad Request`"),
                fieldWithPath("message").description("A description of the cause of the error"),
                fieldWithPath("path").description("The path to which the request was made"),
                fieldWithPath("status").description("The HTTP status code, e.g. `400`"),
                fieldWithPath("timestamp").description("The time, in milliseconds, at which the error occurred"))));
}

然后在结果文档中使用它来描述整个API中使用的错误响应格式。

Answer 2

package com.cts.skynews.springboot.controller;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext;
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserControllerTest {
    private static final Logger LOGGER = LoggerFactory.getLogger(UserControllerTest.class);
    @Autowired
    private WebApplicationContext webApplicationContext;
    private MockMvc mockMvc;
    @Before
    public void setup() {
        mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();
    }
    @Test
    public void addNewUser() throws Exception {
        LOGGER.info("START : Inside Spring Boot addUser() method of UserController");
        String USER_DATA = "{"name":"Kiran Ravariya"," + ""email":"[e-mail]","
                + ""password":"A123456"," + ""status":"active"," + ""language":{"id":"1"},"
                + ""role":{"id":1}}";
        LOGGER.debug("JSON Object :  {}", USER_DATA);
        mockMvc.perform(post("/user/signup").content(USER_DATA).contentType("application/json;charset=UTF-8"))
                .andExpect(status().isOk()).andExpect(jsonPath("$.signedUp").value("true"));
        LOGGER.info("END : Spring Boot addUser() method of UserController");
    }
    @Test
    public void checkEmailExists() throws Exception {
        LOGGER.info("START : Inside Spring Boot checkEmailExists() method of UserController");
        String USER_DATA = "{"name":"Kiran Ravariya"," + ""email":"[e-mail]","
                + ""password":"A123456"," + ""status":"active"," + ""language":{"id":"1"},"
                + ""role":{"id":1}}";
        LOGGER.debug("JSON Object :  {}", USER_DATA);
        mockMvc.perform(post("/user/signup").content(USER_DATA).contentType("application/json;charset=UTF-8"))
                .andExpect(status().isOk()).andExpect(jsonPath("$.emailExists").value("true"))
                .andExpect(jsonPath("$.signedUp").value("false"));
        LOGGER.info("END : Spring Boot checkEmailExists() method of UserController");
    }
    @Test
    public void incorrectEmailFormat() throws Exception {
        LOGGER.info("START : Inside Spring Boot incorrectEmailFormat() method of UserController");
        String USER_DATA = "{"name":"Kiran Ravariya"," + ""email":"rgmail.com"," + ""password":"A123456","
                + ""status":"active"," + ""language":{"id":"1"}," + ""role":{"id":1}}";
        LOGGER.debug("JSON Object :  {}", USER_DATA);
        mockMvc.perform(post("/user/signup").content(USER_DATA).contentType("application/json;charset=UTF-8"))
                .andExpect(status().is4xxClientError())
                .andExpect(jsonPath("$.errorMessage").value("Input Validation Failed:Email address is invalid"));
        LOGGER.info("END : Spring Boot incorrectEmailFormat() method of UserController");
    }
    @Test
    public void nullName() throws Exception {
        LOGGER.info("START : Inside Spring Boot nullName() method of UserController");
        String USER_DATA = "{"email":"[e-mail]"," + ""password":"A123456"," + ""status":"active","
                + ""language":{"id":"1"}," + ""role":{"id":1}}";
        LOGGER.debug("JSON Object :  {}", USER_DATA);
        mockMvc.perform(post("/user/signup").content(USER_DATA).contentType("application/json;charset=UTF-8"))
                .andExpect(status().is4xxClientError())
                .andExpect(jsonPath("$.errorMessage").value("Input Validation Failed:Name cannot be empty"));
        LOGGER.info("END : Spring Boot nullName() method of UserController");
    }
    @Test
    public void nullPassword() throws Exception {
        LOGGER.info("START : Inside Spring Boot nullPassword() method of UserController");
        String USER_DATA = "{"name":"Kiran Ravariya"," + ""email":"[e-mail]","
                + ""status":"active"," + ""language":{"id":"1"}," + ""role":{"id":1}}";
        LOGGER.debug("JSON Object :  {}", USER_DATA);
        mockMvc.perform(post("/user/signup").content(USER_DATA).contentType("application/json;charset=UTF-8"))
                .andExpect(status().is4xxClientError())
                .andExpect(jsonPath("$.errorMessage").value("Input Validation Failed:Password cannot be empty"));
        LOGGER.info("END : Spring Boot nullPassword() method of UserController");
    }
    @Test
    public void nullEmail() throws Exception {
        LOGGER.info("START : Inside Spring Boot nullEmail() method of UserController");
        String USER_DATA = "{"name":"Kiran Ravariya"," + ""password":"A123456"," + ""status":"active","
                + ""language":{"id":"1"}," + ""role":{"id":1}}";
        LOGGER.debug("JSON Object :  {}", USER_DATA);
        mockMvc.perform(post("/user/signup").content(USER_DATA).contentType("application/json;charset=UTF-8"))
                .andExpect(status().is4xxClientError())
                .andExpect(jsonPath("$.errorMessage").value("Input Validation Failed:Email cannot be empty"));
        LOGGER.info("END : Spring Boot nullEmail() method of UserController");
    }
    @Test
    public void nullStatus() throws Exception {
        LOGGER.info("START : Inside Spring Boot nullEmail() method of UserController");
        String USER_DATA = "{"name":"Kiran Ravariya"," + ""email":"[e-mail]","
                + ""password":"A123456"," + ""language":{"id":"1"}," + ""role":{"id":1}}";
        LOGGER.debug("JSON Object :  {}", USER_DATA);
        mockMvc.perform(post("/user/signup").content(USER_DATA).contentType("application/json;charset=UTF-8"))
                .andExpect(status().is4xxClientError())
                .andExpect(jsonPath("$.errorMessage").value("Input Validation Failed:Status cannot be empty"));
        LOGGER.info("END : Spring Boot nullStatus() method of UserController");
    }
    @Test
    public void langugaeNull() throws Exception {
        LOGGER.info("START : Inside Spring Boot langugaeNull() method of UserController");
        String USER_DATA = "{"name":"Kiran Ravariya"," + ""email":"[e-mail]","
                + ""password":"A123456"," + ""status":"active"," + ""role":{"id":1}}";
        LOGGER.debug("JSON Object :  {}", USER_DATA);
        mockMvc.perform(post("/user/signup").content(USER_DATA).contentType("application/json;charset=UTF-8"))
                .andExpect(status().is4xxClientError())
                .andExpect(jsonPath("$.errorMessage").value("Input Validation Failed:Language cannot be empty"));
        LOGGER.info("END : Spring Boot langugaeNull() method of UserController");
    }
    @Test
    public void roleNull() throws Exception {
        LOGGER.info("START : Inside Spring Boot roleNull() method of UserController");
        String USER_DATA = "{"name":"Kiran Ravariya"," + ""email":"[e-mail]","
                + ""password":"A123456"," + ""status":"active"," + ""language":{"id":"1"}}";
        LOGGER.debug("JSON Object :  {}", USER_DATA);
        mockMvc.perform(post("/user/signup").content(USER_DATA).contentType("application/json;charset=UTF-8"))
                .andExpect(status().is4xxClientError())
                .andExpect(jsonPath("$.errorMessage").value("Input Validation Failed:Role cannot be empty"));
        LOGGER.info("END : Spring Boot roleNull() method of UserController");
    }
    @Test
    public void invalidNameLength() throws Exception {
        LOGGER.info("START : Inside Spring Boot invalidNameLength() method of UserController");
        String USER_DATA = "{"name":"KiranKiranRavariyKiranKiranRavariyaRRavariyaRavariyaRavariyaRavariyaRavariya "
                + "KiranKiranRavariyKiranKiranRavariyaRRavariyaRavariyaRavariyaRavariyaRavariya "
                + "KiranKiranRavariyKiranKiranRavariyaRRavariyaRavariyaRavariyaRavariyaRavariya","
                + ""email":"[e-mail]"," + ""password":"A123456"," + ""status":"active","
                + ""language":{"id":"1"}," + ""role":{"id":1}}";
        LOGGER.debug("JSON Object :  {}", USER_DATA);
        mockMvc.perform(post("/user/signup").content(USER_DATA).contentType("application/json;charset=UTF-8"))
                .andExpect(status().is4xxClientError())
                .andExpect(jsonPath("$.errorMessage").value("Input Validation Failed:Name must be 3 to 80 characters"));
        LOGGER.info("END : Spring Boot invalidNameLength() method of UserController");
    }
    @Test
    public void invalidEmailLength() throws Exception {
        LOGGER.info("START : Inside Spring Boot invalidEmailLength() method of UserController");
        String USER_DATA = "{"name":"Kiran Ravariya","
                + ""email":"ravariakiran@gmailravariakiran@gmailravariakiran@gmailravariakiran@gmailravariakiran@gmailravariakiran@gmailravariakiran@gmailravariakiran@gmailravariakiran@[e-mail]","
                + ""password":"A123456"," + ""status":"active"," + ""language":{"id":"1"},"
                + ""role":{"id":1}}";
        LOGGER.debug("JSON Object :  {}", USER_DATA);
        mockMvc.perform(post("/user/signup").content(USER_DATA).contentType("application/json;charset=UTF-8"))
                .andExpect(status().is4xxClientError()).andExpect(
                        jsonPath("$.errorMessage").value("Input Validation Failed:Email must be 4 to 80 characters"));
        LOGGER.info("END : Spring Boot invalidEmailLength() method of UserController");
    }
    @Test
    public void incorrectPasswordFormat() throws Exception {
        LOGGER.info("START : Inside Spring Boot incorrectPasswordFormat() method of UserController");
        String USER_DATA = "{"name":"Kiran Ravariya"," + ""email":"[e-mail]"," + ""password":"12","
                + ""status":"active"," + ""language":{"id":"1"}," + ""role":{"id":1}}";
        LOGGER.debug("JSON Object :  {}", USER_DATA);
        mockMvc.perform(post("/user/signup").content(USER_DATA).contentType("application/json;charset=UTF-8"))
                .andExpect(status().is4xxClientError()).andExpect(jsonPath("$.errorMessage")
                        .value("Input Validation Failed:Password must be 6 to 45 characters"));
        LOGGER.info("END : Spring Boot incorrectPasswordFormat() method of UserController");
    }
    @Test
    public void successfullLogin() throws Exception {
        LOGGER.info("START : Inside Spring Boot successfullLogin() method of UserController");
        String USER_DATA = "{"email":"[e-mail]","password":"A123456"}";
        LOGGER.debug("JSON Object :  {}", USER_DATA);
        mockMvc.perform(post("/user/login").content(USER_DATA).contentType("application/json;charset=UTF-8"))
                .andExpect(status().isOk()).andExpect(jsonPath("$.authenticated").value("true"));
        LOGGER.info("END : Spring Boot successfullLogin() method of UserController");
    }
    @Test
    public void invalidEmailForLogin() throws Exception {
        LOGGER.info("START : Inside Spring Boot invalidEmailForLogin() method of UserController");
        String USER_DATA = "{"email":"[e-mail]","password":"A123456"}";
        LOGGER.debug("JSON Object :  {}", USER_DATA);
        mockMvc.perform(post("/user/login").content(USER_DATA).contentType("application/json;charset=UTF-8"))
                .andExpect(status().isOk()).andExpect(jsonPath("$.authenticated").value("false"));
        LOGGER.info("END : Spring Boot invalidEmailForLogin() method of UserController");
    }
    @Test
    public void invalidPasswordForLogin() throws Exception {
        LOGGER.info("START : Inside Spring Boot invalidPasswordForLogin() method of UserController");
        String USER_DATA = "{"email":"[e-mail]","password":"12345678"}";
        LOGGER.debug("JSON Object :  {}", USER_DATA);
        mockMvc.perform(post("/user/login").content(USER_DATA).contentType("application/json;charset=UTF-8"))
                .andExpect(status().isOk()).andExpect(jsonPath("$.authenticated").value("false"));;
        LOGGER.info("END : Spring Boot invalidPasswordForLogin() method of UserController");
    }
}