Merge pull request #103 from Sineaggi/fix-gradle-issues

Fix a few gradle issues

Author: bnasslahsen

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

@@ -1,35 +1,37 @@
 package org.springdoc.openapi.gradle.plugin
 
 import org.gradle.api.Action
-import org.gradle.api.Project
 import org.gradle.api.file.ConfigurableFileCollection
 import org.gradle.api.file.DirectoryProperty
-import org.gradle.api.file.RegularFileProperty
+import org.gradle.api.file.ProjectLayout
+import org.gradle.api.model.ObjectFactory
 import org.gradle.api.provider.ListProperty
 import org.gradle.api.provider.MapProperty
 import org.gradle.api.provider.Property
 import javax.inject.Inject
 
-open class OpenApiExtension @Inject constructor(project: Project) {
-    val apiDocsUrl: Property<String> = project.objects.property(String::class.java)
-    val outputFileName: Property<String> = project.objects.property(String::class.java)
-    val outputDir: DirectoryProperty = project.objects.directoryProperty()
-    val waitTimeInSeconds: Property<Int> = project.objects.property(Int::class.java)
-    val groupedApiMappings: MapProperty<String, String> = project.objects.mapProperty(String::class.java, String::class.java)
-    val customBootRun: CustomBootRunAction = project.objects.newInstance(CustomBootRunAction::class.java, project)
+open class OpenApiExtension @Inject constructor(
+    objects: ObjectFactory,
+) {
+    val apiDocsUrl: Property<String> = objects.property(String::class.java)
+    val outputFileName: Property<String> = objects.property(String::class.java)
+    val outputDir: DirectoryProperty = objects.directoryProperty()
+    val waitTimeInSeconds: Property<Int> = objects.property(Int::class.java)
+    val groupedApiMappings: MapProperty<String, String> = objects.mapProperty(String::class.java, String::class.java)
+    val customBootRun: CustomBootRunAction = objects.newInstance(CustomBootRunAction::class.java)
     fun customBootRun(action: Action<CustomBootRunAction>) {
         action.execute(customBootRun)
     }
 }
 
 open class CustomBootRunAction @Inject constructor(
-    project: Project,
+    objects: ObjectFactory,
 ) {
-    val systemProperties: MapProperty<String, Any> = project.objects.mapProperty(String::class.java, Any::class.java)
-    val workingDir: RegularFileProperty = project.objects.fileProperty()
-    val mainClass: Property<String> = project.objects.property(String::class.java)
-    val args: ListProperty<String> = project.objects.listProperty(String::class.java)
-    val classpath: ConfigurableFileCollection = project.objects.fileCollection()
-    val jvmArgs: ListProperty<String> = project.objects.listProperty(String::class.java)
-    val environment: MapProperty<String, Any> = project.objects.mapProperty(String::class.java, Any::class.java)
+    val systemProperties: MapProperty<String, Any> = objects.mapProperty(String::class.java, Any::class.java)
+    val workingDir: DirectoryProperty = objects.directoryProperty()
+    val mainClass: Property<String> = objects.property(String::class.java)
+    val args: ListProperty<String> = objects.listProperty(String::class.java)
+    val classpath: ConfigurableFileCollection = objects.fileCollection()
+    val jvmArgs: ListProperty<String> = objects.listProperty(String::class.java)
+    val environment: MapProperty<String, Any> = objects.mapProperty(String::class.java, Any::class.java)
 }

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

@@ -40,17 +40,17 @@ open class OpenApiGeneratorTask : DefaultTask() {
         description = OPEN_API_TASK_DESCRIPTION
         group = GROUP_NAME
         // load my extensions
-        val extension: OpenApiExtension = project.extensions.run { getByName(EXTENSION_NAME) as OpenApiExtension }
+        val extension: OpenApiExtension = project.extensions.getByName(EXTENSION_NAME) as OpenApiExtension
 
         // set a default value if not provided
         val defaultOutputDir = project.objects.directoryProperty()
-        defaultOutputDir.set(project.buildDir)
+        defaultOutputDir.convention(project.layout.buildDirectory.dir("openapi"))
 
-        apiDocsUrl.set(extension.apiDocsUrl.getOrElse(DEFAULT_API_DOCS_URL))
-        outputFileName.set(extension.outputFileName.getOrElse(DEFAULT_OPEN_API_FILE_NAME))
-        groupedApiMappings.set(extension.groupedApiMappings.getOrElse(emptyMap()))
-        outputDir.set(extension.outputDir.getOrElse(defaultOutputDir.get()))
-        waitTimeInSeconds.set(extension.waitTimeInSeconds.getOrElse(DEFAULT_WAIT_TIME_IN_SECONDS))
+        apiDocsUrl.convention(extension.apiDocsUrl.getOrElse(DEFAULT_API_DOCS_URL))
+        outputFileName.convention(extension.outputFileName.getOrElse(DEFAULT_OPEN_API_FILE_NAME))
+        groupedApiMappings.convention(extension.groupedApiMappings.getOrElse(emptyMap()))
+        outputDir.convention(extension.outputDir.getOrElse(defaultOutputDir.get()))
+        waitTimeInSeconds.convention(extension.waitTimeInSeconds.getOrElse(DEFAULT_WAIT_TIME_IN_SECONDS))
     }
 
     @TaskAction

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

@@ -18,7 +18,9 @@ open class OpenApiGradlePlugin : Plugin<Project> {
             plugins.apply(SPRING_BOOT_PLUGIN)
             plugins.apply(EXEC_FORK_PLUGIN)
 
-            extensions.create(EXTENSION_NAME, OpenApiExtension::class.java, this)
+            extensions.create(EXTENSION_NAME, OpenApiExtension::class.java)
+            tasks.register(FORKED_SPRING_BOOT_RUN_TASK_NAME, JavaExecFork::class.java)
+            tasks.register(OPEN_API_TASK_NAME, OpenApiGeneratorTask::class.java)
 
             afterEvaluate { generate(this) }
         }
@@ -30,24 +32,24 @@ open class OpenApiGradlePlugin : Plugin<Project> {
         // The task, used to run the Spring Boot application (`bootRun`)
         val bootRunTask = tasks.named(SPRING_BOOT_RUN_TASK_NAME)
         // The task, used to resolve the application's main class (`bootRunMainClassName`)
-        val bootRunMainClassNameTask = tasks.find { it.name ==  SPRING_BOOT_RUN_MAIN_CLASS_NAME_TASK_NAME}
-            ?:tasks.named(SPRING_BOOT_3_RUN_MAIN_CLASS_NAME_TASK_NAME)
+        val bootRunMainClassNameTask = tasks.find { it.name == SPRING_BOOT_RUN_MAIN_CLASS_NAME_TASK_NAME }
+            ?: tasks.named(SPRING_BOOT_3_RUN_MAIN_CLASS_NAME_TASK_NAME)
 
         val extension = extensions.findByName(EXTENSION_NAME) as OpenApiExtension
         val customBootRun = extension.customBootRun
         // Create a forked version spring boot run task
-        val forkedSpringBoot = tasks.register(FORKED_SPRING_BOOT_RUN_TASK_NAME, JavaExecFork::class.java) { fork ->
+        val forkedSpringBoot = tasks.named(FORKED_SPRING_BOOT_RUN_TASK_NAME, JavaExecFork::class.java) { fork ->
             fork.dependsOn(bootRunMainClassNameTask)
             fork.onlyIf { needToFork(bootRunTask, customBootRun, fork) }
         }
 
         // This is my task. Before I can run it, I have to run the dependent tasks
-        tasks.register(OPEN_API_TASK_NAME, OpenApiGeneratorTask::class.java) {
+        val openApiTask = tasks.named(OPEN_API_TASK_NAME, OpenApiGeneratorTask::class.java) {
             it.dependsOn(forkedSpringBoot)
         }
 
         // The forked task need to be terminated as soon as my task is finished
-        forkedSpringBoot.get().stopAfter = tasks.named(OPEN_API_TASK_NAME)
+        forkedSpringBoot.get().stopAfter = openApiTask as TaskProvider<Task>
     }
 
     private fun Project.springBoot3CompatibilityCheck() {
@@ -75,7 +77,7 @@ open class OpenApiGradlePlugin : Plugin<Project> {
 
             // use original bootRun parameter if the list-type customBootRun properties are empty
             workingDir = customBootRun.workingDir.asFile.orNull
-                ?: bootRun.workingDir
+                ?: fork.temporaryDir
             args = customBootRun.args.orNull?.takeIf { it.isNotEmpty() }?.toMutableList()
                 ?: bootRun.args?.toMutableList() ?: mutableListOf()
             classpath = customBootRun.classpath.takeIf { !it.isEmpty }