Merge pull request #932 from ymohdriz/branch_issue_911_v1

Fix for issue 911 in swagger parser v1

Author: gracekarina

modules/swagger-parser/src/main/java/io/swagger/parser/util/SwaggerDeserializer.java

@@ -188,16 +188,63 @@ public Map<String,Path> paths(ObjectNode obj, String location, ParseResult resul
                 } else {
                     ObjectNode path = (ObjectNode) pathValue;
                     Path pathObj = path(path, location + ".'" + pathName + "'", result);
+                    String[] eachPart = pathName.split("/");
+                    for (String part : eachPart) {
+                        if (part.startsWith("{") && part.endsWith("}") && part.length() > 2) {
+                            String pathParam = part.substring(1, part.length() - 1);
+                            boolean definedInPathLevel = isPathParamDefined(pathParam, pathObj.getParameters());
+                            if (definedInPathLevel) {
+                                continue;
+                            }
+                            List<Operation> operationsInAPath = getAllOperationsInAPath(pathObj);
+                            for (Operation operation : operationsInAPath) {
+                                if (!isPathParamDefined(pathParam, operation.getParameters())) {
+                                    result.warning(location + ".'" + pathName + "'"," Declared path parameter " + pathParam + " needs to be defined as a path parameter in path or operation level");
+                                    break;
+                                }
+                            }
+                        }
+                    }
                     output.put(pathName, pathObj);
                 }
             }
         }
         return output;
     }
 
+    private boolean isPathParamDefined(String pathParam, List<Parameter> parameters) {
+        if (parameters == null || parameters.isEmpty()) {
+            return false;
+        } else {
+            for (Parameter parameter : parameters) {
+                if (pathParam.equals(parameter.getName()) && "path".equals(parameter.getIn())) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+
+    private void addToOperationsList(List<Operation> operationsList, Operation operation) {
+        if (operation == null) {
+            return;
+        }
+        operationsList.add(operation);
+    }
+
+    private List<Operation> getAllOperationsInAPath(Path pathObj) {
+        List<Operation> operations = new ArrayList<>();
+        addToOperationsList(operations, pathObj.getGet());
+        addToOperationsList(operations, pathObj.getPut());
+        addToOperationsList(operations, pathObj.getPost());
+        addToOperationsList(operations, pathObj.getPatch());
+        addToOperationsList(operations, pathObj.getDelete());
+        addToOperationsList(operations, pathObj.getOptions());
+        addToOperationsList(operations, pathObj.getHead());
+        return operations;
+    }
+
     public Path path(ObjectNode obj, String location, ParseResult result) {
-        boolean hasRef = false;
-        Path output = null;
         if(obj.get("$ref") != null) {
             JsonNode ref = obj.get("$ref");
             if(ref.getNodeType().equals(JsonNodeType.STRING)) {
@@ -1606,6 +1653,7 @@ protected static class ParseResult {
         private Map<Location, JsonNode> extra = new LinkedHashMap<Location, JsonNode>();
         private Map<Location, JsonNode> unsupported = new LinkedHashMap<Location, JsonNode>();
         private Map<Location, String> invalidType = new LinkedHashMap<Location, String>();
+        private List<Location> warnings = new ArrayList<>();
         private List<Location> missing = new ArrayList<Location>();
         private List<Location> unique = new ArrayList<>();
 
@@ -1628,6 +1676,10 @@ public void missing(String location, String key) {
             missing.add(new Location(location, key));
         }
 
+        public void warning(String location, String key) {
+            warnings.add(new Location(location, key));
+        }
+
         public void invalidType(String location, String key, String expectedType, JsonNode value){
             invalidType.put(new Location(location, key), expectedType);
         }
@@ -1693,6 +1745,11 @@ public List<String> getMessages() {
                 String message = "attribute " + location + l.key + " is missing";
                 messages.add(message);
             }
+            for (Location l : warnings) {
+                String location = l.location.equals("") ? "" : l.location + ".";
+                String message = "attribute " + location +l.key;
+                messages.add(message);
+            }
             for (Location l : unique) {
                 String location = l.location.equals("") ? "" : l.location + ".";
                 String message = "attribute " + location + l.key + " is repeated";

modules/swagger-parser/src/test/java/io/swagger/parser/util/SwaggerDeserializerTest.java

@@ -1557,6 +1557,14 @@ public void testUntypedAdditionalProperties() {
         assertEquals(additionalProperties.getType(), null);
     }
 
+    @Test
+    public void testIssue911() {
+        SwaggerDeserializationResult result = new SwaggerParser().readWithInfo("issue_911.yaml", null, true);
+        System.out.println(result.getMessages());
+        assertEquals(result.getMessages().size(),1);
+        assertNotNull(result.getSwagger());
+    }
+
     @Test
     public void testArrayParameterDefaultValue() {
         String swaggerSpec = "swagger: '2.0'\n" +
@@ -1647,5 +1655,4 @@ public void testArrayParameterDefaultValue() {
         assertNotNull(parameter4.getDefault());
         assertNotNull(parameter4.getDefaultValue());
     }
-
 }

modules/swagger-parser/src/test/resources/duplicateOperationId.json

@@ -6,6 +6,13 @@
   },
   "paths": {
     "/pets/{id}": {
+      "parameters" : [
+        {
+          "in": "path",
+          "name": "id",
+          "type": "string"
+        }
+      ],
       "get": {
         "operationId": "getPetsById",
         "responses": {

modules/swagger-parser/src/test/resources/issue_911.yaml

@@ -0,0 +1,44 @@
+swagger: 2.0
+info:
+  description: >-
+    This is a sample server Petstore server.  You can find out more about
+    Swagger at http://swagger.io or on
+    irc.freenode.net, #swagger.  For this sample, you can use the api key
+    "special-key" to test the authorization filters
+  version: 1.0.0
+  title: Swagger Petstore
+  termsOfService: 'http://swagger.io/terms/'
+  contact:
+    name: [email protected]
+  license:
+    name: Apache 2.0
+    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
+externalDocs:
+  description: Find more info here
+  url: 'https://swagger.io'
+tags:
+- name: pet
+  description: Pet Operations
+  externalDocs:
+    url: 'http://swagger.io'
+- name: user
+  description: All about the Users
+paths:
+  '/pet/{petId}/{pathParamNotDefined}':
+    get:
+      tags:
+      - pet
+      summary: Find pet by ID
+      description: >-
+        Returns a pet when ID < 10.  ID > 10 or nonintegers will simulate API
+        error conditions
+      operationId: getPetById
+      responses:
+        200:
+          description: 200 ok
+      parameters:
+      - name: petId
+        in: path
+        description: ID of pet that needs to be fetched
+        required: true
+        type: integer