Add OpenJ9 JDK 21 CI build (#3768)

marcphilipp · web-flow · commit 84d426ca3c9f · 2024-04-12T21:11:47.000+02:00
* Use jfr-polyfill when compiling for/running on OpenJ9
* Disable exception message tests on OpenJ9 JVMs
* Disable JFR-related tests on OpenJ9 JVMs
* Disable test on OpenJ9 due to Kotlin DSL issues
diff --git a/.github/actions/setup-test-jdk/action.yml b/.github/actions/setup-test-jdk/action.yml
@@ -1,11 +1,16 @@
 name: Set up Test JDK
 description: Sets up the JDK required to run platform-tooling-support-tests
+inputs:
+  distribution:
+    required: true
+    description: 'The JDK distribution to use'
+    default: 'temurin'
 runs:
   using: "composite"
   steps:
     - uses: actions/setup-java@v4
       with:
-        distribution: temurin
+        distribution: ${{ inputs.distribution }}
         java-version: 8
     - shell: bash
       run: echo "JDK8=$JAVA_HOME" >> $GITHUB_ENV
diff --git a/.github/workflows/cross-version.yml b/.github/workflows/cross-version.yml
@@ -18,7 +18,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        jdk: [22, 23]
+        jdk: [ 22, 23 ]
     name: "OpenJDK ${{ matrix.jdk }}"
     runs-on: ubuntu-latest
     steps:
@@ -41,11 +41,44 @@ jobs:
         uses: ./.github/actions/run-gradle
         with:
           arguments: |
-            -PjavaToolchainVersion=${{ matrix.jdk }}
+            -PjavaToolchain.version=${{ matrix.jdk }}
             -Dscan.tag.JDK_${{ matrix.jdk }}
             build
       - name: Upload Test Distribution trace files
         uses: actions/upload-artifact@v4
         with:
           name: "Test Distribution trace files (OpenJDK ${{ matrix.jdk }})"
           path: '**/build/test-results/*/trace.json'
+  openj9:
+    strategy:
+      fail-fast: false
+      matrix:
+        jdk: [ 21 ]
+    name: "OpenJ9 ${{ matrix.jdk }}"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+      - name: Set up Test JDK
+        uses: ./.github/actions/setup-test-jdk
+        with:
+          distribution: semeru
+      - name: 'Set up JDK ${{ matrix.jdk }}'
+        uses: actions/setup-java@v4
+        with:
+          distribution: semeru
+          java-version: ${{ matrix.jdk }}
+      - name: 'Prepare JDK${{ matrix.jdk }} env var'
+        shell: bash
+        run: echo "JDK${{ matrix.jdk }}=$JAVA_HOME" >> $GITHUB_ENV
+      - name: Build
+        uses: ./.github/actions/run-gradle
+        with:
+          arguments: |
+            -PjavaToolchain.version=${{ matrix.jdk }}
+            -PjavaToolchain.implementation=j9
+            -Dscan.tag.JDK_${{ matrix.jdk }}
+            -Dscan.tag.OpenJ9
+            build
diff --git a/documentation/documentation.gradle.kts b/documentation/documentation.gradle.kts
@@ -64,6 +64,12 @@ dependencies {
 		because("Jimfs is used in src/test/java")
 	}
 
+	if (java.toolchain.implementation.orNull == JvmImplementation.J9) {
+		testRuntimeOnly(libs.jfrPolyfill) {
+			because("OpenJ9 does not include JFR")
+		}
+	}
+
 	standaloneConsoleLauncher(projects.junitPlatformConsoleStandalone)
 }
 
diff --git a/documentation/src/test/java/example/AssertionsDemo.java b/documentation/src/test/java/example/AssertionsDemo.java
@@ -85,6 +85,9 @@ void dependentAssertions() {
 		);
 	}
 
