Merge pull request #300 from kit-data-manager/development

PR for v1.3.2

.github/workflows/codeql-analysis.yml

@@ -42,7 +42,7 @@ jobs:
 
     # Initialize minimum JDK version
     - name: Setup Java JDK
-      uses: actions/setup-java@v4.2.1
+      uses: actions/setup-java@v4.5.0
       with:
         distribution: zulu
         java-version: 17

.github/workflows/gradle.yml

@@ -24,7 +24,7 @@ jobs:
     - name: Checkout repo
       uses: actions/checkout@v4
     - name: Set up OpenJDK version ...
-      uses: actions/setup-java@v4.2.1
+      uses: actions/setup-java@v4.5.0
       with:
         distribution: 'zulu' 
         java-version: ${{ matrix.jdk }}
@@ -50,7 +50,7 @@ jobs:
     - name: Checkout repo
       uses: actions/checkout@v4
     - name: Set up OpenJDK version ...
-      uses: actions/setup-java@v4.2.1
+      uses: actions/setup-java@v4.5.0
       with:
         distribution: 'zulu' 
         java-version: ${{ env.currentBuildVersion }}

.github/workflows/publishRelease.yml

@@ -9,7 +9,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Set up Java
-        uses: actions/setup-java@v4.2.1
+        uses: actions/setup-java@v4.5.0
         with:
           java-version: 17
           distribution: 'zulu' # openjdk

CHANGELOG.md

@@ -8,13 +8,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-### Changed
+### Fixed
 
-### Removed
+### Security
 
-### Deprecated
+## [1.3.2] - 2024-11-08
+
+### Added
+* Added a Javadoc badge to the README for easier access to documentation.
 
 ### Fixed
+* Enhanced error handling and portability in the gradlew and gradlew.bat scripts.
+
+### Security
+* Updated Java setup action versions across various workflow files for improved compatibility.
+* Upgraded multiple plugin and dependency versions in the build configuration for better performance and security.
+* Updated Gradle distribution version and added new properties for improved configuration.
 
 ## [1.3.1] - 2024-04-17
 
@@ -289,7 +298,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Security
 - none
 
-[Unreleased]: https://github.com/kit-data-manager/service-base/compare/v1.3.1...HEAD
+[Unreleased]: https://github.com/kit-data-manager/service-base/compare/v1.3.2...HEAD
+[1.3.2]: https://github.com/kit-data-manager/service-base/compare/v1.3.1...v1.3.2
 [1.3.1]: https://github.com/kit-data-manager/service-base/compare/v1.3.0...v1.3.1
 [1.3.0]: https://github.com/kit-data-manager/service-base/compare/v1.2.1...v1.3.0
 [1.2.1]: https://github.com/kit-data-manager/service-base/compare/v1.2.0...v1.2.1

README.md

