Merge pull request #57 from bitrise-io/config-cache

feat: ACI-2926 Generate config cache compatible config
bitrise-io · Sep 30, 2024 · 92a7f62 · 92a7f62
2 parents f600e2a + dc313a4
commit 92a7f62
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 39 deletions.
diff --git a/internal/config/common/auth.go b/internal/config/common/auth.go
@@ -23,32 +23,29 @@ func (cac CacheAuthConfig) TokenInGradleFormat() string {
 }
 
 // ReadAuthConfigFromEnvironments reads auth information from the environment variables
-// - if BITRISEIO_BITRISE_SERVICES_ACCESS_TOKEN is provided, use that
-// - otherwise, if BITRISE_BUILD_CACHE_AUTH_TOKEN and BITRISE_BUILD_CACHE_WORKSPACE_ID is provided, use that
-// - otherwise return error
 func ReadAuthConfigFromEnvironments(envProvider func(string) string) (CacheAuthConfig, error) {
+	authTokenEnv := envProvider("BITRISE_BUILD_CACHE_AUTH_TOKEN")
+	workspaceIDEnv := envProvider("BITRISE_BUILD_CACHE_WORKSPACE_ID")
+
+	if len(authTokenEnv) > 0 && len(workspaceIDEnv) > 0 {
+		return CacheAuthConfig{
+			AuthToken:   authTokenEnv,
+			WorkspaceID: workspaceIDEnv,
+		}, nil
+	}
+
+	// Try to fall back to JWT which is always available on Bitrise.
+	// It's a JWT token which already includes the workspace ID.
 	if serviceToken := envProvider("BITRISEIO_BITRISE_SERVICES_ACCESS_TOKEN"); len(serviceToken) > 0 {
-		// Bitrise service access token specified, use it for auth.
-		// It's a JWT token which already includes the workspace ID.
 		return CacheAuthConfig{
 			AuthToken: serviceToken,
 		}, nil
 	}
 
-	// No Bitrise Service Access Token specified.
-	// In this case both AuthToken and Workspace ID required,
-	authTokenEnv := envProvider("BITRISE_BUILD_CACHE_AUTH_TOKEN")
+	// Write specific errors for each case.
 	if len(authTokenEnv) < 1 {
 		return CacheAuthConfig{}, errAuthTokenNotProvided
 	}
 
-	workspaceIDEnv := envProvider("BITRISE_BUILD_CACHE_WORKSPACE_ID")
-	if len(workspaceIDEnv) < 1 {
-		return CacheAuthConfig{}, errWorkspaceIDNotProvided
-	}
-
-	return CacheAuthConfig{
-		AuthToken:   authTokenEnv,
-		WorkspaceID: workspaceIDEnv,
-	}, nil
+	return CacheAuthConfig{}, errWorkspaceIDNotProvided
 }
diff --git a/internal/config/common/endpoint_test.go b/internal/config/common/endpoint_test.go
@@ -53,8 +53,8 @@ func Test_ReadAuthConfigFromEnvironments(t *testing.T) {
 			"BITRISE_BUILD_CACHE_WORKSPACE_ID":        "WorkspaceIDValue",
 		}))
 		require.NoError(t, err)
-		// BITRISEIO_BITRISE_SERVICES_ACCESS_TOKEN wins
-		assert.Equal(t, CacheAuthConfig{AuthToken: "ServiceAccessTokenValue"}, authToken)
+		// BITRISE_BUILD_CACHE_AUTH_TOKEN wins
+		assert.Equal(t, CacheAuthConfig{AuthToken: "AuthTokenValue", WorkspaceID: "WorkspaceIDValue"}, authToken)
 	})
 }
 

diff --git a/internal/config/gradle/gradleconfig_test.go b/internal/config/gradle/gradleconfig_test.go
@@ -53,9 +53,7 @@ func TestGenerateInitGradle(t *testing.T) {
 					CIProvider: "BestCI",
 					RepoURL:    "https://github.com/some/repo",
 					// Bitrise CI specific
-					BitriseAppID:        "BitriseAppID1",
-					BitriseBuildID:      "BitriseBuildID1",
-					BitriseWorkflowName: "BitriseWorkflowName1",
+					BitriseAppID: "BitriseAppID1",
 				},
 			},
 			want:    expectedInitScriptWithoutMetrics,
