Merge pull request swagger-api#1134 from scottr-ad/master

issue-1133 - Parser does not resolve $ref pointing to relative locations on classpath

Author: gracekarina

modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/ResolverCache.java

@@ -118,9 +118,13 @@ public <T> T loadRef(String ref, RefFormat refFormat, Class<T> expectedType) {
             if(parentDirectory != null) {
                 contents = RefUtils.readExternalRef(file, refFormat, auths, parentDirectory);
             }
-            else if(rootPath != null) {
+            else if(rootPath != null && rootPath.startsWith("http")) {
                 contents = RefUtils.readExternalUrlRef(file, refFormat, auths, rootPath);
             }
+            else if (rootPath != null) {
+                contents = RefUtils.readExternalClasspathRef(file, refFormat, auths, rootPath);
+
+            }
             externalFileCache.put(file, contents);
         }
 

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

@@ -20,17 +20,32 @@ public static Path getParentDirectoryOfFile(String location) {
                 file = Paths.get(location).toAbsolutePath();
             }
             if (!Files.exists(file)) {
-                URL url = PathUtils.class.getClassLoader().getResource(location);
-                file = Paths.get((URI.create(url.toExternalForm())));
-                return file.getParent();
+                return getParentDirectoryFromUrl(location);
             }
 
-
-
         } catch (Exception e) {
             e.getMessage();
         }
 
         return file.toAbsolutePath().getParent();
     }
+
+    private static Path getParentDirectoryFromUrl(String location){
+        try {
+            URL url = PathUtils.class.getResource(location);
+            if (url == null){
+                url = PathUtils.class.getClassLoader().getResource(location);
+            }
+            if(url == null) {
+                url = ClassLoader.getSystemResource(location);
+            }
+
+            Path file = Paths.get((URI.create(url.toExternalForm())));
+            return file.getParent();
+
+        } catch (Exception e) {
+            e.getMessage();
+            return null;
+        }
+    }
 }

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

@@ -2,6 +2,7 @@
 
 import io.swagger.v3.parser.core.models.AuthorizationValue;
 import io.swagger.v3.parser.models.RefFormat;
+import io.swagger.v3.parser.processors.ExternalRefProcessor;
 import org.apache.commons.io.IOUtils;
 import org.apache.commons.lang3.StringUtils;
 
@@ -118,6 +119,32 @@ public static String readExternalUrlRef(String file, RefFormat refFormat, List<A
 
     }
 
+    public static String readExternalClasspathRef(String file, RefFormat refFormat, List<AuthorizationValue> auths,
+                                                  String rootPath) {
+
+        if (!RefUtils.isAnExternalRefFormat(refFormat)) {
+            throw new RuntimeException("Ref is not external");
+        }
+
+        String result;
+
+        try {
+            if (refFormat == RefFormat.URL) {
+                result = RemoteUrl.urlToString(file, auths);
+            } else {
+                //its assumed to be a relative ref
+                String pathRef = ExternalRefProcessor.join(rootPath, file);
+
+                result = ClasspathHelper.loadFileFromClasspath(pathRef);
+            }
+        } catch (Exception e) {
+            throw new RuntimeException("Unable to load " + refFormat + " ref: " + file, e);
+        }
+
+        return result;
+
+    }
+
     public static String buildUrl(String rootPath, String relativePath) {
         String[] rootPathParts = rootPath.split("/");
         String [] relPathParts = relativePath.split("/");

modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/util/PathUtilTest.java

@@ -2,19 +2,29 @@
 
 import org.testng.annotations.Test;
 
+import java.nio.file.Path;
 import java.nio.file.Paths;
 
 import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.assertNull;
 
 public class PathUtilTest {
 
     @Test
     public void testGetParentDirectoryOfFile() throws Exception {
 
-        final String actualResult = PathUtils.getParentDirectoryOfFile("src/test/resources/parent.json").toString();
+        final String actualResult = PathUtils.getParentDirectoryOfFile("src/test/resources/test.yaml").toString();
 
         final String expectedResult = Paths.get("src/test/resources").toAbsolutePath().toString();
 
         assertEquals(actualResult, expectedResult);
     }
+
+    @Test
+    public void testGetParentDirectoryOfNonExistentFile() throws Exception {
+
+        final Path result = PathUtils.getParentDirectoryOfFile("src/test/resources/parent.json");
+
+        assertNull(result);
+    }
 }