Refactored configuring interface and annotate all public properties with task annotations to instrument Gradle when should rebuild custom distributions

piotrminkina · piotrminkina · commit 48021de5baeb · 2024-04-21T18:38:08.000+02:00
diff --git a/README.md b/README.md
@@ -71,7 +71,7 @@ Gradle automatically applies [init scripts](https://docs.gradle.org/current/user
      **mandatory settings:**
      * `gradleVersion` - base Gradle wrapper version
      * `customDistributionVersion` - custom distribution version (`project.version` is used by default)
-     * `customDistributionFileNameMapper` - a property of type [CustomDistributionNameMapper](./src/main/kotlin/tech/harmonysoft/oss/gradle/dist/config/CustomDistributionNameMapper.kt) which generates resulting custom distribution file name for the given parameters. *Note: it's necessary to specify this property or 'distributionNameMapper' property. It's an error to define the both/none of them*
+     * `customDistributionFileNameMapper` - a property of type [CustomDistributionNameMapper](./src/main/kotlin/tech/harmonysoft/oss/gradle/dist/config/CustomDistributionNameMapper.kt) which generates resulting custom distribution file name for the given parameters. *Note: it's necessary to specify this property or `distributionNameMapper` property. It's an error to define the both/none of them*
        * `gradleVersion` - base gradle distribution version as defined above
        * `customDistributionVersion` - custom distribution mixing version as defined above
        * `gradleDistributionType` - gradle distribution type as defined below
@@ -118,10 +118,13 @@ Gradle automatically applies [init scripts](https://docs.gradle.org/current/user
            }
        }
        ```
-     *Note: it's necessary to specify this property or 'customDistributionFileNameMapper' property. It's an error to define the both/none of them*
+       *Note: it's necessary to specify this property or `customDistributionFileNameMapper` property. It's an error to define the both/none of them*
+    
+    * `initScriptsSourceDir` - a path to the directory where your initialization scripts are located (see below docs for more details). The path to the directory must be set, and the pointed directory must exist. The default path is `src/main/resources/init.d`.
      
      **optional settings:**
-     * `gradleDistributionType` - allows to specify base Gradle distribution type. `bin` and `all` [are available](https://docs.gradle.org/current/userguide/gradle_wrapper.html#sec:adding_wrapper) at the moment, `bin` is used by default  
+     * `gradleDistributionType` - allows to specify base Gradle distribution type. `bin` and `all` [are available](https://docs.gradle.org/current/userguide/gradle_wrapper.html#sec:adding_wrapper) at the moment, `bin` is used by default
+     * `utilityScriptsSourceDir` - a path to the directory where your utility scripts and replacements are located (see below docs for more details). The path to the directory is optional, but the pointed directory must exist. The default path is `src/main/resources/include`.
      * `skipContentExpansionFor` - the plugin by default expands content of the files included into custom Gradle distribution by default (see below). That might cause a problem if we want to add some binary file like `*.jar` or `*.so`. This property holds a list of root paths relative to `init.d` which content shouldn't be expanded.  
        Example: consider the following project structure:
        ```
