Merge pull request #437 from Backbase/test-merge

WIP: Upgrade OpenAPI Generator 6.3.0 and support for Jakarta

Author: miladbb

.github/workflows/boat.yml

@@ -16,7 +16,7 @@ jobs:
         uses: actions/setup-java@v3
         with:
           distribution: 'microsoft'
-          java-version: '11'
+          java-version: '17'
           cache: 'maven'
       - name: Build & Test
         run: mvn -B test
@@ -31,10 +31,42 @@ jobs:
         uses: actions/setup-java@v3
         with:
           distribution: 'microsoft'
-          java-version: '11'
+          java-version: '17'
           cache: 'maven'
       - name: Build and Analyze
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
         run: mvn -B verify sonar:sonar -Dgpg.skip
+  publish:
+    if: "!contains(github.event.head_commit.message, '[version bump]')"
+    runs-on: ubuntu-latest
+    needs: [ test, sonar ]
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v3
+
+      - name: Setup Java
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'microsoft'
+          java-version: '17'
+          cache: 'maven'
+          server-id: ossrh
+          server-username: MAVEN_USERNAME
+          server-password: MAVEN_PASSWORD
+          gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
+          gpg-passphrase: GPG_PASSPHRASE
+
+      - name: Build and Publish SNAPSHOT
+        run: |
+          mvn \
+            --no-transfer-progress \
+            --batch-mode \
+            -DskipTests=true \
+            deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          MAVEN_USERNAME: ${{ secrets.NEXUS_USERNAME }}
+          MAVEN_PASSWORD: ${{ secrets.NEXUS_PASSWORD }}
+          GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}

.github/workflows/release.yml

@@ -16,7 +16,7 @@ jobs:
         uses: actions/setup-java@v3
         with:
           distribution: 'microsoft'
-          java-version: '11'
+          java-version: '17'
           cache: 'maven'
       - name: Build & Test
         run: mvn -B test
@@ -31,7 +31,7 @@ jobs:
         uses: actions/setup-java@v3
         with:
           distribution: 'microsoft'
-          java-version: '11'
+          java-version: '17'
           cache: 'maven'
       - name: Build and Analyze
         env:
@@ -51,7 +51,7 @@ jobs:
         uses: actions/setup-java@v3
         with:
           distribution: 'microsoft'
-          java-version: '11'
+          java-version: '17'
           cache: 'maven'
           server-id: ossrh
           server-username: MAVEN_USERNAME
@@ -114,7 +114,7 @@ jobs:
         uses: actions/setup-java@v3
         with:
           distribution: 'microsoft'
-          java-version: '11'
+          java-version: '17'
           cache: 'maven'
       - name: Configure Git user
         run: |

.gitignore

@@ -34,3 +34,5 @@ hs_err_pid*
 .*
 # but not git dot files (e.g. .gitattribute)
 !.git?*
+
+!boat-scaffold/src/main/templates/boat-java/gradle-wrapper.jar

README.md

@@ -7,18 +7,26 @@ The Backbase Open API Tools is a collection of tools created to work efficiently
 
 It currently consists of
 
