Merge pull request #1003 from Backbase/feature/Add-flatten-output-parameter-on-bundle

Add 'flattenOutput' parameter for 'bundle' execution.

Author: ugur-bb

README.md

@@ -14,6 +14,8 @@ It currently consists of
 
 # Release Notes
 BOAT is still under development and subject to change.
+## 0.17.56
+* Added new `flattenOutput` parameter into `bundle` execution to generate the bundled APIs directly into `output` directory, even though the respective `input` files are located within a subdirectory in the `input`.
 ## 0.17.55
 * Enhanced `boat-swift5` generator to cater for nested freeformObjects. This issue was identified in `ContentServicesApi`
 ## 0.17.54 and later

boat-maven-plugin/README.md

@@ -202,6 +202,36 @@ Bundles a spec by resolving external references.
 Configuration can point to a single in- and output file, or to in- and output directories. When directories are
 specified, all files specified by the `includes` parameter are bundled.
 
+Available parameters:
+
+    input (Default: ${project.basedir}/src/main/resources)
+        Required: true
+        Path to a directory or a file to indicate the input Open API files to bundle.
+
+    includes (Default: **/openapi.yaml, **/*api*.yaml)
+        Required: false
+        List of file patterns to include to bundle.
+
+    output (Default: ${project.build.directory}/openapi)
+        Required: true
+        Output directory for the bundled OpenAPI specs.
+
+    flattenOutput (Default: false)
+        Required: false
+        Flatten the output directory structure, i.e. the bundle API specs are directly put into the output folder, even if the respective `input` files are located within a subdirectory in the `input`.
+
+    version
+        Required: false
+        Optional parameter, to override the bundled spec version.
+
+    versionFileName (Default: false)
+        Required: false
+        Optional parameter to include the version in the bundled spec file name.
+        
+    removeExtensions (Default: "")
+        Required: false
+        Optional parameter to remove extensions from the bundled spec.
+
 Examples in `json` files are parsed to objects.
 
     <configuration>
@@ -486,4 +516,4 @@ This parameter is available as a replacement for the inputSpec parameter in goal
 It downloads a copy of the artifact if it is not already present, and uses a specified spec (or directory of specs) 
 from the artifact as the inputSpec for the goal. 
 
-More examples can be found in integration tests.
+More examples can be found in integration tests.

boat-maven-plugin/src/main/java/com/backbase/oss/boat/BundleMojo.java

@@ -4,14 +4,15 @@
 import static java.util.Collections.singletonMap;
 import static org.apache.commons.collections4.CollectionUtils.isNotEmpty;
 import static org.apache.commons.lang3.StringUtils.isNotBlank;
-import static org.apache.commons.lang3.StringUtils.isNumeric;
 
 import com.backbase.oss.boat.loader.OpenAPILoader;
 import com.backbase.oss.boat.loader.OpenAPILoaderException;
 import com.backbase.oss.boat.serializer.SerializerUtils;
 import com.backbase.oss.boat.transformers.Bundler;
 import com.backbase.oss.boat.transformers.SetVersion;
 import com.backbase.oss.boat.transformers.ExtensionFilter;
+
+import com.google.common.annotations.VisibleForTesting;
 import io.swagger.v3.oas.models.OpenAPI;
 import java.io.File;
 import java.io.IOException;
@@ -20,8 +21,10 @@
 import java.nio.file.Paths;
 import java.nio.file.StandardOpenOption;
 import java.util.List;
+import java.util.Optional;
 import java.util.stream.Collectors;
 
+import io.swagger.v3.oas.models.info.Info;
 import lombok.Getter;
 import lombok.Setter;
 import lombok.extern.slf4j.Slf4j;
@@ -51,6 +54,9 @@ public class BundleMojo extends AbstractMojo {
     @Parameter(name = "output", required = true, defaultValue = "${project.build.directory}/openapi")
     private File output;
 
+    @Parameter(name = "flattenOutput", required = false)
+    private boolean flattenOutput = false;
+
     @Parameter(name = "version", required = false)
     private String version;
 
@@ -82,17 +88,20 @@ public void execute() throws MojoExecutionException, MojoFailureException {
         final File[] inputFiles;
         final File[] outputFiles;
         if (input.isDirectory()) {
-
             DirectoryScanner directoryScanner = new DirectoryScanner();
             directoryScanner.setBasedir(input);
             directoryScanner.setIncludes(includes);
             directoryScanner.scan();
+
             String[] includedFiles = directoryScanner.getIncludedFiles();
-            inputFiles = stream(includedFiles).map(f -> new File(input, f)).collect(Collectors.toList()).toArray(File[]::new);
+            inputFiles = stream(includedFiles)
+                .map(file -> new File(input, file))
+                .collect(Collectors.toList())
+                .toArray(File[]::new);
             outputFiles = stream(includedFiles)
+                .map(this::normalizeOutputFileName)
                 .map(file -> new File(output, file))
                 .toArray(File[]::new);
-
             log.info("Found " + inputFiles.length + " specs to bundle.");
         } else {
             inputFiles = new File[] {input};
@@ -102,7 +111,6 @@ public void execute() throws MojoExecutionException, MojoFailureException {
         for (int i = 0; i < inputFiles.length; i++) {
             bundleOpenAPI(inputFiles[i], outputFiles[i]);
         }
-
     }
 
     private void bundleOpenAPI(File inputFile, File outputFile) throws MojoExecutionException {
@@ -130,21 +138,21 @@ private void bundleOpenAPI(File inputFile, File outputFile) throws MojoExecution
             if (versionFileName) {
                 String versionedFileName = versionFileName(outputFile.getAbsolutePath(), openAPI);
                 outputFile = Paths.get(versionedFileName).toFile();
-
             }
+
             Files.write(outputFile.toPath(), SerializerUtils.toYamlString(openAPI).getBytes(StandardCharsets.UTF_8), StandardOpenOption.CREATE);
             log.info("Bundled: {} into: {}", inputFile, outputFile);
         } catch (OpenAPILoaderException | IOException e) {
             throw new MojoExecutionException("Error transforming OpenAPI: {}" + inputFile, e);
         }
     }
 
-
+    @VisibleForTesting
     String versionFileName(String originalFileName, OpenAPI openAPI) throws MojoExecutionException {
-        String openApiVersion = openAPI.getInfo() != null ? openAPI.getInfo().getVersion() : null;
-        if (openApiVersion == null) {
-            throw new MojoExecutionException("Configured to use version in filename, but no version set.");
-        }
+        String openApiVersion = Optional.ofNullable(openAPI.getInfo())
+            .map(Info::getVersion)
+            .orElseThrow(() -> new MojoExecutionException("Configured to use version in filename, but no version set."));
+
         if (!openApiVersion.matches("^\\d\\..*")) {
             throw new MojoExecutionException(
                 "Version should be semver (or at least have a recognisable major version), but found '" + openApiVersion
@@ -159,4 +167,8 @@ String versionFileName(String originalFileName, OpenAPI openAPI) throws MojoExec
         return originalFileName.replaceAll("^(.*api-v)([0-9]+)(\\.yaml$)", "$1" + openApiVersion + "$3");
     }
 
+    @VisibleForTesting
+    String normalizeOutputFileName(String outputFileName) {
+        return flattenOutput ? new File(outputFileName).getName() : outputFileName;
+    }
 }

boat-maven-plugin/src/test/java/com/backbase/oss/boat/BundleMojoTest.java

@@ -13,6 +13,8 @@
 import org.apache.maven.plugin.MojoFailureException;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.function.Executable;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertThrows;
@@ -49,18 +51,59 @@ void testSkip() {
     @Test
     @SneakyThrows
     void testBundleFolder() {
+        var outputFolder = "target/test-bundle-folder";
+
         BundleMojo mojo = new BundleMojo();
 
-        mojo.setInput(new File(getClass().getResource("/bundler/folder/one-client-api-v1.yaml").getFile())
-            .getParentFile());
-        mojo.setOutput(new File("target/test-bundle-folder"));
+        mojo.setInput(new File(getClass().getResource("/bundler/folder").getFile()));
+        mojo.setOutput(new File(outputFolder));
         mojo.setIncludes(new String[]{"*-api-v*.yaml"});
         mojo.setVersionFileName(true);
         mojo.execute();
 
-        assertTrue(new File("target/test-bundle-folder/one-client-api-v1.3.5.yaml").exists());
-        assertTrue(new File("target/test-bundle-folder/one-client-api-v2.0.0.yaml").exists());
-        assertTrue(new File("target/test-bundle-folder/another-client-api-v1.7.9.yaml").exists());
+        assertTrue(new File(outputFolder, "one-client-api-v1.3.5.yaml").exists());
+        assertTrue(new File(outputFolder, "one-client-api-v2.0.0.yaml").exists());
+        assertTrue(new File(outputFolder, "another-client-api-v1.7.9.yaml").exists());
+    }
+
+    @Test
+    @SneakyThrows
+    void testBundleFolder_whenNotToBeFlattened_inSubDirStructure() {
+        var outputFolder = "target/test-bundle-folder-with-subdir";
+
+        BundleMojo mojo = new BundleMojo();
+
+        mojo.setInput(new File(getClass().getResource("/bundler").getFile()));
+        mojo.setOutput(new File(outputFolder));
+        mojo.setIncludes(new String[]{"**/*api-v*.yaml"}); // Includes sub-directories by '**/'
+        mojo.setVersionFileName(true);
+        mojo.setFlattenOutput(false);
+
+        mojo.execute();
+
+        assertTrue(new File(outputFolder, "/folder/one-client-api-v1.3.5.yaml").exists());
+        assertTrue(new File(outputFolder, "/folder/one-client-api-v2.0.0.yaml").exists());
+        assertTrue(new File(outputFolder, "/folder/another-client-api-v1.7.9.yaml").exists());
+    }
+
+    @Test
+    @SneakyThrows
+    void testBundleFolder_whenToBeFlattened_inSubDirStructure() {
+        var outputFolder = "target/test-bundle-folder-flattened";
+
+        BundleMojo mojo = new BundleMojo();
+
+        mojo.setInput(new File(getClass().getResource("/bundler").getFile()));
+        mojo.setOutput(new File(outputFolder));
+        mojo.setIncludes(new String[]{"**/*api-v*.yaml"}); // Includes sub-directories by '**/'
+        mojo.setVersionFileName(true);
+        mojo.setFlattenOutput(true);
+
+        mojo.execute();
+
+        assertTrue(new File(outputFolder, "one-client-api-v1.3.5.yaml").exists());
+        assertTrue(new File(outputFolder, "one-client-api-v2.0.0.yaml").exists());
+        assertTrue(new File(outputFolder, "another-client-api-v1.7.9.yaml").exists());
     }
 
     @Test
