Migrate injection scripts to use gradle.startParameter.systemPropertyArgs

Author: erichaagdev

build.gradle.kts

@@ -167,6 +167,7 @@ val copyGradleScripts by tasks.registering(Sync::class) {
     from(develocityInjectionResolvable) {
         rename { "develocity-injection.gradle" }
         into("lib/scripts/gradle-init-scripts")
+        filter(TransformDevelocityInjectionScript())
     }
     from(layout.projectDirectory.dir("components/scripts")) {
         include("README.md")

buildSrc/src/main/kotlin/TransformDevelocityInjectionScript.kt

@@ -0,0 +1,27 @@
+/*
+ * Transforms usages of 'System.getProperty' in the Develocity injection script
+ * to 'gradle.startParameter'. This is required because 'System.getProperty'
+ * cannot be used to reliably read system properties from init scripts in Gradle
+ * 7.0.2 and earlier.
+*/
+class TransformDevelocityInjectionScript : (String) -> String {
+
+    override fun invoke(content: String): String {
+        return content
+            .replace("static getInputParam(String name) {", "def getInputParam = { String name ->")
+            .replace("System.getProperty(name)", "gradle.startParameter.systemPropertiesArgs[name]")
+
+            // The 'getInputParam' method is no longer static so it must be redefined within the
+            // 'enableDevelocityInjection' method
+            .replace("void enableDevelocityInjection() {", """
+            void enableDevelocityInjection() {
+                def getInputParam = { String name ->
+                    def ENV_VAR_PREFIX = ''
+                    def envVarName = ENV_VAR_PREFIX + name.toUpperCase().replace('.', '_').replace('-', '_')
+                    return gradle.startParameter.systemPropertiesArgs[name] ?: System.getenv(envVarName)
+                }
+
+        """.trimIndent())
+    }
+
+}

components/scripts/gradle/gradle-init-scripts/configure-build-validation.gradle

@@ -1,10 +1,10 @@
 import org.gradle.util.GradleVersion
 import java.nio.charset.StandardCharsets
 
-static getInputParam(String name) {
+def getInputParam = { String name ->
     def ENV_VAR_PREFIX = ''
     def envVarName = ENV_VAR_PREFIX + name.toUpperCase().replace('.', '_').replace('-', '_')
-    return System.getProperty(name) ?: System.getenv(envVarName)
+    return gradle.startParameter.systemPropertiesArgs[name] ?: System.getenv(envVarName)
 }
 
 def isTopLevelBuild = !gradle.parent
@@ -34,12 +34,16 @@ def registerBuildScanActions = { def buildScan, def rootProjectName ->
         // the configuration of the build, and given its value changes between consecutive build invocations
         // it would always invalidate the configuration cache model from the first build invocation
         // in the second build invocation
-        def getInputParam = { String name ->
-            def ENV_VAR_PREFIX = ''
-            def envVarName = ENV_VAR_PREFIX + name.toUpperCase().replace('.', '_').replace('-', '_')
+        //
+        // System.getProperty can be used here because system properties can be read at *execution* time
+        // safely for Gradle 7.0.2 and earlier, and we must do so anyway because referencing a Gradle
+        // script object, e.g., 'gradle.startParameter', from a Groovy closure is not compatible with
+        // configuration cache
+        def getRunNumInputParam = { String name ->
+            def envVarName = name.toUpperCase().replace('.', '_').replace('-', '_')
             return System.getProperty(name) ?: System.getenv(envVarName)
         }
-        def runNum = getInputParam('develocity.build-validation.runNum')
+        def runNum = getRunNumInputParam('develocity.build-validation.runNum')
         def buildScanUri = publishedBuildScan.buildScanUri
         def buildScanId = publishedBuildScan.buildScanId
         def port = (buildScanUri.port != -1) ? ':' + buildScanUri.port : ''

components/scripts/gradle/gradle-init-scripts/configure-local-build-caching.gradle

@@ -1,7 +1,7 @@
-static getInputParam(String name) {
+def getInputParam = { String name ->
     def ENV_VAR_PREFIX = ''
     def envVarName = ENV_VAR_PREFIX + name.toUpperCase().replace('.', '_').replace('-', '_')
-    return System.getProperty(name) ?: System.getenv(envVarName)
+    return gradle.startParameter.systemPropertiesArgs[name] ?: System.getenv(envVarName)
 }
 
 def expDir = getInputParam('develocity.build-validation.expDir')

components/scripts/gradle/gradle-init-scripts/configure-remote-build-caching.gradle

@@ -1,7 +1,7 @@
-static getInputParam(String name) {
+def getInputParam = { String name ->
     def ENV_VAR_PREFIX = ''
     def envVarName = ENV_VAR_PREFIX + name.toUpperCase().replace('.', '_').replace('-', '_')
-    return System.getProperty(name) ?: System.getenv(envVarName)
+    return gradle.startParameter.systemPropertiesArgs[name] ?: System.getenv(envVarName)
 }
 
 def remoteBuildCacheUrl = getInputParam('develocity.build-validation.remoteBuildCacheUrl')