fixes #13

GavinChenYan · GavinChenYan · commit 6a3b54a350b0 · 2021-01-07T16:56:12.000-05:00
diff --git a/pom.xml b/pom.xml
@@ -19,7 +19,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.mservicetech</groupId>
     <artifactId>openapi-schema-validation</artifactId>
-    <version>2.0.1</version>
+    <version>2.0.2</version>
     <packaging>jar</packaging>
     <description>openapi schema  for openpai 3.*</description>
     <url>https://github.com/mservicetech/openapi-schema-validation</url>
diff --git a/src/main/java/com/mservicetech/openapi/validation/OpenApiValidator.java b/src/main/java/com/mservicetech/openapi/validation/OpenApiValidator.java
@@ -189,7 +189,8 @@ private Status validatePathParameters(final RequestEntity requestEntity, final N
             return result.getStatus();
         }
         if  (result.skippedParameters!=null && !result.skippedParameters.isEmpty()) {
-            return new Status(VALIDATOR_REQUEST_PARAMETER_MISSING,  openApiOperation.getMethod(), openApiOperation.getPathString().original());
+            return result.skippedParameters.stream().map(p-> new Status (VALIDATOR_REQUEST_PARAMETER_MISSING, p.getName(), openApiOperation.getPathString().original()))
+                    .filter(s->s != null).findFirst().get();
         }
         return null;
     }
@@ -238,13 +239,12 @@ private Status validateQueryParameters(final RequestEntity requestEntity, final
             return result.getStatus();
         }
         if  (result.skippedParameters!=null && !result.skippedParameters.isEmpty()) {
-            return new Status(VALIDATOR_REQUEST_PARAMETER_MISSING,  openApiOperation.getMethod(), openApiOperation.getPathString().original());
+            return result.skippedParameters.stream().map(p-> new Status (VALIDATOR_REQUEST_PARAMETER_MISSING, p.getName(), openApiOperation.getPathString().original()))
+                    .filter(s->s != null).findFirst().get();
         }
         return null;
     }
 
-
-
     private Status validateHeaderParameters(final RequestEntity requestEntity,
                                             final OpenApiOperation openApiOperation) {
 
@@ -267,7 +267,8 @@ private Optional<Status> validatePathLevelHeaders(final RequestEntity requestEnt
             return Optional.ofNullable(result.getStatus());
         }
         if  (result.skippedParameters!=null && !result.skippedParameters.isEmpty()) {
-            return Optional.ofNullable(new Status(VALIDATOR_REQUEST_PARAMETER_MISSING,  openApiOperation.getMethod(), openApiOperation.getPathString().original()));
+            return result.skippedParameters.stream().map(p-> new Status (VALIDATOR_REQUEST_PARAMETER_MISSING, p.getName(), openApiOperation.getPathString().original()))
+                    .filter(s->s != null).findFirst();
         }
         return Optional.ofNullable(null);
     }
@@ -281,7 +282,8 @@ private Optional<Status> validateOperationLevelHeaders(final RequestEntity reque
             return Optional.ofNullable(result.getStatus());
         }
         if  (result.skippedParameters!=null && !result.skippedParameters.isEmpty()) {
-            return Optional.ofNullable(new Status(VALIDATOR_REQUEST_PARAMETER_MISSING,  openApiOperation.getMethod(), openApiOperation.getPathString().original()));
+            return result.skippedParameters.stream().map(p-> new Status (VALIDATOR_REQUEST_PARAMETER_MISSING, p.getName(), openApiOperation.getPathString().original()))
+                    .filter(s->s != null).findFirst();
         }
         return Optional.ofNullable(null);
     }
@@ -307,7 +309,8 @@ private Optional<Status> validatePathLevelCookies(final RequestEntity requestEnt
             return Optional.ofNullable(result.getStatus());
         }
         if  (result.skippedParameters!=null && !result.skippedParameters.isEmpty()) {
-            return Optional.ofNullable(new Status(VALIDATOR_REQUEST_PARAMETER_MISSING,  openApiOperation.getMethod(), openApiOperation.getPathString().original()));
+            return result.skippedParameters.stream().map(p-> new Status (VALIDATOR_REQUEST_PARAMETER_MISSING, p.getName(), openApiOperation.getPathString().original()))
+                    .filter(s->s != null).findFirst();
         }
         return Optional.ofNullable(null);
     }
@@ -321,7 +324,8 @@ private Optional<Status> validateOperationLevelCookies(final RequestEntity reque
             return Optional.ofNullable(result.getStatus());
         }
         if  (result.skippedParameters!=null && !result.skippedParameters.isEmpty()) {
-            return Optional.ofNullable(new Status(VALIDATOR_REQUEST_PARAMETER_MISSING,  openApiOperation.getMethod(), openApiOperation.getPathString().original()));
+            return result.skippedParameters.stream().map(p-> new Status (VALIDATOR_REQUEST_PARAMETER_MISSING, p.getName(), openApiOperation.getPathString().original()))
+                    .filter(s->s != null).findFirst();
         }
         return Optional.ofNullable(null);
     }
