Merge branch '227-ci-read-packages' into 'dev'

GitLab: use OBX_READ_PACKAGES_TOKEN to read packages repo

See merge request objectbox/objectbox-java!143

Author: greenrobot-team

.gitlab-ci.yml

@@ -3,6 +3,7 @@
 image: objectboxio/buildenv-core:2023-07-28
 
 # Assumes these environment variables are configured in GitLab CI/CD Settings:
+# - OBX_READ_PACKAGES_TOKEN
 # - SONATYPE_USER
 # - SONATYPE_PWD
 # - GOOGLE_CHAT_WEBHOOK_JAVA_CI
@@ -18,8 +19,9 @@ variables:
   # Configure file.encoding to always use UTF-8 when running Gradle.
   # Use low priority processes to avoid Gradle builds consuming all build machine resources.
   GRADLE_OPTS: "-Dorg.gradle.daemon=false -Dfile.encoding=UTF-8 -Dorg.gradle.priority=low"
-  GITLAB_REPO_ARGS: "-PgitlabUrl=$CI_SERVER_URL -PgitlabTokenName=Job-Token -PgitlabPrivateToken=$CI_JOB_TOKEN"
-  CENTRAL_REPO_ARGS: "-PsonatypeUsername=$SONATYPE_USER -PsonatypePassword=$SONATYPE_PWD"
+  GITLAB_REPO_ARGS: "-PgitlabUrl=$CI_SERVER_URL -PgitlabPrivateTokenName=Deploy-Token -PgitlabPrivateToken=$OBX_READ_PACKAGES_TOKEN"
+  GITLAB_PUBLISH_ARGS: "-PgitlabPublishTokenName=Job-Token -PgitlabPublishToken=$CI_JOB_TOKEN"
+  CENTRAL_PUBLISH_ARGS: "-PsonatypeUsername=$SONATYPE_USER -PsonatypePassword=$SONATYPE_PWD"
   # CI_COMMIT_REF_SLUG is the branch or tag name, but web-safe (only 0-9, a-z)
   VERSION_ARGS: "-PversionPostFix=$CI_COMMIT_REF_SLUG"
 
@@ -127,7 +129,7 @@ upload-to-internal:
     - schedules # Do not upload artifacts from scheduled jobs to save on disk space
     - tags # Only upload artifacts from branches
   script:
-    - ./gradlew $GITLAB_REPO_ARGS $VERSION_ARGS publishMavenJavaPublicationToGitLabRepository
+    - ./gradlew $GITLAB_REPO_ARGS $GITLAB_PUBLISH_ARGS $VERSION_ARGS publishMavenJavaPublicationToGitLabRepository
 
 upload-to-central:
   stage: upload-to-central
@@ -138,7 +140,7 @@ upload-to-central:
     - ci/send-to-gchat.sh "$GOOGLE_CHAT_WEBHOOK_JAVA_CI" --thread $CI_COMMIT_SHA "*Releasing Java library:* job $CI_JOB_NAME from branch $CI_COMMIT_BRANCH ($CI_COMMIT_SHORT_SHA)..."
   script:
     # Note: supply internal repo as tests use native dependencies that might not be published, yet.
-    - ./gradlew $GITLAB_REPO_ARGS $VERSION_ARGS $CENTRAL_REPO_ARGS publishMavenJavaPublicationToSonatypeRepository closeAndReleaseSonatypeStagingRepository
+    - ./gradlew $GITLAB_REPO_ARGS $VERSION_ARGS $CENTRAL_PUBLISH_ARGS publishMavenJavaPublicationToSonatypeRepository closeAndReleaseSonatypeStagingRepository
   after_script:
     # Also runs on failure, so show CI_JOB_STATUS.
     - ci/send-to-gchat.sh "$GOOGLE_CHAT_WEBHOOK_JAVA_CI" --thread $CI_COMMIT_SHA "*Releasing Java library:* *$CI_JOB_STATUS* for $CI_JOB_NAME"

build.gradle.kts

