Added addition tests to improve the coverage

dilipkrish · dilipkrish · commit 8e419ef6e0d6 · 2017-03-11T16:34:54.000-06:00
diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,40 @@
+codecov:
+  notify:
+    require_ci_to_pass: yes
+
+coverage:
+  precision: 2
+  round: down
+  range: "70...95"
+
+  status:
+    project: yes
+    patch: yes
+    changes: no
+    
+  notify:
+    gitter:
+      default:
+        url: "https://webhooks.gitter.im/e/49ad46bbe08a7cda7e7f"
+        threshold: 1%
+        only_pulls: false
+        branches: null
+        flags: null
+        paths: null
+
+parsers:
+  gcov:
+    branch_detection:
+      conditional: yes
+      loop: yes
+      method: no
+      macro: no
+
+comment:
+  layout: "header, diff"
+  behavior: default
+  require_changes: no
+
+ignore:
+  - "/springfox-grails/src/main/java/springfox/documentation/grails/SynthesizedAnnotations.java"
+  - "/springfox-grails/src/main/java/springfox/documentation/grails/ActionSpecificationFactory.java"
diff --git a/springfox-grails-contract-tests/src/integration-test/resources/expected-service-description.json b/springfox-grails-contract-tests/src/integration-test/resources/expected-service-description.json
@@ -13,7 +13,7 @@
       "url": "http://www.apache.org/licenses/LICENSE-2.0"
     }
   },
