/*
 * Copyright 2012-present 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.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.autoconfigure.web.servlet.error;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.Parameter;
import java.net.URI;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.validation.Valid;
import jakarta.validation.constraints.NotNull;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
import org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration;
import org.springframework.boot.autoconfigure.freemarker.FreeMarkerAutoConfiguration;
import org.springframework.boot.autoconfigure.http.HttpMessageConvertersAutoConfiguration;
import org.springframework.boot.autoconfigure.web.ServerProperties;
import org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration;
import org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration;
import org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.boot.testsupport.classpath.resources.WithResource;
import org.springframework.boot.web.error.ErrorAttributeOptions;
import org.springframework.boot.web.error.ErrorAttributeOptions.Include;
import org.springframework.boot.web.servlet.error.ErrorAttributes;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.MethodParameter;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.RequestEntity;
import org.springframework.http.ResponseEntity;
import org.springframework.util.ReflectionUtils;
import org.springframework.util.StringUtils;
import org.springframework.validation.BindException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestAttribute;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.servlet.View;
import org.springframework.web.servlet.view.AbstractView;

import static org.assertj.core.api.Assertions.assertThat;

/**
 * Tests for {@link BasicErrorController} using a real HTTP server.
 *
 * @author Phillip Webb
 * @author Dave Syer
 * @author Stephane Nicoll
 * @author Scott Frederick
 */
class BasicErrorControllerIntegrationTests {

	private ConfigurableApplicationContext context;

	@AfterEach
	void closeContext() {
		if (this.context != null) {
			this.context.close();
		}
	}

	@Test
	@SuppressWarnings({ "rawtypes", "unchecked" })
	void testErrorForMachineClientDefault() {
		load();
		ResponseEntity<Map> entity = new TestRestTemplate().getForEntity(createUrl("?trace=true"), Map.class);
		assertErrorAttributes(entity.getBody(), "500", "Internal Server Error", null, null, "/");
		assertThat(entity.getBody()).doesNotContainKey("exception");
		assertThat(entity.getBody()).doesNotContainKey("trace");
	}

	@Test
	void testErrorForMachineClientWithParamsTrue() {
		load("--server.error.include-exception=true", "--server.error.include-stacktrace=on-param",
				"--server.error.include-message=on-param");
		exceptionWithStackTraceAndMessage("?trace=true&message=true");
	}

	@Test
	void testErrorForMachineClientWithParamsFalse() {
		load("--server.error.include-exception=true", "--server.error.include-stacktrace=on-param",
				"--server.error.include-message=on-param");
		exceptionWithoutStackTraceAndMessage("?trace=false&message=false");
	}

	@Test
	void testErrorForMachineClientWithParamsAbsent() {
		load("--server.error.include-exception=true", "--server.error.include-stacktrace=on-param",
				"--server.error.include-message=on-param");
		exceptionWithoutStackTraceAndMessage("");
	}

	@Test
	void testErrorForMachineClientNeverParams() {
		load("--server.error.include-exception=true", "--server.error.include-stacktrace=never",
				"--server.error.include-message=never");
		exceptionWithoutStackTraceAndMessage("?trace=true&message=true");
	}

	@Test
	void testErrorForMachineClientAlwaysParams() {
		load("--server.error.include-exception=true", "--server.error.include-stacktrace=always",
				"--server.error.include-message=always");
		exceptionWithStackTraceAndMessage("?trace=false&message=false");
	}

	@Test
	@SuppressWarnings("rawtypes")
	void testErrorForMachineClientAlwaysParamsWithoutMessage() {
		load("--server.error.include-exception=true", "--server.error.include-message=always");
		ResponseEntity<Map> entity = new TestRestTemplate().getForEntity(createUrl("/noMessage"), Map.class);
		assertErrorAttributes(entity.getBody(), "500", "Internal Server Error", IllegalStateException.class,
				"No message available", "/noMessage");
	}

