Fix for PropertiesFileTransformer breaks Reproducible builds in 8.1.1 #856

.circleci/config.yml

@@ -1,7 +1,7 @@
 defaults: &defaults
   working_directory: ~/shadow
   docker:
-    - image: cimg/openjdk:17.0
+    - image: azul/zulu-openjdk:21-latest
   environment:
     - TERM: "dumb"
     - GRADLE_OPTS: "-Xmx1024m"
@@ -29,7 +29,7 @@ jobs:
           paths:
             - ~/.gradle
 
-      - run: ./gradlew build --scan
+      - run: ./gradlew build
 
       - run:
           name: Save test results

.github/workflows/gradle-wrapper-validation.yml

@@ -16,5 +16,5 @@ jobs:
     name: "Validation"
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: gradle/wrapper-validation-action@v1
+      - uses: actions/checkout@v4
+      - uses: gradle/actions/wrapper-validation@v3

build.gradle

@@ -7,9 +7,9 @@ plugins {
     id 'idea'
     id 'java-gradle-plugin'
     id 'signing'
-    id 'com.gradle.plugin-publish' version '1.1.0'
-    id 'org.ajoberstar.git-publish' version '4.1.1'
-    id 'com.github.node-gradle.node' version '3.5.1'
+    id 'com.gradle.plugin-publish' version '1.2.1'
+    id 'org.ajoberstar.git-publish' version '4.2.2'
+    id 'com.github.node-gradle.node' version '7.0.2'
 }
 
 apply plugin: ShadowPlugin
@@ -20,11 +20,6 @@ apply from: file('gradle/vuepress.gradle')
 apply from: file('gradle/ghPages.gradle')
 apply from: file('gradle/dependencies.gradle')
 
-repositories {
-    gradlePluginPortal()
-    mavenCentral()
-}
-
 tasks.withType(Test).configureEach {
     useJUnitPlatform()
 
@@ -34,25 +29,21 @@ tasks.withType(Test).configureEach {
         maxHeapSize "1g"
     }
 
-    systemProperty 'java.io.tmpdir', buildDir.absolutePath
+    systemProperty 'java.io.tmpdir', project.layout.buildDirectory.asFile.get().absolutePath
 
     // Required to test configuration cache in tests when using withDebug()
     // https://github.com/gradle/gradle/issues/22765#issuecomment-1339427241
     jvmArgs(
-            "--add-opens",
-            "java.base/java.util=ALL-UNNAMED",
-            "--add-opens",
-            "java.base/java.util.concurrent.atomic=ALL-UNNAMED",
-            "--add-opens",
-            "java.base/java.lang.invoke=ALL-UNNAMED",
-            "--add-opens",
-            "java.base/java.net=ALL-UNNAMED",
+            "--add-opens", "java.base/java.util=ALL-UNNAMED",
+            "--add-opens", "java.base/java.util.concurrent.atomic=ALL-UNNAMED",
+            "--add-opens", "java.base/java.lang.invoke=ALL-UNNAMED",
+            "--add-opens", "java.base/java.net=ALL-UNNAMED",
     )
 }
 
 // Remove the gradleApi so it isn't merged into the jar file.
 // This is required because 'java-gradle-plugin' adds gradleApi() to the 'api' configuration.
-// See https://github.com/gradle/gradle/blob/master/subprojects/plugin-development/src/main/java/org/gradle/plugin/devel/plugins/JavaGradlePluginPlugin.java#L162
+// See https://github.com/gradle/gradle/blob/972c3e5c6ef990dd2190769c1ce31998a9402a79/subprojects/plugin-development/src/main/java/org/gradle/plugin/devel/plugins/JavaGradlePluginPlugin.java#L161
 configurations.named(JavaPlugin.API_CONFIGURATION_NAME) {
     dependencies.remove(project.dependencies.gradleApi())
 }

buildSrc/build.gradle

