Skip to content

feat(workers): Include GradleDefinitions in the GradleInitGenerator #3130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat(workers): Include GradleDefinitions in the GradleInitGenerator #3130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 19 additions & 6 deletions workers/common/src/main/kotlin/common/env/GradleInitGenerator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,14 +65,27 @@ class GradleInitGenerator : EnvironmentConfigGenerator<GradleDefinition> {
builder.buildInUserHome(TARGET_NAME) {
val repositories = buildList {
builder.adminConfig.mavenCentralMirror?.let { mirror ->
add(
GradleRepositoryEntry(
mirror.url,
mirror.usernameSecret?.let { builder.infraSecretResolverFun(Path(it)) },
mirror.passwordSecret?.let { builder.infraSecretResolverFun(Path(it)) }
val isOverridden = definitions.any { it.service.url == mirror.url }
if (!isOverridden) {
add(
GradleRepositoryEntry(
mirror.url,
mirror.usernameSecret?.let { builder.infraSecretResolverFun(Path(it)) },
mirror.passwordSecret?.let { builder.infraSecretResolverFun(Path(it)) }
)
)
)
}
}

addAll(
definitions.map { definition ->
GradleRepositoryEntry(
definition.service.url,
builder.secretRef(definition.service.usernameSecret),
builder.secretRef(definition.service.passwordSecret)
)
}
)
}

if (repositories.isNotEmpty()) {
Expand Down
309 changes: 309 additions & 0 deletions workers/common/src/test/kotlin/common/env/GradleInitGeneratorTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,315 @@ class GradleInitGeneratorTest : WordSpec({
mockBuilder.homeFileName shouldBe ".gradle/init.gradle.kts"
}

"generate repositories blocks from definitions" {
val secUser1 = MockConfigFileBuilder.createSecret("user1Secret")
val secPass1 = MockConfigFileBuilder.createSecret("pass1Secret")
val secUser2 = MockConfigFileBuilder.createSecret("user2Secret")
val secPass2 = MockConfigFileBuilder.createSecret("pass2Secret")

val definition1 = GradleDefinition(
MockConfigFileBuilder.createInfrastructureService("https://repo1.example.org", secUser1, secPass1),
emptySet()
)

val definition2 = GradleDefinition(
MockConfigFileBuilder.createInfrastructureService("https://repo2.example.org", secUser2, secPass2),
emptySet()
)

val mockBuilder = MockConfigFileBuilder()

GradleInitGenerator().generate(mockBuilder.builder, listOf(definition1, definition2))

val expectedContent = """
allprojects {
repositories {
maven {
url = uri("https://repo1.example.org")
credentials {
username = "${MockConfigFileBuilder.testSecretRef(secUser1)}"
password = "${MockConfigFileBuilder.testSecretRef(secPass1)}"
}
}
maven {
url = uri("https://repo2.example.org")
credentials {
username = "${MockConfigFileBuilder.testSecretRef(secUser2)}"
password = "${MockConfigFileBuilder.testSecretRef(secPass2)}"
}
}
}

buildscript {
repositories {
maven {
url = uri("https://repo1.example.org")
credentials {
username = "${MockConfigFileBuilder.testSecretRef(secUser1)}"
password = "${MockConfigFileBuilder.testSecretRef(secPass1)}"
}
}
maven {
url = uri("https://repo2.example.org")
credentials {
username = "${MockConfigFileBuilder.testSecretRef(secUser2)}"
password = "${MockConfigFileBuilder.testSecretRef(secPass2)}"
}
}
}
}
}

settingsEvaluated {
settings.pluginManagement {
repositories {
maven {
url = uri("https://repo1.example.org")
credentials {
username = "${MockConfigFileBuilder.testSecretRef(secUser1)}"
password = "${MockConfigFileBuilder.testSecretRef(secPass1)}"
}
}
maven {
url = uri("https://repo2.example.org")
credentials {
username = "${MockConfigFileBuilder.testSecretRef(secUser2)}"
password = "${MockConfigFileBuilder.testSecretRef(secPass2)}"
}
}
gradlePluginPortal()
}
}

settings.dependencyResolutionManagement {
repositories {
maven {
url = uri("https://repo1.example.org")
credentials {
username = "${MockConfigFileBuilder.testSecretRef(secUser1)}"
password = "${MockConfigFileBuilder.testSecretRef(secPass1)}"
}
}
maven {
url = uri("https://repo2.example.org")
credentials {
username = "${MockConfigFileBuilder.testSecretRef(secUser2)}"
password = "${MockConfigFileBuilder.testSecretRef(secPass2)}"
}
}
}
}
}

""".trimIndent()

val content = mockBuilder.generatedText()
content shouldBe expectedContent
}

"generate repositories section for both GradleDefinition and MavenCentralMirror if URL differs" {
val secUser = MockConfigFileBuilder.createSecret("userSecret")
val secPass = MockConfigFileBuilder.createSecret("passSecret")

val definition1 = GradleDefinition(
MockConfigFileBuilder.createInfrastructureService("https://repo.example.org", secUser, secPass),
emptySet()
)

val username = "test-username"
val infraUsernameSecret = MockConfigFileBuilder.createSecret("infra-secret-username")
val password = "test-password"
val infraPasswordSecret = MockConfigFileBuilder.createSecret("infra-secret-password")
val mavenCentralMirror = MavenCentralMirror(
id = "central",
name = "Maven Central",
url = "https://different-repo.example.org",
mirrorOf = "central",
usernameSecret = infraUsernameSecret.name,
passwordSecret = infraPasswordSecret.name
)

val mockBuilder = MockConfigFileBuilder()
every { mockBuilder.infraSecretResolverFun.invoke(Path(infraUsernameSecret.path)) } returns username
every { mockBuilder.infraSecretResolverFun.invoke(Path(infraPasswordSecret.path)) } returns password
every { mockBuilder.adminConfig.mavenCentralMirror } returns mavenCentralMirror

GradleInitGenerator().generate(mockBuilder.builder, listOf(definition1))

val expectedContent = """
allprojects {
repositories {
maven {
url = uri("${mavenCentralMirror.url}")
credentials {
username = "$username"
password = "$password"
}
}
maven {
url = uri("https://repo.example.org")
credentials {
username = "${MockConfigFileBuilder.testSecretRef(secUser)}"
password = "${MockConfigFileBuilder.testSecretRef(secPass)}"
}
}
}

buildscript {
repositories {
maven {
url = uri("${mavenCentralMirror.url}")
credentials {
username = "$username"
password = "$password"
}
}
maven {
url = uri("https://repo.example.org")
credentials {
username = "${MockConfigFileBuilder.testSecretRef(secUser)}"
password = "${MockConfigFileBuilder.testSecretRef(secPass)}"
}
}
}
}
}

settingsEvaluated {
settings.pluginManagement {
repositories {
maven {
url = uri("${mavenCentralMirror.url}")
credentials {
username = "$username"
password = "$password"
}
}
maven {
url = uri("https://repo.example.org")
credentials {
username = "${MockConfigFileBuilder.testSecretRef(secUser)}"
password = "${MockConfigFileBuilder.testSecretRef(secPass)}"
}
}
gradlePluginPortal()
}
}

settings.dependencyResolutionManagement {
repositories {
maven {
url = uri("${mavenCentralMirror.url}")
credentials {
username = "$username"
password = "$password"
}
}
maven {
url = uri("https://repo.example.org")
credentials {
username = "${MockConfigFileBuilder.testSecretRef(secUser)}"
password = "${MockConfigFileBuilder.testSecretRef(secPass)}"
}
}
}
}
}

""".trimIndent()

val content = mockBuilder.generatedText()
content shouldBe expectedContent
}

"prefer GradleDefinition over MavenCentralMirror if URLs match" {
val repositoryUrl = "https://repo.example.org"
val secUser = MockConfigFileBuilder.createSecret("userSecret")
val secPass = MockConfigFileBuilder.createSecret("passSecret")

val definition1 = GradleDefinition(
MockConfigFileBuilder.createInfrastructureService(repositoryUrl, secUser, secPass),
emptySet()
)

val username = "test-username"
val infraUsernameSecret = MockConfigFileBuilder.createSecret("infra-secret-username")
val password = "test-password"
val infraPasswordSecret = MockConfigFileBuilder.createSecret("infra-secret-password")
val mavenCentralMirror = MavenCentralMirror(
id = "central",
name = "Maven Central",
url = repositoryUrl,
mirrorOf = "central",
usernameSecret = infraUsernameSecret.name,
passwordSecret = infraPasswordSecret.name
)

val mockBuilder = MockConfigFileBuilder()
every { mockBuilder.infraSecretResolverFun.invoke(Path(infraUsernameSecret.path)) } returns username
every { mockBuilder.infraSecretResolverFun.invoke(Path(infraPasswordSecret.path)) } returns password
every { mockBuilder.adminConfig.mavenCentralMirror } returns mavenCentralMirror

GradleInitGenerator().generate(mockBuilder.builder, listOf(definition1))

val expectedContent = """
allprojects {
repositories {
maven {
url = uri("$repositoryUrl")
credentials {
username = "${MockConfigFileBuilder.testSecretRef(secUser)}"
password = "${MockConfigFileBuilder.testSecretRef(secPass)}"
}
}
}

buildscript {
repositories {
maven {
url = uri("$repositoryUrl")
credentials {
username = "${MockConfigFileBuilder.testSecretRef(secUser)}"
password = "${MockConfigFileBuilder.testSecretRef(secPass)}"
}
}
}
}
}

settingsEvaluated {
settings.pluginManagement {
repositories {
maven {
url = uri("$repositoryUrl")
credentials {
username = "${MockConfigFileBuilder.testSecretRef(secUser)}"
password = "${MockConfigFileBuilder.testSecretRef(secPass)}"
}
}
gradlePluginPortal()
}
}

settings.dependencyResolutionManagement {
repositories {
maven {
url = uri("$repositoryUrl")
credentials {
username = "${MockConfigFileBuilder.testSecretRef(secUser)}"
password = "${MockConfigFileBuilder.testSecretRef(secPass)}"
}
}
}
}
}

""".trimIndent()

val content = mockBuilder.generatedText()
content shouldBe expectedContent
}

"generate an empty file if MavenCentralMirror is null" {
val mockBuilder = MockConfigFileBuilder()

Expand Down