Merge pull request #4 from SpringSimpleUtils/dev

Added unsupported media type and method not allowed exception handlers.

Author: remmintan

build.gradle.kts

@@ -10,7 +10,7 @@ plugins {
 }
 
 group = "io.github.springsimpleutils"
-version = "0.1.0"
+version = "0.2.0"
 java.sourceCompatibility = JavaVersion.VERSION_11
 
 repositories {

src/main/kotlin/ru/remmintan/simple/exceptions/RestExceptionHandler.kt

@@ -7,6 +7,8 @@ import org.springframework.http.ResponseEntity
 import org.springframework.http.converter.HttpMessageNotReadableException
 import org.springframework.validation.BindException
 import org.springframework.validation.BindingResult
+import org.springframework.web.HttpMediaTypeNotSupportedException
+import org.springframework.web.HttpRequestMethodNotSupportedException
 import org.springframework.web.bind.MethodArgumentNotValidException
 import org.springframework.web.bind.annotation.ControllerAdvice
 import org.springframework.web.bind.annotation.ExceptionHandler
@@ -58,6 +60,29 @@ class RestExceptionHandler {
     fun handleMethodArgumentNotValid(ex: MethodArgumentNotValidException): ErrorDto
         = parseBindingResult(ex.bindingResult)
 
+    @ExceptionHandler(HttpRequestMethodNotSupportedException::class)
+    fun handleMethodNotAllowedException(ex: HttpRequestMethodNotSupportedException): ResponseEntity<ErrorDto> {
+        val allowedMethods = ex.supportedMethods?.toList()?.joinToString(", ") ?: ""
+        val errorMessage = "Method ${ex.method} not allowed. Allowed methods: $allowedMethods."
+
+        val dto = ErrorDto(errorMessage)
+        var responseEntity = ResponseEntity
+            .status(HttpStatus.METHOD_NOT_ALLOWED);
+
+        val allowedHeaders = ex.supportedHttpMethods?.toTypedArray()
+        if(allowedHeaders != null) {
+            responseEntity = responseEntity.allow(*allowedHeaders)
+        }
+
+        return responseEntity.body(dto)
+    }
+
+    @ExceptionHandler(HttpMediaTypeNotSupportedException::class)
+    @ResponseBody
+    @ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE)
+    fun handleUnsupportedMediaTypeException(ex: HttpMediaTypeNotSupportedException): ErrorDto =
+        ErrorDto(ex.localizedMessage)
+
     private fun parseBindingResult(br: BindingResult): ErrorDto {
         val errors = br.allErrors.map {it.defaultMessage}.joinToString("\n")
         return ErrorDto(errors)

src/test/kotlin/ru/remmintan/simple/exceptions/HttpProtocolExceptionsTest.kt

@@ -0,0 +1,53 @@
+package ru.remmintan.simple.exceptions
+
+import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.jupiter.api.Test
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.context.SpringBootTest
+import org.springframework.boot.test.web.client.TestRestTemplate
+import org.springframework.http.*
+import ru.remmintan.simple.exceptions.dtos.ErrorDto
+import ru.remmintan.simple.exceptions.testapp.TestApplication
+
+@SpringBootTest(classes = [TestApplication::class], webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
+class HttpProtocolExceptionsTest {
+
+    @Autowired
+    private lateinit var rest: TestRestTemplate
+
+    private val mapper = jacksonObjectMapper()
+
+    @Test
+    fun methodNotAllowedTest() {
+        val message = "Method POST not allowed. Allowed methods: GET."
+
+        val result = rest.postForEntity("/test/badrequest", null, String::class.java)
+        assertThat(result.statusCode).isEqualTo(HttpStatus.METHOD_NOT_ALLOWED)
+        assertThat(result.hasBody()).isTrue
+        val error = mapper.readValue(result.body, ErrorDto::class.java)
+        assertThat(error.message).isEqualTo(message)
+    }
+
+    @Test
+    fun notFoundTest() {
+        val result = rest.getForEntity("/path/that/doesnt/exist", String::class.java)
+        assertThat(result.statusCode).isEqualTo(HttpStatus.NOT_FOUND)
+    }
+
+    @Test
+    fun mediaTypeNotSupportedTest() {
+        val invalidHeaders = HttpHeaders()
+        invalidHeaders.contentType = MediaType.TEXT_PLAIN
+        val invalidEntity = HttpEntity("", invalidHeaders);
+
+        val errorMessage = "Content type 'text/plain;charset=UTF-8' not supported"
+
+        val result = rest.postForEntity("/validation/mapping", invalidEntity, String::class.java)
+        assertThat(result.statusCode).isEqualTo(HttpStatus.UNSUPPORTED_MEDIA_TYPE)
+        assertThat(result.hasBody()).isTrue
+        val error = mapper.readValue(result.body, ErrorDto::class.java)
+        assertThat(error.message).isEqualTo(errorMessage)
+    }
+
+}