Use toolchains to configure build and test Java version

Author: mrotteveel

.github/workflows/run-tests.yml

@@ -6,6 +6,25 @@ permissions:
 
 jobs:
   build:
+    strategy:
+      matrix:
+        java:
+          - version: 17
+            javaInstall: 17
+            buildProfile: 17
+            testProfile: 17
+          - version: 17-test-21
+            javaInstall: |
+              17
+              21
+            buildProfile: 17
+            testProfile: 21
+          - version: 17-test-25
+            javaInstall: |
+              17
+              25
+            buildProfile: 17
+            testProfile: 25
     runs-on: ubuntu-latest
     steps:
       - name: Login to Docker Hub
@@ -19,22 +38,22 @@ jobs:
           firebird_root_password: 'masterkey'
           firebird_conf: 'WireCrypt=Enabled,AuthServer=Srp256;Srp;Legacy_Auth;Srp224;Srp384;Srp512,UserManager=Srp;Legacy_UserManager'
       - uses: actions/checkout@v6
-      - name: Set up Java 17
+      - name: Set up Java ${{ matrix.java.version }}
         uses: actions/setup-java@v5
         with:
-          java-version: '17'
+          java-version: ${{ matrix.java.javaInstall }}
           distribution: 'temurin'
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@0723195856401067f7a2779048b490ace7a47d7c
         with:
           cache-read-only: ${{ github.ref != 'refs/heads/Branch_6_0' }}
       - name: Build with Gradle
-        run: ./gradlew test -Ptest.dbondocker=true -Ptest.db.dir=/var/lib/firebird/data
+        run: ./gradlew test -PbuildProfile=${{ matrix.java.buildProfile }} -PtestProfile=${{ matrix.java.testProfile }} -Ptest.dbondocker=true -Ptest.db.dir=/var/lib/firebird/data
       - name: Store Report Artifact
         uses: actions/upload-artifact@v7
         if: always()
         with:
-          name: report-artifacts
+          name: report-artifacts-${{ matrix.java.version }}
           path: build/reports
           compression-level: 9
           retention-days: 7

build-properties.gradle

@@ -20,10 +20,24 @@ def buildTime = new Date()
 ext.'build.id' = buildTime.format('yyyyMMddHHmm')
 ext.YEAR = buildTime.format("yyyy")
 
-// Build profile
-ext.'maven.jdkversion' = 'java17'
+// Build profile (target Java version)
+def buildProfileProp = findProperty('buildProfile') as String
+def buildMatcher = buildProfileProp =~ /^(?:java)?(\d+)$/
+ext.buildJava = buildMatcher ? buildMatcher.group(1) as Integer : 17
+println "Build profile: Java ${ext.buildJava}"
+if (ext.buildJava != 17) {
+    println "WARNING: Java target version ${ext.buildJava} (buildProfile) is not a baseline version and will not be published to Maven."
+}
+
+// As we only publish the Java 17 version, we don't do further mapping for higher JDBC versions
 ext.'specification.version' = '4.3'
 
+// Test profile (test Java version)
+def testProfileProp = findProperty('testProfile') as String
+def testMatcher =  testProfileProp =~ /^(?:java)?(\d+)$/
+ext.testJava = testMatcher ? testMatcher.group(1) as Integer : ext.buildJava
+println "Test profile: Java ${ext.testJava}"
+
 ext.'version.simple' = "${project.'version.major'}.${project.'version.minor'}.${project.'version.revision'}".toString()
 ext.'version.maven' = "${project.'version.simple'}${project.'version.tag'}".toString()
 

build.gradle