@@ -76,9 +74,7 @@ func TestGenerateInitGradle(t *testing.T) {
 					CIProvider: "BestCI",
 					RepoURL:    "https://github.com/some/repo",
 					// Bitrise CI specific
-					BitriseAppID:        "BitriseAppID1",
-					BitriseBuildID:      "BitriseBuildID1",
-					BitriseWorkflowName: "BitriseWorkflowName1",
+					BitriseAppID: "BitriseAppID1",
 				},
 			},
 			want:    expectedInitScriptWithMetrics,
@@ -155,7 +151,7 @@ initscript {
         maven(url="https://jitpack.io")
     }
     dependencies {
-        classpath("io.bitrise.gradle:remote-cache:1.2.8")
+        classpath("io.bitrise.gradle:remote-cache:1.2.9")
         classpath("io.bitrise.gradle:gradle-analytics:2.1.7")
     }
 }
@@ -174,6 +170,7 @@ settingsEvaluated {
             isPush = true
             debug = true
             blobValidationLevel = "warning"
+            collectMetadata = false
         }
     }
 }
@@ -193,8 +190,6 @@ rootProject {
 
         bitrise {
             appSlug.set("BitriseAppID1")
-            buildSlug.set("BitriseBuildID1")
-            workflowName.set("BitriseWorkflowName1")
         }
     }
 }
@@ -211,7 +206,7 @@ initscript {
         maven(url="https://jitpack.io")
     }
     dependencies {
-        classpath("io.bitrise.gradle:remote-cache:1.2.8")
+        classpath("io.bitrise.gradle:remote-cache:1.2.9")
         classpath("io.bitrise.gradle:gradle-analytics:2.1.7")
     }
 }
@@ -230,6 +225,7 @@ settingsEvaluated {
             isPush = true
             debug = true
             blobValidationLevel = "warning"
+            collectMetadata = false
         }
     }
 }
@@ -264,7 +260,7 @@ initscript {
         maven(url="https://jitpack.io")
     }
     dependencies {
-        classpath("io.bitrise.gradle:remote-cache:1.2.8")
+        classpath("io.bitrise.gradle:remote-cache:1.2.9")
     }
 }
 
@@ -298,7 +294,7 @@ initscript {
         maven(url="https://jitpack.io")
     }
     dependencies {
-        classpath("io.bitrise.gradle:remote-cache:1.2.8")
+        classpath("io.bitrise.gradle:remote-cache:1.2.9")
     }
 }
 
@@ -332,7 +328,7 @@ initscript {
         maven(url="https://jitpack.io")
     }
     dependencies {
-        classpath("io.bitrise.gradle:remote-cache:1.2.8")
+        classpath("io.bitrise.gradle:remote-cache:1.2.9")
     }
 }
 

diff --git a/internal/config/gradle/initd.gradle.kts.gotemplate b/internal/config/gradle/initd.gradle.kts.gotemplate
@@ -30,6 +30,9 @@ settingsEvaluated {
             isPush = {{ .IsPushEnabled }}
             debug = {{ .IsDebugEnabled }}
             blobValidationLevel = "{{ .ValidationLevel }}"
+            {{- if .IsAnalyticsEnabled }}
+            collectMetadata = false
+            {{- end }}
         }
     }
 }
@@ -53,12 +56,6 @@ rootProject {
             {{- if .CacheConfigMetadata.BitriseAppID }}
             appSlug.set("{{ .CacheConfigMetadata.BitriseAppID }}")
             {{- end }}
-            {{- if .CacheConfigMetadata.BitriseBuildID }}
-            buildSlug.set("{{ .CacheConfigMetadata.BitriseBuildID }}")
-            {{- end }}
-            {{- if .CacheConfigMetadata.BitriseWorkflowName }}
-            workflowName.set("{{ .CacheConfigMetadata.BitriseWorkflowName }}")
-            {{- end }}
         }
     }
 }

diff --git a/internal/consts/consts.go b/internal/consts/consts.go
@@ -10,7 +10,7 @@ const (
 	AnalyticsServiceEndpoint = "https://xcode-analytics.services.bitrise.io"
 
 	// Gradle Remote Build Cache related consts
-	GradleRemoteBuildCachePluginDepVersion = "1.2.8"
+	GradleRemoteBuildCachePluginDepVersion = "1.2.9"
 
 	// Gradle Analytics related consts
 	GradleAnalyticsPluginDepVersion = "2.1.7"