Added update action specification tests

Also provided index to body parameters

Author: dilipkrish

springfox-grails/build.gradle

@@ -28,6 +28,7 @@ apply plugin: 'groovy'
 apply plugin: 'idea'
 apply plugin: 'maven-publish'
 apply plugin: 'com.jfrog.bintray'
+apply plugin: 'jacoco'
 apply from: 'gradle/publishing.gradle'
 
 description = 'Springfox Grails module that produces grails specific documentation'
@@ -91,3 +92,12 @@ jar {
       )
     }
 }
+
+jacocoTestReport {
+  reports {
+    xml.enabled true
+    html.enabled false
+  }
+}
+
+

springfox-grails/src/main/java/springfox/documentation/grails/ActionSpecificationFactory.java

@@ -35,9 +35,9 @@ default ResolvedMethodParameter queryParameter(
         resolvedType);
   }
 
-  default ResolvedMethodParameter bodyParameter(ResolvedType resolvedType) {
+  default ResolvedMethodParameter bodyParameter(int parameterIndex, ResolvedType resolvedType) {
     return new ResolvedMethodParameter(
-        1,
+        parameterIndex,
         "body",
         singletonList(SynthesizedAnnotations.REQUEST_BODY_ANNOTATION), resolvedType);
   }

springfox-grails/src/main/java/springfox/documentation/grails/CreateActionSpecificationFactory.java

@@ -30,7 +30,7 @@ public ActionSpecification create(GrailsActionContext context) {
         new HashSet<>(Collections.singletonList(MediaType.APPLICATION_JSON)),
         handlerMethod,
         new ArrayList<>(Collections.singletonList(
-            bodyParameter(resolver.resolve(domainClass(context.getDomainClass()))))),
+            bodyParameter(1, resolver.resolve(domainClass(context.getDomainClass()))))),
         resolver.resolve(domainClass(context.getDomainClass())));
   }
 }

springfox-grails/src/main/java/springfox/documentation/grails/EditActionSpecificationFactory.java

@@ -31,7 +31,7 @@ public ActionSpecification create(GrailsActionContext context) {
         handlerMethod,
         new ArrayList<>(Arrays.asList(
             pathParameter(1, "id", resolver.resolve(idType(context.getDomainClass()))),
-            bodyParameter(resolver.resolve(domainClass(context.getDomainClass()))))),
+            bodyParameter(1, resolver.resolve(domainClass(context.getDomainClass()))))),
         resolver.resolve(domainClass(context.getDomainClass())));
 
   }

springfox-grails/src/main/java/springfox/documentation/grails/PatchActionSpecificationFactory.java

@@ -31,7 +31,7 @@ public ActionSpecification create(GrailsActionContext context) {
         handlerMethod,
         new ArrayList<>(Arrays.asList(
             pathParameter(1, "id", resolver.resolve(idType(context.getDomainClass()))),
-            bodyParameter(resolver.resolve(domainClass(context.getDomainClass()))))),
+            bodyParameter(1, resolver.resolve(domainClass(context.getDomainClass()))))),
         resolver.resolve(domainClass(context.getDomainClass())));
 
   }

springfox-grails/src/main/java/springfox/documentation/grails/SaveActionSpecificationFactory.java

@@ -31,7 +31,7 @@ public ActionSpecification create(GrailsActionContext context) {
         handlerMethod,
         new ArrayList<>(Arrays.asList(
             pathParameter(1, "id", resolver.resolve(idType(context.getDomainClass()))),
-            bodyParameter(resolver.resolve(domainClass(context.getDomainClass()))))),
+            bodyParameter(1, resolver.resolve(domainClass(context.getDomainClass()))))),
         resolver.resolve(domainClass(context.getDomainClass())));
 
   }

springfox-grails/src/main/java/springfox/documentation/grails/UpdateActionSpecificationFactory.java

@@ -31,7 +31,7 @@ public ActionSpecification create(GrailsActionContext context) {
         handlerMethod,
         new ArrayList<>(Arrays.asList(
             pathParameter(1, "id", resolver.resolve(idType(context.getDomainClass()))),
-            bodyParameter(resolver.resolve(domainClass(context.getDomainClass()))))),
+            bodyParameter(2, resolver.resolve(domainClass(context.getDomainClass()))))),
         resolver.resolve(domainClass(context.getDomainClass())));
 
   }

springfox-grails/src/test/groovy/springfox/documentation/grails/UpdateActionSpecificationFactorySpec.groovy

@@ -0,0 +1,58 @@
+package springfox.documentation.grails
+
+import com.fasterxml.classmate.TypeResolver
+import grails.core.GrailsControllerClass
+import grails.core.GrailsDomainClass
+import grails.core.GrailsDomainClassProperty
+import org.springframework.http.MediaType
+import org.springframework.web.bind.annotation.RequestMethod
+import spock.lang.Specification
+
+class UpdateActionSpecificationFactorySpec extends Specification {
+  def controller = Mock(GrailsControllerClass)
+  def domain = Mock(GrailsDomainClass)
+  def identifierProperty = Mock(GrailsDomainClassProperty)
+
+  def setup() {
+    controller.clazz >> AController
+    domain.clazz >> ADomain
+    domain.identifier >> identifierProperty
+    domain.identifier.type >> Integer
+  }
+
+  def "Create action produces action specification" () {
+    given:
+      def resolver = new TypeResolver()
+      def sut = new UpdateActionSpecificationFactory(resolver)
+    when:
+      def spec = sut.create(new GrailsActionContext(controller, domain, "update"))
+    then:
+      spec.consumes == [MediaType.APPLICATION_JSON] as Set
+      spec.produces == [MediaType.APPLICATION_JSON] as Set
+      spec.supportedMethods == [RequestMethod.PUT, RequestMethod.POST] as Set
+      spec.parameters.size() == 2
+      spec.parameters[0].parameterType == resolver.resolve(Integer)
+      spec.parameters[0].parameterIndex == 1
+      spec.parameters[0].defaultName().isPresent()
+      spec.parameters[0].defaultName().get() == "id"
+
+      spec.parameters[1].parameterType == resolver.resolve(ADomain)
+      spec.parameters[1].parameterIndex == 2
+      spec.parameters[1].defaultName().isPresent()
+      spec.parameters[1].defaultName().get() == "body"
+
+      spec.returnType == resolver.resolve(ADomain)
+      spec.handlerMethod.method == AController.methods.find {it.name == "update" }
+  }
+
+  def "Index action throws exception when action is not found" () {
+    given:
+      def resolver = new TypeResolver()
+      def sut = new UpdateActionSpecificationFactory(resolver)
+    when:
+      sut.create(new GrailsActionContext(controller, domain, "unknown"))
+    then:
+      def exception = thrown(NullPointerException)
+      exception.message.contains("Handler method is null")
+  }
+}