Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Migrate injection scripts to use gradle.startParameter.systemProperty…
…Args
  • Loading branch information
erichaagdev committed Nov 20, 2024
commit 512bf7a3e430e79f507383e4d2cfc00430b8f34f
1 change: 1 addition & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
27 changes: 27 additions & 0 deletions buildSrc/src/main/kotlin/TransformDevelocityInjectionScript.kt
Original file line number Diff line number Diff line change
@@ -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())
}

}
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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 : ''
Expand Down
Original file line number Diff line number Diff line change
@@ -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')
Expand Down
Original file line number Diff line number Diff line change
@@ -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')
Expand Down