@@ -270,6 +273,16 @@ Gradle automatically applies [init scripts](https://docs.gradle.org/current/user
     
     The distribution(s) are located in the `build/gradle-dist`
 
+6. In addition, if you need, you can configure the properties of the `buildGradleDist` task, such as the path to the directory where downloaded Gradle distributions and built custom Gradle distributions should be located.  You can do this as follows:
+    ```groovy
+    import tech.harmonysoft.oss.gradle.dist.BuildCustomGradleDistributionTask
+   
+    tasks.named('buildGradleDist', BuildCustomGradleDistributionTask) {
+        gradleDownloadDir = project.layout.buildDirectory.dir('own-gradle-download') 
+        customDistributionOutputDir = project.layout.buildDirectory.dir('own-gradle-dist') 
+    }
+    ```
+
 ### Configure Client Project
 
 Just define your custom Gradle wrapper's location in the *gradle/wrapper/gradle-wrapper.properties* file:  
diff --git a/src/main/kotlin/tech/harmonysoft/oss/gradle/dist/BuildCustomGradleDistributionTask.kt b/src/main/kotlin/tech/harmonysoft/oss/gradle/dist/BuildCustomGradleDistributionTask.kt
@@ -5,7 +5,6 @@ import java.io.FileFilter
 import java.io.FileInputStream
 import java.io.FileOutputStream
 import java.net.URI
-import java.net.URL
 import java.nio.channels.Channels
 import java.nio.file.FileSystem
 import java.nio.file.FileSystems
@@ -14,72 +13,56 @@ import java.util.Properties
 import java.util.Stack
 import org.gradle.api.DefaultTask
 import org.gradle.api.file.DirectoryProperty
-import org.gradle.api.provider.Property
-import org.gradle.api.tasks.InputDirectory
 import org.gradle.api.tasks.Internal
-import org.gradle.api.tasks.Optional
+import org.gradle.api.tasks.Nested
 import org.gradle.api.tasks.OutputDirectory
 import org.gradle.api.tasks.TaskAction
 import org.gradle.tooling.BuildException
 import tech.harmonysoft.oss.gradle.dist.config.CustomGradleDistConfig
+import javax.inject.Inject
 
 @Suppress("LeakingThis")
-abstract class BuildCustomGradleDistributionTask : DefaultTask() {
+abstract class BuildCustomGradleDistributionTask @Inject constructor(
+    @get:Nested val config: CustomGradleDistConfig
+) : DefaultTask() {
 
     @get:Internal
-    abstract val config: Property<CustomGradleDistConfig>
-
-    @get:Internal
-    abstract val downloadRootDir: DirectoryProperty
-
-    @get:Optional
-    @get:InputDirectory
-    abstract val includeRootDir: DirectoryProperty
-
-    @get:InputDirectory
-    abstract val extensionsRootDir: DirectoryProperty
+    abstract val gradleDownloadDir: DirectoryProperty
 
     @get:OutputDirectory
-    abstract val customDistributionsRootDir: DirectoryProperty
+    abstract val customDistributionOutputDir: DirectoryProperty
 
     init {
-        downloadRootDir.convention(
-            project.layout.buildDirectory.dir("download")
+        gradleDownloadDir.convention(
+            project.layout.buildDirectory.dir("gradle-download")
         )
-        project.layout.projectDirectory.dir("src/main/resources/include").let {
-            if (it.asFile.exists()) includeRootDir.convention(it)
-        }
-        extensionsRootDir.convention(
-            project.layout.projectDirectory.dir("src/main/resources/init.d")
-        )
-        customDistributionsRootDir.convention(
+        customDistributionOutputDir.convention(
             project.layout.buildDirectory.dir("gradle-dist")
         )
     }
 
     @TaskAction
     fun build() {
-        val baseDistribution = getBaseGradleDistribution(config.get())
-        val customDistributionsDir = customDistributionsRootDir.get().asFile
+        val baseDistribution = getBaseGradleDistribution(config)
+        val customDistributionsDir = customDistributionOutputDir.get().asFile
         remove(customDistributionsDir)
         Files.createDirectories(customDistributionsDir.toPath())
 
-        val currentConfig = config.get()
         val replacements = prepareReplacements()
         val distributions = getDistributions()
         if (distributions.isEmpty()) {
             prepareCustomDistribution(
                 distribution = null,
                 baseDistribution = baseDistribution,
-                extension = currentConfig,
+                extension = config,
                 replacements = replacements
             )
         } else {
             for (distribution in distributions) {
                 prepareCustomDistribution(
                     distribution = distribution,
                     baseDistribution = baseDistribution,
-                    extension = currentConfig,
+                    extension = config,
                     replacements = replacements
                 )
             }
@@ -100,7 +83,7 @@ abstract class BuildCustomGradleDistributionTask : DefaultTask() {
     private fun doGetBaseGradleDistribution(extension: CustomGradleDistConfig): File {
         val gradleBaseName = "gradle-${extension.gradleVersion.get()}"
         val gradleZip = "$gradleBaseName-${extension.gradleDistributionType.get()}.zip"
-        val baseGradleArchive = downloadRootDir.map { it.file(gradleZip) }.get().asFile
+        val baseGradleArchive = gradleDownloadDir.map { it.file(gradleZip) }.get().asFile
         if (!baseGradleArchive.isFile) {
             val archiveDir = baseGradleArchive.parentFile
             if (!archiveDir.isDirectory) {
@@ -123,7 +106,7 @@ abstract class BuildCustomGradleDistributionTask : DefaultTask() {
     }
 
     private fun download(fromUrl: String, toFile: File) {
-        val from = Channels.newChannel(URL(fromUrl).openStream())
+        val from = Channels.newChannel(URI(fromUrl).toURL().openStream())
         project.logger.lifecycle("about to download a gradle distribution from $fromUrl to ${toFile.canonicalPath}")
         FileOutputStream(toFile).channel.use {
             it.transferFrom(from, 0, Long.MAX_VALUE)
@@ -149,8 +132,7 @@ abstract class BuildCustomGradleDistributionTask : DefaultTask() {
     }
 
     private fun getDistributions(): Collection<String> {
-        val extensionsRootDir = this.extensionsRootDir.get().asFile
-        val childDirectories = extensionsRootDir.listFiles(FileFilter { it.isDirectory })
+        val childDirectories = config.initScriptsSourceDir.get().asFile.listFiles(FileFilter { it.isDirectory })
         return if (childDirectories == null || childDirectories.size < 2) {
             project.logger.lifecycle("using a single custom gradle distribution")
             emptyList()
@@ -188,7 +170,8 @@ abstract class BuildCustomGradleDistributionTask : DefaultTask() {
     }
 
     private fun loadReplacementsFromFiles(): Map<String, RichValue> {
-        return includeRootDir.orNull
+        return config.utilityScriptsSourceDir
+            .orNull
             ?.asFile
             ?.listFiles()
             ?.filter {
@@ -325,7 +308,7 @@ abstract class BuildCustomGradleDistributionTask : DefaultTask() {
             gradleDistributionType = extension.gradleDistributionType.get(),
             distributionName = distribution
         ).toString()
-        val customDistributionsDir = customDistributionsRootDir.get().asFile
+        val customDistributionsDir = customDistributionOutputDir.get().asFile
         val result = File(customDistributionsDir, customDistributionFileName)
 
         copyBaseDistribution(baseDistribution, result)
@@ -387,14 +370,12 @@ abstract class BuildCustomGradleDistributionTask : DefaultTask() {
             mapOf("create" to "true")
         )
         .use { zipFileSystem ->
-            val extensionsRootDir = this.extensionsRootDir.get().asFile
-
-            extensionsRootDir.let { extensionsRootDir ->
+            config.initScriptsSourceDir.get().asFile.let { initScriptsSourceDir ->
                 addToZip(
                     zip = zipFileSystem,
                     includeRootDir = distribution?.let {
-                        File(extensionsRootDir, it)
-                    } ?: extensionsRootDir,
+                        File(initScriptsSourceDir, it)
+                    } ?: initScriptsSourceDir,
                     gradleVersion = gradleVersion,
                     pathsToExcludeFromContentExpansion = pathsToExcludeFromContentExpansion,
                     replacements = replacements
@@ -505,6 +486,6 @@ abstract class BuildCustomGradleDistributionTask : DefaultTask() {
 
     companion object {
         private val PATTERN = """\$(\S+)\$""".toRegex()
-        private val REPLACEMENTS_FILE_NAME = "replacements.properties"
+        private const val REPLACEMENTS_FILE_NAME = "replacements.properties"
     }
 }
diff --git a/src/main/kotlin/tech/harmonysoft/oss/gradle/dist/CustomGradleDistributionPlugin.kt b/src/main/kotlin/tech/harmonysoft/oss/gradle/dist/CustomGradleDistributionPlugin.kt
@@ -11,9 +11,11 @@ class CustomGradleDistributionPlugin : Plugin<Project> {
     override fun apply(project: Project) {
         val config = createAndConfigureExtension(project)
 
-        project.tasks.register("buildGradleDist", BuildCustomGradleDistributionTask::class.java) {
-            it.config.set(config)
-        }
+        project.tasks.register(
+            "buildGradleDist",
+            BuildCustomGradleDistributionTask::class.java,
+            config
+        )
         project.afterEvaluate {
             validateAndEnrich(config)
         }
@@ -28,6 +30,12 @@ class CustomGradleDistributionPlugin : Plugin<Project> {
             project.provider { project.version.toString() }
         )
         config.gradleDistributionType.convention("bin")
+        project.layout.projectDirectory.dir("src/main/resources/include").let {
+            if (it.asFile.exists()) config.utilityScriptsSourceDir.convention(it)
+        }
+        config.initScriptsSourceDir.convention(
+            project.layout.projectDirectory.dir("src/main/resources/init.d")
+        )
         config.skipContentExpansionFor.convention(emptyList())
         config.rootUrlMapper.convention(GradleUrlMapper { version, type ->
             "https://services.gradle.org/distributions/gradle-$version-${type}.zip"
diff --git a/src/main/kotlin/tech/harmonysoft/oss/gradle/dist/config/CustomGradleDistConfig.kt b/src/main/kotlin/tech/harmonysoft/oss/gradle/dist/config/CustomGradleDistConfig.kt
@@ -1,14 +1,42 @@
 package tech.harmonysoft.oss.gradle.dist.config
 
+import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.provider.Property
+import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.InputDirectory
+import org.gradle.api.tasks.Internal
+import org.gradle.api.tasks.Nested
+import org.gradle.api.tasks.Optional
 
 interface CustomGradleDistConfig {
 
+    @get:Input
     val gradleVersion: Property<String>
+
+    @get:Optional
+    @get:Input
     val customDistributionName: Property<String>
+
+    @get:Optional
+    @get:Nested
     val customDistributionFileNameMapper: Property<CustomDistributionNameMapper>
+
+    @get:Input
     val customDistributionVersion: Property<String>
+
+    @get:Input
     val gradleDistributionType: Property<String>
+
+    @get:Optional
+    @get:InputDirectory
+    val utilityScriptsSourceDir: DirectoryProperty
+
+    @get:InputDirectory
+    val initScriptsSourceDir: DirectoryProperty
+
+    @get:Input
     val skipContentExpansionFor: Property<Collection<String>>
+
+    @get:Internal
     val rootUrlMapper: Property<GradleUrlMapper>
-}
+}
diff --git a/src/test/kotlin/tech/harmonysoft/oss/gradle/dist/CustomGradleDistributionPluginTest.kt b/src/test/kotlin/tech/harmonysoft/oss/gradle/dist/CustomGradleDistributionPluginTest.kt
@@ -181,12 +181,12 @@ class CustomGradleDistributionPluginTest {
                 gradleVersion = "$GRADLE_VERSION"
                 customDistributionVersion = "$PROJECT_VERSION"
                 customDistributionName = "$PROJECT_NAME"
+                utilityScriptsSourceDir = project.layout.projectDirectory.dir("src/main/resources/own-include")
+                initScriptsSourceDir = project.layout.projectDirectory.dir("src/main/resources/own-init.d")
             }
             
             tasks.named<BuildCustomGradleDistributionTask>("buildGradleDist") {
-                includeRootDir = project.layout.projectDirectory.dir("src/main/resources/own-include")
-                extensionsRootDir = project.layout.projectDirectory.dir("src/main/resources/own-init.d")
-                customDistributionsRootDir = project.layout.buildDirectory.dir("own-gradle-dist")
+                customDistributionOutputDir = project.layout.buildDirectory.dir("own-gradle-dist")
             }
         """.trimIndent(), "build/own-gradle-dist")
         val expectedCustomDistributionFile = File(
@@ -444,7 +444,7 @@ class CustomGradleDistributionPluginTest {
     }
 
     private fun prepareGradleDistributionZip(projectRootDir: File) {
-        val downloadDir = File(projectRootDir, "build/download")
+        val downloadDir = File(projectRootDir, "build/gradle-download")
         Files.createDirectories(downloadDir.toPath())
         listOf("bin", "all").forEach {
             val zip = File(downloadDir, "gradle-${GRADLE_VERSION}-${it}.zip")