@@ -41,7 +41,7 @@ class ScriptHolder {
 
 //Grab the dependencies closure and resolve it against
 //the buildSrc project dependencies
-//This effectively applies the same dependenices from build.gradle into buildSrc/build.gradle
+//This effectively applies the same dependencies from build.gradle into buildSrc/build.gradle
 //This is required so that when buildSrc is compiled it has the dependencies to compile the source code
 def closure = holder.dependencies.clone()
 closure.delegate = project.dependencies

gradle.properties

@@ -1,4 +1,4 @@
-org.gradle.jvmargs=-Xmx4g -XX:MaxMetaspaceSize=2g
+org.gradle.jvmargs=-Dfile.encoding=UTF-8 -Xmx4g -XX:MaxMetaspaceSize=2g
 org.gradle.parallel=true
 org.gradle.caching=true
-org.gradle.unsafe.configuration-cache=true
+org.gradle.configuration-cache=true

gradle/dependencies.gradle

@@ -4,13 +4,14 @@ dependencies {
     shadow 'org.codehaus.groovy:groovy-backports-compat23:3.0.8'
 
     implementation 'org.jdom:jdom2:2.0.6.1'
-    implementation 'org.ow2.asm:asm:9.5'
-    implementation 'org.ow2.asm:asm-commons:9.5'
-    implementation 'commons-io:commons-io:2.11.0'
-    implementation 'org.apache.ant:ant:1.10.13'
-    implementation 'org.codehaus.plexus:plexus-utils:3.5.1'
-    implementation "org.apache.logging.log4j:log4j-core:2.20.0"
-    implementation('org.vafer:jdependency:2.8.0') {
+    implementation 'org.ow2.asm:asm:9.7'
+    implementation 'org.ow2.asm:asm-commons:9.7'
+    implementation 'commons-io:commons-io:2.16.1'
+    implementation 'org.apache.ant:ant:1.10.14'
+    implementation 'org.codehaus.plexus:plexus-utils:4.0.1'
+    implementation 'org.codehaus.plexus:plexus-xml:4.0.4'
+    implementation "org.apache.logging.log4j:log4j-core:2.23.1"
+    implementation('org.vafer:jdependency:2.10') {
         exclude group: 'org.ow2.asm'
     }
 
@@ -19,8 +20,9 @@ dependencies {
     }
     testImplementation 'org.spockframework:spock-junit4:2.3-groovy-3.0'
     testImplementation 'xmlunit:xmlunit:1.6'
-    testImplementation 'org.apache.commons:commons-lang3:3.12.0'
-    testImplementation 'com.google.guava:guava:31.1-jre'
-    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.9.2'
-    testRuntimeOnly 'org.junit.vintage:junit-vintage-engine:5.9.2'
+    testImplementation 'org.apache.commons:commons-lang3:3.14.0'
+    testImplementation 'com.google.guava:guava:33.2.1-jre'
+    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.2'
+    testRuntimeOnly 'org.junit.vintage:junit-vintage-engine:5.10.2'
+    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
 }

gradle/publish.gradle

@@ -47,10 +47,6 @@ signing {
     sign(publishing.publications)
 }
 
-tasks.withType(Sign).configureEach {
-    notCompatibleWithConfigurationCache("https://github.com/gradle/gradle/issues/13470")
-}
-
 tasks.register('release') {
     dependsOn tasks.named('assemble'), tasks.named('publishPlugins'), tasks.named('gitPublishPush')
 }

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-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/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -83,10 +83,8 @@ done
 # This is normally unused
 # shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-# 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,26 +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=SC3045
+        # 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=SC3045
+        # shellcheck disable=SC2039,SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -197,11 +198,15 @@ 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" \

gradlew.bat

@@ -43,11 +43,11 @@ set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
 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
 
@@ -57,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
 

settings.gradle

@@ -6,15 +6,23 @@ pluginManagement {
 }
 
 plugins {
-    id 'com.gradle.enterprise' version '3.12.6'
+    id 'com.gradle.develocity' version '3.17.4'
 }
 
-gradleEnterprise {
+dependencyResolutionManagement {
+    repositories {
+        mavenCentral()
+    }
+}
+
+def isCI = providers.environmentVariable('CI').present
+
+develocity {
     buildScan {
-        termsOfServiceUrl = 'https://gradle.com/terms-of-service'
-        termsOfServiceAgree = 'yes'
-        publishAlways()
-        if (System.env.CI == 'true') {
+        termsOfUseUrl = 'https://gradle.com/terms-of-service'
+        termsOfUseAgree = 'yes'
+        publishing.onlyIf { isCI }
+        if (isCI) {
             tag 'CI'
             if (System.env.CIRCLE_TAG) {
                 link 'VCS', "https://github.com/johnrengelman/shadow/tree/${System.env.CIRCLE_TAG}"

src/docs/application-plugin/README.md

@@ -13,7 +13,9 @@ apply plugin: 'java'
 apply plugin: 'application'
 apply plugin: 'com.github.johnrengelman.shadow'
 
-mainClassName = 'myapp.Main'
+application {
+    mainClass = 'myapp.Main'
+}
 ```
 
 ## Running the Shadow JAR

src/main/groovy/com/github/jengelman/gradle/plugins/shadow/ShadowApplicationPlugin.groovy

@@ -86,7 +86,7 @@ class ShadowApplicationPlugin implements Plugin<Project> {
             startScripts.classpath = project.files(jar)
             startScripts.conventionMapping.mainClassName = { javaApplication.mainClass.get() }
             startScripts.conventionMapping.applicationName = { javaApplication.applicationName }
-            startScripts.conventionMapping.outputDir = { new File(project.buildDir, 'scriptsShadow') }
+            startScripts.conventionMapping.outputDir = { new File(project.layout.buildDirectory.asFile.get(), 'scriptsShadow') }
             startScripts.conventionMapping.defaultJvmOpts = { javaApplication.applicationDefaultJvmArgs }
             startScripts.inputs.files project.objects.fileCollection().from { -> jar }
         }
@@ -126,7 +126,7 @@ class ShadowApplicationPlugin implements Plugin<Project> {
             }
             into("bin") {
                 from(startScripts)
-                fileMode = 493
+                filePermissions { unix(493) }
             }
         }
 

src/main/groovy/com/github/jengelman/gradle/plugins/shadow/ShadowBasePlugin.groovy

@@ -13,15 +13,15 @@ class ShadowBasePlugin implements Plugin<Project> {
 
     @Override
     void apply(Project project) {
-        if (GradleVersion.current() < GradleVersion.version("8.0")) {
-            throw new GradleException("This version of Shadow supports Gradle 8.0+ only. Please upgrade.")
+        if (GradleVersion.current() < GradleVersion.version("8.3")) {
+            throw new GradleException("This version of Shadow supports Gradle 8.3+ only. Please upgrade.")
         }
         project.extensions.create(EXTENSION_NAME, ShadowExtension, project)
         createShadowConfiguration(project)
 
         project.tasks.register(KnowsTask.NAME, KnowsTask) { knows ->
             knows.group = ShadowJavaPlugin.SHADOW_GROUP
-            knows.description = KnowsTask.DESC
+            knows.description = DESC
         }
     }
 

src/main/groovy/com/github/jengelman/gradle/plugins/shadow/ShadowPlugin.groovy

@@ -6,8 +6,6 @@ import org.gradle.api.Project
 import org.gradle.api.plugins.ApplicationPlugin
 import org.gradle.api.plugins.JavaPlugin
 
-import static java.util.Objects.nonNull
-
 class ShadowPlugin implements Plugin<Project> {
 
     @Override
@@ -21,17 +19,25 @@ class ShadowPlugin implements Plugin<Project> {
                 plugins.apply(ShadowApplicationPlugin)
             }
 
+            // Legacy build scan support for Gradle Enterprise, users should migrate to develocity plugin.
             rootProject.plugins.withId('com.gradle.enterprise') {
-                rootProject.buildScan.buildFinished {
-                    def shadowTasks = tasks.withType(ShadowJar)
-                    shadowTasks.each { task ->
-                        if (task.didWork) {
-                            task.stats.buildScanData.each { k, v ->
-                                rootProject.buildScan.value "shadow.${task.path}.${k}", v.toString()
-                            }
-                            rootProject.buildScan.value "shadow.${task.path}.configurations", task.configurations*.name.join(", ")
-                        }
+                configureBuildScan(rootProject)
+            }
+            rootProject.plugins.withId('com.gradle.develocity') {
+                configureBuildScan(rootProject)
+            }
+        }
+    }
+
+    private void configureBuildScan(Project rootProject) {
+        rootProject.buildScan.buildFinished {
+            def shadowTasks = tasks.withType(ShadowJar)
+            shadowTasks.each { task ->
+                if (task.didWork) {
+                    task.stats.buildScanData.each { k, v ->
+                        rootProject.buildScan.value "shadow.${task.path}.${k}", v.toString()
                     }
+                    rootProject.buildScan.value "shadow.${task.path}.configurations", task.configurations*.name.join(", ")
                 }
             }
         }

src/main/groovy/com/github/jengelman/gradle/plugins/shadow/ShadowStats.groovy

@@ -75,7 +75,7 @@ class ShadowStats {
     Map<String, String> getBuildScanData() {
         [
                 dependencies: jarCount,
-                relocations: relocationString
-        ]
+                relocations : relocationString,
+        ] as Map<String, String>
     }
 }