Merge pull request #34 from zeners/gradle_updates

Gradle updates

README.md

@@ -0,0 +1,39 @@
+Serenity-Gradle-Plugin
+======================
+
+Serenity-Gradle-Plugin adding tasks to generate reports from serenity test-results.   
+
+Requirements
+============
+
+* gradle 7.0+
+
+Gradle Tasks
+============
+
+* `gradle aggregate` Generates aggregated Serenity reports
+* `gradle reports` Generates extended Serenity reports
+* `gradle checkOutcomes ` Checks the Serenity reports and fails the build if there are test failures (run automatically with 'check')
+* `gradle clearReports` Deletes the Serenity output directory (run automatically with 'clean')
+
+Example 'build.gradle'
+======================
+
+```
+plugins {    
+    id 'net.serenity-bdd.serenity-gradle-plugin' version '4.1.9'
+}
+
+serenity {
+    outputDirectory = null      // String, report-directory
+    projectKey = null           // String, overwrites 'serenity.project.key'
+    issueTrackerUrl = null      // String, base URL for the issue tracking system to be referred to in the reports
+    jiraUrl = null              // String, If the base JIRA URL is defined, Serenity will build the issue tracker url using the standard JIRA form
+    jiraProject = null          // String, ff defined, the JIRA project id will be prepended to issue numbers
+    requirementsBaseDir = null  // String, overwrites 'serenity.test.requirements.basedir'
+    requirementsDir = null      // String, overwrites 'serenity.requirements.dir'             
+    testRoot = null             // String, overwrites 'serenity.test.root' 
+    generateOutcomes = true     // generate report
+    reports = []                // extended report types for reports-task    
+}
+```

build.gradle