-  "host": "localhost:8080",
+  "host": "localhost:__PORT__",
   "basePath": "/",
   "tags": [
     {
diff --git a/springfox-grails/src/main/java/springfox/documentation/grails/Actions.java b/springfox-grails/src/main/java/springfox/documentation/grails/Actions.java
@@ -72,16 +72,6 @@ static Set<RequestMethod> methodOverrides(GrailsActionContext context) {
     return methodOverrides(context, newHashSet());
   }
 
-  private static void setFinalStatic(Field field, Object newValue) throws Exception {
-    field.setAccessible(true);
-
-    Field modifiersField = Field.class.getDeclaredField("modifiers");
-    modifiersField.setAccessible(true);
-    modifiersField.setInt(field, field.getModifiers() & ~Modifier.FINAL);
-
-    field.set(null, newValue);
-  }
-
   static Set<MediaType> producesOverrides(GrailsActionContext context) {
     Set<MediaType> produces = newHashSet(MediaType.APPLICATION_JSON);
     List<String> responseFormats;
diff --git a/springfox-grails/src/main/java/springfox/documentation/grails/DefaultGrailsPropertyTransformer.java b/springfox-grails/src/main/java/springfox/documentation/grails/DefaultGrailsPropertyTransformer.java
@@ -4,16 +4,25 @@
 
 public class DefaultGrailsPropertyTransformer implements GrailsPropertyTransformer {
   @Override
-  public AlternateTypePropertyBuilder apply(GrailsDomainClassProperty each) {
-    Class type = each.getReferencedPropertyType();
-    if (!each.isPersistent() && each.getName().endsWith("Id")) {
-      GrailsDomainClassProperty property = each.getDomainClass().getPropertyByName(each.getName().replace("Id", ""));
-      type = property.getDomainClass().getIdentifier().getType();
+  public AlternateTypePropertyBuilder apply(GrailsDomainClassProperty property) {
+    Class type = property.getReferencedPropertyType();
+    if (!property.isPersistent() && property.getName().endsWith("Id")) {
+      type = relatedDomainIdentifierType(relatedDomainProperty(property));
     }
+
     return new AlternateTypePropertyBuilder()
-        .withName(each.getName())
+        .withName(property.getName())
         .withType(type)
         .withCanRead(true)
         .withCanWrite(true);
   }
+
+  private Class relatedDomainIdentifierType(GrailsDomainClassProperty property) {
+    return property.getDomainClass().getIdentifier().getType();
+  }
+
+  private GrailsDomainClassProperty relatedDomainProperty(GrailsDomainClassProperty property) {
+    String entityPropertyName = property.getName().replace("Id", "");
+    return property.getDomainClass().getPropertyByName(entityPropertyName);
+  }
 }
diff --git a/springfox-grails/src/test/groovy/springfox/documentation/grails/ActionsSpec.groovy b/springfox-grails/src/test/groovy/springfox/documentation/grails/ActionsSpec.groovy
@@ -1,6 +1,12 @@
 package springfox.documentation.grails
 
+import grails.core.GrailsControllerClass
+import grails.core.GrailsDomainClass
+import grails.web.mapping.LinkGenerator
+import grails.web.mapping.UrlMappings
+import org.springframework.web.bind.annotation.RequestMethod
 import spock.lang.Specification
+import spock.lang.Unroll
 
 
 class ActionsSpec extends Specification implements GrailsControllerSupport {
@@ -28,4 +34,64 @@ class ActionsSpec extends Specification implements GrailsControllerSupport {
       handlerMethods.containsKey("delete")
       handlerMethods.containsKey("other")
   }
+
+  @Unroll
+  def "Detects grails method overrides for #action"() {
+    given:
+      def grailsController = grailsController(controller)
+      def context = context(grailsController, action)
+    when:
+      def methods = Actions.methodOverrides(context)
+    then:
+      methods == expected
+    where:
+      controller          | action          | expected
+      OverridenController | "withOverrides" | [RequestMethod.POST] as Set
+      OverridenController | "noOverrides"   | [] as Set
+  }
+
+  @Unroll
+  def "Detects grails method overrides with defaults for #action"() {
+    given:
+      def grailsController = grailsController(controller)
+      def context = context(grailsController, action)
+    when:
+      def methods = Actions.methodOverrides(context, [RequestMethod.GET] as Set)
+    then:
+      methods == expected
+    where:
+      controller          | action          | expected
+      OverridenController | "withOverrides" | [RequestMethod.POST] as Set
+      OverridenController | "noOverrides"   | [RequestMethod.GET] as Set
+  }
+
+  def grailsController(Class controller) {
+    def grails = Mock(GrailsControllerClass)
+    grails.clazz >> controller
+    grails
+  }
+
+  GrailsActionContext context(controller, action) {
+    new GrailsActionContext(
+        controller,
+        Mock(GrailsDomainClass),
+        actionAttributes(),
+        action)
+  }
+
+  def actionAttributes() {
+    new GrailsActionAttributes(
+        Mock(LinkGenerator),
+        Mock(UrlMappings))
+  }
+
+  class OverridenController {
+    static allowedMethods = [withOverrides: "POST", update: "PUT", delete: "DELETE"]
+
+    def withOverrides() {
+    }
+
+    def show() {
+    }
+  }
 }
diff --git a/springfox-grails/src/test/groovy/springfox/documentation/grails/DefaultGrailsPropertySelectorSpec.groovy b/springfox-grails/src/test/groovy/springfox/documentation/grails/DefaultGrailsPropertySelectorSpec.groovy
@@ -0,0 +1,46 @@
+package springfox.documentation.grails
+
+import grails.core.GrailsDomainClass
+import grails.core.GrailsDomainClassProperty
+import spock.lang.Specification
+import spock.lang.Unroll
+
+
+class DefaultGrailsPropertySelectorSpec extends Specification {
+  @Unroll
+  def "selects scalar properties except version" () {
+    given:
+      def sut = new DefaultGrailsPropertySelector()
+    expect:
+      sut.apply(property) == expected
+    where:
+      property        | expected
+      version()       | false
+      scalar()        | true
+      entity()        | false
+      versionEntity() | false
+  }
+
+  GrailsDomainClassProperty version() {
+    property("version", null)
+  }
+
+  GrailsDomainClassProperty scalar() {
+    property("name", null)
+  }
+
+  GrailsDomainClassProperty entity() {
+    property("name", Mock(GrailsDomainClass))
+  }
+
+  GrailsDomainClassProperty versionEntity() {
+    property("version", Mock(GrailsDomainClass))
+  }
+  
+  def property(name, domain) {
+    def property = Mock(GrailsDomainClassProperty)
+    property.name >> name
+    property.referencedDomainClass >> domain
+    property
+  }
+}
diff --git a/springfox-grails/src/test/groovy/springfox/documentation/grails/DefaultGrailsPropertyTransformerSpec.groovy b/springfox-grails/src/test/groovy/springfox/documentation/grails/DefaultGrailsPropertyTransformerSpec.groovy
@@ -0,0 +1,72 @@
+package springfox.documentation.grails
+
+import grails.core.GrailsDomainClass
+import grails.core.GrailsDomainClassProperty
+import spock.lang.Specification
+import spock.lang.Unroll
+
+
+class DefaultGrailsPropertyTransformerSpec extends Specification {
+  @Unroll
+  def "Infers types correctly for grails property #name" (){
+    given:
+      def sut = new DefaultGrailsPropertyTransformer()
+    when:
+      def transformed = sut.apply(property)
+    then:
+      transformed.name == name
+      transformed.clazz == type
+    where:
+      property                        | name                | type
+      id()                            | "id"                | Long
+      relatedEntityProperty()         | "relatedEntity"     | RelatedEntity
+      relatedEntityIdProperty()       | "relatedEntityId"   | Long
+      scalarProperty("test", String)  | "test"              | String
+  }
+
+  def id() {
+    scalarProperty("id", Long)
+  }
+
+  def scalarProperty(propertyName, propertyType) {
+    def property = Mock(GrailsDomainClassProperty)
+    property.referencedPropertyType >> propertyType
+    property.type >> propertyType
+    property.persistent >> true
+    property.name >> propertyName
+    property
+  }
+
+  def relatedEntityProperty() {
+    def property = Mock(GrailsDomainClassProperty)
+    property.referencedPropertyType >> RelatedEntity
+    property.persistent >> true
+    property.name >> "relatedEntity"
+    property.domainClass >> relatedEntityDomain()
+    property
+  }
+
+  def relatedEntityIdProperty() {
+    def property = Mock(GrailsDomainClassProperty)
+    property.referencedPropertyType >> Long
+    property.persistent >> false
+    property.name >> "relatedEntityId"
+    property.domainClass >> domainClass()
+    property
+  }
+
+  GrailsDomainClass domainClass() {
+    def domain = Mock(GrailsDomainClass)
+    domain.getPropertyByName("relatedEntity") >> relatedEntityProperty()
+    domain
+  }
+
+  GrailsDomainClass relatedEntityDomain() {
+    def domain = Mock(GrailsDomainClass)
+    domain.getIdentifier() >> id()
+    domain
+  }
+
+  class RelatedEntity {
+  }
+}
diff --git a/springfox-grails/src/test/groovy/springfox/documentation/grails/GrailsActionAttributesSpec.groovy b/springfox-grails/src/test/groovy/springfox/documentation/grails/GrailsActionAttributesSpec.groovy
@@ -0,0 +1,100 @@
+package springfox.documentation.grails
+
+import grails.core.GrailsControllerClass
+import grails.core.GrailsDomainClass
+import grails.web.mapping.LinkGenerator
+import grails.web.mapping.UrlMapping
+import grails.web.mapping.UrlMappings
+import org.springframework.web.bind.annotation.RequestMethod
+import spock.lang.Specification
+
+
+class GrailsActionAttributesSpec extends Specification {
+
+  def "Gets the http methods for operations correctly" () {
+    given:
+      def sut = actionAttributes(linkGenerator(), urlMappings())
+    when:
+      def actual = sut.httpMethod(context)
+    then:
+      actual == methods
+    where:
+      context           | methods
+      noOverrides()     | [RequestMethod.GET] as Set
+      withOverrides()   | [RequestMethod.POST] as Set
+  }
+
+  GrailsActionContext noOverrides() {
+    context(noOverridesController(), "noOverride")
+  }
+
+  GrailsActionContext withOverrides() {
+    context(withOverridesController(), "withOverrides")
+  }
+
+  GrailsActionContext context(controller, action) {
+    new GrailsActionContext(
+        controller,
+        Mock(GrailsDomainClass),
+        actionAttributes(linkGenerator(), urlMappings()),
+        action)
+  }
+
+  def noOverridesController() {
+    controller(AController, "A")
+  }
+
+  def withOverridesController() {
+    controller(OverridenController, "Overriden")
+  }
+
+  def controller(controllerClazz, name) {
+    def controller = Mock(GrailsControllerClass)
+    controller.clazz >> controllerClazz
+    controller.name >> name
+    controller
+  }
+
+  def actionAttributes(linkGenerator, urlMappings) {
+    new GrailsActionAttributes(
+        linkGenerator,
+        urlMappings)
+  }
+
+  UrlMappings urlMappings() {
+    def mappings = Mock(UrlMappings)
+    mappings.urlMappings >> [noOverrideMapping(), withOverrideMapping()]
+    mappings
+  }
+
+  def noOverrideMapping() {
+    def noOverride = Mock(UrlMapping)
+    noOverride.actionName >> "noOverride"
+    noOverride.httpMethod >> "GET"
+    noOverride.controllerName >> "A"
+    noOverride
+  }
+
+
+  def withOverrideMapping() {
+    def noOverride = Mock(UrlMapping)
+    noOverride.actionName >> "withOverride"
+    noOverride.httpMethod >> "POST"
+    noOverride.controllerName >> "Override"
+    noOverride
+  }
+
+  LinkGenerator linkGenerator() {
+    def links = Mock(LinkGenerator)
+    links.link(_) >> "/test"
+    links.serverBaseURL >> "http://localhost:8080"
+    links
+  }
+
+  class OverridenController {
+    static allowedMethods = [withOverrides: "POST", update: "PUT", delete: "DELETE"]
+
+    def withOverrides() {
+    }
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`"url": "http://www.apache.org/licenses/LICENSE-2.0"`
`14`	`14`	`}`
`15`	`15`	`},`
`16`		`- "host": "localhost:8080",`
	`16`	`+ "host": "localhost:__PORT__",`
`17`	`17`	`"basePath": "/",`
`18`	`18`	`"tags": [`
`19`	`19`	`{`