+	// end::user_guide[]
+	@extensions.DisabledOnOpenJ9
+	// tag::user_guide[]
 	@Test
 	void exceptionTesting() {
 		Exception exception = assertThrows(ArithmeticException.class, () ->
diff --git a/documentation/src/test/java/example/testkit/EngineTestKitAllEventsDemo.java b/documentation/src/test/java/example/testkit/EngineTestKitAllEventsDemo.java
@@ -62,7 +62,7 @@ void verifyAllJupiterEvents() {
 						message(m -> m.contains("abc does not contain Z")))),
 				event(test("failingTest"), started()),
 				event(test("failingTest"), finishedWithFailure(
-					instanceOf(ArithmeticException.class), message("/ by zero"))),
+					instanceOf(ArithmeticException.class), message(it -> it.endsWith("by zero")))),
 				event(container(ExampleTestCase.class), finishedSuccessfully()),
 				event(engine(), finishedSuccessfully()));
 	}
diff --git a/documentation/src/test/java/example/testkit/EngineTestKitFailedMethodDemo.java b/documentation/src/test/java/example/testkit/EngineTestKitFailedMethodDemo.java
@@ -36,7 +36,7 @@ void verifyJupiterMethodFailed() {
 			.assertThatEvents().haveExactly(1, // <5>
 				event(test("failingTest"),
 					finishedWithFailure(
-						instanceOf(ArithmeticException.class), message("/ by zero"))));
+						instanceOf(ArithmeticException.class), message(it -> it.endsWith("by zero")))));
 	}
 
 }
diff --git a/documentation/src/test/java/extensions/DisabledOnOpenJ9.java b/documentation/src/test/java/extensions/DisabledOnOpenJ9.java
@@ -0,0 +1,24 @@
+/*
+ * Copyright 2015-2024 the original author or authors.
+ *
+ * All rights reserved. This program and the accompanying materials are
+ * made available under the terms of the Eclipse Public License v2.0 which
+ * accompanies this distribution and is available at
+ *
+ * https://www.eclipse.org/legal/epl-v20.html
+ */
+
+package extensions;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.junit.jupiter.api.condition.DisabledIfSystemProperty;
+
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+@DisabledIfSystemProperty(named = "java.vm.vendor", matches = ".*OpenJ9.*")
+public @interface DisabledOnOpenJ9 {
+}
diff --git a/documentation/src/test/kotlin/example/KotlinAssertionsDemo.kt b/documentation/src/test/kotlin/example/KotlinAssertionsDemo.kt
@@ -38,7 +38,10 @@ class KotlinAssertionsDemo {
         assertEquals(0, result)
     }
 
+    // tag::user_guide[]
     @Test