@@ -99,11 +99,11 @@ configure<io.github.gradlenexus.publishplugin.NexusPublishExtension> {
     this.repositories {
         sonatype {
             if (project.hasProperty("sonatypeUsername") && project.hasProperty("sonatypePassword")) {
-                println("nexusPublishing credentials supplied.")
                 username.set(project.property("sonatypeUsername").toString())
                 password.set(project.property("sonatypePassword").toString())
+                println("Publishing: configured Maven Central repository")
             } else {
-                println("nexusPublishing credentials NOT supplied.")
+                println("Publishing: Maven Central repository not configured")
             }
         }
     }

buildSrc/src/main/kotlin/objectbox-publish.gradle.kts

@@ -4,8 +4,8 @@
 //
 // To publish artifacts to the internal GitLab repo set:
 // - gitlabUrl
-// - gitlabPrivateToken
-// - gitlabTokenName: optional, if set used instead of "Private-Token". Use for CI to specify e.g. "Job-Token".
+// - gitlabPublishToken: a token with permission to publish to the GitLab Package Repository
+// - gitlabPublishTokenName: optional, if set used instead of "Private-Token". Use for CI to specify e.g. "Job-Token".
 //
 // To sign artifacts using an ASCII encoded PGP key given via a file set:
 // - signingKeyFile
@@ -28,21 +28,20 @@ publishing {
     repositories {
         maven {
             name = "GitLab"
-            if (project.hasProperty("gitlabUrl") && project.hasProperty("gitlabPrivateToken")) {
+            if (project.hasProperty("gitlabUrl") && project.hasProperty("gitlabPublishToken")) {
                 // "https://gitlab.example.com/api/v4/projects/<PROJECT_ID>/packages/maven"
                 val gitlabUrl = project.property("gitlabUrl")
                 url = uri("$gitlabUrl/api/v4/projects/14/packages/maven")
-                println("GitLab repository set to $url.")
-
                 credentials(HttpHeaderCredentials::class) {
-                    name = project.findProperty("gitlabTokenName")?.toString() ?: "Private-Token"
-                    value = project.property("gitlabPrivateToken").toString()
+                    name = project.findProperty("gitlabPublishTokenName")?.toString() ?: "Private-Token"
+                    value = project.property("gitlabPublishToken").toString()
                 }
                 authentication {
                     create<HttpHeaderAuthentication>("header")
                 }
+                println("Publishing: configured GitLab repository $url")
             } else {
-                println("WARNING: Can not publish to GitLab: gitlabUrl or gitlabPrivateToken not set.")
+                println("Publishing: GitLab repository not configured")
             }
         }
         // Note: Sonatype repo created by publish-plugin, see root build.gradle.kts.
@@ -96,8 +95,9 @@ signing {
             project.property("signingPassword").toString()
         )
         sign(publishing.publications["mavenJava"])
+        println("Publishing: configured signing with key file")
     } else {
-        println("Signing information missing/incomplete for ${project.name}")
+        println("Publishing: signing not configured")
     }
 }
 

tests/objectbox-java-test/build.gradle.kts

@@ -25,20 +25,20 @@ repositories {
     // Native lib might be deployed only in internal repo
     if (project.hasProperty("gitlabUrl")) {
         val gitlabUrl = project.property("gitlabUrl")
-        println("gitlabUrl=$gitlabUrl added to repositories.")
         maven {
             url = uri("$gitlabUrl/api/v4/groups/objectbox/-/packages/maven")
             name = "GitLab"
             credentials(HttpHeaderCredentials::class) {
-                name = project.findProperty("gitlabTokenName")?.toString() ?: "Private-Token"
+                name = project.findProperty("gitlabPrivateTokenName")?.toString() ?: "Private-Token"
                 value = project.property("gitlabPrivateToken").toString()
             }
             authentication {
                 create<HttpHeaderAuthentication>("header")
             }
+            println("Dependencies: added GitLab repository $url")
         }
     } else {
-        println("Property gitlabUrl not set.")
+        println("Dependencies: GitLab repository not added. To resolve dependencies from the GitLab Package Repository, set gitlabUrl and gitlabPrivateToken.")
     }
 }
 

tests/test-proguard/build.gradle

@@ -0,0 +1,49 @@
+plugins {
+    id("java-library")
+}
+
+tasks.withType<JavaCompile> {
+    // Note: use release flag instead of sourceCompatibility and targetCompatibility to ensure only JDK 8 API is used.
+    // https://docs.gradle.org/current/userguide/building_java_projects.html#sec:java_cross_compilation
+    options.release.set(8)
+}
+
+repositories {
+    // Native lib might be deployed only in internal repo
+    if (project.hasProperty("gitlabUrl")) {
+        val gitlabUrl = project.property("gitlabUrl")
+        maven {
+            url = uri("$gitlabUrl/api/v4/groups/objectbox/-/packages/maven")
+            name = "GitLab"
+            credentials(HttpHeaderCredentials::class) {
+                name = project.findProperty("gitlabPrivateTokenName")?.toString() ?: "Private-Token"
+                value = project.property("gitlabPrivateToken").toString()
+            }
+            authentication {
+                create<HttpHeaderAuthentication>("header")
+            }
+            println("Dependencies: added GitLab repository $url")
+        }
+    } else {
+        println("Dependencies: GitLab repository not added. To resolve dependencies from the GitLab Package Repository, set gitlabUrl and gitlabPrivateToken.")
+    }
+}
+
+val obxJniLibVersion: String by rootProject.extra
+
+val junitVersion: String by rootProject.extra
+
+dependencies {
+    implementation(project(":objectbox-java"))
+
+    // Check flag to use locally compiled version to avoid dependency cycles
+    if (!project.hasProperty("noObjectBoxTestDepencies")
+        || project.property("noObjectBoxTestDepencies") == false) {
+        println("Using $obxJniLibVersion")
+        implementation(obxJniLibVersion)
+    } else {
+        println("Did NOT add native dependency")
+    }
+
+    testImplementation("junit:junit:$junitVersion")
+}