Update Gradle to 8.5 and ZAP to 2.14

Update Gradle Wrapper to 8.5 and ZAP to latest version. Apply the common plugins and remove now redundant configurations. Update GitHub Actions in workflows. Apply Spotless changes to the `Messages.properties` file. Signed-off-by: thc202 <[email protected]>
zaproxy · Dec 4, 2023 · 18136f1 · 18136f1
1 parent cfa1896
commit 18136f1
Show file tree

Hide file tree

Showing 13 changed files with 31 additions and 58 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -14,8 +14,8 @@ jobs:
         java: [11]
 
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-java@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
           java-version: ${{ matrix.java }}

diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -23,7 +23,7 @@ jobs:
         language: [ 'java', 'javascript', 'python', 'ruby' ]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: github/codeql-action/init@v2
         with:
           languages: ${{ matrix.language }}

diff --git a/.github/workflows/crowdin-upload-files.yml b/.github/workflows/crowdin-upload-files.yml
@@ -8,9 +8,9 @@ jobs:
     name: Upload Files
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Setup Java
-      uses: actions/setup-java@v3
+      uses: actions/setup-java@v4
       with:
         distribution: 'temurin'
         java-version: 11

diff --git a/.github/workflows/prepare-release-add-on.yml b/.github/workflows/prepare-release-add-on.yml
@@ -8,12 +8,12 @@ jobs:
     name: Prepare Release
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
         persist-credentials: false
     - name: Setup Java
-      uses: actions/setup-java@v3
+      uses: actions/setup-java@v4
       with:
         distribution: 'temurin'
         java-version: 11

diff --git a/.github/workflows/release-add-on.yml b/.github/workflows/release-add-on.yml
@@ -12,12 +12,12 @@ jobs:
     name: Build and Release Add-On
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
         persist-credentials: false
     - name: Setup Java
-      uses: actions/setup-java@v3
+      uses: actions/setup-java@v4
       with:
         distribution: 'temurin'
         java-version: 11

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,7 +5,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [Unreleased]
 ### Changed
-- Update minimum ZAP version to 2.13.0.
+- Update minimum ZAP version to 2.14.0.
 - Remove checks for CFU initiator in HTTP Sender scripts and docs, no longer needed.
 - Rename AWS signing script.
 - Update descriptions/comments in scripts.

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -7,13 +7,10 @@ import org.zaproxy.gradle.addon.misc.ConvertMarkdownToHtml
 
 plugins {
     `java-library`
-    id("org.zaproxy.add-on") version "0.9.0"
+    id("org.zaproxy.add-on") version "0.10.0"
     id("org.zaproxy.crowdin") version "0.3.1"
-    id("com.diffplug.spotless") version "6.20.0"
-}
-
-repositories {
-    mavenCentral()
+    id("com.diffplug.spotless")
+    id("org.zaproxy.common")
 }
 
 description = "Useful ZAP scripts written by the ZAP community."
@@ -23,7 +20,7 @@ val scriptsDir = layout.buildDirectory.dir("scripts")
 zapAddOn {
     addOnId.set("communityScripts")
     addOnName.set("Community Scripts")
-    zapVersion.set("2.13.0")
+    zapVersion.set("2.14.0")
     addOnStatus.set(AddOnStatus.ALPHA)
 
     releaseLink.set("https://github.com/zaproxy/community-scripts/compare/v@[email protected]@CURRENT_VERSION@")
@@ -64,11 +61,6 @@ dependencies {
     testImplementation("org.python:jython-standalone:2.7.2")
 }
 
-tasks.withType<JavaCompile>().configureEach {
-    options.encoding = "UTF-8"
-    options.compilerArgs = listOf("-Xlint:all", "-Xlint:-options", "-Werror")
-}
-
 tasks.withType<Test>().configureEach {
     useJUnitPlatform()
 }
@@ -117,12 +109,6 @@ java {
 sourceSets["main"].output.dir(mapOf("builtBy" to syncScriptsDirTask), scriptsDir)
 
 spotless {
-    java {
-        licenseHeaderFile("$rootDir/gradle/spotless/license.java")
-
-        googleJavaFormat("1.17.0").aosp()
-    }
-
     kotlinGradle {
         ktlint()
     }

diff --git a/gradle/spotless/license.java b/gradle/spotless/license.java
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,7 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionSha256Sum=7c3ad722e9b0ce8205b91560fd6ce8296ac3eadf065672242fd73c06b8eeb6ee
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-all.zip
+distributionSha256Sum=c16d517b50dd28b3f5838f0e844b7520b8f1eb610f2f29de7e4e04a1b7c9c79b
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-all.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

diff --git a/gradlew b/gradlew
@@ -83,7 +83,8 @@ done
 # This is normally unused
 # shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
+# 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
@@ -144,15 +145,15 @@ 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
@@ -201,11 +202,11 @@ fi
 # 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, 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.
+# 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" \

diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -1 +1,6 @@
+plugins {
+    id("org.zaproxy.common.settings") version "0.2.0"
+    id("com.diffplug.spotless") version "6.20.0" apply false
+}
+
 rootProject.name = "community-scripts"
diff --git a/src/main/resources/org/zaproxy/zap/extension/communityScripts/resources/Messages.properties b/src/main/resources/org/zaproxy/zap/extension/communityScripts/resources/Messages.properties
@@ -1,2 +1,2 @@
-communityScripts.name = Community Scripts
 communityScripts.desc = Community Scripts from https://github.com/zaproxy/community-scripts
+communityScripts.name = Community Scripts