@@ -123,6 +166,42 @@ void testInvalidVersionInApi() {
 
     }
 
+    @ParameterizedTest
+    @ValueSource(strings = { "outputFile.yaml", "/client-api/v1/outputFile.yaml"})
+    void testOutputFileName_DefaultBehaviour(String outputFileName) {
+        BundleMojo mojo = new BundleMojo();
+
+        var actual = mojo.normalizeOutputFileName(outputFileName);
+
+        assertEquals(outputFileName, actual);
+    }
+
+    @Test
+    void testOutputFileName_WhenToBeFlattened_SimpleStructure() {
+        BundleMojo mojo = new BundleMojo();
+        mojo.setFlattenOutput(true);
+
+        var fileName = "outputFile.yaml";
+
+        var expected = fileName;
+        var actual = mojo.normalizeOutputFileName(fileName);
+
+        assertEquals(expected, actual);
+    }
+
+    @Test
+    void testOutputFileName_WhenToBeFlattened_NestedStructure() {
+        BundleMojo mojo = new BundleMojo();
+        mojo.setFlattenOutput(true);
+
+        var fileName = "/client-api/v1/outputFile.yaml";
+
+        var expected = "outputFile.yaml";
+        var actual = mojo.normalizeOutputFileName(fileName);
+
+        assertEquals(expected, actual);
+    }
+
     private void assertThrowsMojoExecutionExceptionWithMessage(Executable executable, String message) {
         MojoExecutionException thrown = assertThrows(MojoExecutionException.class, executable);
         assertTrue(thrown.getMessage().startsWith(message), "Expected message '" + message + "' but got '"
@@ -140,6 +219,4 @@ protected File getFile(String name) {
         assert resource != null;
         return new File(resource.getFile());
     }
-
-
 }