Added a failing test for bidirectional recursive types

Author: dilipkrish

springfox-spring-web/src/test/groovy/springfox/documentation/spring/web/readers/ApiModelReaderSpec.groovy

@@ -24,19 +24,21 @@ import org.springframework.http.HttpEntity
 import org.springframework.http.ResponseEntity
 import org.springframework.web.method.HandlerMethod
 import spock.lang.Ignore
-import springfox.documentation.spring.web.dummy.DummyModels
-import springfox.documentation.spring.web.mixins.ServicePluginsSupport
-import springfox.documentation.spring.web.scanners.ApiModelReader
 import springfox.documentation.schema.Model
 import springfox.documentation.schema.ModelProperty
 import springfox.documentation.spi.service.contexts.RequestMappingContext
+import springfox.documentation.spring.web.dummy.DummyModels
 import springfox.documentation.spring.web.dummy.controllers.BusinessService
 import springfox.documentation.spring.web.dummy.controllers.PetService
 import springfox.documentation.spring.web.dummy.models.FoobarDto
+import springfox.documentation.spring.web.dummy.models.Monkey
+import springfox.documentation.spring.web.dummy.models.Pirate
 import springfox.documentation.spring.web.mixins.ModelProviderForServiceSupport
 import springfox.documentation.spring.web.mixins.RequestMappingSupport
+import springfox.documentation.spring.web.mixins.ServicePluginsSupport
 import springfox.documentation.spring.web.plugins.DocumentationContextSpec
 import springfox.documentation.spring.web.plugins.DocumentationPluginsManager
+import springfox.documentation.spring.web.scanners.ApiModelReader
 
 import javax.servlet.http.HttpServletResponse
 
@@ -246,4 +248,24 @@ class ApiModelReaderSpec extends DocumentationContextSpec {
       modelProperties.containsKey('visibleForSerialize')
 
   }
+  def "Test to verify issue #1196"() {
+    given:
+      HandlerMethod handlerMethod = dummyHandlerMethod('methodToTestBidrectionalRecursiveTypes', Pirate)
+      RequestMappingContext context = new RequestMappingContext(context(), requestMappingInfo('/somePath'), handlerMethod)
+
+    when:
+      def models = sut.read(context)
+      Model pirate = models[Pirate.simpleName]
+      Model monkey = models[Monkey.simpleName]
+
+    then:
+      models.size() == 2
+    and:
+      pirate != null
+      monkey != null
+    and:
+      pirate.getProperties().containsKey('monkey')
+      monkey.getProperties().containsKey('pirate')
+
+  }
 }

springfox-spring-web/src/test/java/springfox/documentation/spring/web/dummy/DummyClass.java

@@ -45,6 +45,7 @@
 import springfox.documentation.spring.web.dummy.models.EnumType;
 import springfox.documentation.spring.web.dummy.models.Example;
 import springfox.documentation.spring.web.dummy.models.FoobarDto;
+import springfox.documentation.spring.web.dummy.models.Pirate;
 import springfox.documentation.spring.web.dummy.models.Treeish;
 
 import javax.servlet.ServletRequest;
@@ -352,6 +353,10 @@ public FoobarDto methodToTestFoobarDto(@RequestBody FoobarDto model) {
     return null;
   }
 
+  @ResponseBody
+  public void methodToTestBidrectionalRecursiveTypes(@RequestBody Pirate model) {
+  }
+
   public enum BusinessType {
     PRODUCT(1),
     SERVICE(2);

springfox-spring-web/src/test/java/springfox/documentation/spring/web/dummy/models/Monkey.java

@@ -0,0 +1,31 @@
+/*
+ *
+ *  Copyright 2016 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
+ *
+ *         http://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 springfox.documentation.spring.web.dummy.models;
+
+public class Monkey {
+  private Pirate pirate;
+
+  public Pirate getPirate() {
+    return pirate;
+  }
+
+  public void setPirate(Pirate pirate) {
+    this.pirate = pirate;
+  }
+}

springfox-spring-web/src/test/java/springfox/documentation/spring/web/dummy/models/Pirate.java

@@ -0,0 +1,31 @@
+/*
+ *
+ *  Copyright 2016 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
+ *
+ *         http://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 springfox.documentation.spring.web.dummy.models;
+
+public class Pirate {
+  private Monkey monkey;
+
+  public Monkey getMonkey() {
+    return monkey;
+  }
+
+  public void setMonkey(Monkey monkey) {
+    this.monkey = monkey;
+  }
+}