chore: use Gradle toolchains for JDK provisioning

It enables automatic JDK provisioning (e.g. download), and it enables
using different JDKs for executing Gradle and for building JMeter

Java version can be specified when building with -PjdkVersion=11

You could use ./gradlew -q javaToolchains to list the detected toolchains.

See https://docs.gradle.org/8.0/userguide/toolchains.html#sec:consuming

Fixes #5986

Author: vlsi

.github/workflows/main.yml

@@ -46,10 +46,19 @@ jobs:
     - uses: actions/checkout@v3
       with:
         fetch-depth: 50
-    - name: Set up Java ${{ matrix.java_version }}, ${{ matrix.java_distribution }}
+    - name: Set up Java ${{ matrix.java_version }}, oracle
+      if: ${{ matrix.oracle_java_website != '' }}
+      uses: oracle-actions/setup-java@1611a647972adb8b04779be3529a044d650fd510 # v1
+      with:
+        website: ${{ matrix.oracle_java_website }}
+        release: ${{ matrix.java_version }}
+    - name: Set up Java 17 and ${{ matrix.non_ea_java_version }}, ${{ matrix.java_distribution }}
       uses: actions/setup-java@v3
       with:
-        java-version: ${{ matrix.java_version }}
+        # The latest one will be the default, so we use Java 17 for launching Gradle
+        java-version: |
+          ${{ matrix.non_ea_java_version }}
+          17
         distribution: ${{ matrix.java_distribution }}
         architecture: x64
     - name: Steps to reproduce
@@ -68,6 +77,11 @@ jobs:
         properties: |
           testExtraJvmArgs=${{ matrix.testExtraJvmArgs }}
           testDisableCaching=${{ matrix.testDisableCaching }}
+          jdkBuildVersion=17
+          jdkTestVersion=${{ matrix.java_version }}
+          jdkTestVendor=${{ matrix.java_vendor }}
+          # We provision JDKs with GitHub Actions for caching purposes, so Gradle should rather fail in case JDK is not found
+          org.gradle.java.installations.auto-download=false
       env:
         _JAVA_OPTIONS: ${{ matrix.extraJvmArgs }}
         GRADLE_ENTERPRISE_ACCESS_KEY: ${{ secrets.GE_ACCESS_TOKEN }}

.github/workflows/matrix.js

@@ -8,23 +8,26 @@ const matrix = new MatrixBuilder();
 matrix.addAxis({
   name: 'java_distribution',
   values: [
-    {value: 'corretto', weight: 1},
-    {value: 'liberica', weight: 1},
-    {value: 'microsoft', weight: 1},
-    {value: 'oracle', weight: 1},
-    {value: 'semeru', weight: 4},
-    {value: 'temurin', weight: 1},
-    {value: 'zulu', weight: 1},
+    {value: 'corretto', vendor: 'amazon', weight: 1},
+    {value: 'liberica', vendor: 'bellsoft', weight: 1},
+    {value: 'microsoft', vendor: 'microsoft', weight: 1},
+    {value: 'oracle', vendor: 'oracle', weight: 1},
+    {value: 'semeru', vendor: 'ibm', weight: 4},
+    {value: 'temurin', vendor: 'eclipse', weight: 1},
+    {value: 'zulu', vendor: 'azul', weight: 1},
   ]
 });
 
+const eaJava = '21';
+
 matrix.addAxis({
   name: 'java_version',
   // Strings allow versions like 18-ea
   values: [
     '8',
     '11',
     '17',
+    eaJava,
   ]
 });
 
