Merge branch '5.2.x'

spring-test/src/test/java/org/springframework/test/web/servlet/samples/standalone/ExceptionHandlerTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,48 +16,60 @@
 
 package org.springframework.test.web.servlet.samples.standalone;
 
+import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
 
+import org.springframework.core.Ordered;
+import org.springframework.core.annotation.Order;
+import org.springframework.http.MediaType;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.ControllerAdvice;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
 
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.forwardedUrl;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 import static org.springframework.test.web.servlet.setup.MockMvcBuilders.standaloneSetup;
 
 /**
- * Exception handling via {@code @ExceptionHandler} method.
+ * Exception handling via {@code @ExceptionHandler} methods.
  *
  * @author Rossen Stoyanchev
+ * @author Sam Brannen
  */
-public class ExceptionHandlerTests {
+class ExceptionHandlerTests {
 
-	@Test
-	public void testExceptionHandlerMethod() throws Exception {
-		standaloneSetup(new PersonController()).build()
-			.perform(get("/person/Clyde"))
+	@Nested
+	class MvcTests {
+
+		@Test
+		void localExceptionHandlerMethod() throws Exception {
+			standaloneSetup(new PersonController()).build()
+				.perform(get("/person/Clyde"))
 				.andExpect(status().isOk())
 				.andExpect(forwardedUrl("errorView"));
-	}
+		}
 
-	@Test
-	public void testGlobalExceptionHandlerMethod() throws Exception {
-		standaloneSetup(new PersonController()).setControllerAdvice(new GlobalExceptionHandler()).build()
+		@Test
+		void globalExceptionHandlerMethod() throws Exception {
+			standaloneSetup(new PersonController()).setControllerAdvice(new GlobalExceptionHandler()).build()
 				.perform(get("/person/Bonnie"))
 				.andExpect(status().isOk())
 				.andExpect(forwardedUrl("globalErrorView"));
-	}
+		}
 
-	@Test
-	public void testGlobalExceptionHandlerMethodUsingClassArgument() throws Exception {
-		standaloneSetup(PersonController.class).setControllerAdvice(GlobalExceptionHandler.class).build()
+		@Test
+		void globalExceptionHandlerMethodUsingClassArgument() throws Exception {
+			standaloneSetup(PersonController.class).setControllerAdvice(GlobalExceptionHandler.class).build()
 				.perform(get("/person/Bonnie"))
 				.andExpect(status().isOk())
 				.andExpect(forwardedUrl("globalErrorView"));
+		}
 	}
 
 
@@ -65,7 +77,7 @@ public class ExceptionHandlerTests {
 	private static class PersonController {
 
 		@GetMapping("/person/{name}")
-		public String show(@PathVariable String name) {
+		String show(@PathVariable String name) {
 			if (name.equals("Clyde")) {
 				throw new IllegalArgumentException("simulated exception");
 			}
@@ -76,20 +88,138 @@ public class ExceptionHandlerTests {
 		}
 
 		@ExceptionHandler
-		public String handleException(IllegalArgumentException exception) {
+		String handleException(IllegalArgumentException exception) {
 			return "errorView";
 		}
 	}
 
-
 	@ControllerAdvice
 	private static class GlobalExceptionHandler {
 
 		@ExceptionHandler
-		public String handleException(IllegalStateException exception) {
+		String handleException(IllegalStateException exception) {
 			return "globalErrorView";
 		}
+	}
 
+
+	@Nested
+	class RestTests {
+
+		@Test
+		void noException() throws Exception {
+			standaloneSetup(RestPersonController.class)
+				.setControllerAdvice(RestGlobalExceptionHandler.class, RestPersonControllerExceptionHandler.class).build()
+				.perform(get("/person/Yoda").accept(MediaType.APPLICATION_JSON))
+				.andExpect(status().isOk())
+				.andExpect(jsonPath("$.name").value("Yoda"));
+		}
+
+		@Test
+		void localExceptionHandlerMethod() throws Exception {
+			standaloneSetup(RestPersonController.class)
+				.setControllerAdvice(RestGlobalExceptionHandler.class, RestPersonControllerExceptionHandler.class).build()
+				.perform(get("/person/Luke").accept(MediaType.APPLICATION_JSON))
+				.andExpect(status().isOk())
+				.andExpect(jsonPath("$.error").value("local - IllegalArgumentException"));
+		}
+
+		@Test
+		void globalExceptionHandlerMethod() throws Exception {
+			standaloneSetup(RestPersonController.class)
+				.setControllerAdvice(RestGlobalExceptionHandler.class).build()
+				.perform(get("/person/Leia").accept(MediaType.APPLICATION_JSON))
+				.andExpect(status().isOk())
+				.andExpect(jsonPath("$.error").value("global - IllegalStateException"));
+		}
+
+		@Test
+		void globalRestPersonControllerExceptionHandlerTakesPrecedenceOverGlobalExceptionHandler() throws Exception {
+			standaloneSetup(RestPersonController.class)
+				.setControllerAdvice(RestGlobalExceptionHandler.class, RestPersonControllerExceptionHandler.class).build()
+				.perform(get("/person/Leia").accept(MediaType.APPLICATION_JSON))
+				.andExpect(status().isOk())
+				.andExpect(jsonPath("$.error").value("globalPersonController - IllegalStateException"));
+		}
+
+		@Test  // gh-25520
+		void noHandlerFound() throws Exception {
+			standaloneSetup(RestPersonController.class)
+				.setControllerAdvice(RestGlobalExceptionHandler.class, RestPersonControllerExceptionHandler.class)
+				.addDispatcherServletCustomizer(dispatcherServlet -> dispatcherServlet.setThrowExceptionIfNoHandlerFound(true))
+				.build()
+				.perform(get("/bogus").accept(MediaType.APPLICATION_JSON))
+				.andExpect(status().isOk())
+				.andExpect(jsonPath("$.error").value("global - NoHandlerFoundException"));
+		}
+	}
+
+
+	@RestController
+	private static class RestPersonController {
+
+		@GetMapping("/person/{name}")
+		Person get(@PathVariable String name) {
+			switch (name) {
+				case "Luke":
+					throw new IllegalArgumentException();
+				case "Leia":
+					throw new IllegalStateException();
+				default:
+					return new Person("Yoda");
+			}
+		}
+
+		@ExceptionHandler
+		Error handleException(IllegalArgumentException exception) {
+			return new Error("local - " + exception.getClass().getSimpleName());
+		}
+	}
+
+	@RestControllerAdvice(assignableTypes = RestPersonController.class)
+	@Order(Ordered.HIGHEST_PRECEDENCE)
+	private static class RestPersonControllerExceptionHandler {
+
+		@ExceptionHandler
+		Error handleException(Throwable exception) {
+			return new Error("globalPersonController - " + exception.getClass().getSimpleName());
+		}
+	}
+
+	@RestControllerAdvice
+	@Order(Ordered.LOWEST_PRECEDENCE)
+	private static class RestGlobalExceptionHandler {
+
+		@ExceptionHandler
+		Error handleException(Throwable exception) {
+			return new Error( "global - " + exception.getClass().getSimpleName());
+		}
+	}
+
+	static class Person {
+
+		private final String name;
+
+		Person(String name) {
+			this.name = name;
+		}
+
+		public String getName() {
+			return name;
+		}
+	}
+
+	static class Error {
+
+		private final String error;
+
+		Error(String error) {
+			this.error = error;
+		}
+
+		public String getError() {
+			return error;
+		}
 	}
 
 }