Merge pull request #827 from swagger-api/fix-issue-811-master

Fix issue #811 OAS2 - RefResponse -> RefSchema external Resolving

Author: gracekarina

modules/swagger-parser/src/main/java/io/swagger/parser/processors/ExternalRefProcessor.java

@@ -7,6 +7,7 @@
 import io.swagger.models.properties.RefProperty;
 import io.swagger.models.refs.RefFormat;
 import io.swagger.parser.ResolverCache;
+import io.swagger.parser.util.RefUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.slf4j.LoggerFactory;
 
@@ -153,6 +154,30 @@ public String processRefToExternalDefinition(String $ref, RefFormat refFormat) {
         return newRef;
     }
 
+
+    public void processRefToExternalResponse(String $ref, RefFormat refFormat) {
+
+        final Response response = cache.loadRef($ref, refFormat, Response.class);
+
+        if(response != null) {
+
+            String file = $ref.split("#/")[0];
+
+            Model model = null;
+            if (response.getResponseSchema() != null) {
+                model = response.getResponseSchema();
+                if (model instanceof RefModel) {
+                    RefModel refModel = (RefModel) model;
+                    if (RefUtils.isAnExternalRefFormat(refFormat)) {
+                        processRefModel(refModel, $ref);
+                    } else {
+                        processRefToExternalDefinition(file + refModel.get$ref(), RefFormat.RELATIVE);
+                    }
+                }
+            }
+        }
+    }
+
     private void processProperties(final Map<String, Property> subProps, final String file) {
         if (subProps == null || 0 == subProps.entrySet().size() ) {
             return;
@@ -187,6 +212,16 @@ private void processRefProperty(RefProperty subRef, String externalFile) {
             processRefToExternalDefinition(externalFile + subRef.get$ref(), RefFormat.RELATIVE);
         }
     }
+
+    private void processRefModel(RefModel subRef, String externalFile) {
+
+        if (isAnExternalRefFormat(subRef.getRefFormat())) {
+            String joinedRef = join(externalFile, subRef.get$ref());
+            subRef.set$ref(processRefToExternalDefinition(joinedRef, subRef.getRefFormat()));
+        } else {
+            processRefToExternalDefinition(externalFile + subRef.get$ref(), RefFormat.RELATIVE);
+        }
+    }
 
 
     public static String join(String source, String fragment) {

modules/swagger-parser/src/main/java/io/swagger/parser/processors/OperationProcessor.java

@@ -35,6 +35,8 @@ public void processOperation(Operation operation) {
                 if(response != null) {
                     if (response instanceof RefResponse) {
                         RefResponse refResponse = (RefResponse) response;
+                        responseProcessor.processResponse(response);
+
                         Response resolvedResponse = cache.loadRef(refResponse.get$ref(), refResponse.getRefFormat(), Response.class);
 
                         if (resolvedResponse != null) {

modules/swagger-parser/src/main/java/io/swagger/parser/processors/ResponseProcessor.java

@@ -1,24 +1,35 @@
 package io.swagger.parser.processors;
 
 import io.swagger.models.Model;
+import io.swagger.models.RefResponse;
 import io.swagger.models.Response;
 import io.swagger.models.Swagger;
 import io.swagger.models.properties.Property;
+import io.swagger.models.refs.RefFormat;
 import io.swagger.parser.ResolverCache;
+import io.swagger.parser.util.RefUtils;
 
 public class ResponseProcessor {
 
     private final ModelProcessor modelProcessor;
+    private final ExternalRefProcessor externalRefProcessor;
 
     public ResponseProcessor(ResolverCache cache, Swagger swagger) {
         modelProcessor = new ModelProcessor(cache, swagger);
+        externalRefProcessor = new ExternalRefProcessor(cache, swagger);
 
     }
 
     public void processResponse(Response response) {
         //process the response body
         final Model schema = response.getResponseSchema();
 
+        if (response instanceof RefResponse) {
+            RefResponse refResponse = (RefResponse) response;
+            processReferenceResponse(refResponse);
+        }
+
+
         if (schema != null) {
             modelProcessor.processModel(schema);
         }
@@ -29,4 +40,12 @@ public void processResponse(Response response) {
           */
 
     }
+
+    public void processReferenceResponse(RefResponse refResponse){
+        RefFormat refFormat = refResponse.getRefFormat();
+        String $ref = refResponse.get$ref();
+        if (RefUtils.isAnExternalRefFormat(refFormat)){
+            externalRefProcessor.processRefToExternalResponse($ref, refFormat);
+        }
+    }
 }

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

@@ -5,9 +5,14 @@
 import org.apache.commons.io.IOUtils;
 import org.apache.commons.lang3.StringUtils;
 
+import java.io.File;
 import java.io.FileInputStream;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.nio.file.FileSystem;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.List;
 import java.util.Set;
 
@@ -114,6 +119,8 @@ else if ("..".equals(relPathParts[i])) {
         return StringUtils.join(outputParts, "/");
     }
 
+
+
     public static String readExternalRef(String file, RefFormat refFormat, List<AuthorizationValue> auths,
                                          Path parentDirectory) {
 

modules/swagger-parser/src/test/java/io/swagger/parser/SwaggerParserTest.java

@@ -54,6 +54,17 @@
 
 public class SwaggerParserTest {
 
+    @Test
+    public void testIssue811() throws Exception {
+        SwaggerParser parser = new SwaggerParser();
+        final Swagger swagger = parser.read("src/test/resources/oapi-reference-test/index.yaml");
+        Assert.assertNotNull(swagger);
+        assertTrue(swagger.getPaths().get("/").getGet().getResponses().get("200").getResponseSchema() instanceof RefModel);
+        RefModel model = (RefModel) swagger.getPaths().get("/").getGet().getResponses().get("200").getResponseSchema();
+        Assert.assertEquals(model.get$ref(),"#/definitions/schema-with-reference");
+
+    }
+
     @Test
     public void testIssue727() throws Exception {
         SwaggerParser parser = new SwaggerParser();

modules/swagger-parser/src/test/java/io/swagger/parser/processors/OperationProcessorTest.java

@@ -42,7 +42,7 @@ public void testProcessOperation(@Injectable final List<Parameter> inputParamete
         operation.setParameters(inputParameterList);
 
         final String ref = "http://my.company.com/path/to/file.json#/foo/bar";
-        RefResponse refResponse = new RefResponse(ref);
+        final RefResponse refResponse = new RefResponse(ref);
 
         operation.response(200, refResponse);
         operation.response(400, incomingResponse);
@@ -59,6 +59,9 @@ public void testProcessOperation(@Injectable final List<Parameter> inputParamete
             times = 1;
             result = outputParameterList;
 
+            responseProcessor.processResponse(refResponse);
+            times = 1;
+
             cache.loadRef(ref, RefFormat.URL, Response.class);
             times = 1;
             result = resolvedResponse;

modules/swagger-parser/src/test/resources/oapi-reference-test/components/referent.yaml

@@ -0,0 +1,2 @@
+---
+type: object

modules/swagger-parser/src/test/resources/oapi-reference-test/components/response-with-reference.yaml

@@ -0,0 +1,4 @@
+---
+description: Response with schema containing reference
+schema:
+  $ref: "./schema-with-reference.yaml"

modules/swagger-parser/src/test/resources/oapi-reference-test/components/schema-with-reference.yaml

@@ -0,0 +1,7 @@
+---
+type: object
+properties:
+  reference_array:
+    type: array
+    items:
+      $ref: "./referent.yaml"

modules/swagger-parser/src/test/resources/oapi-reference-test/index.yaml

@@ -0,0 +1,16 @@
+---
+swagger: "2.0"
+
+info:
+  version: 1.0.0
+  title: Path include test case child
+
+paths:
+  /:
+    get:
+      description: Test
+      summary: Test
+      operationId: getTest
+      responses:
+        200:
+          $ref: "./components/response-with-reference.yaml"