Feature/javaPlayWithAsynchronousControllers (#7705)

* Add property 'supportAsync' to allow the use of CompletionStage of java8

* Add support for completionStage in play-framework templates

* Add script to generate samples for play-framework async controllers

* Add generated samples for java play framework with asynchronous controllers

* Add missing templates and generate samples

* Remove useless comments from generated samples in play framework async

* Fix ControllerImp template for java play framework

* Add script for java play framework async to general script

* Regenerate java play framework server samples

* Fix missing whitespace

* Fix unnecessary blank lines at imports

* Fix tabulation issue

* Fix tabulation issue in controllers

* Remove blanks from api Imp

* Remove more empty lines

* Add blank between methods

* Remove blanks before call to service method

* Fix some tabulations in java play async templates

* Regenerate samples for java play async

Author: ignaciomolina

bin/java-play-framework-petstore-server-all.sh

@@ -8,4 +8,5 @@
 ./bin/java-play-framework-petstore-server-no-swagger-ui.sh
 ./bin/java-play-framework-petstore-server-no-wrap-calls.sh
 ./bin/java-play-framework-petstore-server-fake-endpoints.sh
-./bin/java-play-framework-petstore-server-api-package-override.sh
+./bin/java-play-framework-petstore-server-api-package-override.sh
+./bin/java-play-framework-petstore-server-async.sh

bin/java-play-framework-petstore-server-async.json

@@ -0,0 +1,5 @@
+{
+	"additionalProperties" : {
+		"supportAsync" : true
+	}
+}

bin/java-play-framework-petstore-server-async.sh

@@ -0,0 +1,31 @@
+#!/bin/sh
+
+SCRIPT="$0"
+
+while [ -h "$SCRIPT" ] ; do
+  ls=`ls -ld "$SCRIPT"`
+  link=`expr "$ls" : '.*-> \(.*\)$'`
+  if expr "$link" : '/.*' > /dev/null; then
+    SCRIPT="$link"
+  else
+    SCRIPT=`dirname "$SCRIPT"`/"$link"
+  fi
+done
+
+if [ ! -d "${APP_DIR}" ]; then
+  APP_DIR=`dirname "$SCRIPT"`/..
+  APP_DIR=`cd "${APP_DIR}"; pwd`
+fi
+
+executable="./modules/swagger-codegen-cli/target/swagger-codegen-cli.jar"
+
+if [ ! -f "$executable" ]
+then
+  mvn clean package
+fi
+
+# if you've executed sbt assembly previously it will use that instead.
+export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
+ags="$@ generate -t modules/swagger-codegen/src/main/resources/JavaPlayFramework -i modules/swagger-codegen/src/test/resources/2_0/petstore.yaml -l java-play-framework -c bin/java-play-framework-petstore-server-async.json -o samples/server/petstore/java-play-framework-async -DhideGenerationTimestamp=true"
+
+java $JAVA_OPTS -jar $executable $ags

modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AbstractJavaCodegen.java

@@ -51,10 +51,12 @@ public abstract class AbstractJavaCodegen extends DefaultCodegen implements Code
     public static final String DEFAULT_LIBRARY = "<default>";
     public static final String DATE_LIBRARY = "dateLibrary";
     public static final String JAVA8_MODE = "java8";
+    public static final String SUPPORT_ASYNC = "supportAsync";
     public static final String WITH_XML = "withXml";
     public static final String SUPPORT_JAVA6 = "supportJava6";
 
     protected String dateLibrary = "threetenbp";
+    protected boolean supportAsync = false;
     protected boolean java8Mode = false;
     protected boolean withXml = false;
     protected String invokerPackage = "io.swagger";
@@ -173,7 +175,6 @@ public AbstractJavaCodegen() {
         java8ModeOptions.put("false", "Various third party libraries as needed");
         java8Mode.setEnum(java8ModeOptions);
         cliOptions.add(java8Mode);
-
     }
 
     @Override
@@ -381,14 +382,21 @@ public void processOpts() {
         // used later in recursive import in postProcessingModels
         importMapping.put("com.fasterxml.jackson.annotation.JsonProperty", "com.fasterxml.jackson.annotation.JsonCreator");
 
-        if(additionalProperties.containsKey(JAVA8_MODE)) {
+        if (additionalProperties.containsKey(JAVA8_MODE)) {
             setJava8Mode(Boolean.parseBoolean(additionalProperties.get(JAVA8_MODE).toString()));
             if ( java8Mode ) {
                 additionalProperties.put("java8", "true");
             }
         }
 
-        if(additionalProperties.containsKey(WITH_XML)) {
+        if (additionalProperties.containsKey(SUPPORT_ASYNC)) {
+            setSupportAsync(Boolean.parseBoolean(additionalProperties.get(SUPPORT_ASYNC).toString()));
+            if (supportAsync) {
+                additionalProperties.put(SUPPORT_ASYNC, "true");
+            }
+        }
+
+        if (additionalProperties.containsKey(WITH_XML)) {
             setWithXml(Boolean.parseBoolean(additionalProperties.get(WITH_XML).toString()));
             if ( withXml ) {
                 additionalProperties.put(WITH_XML, "true");
@@ -1217,6 +1225,10 @@ public void setJava8Mode(boolean enabled) {
         this.java8Mode = enabled;
     }
 
+    public void setSupportAsync(boolean enabled) {
+        this.supportAsync = enabled;
+    }
+
     @Override
     public String escapeQuotationMark(String input) {
         // remove " to avoid code injection

modules/swagger-codegen/src/main/resources/JavaPlayFramework/newApi.mustache

@@ -16,15 +16,21 @@ import javax.validation.constraints.*;
 public class {{classname}}ControllerImp {{#useInterfaces}}implements {{classname}}ControllerImpInterface{{/useInterfaces}} {
 {{#operation}}
     {{#useInterfaces}}@Override{{/useInterfaces}}
-    public {{>returnTypes}} {{operationId}}({{#allParams}}{{>pathParams}}{{>queryParams}}{{>bodyParams}}{{>formParams}}{{>headerParams}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) {{#handleExceptions}}throws Exception{{/handleExceptions}} {
+    public {{^returnType}}void{{/returnType}}{{#returnType}}{{#supportAsync}}CompletionStage<{{/supportAsync}}{{>returnTypesNoVoid}}{{#supportAsync}}>{{/supportAsync}}{{/returnType}} {{operationId}}({{#allParams}}{{>pathParams}}{{>queryParams}}{{>bodyParams}}{{>formParams}}{{>headerParams}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) {{#handleExceptions}}throws Exception{{/handleExceptions}} {
         //Do your magic!!!
         {{#returnType}}
+        {{#supportAsync}}
+        return CompletableFuture.supplyAsync(() -> {
+        {{/supportAsync}}
         {{#isResponseFile}}
         return new FileInputStream("replace this");
         {{/isResponseFile}}
         {{^isResponseFile}}
-        return new {{>returnTypesNoVoidNoAbstract}}({{#vendorExtensions.missingReturnInfoIfNeeded}}{{vendorExtensions.missingReturnInfoIfNeeded}}{{/vendorExtensions.missingReturnInfoIfNeeded}});
+        {{#supportAsync}}   {{/supportAsync}}return new {{>returnTypesNoVoidNoAbstract}}({{#vendorExtensions.missingReturnInfoIfNeeded}}{{vendorExtensions.missingReturnInfoIfNeeded}}{{/vendorExtensions.missingReturnInfoIfNeeded}});
         {{/isResponseFile}}
+        {{#supportAsync}}
+        });
+        {{/supportAsync}}
         {{/returnType}}
     }
 

modules/swagger-codegen/src/main/resources/JavaPlayFramework/newApiController.mustache

@@ -18,6 +18,11 @@ import java.io.IOException;
 {{/handleExceptions}}
 import swagger.SwaggerUtils;
 import com.fasterxml.jackson.core.type.TypeReference;
+{{#supportAsync}}
+
+import java.util.concurrent.CompletionStage;
+import java.util.concurrent.CompletableFuture;
+{{/supportAsync}}
 
 {{#useBeanValidation}}
 import javax.validation.constraints.*;
@@ -54,7 +59,7 @@ public class {{classname}}Controller extends Controller {
 {{#operation}}
 
     {{#wrapCalls}}@ApiAction{{/wrapCalls}}
-    public Result {{operationId}}({{#pathParams}}{{>pathParams}}{{#hasMore}},{{/hasMore}}{{/pathParams}}) {{^handleExceptions}}{{#bodyParams}}throws IOException{{/bodyParams}}{{/handleExceptions}}{{#handleExceptions}}throws Exception{{/handleExceptions}} {
+    public {{#supportAsync}}CompletionStage<{{/supportAsync}}Result{{#supportAsync}}>{{/supportAsync}} {{operationId}}({{#pathParams}}{{>pathParams}}{{#hasMore}},{{/hasMore}}{{/pathParams}}) {{^handleExceptions}}{{#bodyParams}}throws IOException{{/bodyParams}}{{/handleExceptions}}{{#handleExceptions}}throws Exception{{/handleExceptions}} {
         {{#bodyParams}}
         {{^collectionFormat}}
         JsonNode node{{paramName}} = request().body().asJson();
@@ -195,11 +200,17 @@ public class {{classname}}Controller extends Controller {
         {{/collectionFormat}}
         {{/headerParams}}
         {{^controllerOnly}}
-        {{#returnType}}{{>returnTypesNoVoid}} obj = {{/returnType}}imp.{{operationId}}({{#allParams}}{{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}});
+        {{^returnType}}
+        {{#supportAsync}}
+        return CompletableFuture.supplyAsync(() -> {
+        {{/supportAsync}}
+        {{/returnType}}
+        {{#returnType}}{{#supportAsync}}CompletionStage<{{>returnTypesNoVoid}}> stage = {{/supportAsync}}{{^supportAsync}}{{>returnTypesNoVoid}} obj = {{/supportAsync}}{{/returnType}}{{^returnType}}{{#supportAsync}}    {{/supportAsync}}{{/returnType}}imp.{{operationId}}({{#allParams}}{{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}){{#returnType}}{{#supportAsync}}.thenApply(obj -> { {{/supportAsync}}{{/returnType}}{{^supportAsync}};{{/supportAsync}}
         {{#returnType}}
         {{^isResponseFile}}
         {{^returnTypeIsPrimitive}}
         {{#useBeanValidation}}
+        {{^supportAsync}}
         if (configuration.getBoolean("useOutputBeanValidation")) {
             {{#isListContainer}}
             for ({{{returnType}}} curItem : obj) {
@@ -215,21 +226,50 @@ public class {{classname}}Controller extends Controller {
             SwaggerUtils.validate(obj);
             {{/returnContainer}}
         }
+        {{/supportAsync}}
+        {{#supportAsync}}
+            if (configuration.getBoolean("useOutputBeanValidation")) {
+                {{#isListContainer}}
+                for ({{{returnType}}} curItem : obj) {
+                    SwaggerUtils.validate(curItem);
+                }
+                {{/isListContainer}}
+                {{#isMapContainer}}
+                for (Map.Entry<String, {{{returnType}}}> entry : obj.entrySet()) {
+                    SwaggerUtils.validate(entry.getValue());
+                }
+                {{/isMapContainer}}
+                {{^returnContainer}}
+                SwaggerUtils.validate(obj);
+                {{/returnContainer}}
+            }
+        {{/supportAsync}}
         {{/useBeanValidation}}
         {{/returnTypeIsPrimitive}}
         {{/isResponseFile}}
+        {{#supportAsync}}
+            return obj;
+        });
+        {{/supportAsync}}
         {{/returnType}}
         {{#returnType}}
-        {{^isResponseFile}}JsonNode result = mapper.valueToTree(obj);
-        return ok(result);
+        {{#supportAsync}}
+        stage.thenApply(obj -> {
+        {{/supportAsync}}
+        {{^isResponseFile}}
+        {{#supportAsync}}    {{/supportAsync}}JsonNode result = mapper.valueToTree(obj);
+        {{#supportAsync}}    {{/supportAsync}}return ok(result);
         {{/isResponseFile}}
         {{#isResponseFile}}
-        return ok(obj);
+        {{#supportAsync}}    {{/supportAsync}}return ok(obj);
         {{/isResponseFile}}
         {{/returnType}}
         {{^returnType}}
-        return ok();
+        {{#supportAsync}}    {{/supportAsync}}return ok();
         {{/returnType}}
+        {{#supportAsync}}
+        });
+        {{/supportAsync}}
         {{/controllerOnly}}
         {{#controllerOnly}}
         return ok();

modules/swagger-codegen/src/main/resources/JavaPlayFramework/newApiInterface.mustache

@@ -7,6 +7,10 @@ import play.mvc.Http;
 import java.util.List;
 import java.util.ArrayList;
 import java.util.HashMap;
+{{#supportAsync}}
+import java.util.concurrent.CompletionStage;
+import java.util.concurrent.CompletableFuture;
+{{/supportAsync}}
 
 {{#useBeanValidation}}
 import javax.validation.constraints.*;
@@ -16,7 +20,7 @@ import javax.validation.constraints.*;
 @SuppressWarnings("RedundantThrows")
 public interface {{classname}}ControllerImpInterface {
 {{#operation}}
-    {{>returnTypes}} {{operationId}}({{#allParams}}{{>pathParams}}{{>queryParams}}{{>bodyParams}}{{>formParams}}{{>headerParams}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) {{#handleExceptions}}throws Exception{{/handleExceptions}};
+    {{^returnType}}void{{/returnType}}{{#returnType}}{{#supportAsync}}CompletionStage<{{/supportAsync}}{{>returnTypesNoVoid}}{{#supportAsync}}>{{/supportAsync}}{{/returnType}} {{operationId}}({{#allParams}}{{>pathParams}}{{>queryParams}}{{>bodyParams}}{{>formParams}}{{>headerParams}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) {{#handleExceptions}}throws Exception{{/handleExceptions}};
 
 {{/operation}}
 }

samples/server/petstore/java-play-framework-async/.swagger-codegen-ignore

@@ -0,0 +1,23 @@
+# Swagger Codegen Ignore
+# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

samples/server/petstore/java-play-framework-async/.swagger-codegen/VERSION

@@ -0,0 +1 @@
+2.4.0-SNAPSHOT

samples/server/petstore/java-play-framework-async/LICENSE

@@ -0,0 +1,8 @@
+This software is licensed under the Apache 2 license, quoted below.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with
+the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
+language governing permissions and limitations under the License.