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.

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

Jump to bottom

Handle inconsistent vendor info for IBM Semeru runtimes (backport) #23094

Merged
merged 4 commits into from Dec 15, 2022
Merged

Handle inconsistent vendor info for IBM Semeru runtimes (backport) #23094

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0a7f478
Consider IBM and IBM_SEMERU vendors identical, deprecate the later
jbartok Dec 10, 2022
25e4fa7
Fix test
jbartok Dec 12, 2022
d5fae0c
Fix deprecation message
jbartok Dec 14, 2022
55896a8
Reformat to one sentence per line
jbartok Dec 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 0 additions & 1 deletion subprojects/docs/src/docs/userguide/jvm/toolchains.adoc
View file
Open in desktop
Expand Up @@ -387,7 +387,6 @@ Sorting is done based on the following rules:
.. GRAAL_VM
.. HEWLETT_PACKARD
.. IBM
.. IBM_SEMERU
.. MICROSOFT
.. ORACLE
.. SAP
Expand Down
109 changes: 72 additions & 37 deletions subprojects/docs/src/docs/userguide/migration/upgrading_version_7.adoc
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion subprojects/docs/src/snippets/java/toolchain-filters/groovy/build.gradle
View file
Open in desktop
Expand Up @@ -25,7 +25,7 @@ java {
java {
toolchain {
languageVersion = JavaLanguageVersion.of(11)
vendor = JvmVendorSpec.IBM_SEMERU
vendor = JvmVendorSpec.IBM
implementation = JvmImplementation.J9
}
}
Expand Down
2 changes: 1 addition & 1 deletion subprojects/docs/src/snippets/java/toolchain-filters/kotlin/build.gradle.kts
View file
Open in desktop
Expand Up @@ -26,7 +26,7 @@ java {
java {
toolchain {
languageVersion.set(JavaLanguageVersion.of(11))
vendor.set(JvmVendorSpec.IBM_SEMERU)
vendor.set(JvmVendorSpec.IBM)
implementation.set(JvmImplementation.J9)
}
}
Expand Down
3 changes: 1 addition & 2 deletions subprojects/jvm-services/src/main/java/org/gradle/internal/jvm/inspection/JvmVendor.java
View file
Open in desktop
Expand Up @@ -29,8 +29,7 @@ enum KnownJvmVendor {
BELLSOFT("bellsoft", "BellSoft Liberica"),
GRAAL_VM("graalvm community", "GraalVM Community"),
HEWLETT_PACKARD("hewlett-packard", "HP-UX"),
IBM("ibm", "IBM"),
IBM_SEMERU("international business machines corporation", "IBM Semeru Runtimes"),
IBM("ibm", "ibm|international business machines corporation", "IBM"),
MICROSOFT("microsoft", "Microsoft"),
ORACLE("oracle", "Oracle"),
SAP("sap se", "SAP SapMachine"),
Expand Down
48 changes: 35 additions & 13 deletions .../src/test/groovy/org/gradle/internal/jvm/inspection/DefaultJvmMetadataDetectorTest.groovy
View file
Open in desktop
Expand Up @@ -120,12 +120,9 @@ class DefaultJvmMetadataDetectorTest extends Specification {
'temurinjdk17' | temurinJvm('17') | JavaVersion.VERSION_17 | 'Eclipse Temurin JDK 17' | false
'temurinjre8' | temurin8Jvm('8') | JavaVersion.VERSION_1_8 | 'Eclipse Temurin JRE 8' | true
'temurinjre11' | temurin11Jvm('11') | JavaVersion.VERSION_11 | 'Eclipse Temurin JRE 11' | true
'semerujdk8' | semeruJvm('8') | JavaVersion.VERSION_1_8 | 'IBM Semeru Runtimes JDK 8' | false
'semerujdk11' | semeruJvm('11') | JavaVersion.VERSION_11 | 'IBM Semeru Runtimes JDK 11' | false
'semerujdk16' | semeruJvm('16') | JavaVersion.VERSION_16 | 'IBM Semeru Runtimes JDK 16' | false
'semerujre8' | semeruJvm('8') | JavaVersion.VERSION_1_8 | 'IBM Semeru Runtimes JRE 8' | true
'semerujre11' | semeruJvm('11') | JavaVersion.VERSION_11 | 'IBM Semeru Runtimes JRE 11' | true
'semerujre16' | semeruJvm('16') | JavaVersion.VERSION_16 | 'IBM Semeru Runtimes JRE 16' | true
'semerujdk11' | semeruJvm11() | JavaVersion.VERSION_11 | 'IBM JDK 11' | false
'semerujdk16' | semeruJvm16() | JavaVersion.VERSION_16 | 'IBM JDK 16' | false
'semerujdk17' | semeruJvm17() | JavaVersion.VERSION_17 | 'IBM JDK 17' | false
'whitespaces' | whitespaces('11.0.3') | JavaVersion.VERSION_11 | 'AdoptOpenJDK JRE 11' | true
}

Expand Down Expand Up @@ -154,9 +151,8 @@ class DefaultJvmMetadataDetectorTest extends Specification {
'ibmJdk7' | ibmJvm('7') | true
'ibmJdk8' | ibmJvm('8') | true
'ibmJdk9' | ibmJvm('9') | true
'semeru8' | semeruJvm('8') | true
'semeru11' | semeruJvm('11') | true
'semeru16' | semeruJvm('16') | true
'semeru11' | semeruJvm11() | true
'semeru16' | semeruJvm16() | true
'temurin8' | temurin8Jvm('8') | false
'temurin11' | temurin11Jvm('11') | false
'temurin17' | temurinJvm('17') | false
Expand Down Expand Up @@ -436,16 +432,42 @@ class DefaultJvmMetadataDetectorTest extends Specification {
]
}

private static Map<String, String> semeruJvm(String version) {
private static Map<String, String> semeruJvm11() {
['java.home': "java-home",
'java.version': "${version}",
'java.version': "11.0.17",
'java.vendor': "IBM Corporation",
'os.arch': "x86_64",
'java.vm.name': "Eclipse OpenJ9 VM",
'java.vm.version': "openj9-0.35.0",
'java.vm.vendor': "Eclipse OpenJ9",
'java.runtime.name': "IBM Semeru Runtime Open Edition",
'java.runtime.version': "11.0.17+8"
]
}

private static Map<String, String> semeruJvm16() {
['java.home': "java-home",
'java.version': "16.0.2",
'java.vendor': "International Business Machines Corporation",
'os.arch': "x86_64",
'java.vm.name': "Eclipse OpenJ9 VM",
'java.vm.version': "openj9-0.27.0",
'java.vm.vendor': "International Business Machines Corporation",
'java.vm.vendor': "Eclipse OpenJ9",
'java.runtime.name': "IBM Semeru Runtime Open Edition",
'java.runtime.version': "${version}-b08"
'java.runtime.version': "16.0.2+7"
]
}

private static Map<String, String> semeruJvm17() {
['java.home': "java-home",
'java.version': "17.0.5",
'java.vendor': "IBM Corporation",
'os.arch': "x86_64",
'java.vm.name': "Eclipse OpenJ9 VM",
'java.vm.version': "openj9-0.35.0",
'java.vm.vendor': "Eclipse OpenJ9",
'java.runtime.name': "IBM Semeru Runtime Open Edition",
'java.runtime.version': "17.0.5+8"
]
}

Expand Down
6 changes: 3 additions & 3 deletions ...src/integTest/groovy/org/gradle/jvm/toolchain/JavaToolchainDownloadIntegrationTest.groovy
View file
Open in desktop
Expand Up @@ -241,14 +241,14 @@ class JavaToolchainDownloadIntegrationTest extends AbstractIntegrationSpec {
}

@ToBeFixedForConfigurationCache(because = "Fails the build with an additional error")
def 'toolchain download of Semeru forces openj9'() {
def 'toolchain download of IBM forces openj9'() {
buildFile << """
apply plugin: "java"

java {
toolchain {
languageVersion = JavaLanguageVersion.of(99)
vendor = JvmVendorSpec.IBM_SEMERU
vendor = JvmVendorSpec.IBM
}
}
"""
Expand All @@ -274,7 +274,7 @@ class JavaToolchainDownloadIntegrationTest extends AbstractIntegrationSpec {
then:
failure.assertHasDescription("Execution failed for task ':compileJava'.")
.assertHasCause("Failed to calculate the value of task ':compileJava' property 'javaCompiler'")
.assertHasCause("Unable to download toolchain matching the requirements ({languageVersion=99, vendor=IBM_SEMERU, implementation=vendor-specific}) from 'https://example.com/v3/binary/latest/99/ga/${os()}/${architecture()}/jdk/openj9/normal/adoptopenjdk'.")
.assertHasCause("Unable to download toolchain matching the requirements ({languageVersion=99, vendor=IBM, implementation=vendor-specific}) from 'https://example.com/v3/binary/latest/99/ga/${os()}/${architecture()}/jdk/openj9/normal/adoptopenjdk'.")
.assertHasCause("Could not read 'https://example.com/v3/binary/latest/99/ga/${os()}/${architecture()}/jdk/openj9/normal/adoptopenjdk' as it does not exist.")
}

Expand Down
14 changes: 12 additions & 2 deletions subprojects/platform-jvm/src/main/java/org/gradle/jvm/toolchain/JvmVendorSpec.java
View file
Open in desktop
Expand Up @@ -34,10 +34,15 @@ public abstract class JvmVendorSpec {
*/
@Incubating
public static final JvmVendorSpec ADOPTIUM = matching(KnownJvmVendor.ADOPTIUM);

public static final JvmVendorSpec ADOPTOPENJDK = matching(KnownJvmVendor.ADOPTOPENJDK);

public static final JvmVendorSpec AMAZON = matching(KnownJvmVendor.AMAZON);

public static final JvmVendorSpec APPLE = matching(KnownJvmVendor.APPLE);

public static final JvmVendorSpec AZUL = matching(KnownJvmVendor.AZUL);

public static final JvmVendorSpec BELLSOFT = matching(KnownJvmVendor.BELLSOFT);

/**
Expand All @@ -49,14 +54,17 @@ public abstract class JvmVendorSpec {
public static final JvmVendorSpec GRAAL_VM = matching(KnownJvmVendor.GRAAL_VM);

public static final JvmVendorSpec HEWLETT_PACKARD = matching(KnownJvmVendor.HEWLETT_PACKARD);

public static final JvmVendorSpec IBM = matching(KnownJvmVendor.IBM);

/**
* A constant for using <a href="https://developer.ibm.com/languages/java/semeru-runtimes/">IBM Semeru Runtimes</a> as the JVM vendor.
*
* @since 7.4
* @deprecated We are grouping all IBM runtimes under the '{@code IBM}' vendor, won't keep a separate constant for Semeru ones. Just use '{@code IBM}' instead.
*/
@Incubating
public static final JvmVendorSpec IBM_SEMERU = matching(KnownJvmVendor.IBM_SEMERU);
@Deprecated
public static final JvmVendorSpec IBM_SEMERU = IBM;

/**
* A constant for using <a href="https://www.microsoft.com/openjdk">Microsoft OpenJDK</a> as the JVM vendor.
Expand All @@ -65,7 +73,9 @@ public abstract class JvmVendorSpec {
*/
@Incubating
public static final JvmVendorSpec MICROSOFT = matching(KnownJvmVendor.MICROSOFT);

public static final JvmVendorSpec ORACLE = matching(KnownJvmVendor.ORACLE);

public static final JvmVendorSpec SAP = matching(KnownJvmVendor.SAP);

/**
Expand Down
9 changes: 4 additions & 5 deletions ...ts/platform-jvm/src/main/java/org/gradle/jvm/toolchain/internal/JavaToolchainMatcher.java
View file
Open in desktop
Expand Up @@ -21,7 +21,6 @@
import org.gradle.jvm.toolchain.JavaLanguageVersion;
import org.gradle.jvm.toolchain.JavaToolchainSpec;
import org.gradle.jvm.toolchain.JvmImplementation;
import org.gradle.jvm.toolchain.JvmVendorSpec;

import java.util.function.Predicate;

Expand Down Expand Up @@ -69,12 +68,12 @@ private static boolean isJ9ExplicitlyRequested(JavaToolchainSpec spec) {

private static boolean isJ9RequestedViaVendor(JavaToolchainSpec spec) {
DefaultJvmVendorSpec vendorSpec = (DefaultJvmVendorSpec) spec.getVendor().get();
return vendorSpec != DefaultJvmVendorSpec.any() && vendorSpec.test(JvmVendor.KnownJvmVendor.IBM_SEMERU.asJvmVendor());
return vendorSpec != DefaultJvmVendorSpec.any() && vendorSpec.test(JvmVendor.KnownJvmVendor.IBM.asJvmVendor());
}

@SuppressWarnings("unchecked")
private Predicate<? super JvmInstallationMetadata> vendorPredicate() {
JvmVendorSpec vendorSpec = spec.getVendor().get();
return (Predicate<? super JvmInstallationMetadata>) vendorSpec;
private Predicate<JvmInstallationMetadata> vendorPredicate() {
return (DefaultJvmVendorSpec) spec.getVendor().get();
}

}
4 changes: 2 additions & 2 deletions ...jvm/src/main/java/org/gradle/jvm/toolchain/internal/install/AdoptOpenJdkRemoteBinary.java
View file
Open in desktop
Expand Up @@ -77,7 +77,7 @@ private boolean matchesVendor(JavaToolchainSpec spec) {
return true;
}

return vendorSpec.test(JvmVendor.KnownJvmVendor.IBM_SEMERU.asJvmVendor());
return vendorSpec.test(JvmVendor.KnownJvmVendor.IBM.asJvmVendor());
}

private URI constructUri(JavaToolchainSpec spec, BuildPlatform platform) {
Expand Down Expand Up @@ -171,7 +171,7 @@ private static boolean isJ9ExplicitlyRequested(JavaToolchainSpec spec) {

private static boolean isJ9RequestedViaVendor(JavaToolchainSpec spec) {
DefaultJvmVendorSpec vendorSpec = (DefaultJvmVendorSpec) spec.getVendor().get();
return vendorSpec != DefaultJvmVendorSpec.any() && vendorSpec.test(JvmVendor.KnownJvmVendor.IBM_SEMERU.asJvmVendor());
return vendorSpec != DefaultJvmVendorSpec.any() && vendorSpec.test(JvmVendor.KnownJvmVendor.IBM.asJvmVendor());
}

}
10 changes: 7 additions & 3 deletions ...test/groovy/org/gradle/jvm/toolchain/install/internal/AdoptOpenJdkRemoteBinaryTest.groovy
View file
Open in desktop
Expand Up @@ -116,7 +116,7 @@ class AdoptOpenJdkRemoteBinaryTest extends Specification {
!download.isPresent()

where:
vendor << [JvmVendorSpec.AMAZON, JvmVendorSpec.IBM]
vendor << [JvmVendorSpec.AMAZON]
}

def "can provide matching vendor spec using #vendor"() {
Expand All @@ -133,10 +133,14 @@ class AdoptOpenJdkRemoteBinaryTest extends Specification {

then:
download.isPresent()
download.get().getUri() == URI.create("https://api.adoptopenjdk.net/v3/binary/latest/12/ga/mac/x64/jdk/hotspot/normal/adoptopenjdk")
download.get().getUri() == URI.create("https://api.adoptopenjdk.net/v3/binary/latest/12/ga/mac/x64/jdk/${implementation}/normal/adoptopenjdk")

where:
vendor << [JvmVendorSpec.ADOPTOPENJDK, JvmVendorSpec.matching("adoptopenjdk"), DefaultJvmVendorSpec.any()]
vendor | implementation
JvmVendorSpec.IBM | "openj9"
JvmVendorSpec.ADOPTOPENJDK | "hotspot"
JvmVendorSpec.matching("adoptopenjdk") | "hotspot"
DefaultJvmVendorSpec.any() | "hotspot"
}

def "can provide j9 impl if requested"() {
Expand Down