Refactor Maven Runner build config #2911
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| package org.jetbrains.conventions | ||
|
|
||
| import org.gradle.kotlin.dsl.support.serviceOf | ||
|
|
||
| /** | ||
| * Utility for downloading and installing a Maven binary. | ||
| * | ||
| * Provides the `setupMavenProperties` extension that contains the default versions and locations | ||
| * of the Maven binary. | ||
| * | ||
| * The task [installMavenBinary] will download and unzip the Maven bianry. | ||
| */ | ||
|
|
||
| plugins { | ||
| base | ||
| } | ||
|
|
||
| abstract class SetupMavenProperties { | ||
| abstract val mavenVersion: Property<String> | ||
| abstract val mavenPluginToolsVersion: Property<String> | ||
| abstract val mavenBuildDir: DirectoryProperty | ||
|
|
||
| /** Directory that will contain the unpacked Apache Maven dependency */ | ||
| abstract val mavenInstallDir: DirectoryProperty | ||
|
|
||
| /** | ||
| * Path to the Maven executable. | ||
| * | ||
| * This should be different per OS: | ||
| * | ||
| * * Windows: `$mavenInstallDir/bin/mvn.cmd` | ||
| * * Unix: `$mavenInstallDir/bin/mvn` | ||
| */ | ||
| abstract val mvn: RegularFileProperty | ||
| } | ||
|
|
||
| val setupMavenProperties = | ||
| extensions.create("setupMavenProperties", SetupMavenProperties::class).apply { | ||
| mavenVersion.convention(providers.gradleProperty("mavenVersion")) | ||
| mavenPluginToolsVersion.convention(providers.gradleProperty("mavenPluginToolsVersion")) | ||
|
|
||
| mavenBuildDir.convention(layout.buildDirectory.dir("maven")) | ||
| mavenInstallDir.convention(layout.buildDirectory.dir("apache-maven")) | ||
|
|
||
| val isWindowsProvider = | ||
| providers.systemProperty("os.name").map { "win" in it.toLowerCase() } | ||
|
|
||
| mvn.convention( | ||
| providers.zip(mavenInstallDir, isWindowsProvider) { mavenInstallDir, isWindows -> | ||
| mavenInstallDir.file( | ||
| when { | ||
| isWindows -> "bin/mvn.cmd" | ||
| else -> "bin/mvn" | ||
| } | ||
| ) | ||
| } | ||
| ) | ||
| } | ||
|
|
||
| val mavenBinary by configurations.registering { | ||
| description = "used to download the Maven binary" | ||
| isCanBeResolved = true | ||
| isCanBeConsumed = false | ||
| isVisible = false | ||
|
|
||
| defaultDependencies { | ||
| addLater(setupMavenProperties.mavenVersion.map { mavenVersion -> | ||
| project.dependencies.create( | ||
| group = "org.apache.maven", | ||
| name = "apache-maven", | ||
| version = mavenVersion, | ||
| classifier = "bin", | ||
| ext = "zip" | ||
| ) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| tasks.clean { | ||
| delete(setupMavenProperties.mavenBuildDir) | ||
| delete(setupMavenProperties.mavenInstallDir) | ||
| } | ||
|
|
||
| val installMavenBinary by tasks.registering(Sync::class) { | ||
| val archives = serviceOf<ArchiveOperations>() | ||
| from( | ||
| mavenBinary.flatMap { conf -> | ||
| @Suppress("UnstableApiUsage") | ||
| val resolvedArtifacts = conf.incoming.artifacts.resolvedArtifacts | ||
|
|
||
| resolvedArtifacts.map { artifacts -> | ||
| artifacts.map { archives.zipTree(it.file) } | ||
| } | ||
| } | ||
| ) { | ||
| eachFile { | ||
| // drop the first directory inside the zipped Maven bin (apache-maven-$version) | ||
| relativePath = RelativePath(true, *relativePath.segments.drop(1).toTypedArray()) | ||
| } | ||
| includeEmptyDirs = false | ||
| } | ||
| into(setupMavenProperties.mavenInstallDir) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of using a cross-project dependency to re-use the Maven exec, just download it again.
Gradle will cache the downloaded dependency, so it's fine to set it up twice in different subprojects.