-* RAML 1.0 Converter to OpenAPI 3.0 
 * Create Diff Report between 2 OpenAPI versions of the same spec (Based on https://github.com/quen2404/openapi-diff)
 * Decompose Transformer to remove Composed Schemas from OpenAPI specs to aid in code generators
 * Case Transformer to see how your API looks like when going from camelCase to snake_case  (transforms examples too)
 * [Code Generator](boat-maven-plugin/README.md) based on [openapi-generator.tech](https://openapi-generator.tech/) with optimized templates and fixes.
-* Lint mojo based on Zalando Zally API Guidelines
+* Lint mojo based on Zalando Zally and Backbase API
 
 The project is very much Work In Progress and will be published on maven central when considered ready enough. 
 
 # Release Notes
 BOAT is still under development and subject to change.
 
+## 0.17.0
+* General
+  * Removed RAML Support
+  * Update OpenAPI Tools to 6.2.1
+* Boat Java Generator
+  * Jakarta EE 9 compatibility
+  * `spring-mvc` library is removed because it is not supported by OpenAPI Tools anymore
+  * Use of `Set` for unique items is now enabled by default as OpenAPI Generator fixed their implementation
+
 ## 0.16.11
 * Boat Angular generator
   * Set `removeComments: false` in generated tsconfig.json files to retain `/*#__PURE__*/` annotation in compiled JS.
@@ -391,172 +399,8 @@ BOAT is still under development and subject to change.
 mvn install
 ```
 
-## CLI Usage
-
-### Convert RAML to Open API 3.0 
-```shell script
-cd boat-terminal
-java -jar target/boat-terminal-0.0.1-SNAPSHOT-jar-with-dependencies.jar \
-  -f src/test/resources/api.raml
-```
-
-
-### Convert RAML to Open API 3.0 && Pipe output to file
-```shell script
-cd boat-terminal
-java -jar target/boat-terminal-0.0.1-SNAPSHOT-jar-with-dependencies.jar \
-  -f src/test/resources/api.raml \
-  > openapi.yaml
-```
-
-
-### Convert RAML to Open API 3.0 file and verbose logging
-```shell script
-cd boat-terminal
-java -jar target/boat-terminal-0.0.1-SNAPSHOT-jar-with-dependencies.jar \
-  -f src/test/resources/api.raml \
-  -o swagger.yaml \
-  -v
-```
-
-### Convert RAML to Open API 3.0 with examples exploded into <output-dir>/examples/
-```shell script
-cd boat-terminal
-java -jar target/boat-terminal-0.0.1-SNAPSHOT-jar-with-dependencies.jar \
-  -f src/test/resources/api.raml \
-  -o swagger.yaml \
-  -d my-open-api-spec/ \
-  -v
-```
-
-
 ## Maven Plugin Usage
 
-Configuration
-
-```xml
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-    
-    <modelVersion>4.0.0</modelVersion>
-
-    <groupId>my.project</groupId>
-    <artifactId>my-specs-definition</artifactId>
-    <version>1.0</version>
-    <packaging>pom</packaging>
-
-    <properties>
-      <boat-maven-plugin.version>0.1.4</boat-maven-plugin.version>
-    </properties>
-
-    <build>
-      <plugins>
-        <plugin>
-          <groupId>com.backbase.oss</groupId>
-          <artifactId>boat-maven-plugin</artifactId>
-          <version>${boat-maven-plugin.version}</version>
-            <executions>
-              <execution>
-                <id>export-raml-spec</id>
-                <phase>generate-sources</phase>
-                <goals>
-                  <goal>export</goal>
-                </goals>
-                <configuration>
-                  <inputFile>${basedir}/src/main/resources/client-api.raml</inputFile>
-                </configuration>
-              </execution>
-            </executions>
-        </plugin>
-     </plugins>
-    </build>
-</project>
-```
-
-The following command will convert the given `client-api.raml` file into Open API 3.0 format.
- 
-```bash
-mvn boat:export
-```
-
-**NOTE:** RAML file name should end with `-api.raml`, `service-api.raml` or `client-api.raml`. 
-
-## Export All Specifications in Bill-Of-Materials pom file
-If you want to export all specifications referenced in a pom file, you can use the following mojo
-
-```xml
-    <build>
-        <plugins>
-            <plugin>
-                <groupId>com.backbase.boat</groupId>
-                <artifactId>boat-maven-plugin</artifactId>
-                <version>${boat-maven-plugin.version}</version>
-                <configuration>
-                    <specBom>
-                        <groupId>com.backbase.dbs</groupId>-->
-                        <artifactId>banking-services-bom</artifactId>
-                        <version>[2.16.0,)</version>
-                        <type>pom</type>
-                        <!-- Bom equal or higher than 2.16 -->
-                    </specBom>
-                    <output>${project.basedir}/raml-2-openapi-specs</output>
-                    <xLogoUrl>http://www.backbase.com/wp-content/uploads/2017/04/backbase-logo-png.png</xLogoUrl>
-                    <xLogoAltText>Backbase</xLogoAltText>
-                    <markdownBottom># Disclaimer
-This API is converted from RAML1.0 using the boat-maven-plugin and is not final or validated!
-                    </markdownBottom>
-                    <addChangeLog>true</addChangeLog>
-                </configuration>
-            </plugin>
-        </plugins>
-    </build>
-
-```
-
-### Configuration Options
-
-* The `addChangeLog` option will automagically insert a change log between all referenced versions 
-* The `includeVersionsRegEx` can be used to filter out certain versions. By default it's set to `^(\d+\.)?(\d+\.)?(\d+)$` to only allow x.x.x versions. To also include patch versions, set it to `^(\d+\.)?(\d+\.)?(\d+\.)?(\*|\d+)$`
-
-```bash
-mvn boat:export-bom
-```
-
-## Generate API docs
-
-Configuration
-
-```xml
-<!-- ... -->
-
-<build>
-  <plugins>
-    <plugin>
-      <groupId>com.backbase.oss</groupId>
-      <artifactId>boat-maven-plugin</artifactId>
-      <version>${boat-maven-plugin.version}</version>
-        <executions>
-          <execution>
-            <id>generate-docs</id>
-            <phase>generate-sources</phase>
-            <goals>
-              <goal>generate</goal>
-            </goals>
-            <configuration>
-              <inputSpec>${project.basedir}/src/main/resources/api.yaml</inputSpec>
-              <output>${project.build.directory}/generated-sources</output>
-              <generatorName>html2</generatorName>
-            </configuration>
-          </execution>
-        </executions>
-    </plugin>
- </plugins>
-</build>
-
-<!-- ... -->
-```
-
 The following command will generate `index.html` file in the specified output folder that contains API endpoints description.  
 
 ```bash

boat-engine/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.backbase.oss</groupId>
         <artifactId>backbase-openapi-tools</artifactId>
-        <version>0.16.12-SNAPSHOT</version>
+        <version>0.17.0-SNAPSHOT</version>
     </parent>
     <artifactId>boat-engine</artifactId>
     <packaging>jar</packaging>
@@ -36,17 +36,6 @@
             <version>0.3.2</version>
         </dependency>
 
-        <dependency>
-            <groupId>org.raml</groupId>
-            <artifactId>raml-parser-2</artifactId>
-            <version>1.0.51</version>
-            <exclusions>
-                <exclusion>
-                    <groupId>com.github.fge</groupId>
-                    <artifactId>*</artifactId>
-                </exclusion>
-            </exclusions>
-        </dependency>
 
         <dependency>
             <groupId>io.swagger.parser.v3</groupId>

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

@@ -5,11 +5,11 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectWriter;
 import com.google.common.base.CaseFormat;
+import jakarta.validation.constraints.NotNull;
 import org.apache.commons.io.FileUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import javax.validation.constraints.NotNull;
 import java.io.File;
 import java.io.IOException;
 import java.nio.file.Files;