	@SuppressWarnings({ "rawtypes", "unchecked" })
	private void exceptionWithStackTraceAndMessage(String path) {
		ResponseEntity<Map> entity = new TestRestTemplate().getForEntity(createUrl(path), Map.class);
		assertErrorAttributes(entity.getBody(), "500", "Internal Server Error", IllegalStateException.class,
				"Expected!", "/");
		assertThat(entity.getBody()).containsKey("trace");
	}

	@SuppressWarnings({ "rawtypes", "unchecked" })
	private void exceptionWithoutStackTraceAndMessage(String path) {
		ResponseEntity<Map> entity = new TestRestTemplate().getForEntity(createUrl(path), Map.class);
		assertErrorAttributes(entity.getBody(), "500", "Internal Server Error", IllegalStateException.class, null, "/");
		assertThat(entity.getBody()).doesNotContainKey("trace");
	}

	@Test
	@SuppressWarnings("rawtypes")
	void testErrorForAnnotatedExceptionWithoutMessage() {
		load("--server.error.include-exception=true");
		ResponseEntity<Map> entity = new TestRestTemplate().getForEntity(createUrl("/annotated"), Map.class);
		assertErrorAttributes(entity.getBody(), "400", "Bad Request", TestConfiguration.Errors.ExpectedException.class,
				null, "/annotated");
	}

	@Test
	@SuppressWarnings("rawtypes")
	void testErrorForAnnotatedExceptionWithMessage() {
		load("--server.error.include-exception=true", "--server.error.include-message=always");
		ResponseEntity<Map> entity = new TestRestTemplate().getForEntity(createUrl("/annotated"), Map.class);
		assertErrorAttributes(entity.getBody(), "400", "Bad Request", TestConfiguration.Errors.ExpectedException.class,
				"Expected!", "/annotated");
	}

	@Test
	@SuppressWarnings("rawtypes")
	void testErrorForAnnotatedNoReasonExceptionWithoutMessage() {
		load("--server.error.include-exception=true");
		ResponseEntity<Map> entity = new TestRestTemplate().getForEntity(createUrl("/annotatedNoReason"), Map.class);
		assertErrorAttributes(entity.getBody(), "406", "Not Acceptable",
				TestConfiguration.Errors.NoReasonExpectedException.class, null, "/annotatedNoReason");
	}

	@Test
	@SuppressWarnings("rawtypes")
	void testErrorForAnnotatedNoReasonExceptionWithMessage() {
		load("--server.error.include-exception=true", "--server.error.include-message=always");
		ResponseEntity<Map> entity = new TestRestTemplate().getForEntity(createUrl("/annotatedNoReason"), Map.class);
		assertErrorAttributes(entity.getBody(), "406", "Not Acceptable",
				TestConfiguration.Errors.NoReasonExpectedException.class, "Expected message", "/annotatedNoReason");
	}

	@Test
	@SuppressWarnings("rawtypes")
	void testErrorForAnnotatedNoMessageExceptionWithMessage() {
		load("--server.error.include-exception=true", "--server.error.include-message=always");
		ResponseEntity<Map> entity = new TestRestTemplate().getForEntity(createUrl("/annotatedNoMessage"), Map.class);
		assertErrorAttributes(entity.getBody(), "406", "Not Acceptable",
				TestConfiguration.Errors.NoReasonExpectedException.class, "No message available",
				"/annotatedNoMessage");
	}

	@Test
	void testBindingExceptionForMachineClientWithErrorsParamTrue() {
		load("--server.error.include-exception=true", "--server.error.include-binding-errors=on-param");
		bindingExceptionWithErrors("?errors=true");
	}

	@Test
	void testBindingExceptionForMachineClientWithErrorsParamFalse() {
		load("--server.error.include-exception=true", "--server.error.include-binding-errors=on-param");
		bindingExceptionWithoutErrors("?errors=false");
	}

