added option to configure the valdiation of internal references

Author: gracekarina

modules/swagger-parser-core/src/main/java/io/swagger/v3/parser/core/models/ParseOptions.java

@@ -10,6 +10,7 @@ public class ParseOptions {
     private boolean skipMatches;
     private boolean allowEmptyStrings = true;
     private boolean validateExternalRefs = false;
+    private boolean validateInternalRefs = false;
     private boolean legacyYamlDeserialization = false;
 
     public boolean isResolve() {
@@ -89,4 +90,12 @@ public boolean isLegacyYamlDeserialization() {
     public void setLegacyYamlDeserialization(boolean legacyYamlDeserialization) {
         this.legacyYamlDeserialization = legacyYamlDeserialization;
     }
+
+    public void setValidateInternalRefs(boolean validateInternalRefs) {
+        this.validateInternalRefs = validateInternalRefs;
+    }
+
+    public boolean isValidateInternalRefs() {
+        return validateInternalRefs;
+    }
 }

modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/OpenAPIDeserializer.java

@@ -153,6 +153,7 @@ public SwaggerParseResult deserialize(JsonNode rootNode, String path, ParseOptio
 		SwaggerParseResult result = new SwaggerParseResult();
 		ParseResult rootParse = new ParseResult();
 		rootParse.setAllowEmptyStrings(options.isAllowEmptyString());
+        rootParse.setValidateInternalRefs(options.isValidateInternalRefs());
 		OpenAPI api = parseRoot(rootNode, rootParse, path);
 		result.setOpenAPI(api);
 		result.setMessages(rootParse.getMessages());
@@ -185,9 +186,11 @@ public OpenAPI parseRoot(JsonNode node, ParseResult result, String path) {
 				Components components = getComponents(obj, "components", result);
 				openAPI.setComponents(components);
 				this.components = components;
-                for (String schema : localSchemaRefs.keySet()){
-                    if(components.getSchemas().get(schema) == null){
-                        result.invalidType(localSchemaRefs.get(schema), schema, "schema", rootNode);
+                if(result.validateInternalRefs) {
+                    for (String schema : localSchemaRefs.keySet()) {
+                        if (components.getSchemas().get(schema) == null) {
+                            result.invalidType(localSchemaRefs.get(schema), schema, "schema", rootNode);
+                        }
                     }
                 }
 			}
@@ -3195,6 +3198,7 @@ public static class ParseResult {
 		private List<Location> unique = new ArrayList<>();
 		private List<Location> uniqueTags = new ArrayList<>();
 		private boolean allowEmptyStrings = true;
+        private boolean validateInternalRefs;
 
 		public ParseResult() {
 		}
@@ -3289,7 +3293,15 @@ public List<String> getMessages() {
 			}
 			return messages;
 		}
-	}
+
+        public void setValidateInternalRefs(boolean validateInternalRefs) {
+            this.validateInternalRefs = validateInternalRefs;
+        }
+
+        public boolean isValidateInternalRefs() {
+            return validateInternalRefs;
+        }
+    }
 
 
 	protected static class Location {

modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/test/OpenAPIV3ParserTest.java

@@ -86,8 +86,9 @@ public class OpenAPIV3ParserTest {
     protected WireMockServer wireMockServer;
 
     @Test
-    public void testIssue1643() throws Exception{
+    public void testIssue1643_True() throws Exception{
         ParseOptions options = new ParseOptions();
+        options.setValidateInternalRefs(true);
         String issue1643 = "openapi: \"3.0.0\"\n" +
                 "info:\n" +
                 "  version: 1.0.0\n" +
@@ -128,6 +129,49 @@ public void testIssue1643() throws Exception{
         assertTrue(result.getMessages().contains("attribute components.schemas.Person.Employee is not of type `schema`"));
     }
 
+    @Test
+    public void testIssue1643_False() throws Exception{
+        ParseOptions options = new ParseOptions();
+        String issue1643 = "openapi: \"3.0.0\"\n" +
+                "info:\n" +
+                "  version: 1.0.0\n" +
+                "  title: People\n" +
+                "paths:\n" +
+                "  /person:\n" +
+                "    get:\n" +
+                "      operationId: getPerson\n" +
+                "      parameters:\n" +
+                "        - name: name\n" +
+                "          in: query\n" +
+                "          required: true\n" +
+                "          schema:\n" +
+                "            type: string\n" +
+                "      responses:\n" +
+                "        '200':\n" +
+                "          description: The person with the given name.          \n" +
+                "          content:\n" +
+                "            application/json:\n" +
+                "              schema:\n" +
+                "                $ref: '#/components/schemas/Person'\n" +
+                "components:\n" +
+                "  schemas:\n" +
+                "    Person:\n" +
+                "      required:\n" +
+                "      - name\n" +
+                "      type: object\n" +
+                "      properties:\n" +
+                "        name:\n" +
+                "          type: string\n" +
+                "        employee:\n" +
+                "          $ref: '#/components/schemas/Employee'";
+        SwaggerParseResult result = new OpenAPIV3Parser().readContents(issue1643, null, options);
+
+        Assert.assertNotNull(result);
+        Assert.assertNotNull(result.getOpenAPI());
+        assertEquals(result.getMessages().size(),0);
+        assertFalse(result.getMessages().contains("attribute components.schemas.Person.Employee is not of type `schema`"));
+    }
+
     @Test
     public void testExampleFormatByte() throws Exception{
 
@@ -328,7 +372,7 @@ public void testCantReadDeepProperties() {
         options.setResolveFully(true);
 
         final SwaggerParseResult parseResult = parser.readLocation("src/test/resources/cant-read-deep-properties.yaml", null, options);
-        assertEquals(parseResult.getMessages().size(), 1);
+        assertEquals(parseResult.getMessages().size(), 0);
         Schema projects = (Schema) parseResult.getOpenAPI().getComponents().getSchemas().get("Project").getProperties().get("project_type");
         assertEquals(projects.getType(), "integer");
     }
@@ -2511,7 +2555,7 @@ public void testIssue931() {
         SwaggerParseResult result = new OpenAPIV3Parser().readLocation("Issue_931.json", null, options);
         assertNotNull(result.getOpenAPI());
         assertTrue(result.getMessages().size() > 0);
-        assertEquals(result.getMessages().get(1).contains("doesn't adhere to regular expression ^[a-zA-Z0-9\\.\\-_]+$"), true);
+        assertEquals(result.getMessages().get(0).contains("doesn't adhere to regular expression ^[a-zA-Z0-9\\.\\-_]+$"), true);
 
     }