Merge pull request #5754 from crazy-max/update-gha-cache-test

buildctl: set fallback url for gha cache

Author: crazy-max

README.md

@@ -516,7 +516,8 @@ GitHub Actions cache saves both cache metadata and layers to GitHub's Cache serv
 Similarly to using [actions/cache](https://github.com/actions/cache), caches are [scoped by branch](https://docs.github.com/en/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache), with the default and target branches being available to every branch.
 
 Following attributes are required to authenticate against the [GitHub Actions Cache service API](https://github.com/tonistiigi/go-actions-cache/blob/master/api.md#authentication):
-* `url`: Cache server URL (default `$ACTIONS_CACHE_URL`)
+* `url`: Cache server URL (default `$ACTIONS_CACHE_URL` or fallback to `$ACTIONS_RESULTS_URL`)
+* `url_v2`: Cache v2 server URL if `$ACTIONS_CACHE_SERVICE_V2` set on the runner (default `$ACTIONS_RESULTS_URL`)
 * `token`: Access token (default `$ACTIONS_RUNTIME_TOKEN`)
 
 :information_source: This type of cache can be used with [Docker Build Push Action](https://github.com/docker/build-push-action)

cache/remotecache/gha/gha_test.go

@@ -1,8 +1,10 @@
 package gha
 
 import (
+	"maps"
 	"os"
 	"path/filepath"
+	"strconv"
 	"strings"
 	"testing"
 	"time"
@@ -57,10 +59,25 @@ func testBasicGhaCacheImportExportExtraTimeout(t *testing.T, sb integration.Sand
 
 	destDir := t.TempDir()
 
-	runtimeToken := os.Getenv("ACTIONS_RUNTIME_TOKEN")
-	cacheURL := os.Getenv("ACTIONS_CACHE_URL")
-	if runtimeToken == "" || cacheURL == "" {
-		t.Skip("ACTIONS_RUNTIME_TOKEN and ACTIONS_CACHE_URL must be set")
+	var cacheVersion string
+	if v, ok := os.LookupEnv("ACTIONS_CACHE_SERVICE_V2"); ok {
+		if b, err := strconv.ParseBool(v); err == nil && b {
+			cacheVersion = "2"
+		}
+	}
+
+	cacheAttrs := map[string]string{}
+	if cacheVersion == "2" {
+		cacheAttrs["url_v2"] = os.Getenv("ACTIONS_RESULTS_URL")
+	}
+	cacheAttrs["url"] = os.Getenv("ACTIONS_CACHE_URL")
+	if cacheAttrs["url"] == "" {
+		cacheAttrs["url"] = os.Getenv("ACTIONS_RESULTS_URL")
+	}
+	cacheAttrs["token"] = os.Getenv("ACTIONS_RUNTIME_TOKEN")
+
+	if cacheAttrs["token"] == "" || (cacheAttrs["url"] == "" && cacheAttrs["url_v2"] == "") {
+		t.Skip("actions runtime token and cache url must be set")
 	}
 
 	scope := "buildkit-" + t.Name()
@@ -74,6 +91,12 @@ func testBasicGhaCacheImportExportExtraTimeout(t *testing.T, sb integration.Sand
 		}
 	}
 
+	cacheExportAttrs := map[string]string{
+		"scope": scope,
+		"mode":  "max",
+	}
+	maps.Copy(cacheExportAttrs, cacheAttrs)
+
 	_, err = c.Solve(sb.Context(), def, client.SolveOpt{
 		Exports: []client.ExportEntry{
 			{
@@ -82,13 +105,8 @@ func testBasicGhaCacheImportExportExtraTimeout(t *testing.T, sb integration.Sand
 			},
 		},
 		CacheExports: []client.CacheOptionsEntry{{
-			Type: "gha",
-			Attrs: map[string]string{
-				"url":   cacheURL,
-				"token": runtimeToken,
-				"scope": scope,
-				"mode":  "max",
-			},
+			Type:  "gha",
+			Attrs: cacheExportAttrs,
 		}},
 	}, nil)
 	require.NoError(t, err)
@@ -104,6 +122,11 @@ func testBasicGhaCacheImportExportExtraTimeout(t *testing.T, sb integration.Sand
 
 	destDir = t.TempDir()
 
+	cacheImportAttrs := map[string]string{
+		"scope": scope,
+	}
+	maps.Copy(cacheImportAttrs, cacheAttrs)
+
 	_, err = c.Solve(sb.Context(), def, client.SolveOpt{
 		Exports: []client.ExportEntry{
 			{
@@ -112,12 +135,8 @@ func testBasicGhaCacheImportExportExtraTimeout(t *testing.T, sb integration.Sand
 			},
 		},
 		CacheImports: []client.CacheOptionsEntry{{
-			Type: "gha",
-			Attrs: map[string]string{
-				"url":   cacheURL,
-				"token": runtimeToken,
-				"scope": scope,
-			},
+			Type:  "gha",
+			Attrs: cacheImportAttrs,
 		}},
 	}, nil)
 	require.NoError(t, err)

cmd/buildctl/build/importcache_test.go

@@ -54,8 +54,22 @@ func TestParseImportCache(t *testing.T) {
 				{
 					Type: "gha",
 					Attrs: map[string]string{
-						"url":   "https://foo.bar",
-						"token": "foo",
+						"url":    "https://foo.bar",
+						"url_v2": "https://github.com/testv2", // Set from env below
+						"token":  "foo",
+					},
+				},
+			},
+		},
+		{
+			importCaches: []string{"type=gha,url_v2=https://foo.bar,token=foo"},
+			expected: []client.CacheOptionsEntry{
+				{
+					Type: "gha",
+					Attrs: map[string]string{
+						"url":    "https://github.com/test", // Set from env below
+						"url_v2": "https://foo.bar",
+						"token":  "foo",
 					},
 				},
 			},
@@ -66,16 +80,19 @@ func TestParseImportCache(t *testing.T) {
 				{
 					Type: "gha",
 					Attrs: map[string]string{
-						"url":   "https://github.com/test", // Set from env below
-						"token": "bar",                     // Set from env below
+						"url":    "https://github.com/test",   // Set from env below
+						"url_v2": "https://github.com/testv2", // Set from env below
+						"token":  "bar",                       // Set from env below
 					},
 				},
 			},
 		},
 	}
 
 	// Set values for GitHub parse cache
+	t.Setenv("ACTIONS_CACHE_SERVICE_V2", "True")
 	t.Setenv("ACTIONS_CACHE_URL", "https://github.com/test")
+	t.Setenv("ACTIONS_RESULTS_URL", "https://github.com/testv2")
 	t.Setenv("ACTIONS_RUNTIME_TOKEN", "bar")
 
 	for _, tc := range testCases {

cmd/buildctl/build/util.go

@@ -4,10 +4,9 @@ import (
 	"os"
 	"strconv"
 
-	"github.com/pkg/errors"
-
 	"github.com/moby/buildkit/client"
 	"github.com/moby/buildkit/util/bklog"
+	"github.com/pkg/errors"
 )
 
 // loadGithubEnv verify that url and token attributes exists in the
@@ -18,6 +17,7 @@ import (
 func loadGithubEnv(cache client.CacheOptionsEntry) (client.CacheOptionsEntry, error) {
 	version, ok := cache.Attrs["version"]
 	if !ok {
+		// https://github.com/actions/toolkit/blob/2b08dc18f261b9fdd978b70279b85cbef81af8bc/packages/cache/src/internal/config.ts#L19
 		if v, ok := os.LookupEnv("ACTIONS_CACHE_SERVICE_V2"); ok {
 			if b, err := strconv.ParseBool(v); err == nil && b {
 				version = "2"
@@ -26,18 +26,23 @@ func loadGithubEnv(cache client.CacheOptionsEntry) (client.CacheOptionsEntry, er
 	}
 
 	if _, ok := cache.Attrs["url_v2"]; !ok && version == "2" {
-		url, ok := os.LookupEnv("ACTIONS_RESULTS_URL")
-		if !ok {
-			return cache, errors.New("cache with type gha requires url parameter or $ACTIONS_RESULTS_URL")
+		// https://github.com/actions/toolkit/blob/2b08dc18f261b9fdd978b70279b85cbef81af8bc/packages/cache/src/internal/config.ts#L34-L35
+		if v, ok := os.LookupEnv("ACTIONS_RESULTS_URL"); ok {
+			cache.Attrs["url_v2"] = v
 		}
-		cache.Attrs["url_v2"] = url
 	}
 	if _, ok := cache.Attrs["url"]; !ok {
-		url, ok := os.LookupEnv("ACTIONS_CACHE_URL")
-		if !ok {
-			return cache, errors.New("cache with type gha requires url parameter or $ACTIONS_CACHE_URL")
+		// https://github.com/actions/toolkit/blob/2b08dc18f261b9fdd978b70279b85cbef81af8bc/packages/cache/src/internal/config.ts#L28-L33
+		if v, ok := os.LookupEnv("ACTIONS_CACHE_URL"); ok {
+			cache.Attrs["url"] = v
+		} else if v, ok := os.LookupEnv("ACTIONS_RESULTS_URL"); ok {
+			cache.Attrs["url"] = v
+		}
+	}
+	if _, ok := cache.Attrs["url"]; !ok {
+		if _, ok := cache.Attrs["url_v2"]; !ok {
+			return cache, errors.New("cache with type gha requires url parameter to be set")
 		}
-		cache.Attrs["url"] = url
 	}
 
 	if _, ok := cache.Attrs["token"]; !ok {

hack/test

@@ -125,7 +125,9 @@ baseCreateFlags="--rm --privileged $dockerConfigMount \
 -e CGO_ENABLED \
 -e GITHUB_REF \
 -e ACTIONS_RUNTIME_TOKEN \
+-e ACTIONS_CACHE_SERVICE_V2 \
 -e ACTIONS_CACHE_URL \
+-e ACTIONS_RESULTS_URL \
 -e TEST_DOCKERD \
 -e BUILDKIT_TEST_ENABLE_FEATURES \
 -e BUILDKIT_TEST_DISABLE_FEATURES \