Adds gradle build tool support for java generator (#430)

* Adds buildTool cli option for java

* Updates buildTool info

* Adds gradle files in petsote sample

* Adds gitignore

* Moves common files to same place in java

* Fixes gradle checker framework settings

* Excludes gradle wrapper

* Fixes buuild and settings filenames for gradle buildTool

* Fixes gitignoring of gradle wrapper files

* Updates java version constraint in gradle settings file, petstore uses gradle in ci

* Reverts root gitignore

* Fixes java generator tests

* Fixes AuthorTemplateTest

* Fixes all getGnerator invocations

* Docs regen

* Updates buildTool ordering for docs

* Samples regen

.circleci/parallel.sh

@@ -29,6 +29,8 @@ elif [ "$JOB_ID" = "testJava17ClientSamples" ]; then
   echo "Running job $JOB_ID ..."
   java -version
   mvn -version
+  gradle --version
+
   cat ./.circleci/testJava17ClientSamples.sh | parallel
 
 else

.circleci/testJava17ClientSamples.sh

@@ -1,3 +1,3 @@
-  (cd samples/client/petstore/java && mvn test)
+  (cd samples/client/petstore/java && gradle wrapper && gradle test)
   (cd samples/client/3_0_3_unit_test/java && mvn test)
   (cd samples/client/3_1_0_unit_test/java && mvn test)

.gitignore

@@ -49,7 +49,6 @@ test-output/
 #Java/Android
 **/.gradle
 
-
 # Python
 *.pyc
 __pycache__

bin/generate_samples_configs/java.yaml

@@ -3,4 +3,5 @@ outputDir: samples/client/petstore/java
 inputSpec: src/test/resources/3_0/python/petstore_customized.yaml
 additionalProperties:
   artifactId: petstore
-  hideGenerationTimestamp: "true"
+  hideGenerationTimestamp: "true"
+  buildTool: gradle

docs/generators/java.md

@@ -23,6 +23,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
 |artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapi-json-schema-tools/openapi-json-schema-generator|
 |artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
+|buildTool|the build automation tool used in generated code|<dl><dt>**maven**</dt><dd>Use maven</dd><dt>**gradle**</dt><dd>Use gradle</dd></dl>|maven|
 |developerEmail|developer email in generated pom.xml| |team@openapijsonschematools.org|
 |developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
 |developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|

samples/client/3_0_3_unit_test/java/.gitignore

@@ -0,0 +1,9 @@
+build/
+.gradle/
+.idea/
+target/
+
+# gradle wrapper
+gradlew
+gradlew.bat
+gradle/

samples/client/3_0_3_unit_test/java/.openapi-generator/FILES

@@ -1,3 +1,4 @@
+.gitignore
 README.md
 docs/RootServerInfo.md
 docs/components/schemas/AdditionalpropertiesAllowsASchemaWhichShouldValidate.md

samples/client/3_0_3_unit_test/java/README.md

@@ -41,19 +41,6 @@ Add this dependency to your project's POM:
 </dependency>
 ```
 
-### Others
-
-At first generate the JAR by executing:
-
-```shell
-mvn clean package
-```
-
-Then manually install the following JARs:
-
-- `target/unit-test-api-0.0.1.jar`
-- `target/lib/*.jar`
-
 
 ## Usage Notes
 ### Validation, Immutability, and Data Type

samples/client/3_0_3_unit_test/java/src/main/java/org/openapijsonschematools/client/header/Rfc6570Serializer.java

@@ -27,7 +27,11 @@ private static String percentEncode(String s) throws NotImplementedException {
                     .replace("%7E", "~");
             // This could be done faster with more hand-crafted code.
         } catch (UnsupportedEncodingException wow) {
-            throw new NotImplementedException(wow.getMessage());
+            @Nullable String msg = wow.getMessage();
+            if (msg == null) {
+                throw new NotImplementedException("UnsupportedEncodingException thrown");
+            }
+            throw new NotImplementedException(msg);
         }
     }
 

samples/client/3_0_3_unit_test/java/src/main/java/org/openapijsonschematools/client/parameter/CookieSerializer.java

@@ -16,7 +16,7 @@ protected CookieSerializer(Map<String, Parameter> parameters) {
 
     public String serialize(Map<String, ?> inData) throws NotImplementedException {
         String result = "";
-        Map<String, ?> sortedData = new TreeMap<>(inData);
+        Map<String, @Nullable Object> sortedData = new TreeMap<>(inData);
         for (Map.Entry<String, ?> entry: sortedData.entrySet()) {
             String mapKey = entry.getKey();
             @Nullable Parameter parameter = parameters.get(mapKey);

samples/client/3_0_3_unit_test/java/src/test/java/org/openapijsonschematools/client/header/SchemaHeaderTest.java

@@ -34,7 +34,7 @@ public void testSerialization() throws ValidationException, NotImplementedExcept
         mapPayload.put("R", 100);
         mapPayload.put("G", 200);
         mapPayload.put("B", 150);
-        var testCases = List.of(
+        List<ParamTestCase> testCases = List.of(
                 new ParamTestCase(
                         null,
                         Map.of("color", List.of(""))
@@ -135,28 +135,43 @@ public void testDeserialization() throws ValidationException, NotImplementedExce
         assertNull(deserialized);
 
         header = getHeader(NumberJsonSchema.NumberJsonSchema1.getInstance());
-        deserialized = header.deserialize(List.of("1"), false, configuration);
+        var deserializedOne = header.deserialize(List.of("1"), false, configuration);
+        if (deserializedOne == null) {
+            throw new RuntimeException("invalid value");
+        }
         @Nullable Object expected = 1L;
-        Assert.assertEquals(expected, deserialized);
+        Assert.assertEquals(expected, deserializedOne);
 
         header = getHeader(NumberJsonSchema.NumberJsonSchema1.getInstance());
-        deserialized = header.deserialize(List.of("3.14"), false, configuration);
+        var deserialized314 = header.deserialize(List.of("3.14"), false, configuration);
+        if (deserialized314 == null) {
+            throw new RuntimeException("invalid value");
+        }
         expected = 3.14d;
-        Assert.assertEquals(expected, deserialized);
+        Assert.assertEquals(expected, deserialized314);
 
         header = getHeader(StringJsonSchema.StringJsonSchema1.getInstance());
-        deserialized = header.deserialize(List.of("blue"), false, configuration);
+        var deserializedBlue = header.deserialize(List.of("blue"), false, configuration);
+        if (deserializedBlue == null) {
+            throw new RuntimeException("invalid value");
+        }
         expected = "blue";
-        Assert.assertEquals(expected, deserialized);
+        Assert.assertEquals(expected, deserializedBlue);
 
         header = getHeader(StringJsonSchema.StringJsonSchema1.getInstance());
-        deserialized = header.deserialize(List.of("hello world"), false, configuration);
+        var deserializedHelloWorld = header.deserialize(List.of("hello world"), false, configuration);
+        if (deserializedHelloWorld == null) {
+            throw new RuntimeException("invalid value");
+        }
         expected = "hello world";
-        Assert.assertEquals(expected, deserialized);
+        Assert.assertEquals(expected, deserializedHelloWorld);
 
         header = getHeader(ListJsonSchema.ListJsonSchema1.getInstance());
-        deserialized = header.deserialize(List.of("blue", "black", "brown"), false, configuration);
+        var deserializedList = header.deserialize(List.of("blue", "black", "brown"), false, configuration);
+        if (deserializedList == null) {
+            throw new RuntimeException("invalid value");
+        }
         expected = List.of("blue", "black", "brown");
-        Assert.assertEquals(expected, deserialized);
+        Assert.assertEquals(expected, deserializedList);
     }
 }

samples/client/3_1_0_unit_test/java/.gitignore

@@ -0,0 +1,9 @@
+build/
+.gradle/
+.idea/
+target/
+
+# gradle wrapper
+gradlew
+gradlew.bat
+gradle/

samples/client/3_1_0_unit_test/java/.openapi-generator/FILES

@@ -1,3 +1,4 @@
+.gitignore
 README.md
 docs/RootServerInfo.md
 docs/components/schemas/ASchemaGivenForPrefixitems.md

samples/client/3_1_0_unit_test/java/README.md

@@ -41,19 +41,6 @@ Add this dependency to your project's POM:
 </dependency>
 ```
 
-### Others
-
-At first generate the JAR by executing:
-
-```shell
-mvn clean package
-```
-
-Then manually install the following JARs:
-
-- `target/unit-test-api-0.0.1.jar`
-- `target/lib/*.jar`
-
 
 ## Usage Notes
 ### Validation, Immutability, and Data Type

samples/client/3_1_0_unit_test/java/src/main/java/org/openapijsonschematools/client/header/Rfc6570Serializer.java

@@ -27,7 +27,11 @@ private static String percentEncode(String s) throws NotImplementedException {
                     .replace("%7E", "~");
             // This could be done faster with more hand-crafted code.
         } catch (UnsupportedEncodingException wow) {
-            throw new NotImplementedException(wow.getMessage());
+            @Nullable String msg = wow.getMessage();
+            if (msg == null) {
+                throw new NotImplementedException("UnsupportedEncodingException thrown");
+            }
+            throw new NotImplementedException(msg);
         }
     }
 

samples/client/3_1_0_unit_test/java/src/main/java/org/openapijsonschematools/client/parameter/CookieSerializer.java

@@ -16,7 +16,7 @@ protected CookieSerializer(Map<String, Parameter> parameters) {
 
     public String serialize(Map<String, ?> inData) throws NotImplementedException {
         String result = "";
-        Map<String, ?> sortedData = new TreeMap<>(inData);
+        Map<String, @Nullable Object> sortedData = new TreeMap<>(inData);
         for (Map.Entry<String, ?> entry: sortedData.entrySet()) {
             String mapKey = entry.getKey();
             @Nullable Parameter parameter = parameters.get(mapKey);

samples/client/3_1_0_unit_test/java/src/test/java/org/openapijsonschematools/client/header/SchemaHeaderTest.java

@@ -34,7 +34,7 @@ public void testSerialization() throws ValidationException, NotImplementedExcept
         mapPayload.put("R", 100);
         mapPayload.put("G", 200);
         mapPayload.put("B", 150);
-        var testCases = List.of(
+        List<ParamTestCase> testCases = List.of(
                 new ParamTestCase(
                         null,
                         Map.of("color", List.of(""))
@@ -135,28 +135,43 @@ public void testDeserialization() throws ValidationException, NotImplementedExce
         assertNull(deserialized);
 
         header = getHeader(NumberJsonSchema.NumberJsonSchema1.getInstance());
-        deserialized = header.deserialize(List.of("1"), false, configuration);
+        var deserializedOne = header.deserialize(List.of("1"), false, configuration);
+        if (deserializedOne == null) {
+            throw new RuntimeException("invalid value");
+        }
         @Nullable Object expected = 1L;
-        Assert.assertEquals(expected, deserialized);
+        Assert.assertEquals(expected, deserializedOne);
 
         header = getHeader(NumberJsonSchema.NumberJsonSchema1.getInstance());
-        deserialized = header.deserialize(List.of("3.14"), false, configuration);
+        var deserialized314 = header.deserialize(List.of("3.14"), false, configuration);
+        if (deserialized314 == null) {
+            throw new RuntimeException("invalid value");
+        }
         expected = 3.14d;
-        Assert.assertEquals(expected, deserialized);
+        Assert.assertEquals(expected, deserialized314);
 
         header = getHeader(StringJsonSchema.StringJsonSchema1.getInstance());
-        deserialized = header.deserialize(List.of("blue"), false, configuration);
+        var deserializedBlue = header.deserialize(List.of("blue"), false, configuration);
+        if (deserializedBlue == null) {
+            throw new RuntimeException("invalid value");
+        }
         expected = "blue";
-        Assert.assertEquals(expected, deserialized);
+        Assert.assertEquals(expected, deserializedBlue);
 
         header = getHeader(StringJsonSchema.StringJsonSchema1.getInstance());
-        deserialized = header.deserialize(List.of("hello world"), false, configuration);
+        var deserializedHelloWorld = header.deserialize(List.of("hello world"), false, configuration);
+        if (deserializedHelloWorld == null) {
+            throw new RuntimeException("invalid value");
+        }
         expected = "hello world";
-        Assert.assertEquals(expected, deserialized);
+        Assert.assertEquals(expected, deserializedHelloWorld);
 
         header = getHeader(ListJsonSchema.ListJsonSchema1.getInstance());
-        deserialized = header.deserialize(List.of("blue", "black", "brown"), false, configuration);
+        var deserializedList = header.deserialize(List.of("blue", "black", "brown"), false, configuration);
+        if (deserializedList == null) {
+            throw new RuntimeException("invalid value");
+        }
         expected = List.of("blue", "black", "brown");
-        Assert.assertEquals(expected, deserialized);
+        Assert.assertEquals(expected, deserializedList);
     }
 }

samples/client/petstore/java/.gitignore

@@ -0,0 +1,9 @@
+build/
+.gradle/
+.idea/
+target/
+
+# gradle wrapper
+gradlew
+gradlew.bat
+gradle/

samples/client/petstore/java/.openapi-generator/FILES

@@ -1,4 +1,6 @@
+.gitignore
 README.md
+build.gradle.kts
 docs/RootServerInfo.md
 docs/apis/paths/Anotherfakedummy.md
 docs/apis/paths/Commonparamsubdir.md
@@ -751,7 +753,7 @@ docs/servers/RootServer1.md
 docs/servers/RootServer2.md
 docs/servers/rootserver0/RootServer0Variables.md
 docs/servers/rootserver1/RootServer1Variables.md
-pom.xml
+settings.gradle.kts
 src/main/java/org/openapijsonschematools/client/RootServerInfo.java
 src/main/java/org/openapijsonschematools/client/apiclient/ApiClient.java
 src/main/java/org/openapijsonschematools/client/apis/paths/Anotherfakedummy.java

samples/client/petstore/java/README.md

@@ -10,50 +10,32 @@ This Java package is automatically generated by the [OpenAPI JSON Schema Generat
 ## Requirements
 
 1. Java 17
-2. Maven
+2. Gradle
 
 ## Installation
 
 To install the API client library to your local Maven repository, simply execute:
 
 ```shell
-mvn clean install
+gradle wrapper
+gradlew clean build
 ```
 
-To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
+### Gradle users
 
-```shell
-mvn clean deploy
-```
-
-Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
+Add this dependency to your project's build file:
 
-### Maven users
-
-Add this dependency to your project's POM:
-
-```xml
-<dependency>
-  <groupId>org.openapijsonschematools</groupId>
-  <artifactId>petstore</artifactId>
-  <version>1.0.0</version>
-  <scope>compile</scope>
-</dependency>
 ```
+repositories {
+    mavenCentral()     // Needed if the 'petstore' jar has been published to maven centra
+    mavenLocal()       // Needed if the 'petstore' jar has been published to the local maven repo
+}
 
-### Others
-
-At first generate the JAR by executing:
-
-```shell
-mvn clean package
+dependencies {
+     implementation "org.openapijsonschematools:petstore:1.0.0"
+}
 ```
 
-Then manually install the following JARs:
-
-- `target/petstore-1.0.0.jar`
-- `target/lib/*.jar`
-
 
 ## Usage Notes
 ### Validation, Immutability, and Data Type