[gradle] Add recommendations to validate task (#5183)

* [gradle] Add recommendations to validate task

* Use current version of Gradle Plugin in build checks.

* Fix gradle project build version confusion in CI

* [gradle] Bump samples to 5.2.1 wrapper

Previously, the Gradle plugin was building in CI against
openapi-generator 4.2.0 and Gradle version 4.10.2. At some point, a
contribution was made with an API which is incomatible at 4.10.2 and due
to a release script error which pinned the local-spec version to release
4.2.0, we didn't notice this inconsistency.

This bumps the project to build against Gradle 5.2.1.

modules/openapi-generator-gradle-plugin/README.adoc

@@ -377,6 +377,11 @@ openApiGenerate {
 |None
 |The input specification to validate. Supports all formats supported by the Parser.
 
+|recommend
+|Boolean
+|true
+|Whether or not to offer recommendations related to the validated specification document.
+
 |===
 
 === openApiMeta
@@ -521,6 +526,7 @@ BUILD SUCCESSFUL in 0s
 ----
 openApiValidate {
    inputSpec = "/src/openapi-generator/modules/openapi-generator/src/test/resources/3_0/petstore.yaml"
+   recommend = true
 }
 ----
 

modules/openapi-generator-gradle-plugin/gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,6 @@
+#Thu Jan 30 22:14:34 EST 2020
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-all.zip
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-bin.zip
-zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME

modules/openapi-generator-gradle-plugin/pom.xml

@@ -96,6 +96,7 @@
                                 <task>clean</task>
                                 <task>assemble</task>
                                 <task>publishToMavenLocal</task>
+                                <task>publishPluginMavenPublicationToMavenLocal</task>
                             </tasks>
                         </configuration>
                     </execution>

modules/openapi-generator-gradle-plugin/samples/local-spec/build.gradle

@@ -28,6 +28,7 @@ openApiMeta {
 
 openApiValidate {
     inputSpec = "$rootDir/petstore-v3.0-invalid.yaml".toString()
+    recommend = true
 }
 
 // Builds a Kotlin client by default.

modules/openapi-generator-gradle-plugin/samples/local-spec/gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

modules/openapi-generator-gradle-plugin/samples/local-spec/gradlew

@@ -1,5 +1,21 @@
 #!/usr/bin/env sh
 
+#
+# Copyright 2015 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://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.
+#
+
 ##############################################################################
 ##
 ##  Gradle start up script for UN*X
@@ -28,7 +44,7 @@ APP_NAME="Gradle"
 APP_BASE_NAME=`basename "$0"`
 
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS=""
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD="maximum"
@@ -109,8 +125,8 @@ if $darwin; then
     GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
 fi
 
-# For Cygwin, switch paths to Windows format before running java
+# For Cygwin or MSYS, switch paths to Windows format before running java
-if $cygwin ; then
+if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
     APP_HOME=`cygpath --path --mixed "$APP_HOME"`
     CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
     JAVACMD=`cygpath --unix "$JAVACMD"`
@@ -138,19 +154,19 @@ if $cygwin ; then
         else
             eval `echo args$i`="\"$arg\""
         fi
-        i=$((i+1))
+        i=`expr $i + 1`
     done
     case $i in
-        (0) set -- ;;
+        0) set -- ;;
-        (1) set -- "$args0" ;;
+        1) set -- "$args0" ;;
-        (2) set -- "$args0" "$args1" ;;
+        2) set -- "$args0" "$args1" ;;
-        (3) set -- "$args0" "$args1" "$args2" ;;
+        3) set -- "$args0" "$args1" "$args2" ;;
-        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        4) set -- "$args0" "$args1" "$args2" "$args3" ;;
-        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
-        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
-        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
-        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
-        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+        9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
     esac
 fi
 
@@ -159,14 +175,9 @@ save () {
     for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
     echo " "
 }
-APP_ARGS=$(save "$@")
+APP_ARGS=`save "$@"`
 
 # Collect all arguments for the java command, following the shell quoting and substitution rules
 eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
 
-# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
-if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
-  cd "$(dirname "$0")"
-fi
-
 exec "$JAVACMD" "$@"

modules/openapi-generator-gradle-plugin/samples/local-spec/gradlew.bat

@@ -1,3 +1,19 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem      https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
 @if "%DEBUG%" == "" @echo off
 @rem ##########################################################################
 @rem
@@ -14,7 +30,7 @@ set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
 @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-set DEFAULT_JVM_OPTS=
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
 
 @rem Find java.exe
 if defined JAVA_HOME goto findJavaFromJavaHome

modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/OpenApiGeneratorPlugin.kt

@@ -84,6 +84,7 @@ class OpenApiGeneratorPlugin : Plugin<Project> {
                     description = "Validates an Open API 2.0 or 3.x specification document."
 
                     inputSpec.set(validate.inputSpec)
+                    recommend.set(validate.recommend)
                 }
 
                 create("openApiGenerate", GenerateTask::class.java) {

modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/extensions/OpenApiGeneratorValidateExtension.kt

@@ -29,4 +29,18 @@ open class OpenApiGeneratorValidateExtension(project: Project) {
      * The input specification to validate. Supports all formats supported by the Parser.
      */
     val inputSpec = project.objects.property<String>()
+
+    /**
+     * Whether or not to offer recommendations related to the validated specification document.
+     */
+    val recommend = project.objects.property<Boolean?>()
+
+    init {
+        applyDefaults()
+    }
+
+    @Suppress("MemberVisibilityCanBePrivate")
+    fun applyDefaults(){
+        recommend.set(true)
+    }
 }

modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/ValidateTask.kt

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+@file:Suppress("UnstableApiUsage")
+
 package org.openapitools.generator.gradle.plugin.tasks
 
 import io.swagger.parser.OpenAPIParser
@@ -22,9 +24,12 @@ import org.gradle.api.GradleException
 import org.gradle.api.tasks.Internal
 import org.gradle.api.tasks.TaskAction
 import org.gradle.api.tasks.options.Option
+import org.gradle.api.logging.Logging
 import org.gradle.internal.logging.text.StyledTextOutput
 import org.gradle.internal.logging.text.StyledTextOutputFactory
 import org.gradle.kotlin.dsl.property
+import org.openapitools.codegen.validations.oas.OpenApiEvaluator
+import org.openapitools.codegen.validations.oas.RuleConfiguration
 
 /**
  * A generator which validates an Open API spec. This task outputs a list of validation issues and errors.
@@ -46,6 +51,9 @@ open class ValidateTask : DefaultTask() {
     @get:Internal
     var inputSpec = project.objects.property<String>()
 
+    @get:Internal
+    var recommend = project.objects.property<Boolean?>()
+
     @Suppress("unused")
     @get:Internal
     @set:Option(option = "input", description = "The input specification.")
@@ -57,13 +65,35 @@ open class ValidateTask : DefaultTask() {
     @Suppress("unused")
     @TaskAction
     fun doWork() {
+        val logger = Logging.getLogger(javaClass)
+
         val spec = inputSpec.get()
+        val recommendations = recommend.get()
+
         logger.quiet("Validating spec $spec")
         val result = OpenAPIParser().readLocation(spec, null, null)
         val messages = result.messages.toSet()
         val out = services.get(StyledTextOutputFactory::class.java).create("openapi")
 
-        if (messages.isNotEmpty()) {
+
+        val ruleConfiguration = RuleConfiguration()
+        ruleConfiguration.isEnableRecommendations = recommendations
+
+        val evaluator = OpenApiEvaluator(ruleConfiguration)
+        val validationResult = evaluator.validate(result.openAPI)
+
+        if (validationResult.warnings.isNotEmpty()) {
+            out.withStyle(StyledTextOutput.Style.Info)
+            out.println("\nSpec has issues or recommendations.\nIssues:\n")
+
+            validationResult.warnings.forEach {
+                out.withStyle(StyledTextOutput.Style.Info)
+                out.println("\t${it.message}\n")
+                logger.debug("WARNING: ${it.message}|${it.details}")
+            }
+        }
+
+        if (messages.isNotEmpty() || validationResult.errors.isNotEmpty()) {
 
             out.withStyle(StyledTextOutput.Style.Error)
             out.println("\nSpec is invalid.\nIssues:\n")
@@ -71,11 +101,19 @@ open class ValidateTask : DefaultTask() {
             messages.forEach {
                 out.withStyle(StyledTextOutput.Style.Error)
                 out.println("\t$it\n")
+                logger.debug("ERROR: $it")
+            }
+
+            validationResult.errors.forEach {
+                out.withStyle(StyledTextOutput.Style.Error)
+                out.println("\t${it.message}\n")
+                logger.debug("ERROR: ${it.message}|${it.details}")
             }
 
             throw GradleException("Validation failed.")
         } else {
             out.withStyle(StyledTextOutput.Style.Success)
+            logger.debug("No error validations from swagger-parser or internal validations.")
             out.println("Spec is valid.")
         }
     }