@@ -374,7 +378,7 @@ public Status getStatus() {
             return statuses.isEmpty()?null:statuses.get(0);
         }
 
-        public List<Status> getAllStatueses(){
+        public List<Status> getAllStatues(){
             return Collections.unmodifiableList(statuses);
         }
     }
diff --git a/src/test/java/com/mservicetech/openapi/validation/OpenApiValidatorTest.java b/src/test/java/com/mservicetech/openapi/validation/OpenApiValidatorTest.java
@@ -115,7 +115,7 @@ public void testRequestPath3() {
         Status status = openApiValidator.validateRequestPath("/pets/{petId}", "get", requestEntity);
         Assert.assertNotNull(status);
         Assert.assertEquals( status.getCode(), "ERR11001");
-        //{"statusCode":400,"code":"ERR11001","message":"VALIDATOR_REQUEST_PARAMETER_MISSING","description":"Parameter get is required but is missing.","severity":"ERROR"}
+        //{"statusCode":400,"code":"ERR11001","message":"VALIDATOR_REQUEST_PARAMETER_MISSING","description":"Parameter petId is required but is missing.","severity":"ERROR"}
     }
 
     @Test
@@ -132,13 +132,28 @@ public void testRequestPath4() {
     }
 
     @Test
-    public void testRequestQueryMissNotRequired() {
+    public void testRequestQueryMissRequired() {
 
         RequestEntity requestEntity = new RequestEntity();
         Map<String, Object> queryMap = new HashMap<>();
         requestEntity.setQueryParameters(queryMap);
         Status status = openApiValidator.validateRequestPath("/pets", "get", requestEntity);
-        Assert.assertNull(status);
+        Assert.assertEquals( status.getCode(), "ERR11001");
+        //{"statusCode":400,"code":"ERR11001","message":"VALIDATOR_REQUEST_PARAMETER_MISSING","description":"Parameter limit is required but is missing.","severity":"ERROR"}
+        Assert.assertNotNull(status);
+    }
+
+    @Test
+    public void testRequestQueryRequiredWithEmpty() {
+
+        RequestEntity requestEntity = new RequestEntity();
+        Map<String, Object> queryMap = new HashMap<>();
+        requestEntity.setQueryParameters(queryMap);
+        queryMap.put("limit", null);
+        Status status = openApiValidator.validateRequestPath("/pets", "get", requestEntity);
+        Assert.assertEquals( status.getCode(), "ERR11001");
+        //{"statusCode":400,"code":"ERR11001","message":"VALIDATOR_REQUEST_PARAMETER_MISSING","description":"Parameter limit is required but is missing.","severity":"ERROR"}
+        Assert.assertNotNull(status);
     }
 
     @Test
@@ -171,6 +186,7 @@ public void testRequestQueryBooleanType() {
         RequestEntity requestEntity = new RequestEntity();
         Map<String, Object> queryMap = new HashMap<>();
         queryMap.put("includeCode", "true");
+        queryMap.put("limit", 12);
         requestEntity.setQueryParameters(queryMap);
         Status status = openApiValidator.validateRequestPath("/pets", "get", requestEntity);
         Assert.assertNull(status);
@@ -182,6 +198,7 @@ public void testRequestQueryBooleanTypeWithError() {
         RequestEntity requestEntity = new RequestEntity();
         Map<String, Object> queryMap = new HashMap<>();
         queryMap.put("includeCode", "yes");
+        queryMap.put("limit", 12);
         requestEntity.setQueryParameters(queryMap);
         Status status = openApiValidator.validateRequestPath("/pets", "get", requestEntity);
         Assert.assertNotNull(status);
diff --git a/src/test/resources/openapi.yaml b/src/test/resources/openapi.yaml
@@ -17,7 +17,7 @@ paths:
         - name: limit
           in: query
           description: How many items to return at one time (max 100)
-          required: false
+          required: true
           schema:
             type: integer
             format: int32

Original file line number	Diff line number	Diff line change
`@@ -189,7 +189,8 @@ private Status validatePathParameters(final RequestEntity requestEntity, final N`
`189`	`189`	`return result.getStatus();`
`190`	`190`	`}`
`191`	`191`	`if (result.skippedParameters!=null && !result.skippedParameters.isEmpty()) {`
`192`		`- return new Status(VALIDATOR_REQUEST_PARAMETER_MISSING, openApiOperation.getMethod(), openApiOperation.getPathString().original());`
	`192`	`+ return result.skippedParameters.stream().map(p-> new Status (VALIDATOR_REQUEST_PARAMETER_MISSING, p.getName(), openApiOperation.getPathString().original()))`
	`193`	`+ .filter(s->s != null).findFirst().get();`
`193`	`194`	`}`
`194`	`195`	`return null;`
`195`	`196`	`}`
`@@ -238,13 +239,12 @@ private Status validateQueryParameters(final RequestEntity requestEntity, final`
`238`	`239`	`return result.getStatus();`
`239`	`240`	`}`
`240`	`241`	`if (result.skippedParameters!=null && !result.skippedParameters.isEmpty()) {`
`241`		`- return new Status(VALIDATOR_REQUEST_PARAMETER_MISSING, openApiOperation.getMethod(), openApiOperation.getPathString().original());`
	`242`	`+ return result.skippedParameters.stream().map(p-> new Status (VALIDATOR_REQUEST_PARAMETER_MISSING, p.getName(), openApiOperation.getPathString().original()))`
	`243`	`+ .filter(s->s != null).findFirst().get();`
`242`	`244`	`}`
`243`	`245`	`return null;`
`244`	`246`	`}`
`245`	`247`
`246`		`-`
`247`		`-`
`248`	`248`	`private Status validateHeaderParameters(final RequestEntity requestEntity,`
`249`	`249`	`final OpenApiOperation openApiOperation) {`
`250`	`250`
`@@ -267,7 +267,8 @@ private Optional<Status> validatePathLevelHeaders(final RequestEntity requestEnt`
`267`	`267`	`return Optional.ofNullable(result.getStatus());`
`268`	`268`	`}`
`269`	`269`	`if (result.skippedParameters!=null && !result.skippedParameters.isEmpty()) {`
`270`		`- return Optional.ofNullable(new Status(VALIDATOR_REQUEST_PARAMETER_MISSING, openApiOperation.getMethod(), openApiOperation.getPathString().original()));`
	`270`	`+ return result.skippedParameters.stream().map(p-> new Status (VALIDATOR_REQUEST_PARAMETER_MISSING, p.getName(), openApiOperation.getPathString().original()))`
	`271`	`+ .filter(s->s != null).findFirst();`
`271`	`272`	`}`
`272`	`273`	`return Optional.ofNullable(null);`
`273`	`274`	`}`
`@@ -281,7 +282,8 @@ private Optional<Status> validateOperationLevelHeaders(final RequestEntity reque`
`281`	`282`	`return Optional.ofNullable(result.getStatus());`
`282`	`283`	`}`
`283`	`284`	`if (result.skippedParameters!=null && !result.skippedParameters.isEmpty()) {`
`284`		`- return Optional.ofNullable(new Status(VALIDATOR_REQUEST_PARAMETER_MISSING, openApiOperation.getMethod(), openApiOperation.getPathString().original()));`
	`285`	`+ return result.skippedParameters.stream().map(p-> new Status (VALIDATOR_REQUEST_PARAMETER_MISSING, p.getName(), openApiOperation.getPathString().original()))`
	`286`	`+ .filter(s->s != null).findFirst();`
`285`	`287`	`}`
`286`	`288`	`return Optional.ofNullable(null);`
`287`	`289`	`}`
`@@ -307,7 +309,8 @@ private Optional<Status> validatePathLevelCookies(final RequestEntity requestEnt`
`307`	`309`	`return Optional.ofNullable(result.getStatus());`
`308`	`310`	`}`
`309`	`311`	`if (result.skippedParameters!=null && !result.skippedParameters.isEmpty()) {`
`310`		`- return Optional.ofNullable(new Status(VALIDATOR_REQUEST_PARAMETER_MISSING, openApiOperation.getMethod(), openApiOperation.getPathString().original()));`
	`312`	`+ return result.skippedParameters.stream().map(p-> new Status (VALIDATOR_REQUEST_PARAMETER_MISSING, p.getName(), openApiOperation.getPathString().original()))`
	`313`	`+ .filter(s->s != null).findFirst();`
`311`	`314`	`}`
`312`	`315`	`return Optional.ofNullable(null);`
`313`	`316`	`}`
`@@ -321,7 +324,8 @@ private Optional<Status> validateOperationLevelCookies(final RequestEntity reque`
`321`	`324`	`return Optional.ofNullable(result.getStatus());`
`322`	`325`	`}`
`323`	`326`	`if (result.skippedParameters!=null && !result.skippedParameters.isEmpty()) {`
`324`		`- return Optional.ofNullable(new Status(VALIDATOR_REQUEST_PARAMETER_MISSING, openApiOperation.getMethod(), openApiOperation.getPathString().original()));`
	`327`	`+ return result.skippedParameters.stream().map(p-> new Status (VALIDATOR_REQUEST_PARAMETER_MISSING, p.getName(), openApiOperation.getPathString().original()))`
	`328`	`+ .filter(s->s != null).findFirst();`
`325`	`329`	`}`
`326`	`330`	`return Optional.ofNullable(null);`
`327`	`331`	`}`
`@@ -374,7 +378,7 @@ public Status getStatus() {`
`374`	`378`	`return statuses.isEmpty()?null:statuses.get(0);`
`375`	`379`	`}`
`376`	`380`
`377`		`- public List<Status> getAllStatueses(){`
	`381`	`+ public List<Status> getAllStatues(){`
`378`	`382`	`return Collections.unmodifiableList(statuses);`
`379`	`383`	`}`
`380`	`384`	`}`