Skip to content
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.

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

Inject TargetJvmVersion attr for GMM #1199

Merged
merged 6 commits into from
Jan 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
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
4 changes: 4 additions & 0 deletions src/docs/changes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@

## [Unreleased]

**Added**

- Inject `TargetJvmVersion` attribute for Gradle Module Metadata. ([#1199](https://github.com/GradleUp/shadow/pull/1199))

**Changed**

- Update start script templates. ([#1183](https://github.com/GradleUp/shadow/pull/1183))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,60 @@ class PublishingTest : BasePluginTest() {
archiveClassifier = ''
archiveBaseName = 'maven-all'
""".trimIndent(),
),
) + System.lineSeparator(),
)

publish()

assertShadowJarCommon(repoJarPath("shadow/maven-all/1.0/maven-all-1.0.jar"))
assertPomCommon(repoPath("shadow/maven-all/1.0/maven-all-1.0.pom"))
assertShadowVariantCommon(gmmAdapter.fromJson(repoPath("shadow/maven-all/1.0/maven-all-1.0.module")))
val assertions = { variantAttrs: Array<Pair<String, String>>? ->
assertShadowJarCommon(repoJarPath("shadow/maven-all/1.0/maven-all-1.0.jar"))
assertPomCommon(repoPath("shadow/maven-all/1.0/maven-all-1.0.pom"))
val gmm = gmmAdapter.fromJson(repoPath("shadow/maven-all/1.0/maven-all-1.0.module"))
if (variantAttrs == null) {
assertShadowVariantCommon(gmm)
} else {
assertShadowVariantCommon(gmm, variantAttrs = variantAttrs)
}
}

assertions(null)

val attrsWithoutTargetJvm = shadowVariantAttrs.filterNot { (name, _) ->
name == TargetJvmVersion.TARGET_JVM_VERSION_ATTRIBUTE.name
}.toTypedArray()
val targetJvmAttr17 = TargetJvmVersion.TARGET_JVM_VERSION_ATTRIBUTE.name to "17"
val targetJvmAttr11 = TargetJvmVersion.TARGET_JVM_VERSION_ATTRIBUTE.name to "11"

projectScriptPath.appendText(
"""
java {
toolchain.languageVersion = JavaLanguageVersion.of(17)
}
""".trimIndent() + System.lineSeparator(),
)
publish()
assertions(attrsWithoutTargetJvm + targetJvmAttr17)

projectScriptPath.appendText(
"""
java {
targetCompatibility = JavaVersion.VERSION_11
}
""".trimIndent() + System.lineSeparator(),
)
publish()
assertions(attrsWithoutTargetJvm + targetJvmAttr11)

projectScriptPath.appendText(
"""
java {
sourceCompatibility = JavaVersion.VERSION_1_8
}
""".trimIndent() + System.lineSeparator(),
)
publish()
// sourceCompatibility doesn't affect the target JVM version.
assertions(attrsWithoutTargetJvm + targetJvmAttr11)
}

@Test
Expand Down Expand Up @@ -265,10 +311,6 @@ class PublishingTest : BasePluginTest() {
projectBlock = """
group = 'com.acme'
version = '1.0'
java {
// This is necessary for `org.gradle.jvm.version` to be pinned on Java 8 for `components.java` MavenPublication.
targetCompatibility = JavaVersion.VERSION_1_8
}
""".trimIndent(),
dependenciesBlock = """
implementation 'shadow:a:1.0'
Expand Down Expand Up @@ -310,7 +352,6 @@ class PublishingTest : BasePluginTest() {
*commonVariantAttrs,
Bundling.BUNDLING_ATTRIBUTE.name to Bundling.EXTERNAL,
Usage.USAGE_ATTRIBUTE.name to Usage.JAVA_API,
TargetJvmVersion.TARGET_JVM_VERSION_ATTRIBUTE.name to JavaVersion.VERSION_1_8.majorVersion,
)
transform { it.gavs }.isEmpty()
}
Expand All @@ -319,7 +360,6 @@ class PublishingTest : BasePluginTest() {
*commonVariantAttrs,
Bundling.BUNDLING_ATTRIBUTE.name to Bundling.EXTERNAL,
Usage.USAGE_ATTRIBUTE.name to Usage.JAVA_RUNTIME,
TargetJvmVersion.TARGET_JVM_VERSION_ATTRIBUTE.name to JavaVersion.VERSION_1_8.majorVersion,
)
transform { it.gavs }.containsOnly(
"shadow:a:1.0",
Expand Down Expand Up @@ -404,15 +444,12 @@ class PublishingTest : BasePluginTest() {

private fun assertShadowVariantCommon(
gmm: GradleModuleMetadata,
variantAttrs: Array<Pair<String, String>> = shadowVariantAttrs,
gavs: Array<String> = arrayOf("shadow:b:1.0"),
body: Assert<GradleModuleMetadata.Variant>.() -> Unit = {},
) {
assertThat(gmm.shadowRuntimeElementsVariant).all {
transform { it.attributes }.containsOnly(
*commonVariantAttrs,
Bundling.BUNDLING_ATTRIBUTE.name to Bundling.SHADOWED,
Usage.USAGE_ATTRIBUTE.name to Usage.JAVA_RUNTIME,
)
transform { it.attributes }.containsOnly(*variantAttrs)
transform { it.gavs }.containsOnly(*gavs)
body()
}
Expand All @@ -439,6 +476,12 @@ class PublishingTest : BasePluginTest() {
val commonVariantAttrs = arrayOf(
Category.CATEGORY_ATTRIBUTE.name to Category.LIBRARY,
LibraryElements.LIBRARY_ELEMENTS_ATTRIBUTE.name to LibraryElements.JAR,
TargetJvmVersion.TARGET_JVM_VERSION_ATTRIBUTE.name to JavaVersion.current().majorVersion,
)

val shadowVariantAttrs = commonVariantAttrs + arrayOf(
Bundling.BUNDLING_ATTRIBUTE.name to Bundling.SHADOWED,
Usage.USAGE_ATTRIBUTE.name to Usage.JAVA_RUNTIME,
)

fun MavenXpp3Reader.read(path: Path): Model = path.inputStream().use { read(it) }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@ import org.gradle.api.attributes.Bundling
import org.gradle.api.attributes.Category
import org.gradle.api.attributes.LibraryElements
import org.gradle.api.attributes.Usage
import org.gradle.api.attributes.java.TargetJvmVersion
import org.gradle.api.component.AdhocComponentWithVariants
import org.gradle.api.component.SoftwareComponentFactory
import org.gradle.api.plugins.JavaPlugin
import org.gradle.api.plugins.JavaPluginExtension
import org.gradle.api.tasks.SourceSetContainer
import org.gradle.api.tasks.TaskProvider
import org.gradle.jvm.tasks.Jar
Expand Down Expand Up @@ -42,6 +44,11 @@ public abstract class ShadowJavaPlugin @Inject constructor(
project.objects.named(LibraryElements::class.java, LibraryElements.JAR),
)
attr.attribute(Bundling.BUNDLING_ATTRIBUTE, project.objects.named(Bundling::class.java, Bundling.SHADOWED))
val targetJvmVersion = project.provider {
project.extensions.getByType(JavaPluginExtension::class.java).targetCompatibility.majorVersion.toInt()
}
// Track JavaPluginExtension to update targetJvmVersion when it changes.
attr.attributeProvider(TargetJvmVersion.TARGET_JVM_VERSION_ATTRIBUTE, targetJvmVersion)
}
it.outgoing.artifact(shadowTaskProvider)
}
Expand Down