@@ -4,6 +4,21 @@ import org.asciidoctor.gradle.jvm.AsciidoctorTask
 /*
   Gradle build script for Jaybird - Firebird JDBC driver.
 
+  Define target Java version:
+  - -PbuildProfile=17              : Java 17 (supported)
+    or not specified
+  - -PbuildProfile=NN              : Java NN (not publishable)
+    with NN > 17
+
+  Build profiles other than 17 will not be published to Maven.
+
+  Define (other) Java version to test:
+  - -PtestProfile=NN with NN >= 17
+
+  If not specified, the test profile is the same as buildProfile.
+
+  For historic reasons, both buildProfile and testProfile also accept javaNN.
+
   Uploading archives:
 
   publish -PcredentialsPassphrase=<credentials password>
@@ -27,9 +42,21 @@ version = project.'version.maven'
 allprojects {
     tasks.withType(JavaCompile).configureEach {
         options.encoding = 'UTF-8'
+        options.release = project.buildJava
+        javaCompiler = javaToolchains.compilerFor {
+            languageVersion = JavaLanguageVersion.of((int) project.buildJava)
+        }
     }
     tasks.withType(Test).configureEach {
         systemProperty 'file.encoding', 'UTF-8'
+        javaLauncher = javaToolchains.launcherFor {
+            languageVersion = JavaLanguageVersion.of((int) project.testJava)
+        }
+    }
+    tasks.withType(Javadoc).configureEach {
+        javadocTool = javaToolchains.javadocToolFor {
+            languageVersion = JavaLanguageVersion.of((int) project.buildJava)
+        }
     }
 }
 
@@ -38,8 +65,9 @@ base {
 }
 
 java {
-    sourceCompatibility = JavaVersion.VERSION_17
-    targetCompatibility = JavaVersion.VERSION_17
+    def javaVersion = JavaLanguageVersion.of((int) project.buildJava)
+    sourceCompatibility = javaVersion
+    targetCompatibility = javaVersion
     withJavadocJar()
     withSourcesJar()
 }
@@ -158,13 +186,12 @@ tasks.named('assemble') {
 jar {
     manifest {
         attributes(
-                'Created-By': "${System.getProperty('java.vm.version')} (${System.getProperty('java.vm.vendor')})",
                 'Specification-Title': project.'specification.title',
                 'Specification-Version': project.'specification.version',
                 'Specification-Vendor': project.'specification.vendor',
                 'Implementation-Title': project.'implementation.title',
                 'Implementation-Url': project.'implementation.url',
-                'Implementation-Version': "$project.version (build: variant=$project.mavenName tag=${project.'version.svntag'} date=${project.'build.id'})",
+                'Implementation-Version': "$project.version (build: variant=$project.mavenName tag=${project.'version.svntag'} date=${project.'build.id'} java=${project.buildJava})",
                 'Implementation-Vendor': project.'implementation.vendor',
                 'Implementation-Vendor-Id': project.'implementation.vendor.id'
         )

chacha64-plugin/build.gradle

@@ -36,7 +36,7 @@ jar {
                 'Created-By': "${System.getProperty('java.vm.version')} (${System.getProperty('java.vm.vendor')})",
                 'Implementation-Title': 'Jaybird ChaCha64 wire encryption',
                 'Implementation-Url': project.'implementation.url',
-                'Implementation-Version': "$project.version (build: variant=$project.mavenName tag=${project.'version.svntag'} date=${project.'build.id'})",
+                'Implementation-Version': "$project.version (build: variant=$project.mavenName tag=${project.'version.svntag'} date=${project.'build.id'} java=${project.buildJava})",
                 'Implementation-Vendor': project.'implementation.vendor',
                 'Implementation-Vendor-Id': project.'implementation.vendor.id'
         )

devdoc/build-documentation.md

@@ -6,15 +6,23 @@ please contribute using a pull request, or ask on [firebird-java](https://groups
 ## Running the build
 
 The build uses Gradle wrapper, which is included in the repository. The current
-minimum version is Java 17.
+minimum version is Java 17. The build target (buildProfile) defaults to Java 17,
+independent of the Java version running Gradle.
+
+The target Java version is determined by passing `-PbuildProfile=NN`, where `NN`
+is the desired Java version. The default is `17`. Versions other than `17` are
+not published to Maven.
+
+By default, tests are run with that `buildProfile` version. This can be
+overridden with `-PtestProfile=NN`. For historic reasons, `javaNN` is also
+accepted by both properties.
 
 To run with a specific Java version, we suggest creating a Java-specific launch
 script. For example, for Windows create a batch file with:
 
 ```
 @echo off
-set JAVA_HOME=C:\Program Files\Java\jdk-19
-call gradlew.bat %*
+call gradlew.bat -PbuildProfile=21 %*
 ```
 
 ### Default build

jaybird-native/build.gradle

@@ -38,7 +38,7 @@ jar {
                 'Created-By': "${System.getProperty('java.vm.version')} (${System.getProperty('java.vm.vendor')})",
                 'Implementation-Title': 'Jaybird Native GDS Factory Plugin',
                 'Implementation-Url': project.'implementation.url',
-                'Implementation-Version': "$project.version (build: variant=$project.mavenName tag=${project.'version.svntag'} date=${project.'build.id'})",
+                'Implementation-Version': "$project.version (build: variant=$project.mavenName tag=${project.'version.svntag'} date=${project.'build.id'} java=${project.buildJava})",
                 'Implementation-Vendor': project.'implementation.vendor',
                 'Implementation-Vendor-Id': project.'implementation.vendor.id'
         )

publish.gradle

@@ -173,6 +173,9 @@ publishing {
 
 allprojects {
     tasks.withType(PublishToMavenRepository).each {
+        it.onlyIf('Only publish Java 17 builds') {
+            project.buildJava == 17
+        }
         it.doFirst {
             if (findProperty('centralUsername') == null || findProperty('centralPassword') == null) {
                 throw new RuntimeException('No credentials for publishing, make sure to specify the properties ' +