Add Groovy 5 support (#2196)

Author: Vampire

.github/codecov.yml

@@ -3,4 +3,4 @@ codecov:
 
 comment:
   layout: "reach, diff, flags, files"
-  after_n_builds: 18
+  after_n_builds: 24

.github/renovate.json5

@@ -20,6 +20,11 @@
       matchCurrentValue: "/^4\\./",
       allowedVersions: "(,5.0)"
     },
+    {
+      matchPackageNames: ["/^org.apache.groovy:/"],
+      matchCurrentValue: "/^5\\./",
+      allowedVersions: "(,6.0)"
+    },
     {
       matchPackageNames: ["/^org.mockito:/"],
       matchCurrentValue: "/^4\\./",
@@ -34,6 +39,11 @@
       matchPackageNames: ["/^org.spockframework:spock-/"],
       matchCurrentVersion: "/-groovy-4\\.0$/",
       allowedVersions: "/-groovy-4\\.0$/"
+    },
+    {
+      matchPackageNames: ["/^org.spockframework:spock-/"],
+      matchCurrentVersion: "/-groovy-5\\.0$/",
+      allowedVersions: "/-groovy-5\\.0$/"
     }
   ]
 }

.github/workflows/branches-and-prs.yaml

@@ -56,6 +56,7 @@ jobs:
         - '2.5'
         - '3.0'
         - '4.0'
+        - '5.0'
         java:
         - '8'
         - '11'
@@ -74,6 +75,9 @@ jobs:
         - variant: '2.5'
           java: '24'
           os: 'ubuntu-latest'
+        - variant: '5.0'
+          java: '8'
+          os: 'ubuntu-latest'
         include:
         - variant: '2.5'
           java: '8'
@@ -84,6 +88,9 @@ jobs:
         - variant: '4.0'
           java: '8'
           os: 'windows-latest'
+        - variant: '5.0'
+          java: '11'
+          os: 'windows-latest'
         - variant: '2.5'
           java: '8'
           os: 'macos-latest'
@@ -93,6 +100,9 @@ jobs:
         - variant: '4.0'
           java: '8'
           os: 'macos-latest'
+        - variant: '5.0'
+          java: '11'
+          os: 'macos-latest'
     steps:
     - id: 'step-0'
       name: 'Checkout Repository'

.github/workflows/codeql-analysis.main.kts

