feat: pass TESTLENS_GITHUB_TOKEN via env file as well

To avoid passing absolute paths

Author: marcphilipp

setup-testlens.sh

@@ -13,7 +13,7 @@ write_env_properties_file() {
   {
     while IFS= read -r var_name; do
       printf '%s=%s\n' "$var_name" "$(escape_for_java_properties "${!var_name}")"
-    done < <(printf '%s\n' "${!GITHUB_@}" "${!RUNNER_@}" "JOB_CHECK_RUN_ID" | sort -u)
+    done < <(printf '%s\n' "${!GITHUB_@}" "${!RUNNER_@}" "JOB_CHECK_RUN_ID" "TESTLENS_GITHUB_TOKEN" | sort -u)
   } > "$properties_file"
 }
 
@@ -33,21 +33,12 @@ if [[ -n "$GRADLE_USER_HOME" ]] || [[ -f settings.gradle ]] || [[ -f settings.gr
     # SC2001: sed is intentionally used here over bash parameter expansion for readability,
     # as the bash equivalent `${VAR//\\//}` is visually ambiguous for backslash-to-slash substitution.
     GRADLE_USER_HOME=$(echo "$GRADLE_USER_HOME" | sed 's|\\|/|g')
-    # When running in a shell script (as opposed to inline action YAML), bash on Windows
-    # normalizes paths to Git Bash style (/c/Users/...). The Groovy init script however
-    # runs on the JVM which requires Windows style paths (C:/Users/...).
-    # shellcheck disable=SC2001
-    GRADLE_USER_HOME_GROOVY=$(echo "$GRADLE_USER_HOME" | sed 's|^/\([a-zA-Z]\)/|\1:/|')
-  else
-    GRADLE_USER_HOME_GROOVY="$GRADLE_USER_HOME"
   fi
 
   # write files required by TestLens
   write_env_properties_file "$PWD/.gradle/testlens-env.properties"
   mkdir -p "$GRADLE_USER_HOME/init.d"
-  echo -n "$TESTLENS_GITHUB_TOKEN" > "$GRADLE_USER_HOME"/init.d/TESTLENS_GITHUB_TOKEN
   cat << EOF > "$GRADLE_USER_HOME"/init.d/testlens-init.gradle
-import org.gradle.api.provider.*;
 gradle.beforeProject { project ->
   // Locate the env properties file relative to the build root as seen at runtime
   // so it resolves whether the build runs on the runner or in a container/VM.
@@ -62,25 +53,20 @@ gradle.beforeProject { project ->
     TestLensSetup.configure(project, relativeBuildPath, envPropertiesFile)
   }
 }
-abstract class TestLensGitHubTokenValueSource implements ValueSource<String, ValueSourceParameters.None> {
-  String obtain() { new File('$GRADLE_USER_HOME_GROOVY/init.d/TESTLENS_GITHUB_TOKEN').text }
-}
 final class TestLensSetup {
   static def configure(Project project, String relativeBuildPath, File envPropertiesFile) {
     project.plugins.withId('java') {
       project.testing.suites.configureEach {
         dependencies { runtimeOnly('app.testlens:junit-platform-instrumentation:$INSTRUMENTATION_VERSION') }
       }
     }
-    def providers = project.providers
     project.tasks.withType(Test).configureEach { task ->
       def muteMarker = new File(task.temporaryDir, 'testlens-mute.marker')
       def logsDir = new File(task.temporaryDir, 'testlens-logs')
       def workUnitPath = task.path + (relativeBuildPath.isEmpty() ? '' : ' [' + relativeBuildPath + ']')
       task.environment('TESTLENS_PROJECT_ID', '$TESTLENS_PROJECT_ID')
       task.environment('TESTLENS_WORK_UNIT_PATH', workUnitPath)
       task.environment('TESTLENS_MUTE_MARKER_FILE', muteMarker.absolutePath)
-      task.environment('TESTLENS_GITHUB_TOKEN', providers.of(TestLensGitHubTokenValueSource){}.get())
       task.environment('TESTLENS_ENV_PROPERTIES_FILE', envPropertiesFile.absolutePath)
       if ('true'.equalsIgnoreCase('$WRITE_LOG_FILES')) {
         task.environment('TESTLENS_LOGS_DIR', logsDir.absolutePath)
@@ -136,7 +122,6 @@ if [[ -f "pom.xml" ]]; then
             <configuration>
               <environmentVariables>
                 <TESTLENS_PROJECT_ID>$TESTLENS_PROJECT_ID</TESTLENS_PROJECT_ID>
-                <TESTLENS_GITHUB_TOKEN>$TESTLENS_GITHUB_TOKEN</TESTLENS_GITHUB_TOKEN>
                 <TESTLENS_WORK_UNIT_PATH>\${project.name}</TESTLENS_WORK_UNIT_PATH>
                 <TESTLENS_ENV_PROPERTIES_FILE>\${maven.multiModuleProjectDirectory}/.mvn/testlens-env.properties</TESTLENS_ENV_PROPERTIES_FILE>
                 <TESTLENS_LOGS_DIR>$(if [[ $WRITE_LOG_FILES = "true" ]]; then echo '${project.build.directory}/testlens-logs'; fi)</TESTLENS_LOGS_DIR>
@@ -149,7 +134,6 @@ if [[ -f "pom.xml" ]]; then
             <configuration>
               <environmentVariables>
                 <TESTLENS_PROJECT_ID>$TESTLENS_PROJECT_ID</TESTLENS_PROJECT_ID>
-                <TESTLENS_GITHUB_TOKEN>$TESTLENS_GITHUB_TOKEN</TESTLENS_GITHUB_TOKEN>
                 <TESTLENS_WORK_UNIT_PATH>\${project.name}</TESTLENS_WORK_UNIT_PATH>
                 <TESTLENS_ENV_PROPERTIES_FILE>\${maven.multiModuleProjectDirectory}/.mvn/testlens-env.properties</TESTLENS_ENV_PROPERTIES_FILE>
                 <TESTLENS_LOGS_DIR>$(if [[ $WRITE_LOG_FILES = "true" ]]; then echo '${project.build.directory}/testlens-logs'; fi)</TESTLENS_LOGS_DIR>

test/env-properties.bats

@@ -11,16 +11,18 @@ setup() {
   unset "${!GITHUB_@}" "${!RUNNER_@}"
 }
 
-@test "captures GITHUB_*, RUNNER_*, and JOB_CHECK_RUN_ID variables" {
+@test "captures GITHUB_*, RUNNER_*, JOB_CHECK_RUN_ID, and TESTLENS_GITHUB_TOKEN variables" {
   echo "rootProject.name = 'demo'" > settings.gradle
   export GITHUB_REPOSITORY="octo/demo"
   export RUNNER_NAME="runner-7"
   export JOB_CHECK_RUN_ID="12345"
+  export TESTLENS_GITHUB_TOKEN="some-token"
   run "$SCRIPT"
   assert_success
   assert_contains "$GRADLE_ENV_PROPS" "GITHUB_REPOSITORY=octo/demo"
   assert_contains "$GRADLE_ENV_PROPS" "RUNNER_NAME=runner-7"
   assert_contains "$GRADLE_ENV_PROPS" "JOB_CHECK_RUN_ID=12345"
+  assert_contains "$GRADLE_ENV_PROPS" "TESTLENS_GITHUB_TOKEN=some-token"
 }
 
 @test "does not capture unrelated variables" {

test/gradle.bats

@@ -60,14 +60,6 @@ setup() {
   assert_not_contains "$init" "$WORKDIR/.gradle/testlens-env.properties"
 }
 
-@test "token file contains the raw token" {
-  export TESTLENS_GITHUB_TOKEN="some-token"
-  export GRADLE_USER_HOME="$GRADLE_HOME"
-  run "$SCRIPT"
-  assert_file "$GRADLE_HOME/init.d/TESTLENS_GITHUB_TOKEN"
-  assert_equal "$(cat "$GRADLE_HOME/init.d/TESTLENS_GITHUB_TOKEN")" "some-token"
-}
-
 @test "log-files switch is included in init script" {
   export GRADLE_USER_HOME="$GRADLE_HOME"
   export WRITE_LOG_FILES="true"
@@ -83,11 +75,10 @@ setup() {
   assert_contains "$init" "if (!'30'.empty)"
 }
 
-@test "windows backslash GRADLE_USER_HOME is converted to JVM style in the token path" {
+@test "windows backslash GRADLE_USER_HOME is normalized to forward slashes" {
   export RUNNER_OS="Windows"
-  export GRADLE_USER_HOME='C:\gradle\home'
+  export GRADLE_USER_HOME="$WORKDIR\\gradle\\home"
   run "$SCRIPT"
   assert_success
-  assert_contains "C:/gradle/home/init.d/testlens-init.gradle" \
-    "new File('C:/gradle/home/init.d/TESTLENS_GITHUB_TOKEN')"
+  assert_file "$WORKDIR/gradle/home/init.d/testlens-init.gradle"
 }