diff --git a/test/test-init-scripts/.gitignore b/test/test-init-scripts/.gitignore new file mode 100644 index 0000000..91ea741 --- /dev/null +++ b/test/test-init-scripts/.gitignore @@ -0,0 +1,2 @@ +build +.gradle diff --git a/test/test-init-scripts/build.gradle b/test/test-init-scripts/build.gradle new file mode 100644 index 0000000..35d69ed --- /dev/null +++ b/test/test-init-scripts/build.gradle @@ -0,0 +1,23 @@ +plugins { + id 'groovy' +} + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(8) + } +} + +repositories { + mavenCentral() +} + +dependencies { + testImplementation gradleTestKit() + testImplementation 'org.spockframework:spock-core:2.1-groovy-3.0' + testImplementation('org.spockframework:spock-junit4:2.1-groovy-3.0') +} + +test { + useJUnitPlatform() +} diff --git a/test/test-init-scripts/gradle/wrapper/gradle-wrapper.jar b/test/test-init-scripts/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..41d9927 Binary files /dev/null and b/test/test-init-scripts/gradle/wrapper/gradle-wrapper.jar differ diff --git a/test/test-init-scripts/gradle/wrapper/gradle-wrapper.properties b/test/test-init-scripts/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..aa991fc --- /dev/null +++ b/test/test-init-scripts/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/test/test-init-scripts/gradlew b/test/test-init-scripts/gradlew new file mode 100755 index 0000000..1b6c787 --- /dev/null +++ b/test/test-init-scripts/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed 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 +# +# https://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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# 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 +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +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"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +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. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + 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. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/test/test-init-scripts/gradlew.bat b/test/test-init-scripts/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/test/test-init-scripts/gradlew.bat @@ -0,0 +1,89 @@ +@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 + +@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=. +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%" == "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. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +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. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="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 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/test/test-init-scripts/settings.gradle b/test/test-init-scripts/settings.gradle new file mode 100644 index 0000000..8346528 --- /dev/null +++ b/test/test-init-scripts/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'test-init-scripts' diff --git a/test/test-init-scripts/src/test/groovy/com/gradle/gradlebuildaction/BaseInitScriptTest.groovy b/test/test-init-scripts/src/test/groovy/com/gradle/gradlebuildaction/BaseInitScriptTest.groovy new file mode 100644 index 0000000..ebe9b94 --- /dev/null +++ b/test/test-init-scripts/src/test/groovy/com/gradle/gradlebuildaction/BaseInitScriptTest.groovy @@ -0,0 +1,133 @@ +package com.gradle.gradlebuildaction + +import org.gradle.testkit.runner.BuildResult +import org.gradle.testkit.runner.GradleRunner +import org.gradle.testkit.runner.internal.DefaultGradleRunner +import org.gradle.util.GradleVersion +import spock.lang.Specification +import spock.lang.TempDir + +import java.nio.file.Files + +class BaseInitScriptTest extends Specification { + + static final TestGradleVersion GRADLE_3_5 = new TestGradleVersion(GradleVersion.version('3.5.1'), 7, 9) + static final TestGradleVersion GRADLE_4_0 = new TestGradleVersion(GradleVersion.version('4.0.2'), 7, 9) + static final TestGradleVersion GRADLE_4_10 = new TestGradleVersion(GradleVersion.version('4.10.3'), 7, 10) + static final TestGradleVersion GRADLE_5_0 = new TestGradleVersion(GradleVersion.version('5.0'), 8, 11) + static final TestGradleVersion GRADLE_5_6 = new TestGradleVersion(GradleVersion.version('5.6.4'), 8, 12) + static final TestGradleVersion GRADLE_6_0 = new TestGradleVersion(GradleVersion.version('6.0.1'), 8, 13) + static final TestGradleVersion GRADLE_6_7 = new TestGradleVersion(GradleVersion.version('6.7'), 8, 15) + static final TestGradleVersion GRADLE_7_0 = new TestGradleVersion(GradleVersion.version('7.0.2'), 8, 16) + static final TestGradleVersion GRADLE_7_4 = new TestGradleVersion(GradleVersion.version('7.4.2'), 8, 17) + + static final List ALL_VERSIONS = [ + GRADLE_3_5, // First version where TestKit supports environment variables + GRADLE_4_0, + GRADLE_4_10, + GRADLE_5_0, + GRADLE_5_6, + GRADLE_6_0, + GRADLE_6_7, + GRADLE_7_0, + GRADLE_7_4, + ] + + static final List CONFIGURATION_CACHE_VERSIONS = + [GRADLE_7_0, GRADLE_7_4] + + File settingsFile + File buildFile + + @TempDir + File testProjectDir + + def setup() { + settingsFile = new File(testProjectDir, 'settings.gradle') + buildFile = new File(testProjectDir, 'build.gradle') + + File srcInitScriptsDir = new File("../../src/resources") + File targetInitScriptsDir = new File(testProjectDir, "initScripts") + targetInitScriptsDir.mkdirs() + + for (File srcInitScript : srcInitScriptsDir.listFiles()) { + File targetInitScript = new File(targetInitScriptsDir, srcInitScript.name) + Files.copy(srcInitScript.toPath(), targetInitScript.toPath()) + } + settingsFile << "rootProject.name = 'test-init-script'\n" + buildFile << '' + } + + def addFailingTaskToBuild() { + buildFile << ''' +task expectFailure { + doLast { + throw new RuntimeException("Expected to fail") + } +} +''' + } + + BuildResult run(List args, String initScript, GradleVersion gradleVersion = GradleVersion.current(), List jvmArgs = [], Map envVars = [:]) { + createRunner(initScript, args, gradleVersion, jvmArgs, envVars).build() + } + + BuildResult runAndFail(List args, String initScript, GradleVersion gradleVersion = GradleVersion.current(), List jvmArgs = [], Map envVars = [:]) { + createRunner(initScript, args, gradleVersion, jvmArgs, envVars).buildAndFail() + } + + GradleRunner createRunner(String initScript, List args, GradleVersion gradleVersion = GradleVersion.current(), List jvmArgs = [], Map envVars = [:]) { + File initScriptsDir = new File(testProjectDir, "initScripts") + args << '-I' << new File(initScriptsDir, initScript).absolutePath + + envVars['RUNNER_TEMP'] = testProjectDir.absolutePath + envVars['GITHUB_ACTION'] = 'github-step-id' + + def runner = ((DefaultGradleRunner) GradleRunner.create()) + .withJvmArguments(jvmArgs) + .withGradleVersion(gradleVersion.version) + .withProjectDir(testProjectDir) + .withArguments(args) + .forwardOutput() + + if (envVars) { + runner.withEnvironment(envVars) + } + + runner + } + + static final class TestGradleVersion { + + final GradleVersion gradleVersion + private final Integer jdkMin + private final Integer jdkMax + + TestGradleVersion(GradleVersion gradleVersion, Integer jdkMin, Integer jdkMax) { + this.gradleVersion = gradleVersion + this.jdkMin = jdkMin + this.jdkMax = jdkMax + } + + boolean isCompatibleWithCurrentJvm() { + def jvmVersion = getJvmVersion() + jdkMin <= jvmVersion && jvmVersion <= jdkMax + } + + private static int getJvmVersion() { + String version = System.getProperty('java.version') + if (version.startsWith('1.')) { + Integer.parseInt(version.substring(2, 3)) + } else { + Integer.parseInt(version.substring(0, version.indexOf('.'))) + } + } + + @Override + String toString() { + return "Gradle " + gradleVersion.version + } + + } + +} diff --git a/test/test-init-scripts/src/test/groovy/com/gradle/gradlebuildaction/TestProjectRootCapture.groovy b/test/test-init-scripts/src/test/groovy/com/gradle/gradlebuildaction/TestProjectRootCapture.groovy new file mode 100644 index 0000000..23049ea --- /dev/null +++ b/test/test-init-scripts/src/test/groovy/com/gradle/gradlebuildaction/TestProjectRootCapture.groovy @@ -0,0 +1,77 @@ +package com.gradle.gradlebuildaction + +import static org.junit.Assume.assumeTrue + +class TestProjectRootCapture extends BaseInitScriptTest { + def initScript = 'project-root-capture.init.gradle' + + def "captures project root on #testGradleVersion"() { + assumeTrue testGradleVersion.isCompatibleWithCurrentJvm() + + when: + run(['help'], initScript, testGradleVersion.gradleVersion) + + then: + assertCapturesProjectRoot() + + where: + testGradleVersion << CONFIGURATION_CACHE_VERSIONS + } + + def "captures project root on #testGradleVersion when build fails"() { + assumeTrue testGradleVersion.isCompatibleWithCurrentJvm() + + addFailingTaskToBuild() + + when: + runAndFail(['expectFailure'], initScript, testGradleVersion.gradleVersion) + + then: + assertCapturesProjectRoot() + + where: + testGradleVersion << CONFIGURATION_CACHE_VERSIONS + } + + def "captures project root on #testGradleVersion with --configuration-cache"() { + assumeTrue testGradleVersion.isCompatibleWithCurrentJvm() + + when: + run(['help', '--configuration-cache'], initScript, testGradleVersion.gradleVersion) + + then: + assertCapturesProjectRoot() + assert projectRootList.delete() + + when: + run(['help', '--configuration-cache'], initScript, testGradleVersion.gradleVersion) + + then: + assertCapturesProjectRoot() + + where: + testGradleVersion << CONFIGURATION_CACHE_VERSIONS + } + + def "has no effect on #testVersion"() { + assumeTrue testVersion.isCompatibleWithCurrentJvm() + + when: + run(['help'], initScript, testVersion.gradleVersion) + + then: + assert !projectRootList.exists() + + where: + testVersion << (ALL_VERSIONS - CONFIGURATION_CACHE_VERSIONS) + } + + private void assertCapturesProjectRoot() { + assert projectRootList.exists() + assert new File(projectRootList.text.trim()).canonicalPath == testProjectDir.canonicalPath + } + + private File getProjectRootList() { + new File(testProjectDir, 'project-roots.txt') + } +}