@@ -125,7 +125,8 @@ workflow(
                 "--stacktrace",
                 "--no-build-cache",
                 "testClasses",
-                """"-Dvariant=${expr(Matrix.variant)}""""
+                """"-Dvariant=${expr(Matrix.variant)}"""",
+                """"-DjavaVersion=${expr("${Matrix.variant} == '5.0' && '11' || '${Matrix.axes.javaVersions.first()}'")}""""
             ).joinToString(" ")
         )
         uses(

.github/workflows/codeql-analysis.yaml

@@ -40,6 +40,7 @@ jobs:
         - '2.5'
         - '3.0'
         - '4.0'
+        - '5.0'
     steps:
     - id: 'step-0'
       name: 'Checkout Repository'
@@ -52,7 +53,7 @@ jobs:
       uses: 'github/codeql-action/init@v3'
     - id: 'step-3'
       name: 'Build Spock Classes'
-      run: './gradlew --stacktrace --no-build-cache testClasses "-Dvariant=${{ matrix.variant }}"'
+      run: './gradlew --stacktrace --no-build-cache testClasses "-Dvariant=${{ matrix.variant }}" "-DjavaVersion=${{ matrix.variant == ''5.0'' && ''11'' || ''8'' }}"'
     - id: 'step-4'
       name: 'Perform CodeQL Analysis'
       uses: 'github/codeql-action/analyze@v3'

.github/workflows/common.main.kts

@@ -139,15 +139,20 @@ val Matrix.Companion.full
         operatingSystems = listOf("ubuntu-latest"),
         variants = axes.variants,
         javaVersions = axes.javaVersions + axes.additionalJavaTestVersions,
-        exclude = { (variant == "2.5") && (javaVersion!!.toInt() >= 17) },
+        exclude = {
+            ((variant == "2.5") && (javaVersion!!.toInt() >= 17)) ||
+                ((variant == "5.0") && (javaVersion!!.toInt() < 11))
+        },
         includes = listOf("windows-latest", "macos-latest")
-            .map {
-                Matrix.Element(
-                    operatingSystem = it,
-                    javaVersion = axes.javaVersions.first()
-                )
+            .map { Matrix.Element(operatingSystem = it) }
+            .flatMap { element ->
+                axes.variants.map {
+                    element.copy(
+                        variant = it,
+                        javaVersion = if (it == "5.0") "11" else axes.javaVersions.first()
+                    )
+                }
             }
-            .flatMap { element -> axes.variants.map { element.copy(variant = it) } }
     )
 
 val Matrix.Companion.axes by lazy {

.github/workflows/docs-pr.yaml

@@ -48,7 +48,7 @@ jobs:
       run: 'sudo apt update && sudo apt install --yes graphviz'
     - id: 'step-3'
       name: 'Build Docs'
-      run: './gradlew --stacktrace asciidoctor javadoc "-Dvariant=4.0" "-DjavaVersion=21"'
+      run: './gradlew --stacktrace asciidoctor javadoc "-Dvariant=5.0" "-DjavaVersion=21"'
     - id: 'step-4'
       name: 'Archive and upload docs'
       uses: 'actions/upload-artifact@v4'

.github/workflows/release.yaml

@@ -36,6 +36,7 @@ jobs:
         - '2.5'
         - '3.0'
         - '4.0'
+        - '5.0'
         java:
         - '8'
         - '11'
@@ -54,6 +55,9 @@ jobs:
         - variant: '2.5'
           java: '24'
           os: 'ubuntu-latest'
+        - variant: '5.0'
+          java: '8'
+          os: 'ubuntu-latest'
         include:
         - variant: '2.5'
           java: '8'
@@ -64,6 +68,9 @@ jobs:
         - variant: '4.0'
           java: '8'
           os: 'windows-latest'
+        - variant: '5.0'
+          java: '11'
+          os: 'windows-latest'
         - variant: '2.5'
           java: '8'
           os: 'macos-latest'
@@ -73,6 +80,9 @@ jobs:
         - variant: '4.0'
           java: '8'
           os: 'macos-latest'
+        - variant: '5.0'
+          java: '11'
+          os: 'macos-latest'
     steps:
     - id: 'step-0'
       name: 'Checkout Repository'
@@ -109,6 +119,7 @@ jobs:
         - '2.5'
         - '3.0'
         - '4.0'
+        - '5.0'
         java:
         - '8'
         os:
@@ -140,7 +151,7 @@ jobs:
     strategy:
       matrix:
         variant:
-        - '4.0'
+        - '5.0'
         java:
         - '21'
         os:

CONTRIBUTING.adoc

@@ -137,10 +137,10 @@ Functional tests for `spock-core` are located under https://github.spockframewor
 === Command Line Build
 
 Spock is built with https://www.gradle.org[Gradle].
-The only prerequisite for executing the build is an installation of JDK 8 and JDK 17.
-The build itself must be run with JDK 17, but JDK 8 must be available via toolchain.
+The only prerequisite for executing the build is an installation of JDK 11 and JDK 17.
+The build itself must be run with JDK 17, but JDK 11 must be available via toolchain.
 You can check if Gradle can locate the necessary JDKs by running `./gradlew javaToolchains`.
-If gradle can't locate your JDK 8, you can make the location of the JDK 8 available via an environment variable called `JDK8`.
+If Gradle can't locate your JDK 11, you can make the location of the JDK 11 available via an environment variable called `JDK11`.
 
 After cloning the https://github.com/spockframework/spock[GitHub repository], cd into the top directory and execute `./gradlew build`. The build should succeed without any errors. `./gradlew tasks` lists the available tasks.
 Always use the Gradle Wrapper (`gradlew` command) rather than your own Gradle installation.

README.adoc

@@ -29,10 +29,11 @@ https://groovyconsole.dev/[Groovy Web Console].
 * The latest 2.x release version is *{spock-release-version}* ({spock-release-version}-groovy-2.5,
 {spock-release-version}-groovy-3.0, {spock-release-version}-groovy-4.0), released on {spock-release-date}.
 * The current development version is *{spock-snapshot-version}-SNAPSHOT*
-({spock-snapshot-version}-groovy-2.5-SNAPSHOT, {spock-snapshot-version}-groovy-3.0-SNAPSHOT, {spock-snapshot-version}-groovy-4.0-SNAPSHOT).
+({spock-snapshot-version}-groovy-2.5-SNAPSHOT, {spock-snapshot-version}-groovy-3.0-SNAPSHOT,
+{spock-snapshot-version}-groovy-4.0-SNAPSHOT), {spock-snapshot-version}-groovy-5.0-SNAPSHOT).
 
 *NOTE:* Spock 2.x is based on the JUnit 5 Platform and requires Java
-8+/groovy-2.5+ (Groovy 3.0 or 4.0 is recommended, especially in projects using
+8+/groovy-2.5+ (Groovy 3.0 or newer is recommended, especially in projects using
 Java 12+).
 
 Releases are available from
@@ -86,25 +87,26 @@ https://tapestry.apache.org/[Tapestry 5] IoC container.
 
 ==== Prerequisites
 
-Spock needs both a JDK 8 and JDK 17+ installed.
+Spock needs both a JDK 11 and JDK 17+ installed.
 
-* JDK 8 is required to compile Spock via toolchains (automatic download is disabled).
+* JDK 11 is required to compile Spock via toolchains (automatic download is disabled).
 * The gradle build itself requires at least JDK 17 to run.
 
 JDK locations must be made known to toolchains via `JDK<version>=<PATH>` environment
-variable, e.g., `JDK8=/path/to/jdk8`.
+variable if they are not in standard places recognized by Gradle, e.g. `JDK11=/path/to/jdk11`.
 
 ==== Supported versions
 
 Spock is supported for Java version 8+.
 
-Spock is supported for Groovy versions 2.5, 3.0, and 4.0.
+Spock is supported for Groovy versions 2.5, 3.0, 4.0, and 5.0.
 
 The tests are testing Spock with the specific versions (variants) of
 Groovy and Java. Default Groovy version is 2.5.
 
 The Groovy 3.0 and 4.0 variant should pass on all supported JDK versions,
 Groovy 2.5 does not work with Java 17+:
+Groovy 5.0 and newer does not work with Java <11:
 
 ....
 ./gradlew build