Added breaking test to demonstrate nullable expandable parameters

dilipkrish · dilipkrish · commit 45ff57739afa · 2017-07-06T18:45:51.000-05:00
Fixed the contracts accordingly

(1864)
diff --git a/springfox-spring-web/src/test/java/springfox/documentation/spring/web/dummy/controllers/BugsController.java b/springfox-spring-web/src/test/java/springfox/documentation/spring/web/dummy/controllers/BugsController.java
@@ -29,6 +29,7 @@
 import io.swagger.annotations.ApiResponses;
 import org.springframework.hateoas.Resource;
 import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.ModelAttribute;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -41,6 +42,7 @@
 
 import javax.servlet.http.HttpServletResponse;
 import javax.validation.Valid;
+import javax.validation.constraints.NotNull;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.nio.ByteBuffer;
@@ -218,6 +220,24 @@ public void modelWithListOfEnumsAsJson(@RequestBody Model1819 model) {
   public void modelWithListOfEnumsAsModelAttribute(@ModelAttribute Model1819 model) {
   }
 
+  @GetMapping("/1864")
+  public void test(@Valid Model1864 req) {
+
+  }
+
+  public class Model1864 {
+    @NotNull
+    private String somename;
+
+    public String getSomename() {
+      return somename;
+    }
+
+    public void setSomename(String somename) {
+      this.somename = somename;
+    }
+  }
+
   public class Model1819 {
 
     private List<EnumType> enumTypes;
diff --git a/swagger-contract-tests/build.gradle b/swagger-contract-tests/build.gradle
@@ -40,8 +40,9 @@ dependencies {
   compile project(':springfox-swagger1')
   compile project(':springfox-swagger2')
   compile project(':springfox-data-rest')
+  compile project(':springfox-petstore')
+  compile project(':springfox-bean-validators')
   compile project(':springfox-spring-web').sourceSets.test.output
-  compile project(path: ':springfox-petstore')
 
 
   compile(project(path: ':springfox-swagger-ui')) {
diff --git a/swagger-contract-tests/src/test/groovy/springfox/test/contract/swaggertests/FunctionContractSpec.groovy b/swagger-contract-tests/src/test/groovy/springfox/test/contract/swaggertests/FunctionContractSpec.groovy
@@ -36,6 +36,7 @@ import org.springframework.test.context.ContextConfiguration
 import spock.lang.Shared
 import spock.lang.Specification
 import spock.lang.Unroll
+import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
 import springfox.documentation.schema.AlternateTypeRuleConvention
 import springfox.documentation.spring.web.plugins.JacksonSerializerConvention
 
@@ -190,7 +191,11 @@ class FunctionContractSpec extends Specification implements FileAccess {
       "springfox.test.contract.swagger",
       "springfox.petstore.controller"
   ])
-  @Import([SecuritySupport, Swagger12TestConfig, Swagger2TestConfig])
+  @Import([
+      SecuritySupport,
+      Swagger12TestConfig,
+      Swagger2TestConfig,
+      BeanValidatorPluginsConfiguration])
   static class Config {
 
     @Bean
diff --git a/swagger-contract-tests/src/test/resources/contract/swagger2/declaration-bugs-different-service.json b/swagger-contract-tests/src/test/resources/contract/swagger2/declaration-bugs-different-service.json
@@ -14,13 +14,13 @@
   "host": "localhost:__PORT__",
   "basePath": "/",
   "tags": [
-    {
-      "name": "foo",
-      "description": "Foo Description"
-    },
     {
       "name": "bugs-controller",
       "description": "Bugs Controller"
+    },
+    {
+      "name": "foo",
+      "description": "Foo Description"
     }
   ],
   "produces": [
@@ -530,8 +530,8 @@
         "description": "Remove an apple from a user. You must specify the user name and the apple name.",
         "operationId": "bug1722UsingPOST_2",
         "consumes": [
-          "application/xml",
-          "application/json"
+          "application/json",
+          "application/xml"
         ],
         "produces": [
           "application/xml",
@@ -629,15 +629,17 @@
           {
             "name": "pageNumber",
             "in": "query",
-            "required": false,
+            "required": true,
             "type": "integer",
+            "minimum": 1.0,
             "format": "int32"
           },
           {
             "name": "pageSize",
             "in": "query",
-            "required": false,
+            "required": true,
             "type": "integer",
+            "maximum": 50.0,
             "format": "int32"
           },
           {
@@ -894,6 +896,35 @@
           }
         }
       }
+    },
+    "/bugs/1864{?somename}": {
+      "get": {
+        "tags": [
+          "bugs-controller"
+        ],
+        "summary": "test",
+        "operationId": "testUsingGET_2",
+        "consumes": [
+          "application/json"
+        ],
+        "produces": [
+          "application/xml",
+          "application/json"
+        ],
+        "parameters": [
+          {
+            "name": "somename",
+            "in": "query",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
     }
   },
   "securityDefinitions": {
@@ -1076,4 +1107,4 @@
       }
     }
   }
-}
+}
diff --git a/swagger-contract-tests/src/test/resources/contract/swagger2/declaration-bugs-service.json b/swagger-contract-tests/src/test/resources/contract/swagger2/declaration-bugs-service.json
@@ -14,13 +14,13 @@
   "host": "localhost:__PORT__",
   "basePath": "/",
   "tags": [
-    {
-      "name": "foo",
-      "description": "Foo Description"
-    },
     {
       "name": "bugs-controller",
       "description": "Bugs Controller"
+    },
+    {
+      "name": "foo",
+      "description": "Foo Description"
     }
   ],
   "produces": [
@@ -541,8 +541,8 @@
         "description": "Remove an apple from a user. You must specify the user name and the apple name.",
         "operationId": "bug1722UsingPOST_1",
         "consumes": [
-          "application/xml",
-          "application/json"
+          "application/json",
+          "application/xml"
         ],
         "produces": [
           "application/xml",
@@ -640,15 +640,17 @@
           {
             "name": "pageNumber",
             "in": "query",
-            "required": false,
+            "required": true,
             "type": "integer",
+            "minimum": 1.0,
             "format": "int32"
           },
           {
             "name": "pageSize",
             "in": "query",
-            "required": false,
+            "required": true,
             "type": "integer",
+            "maximum": 50.0,
             "format": "int32"
           },
           {
@@ -905,6 +907,35 @@
           }
         }
       }
+    },
+    "/bugs/1864{?somename}": {
+      "get": {
+        "tags": [
+          "bugs-controller"
+        ],
+        "summary": "test",
+        "operationId": "testUsingGET_1",
+        "consumes": [
+          "application/json"
+        ],
+        "produces": [
+          "application/xml",
+          "application/json"
+        ],
+        "parameters": [
+          {
+            "name": "somename",
+            "in": "query",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
     }
   },
   "securityDefinitions": {
@@ -1095,4 +1126,4 @@
       }
     }
   }
-}
+}
diff --git a/swagger-contract-tests/src/test/resources/contract/swagger2/swagger.json b/swagger-contract-tests/src/test/resources/contract/swagger2/swagger.json
@@ -15,25 +15,25 @@
   "basePath": "/",
   "tags": [
     {
-      "name": "pet-store-resource",
-      "description": "Operations about store"
+      "name": "generic-pet-controller",
+      "description": "Generic Pet Controller"
     },
     {
       "name": "pet-controller",
       "description": "Operations about pets"
     },
     {
-      "name": "generic-pet-controller",
-      "description": "Generic Pet Controller"
+      "name": "pet-store-resource",
+      "description": "Operations about store"
     },
     {
       "name": "user-controller",
       "description": "Operations about user"
     }
   ],
   "schemes": [
-    "http",
-    "https"
+    "https",
+    "http"
   ],
   "produces": [
     "application/xml",
@@ -990,4 +990,4 @@
       }
     }
   }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -15,25 +15,25 @@`
`15`	`15`	`"basePath": "/",`
`16`	`16`	`"tags": [`
`17`	`17`	`{`
`18`		`- "name": "pet-store-resource",`
`19`		`- "description": "Operations about store"`
	`18`	`+ "name": "generic-pet-controller",`
	`19`	`+ "description": "Generic Pet Controller"`
`20`	`20`	`},`
`21`	`21`	`{`
`22`	`22`	`"name": "pet-controller",`
`23`	`23`	`"description": "Operations about pets"`
`24`	`24`	`},`
`25`	`25`	`{`
`26`		`- "name": "generic-pet-controller",`
`27`		`- "description": "Generic Pet Controller"`
	`26`	`+ "name": "pet-store-resource",`
	`27`	`+ "description": "Operations about store"`
`28`	`28`	`},`
`29`	`29`	`{`
`30`	`30`	`"name": "user-controller",`
`31`	`31`	`"description": "Operations about user"`
`32`	`32`	`}`
`33`	`33`	`],`
`34`	`34`	`"schemes": [`
`35`		`- "http",`
`36`		`- "https"`
	`35`	`+ "https",`
	`36`	`+ "http"`
`37`	`37`	`],`
`38`	`38`	`"produces": [`
`39`	`39`	`"application/xml",`
`@@ -990,4 +990,4 @@`
`990`	`990`	`}`
`991`	`991`	`}`
`992`	`992`	`}`
`993`		`-}`
	`993`	`+}`