Merge pull request #1028 from Backbase/feature/Exclude-dirs-from-bundle

Add 'excludes' 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.61
+* Added new `excludes` parameter into `bundle` execution to exclude certain files (default: `**/lib/**`) to avoid generating externally downloaded spec files.
 ## 0.17.60
 * Allow references to parent directory of the spec itself, to be able to refer to common examples in a common lib.
 * Fix tests... petshop example moved.

boat-maven-plugin/README.md

@@ -212,6 +212,10 @@ Available parameters:
         Required: false
         List of file patterns to include to bundle.
 
+    excludes (Default: **/lib/**)
+        Required: false
+        List of file patterns to exclude to bundle.
+
     output (Default: ${project.build.directory}/openapi)
         Required: true
         Output directory for the bundled OpenAPI specs.

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

@@ -51,6 +51,9 @@ public class BundleMojo extends AbstractMojo {
     @Parameter(name = "includes", defaultValue = "**/openapi.yaml, **/*api*.yaml")
     protected String[] includes;
 
+    @Parameter(name = "excludes", defaultValue = "**/lib/**")
+    protected String[] excludes;
+
     @Parameter(name = "output", required = true, defaultValue = "${project.build.directory}/openapi")
     private File output;
 
@@ -91,6 +94,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
             DirectoryScanner directoryScanner = new DirectoryScanner();
             directoryScanner.setBasedir(input);
             directoryScanner.setIncludes(includes);
+            directoryScanner.setExcludes(excludes);
             directoryScanner.scan();
 
             String[] includedFiles = directoryScanner.getIncludedFiles();

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

@@ -17,6 +17,7 @@
 import org.junit.jupiter.params.provider.ValueSource;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.junit.jupiter.api.Assertions.fail;
@@ -64,6 +65,28 @@ void testBundleFolder() {
         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());
+        assertFalse(new File(outputFolder, "test-client-api-v1.1.1.yaml").exists());
+    }
+
+    @Test
+    @SneakyThrows
+    void testBundleFolder_whenExcludesExists() {
+        var outputFolder = "target/test-bundle-bundler";
+
+        BundleMojo mojo = new BundleMojo();
+
+        mojo.setInput(new File(getClass().getResource("/bundler").getFile()));
+        mojo.setOutput(new File(outputFolder));
+        mojo.setIncludes(new String[]{"**/*-api-v*.yaml"});
+        mojo.setExcludes(new String[]{"**/folder/**"});
+        mojo.setVersionFileName(true);
+        mojo.setFlattenOutput(true);
+        mojo.execute();
+
+        assertFalse(new File(outputFolder, "one-client-api-v1.3.5.yaml").exists());
+        assertFalse(new File(outputFolder, "one-client-api-v2.0.0.yaml").exists());
+        assertFalse(new File(outputFolder, "another-client-api-v1.7.9.yaml").exists());
+        assertTrue(new File(outputFolder, "test-client-api-v1.1.1.yaml").exists());
     }
 
     @Test

boat-maven-plugin/src/test/resources/bundler/test-client-api-v1.yaml

@@ -0,0 +1,26 @@
+openapi: "3.0.0"
+info:
+  version: 1.1.1
+  title: Test
+  license:
+    name: MIT
+paths:
+  '/client-api/v1/tests':
+    get:
+      summary: List all tests
+      operationId: listTests
+      responses:
+        '200':
+          description: A paged array of tests
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Tests"
+components:
+  schemas:
+    Tests:
+      type: object
+      properties:
+        -id:
+          type: string
+          description: The id of this test.