Merge branch '215-update-tools-dependencies' into 'dev'

Update to Gradle 8.7, Kotlin 2.0, test with JDK 21 objectbox-java#215

See merge request objectbox/objectbox-java!150

Author: greenrobot-team

.gitignore

@@ -13,6 +13,9 @@ target/
 out/
 classes/
 
+# Kotlin
+.kotlin
+
 # Local build properties
 build.properties
 local.properties

.gitlab-ci.yml

@@ -1,8 +1,8 @@
 # https://docs.gitlab.com/ci/yaml/
 
 # Default image for linux builds
-# Using core instead of base to get access to ASAN from clang.
-image: objectboxio/buildenv-core:2023-07-28
+# This should match the image used to build the JVM database libraries (so Address Sanitizer library matches)
+image: objectboxio/buildenv-core:2024-07-11 # With JDK 17
 
 # Assumes these environment variables are configured in GitLab CI/CD Settings:
 # - OBX_READ_PACKAGES_TOKEN
@@ -64,7 +64,9 @@ test:
   script:
     # build to assemble, run tests and spotbugs
     # javadocForWeb to catch API docs errors before releasing
-    - ./scripts/test-with-asan.sh $GITLAB_REPO_ARGS $VERSION_ARGS clean build javadocForWeb
+    # Temporarily disable testing with Address Sanitizer until buildenv images are modernized, see #273
+    # - ./scripts/test-with-asan.sh $GITLAB_REPO_ARGS $VERSION_ARGS clean build javadocForWeb
+    - ./gradlew $GITLAB_REPO_ARGS $VERSION_ARGS clean build javadocForWeb
   artifacts:
     when: always
     paths:
@@ -117,7 +119,9 @@ test-macos:
     LC_ALL: "C.UTF-8"
   script:
     # Note: do not run check task as it includes SpotBugs.
-    - ./scripts/test-with-asan.sh $GITLAB_REPO_ARGS $VERSION_ARGS clean :tests:objectbox-java-test:test
+    # Temporarily disable testing with Address Sanitizer until buildenv images are modernized, see #273
+    # - ./scripts/test-with-asan.sh $GITLAB_REPO_ARGS $VERSION_ARGS clean :tests:objectbox-java-test:test
+    - ./gradlew $GITLAB_REPO_ARGS $VERSION_ARGS clean :tests:objectbox-java-test:test
 
 # Test oldest supported and a recent JDK.
 # Note: can not run these in parallel using a matrix configuration as Gradle would step over itself.
@@ -127,12 +131,12 @@ test-jdk-8:
   variables:
     TEST_JDK: 8
 
-# JDK 11 is the next oldest LTS release.
-test-jdk-11:
+# JDK 17 is the default of the current build image, so test the latest LTS JDK 21
+test-jdk-21:
   extends: .test-asan-template
   needs: ["test-jdk-8"]
   variables:
-    TEST_JDK: 11
+    TEST_JDK: 21
 
 test-jdk-x86:
   extends: .test-template

CHANGELOG.md

