Fix: Add clear error message and terminate spring boot application properly after error

This fix includes the following
Add support for clear error message
After an error shutdown the spring boot application properly
Updates to Readme
Add support for publishing the plugin to gradle plugin portal.

Author: Ramesh KP

README.md

@@ -1,4 +1,5 @@
-#**Introduction to springdoc-openapi-gradle-plugin**
+# **Introduction to springdoc-openapi-gradle-plugin**
+
 Spring Docs Open API Gradle Plugin - Generates OpenAPI-3 specification docs for spring boot application
 
 This Gradle plugin provides the capability to generate OpenAPI-3 specification docs for spring boot application from a Gradle build. 
@@ -84,7 +85,7 @@ Parameter | Description | Required | Default
 `apiDocsUrl` |  The url from where the open api docs can be downloaded | No | http://localhost:8080/v3/api-docs
 `outputDir` | The output directory where the generated open api file would be placed | No | $buildDir - Your projects build dir
 `outputFileName` | The name of the output file with extension | No | openapi.json
-`waitTimeInSeconds` | Time to wait in seconds for your spring boot application to start, before we make calls to `apiDocsUrl` to download the openapi docs | No | 10 seconds
+`waitTimeInSeconds` | Time to wait in seconds for your spring boot application to start, before we make calls to `apiDocsUrl` to download the openapi docs | No | 30 seconds
 
 # Building the plugin
 

build.gradle.kts

@@ -1,11 +1,12 @@
 plugins {
     `java-gradle-plugin`
+    id("com.gradle.plugin-publish") version "0.10.1"
     kotlin("jvm") version "1.3.61"
     `maven-publish`
 }
 
 group = "org.springdoc"
