Convert to Gradle focused starter project

Author: mpkorstanje

.github/workflows/build.yml

@@ -1,37 +1,30 @@
-name: Cucumber CI
+name: Test Java
+
+permissions: { }
 
 on:
-  push:
   pull_request:
     branches:
       - main
+  push:
+    branches:
+      - main
+      - renovate/**
 
 jobs:
   build:
-    name: 'Build'
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, windows-latest ]
+        version: [ 17, 21 ]
+    name: 'Build Java ${{ matrix.version }} - ${{ matrix.os }}'
+    runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v6
-      - name: Cache local Maven repository
-        uses: actions/cache@v4
-        with:
-          path: ~/.m2/repository
-          key: build-${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
-          restore-keys: |
-            build-${{ runner.os }}-maven-
-      - uses:
-          AdoptOpenJDK/install-jdk@v1
+      - uses: actions/setup-java@v5
         with:
-          version: '17'
-      - name: test maven
-        run: |
-          cd maven
-          ./mvnw test -Dmaven.test.failure.ignore
-      - run: grep -q "The step 'I wait 1 hour' and 1 other step(s) are undefined." maven/target/surefire-reports/io.cucumber.skeleton.RunCucumberTest.txt || ( echo "mvn test didn't fail as expected" && false )
-      - name: test gradle
-        run: |
-          cd gradle
-          ./gradlew test || true
-      - run: grep -q "The step 'I wait 1 hour' and 1 other step(s) are undefined." gradle/build/reports/tests/test/classes/io.cucumber.skeleton.RunCucumberTest.html  || ( echo "gradle test didn't fail as expected" && false )
-      - name: compare gradle and maven sources
-        run: diff gradle/src maven/src
+          distribution: 'temurin'
+          java-version: ${{ matrix.version }}
+          cache: 'maven'
+      - name: Gradle Test
+        run: ./gradlew test

.gitignore

@@ -5,4 +5,8 @@
 # Eclipse IDE
 .settings
 .classpath
-.project
+.project
+
+# Gradle
+.gradle
+build

README.md

@@ -1,11 +1,11 @@
-# Cucumber-Java Skeleton
+# Cucumber-JVM Starter: Java with Gradle
 
-This is the simplest possible setup for Cucumber using Java. There is nothing
-fancy like a webapp or browser testing. All this does is to show you how to
-set up and run Cucumber!
+This is the simplest possible setup for Cucumber using Java with Gralde.
+There is nothing fancy like a webapp or browser testing. All this does is to
+show you how to set up and run Cucumber!
 
 There is a single feature file with one scenario. The scenario has three steps,
-two of them pending. See if you can make them all pass!
+one passing, skipped and undefined. See if you can make them all pass!
 
 To write assertions the project comes with [AssertJ](https://assertj.github.io/doc/#assertj-core-assertions-guide)
 included. 
@@ -14,32 +14,15 @@ included.
 
 Git:
 
-    git clone https://github.com/cucumber/cucumber-java-skeleton.git
-    cd cucumber-java-skeleton
+    git clone https://github.com/cucumber/cucumber-jvm-starter-gradle-java.git
+    cd cucumber-jvm-starter-gradle-java
 
-Subversion:
-
-    svn checkout https://github.com/cucumber/cucumber-java-skeleton/trunk cucumber-java-skeleton
-    cd cucumber-java-skeleton
-
-Or [download a zip](https://github.com/cucumber/cucumber-java-skeleton/archive/main.zip) file.
+Or [download a zip](https://github.com/cucumber/cucumber-jvm-starter-gradle-java/archive/main.zip) file.
 
 ## Run the tests
-### Use Maven
 
 Open a command window and run:
 
-    cd maven
-    ./mvnw test
-
-This runs Cucumber features using Cucumber's JUnit Platform Engine. The `Suite`
-annotation on the `RunCucumberTest` class tells JUnit to kick off Cucumber.
-
-### Use Gradle
-
-Open a command window and run:
-
-    cd gradle
     ./gradlew test --rerun-tasks --info
 
 This runs Cucumber features using Cucumber's JUnit Platform Engine. The `Suite`
@@ -80,31 +63,30 @@ Then add an annotation to `RunCucumberTest`.
 @IncludeTags("Zucchini")
 ```
 
-When using Maven, tags can be selected from the CLI using the `groups` and `excludedGroups` parameters. These take a
+These take a
 [JUnit5 Tag Expression](https://junit.org/junit5/docs/current/user-guide/#running-tests-tag-expressions). 
 Note: When using JUnit, the `@` is not part of the tag.
 
+Tags can also be selected from the CLI using the `cucumber.filter.tags` parameter.
+This takes a [Cucumber Expression](https://github.com/cucumber/cucumber-expressions).
+
 ```
-mvn verify -DexcludedGroups="Haricots" -Dgroups="Zucchini | Gherkin"
+./gradlew test --rerun-tasks --info -Dcucumber.filter.tags="not @Haricots and (@Zucchini or @Gherkin)" 
 ```
 
+Note: Add `-Dcucumber.plugin=pretty` to get a more detailed output during test execution.
+
 ### Running a single scenario or feature
 
-Maven and Gradle do not (yet) support selecting single features or scenarios
+Gradle does not (yet) support selecting single features or scenarios
 with JUnit selectors. As a work around the `cucumber.features` property can be
 used. Because this property will cause Cucumber to ignore any other selectors
 from JUnit it is prudent to only execute the Cucumber engine.
 
-#### With Maven
-
 To select the scenario on line 3 of the `belly.feature` file use:
 
 ```
-./mvnw test -Dsurefire.includeJUnit5Engines=cucumber -Dcucumber.features=src/test/resources/io/cucumber/skeleton/belly.feature:3 
+./gradlew test --rerun-tasks --info -Dcucumber.features=src/test/resources/io/cucumber/skeleton/belly.feature:3 -Dcucumber.plugin=pretty
 ```
 
 Note: Add `-Dcucumber.plugin=pretty` to get a more detailed output during test execution.
-
-#### With Gradle
-
-TODO: (I don't know how to do this. Feel free to send a pull request. ;))

gradle/build.gradle.kts build.gradle.ktsgradle/build.gradle.kts renamed to build.gradle.kts

@@ -19,7 +19,18 @@ repositories {
 }
 
 tasks.withType<Test> {
-    useJUnitPlatform()
+    useJUnitPlatform {
+        // When running an individual scenario, assume we only want to run 
+        // Cucumber
+        System.getProperty("cucumber.features")?.let { includeEngines("cucumber") }
+    }
+
+    // Pass selected system properties to Cucumber
+    System.getProperty("cucumber.features")?.let { systemProperty("cucumber.features", it) }
+    System.getProperty("cucumber.filter.tags")?.let { systemProperty("cucumber.filter.tags", it) }
+    System.getProperty("cucumber.filter.name")?.let { systemProperty("cucumber.filter.name", it) }
+    System.getProperty("cucumber.plugin")?.let { systemProperty("cucumber.plugin", it) }
+
     // Work around. Gradle does not include enough information to disambiguate
     // between different examples and scenarios.
     systemProperty("cucumber.junit-platform.naming-strategy", "long")

gradle/.gitignore

@@ -1,93 +1,93 @@
-@rem
-@rem Copyright 2015 the original author or authors.
-@rem
-@rem Licensed under the Apache License, Version 2.0 (the "License");
-@rem you may not use this file except in compliance with the License.
-@rem You may obtain a copy of the License at
-@rem
-@rem      https://www.apache.org/licenses/LICENSE-2.0
-@rem
-@rem Unless required by applicable law or agreed to in writing, software
-@rem distributed under the License is distributed on an "AS IS" BASIS,
-@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-@rem See the License for the specific language governing permissions and
-@rem limitations under the License.
-@rem
-@rem SPDX-License-Identifier: Apache-2.0
-@rem
-
-@if "%DEBUG%"=="" @echo off
-@rem ##########################################################################
-@rem
-@rem  Gradle startup script for Windows
-@rem
-@rem ##########################################################################
-
-@rem Set local scope for the variables with windows NT shell
-if "%OS%"=="Windows_NT" setlocal
-
-set DIRNAME=%~dp0
-if "%DIRNAME%"=="" set DIRNAME=.
-@rem This is normally unused
-set APP_BASE_NAME=%~n0
-set APP_HOME=%DIRNAME%
-
-@rem Resolve any "." and ".." in APP_HOME to make it shorter.
-for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
-
-@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
-
-@rem Find java.exe
-if defined JAVA_HOME goto findJavaFromJavaHome
-
-set JAVA_EXE=java.exe
-%JAVA_EXE% -version >NUL 2>&1
-if %ERRORLEVEL% equ 0 goto execute
-
-echo. 1>&2
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
-echo. 1>&2
-echo Please set the JAVA_HOME variable in your environment to match the 1>&2
-echo location of your Java installation. 1>&2
-
-goto fail
-
-:findJavaFromJavaHome
-set JAVA_HOME=%JAVA_HOME:"=%
-set JAVA_EXE=%JAVA_HOME%/bin/java.exe
-
-if exist "%JAVA_EXE%" goto execute
-
-echo. 1>&2
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
-echo. 1>&2
-echo Please set the JAVA_HOME variable in your environment to match the 1>&2
-echo location of your Java installation. 1>&2
-
-goto fail
-
-:execute
-@rem Setup the command line
-
-
-
-@rem Execute Gradle
-"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
-
-:end
-@rem End local scope for the variables with windows NT shell
-if %ERRORLEVEL% equ 0 goto mainEnd
-
-:fail
-rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
-rem the _cmd.exe /c_ return code!
-set EXIT_CODE=%ERRORLEVEL%
-if %EXIT_CODE% equ 0 set EXIT_CODE=1
-if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
-exit /b %EXIT_CODE%
-
-:mainEnd
-if "%OS%"=="Windows_NT" endlocal
-
-:omega
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem      https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+@rem SPDX-License-Identifier: Apache-2.0
+@rem
+
+@if "%DEBUG%"=="" @echo off
+@rem ##########################################################################
+@rem
+@rem  Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if %ERRORLEVEL% equ 0 goto execute
+
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto execute
+
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
+
+goto fail
+
+:execute
+@rem Setup the command line
+
+
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
+
+:end
+@rem End local scope for the variables with windows NT shell
+if %ERRORLEVEL% equ 0 goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega