Release 0.14.4

README.md

@@ -19,6 +19,14 @@ The project is very much Work In Progress and will be published on maven central
 # Release Notes
 BOAT is still under development and subject to change.
 
+## 0.14.4
+
+* *Boat Marina*
+  * Added a now BOAT Scaffold template called Marina, as that is where the models hang out. The Boat Marina template outputs a single JSON file that is used to offer a rich user interface built from the specs including search, page per operation and many more features!
+
+* *Maven Plugin*
+    * The boat:doc goal now recursively search OpenAPI specs in a directory to generate docs for each found spec.  
+
 ## 0.14.3
 
 * *Maven Plugin*

boat-engine/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.backbase.oss</groupId>
         <artifactId>backbase-openapi-tools</artifactId>
-        <version>0.14.3</version>
+        <version>0.14.4-SNAPSHOT</version>
     </parent>
     <artifactId>boat-engine</artifactId>
     <packaging>jar</packaging>

boat-engine/src/main/java/com/backbase/oss/boat/XmlSchemaToOpenApi.java

@@ -21,7 +21,7 @@
 import java.nio.charset.StandardCharsets;
 
 @Log
-@SuppressWarnings({"java:S3740", "rawtypes"})
+@SuppressWarnings({"java:S3740", "rawtypes", "java:S2755"})
 public class XmlSchemaToOpenApi {
     public static final String NAME = "name";
     public static final String TYPE = "type";

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

@@ -253,7 +253,7 @@ private void dereferenceExample(ExampleHolder exampleHolder) {
     private Object convertExampleContent(ExampleHolder exampleHolder, String refPath) {
         try {
             if (exampleHolder.getRef().endsWith("json") || refPath.endsWith("json")) {
-                return Json.mapper().readValue(exampleHolder.getContent(), Object.class);
+                return Json.mapper().readValue(exampleHolder.getContent(), JsonNode.class);
             }
             return exampleHolder.getContent();
         } catch (JsonProcessingException | RuntimeException e) {

boat-maven-plugin/README.md

@@ -23,6 +23,8 @@ defined on openapi-generator-maven-plugin can be applied here too.
 
 Boat maven plugin uses slightly modified templates for html, java and webclient that help generate specs and clients that work best in a Backbase projects.
 
+All inputSpec parameters for this goal may additionally be configured as an artifact. See [Example inputMavenArtifact parameter](#example-inputMavenArtifact-parameter) or [integration tests](https://github.com/Backbase/backbase-openapi-tools/tree/main/boat-maven-plugin/src/it/example/boat-artifact-input) for examples.
+
 ## boat:generate-spring-boot-embedded
 
 Same with `generate` but with opinionated defaults for Spring
@@ -152,7 +154,11 @@ Available parameters:
     inputSpec
         Required: true
         Input spec directory or file.
-
+        Optionaly inputMavenArtifact parameter can be used instead to configure an artifact input.
+
+    inputMavenArtifact
+        Input spec artifact
+
     output (Default: ${project.build.directory}/boat-lint-reports)
         Output directory for lint reports.
 
@@ -171,12 +177,15 @@ Example:
         <ignoreRules>${ignored-lint-rules}</ignoreRules>
         <showIgnoredRules>true</showIgnoredRules>
     </configuration>
+
+To see details and an example of inputMavenArtifact:
+ [Example inputMavenArtifact parameter](#example-inputMavenArtifact-parameter)
 
 To see details about this goal:
 
     mvn help:describe -DgroupId=com.backbase.oss -DartifactId=boat-maven-plugin  -Dgoal=lint -Ddetail`
-
-
+    
+    
 ## boat:bundle
 
 Bundles a spec by resolving external references.
@@ -321,3 +330,47 @@ Configuration example
         </pipeline>
     </configuration>
 ```
+
+## Example inputMavenArtifact parameter
+
+Example:
+
+```$xml
+    <inputMavenArtifact>
+        <groupId>com.backbase.oss.boat.example</groupId>
+        <artifactId>openapi-zips</artifactId>
+        <version>1.0.0-SNAPSHOT</version>
+        <classifier>api</classifier>
+        <type>zip</type>
+        <fileName>presentation-client-api/openapi.yaml</fileName>
+    </inputMavenArtifact>
+```
+
+Parameters:
+
+    groupId
+        Required: true
+        Input artifacts groupId
+    artifactId
+        Required: true
+        Input artifacts artifactId
+    version
+        Required: true
+        Input artifacts version
+    classifier
+        Required: true
+        Input artifacts classifier (must be api)
+    type
+        Required: true
+        Input artifacts type (must be zip)
+    fileName
+        Required: true
+        directory or file in artifact to be processed by goal
+
+
+This parameter is available as a replacement for the inputSpec parameter in goals [generate](#boat:generate) and [lint](#boat:lint).
+
+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.

boat-maven-plugin/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.backbase.oss</groupId>
         <artifactId>backbase-openapi-tools</artifactId>
-        <version>0.14.3</version>
+        <version>0.14.4-SNAPSHOT</version>
     </parent>
     <artifactId>boat-maven-plugin</artifactId>
 
@@ -239,7 +239,7 @@
                     <localRepositoryPath>${project.build.directory}/local-repo</localRepositoryPath>
                     <settingsFile>src/it/settings.xml</settingsFile>
                     <extraArtifacts>
-                        <extraArtifact>org.jacoco:org.jacoco.agent:0.8.4:jar:runtime</extraArtifact>
+                        <extraArtifact>org.jacoco:org.jacoco.agent:${jacoco-maven-plugin.version}:jar:runtime</extraArtifact>
                     </extraArtifacts>
                 </configuration>
                 <executions>

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

@@ -7,12 +7,14 @@
 
 @Mojo(name = "doc", threadSafe = true)
 @Slf4j
-public class GenerateDocMojo  extends GenerateFromDirectoryDocMojo  {
+public class GenerateDocMojo extends GenerateFromDirectoryDocMojo {
 
     @Override
     public void execute() throws MojoExecutionException, MojoFailureException {
         getLog().info("Generating Boat Docs");
-        generatorName = "boat-docs";
+        if (generatorName == null) {
+            generatorName = "boat-docs";
+        }
         super.execute();
     }
 }

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

@@ -3,8 +3,12 @@
 import lombok.extern.slf4j.Slf4j;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
+import org.apache.maven.plugins.annotations.Parameter;
+import org.codehaus.plexus.util.DirectoryScanner;
 
 import java.io.File;
+import java.util.Arrays;
+import java.util.stream.Collectors;
 
 /**
  * Allows generate::Doc to accept inputSpec as a directory
@@ -13,6 +17,9 @@
 @Slf4j
 public class GenerateFromDirectoryDocMojo extends GenerateMojo {
 
+  @Parameter(defaultValue = "**/*-api-*.yaml")
+  protected String openApiFileFilters;
+
 
   @Override
   public void execute() throws MojoExecutionException, MojoFailureException {
@@ -33,22 +40,26 @@ private void fileInputExecute(File inputSpecFile) throws MojoExecutionException,
       File[] inputSpecs;
       File outPutDirectory = output;
 
-      inputSpecs = inputSpecFile.listFiles(pathname -> pathname.getName().endsWith(".yaml"));
+      inputSpecs = findAllOpenApiSpecs(inputSpecFile);
 
-      if (inputSpecs == null || inputSpecs.length == 0) {
+      if (inputSpecs.length == 0) {
         throw new MojoExecutionException("No OpenAPI specs found in: " + inputSpec);
       }
 
       for (File f : inputSpecs) {
         inputSpec = f.getPath();
-        output = new File(outPutDirectory.getPath(), f.getName().substring(0, f.getName().lastIndexOf(".")).concat("-docs"));
+        output = new File(outPutDirectory.getPath(), f.getName().substring(0, f.getName().lastIndexOf(".")));
 
         if (!output.exists()) {
           output.mkdir();
         }
 
         log.info(" Generating docs for spec {} in directory", f.getName());
-        super.execute();
+        try {
+          super.execute();
+        } catch (MojoExecutionException | MojoFailureException e) {
+          log.error("Failed to generate doc for spec: {}", inputSpec);
+        }
       }
 
     } else {
@@ -58,4 +69,15 @@ private void fileInputExecute(File inputSpecFile) throws MojoExecutionException,
 
     }
   }
+
+  private File[] findAllOpenApiSpecs(File specDirectory) {
+    DirectoryScanner directoryScanner = new DirectoryScanner();
+    directoryScanner.setBasedir(specDirectory);
+    directoryScanner.setIncludes(openApiFileFilters.replace(" ", "").split(","));
+    directoryScanner.scan();
+
+    String[] includedFiles = directoryScanner.getIncludedFiles();
+    return Arrays.stream(includedFiles).map(pathname -> new File(specDirectory, pathname))
+            .collect(Collectors.toList()).toArray(new File[]{});
+  }
 }

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

@@ -45,16 +45,12 @@ class ExportBomMojoTests {
   @Mock
   Metadata metadatamock;
 
-  @Captor
-  ArgumentCaptor<List> argCaptor;
-
 
   @Test
-  void testExportBomEmptyMeta() throws MojoFailureException, MojoExecutionException, ArtifactResolutionException {
+  void testExportBomEmptyMeta() throws MojoExecutionException {
     artifactResolver = mock(ArtifactResolver.class);
     artifactResult = mock( ArtifactResult.class);
     metadataResolver = mock(MetadataResolver.class);
-    org.eclipse.aether.artifact.Artifact artifact = mock(org.eclipse.aether.artifact.Artifact.class);
 
     when(metadataResolver.resolveMetadata(any(),any())).thenReturn(Collections.singletonList(metadataResult));
 
@@ -77,13 +73,14 @@ void testExportBomEmptyMeta() throws MojoFailureException, MojoExecutionExceptio
     build.setDirectory("target");
 
     MavenProject project = new MavenProject();
-    mojo.remoteRepositories = Collections.EMPTY_LIST;
+    mojo.remoteRepositories = Collections.emptyList();
     project.setBuild(build);
     mojo.project = project;
     mojo.repositorySession = mock(RepositorySystemSession.class);
     mojo.execute();
 
-    assertThat(output.list()).isEmpty();
+    assertThat(output).isEmptyDirectory();
+
   }
 
   @Test
@@ -98,7 +95,7 @@ void testExportBomUseOfArtifactResolver() throws MojoFailureException, MojoExecu
     artifactResolver = mock(ArtifactResolver.class);
     artifactResult = mock( ArtifactResult.class);
     org.eclipse.aether.artifact.Artifact artifact; //= mock(org.eclipse.aether.artifact.Artifact.class);
-    artifact = new DefaultArtifact(groupId, artifactId, "", type, version,Collections.EMPTY_MAP, pomFile);
+    artifact = new DefaultArtifact(groupId, artifactId, "", type, version,Collections.emptyMap(), pomFile);
 
 
     when(artifactResolver.resolveArtifact(any(),any())).thenReturn(artifactResult);
@@ -138,14 +135,14 @@ void testExportBomUseOfArtifactResolver() throws MojoFailureException, MojoExecu
     build.setDirectory("target");
 
     MavenProject project = new MavenProject();
-    mojo.remoteRepositories = Collections.EMPTY_LIST;
+    mojo.remoteRepositories = Collections.emptyList();
 
     project.setBuild(build);
     mojo.project = project;
     mojo.repositorySession = mock(RepositorySystemSession.class);
     mojo.execute();
 
-    assertThat(output.list()).isEmpty();
+    assertThat(output).isEmptyDirectory();
 
   }
   private File getFile(String fileName) {

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

@@ -111,8 +111,9 @@ void testBoatDocsWithDirectory() throws MojoExecutionException, MojoFailureExcep
         mojo.skipIfSpecIsUnchanged = false;
         mojo.bundleSpecs = true;
         mojo.dereferenceComponents = true;
+        mojo.openApiFileFilters = "**/*.yaml";
         mojo.execute();
-        assertThat(output.list()).containsExactlyInAnyOrder("link-docs", "petstore-docs", "petstore-new-non-breaking-docs", "upto-docs");
+        assertThat(output.list()).contains("link", "petstore", "petstore-new-non-breaking", "upto");
     }
 
     @Test

boat-quay/boat-quay-lint/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.backbase.oss</groupId>
         <artifactId>boat-quay</artifactId>
-        <version>0.14.3</version>
+        <version>0.14.4-SNAPSHOT</version>
     </parent>
     <artifactId>boat-quay-lint</artifactId>
     <packaging>jar</packaging>

boat-quay/boat-quay-rules/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.backbase.oss</groupId>
         <artifactId>boat-quay</artifactId>
-        <version>0.14.3</version>
+        <version>0.14.4-SNAPSHOT</version>
     </parent>
     <artifactId>boat-quay-rules</artifactId>
     <packaging>jar</packaging>

boat-quay/boat-quay-rules/src/main/resources/boat.conf

@@ -63,7 +63,7 @@ StringPropertyLengthBoundsRule {
 }
 
 OpenApiVersionRule {
-  openApiVersions: [ 3.1.0 ]
+  openApiVersions: [ 3.0.3, 3.0.4 ]
 }
 
 ExtraRuleAnnotations {

boat-quay/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.backbase.oss</groupId>
         <artifactId>backbase-openapi-tools</artifactId>
-        <version>0.14.3</version>
+        <version>0.14.4-SNAPSHOT</version>
     </parent>
 
 

boat-scaffold/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.backbase.oss</groupId>
         <artifactId>backbase-openapi-tools</artifactId>
-        <version>0.14.3</version>
+        <version>0.14.4-SNAPSHOT</version>
     </parent>
     <artifactId>boat-scaffold</artifactId>
 
@@ -86,7 +86,7 @@
         <dependency>
             <groupId>com.backbase.oss</groupId>
             <artifactId>boat-trail-resources</artifactId>
-            <version>0.14.3</version>
+            <version>0.14.4-SNAPSHOT</version>
             <scope>test</scope>
         </dependency>
     </dependencies>

boat-scaffold/src/main/java/com/backbase/oss/codegen/BoatDefaultGenerator.java

@@ -0,0 +1,6 @@
+package com.backbase.oss.codegen;
+
+import org.openapitools.codegen.DefaultGenerator;
+
+public class BoatDefaultGenerator extends DefaultGenerator {
+}