@@ -74,10 +77,13 @@ matrix.setNamePattern(['java_version', 'java_distribution', 'hash', 'os', 'tz',
 
 // Semeru uses OpenJ9 jit which has no option for making hash codes the same
 matrix.exclude({java_distribution: {value: 'semeru'}, hash: {value: 'same'}});
+// Semeru 8 fails when Semeru 17 is on the PATH (we use 17 for build)
+matrix.exclude({java_distribution: {value: 'semeru'}, java_version: '8'});
 // Microsoft Java has no distribution for 8
 matrix.exclude({java_distribution: {value: 'microsoft'}, java_version: '8'});
 // Oracle JDK is only supported for JDK 17 and later
 matrix.exclude({java_distribution: {value: 'oracle'}, java_version: ['8', '11']});
+matrix.imply({java_version: eaJava}, {java_distribution: {value: 'oracle'}})
 // Ensure at least one job with "same" hashcode exists
 matrix.generateRow({hash: {value: 'same'}});
 // Ensure at least one Windows and at least one Linux job is present (macOS is almost the same as Linux)
@@ -90,6 +96,8 @@ matrix.generateRow({java_version: "8"});
 matrix.generateRow({java_version: "11"});
 // Ensure there will be at least one job with Java 17
 matrix.generateRow({java_version: "17"});
+// Ensure there will be at least one job with Java EA
+matrix.generateRow({java_version: eaJava});
 const include = matrix.generateRows(process.env.MATRIX_JOBS || 5);
 if (include.length === 0) {
   throw new Error('Matrix list is empty');
@@ -124,9 +132,14 @@ include.forEach(v => {
   jvmArgs.push(`-Duser.country=${v.locale.country}`);
   jvmArgs.push(`-Duser.language=${v.locale.language}`);
   v.java_distribution = v.java_distribution.value;
+  v.java_vendor = v.java_distribution.vendor;
+  if (v.java_distribution === 'oracle') {
+      v.oracle_java_website = v.java_version === eaJava ? 'jdk.java.net' : 'oracle.com';
+  }
+  v.non_ea_java_version = v.java_version === eaJava ? '' : v.java_version;
   if (v.java_distribution !== 'semeru' && Math.random() > 0.5) {
     // The following options randomize instruction selection in JIT compiler
-    // so it might reveal missing synchronization in TestNG code
+    // so it might reveal missing synchronization
     v.name += ', stress JIT';
     v.testDisableCaching = 'JIT randomization should not be cached';
     jvmArgs.push('-XX:+UnlockDiagnosticVMOptions');

.github/workflows/matrix_builder.js

@@ -18,7 +18,7 @@ class Axis {
     }
     if (Array.isArray(filter)) {
       // e.g. row={os: 'windows'}; filter=[{os: 'linux'}, {os: 'linux'}]
-      return filter.find(v => Axis.matches(row, v));
+      return filter.some(v => Axis.matches(row, v));
     }
     if (typeof filter === 'object') {
       // e.g. row={jdk: {name: 'openjdk', version: 8}}; filter={jdk: {version: 8}}
@@ -68,6 +68,7 @@ class MatrixBuilder {
     this.duplicates = {};
     this.excludes = [];
     this.includes = [];
+    this.implications = [];
     this.failOnUnsatisfiableFilters = false;
   }
 
@@ -80,13 +81,23 @@ class MatrixBuilder {
   }
 
   /**
-   * Specifies exclude filter (e.g. exclude a forbidden combination)
+   * Specifies exclude filter (e.g. exclude a forbidden combination).
    * @param filter
    */
   exclude(filter) {
     this.excludes.push(filter);
   }
 
+  /**
+   * Adds implication like `antecedent -> consequent`.
+   * In other words, if `antecedent` holds, then `consequent` must also hold.
+   * @param antecedent
+   * @param consequent
+   */
+  imply(antecedent, consequent) {
+    this.implications.push({antecedent: antecedent, consequent: consequent});
+  }
+
   addAxis({name, title, values}) {
     const axis = new Axis({name, title, values});
     this.axes.push(axis);
@@ -104,8 +115,10 @@ class MatrixBuilder {
    * @returns {boolean}
    */
   matches(row) {
-    return (this.excludes.length === 0 || !this.excludes.find(f => Axis.matches(row, f))) &&
-           (this.includes.length === 0 || this.includes.find(f => Axis.matches(row, f)));
+    return (this.excludes.length === 0 || !this.excludes.some(f => Axis.matches(row, f))) &&
+           (this.includes.length === 0 || this.includes.some(f => Axis.matches(row, f))) &&
+           (this.implications.length === 0 || (
+               this.implications.every(i => !Axis.matches(row, i.antecedent) || Axis.matches(row, i.consequent))));
   }
 
   failOnUnsatisfiableFilters(value) {
@@ -125,7 +138,7 @@ class MatrixBuilder {
     let res;
     if (filter) {
       // If matching row already exists, no need to generate more
-      res = this.rows.find(v => Axis.matches(v, filter));
+      res = this.rows.some(v => Axis.matches(v, filter));
       if (res) {
         return res;
       }

README.md

@@ -175,14 +175,28 @@ systemProp.https.proxyPassword=your_password
 
 ### Test builds
 
-JMeter is built using Gradle.
+JMeter is built using Gradle, and it uses [Gradle's Toolchains for JVM projects](https://docs.gradle.org/current/userguide/toolchains.html)
+for provisioning JDKs. It means the code would search for the needed JDKs locally, or download them
+if they are not found.
+
+By default, the code would use JDK 17 for build purposes, however it would set the target release to 8,
+so the resulting artifacts would be compatible with Java 8.
 
 The following command builds and tests JMeter:
 
 ```sh
 ./gradlew build
 ```
 
+If you want to use a custom JDK for building you can set `-PjdkBuildVersion=11`,
+and you can select `-PjdkTestVersion=21` if you want to use a different JDK for testing.
+
+You can list the available build parameters by executing
+
+```sh
+./gradlew parameters
+```
+
 If the system does not have a GUI display then:
 
 ```sh
@@ -196,7 +210,7 @@ The following command would compile the application and enable you to run `jmete
 from the `bin` directory.
 
 > **Note** that it completely refreshes `lib/` contents,
-so it would remove custom plugins should you have them installed.
+so it would remove custom plugins should you have them installed to `lib/`. However, it would keep `lib/ext/` plugins intact.
 
 ```sh
 ./gradlew createDist

build-logic/basics/build.gradle.kts

@@ -18,3 +18,7 @@
 plugins {
     id("build-logic.kotlin-dsl-gradle-plugin")
 }
+
+dependencies {
+    api(projects.buildParameters)
+}

build-logic/basics/src/main/kotlin/ToolchainProperties.kt

@@ -0,0 +1,37 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import buildparameters.BuildParametersExtension
+import org.gradle.api.JavaVersion
+
+class ToolchainProperties(
+    val version: Int,
+    val vendor: String?,
+    val implementation: String?,
+)
+
+val BuildParametersExtension.buildJdk: ToolchainProperties?
+    get() = jdkBuildVersion.takeIf { it != 0 }
+        ?.let { ToolchainProperties(it, jdkBuildVendor.orNull, jdkBuildImplementation.orNull) }
+
+val BuildParametersExtension.buildJdkVersion: Int
+    get() = buildJdk?.version ?: JavaVersion.current().majorVersion.toInt()
+
+val BuildParametersExtension.testJdk: ToolchainProperties?
+    get() = jdkTestVersion.orNull?.takeIf { it != 0 }
+        ?.let { ToolchainProperties(it, jdkTestVendor.orNull, jdkTestImplementation.orNull) }
+        ?: buildJdk

build-logic/basics/src/main/kotlin/configureToolchain.kt

@@ -0,0 +1,41 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import org.gradle.api.provider.Provider
+import org.gradle.jvm.toolchain.JavaLanguageVersion
+import org.gradle.jvm.toolchain.JavaLauncher
+import org.gradle.jvm.toolchain.JavaToolchainService
+import org.gradle.jvm.toolchain.JavaToolchainSpec
+import org.gradle.jvm.toolchain.JvmImplementation
+import org.gradle.jvm.toolchain.JvmVendorSpec
+
+fun JavaToolchainService.launcherFor(jdk: ToolchainProperties): Provider<JavaLauncher> = launcherFor {
+    configureToolchain(jdk)
+}
+
+fun JavaToolchainSpec.configureToolchain(jdk: ToolchainProperties?) {
+    if (jdk == null) {
+        return
+    }
+    languageVersion.set(JavaLanguageVersion.of(jdk.version))
+    jdk.vendor?.let {
+        vendor.set(JvmVendorSpec.matching(it))
+    }
+    if (jdk.implementation.equals("J9", ignoreCase = true)) {
+        implementation.set(JvmImplementation.J9)
+    }
+}

build-logic/build-parameters/build.gradle.kts

@@ -29,10 +29,39 @@ buildParameters {
         defaultValue.set(true)
         description.set("Add mavenLocal() to repositories")
     }
+    bool("enableJavaFx") {
+        defaultValue.set(false)
+        description.set("Build and include classes that depend on JavaFX. Disabled by default since JavaFX is not included in the default Java distributions")
+    }
     bool("coverage") {
         defaultValue.set(false)
         description.set("Collect test coverage")
     }
+    integer("targetJavaVersion") {
+        defaultValue.set(8)
+        mandatory.set(true)
+        description.set("Java version for source and target compatibility")
+    }
+    integer("jdkBuildVersion") {
+        defaultValue.set(17)
+        mandatory.set(true)
+        description.set("JDK version to use for building JMeter. If the value is 0, then the current Java is used. (see https://docs.gradle.org/8.0/userguide/toolchains.html#sec:consuming)")
+    }
+    string("jdkBuildVendor") {
+        description.set("JDK vendor to use building JMeter (see https://docs.gradle.org/8.0/userguide/toolchains.html#sec:vendors)")
+    }
+    string("jdkBuildImplementation") {
+        description.set("Vendor-specific virtual machine implementation to use building JMeter (see https://docs.gradle.org/8.0/userguide/toolchains.html#selecting_toolchains_by_virtual_machine_implementation)")
+    }
+    integer("jdkTestVersion") {
+        description.set("JDK version to use for testing JMeter. If the value is 0, then the current Java is used. (see https://docs.gradle.org/8.0/userguide/toolchains.html#sec:consuming)")
+    }
+    string("jdkTestVendor") {
+        description.set("JDK vendor to use testing JMeter (see https://docs.gradle.org/8.0/userguide/toolchains.html#sec:vendors)")
+    }
+    string("jdkTestImplementation") {
+        description.set("Vendor-specific virtual machine implementation to use testing JMeter (see https://docs.gradle.org/8.0/userguide/toolchains.html#selecting_toolchains_by_virtual_machine_implementation)")
+    }
     bool("spotbugs") {
         defaultValue.set(false)
         description.set("Run SpotBugs verifications")

build-logic/jvm/src/main/kotlin/build-logic.groovy.gradle.kts

@@ -15,8 +15,20 @@
  * limitations under the License.
  */
 
+import com.github.vlsi.gradle.dsl.configureEach
+
 plugins {
     id("java")
     id("groovy")
     id("build-logic.test-spock")
+    id("com.github.vlsi.gradle-extensions")
+    id("build-logic.build-params")
+}
+
+tasks.configureEach<GroovyCompile> {
+    buildParameters.testJdk?.let {
+        javaLauncher.convention(javaToolchains.launcherFor(it))
+    }
+    // Support jdk-release to configure the target Java release when compiling the bytecode
+    // See https://issues.apache.org/jira/browse/GROOVY-11105
 }