	@Test
	void testBindingExceptionForMachineClientWithErrorsParamAbsent() {
		load("--server.error.include-exception=true", "--server.error.include-binding-errors=on-param");
		bindingExceptionWithoutErrors("");
	}

	@Test
	void testBindingExceptionForMachineClientAlwaysErrors() {
		load("--server.error.include-exception=true", "--server.error.include-binding-errors=always");
		bindingExceptionWithErrors("?errors=false");
	}

	@Test
	void testBindingExceptionForMachineClientNeverErrors() {
		load("--server.error.include-exception=true", "--server.error.include-binding-errors=never");
		bindingExceptionWithoutErrors("?errors=true");
	}

	@Test
	void testBindingExceptionForMachineClientWithMessageParamTrue() {
		load("--server.error.include-exception=true", "--server.error.include-message=on-param");
		bindingExceptionWithMessage("?message=true");
	}

	@Test
	void testBindingExceptionForMachineClientWithMessageParamFalse() {
		load("--server.error.include-exception=true", "--server.error.include-message=on-param");
		bindingExceptionWithoutMessage("?message=false");
	}

	@Test
	void testBindingExceptionForMachineClientWithMessageParamAbsent() {
		load("--server.error.include-exception=true", "--server.error.include-message=on-param");
		bindingExceptionWithoutMessage("");
	}

	@Test
	void testBindingExceptionForMachineClientAlwaysMessage() {
		load("--server.error.include-exception=true", "--server.error.include-message=always");
		bindingExceptionWithMessage("?message=false");
	}

	@Test
	void testBindingExceptionForMachineClientNeverMessage() {
		load("--server.error.include-exception=true", "--server.error.include-message=never");
		bindingExceptionWithoutMessage("?message=true");
	}

	@SuppressWarnings({ "rawtypes", "unchecked" })
	private void bindingExceptionWithErrors(String param) {
		ResponseEntity<Map> entity = new TestRestTemplate().getForEntity(createUrl("/bind" + param), Map.class);
		assertErrorAttributes(entity.getBody(), "400", "Bad Request", MethodArgumentNotValidException.class, null,
				"/bind");
		assertThat(entity.getBody()).containsKey("errors");
	}

	@SuppressWarnings({ "rawtypes", "unchecked" })
	private void bindingExceptionWithoutErrors(String param) {
		ResponseEntity<Map> entity = new TestRestTemplate().getForEntity(createUrl("/bind" + param), Map.class);
		assertErrorAttributes(entity.getBody(), "400", "Bad Request", MethodArgumentNotValidException.class, null,
				"/bind");
		assertThat(entity.getBody()).doesNotContainKey("errors");
	}

	@SuppressWarnings({ "rawtypes", "unchecked" })
	private void bindingExceptionWithMessage(String param) {
		ResponseEntity<Map> entity = new TestRestTemplate().getForEntity(createUrl("/bind" + param), Map.class);
		assertErrorAttributes(entity.getBody(), "400", "Bad Request", MethodArgumentNotValidException.class,
				"Validation failed for object='test'. Error count: 1", "/bind");
		assertThat(entity.getBody()).doesNotContainKey("errors");
	}

	@SuppressWarnings({ "rawtypes", "unchecked" })
	private void bindingExceptionWithoutMessage(String param) {
		ResponseEntity<Map> entity = new TestRestTemplate().getForEntity(createUrl("/bind" + param), Map.class);
		assertErrorAttributes(entity.getBody(), "400", "Bad Request", MethodArgumentNotValidException.class, null,
				"/bind");
		assertThat(entity.getBody()).doesNotContainKey("errors");
	}