+    // end::user_guide[]
+    @extensions.DisabledOnOpenJ9
     fun `expected exception testing`() {
         val calculator = Calculator()
         val exception = assertThrows<ArithmeticException> ("Should throw an exception") {
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -42,6 +42,7 @@ gradle-versions = { module = "com.github.ben-manes:gradle-versions-plugin", vers
 groovy4 = { module = "org.apache.groovy:groovy", version = "4.0.21" }
 groovy2-bom = { module = "org.codehaus.groovy:groovy-bom", version = "2.5.21" }
 hamcrest = { module = "org.hamcrest:hamcrest", version = "2.2" }
+jfrPolyfill = { module = "org.gradle.jfr.polyfill:jfr-polyfill", version = "1.0.2" }
 jfrunit = { module = "org.moditect.jfrunit:jfrunit-core", version = "1.0.0.Alpha2" }
 jimfs = { module = "com.google.jimfs:jimfs", version = "1.3.0" }
 jmh-core = { module = "org.openjdk.jmh:jmh-core", version.ref = "jmh" }
diff --git a/gradle/plugins/build-parameters/build.gradle.kts b/gradle/plugins/build-parameters/build.gradle.kts
@@ -11,8 +11,14 @@ buildParameters {
 		defaultValue = false
 		fromEnvironment()
 	}
-	integer("javaToolchainVersion") {
-		description = "Defines the Java toolchain version to use for compiling code"
+	group("javaToolchain") {
+		description = "Parameters controlling the Java toolchain used for compiling code and running tests"
+		integer("version") {
+			description = "JDK version"
+		}
+		string("implementation") {
+			description = "JDK implementation (for example, 'j9')"
+		}
 	}
 	group("documentation") {
 		description = "Parameters controlling how the documentation is built"
diff --git a/gradle/plugins/common/src/main/kotlin/junitbuild.java-toolchain-conventions.gradle.kts b/gradle/plugins/common/src/main/kotlin/junitbuild.java-toolchain-conventions.gradle.kts
@@ -6,12 +6,21 @@ plugins {
 
 project.pluginManager.withPlugin("java") {
 	val defaultLanguageVersion = JavaLanguageVersion.of(21)
-	val javaLanguageVersion = buildParameters.javaToolchainVersion.map { JavaLanguageVersion.of(it) }.getOrElse(defaultLanguageVersion)
+	val javaLanguageVersion = buildParameters.javaToolchain.version.map { JavaLanguageVersion.of(it) }.getOrElse(defaultLanguageVersion)
+	val jvmImplementation = buildParameters.javaToolchain.implementation.map {
+		when(it) {
+            "j9" -> JvmImplementation.J9
+            else -> throw InvalidUserDataException("Unsupported JDK implementation: $it")
+        }
+	}.getOrElse(JvmImplementation.VENDOR_SPECIFIC)
 
 	val extension = the<JavaPluginExtension>()
 	val javaToolchainService = the<JavaToolchainService>()
 
-	extension.toolchain.languageVersion = javaLanguageVersion
+	extension.toolchain {
+        languageVersion = javaLanguageVersion
+        implementation = jvmImplementation
+    }
 
 	pluginManager.withPlugin("org.jetbrains.kotlin.jvm") {
 		configure<KotlinJvmProjectExtension> {
diff --git a/gradle/plugins/common/src/main/kotlin/junitbuild.testing-conventions.gradle.kts b/gradle/plugins/common/src/main/kotlin/junitbuild.testing-conventions.gradle.kts
@@ -86,6 +86,9 @@ dependencies {
 	testRuntimeOnly(project(":junit-platform-reporting"))
 
 	testRuntimeOnly(bundleFromLibs("log4j"))
+	testRuntimeOnly(dependencyFromLibs("jfrPolyfill")) {
+		because("OpenJ9 does not include JFR")
+	}
 	testRuntimeOnly(dependencyFromLibs("openTestReporting-events")) {
 		because("it's required to run tests via IntelliJ which does not consumed the shadowed jar of junit-platform-reporting")
 	}
diff --git a/junit-jupiter-api/src/testFixtures/java/org/junit/jupiter/api/extension/DisabledOnOpenJ9.java b/junit-jupiter-api/src/testFixtures/java/org/junit/jupiter/api/extension/DisabledOnOpenJ9.java
@@ -0,0 +1,24 @@
+/*
+ * Copyright 2015-2024 the original author or authors.
+ *
+ * All rights reserved. This program and the accompanying materials are
+ * made available under the terms of the Eclipse Public License v2.0 which
+ * accompanies this distribution and is available at
+ *
+ * https://www.eclipse.org/legal/epl-v20.html
+ */
+
+package org.junit.jupiter.api.extension;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.junit.jupiter.api.condition.DisabledIfSystemProperty;
+
+@Target({ ElementType.METHOD, ElementType.TYPE })
+@Retention(RetentionPolicy.RUNTIME)
+@DisabledIfSystemProperty(named = "java.vm.vendor", matches = ".*OpenJ9.*")
+public @interface DisabledOnOpenJ9 {
+}
diff --git a/junit-platform-jfr/junit-platform-jfr.gradle.kts b/junit-platform-jfr/junit-platform-jfr.gradle.kts
@@ -10,6 +10,12 @@ dependencies {
 
 	compileOnlyApi(libs.apiguardian)
 
+	if (java.toolchain.implementation.orNull == JvmImplementation.J9) {
+		compileOnly(libs.jfrPolyfill) {
+			because("OpenJ9 does not include JFR")
+		}
+	}
+
 	osgiVerification(projects.junitJupiterEngine)
 	osgiVerification(projects.junitPlatformLauncher)
 }
diff --git a/platform-tests/src/test/java/org/junit/platform/commons/util/ReflectionUtilsTests.java b/platform-tests/src/test/java/org/junit/platform/commons/util/ReflectionUtilsTests.java
@@ -1008,7 +1008,8 @@ void findNestedClassesWithInvalidNestedClassFile(@TrackLogRecords LogRecordListe
 				assertEquals(fqcn, classWithInvalidNestedClassFile.getName());
 				var noClassDefFoundError = assertThrows(NoClassDefFoundError.class,
 					classWithInvalidNestedClassFile::getDeclaredClasses);
-				assertEquals("tests/NestedInterfaceGroovyTests$NestedInterface$1", noClassDefFoundError.getMessage());
+				assertThat(noClassDefFoundError) //
+						.hasMessageMatching("tests[./]NestedInterfaceGroovyTests\\$NestedInterface\\$1");
 
 				assertThat(findNestedClasses(classWithInvalidNestedClassFile)).isEmpty();
 				// @formatter:off
diff --git a/platform-tests/src/test/java/org/junit/platform/jfr/FlightRecordingDiscoveryListenerIntegrationTests.java b/platform-tests/src/test/java/org/junit/platform/jfr/FlightRecordingDiscoveryListenerIntegrationTests.java
@@ -16,13 +16,15 @@
 import static org.moditect.jfrunit.JfrEventsAssert.assertThat;
 
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.DisabledOnOpenJ9;
 import org.junit.jupiter.engine.JupiterTestEngine;
 import org.junit.platform.launcher.core.LauncherFactoryForTestingPurposesOnly;
 import org.moditect.jfrunit.EnableEvent;
 import org.moditect.jfrunit.JfrEventTest;
 import org.moditect.jfrunit.JfrEvents;
 
 @JfrEventTest
+@DisabledOnOpenJ9
 public class FlightRecordingDiscoveryListenerIntegrationTests {
 
 	public JfrEvents jfrEvents = new JfrEvents();
diff --git a/platform-tests/src/test/java/org/junit/platform/jfr/FlightRecordingExecutionListenerIntegrationTests.java b/platform-tests/src/test/java/org/junit/platform/jfr/FlightRecordingExecutionListenerIntegrationTests.java
@@ -18,13 +18,15 @@
 import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.TestReporter;
+import org.junit.jupiter.api.extension.DisabledOnOpenJ9;
 import org.junit.jupiter.engine.JupiterTestEngine;
 import org.junit.platform.launcher.core.LauncherFactoryForTestingPurposesOnly;
 import org.moditect.jfrunit.EnableEvent;
 import org.moditect.jfrunit.JfrEventTest;
 import org.moditect.jfrunit.JfrEvents;
 
 @JfrEventTest
+@DisabledOnOpenJ9
 public class FlightRecordingExecutionListenerIntegrationTests {
 
 	public JfrEvents jfrEvents = new JfrEvents();
diff --git a/platform-tooling-support-tests/platform-tooling-support-tests.gradle.kts b/platform-tooling-support-tests/platform-tooling-support-tests.gradle.kts
@@ -68,6 +68,7 @@ dependencies {
 		because("we reference Ant's main class")
 	}
 	testImplementation(libs.bundles.xmlunit)
+	testImplementation(testFixtures(projects.junitJupiterApi))
 
 	thirdPartyJars(libs.junit4)
 	thirdPartyJars(libs.assertj)
diff --git a/platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/GraalVmStarterTests.java b/platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/GraalVmStarterTests.java
@@ -22,13 +22,15 @@
 import de.sormuras.bartholdy.tool.GradleWrapper;
 
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.DisabledOnOpenJ9;
 
 import platform.tooling.support.MavenRepo;
 import platform.tooling.support.Request;
 
 /**
  * @since 1.9.1
  */
+@DisabledOnOpenJ9
 class GraalVmStarterTests {
 
 	@Test
diff --git a/platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/ModularUserGuideTests.java b/platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/ModularUserGuideTests.java
@@ -27,6 +27,7 @@
 
 import org.codehaus.groovy.runtime.ProcessGroovyMethods;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.DisabledOnOpenJ9;
 import org.junit.jupiter.api.io.TempDir;
 
 import platform.tooling.support.Helper;
@@ -35,6 +36,7 @@
 /**
  * @since 1.5
  */
+@DisabledOnOpenJ9
 class ModularUserGuideTests {
 
 	private static final String DOCUMENTATION_MODULE_DESCRIPTOR = """
diff --git a/platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/ToolProviderTests.java b/platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/ToolProviderTests.java
@@ -36,6 +36,7 @@
 
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.DisabledOnOpenJ9;
 
 import platform.tooling.support.Helper;
 import platform.tooling.support.MavenRepo;
@@ -87,6 +88,7 @@ void findAndRunJUnitOnTheClassPath() {
 	}
 
 	@Test
+	@DisabledOnOpenJ9
 	void findAndRunJUnitOnTheModulePath() {
 		var finder = ModuleFinder.of(LIB);
 		var modules = finder.findAll().stream() //

Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,12 @@ dependencies {`
`64`	`64`	`because("Jimfs is used in src/test/java")`
`65`	`65`	`}`
`66`	`66`
	`67`	`+ if (java.toolchain.implementation.orNull == JvmImplementation.J9) {`
	`68`	`+ testRuntimeOnly(libs.jfrPolyfill) {`
	`69`	`+ because("OpenJ9 does not include JFR")`
	`70`	`+ }`
	`71`	`+ }`
	`72`	`+`
`67`	`73`	`standaloneConsoleLauncher(projects.junitPlatformConsoleStandalone)`
`68`	`74`	`}`
`69`	`75`
Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,9 @@ void dependentAssertions() {`
`85`	`85`	`);`
`86`	`86`	`}`
`87`	`87`
	`88`	`+ // end::user_guide[]`
	`89`	`+ @extensions.DisabledOnOpenJ9`
	`90`	`+ // tag::user_guide[]`
`88`	`91`	`@Test`
`89`	`92`	`void exceptionTesting() {`
`90`	`93`	`Exception exception = assertThrows(ArithmeticException.class, () ->`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ void verifyAllJupiterEvents() {`
`62`	`62`	`message(m -> m.contains("abc does not contain Z")))),`
`63`	`63`	`event(test("failingTest"), started()),`
`64`	`64`	`event(test("failingTest"), finishedWithFailure(`
`65`		`- instanceOf(ArithmeticException.class), message("/ by zero"))),`
	`65`	`+ instanceOf(ArithmeticException.class), message(it -> it.endsWith("by zero")))),`
`66`	`66`	`event(container(ExampleTestCase.class), finishedSuccessfully()),`
`67`	`67`	`event(engine(), finishedSuccessfully()));`
`68`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ void verifyJupiterMethodFailed() {`
`36`	`36`	`.assertThatEvents().haveExactly(1, // <5>`
`37`	`37`	`event(test("failingTest"),`
`38`	`38`	`finishedWithFailure(`
`39`		`- instanceOf(ArithmeticException.class), message("/ by zero"))));`
	`39`	`+ instanceOf(ArithmeticException.class), message(it -> it.endsWith("by zero")))));`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`}`