@@ -4,6 +4,10 @@ Notable changes to the ObjectBox Java library.
 
 For more insights into what changed in the ObjectBox C++ core, [check the ObjectBox C changelog](https://github.com/objectbox/objectbox-c/blob/main/CHANGELOG.md).
 
+## 4.3.1 - in development
+
+- Requires at least Kotlin compiler and standard library 1.7.
+
 ## 4.3.0 - 2025-05-13
 
 - Basic support for boolean array properties (`boolean[]` in Java or `BooleanArray` in Kotlin).

build.gradle.kts

@@ -6,8 +6,10 @@
 // - sonatypePassword: Maven Central credential used by Nexus publishing.
 
 plugins {
+    // https://github.com/ben-manes/gradle-versions-plugin/releases
+    id("com.github.ben-manes.versions") version "0.51.0"
     // https://github.com/spotbugs/spotbugs-gradle-plugin/releases
-    id("com.github.spotbugs") version "5.0.14" apply false
+    id("com.github.spotbugs") version "6.0.26" apply false
     // https://github.com/gradle-nexus/publish-plugin/releases
     id("io.github.gradle-nexus.publish-plugin") version "1.3.0"
 }
@@ -50,14 +52,17 @@ buildscript {
     val essentialsVersion by extra("3.1.0")
     val junitVersion by extra("4.13.2")
     val mockitoVersion by extra("3.8.0")
-    // The versions of Kotlin, Kotlin Coroutines and Dokka must work together.
-    // Check https://github.com/Kotlin/kotlinx.coroutines#readme
-    // and https://github.com/Kotlin/dokka/releases
-    // Note: when updating might also have to increase the minimum compiler version supported
-    // by consuming projects, see objectbox-kotlin/ build script.
-    val kotlinVersion by extra("1.8.20")
-    val coroutinesVersion by extra("1.7.3")
-    val dokkaVersion by extra("1.8.20")
+    // The versions of Gradle, Kotlin and Kotlin Coroutines must work together.
+    // Check
+    // - https://kotlinlang.org/docs/gradle-configure-project.html#apply-the-plugin
+    // - https://github.com/Kotlin/kotlinx.coroutines#readme
+    // Note: when updating to a new minor version also have to increase the minimum compiler and standard library
+    // version supported by consuming projects, see objectbox-kotlin/ build script.
+    val kotlinVersion by extra("2.0.21")
+    val coroutinesVersion by extra("1.9.0")
+    // Dokka includes its own version of the Kotlin compiler, so it must not match the used Kotlin version.
+    // But it might not understand new language features.
+    val dokkaVersion by extra("1.9.20")
 
     repositories {
         mavenCentral()
@@ -96,6 +101,19 @@ allprojects {
     }
 }
 
+// Exclude pre-release versions from dependencyUpdates task
+fun isNonStable(version: String): Boolean {
+    val stableKeyword = listOf("RELEASE", "FINAL", "GA").any { version.uppercase().contains(it) }
+    val regex = "^[0-9,.v-]+(-r)?$".toRegex()
+    val isStable = stableKeyword || regex.matches(version)
+    return isStable.not()
+}
+tasks.withType<com.github.benmanes.gradle.versions.updates.DependencyUpdatesTask> {
+    rejectVersionIf {
+        isNonStable(candidate.version)
+    }
+}
+
 tasks.wrapper {
     distributionType = Wrapper.DistributionType.ALL
 }

gradle/wrapper/gradle-wrapper.jar

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-all.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradle/wrapper/gradle-wrapper.properties

@@ -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" \

gradlew

@@ -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
 

gradlew.bat

@@ -14,7 +14,7 @@ tasks.withType<JavaCompile> {
     options.release.set(8)
 }
 
-val javadocForWebDir = "$buildDir/docs/web-api-docs"
+val javadocForWebDir = layout.buildDirectory.dir("docs/web-api-docs")
 val essentialsVersion: String by rootProject.extra
 
 dependencies {
@@ -23,7 +23,7 @@ dependencies {
     api("com.google.code.findbugs:jsr305:3.0.2")
 
     // https://github.com/spotbugs/spotbugs/blob/master/CHANGELOG.md
-    compileOnly("com.github.spotbugs:spotbugs-annotations:4.7.3")
+    compileOnly("com.github.spotbugs:spotbugs-annotations:4.8.6")
 }
 
 spotbugs {
@@ -42,12 +42,14 @@ tasks.spotbugsMain {
 tasks.javadoc {
     // Internal Java APIs
     exclude("**/io/objectbox/Cursor.java")
+    exclude("**/io/objectbox/InternalAccess.java")
     exclude("**/io/objectbox/KeyValueCursor.java")
     exclude("**/io/objectbox/ModelBuilder.java")
     exclude("**/io/objectbox/Properties.java")
     exclude("**/io/objectbox/Transaction.java")
     exclude("**/io/objectbox/ideasonly/**")
     exclude("**/io/objectbox/internal/**")
+    exclude("**/io/objectbox/query/InternalAccess.java")
     exclude("**/io/objectbox/reactive/DataPublisherUtils.java")
     exclude("**/io/objectbox/reactive/WeakDataObserver.java")
     exclude("**/io/objectbox/sync/server/ClusterPeerInfo.java")
@@ -63,7 +65,7 @@ tasks.javadoc {
 }
 
 // Note: use packageJavadocForWeb to get as ZIP.
-tasks.register<Javadoc>("javadocForWeb") {
+val javadocForWeb by tasks.registering(Javadoc::class) {
     group = "documentation"
     description = "Builds Javadoc incl. objectbox-java-api classes with web tweaks."
 
@@ -78,12 +80,14 @@ tasks.register<Javadoc>("javadocForWeb") {
     val filteredSources = sourceSets.main.get().allJava.matching {
         // Internal Java APIs
         exclude("**/io/objectbox/Cursor.java")
+        exclude("**/io/objectbox/InternalAccess.java")
         exclude("**/io/objectbox/KeyValueCursor.java")
         exclude("**/io/objectbox/ModelBuilder.java")
         exclude("**/io/objectbox/Properties.java")
         exclude("**/io/objectbox/Transaction.java")
         exclude("**/io/objectbox/ideasonly/**")
         exclude("**/io/objectbox/internal/**")
+        exclude("**/io/objectbox/query/InternalAccess.java")
         exclude("**/io/objectbox/reactive/DataPublisherUtils.java")
         exclude("**/io/objectbox/reactive/WeakDataObserver.java")
         exclude("**/io/objectbox/sync/server/ClusterPeerInfo.java")
@@ -100,7 +104,7 @@ tasks.register<Javadoc>("javadocForWeb") {
     source = filteredSources + fileTree(srcApi)
 
     classpath = sourceSets.main.get().output + sourceSets.main.get().compileClasspath
-    setDestinationDir(file(javadocForWebDir))
+    setDestinationDir(javadocForWebDir.get().asFile)
 
     title = "ObjectBox Java ${project.version} API"
     (options as StandardJavadocDocletOptions).apply {
@@ -124,39 +128,31 @@ tasks.register<Javadoc>("javadocForWeb") {
             .replace("#bb7a2a", "#E61955") // Hover
         stylesheetFile.writeText(replacedContent)
         // Note: in CSS stylesheets the last added rule wins, so append to default stylesheet.
-        // Code blocks
-        stylesheetFile.appendText("pre {\nwhite-space: normal;\noverflow-x: auto;\n}\n")
-        // Member summary tables
-        stylesheetFile.appendText(".memberSummary {\noverflow: auto;\n}\n")
-        // Descriptions and signatures
-        stylesheetFile.appendText(".block {\n" +
-                "    display:block;\n" +
-                "    margin:3px 10px 2px 0px;\n" +
-                "    color:#474747;\n" +
-                "    overflow:auto;\n" +
-                "}")
+        // Make code blocks scroll instead of stick out on small width
+        stylesheetFile.appendText("pre {\n    overflow-x: auto;\n}\n")
 
         println("Javadoc for web created at $destinationDir")
     }
 }
 
 tasks.register<Zip>("packageJavadocForWeb") {
-    dependsOn("javadocForWeb")
+    dependsOn(javadocForWeb)
     group = "documentation"
     description = "Packages Javadoc incl. objectbox-java-api classes with web tweaks as ZIP."
 
     archiveFileName.set("objectbox-java-web-api-docs.zip")
-    destinationDirectory.set(file("$buildDir/dist"))
+    val distDir = layout.buildDirectory.dir("dist")
+    destinationDirectory.set(distDir)
 
     from(file(javadocForWebDir))
 
     doLast {
-        println("Javadoc for web packaged to ${file("$buildDir/dist/objectbox-java-web-api-docs.zip")}")
+        println("Javadoc for web packaged to ${distDir.get().file("objectbox-java-web-api-docs.zip")}")
     }
 }
 
 val javadocJar by tasks.registering(Jar::class) {
-    dependsOn("javadoc")
+    dependsOn(tasks.javadoc)
     archiveClassifier.set("javadoc")
     from("build/docs/javadoc")
 }