-version = "1.0-SNAPSHOT"
+version = "0.0.1-BETA"
 
 repositories {
     mavenCentral()
@@ -32,19 +33,27 @@ dependencies {
     implementation(kotlin("reflect"))
     implementation(group = "khttp", name = "khttp", version = "1.0.0")
     implementation(group = "com.google.code.gson", name = "gson", version = "2.8.6")
-    implementation(group = "com.jayway.awaitility", name = "awaitility", version = "1.7.0")
+    implementation(group = "org.awaitility", name = "awaitility-kotlin", version = "4.0.2")
     implementation(files("/home/ramesh/gradle-processes/build/libs/gradle-processes-0.5.0.jar"))
 }
 
 gradlePlugin {
     plugins {
         create("springdoc-gradle-plugin") {
             id = "org.springdoc.openapi-gradle-plugin"
+            displayName = "Spring Docs OpenApi Gradle plugin"
+            description = " This plugin generates json OpenAPI description during build time"
             implementationClass = "org.springdoc.openapi.gradle.plugin.OpenApiGradlePlugin"
         }
     }
 }
 
+pluginBundle {
+    website = "https://github.com/springdoc/springdoc-openapi-gradle-plugin"
+    vcsUrl = "https://github.com/springdoc/springdoc-openapi-gradle-plugin.git"
+    tags = listOf("SpringDocs", "OpenApi", "SwaggerDocs")
+}
+
 tasks {
     compileKotlin {
         kotlinOptions.jvmTarget = "1.8"

src/main/kotlin/org/springdoc/openapi/gradle/plugin/Constants.kt

@@ -9,7 +9,7 @@ const val FORKED_SPRING_BOOT_RUN_TASK_NAME = "forkedSpringBootRun"
 
 const val DEFAULT_API_DOCS_URL = "http://localhost:8080/v3/api-docs"
 const val DEFAULT_OPEN_API_FILE_NAME = "openapi.json"
-const val DEFAULT_WAIT_TIME_IN_SECONDS = 10
+const val DEFAULT_WAIT_TIME_IN_SECONDS = 30
 
 const val SPRING_BOOT_PLUGIN = "org.springframework.boot"
 const val PROCESS_PLUGIN = "com.github.johnrengelman.processes"

src/main/kotlin/org/springdoc/openapi/gradle/plugin/OpenApiGeneratorTask.kt

@@ -2,26 +2,30 @@ package org.springdoc.openapi.gradle.plugin
 
 import com.google.gson.GsonBuilder
 import com.google.gson.JsonObject
-import com.jayway.awaitility.core.ConditionTimeoutException
 import khttp.responses.Response
+import org.awaitility.Durations
+import org.awaitility.core.ConditionTimeoutException
+import org.awaitility.kotlin.*
 import org.gradle.api.DefaultTask
-import org.gradle.api.GradleException
 import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.provider.Property
 import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.OutputDirectory
 import org.gradle.api.tasks.TaskAction
-import org.slf4j.LoggerFactory
+import java.net.ConnectException
+import java.time.Duration
+import java.time.temporal.ChronoUnit.SECONDS
+
 
 open class OpenApiGeneratorTask: DefaultTask() {
-    private val LOGGER = LoggerFactory.getLogger(OpenApiGeneratorTask::class.java)
     @get:Input
     val apiDocsUrl: Property<String> = project.objects.property(String::class.java)
     @get:Input
     val outputFileName: Property<String> = project.objects.property(String::class.java)
     @get:OutputDirectory
     val outputDir: DirectoryProperty = project.objects.directoryProperty()
     private val waitTimeInSeconds: Property<Int> = project.objects.property(Int::class.java)
+    val taskError: Property<String> = project.objects.property(String::class.java)
 
     init {
         description = OPEN_API_TASK_DESCRIPTION
@@ -35,6 +39,7 @@ open class OpenApiGeneratorTask: DefaultTask() {
         val defaultOutputDir = project.objects.directoryProperty()
         defaultOutputDir.set(project.buildDir)
 
+        taskError.set("")
         apiDocsUrl.set(extension.apiDocsUrl.getOrElse(DEFAULT_API_DOCS_URL))
         outputFileName.set(extension.outputFileName.getOrElse(DEFAULT_OPEN_API_FILE_NAME))
         outputDir.set(extension.outputDir.getOrElse(defaultOutputDir.get()))
@@ -44,17 +49,21 @@ open class OpenApiGeneratorTask: DefaultTask() {
     @TaskAction
     fun execute() {
         try {
-            // I need to change this later on to use a smart logic to wait only for required time
-            Thread.sleep(waitTimeInSeconds.get().toLong() * 1000)
+            await ignoreException ConnectException::class withPollInterval Durations.ONE_SECOND atMost Duration.of(waitTimeInSeconds.get().toLong(), SECONDS) until {
+                val statusCode = khttp.get(apiDocsUrl.get()).statusCode
+                logger.trace("apiDocsUrl = {} status code = {}", apiDocsUrl.get(), statusCode)
+                statusCode < 299
+            }
+            logger.info("Generating OpenApi Docs..")
             val response: Response = khttp.get(apiDocsUrl.get())
             val gson = GsonBuilder().setPrettyPrinting().create();
             val googleJsonObject = gson.fromJson(response.jsonObject.toString(), JsonObject::class.java)
 
             val outputFile = outputDir.file(outputFileName.get()).get().asFile
             outputFile.writeText(gson.toJson(googleJsonObject))
         } catch (e: ConditionTimeoutException) {
-            LOGGER.error("Unable to connect to ${apiDocsUrl.get()} waited for ${waitTimeInSeconds.get()} seconds")
-            throw GradleException("Timeout occurred while trying to connect to ${apiDocsUrl.get()}")
+            taskError.set("Timeout occurred while trying to connect to ${apiDocsUrl.get()}")
+            this.logger.error("Unable to connect to ${apiDocsUrl.get()} waited for ${waitTimeInSeconds.get()} seconds", e)
         }
     }
 

src/main/kotlin/org/springdoc/openapi/gradle/plugin/OpenApiGradlePlugin.kt

@@ -1,6 +1,7 @@
 package org.springdoc.openapi.gradle.plugin
 
 import com.github.jengelman.gradle.plugins.processes.tasks.Fork
+import org.gradle.api.GradleException
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.slf4j.LoggerFactory
@@ -31,10 +32,14 @@ open class OpenApiGradlePlugin: Plugin<Project> {
             }
 
             // This is my task. Before I can run it I have to run the dependent tasks
-            val openApiGeneratorTask  = project.tasks.register(OPEN__API_TASK_NAME, OpenApiGeneratorTask::class.java) {
-                it.dependsOn(forkedSpringBoot)
-                it.doLast {
+            val openApiGeneratorTask  = project.tasks.register(OPEN__API_TASK_NAME, OpenApiGeneratorTask::class.java) { openApiGenTask ->
+                openApiGenTask.dependsOn(forkedSpringBoot)
+
+                openApiGenTask.doLast {
                     forkedSpringBoot.get().processHandle.abort()
+                    if (openApiGenTask.taskError.get().isNotBlank()) {
+                        throw GradleException(openApiGenTask.taskError.get())
+                    }
                 }
             }
         }