Fix relative links going higher than spec itself

Author: jjjasper

boat-engine/src/main/java/com/backbase/oss/boat/transformers/bundler/ExamplesProcessor.java

@@ -119,6 +119,7 @@ public void processMediaType(MediaType mediaType, String relativePath, boolean d
     }
 
     private void putComponentExample(String key, Example example) {
+        log.debug("Put Component Example: [{}], [{}]", key, example);
         getComponentExamplesFromOpenAPI().put(key, example);
     }
 
@@ -155,7 +156,6 @@ private void fixInlineExamples(ExampleHolder exampleHolder, String relativePath,
             return;
         }
 
-        URI resolvedUri;
         Optional<String> fragment;
         if (refPath.contains("#") && !refPath.startsWith("#/components/examples")) {
             fragment = Optional.of(StringUtils.substringAfter(refPath, "#"));
@@ -164,11 +164,12 @@ private void fixInlineExamples(ExampleHolder exampleHolder, String relativePath,
             fragment = Optional.empty();
         }
 
-        resolvedUri = resolveUri(relativePath, refPath);
+        URI resolvedUri = resolveUri(relativePath, refPath);
         try {
             String content = readContent(Paths.get(resolvedUri));
 
             if (fragment.isPresent()) {
+                log.debug("Read content from [{}], finding fragment [{}]", resolvedUri, fragment.get());
                 String exampleName = StringUtils.substringAfterLast(fragment.get(), "/");
                 // resolve fragment from json node
                 JsonNode jsonNode = yamlObjectMapper.readTree(content);
@@ -178,19 +179,22 @@ private void fixInlineExamples(ExampleHolder exampleHolder, String relativePath,
                 processInLineExample(exampleHolder,relativePath,exampleNode, exampleName);
 
             } else {
+                log.debug("Read content from [{}], set content and dereference", resolvedUri);
                 exampleHolder.setContent(content);
                 dereferenceExample(exampleHolder);
             }
             if (derefenceExamples) {
+                log.debug("Read content from [{}], not setting content and dereference because...", resolvedUri);
                 dereferenceExample(exampleHolder);
             }
 
         } catch (IOException e) {
-            throw new TransformerException("Unable to fix inline examples", e);
+            throw new TransformerException("Unable to fix inline examples from " + resolvedUri, e);
         }
     }
 
     private void processInLineExample(ExampleHolder exampleHolder, String relativePath, JsonNode exampleNode, String exampleName) throws IOException {
+        log.debug("Process inline example [{}], [{}], [{}], [{}]", exampleHolder, relativePath, exampleNode, exampleName);
         if (exampleNode.has("$ref")) {
             String refPath = exampleNode.get("$ref").asText();
             exampleHolder.replaceRef(refPath);
@@ -227,17 +231,23 @@ private String readContent(Path path) throws IOException {
     }
 
     private URI resolveUri(String relativePath, String refPath) {
-        URI resolvedUri;
         if (relativePath == null) {
-            resolvedUri = rootUri.resolve(StringUtils.strip(refPath, "./"));
+            return rootUri.resolve(removeTrainingDotSlash(refPath));
         } else {
-            resolvedUri = rootUri.resolve(checkTrailingSlash(relativePath.replace("\\", "/")))
+            return rootUri.resolve(checkTrailingSlash(relativePath.replace("\\", "/")))
                 .resolve(refPath.replace("\\", "/"));
         }
-        return resolvedUri;
+    }
+
+    private String removeTrainingDotSlash(String path) {
+        if (StringUtils.startsWith(path,"./")) {
+            return StringUtils.substring(path, 2);
+        }
+        return path;
     }
 
     private void dereferenceExample(ExampleHolder exampleHolder) {
+        log.debug("dereferenceExample: '{}'", exampleHolder);
         String rootName = exampleHolder.getExampleName();
         int count = 0;
         while (existsButNotMatching(cache.get(makeCountedName(rootName, count)), exampleHolder)) {

boat-engine/src/test/java/com/backbase/oss/boat/transformers/BundlerTests.java

@@ -16,6 +16,11 @@
 import io.swagger.v3.oas.models.responses.ApiResponse;
 import io.swagger.v3.oas.models.responses.ApiResponses;
 import io.swagger.v3.parser.models.RefFormat;
+import lombok.extern.slf4j.Slf4j;
+import org.hamcrest.BaseMatcher;
+import org.hamcrest.Description;
+import org.junit.jupiter.api.Test;
+
 import java.io.File;
 import java.io.IOException;
 import java.net.URISyntaxException;
@@ -26,12 +31,9 @@
 import java.util.Collections;
 import java.util.Map;
 import java.util.function.Function;
-import lombok.extern.slf4j.Slf4j;
-import org.hamcrest.BaseMatcher;
-import org.hamcrest.Description;
-import org.junit.jupiter.api.Test;
 
-import static org.hamcrest.CoreMatchers.*;
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.CoreMatchers.notNullValue;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.nullValue;
 import static org.junit.jupiter.api.Assertions.*;
@@ -87,7 +89,7 @@ void testBundleExamples() throws OpenAPILoaderException, IOException {
     @Test
     void testBundleHttp() throws OpenAPILoaderException, IOException {
 
-        String url = "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/refs/heads/main/tests/v3.0/pass/petstore.yaml";
+        String url = "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/refs/heads/main/_archive_/schemas/v3.0/pass//petstore.yaml";
         OpenAPI openAPI = OpenAPILoader.load(url);
         OpenAPI openAPIUnproccessed = openAPI;
 
@@ -105,8 +107,9 @@ void testBundleNonExistingFiles() throws OpenAPILoaderException, IOException {
         try {
             bundler.transform(openAPI, Collections.EMPTY_MAP);
             fail("Expected TransformerException");
-        }catch (TransformerException e){
-            assertEquals("Unable to fix inline examples",e.getMessage());
+        } catch (TransformerException e){
+            assertTrue(e.getMessage().startsWith("Unable to fix inline examples from file"));
+            assertTrue(e.getMessage().endsWith("notexist.json"));
         }
 
     }