Merge pull request #146 from mikrethor/fix/131-incorrect-mapping-head-trace-options

Fix 131 Incorrect Mapping for @HeadMapping/@TraceMapping/@OptionsMapping

Author: hauner

src/main/kotlin/io/openapiprocessor/spring/writer/java/MappingAnnotationWriter.kt

@@ -18,9 +18,10 @@ package io.openapiprocessor.spring.writer.java
 
 import io.openapiprocessor.core.model.Endpoint
 import io.openapiprocessor.core.model.EndpointResponse
+import io.openapiprocessor.core.model.HttpMethod
 import io.openapiprocessor.core.support.capitalizeFirstChar
-import io.openapiprocessor.core.writer.java.MappingAnnotationWriter as CoreMappingAnnotationWriter
 import java.io.Writer
+import io.openapiprocessor.core.writer.java.MappingAnnotationWriter as CoreMappingAnnotationWriter
 
 /**
  * spring mapping annotation writer
@@ -60,12 +61,23 @@ class MappingAnnotationWriter: CoreMappingAnnotationWriter {
             mapping += "}"
         }
 
+        val method = endpoint.method.method
+        if (method in arrayOf("head","trace","options")) {
+            mapping += ", "
+            mapping += "method = RequestMethod.${method.uppercase()}"
+        }
+
         mapping += ")"
         return mapping
     }
 
     private fun getMappingAnnotation(endpoint: Endpoint): String {
-        return "@${endpoint.method.method.capitalizeFirstChar ()}Mapping"
+        return when(endpoint.method){
+            HttpMethod.HEAD, HttpMethod.OPTIONS, HttpMethod.TRACE -> "@RequestMapping"
+            else -> {
+                "@${endpoint.method.method.capitalizeFirstChar ()}Mapping"
+            }
+        }
     }
 
     private fun quote(content: String): String {

src/test/groovy/io/openapiprocessor/spring/writer/java/MappingAnnotationWriterSpec.groovy

@@ -46,10 +46,10 @@ class MappingAnnotationWriterSpec extends Specification {
         HttpMethod.PUT     | "put-it"     | """@PutMapping(path = "put-it")"""
         HttpMethod.POST    | "post-it"    | """@PostMapping(path = "post-it")"""
         HttpMethod.DELETE  | "delete-it"  | """@DeleteMapping(path = "delete-it")"""
-        HttpMethod.OPTIONS | "options-it" | """@OptionsMapping(path = "options-it")"""
-        HttpMethod.HEAD    | "head-it"    | """@HeadMapping(path = "head-it")"""
+        HttpMethod.OPTIONS | "options-it" | """@RequestMapping(path = "options-it", method = RequestMethod.OPTIONS)"""
+        HttpMethod.HEAD    | "head-it"    | """@RequestMapping(path = "head-it", method = RequestMethod.HEAD)"""
         HttpMethod.PATCH   | "patch-it"   | """@PatchMapping(path = "patch-it")"""
-        HttpMethod.TRACE   | "trace-it"   | """@TraceMapping(path = "trace-it")"""
+        HttpMethod.TRACE   | "trace-it"   | """@RequestMapping(path = "trace-it", method = RequestMethod.TRACE)"""
     }
 
     void "writes 'consumes' parameter with body content type" () {

src/test/groovy/io/openapiprocessor/spring/writer/java/MethodWriterSpec.groovy

@@ -82,4 +82,82 @@ class MethodWriterSpec extends Specification {
 """
     }
 
+    void "head method" () {
+        def dataTypeName = new DataTypeName('java.lang.String', 'java.lang.String')
+
+        def endpoint = createEndpoint (path: '/foo', method: HttpMethod.HEAD, responses: [
+                '200': [new EmptyResponse()]
+        ], parameters: [
+                new QueryParameter('foo', new MappedDataType (
+                        'String',
+                        'java.util',
+                        [],
+                        null,
+                        false,
+                        true
+                ), false, false, null)
+        ])
+
+        when:
+        writer.write (target, endpoint, endpoint.endpointResponses.first ())
+
+        then:
+        target.toString () == """\
+    @RequestMapping(path = "${endpoint.path}", method = RequestMethod.HEAD)
+    void headFoo(@RequestParam(name = "foo", required = false) String foo);
+"""
+    }
+
+    void "trace method" () {
+        def dataTypeName = new DataTypeName('java.lang.String', 'java.lang.String')
+
+        def endpoint = createEndpoint (path: '/foo', method: HttpMethod.TRACE, responses: [
+                '200': [new EmptyResponse()]
+        ], parameters: [
+                new QueryParameter('foo', new MappedDataType (
+                        'String',
+                        'java.util',
+                        [],
+                        null,
+                        false,
+                        true
+                ), false, false, null)
+        ])
+
+        when:
+        writer.write (target, endpoint, endpoint.endpointResponses.first ())
+
+        then:
+        target.toString () == """\
+    @RequestMapping(path = "${endpoint.path}", method = RequestMethod.TRACE)
+    void traceFoo(@RequestParam(name = "foo", required = false) String foo);
+"""
+    }
+
+    void "option method" () {
+        def dataTypeName = new DataTypeName('java.lang.String', 'java.lang.String')
+
+        def endpoint = createEndpoint (path: '/foo', method: HttpMethod.OPTIONS, responses: [
+                '200': [new EmptyResponse()]
+        ], parameters: [
+                new QueryParameter('foo', new MappedDataType (
+                        'String',
+                        'java.util',
+                        [],
+                        null,
+                        false,
+                        true
+                ), false, false, null)
+        ])
+
+        when:
+        writer.write (target, endpoint, endpoint.endpointResponses.first ())
+
+        then:
+        target.toString () == """\
+    @RequestMapping(path = "${endpoint.path}", method = RequestMethod.OPTIONS)
+    void optionsFoo(@RequestParam(name = "foo", required = false) String foo);
+"""
+    }
+
 }