Adjust test to updated parser behaviour, small simplification refactoring.

Author: jjjasper

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

@@ -9,6 +9,7 @@
 import io.swagger.v3.parser.processors.ComponentsProcessor;
 import io.swagger.v3.parser.processors.OperationProcessor;
 import io.swagger.v3.parser.processors.PathsProcessor;
+
 import java.util.Iterator;
 import java.util.List;
 
@@ -40,14 +41,13 @@ public BoatOpenAPIResolver(OpenAPI openApi, List<AuthorizationValue> auths, Stri
     public OpenAPI resolve() {
         if (this.openApi == null) {
             return null;
-        } else {
-            examplesProcessor.processExamples(this.openApi);
-            processOpenAPI();
-            return this.openApi;
         }
+        processOpenAPI();
+        return this.openApi;
     }
 
     private void processOpenAPI() {
+        this.examplesProcessor.processExamples();
         this.pathProcessor.processPaths();
         this.componentsProcessor.processComponents();
         if (this.openApi.getPaths() == null) {

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

@@ -15,6 +15,9 @@
 import io.swagger.v3.oas.models.media.MediaType;
 import io.swagger.v3.parser.models.RefFormat;
 import io.swagger.v3.parser.util.RefUtils;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.StringUtils;
+
 import java.io.IOException;
 import java.net.URI;
 import java.nio.file.Files;
@@ -24,8 +27,6 @@
 import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
-import lombok.extern.slf4j.Slf4j;
-import org.apache.commons.lang3.StringUtils;
 
 
 @Slf4j
@@ -53,7 +54,7 @@ public ExamplesProcessor(OpenAPI openAPI, String inputUri) {
         }
     }
 
-    public void processExamples(OpenAPI openAPI) {
+    public void processExamples() {
 
         log.debug("Processing examples in Components");
         // dereference the /component/examples first...

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

@@ -32,6 +32,7 @@
 import java.util.Map;
 import java.util.function.Function;
 
+import static org.apache.commons.lang3.StringUtils.substringAfterLast;
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.CoreMatchers.notNullValue;
 import static org.hamcrest.MatcherAssert.assertThat;
@@ -120,7 +121,7 @@ void testExamplesProcessor() throws OpenAPILoaderException, URISyntaxException {
         String spec = System.getProperty("spec", inputUri);
         OpenAPI openAPI = OpenAPILoader.load(spec);
         OpenAPI openAPIUnproccessed = openAPI;
-        new ExamplesProcessor(openAPI,spec).processExamples(openAPI);
+        new ExamplesProcessor(openAPI,spec).processExamples();
         assertEquals(openAPIUnproccessed, openAPI);
     }
 
@@ -131,7 +132,7 @@ void testExamplesProcessorComponentError() throws OpenAPILoaderException {
         OpenAPI openAPI = OpenAPILoader.load(spec);
         ExamplesProcessor examplesProcessor = new ExamplesProcessor(openAPI,spec);
         try {
-            examplesProcessor.processExamples(openAPI);
+            examplesProcessor.processExamples();
             fail("Expected TransformerException");
         }catch (TransformerException e){
             assertEquals("Failed to process example content for ExampleHolder{name='example-in-components', ref=null}",e.getMessage());
@@ -166,15 +167,13 @@ void testBundleApi() throws OpenAPILoaderException, IOException {
             openAPI.getComponents().getExamples().get("example-in-components-1").getSummary(),
             is("component-examples with example - should be left alone"));
 
-
         // actual input is not valid... when there is a ref no other properties should be set - still allow it.
         assertThat("Component example that duplicates a inline example, is left alone. But the summary is removed",
             openAPI.getComponents().getExamples().get("example-number-one").getSummary(), is("example-number-one"));
 
 
-        assertThat("Deep linked examples are dereferenced.",
-            singleExampleMap(openAPI, "/users", PathItem::getPost, "400", APPLICATION_JSON).get("$ref").toString(),
-            isComponentExample);
+        assertComponentExample(openAPI, "/users", PathItem::getPost, "400");
+
         assertThat("The deep linked example is in /components/examples",
             openAPI.getComponents().getExamples().get("lib-bad-request-validation-error"), notNullValue());
 
@@ -186,9 +185,7 @@ void testBundleApi() throws OpenAPILoaderException, IOException {
             openAPI.getPaths().get("/users").getPut().getResponses().get("401").getContent().get(APPLICATION_JSON)
                 .getExamples().get("named-bad-example").get$ref(), isComponentExample);
 
-        assertThat("Relative path works",
-            openAPI.getPaths().get("/users").getPut().getResponses().get("403").getContent().get(APPLICATION_JSON)
-                .getExample(), notNullValue());
+        assertComponentExample(openAPI, "/users", PathItem::getPut, "403");
 
         Example exampleNoThree = openAPI.getPaths().get("/multi-users").getPost().getRequestBody().getContent()
             .get(APPLICATION_JSON).getExamples().get("example-number-three");
@@ -198,6 +195,27 @@ void testBundleApi() throws OpenAPILoaderException, IOException {
 
     }
 
+    /**
+     * Asserts that the specified path/operation/responseCode points to a component/response that has a ref to an
+     * example and validates that this example exists in components/examples.
+     * @param openAPI the OpenAPI object
+     * @param path the path of the endpoint
+     * @param operationGetter the getter function to retrieve the operation from the path item
+     * @param responseCode the response code to check
+     */
+    private void assertComponentExample(OpenAPI openAPI, String path, Function<PathItem, Operation> operationGetter,
+                                        String responseCode) {
+        String responseRef = operationGetter.apply(openAPI.getPaths().get(path)).getResponses().get(responseCode).get$ref();
+        assertThat("Response is referenced", responseRef, notNullValue());
+        ApiResponse response = openAPI.getComponents().getResponses().get(substringAfterLast(responseRef, "/"));
+        assertThat("Response " + responseRef + " is inlined in components/response", response, notNullValue());
+        Object exampleRef = ((Map)response.getContent().get(APPLICATION_JSON).getExample()).get("$ref");
+        assertThat("The component has a ref to the actual example", exampleRef, notNullValue());
+        assertThat("400 response is inlined in components/response",
+                openAPI.getComponents().getExamples().containsKey(
+                        substringAfterLast(String.valueOf(exampleRef), "/")), is(true));
+    }
+
     private ObjectNode singleExampleNode(OpenAPI openAPI, String path, Function<PathItem, Operation> operation,
                                          String response, String contentType) {
         return (ObjectNode) singleExample(openAPI, path, operation, response, contentType);
@@ -214,9 +232,11 @@ private Object singleExample(OpenAPI openAPI, String path, Function<PathItem, Op
         ApiResponses responses = apply.getResponses();
         ApiResponse apiResponse = responses.get(response);
         Content content = apiResponse.getContent();
+        if (content == null) {
+            return Map.of();
+        }
         MediaType mediaType = content.get(contentType);
-        return mediaType
-            .getExample();
+        return mediaType.getExample();
     }
 
     // @Test - not really a test.