@@ -14,9 +14,7 @@
  */
 
 plugins {
-    /// XXX - 2022-05-10: id 'com.gradle.plugin-publish' version '1.0.0-rc-1' requires changes
-    // not documented yet. See https://github.com/gradle/gradle/issues/20718
-    id 'com.gradle.plugin-publish' version '0.21.0'
+    id 'com.gradle.plugin-publish' version '1.2.1'
     id 'java-gradle-plugin'
 
     // Building
@@ -50,9 +48,9 @@ java {
 //    sign configurations.archives
 //}
 signing {
-    def signingKeyId = findProperty("signingKeyId")
-    def signingKey = findProperty("signingKey")
-    def signingPassword = findProperty("signingPassword")
+    def signingKeyId = findProperty("signingKeyId") as String
+    def signingKey = findProperty("signingKey") as String
+    def signingPassword = findProperty("signingPassword") as String
     useInMemoryPgpKeys(signingKeyId, signingKey, signingPassword)
     sign configurations.archives
 }
@@ -75,31 +73,33 @@ version = nextVersion
 println "BUILDING VERSION ${nextVersion}"
 
 
-task createNewVersionTag(type: Exec) {
+tasks.register('createNewVersionTag', Exec) {
     executable "sh"
     args "-c", "git tag -f -a v$nextVersion -m'release tag'"
 }
 
-task pushVersionTag(type: Exec, dependsOn: 'createNewVersionTag') {
+tasks.register('pushVersionTag', Exec) {
+    dependsOn 'createNewVersionTag'
     executable "sh"
     args "-c", "git push -f origin v$nextVersion"
 }
 
-task tagNewVersion() {
+tasks.register('tagNewVersion') {
     dependsOn pushVersionTag
 }
 
 wrapper {
-    gradleVersion = '7.4.2'
-    distributionType = 'all'
+    gradleVersion = '8.7'
+    distributionType = 'ALL'
 }
 
 test {
     maxParallelForks = Runtime.runtime.availableProcessors() * 4
+    useJUnitPlatform()
 }
 
 
-configurations.all {
+configurations.configureEach {
     resolutionStrategy {
         // fail fast on dependency convergence problems
         // failOnVersionConflict()
@@ -138,13 +138,13 @@ jar {
 //    from javadoc.destinationDir
 //}
 
-javadoc.options.addStringOption('Xdoclint:none', '-quiet')
+(javadoc.options as CoreJavadocOptions).addStringOption('Xdoclint:none', '-quiet')
 
 //artifacts {
 //    archives sourcesJar, javadocJar
 //}
 
-tasks.withType(JavaCompile) {
+tasks.withType(JavaCompile).configureEach {
     options.compilerArgs << "-Xlint:-options"
 }
 
@@ -216,24 +216,16 @@ tasks.withType(JavaCompile) {
 
 
 gradlePlugin {
-    plugins {
-        serenityPlugin {
-            id = 'net.serenity-bdd.serenity-gradle-plugin'
-            implementationClass = 'net.serenitybdd.plugins.gradle.SerenityPlugin'
-        }
-    }
-}
-
-pluginBundle {
     website = 'https://www.serenity-bdd.info/'
     vcsUrl = 'https://github.com/serenity-bdd/serenity-gradle-plugin'
-    description = 'Serenity Gradle Plugin'
-    tags = ['serenity-bdd', 'test-automation']
 
     plugins {
-        serenityPlugin {
-            // id is captured from java-gradle-plugin configuration
+        create('serenityPlugin') {
+            id = 'net.serenity-bdd.serenity-gradle-plugin'
+            implementationClass = 'net.serenitybdd.plugins.gradle.SerenityPlugin'
             displayName = 'Gradle Serenity BDD plugin'
+            description = 'Serenity Gradle Plugin'
+            tags = ['serenity-bdd', 'test-automation']
         }
     }
 }

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradlew

@@ -55,7 +55,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,13 +80,11 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -133,22 +131,29 @@ location of your Java installation."
     fi
 else
     JAVACMD=java
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
 
 Please set the JAVA_HOME variable in your environment to match the
 location of your Java installation."
+    fi
 fi
 
 # Increase the maximum file descriptors if we can.
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -193,18 +198,28 @@ if "$cygwin" || "$msys" ; then
     done
 fi
 
-# Collect all arguments for the java command;
-#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-#     shell script including quotes and variable substitutions, so put them in
-#     double quotes to make sure that they get re-expanded; and
-#   * put everything else in single quotes, so that it's not re-expanded.
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
 
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \
         -classpath "$CLASSPATH" \
         org.gradle.wrapper.GradleWrapperMain \
         "$@"
 
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
 # Use "xargs" to parse quoted args.
 #
 # With -n1 it outputs one arg per line, with the quotes and backslashes removed.

gradlew.bat

@@ -14,7 +14,7 @@
 @rem limitations under the License.
 @rem
 
-@if "%DEBUG%" == "" @echo off
+@if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
 @rem
 @rem  Gradle startup script for Windows
@@ -25,7 +25,8 @@
 if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
@@ -40,13 +41,13 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto execute
+if %ERRORLEVEL% equ 0 goto execute
 
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+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
 
@@ -56,11 +57,11 @@ set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
 if exist "%JAVA_EXE%" goto execute
 
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+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
 
@@ -75,13 +76,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
 :end
 @rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
+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!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
+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

src/main/groovy/net/serenitybdd/plugins/gradle/AggregateTask.groovy

@@ -8,6 +8,7 @@ import net.thucydides.model.requirements.DefaultRequirements
 import org.gradle.api.file.ProjectLayout
 import org.gradle.api.provider.Property
 import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.InputFiles
 import org.gradle.api.tasks.Optional
 import org.gradle.api.tasks.OutputDirectory
 import org.gradle.api.tasks.TaskAction
@@ -32,6 +33,9 @@ abstract class AggregateTask extends SerenityAbstractTask {
     @Optional @Input
     abstract Property<String> getIssueTrackerUrl()
 
+    @InputFiles
+    abstract Collection testResults
+
     @Optional @Input
     abstract Property<String> getJiraUrl()
 
@@ -42,7 +46,7 @@ abstract class AggregateTask extends SerenityAbstractTask {
     abstract Property<Boolean> getGenerateOutcomes()
 
     @OutputDirectory
-    abstract Path reportDirectory;
+    abstract Path reportDirectory
 
     @Inject
     AggregateTask(ProjectLayout layout) {
@@ -72,7 +76,7 @@ abstract class AggregateTask extends SerenityAbstractTask {
         def requirementsDir = getRequirementsDir().getOrNull()
         if (requirementsDir) {
 
-            SystemPropertiesConfiguration configuration = SerenityInfrastructure.getConfiguration()
+            SystemPropertiesConfiguration configuration = SerenityInfrastructure.getConfiguration() as SystemPropertiesConfiguration
             configuration.getEnvironmentVariables().setProperty('serenity.requirements.dir', requirementsDir)
         }
 
@@ -90,6 +94,6 @@ abstract class AggregateTask extends SerenityAbstractTask {
             reporter.setGenerateTestOutcomeReports();
         }
         reporter.generateReportsForTestResultsFrom(reporter.outputDirectory)
-        new ResultChecker(reporter.outputDirectory).checkTestResults();
+        new ResultChecker(reporter.outputDirectory).checkTestResults()
     }
 }

src/main/groovy/net/serenitybdd/plugins/gradle/ReportTask.groovy

@@ -51,7 +51,7 @@ abstract class ReportTask extends SerenityAbstractTask {
         for (ExtendedReport report : ExtendedReports.named(extendedReportTypes)) {
             report.sourceDirectory = reportDirectory
             report.outputDirectory = reportDirectory
-            URI reportPath = SerenityAbstractTask.absolutePathOf(report.generateReport()).toUri()
+            URI reportPath = absolutePathOf(report.generateReport()).toUri()
             logger.lifecycle("  - ${report.description}: ${reportPath}")
         }