	@Test
	@SuppressWarnings({ "rawtypes", "unchecked" })
	void testRequestBodyValidationForMachineClient() {
		load("--server.error.include-exception=true");
		RequestEntity request = RequestEntity.post(URI.create(createUrl("/bodyValidation")))
			.accept(MediaType.APPLICATION_JSON)
			.contentType(MediaType.APPLICATION_JSON)
			.body("{}");
		ResponseEntity<Map> entity = new TestRestTemplate().exchange(request, Map.class);
		assertErrorAttributes(entity.getBody(), "400", "Bad Request", MethodArgumentNotValidException.class, null,
				"/bodyValidation");
		assertThat(entity.getBody()).doesNotContainKey("errors");
	}

	@Test
	@SuppressWarnings({ "rawtypes", "unchecked" })
	void testBindingExceptionForMachineClientDefault() {
		load();
		RequestEntity request = RequestEntity.get(URI.create(createUrl("/bind?trace=true,message=true")))
			.accept(MediaType.APPLICATION_JSON)
			.build();
		ResponseEntity<Map> entity = new TestRestTemplate().exchange(request, Map.class);
		assertThat(entity.getBody()).doesNotContainKey("exception");
		assertThat(entity.getBody()).doesNotContainKey("trace");
		assertThat(entity.getBody()).doesNotContainKey("errors");
	}

	@Test
	@WithResource(name = "templates/error/507.ftlh", content = "We are out of storage")
	void testConventionTemplateMapping() {
		load();
		RequestEntity<?> request = RequestEntity.get(URI.create(createUrl("/noStorage")))
			.accept(MediaType.TEXT_HTML)
			.build();
		ResponseEntity<String> entity = new TestRestTemplate().exchange(request, String.class);
		String resp = entity.getBody();
		assertThat(resp).contains("We are out of storage");
	}