@@ -1,6 +1,7 @@
 # KIT Data Manager - Service Base Module
 
 [![build with gradle](https://github.com/kit-data-manager/service-base/actions/workflows/gradle.yml/badge.svg)](https://github.com/kit-data-manager/service-base/actions/workflows/gradle.yml)
+[![javadoc](https://javadoc.io/badge2/edu.kit.datamanager/service-base/javadoc.svg)](https://javadoc.io/doc/edu.kit.datamanager/service-base)
 [![codecov](https://codecov.io/gh/kit-data-manager/service-base/branch/master/graph/badge.svg)](https://codecov.io/gh/kit-data-manager/service-base)
 [![CodeQL](https://github.com/kit-data-manager/service-base/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/kit-data-manager/service-base/actions/workflows/codeql-analysis.yml)
 ![License](https://img.shields.io/github/license/kit-data-manager/service-base.svg)

build.gradle

@@ -15,10 +15,10 @@
  * limitations under the License.
  */
 plugins { 
-    id "io.freefair.lombok" version "8.6"
-    id "io.freefair.maven-publish-java" version "8.6"
-    id "io.spring.dependency-management" version "1.1.4" 
-    id "org.owasp.dependencycheck" version "9.1.0"
+    id "io.freefair.lombok" version "8.10.2"
+    id "io.freefair.maven-publish-java" version "8.10.2"
+    id "io.spring.dependency-management" version "1.1.6" 
+    id "org.owasp.dependencycheck" version "11.1.0"
     id "java"
     id "jacoco"
     // plugins for release and publishing to maven repo
@@ -29,7 +29,7 @@ plugins {
 }
 
 ext { 
-    springBootVersion = '3.2.3' 
+    springBootVersion = '3.3.5' 
     springDocVersion  = '1.8.0'
 }
 
@@ -58,39 +58,39 @@ dependencies {
     implementation "org.springframework.boot:spring-boot-starter-security"
     implementation "org.springframework.boot:spring-boot-starter-actuator"
     implementation "org.springframework.boot:spring-boot-starter-data-jpa"
-    implementation "org.springframework.cloud:spring-cloud-gateway-mvc:4.0.6"
+    implementation "org.springframework.cloud:spring-cloud-gateway-mvc:4.1.5"
 
     implementation "org.springdoc:springdoc-openapi-ui:${springDocVersion}"
     implementation "org.springdoc:springdoc-openapi-data-rest:${springDocVersion}"
     implementation "org.springdoc:springdoc-openapi-webmvc-core:${springDocVersion}"
 
-    implementation "com.fasterxml.jackson.jaxrs:jackson-jaxrs-json-provider:2.17.0"
-    implementation "com.fasterxml.jackson.module:jackson-module-afterburner:2.17.0"
+    implementation "com.fasterxml.jackson.jaxrs:jackson-jaxrs-json-provider:2.18.1"
+    implementation "com.fasterxml.jackson.module:jackson-module-afterburner:2.18.1"
 
-    implementation "com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.17.0"
-    implementation "com.fasterxml.jackson.datatype:jackson-datatype-joda:2.17.0"
+    implementation "com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.18.1"
+    implementation "com.fasterxml.jackson.datatype:jackson-datatype-joda:2.18.1"
 
     implementation "com.github.dozermapper:dozer-core:7.0.0"
 
     //keycloak
-    implementation "com.nimbusds:nimbus-jose-jwt:9.37.3"
-    implementation "io.jsonwebtoken:jjwt-api:0.12.5"
-    implementation "io.jsonwebtoken:jjwt-impl:0.12.5"
-    implementation "io.jsonwebtoken:jjwt-jackson:0.12.5"
+    implementation "com.nimbusds:nimbus-jose-jwt:9.45"
+    implementation "io.jsonwebtoken:jjwt-api:0.12.6"
+    implementation "io.jsonwebtoken:jjwt-impl:0.12.6"
+    implementation "io.jsonwebtoken:jjwt-jackson:0.12.6"
 
     implementation "com.github.java-json-tools:json-patch:1.13"
 
-    implementation "org.apache.commons:commons-lang3:3.14.0"
-    implementation "commons-validator:commons-validator:1.8.0"
-    implementation "commons-io:commons-io:2.16.1"
+    implementation "org.apache.commons:commons-lang3:3.17.0"
+    implementation "commons-validator:commons-validator:1.9.0"
+    implementation "commons-io:commons-io:2.17.0"
     // http client uses commons-codec
     implementation 'org.apache.httpcomponents:httpclient:4.5.14'
 
     implementation "org.apache.commons:commons-collections4:4.4"
 
     // due to problems in dependencies check
-    implementation "com.fasterxml.jackson.core:jackson-core:2.17.0"
-    implementation "com.fasterxml.jackson.core:jackson-databind:2.17.0"
+    implementation "com.fasterxml.jackson.core:jackson-core:2.18.1"
+    implementation "com.fasterxml.jackson.core:jackson-databind:2.18.1"
 
     //Java 11 Support 
     implementation 'javax.xml.bind:jaxb-api:2.3.1'
@@ -118,7 +118,7 @@ if (project.hasProperty('release')) {
 }
 
 jacoco {
-    toolVersion = "0.8.11"
+    toolVersion = "0.8.12"
 }
 
 tasks.withType(Test) {

gradle/wrapper/gradle-wrapper.properties

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

gradlew

@@ -15,6 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+# SPDX-License-Identifier: Apache-2.0
+#
 
 ##############################################################################
 #
@@ -55,7 +57,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/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/.
@@ -80,13 +82,12 @@ 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 -P "${APP_HOME:-./}" > /dev/null && printf '%s
+' "$PWD" ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -133,22 +134,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 +201,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

@@ -13,8 +13,10 @@
 @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
+@if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
 @rem
 @rem  Gradle startup script for Windows
@@ -25,7 +27,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 +43,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 +59,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 +78,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