	@Test
	void testIncompatibleMediaType() {
		load();
		RequestEntity<?> request = RequestEntity.get(URI.create(createUrl("/incompatibleType")))
			.accept(MediaType.TEXT_PLAIN)
			.build();
		ResponseEntity<String> entity = new TestRestTemplate().exchange(request, String.class);
		assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.BAD_REQUEST);
		assertThat(entity.getHeaders().getContentType()).isNull();
		assertThat(entity.getBody()).isNull();
	}

	@Test
	@SuppressWarnings({ "rawtypes", "unchecked" })
	void customErrorControllerWithoutStatusConfiguration() {
		load(CustomErrorControllerWithoutStatusConfiguration.class);
		RequestEntity request = RequestEntity.post(URI.create(createUrl("/bodyValidation")))
			.accept(MediaType.APPLICATION_JSON)
			.contentType(MediaType.APPLICATION_JSON)
			.body("{}");
		ResponseEntity<Map> entity = new TestRestTemplate().exchange(request, Map.class);
		assertThat(entity.getBody()).doesNotContainKey("status");
	}

	private void assertErrorAttributes(Map<?, ?> content, String status, String error, Class<?> exception,
			String message, String path) {
		assertThat(content.get("status")).as("Wrong status").hasToString(status);
		assertThat(content.get("error")).as("Wrong error").isEqualTo(error);
		if (exception != null) {
			assertThat(content.get("exception")).as("Wrong exception").isEqualTo(exception.getName());
		}
		else {
			assertThat(content.containsKey("exception")).as("Exception attribute should not be set").isFalse();
		}
		assertThat(content.get("message")).as("Wrong message").isEqualTo(message);
		assertThat(content.get("path")).as("Wrong path").isEqualTo(path);
	}

	private String createUrl(String path) {
		int port = this.context.getEnvironment().getProperty("local.server.port", int.class);
		return "http://localhost:" + port + path;
	}

	private void load(String... arguments) {
		load(TestConfiguration.class, arguments);
	}

	private void load(Class<?> configuration, String... arguments) {
		List<String> args = new ArrayList<>();
		args.add("--server.port=0");
		if (arguments != null) {
			args.addAll(Arrays.asList(arguments));
		}
		this.context = SpringApplication.run(configuration, StringUtils.toStringArray(args));
	}

	@Target(ElementType.TYPE)
	@Retention(RetentionPolicy.RUNTIME)
	@Documented
	@ImportAutoConfiguration({ ServletWebServerFactoryAutoConfiguration.class, DispatcherServletAutoConfiguration.class,
			WebMvcAutoConfiguration.class, HttpMessageConvertersAutoConfiguration.class,
			ErrorMvcAutoConfiguration.class, PropertyPlaceholderAutoConfiguration.class })
	private @interface MinimalWebConfiguration {

	}

	@Configuration(proxyBeanMethods = false)
	@MinimalWebConfiguration
	@ImportAutoConfiguration(FreeMarkerAutoConfiguration.class)
	public static class TestConfiguration {

		// For manual testing
		static void main(String[] args) {
			SpringApplication.run(TestConfiguration.class, args);
		}

		@Bean
		View error() {
			return new AbstractView() {

				@Override
				protected void renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request,
						HttpServletResponse response) throws Exception {
					response.getWriter().write("ERROR_BEAN");
				}

			};
		}

		@RestController
		public static class Errors {

			public String getFoo() {
				return "foo";
			}

			@RequestMapping("/")
			String home() {
				throw new IllegalStateException("Expected!");
			}

			@RequestMapping("/noMessage")
			String noMessage() {
				throw new IllegalStateException();
			}

			@RequestMapping("/annotated")
			String annotated() {
				throw new ExpectedException();
			}

			@RequestMapping("/annotatedNoReason")
			String annotatedNoReason() {
				throw new NoReasonExpectedException("Expected message");
			}

			@RequestMapping("/annotatedNoMessage")
			String annotatedNoMessage() {
				throw new NoReasonExpectedException("");
			}

			@RequestMapping("/bind")
			String bind(@RequestAttribute(required = false) String foo) throws Exception {
				BindException error = new BindException(this, "test");
				error.rejectValue("foo", "bar.error");
				Parameter fooParameter = ReflectionUtils.findMethod(Errors.class, "bind", String.class)
					.getParameters()[0];
				throw new MethodArgumentNotValidException(MethodParameter.forParameter(fooParameter), error);
			}

			@PostMapping(path = "/bodyValidation", produces = "application/json")
			String bodyValidation(@Valid @RequestBody DummyBody body) {
				return body.content;
			}

			@RequestMapping(path = "/noStorage")
			String noStorage() {
				throw new InsufficientStorageException();
			}

			@RequestMapping(path = "/incompatibleType", produces = "text/plain")
			String incompatibleType() {
				throw new ExpectedException();
			}

			@ResponseStatus(value = HttpStatus.BAD_REQUEST, reason = "Expected!")
			@SuppressWarnings("serial")
			static class ExpectedException extends RuntimeException {

			}

			@ResponseStatus(HttpStatus.INSUFFICIENT_STORAGE)
			static class InsufficientStorageException extends RuntimeException {

			}

			@ResponseStatus(HttpStatus.NOT_ACCEPTABLE)
			@SuppressWarnings("serial")
			static class NoReasonExpectedException extends RuntimeException {

				NoReasonExpectedException(String message) {
					super(message);
				}

			}

			static class DummyBody {

				@NotNull
				private String content;

				String getContent() {
					return this.content;
				}

				void setContent(String content) {
					this.content = content;
				}

			}

		}

	}

	static class CustomErrorControllerWithoutStatusConfiguration extends TestConfiguration {

		@Bean
		BasicErrorController basicErrorController(ServerProperties serverProperties, ErrorAttributes errorAttributes,
				ObjectProvider<ErrorViewResolver> errorViewResolvers) {
			return new BasicErrorController(errorAttributes, serverProperties.getError(),
					errorViewResolvers.orderedStream().toList()) {

				@Override
				protected ErrorAttributeOptions getErrorAttributeOptions(HttpServletRequest request,
						MediaType mediaType) {
					return super.getErrorAttributeOptions(request, mediaType).excluding(Include.STATUS);
				}

			};
		}

	}

}
