From 931a426988e76be93ecce76638c5fd7875dc628f Mon Sep 17 00:00:00 2001 From: Samuel K Date: Mon, 26 Oct 2026 00:23:16 -0600 Subject: [PATCH 1/3] test(buildkit): cover cache entry parsing and gha credential fallback --- pkg/devcontainer/buildkit/cache_test.go | 175 ++++++++++++++++++++++++ 1 file changed, 175 insertions(+) create mode 100644 pkg/devcontainer/buildkit/cache_test.go diff --git a/pkg/devcontainer/buildkit/cache_test.go b/pkg/devcontainer/buildkit/cache_test.go new file mode 100644 index 0000000000..ddae390ca0 --- /dev/null +++ b/pkg/devcontainer/buildkit/cache_test.go @@ -0,0 +1,175 @@ +package buildkit + +import ( + "os" + "reflect" + "testing" + + "github.com/moby/buildkit/client" +) + +const ( + cacheAttrRef = "ref" + cacheAttrToken = "token" + cacheAttrURL = "url" + cacheTypeRegistry = "registry" + cacheRuntimeTokenEnv = "ACTIONS_RUNTIME_TOKEN" + cacheURLEnv = "ACTIONS_CACHE_URL" + cacheEnvToken = "env-token" + cacheEnvURL = "https://env-cache" + ghaScopeEntry = "type=gha,scope=x" +) + +type parseCacheEntryCase struct { + name string + in []string + env map[string]string + want []client.CacheOptionsEntry + wantErr bool +} + +func unsetEnvForTest(t *testing.T, key string) { + t.Helper() + t.Setenv(key, "") + if err := os.Unsetenv(key); err != nil { + t.Fatalf("unset %s: %v", key, err) + } +} + +func runParseCacheEntryCases(t *testing.T, cases []parseCacheEntryCase) { + t.Helper() + for _, tt := range cases { + t.Run(tt.name, func(t *testing.T) { + unsetEnvForTest(t, cacheRuntimeTokenEnv) + unsetEnvForTest(t, cacheURLEnv) + for k, v := range tt.env { + t.Setenv(k, v) + } + + got, err := ParseCacheEntry(tt.in) + if tt.wantErr { + if err == nil { + t.Fatalf("expected error, got entries %+v", got) + } + return + } + if err != nil { + t.Fatalf("unexpected error: %v", err) + } + if !reflect.DeepEqual(got, tt.want) { + t.Fatalf("ParseCacheEntry(%q) = %+v, want %+v", tt.in, got, tt.want) + } + }) + } +} + +func TestParseCacheEntryParsesRefAndTypedFields(t *testing.T) { + runParseCacheEntryCases(t, []parseCacheEntryCase{ + { + name: "ref only fields expand to registry entries", + in: []string{"ghcr.io/a:1,ghcr.io/b:2"}, + want: []client.CacheOptionsEntry{ + {Type: cacheTypeRegistry, Attrs: map[string]string{cacheAttrRef: "ghcr.io/a:1"}}, + {Type: cacheTypeRegistry, Attrs: map[string]string{cacheAttrRef: "ghcr.io/b:2"}}, + }, + }, + { + name: "typed entry keeps type and attrs", + in: []string{"type=registry,ref=ghcr.io/x:cache"}, + want: []client.CacheOptionsEntry{ + {Type: cacheTypeRegistry, Attrs: map[string]string{cacheAttrRef: "ghcr.io/x:cache"}}, + }, + }, + { + name: "keys are lowercased and values keep embedded equals", + in: []string{"TYPE=local,SRC=/tmp/x,Dest=a=b"}, + want: []client.CacheOptionsEntry{ + {Type: "local", Attrs: map[string]string{"src": "/tmp/x", "dest": "a=b"}}, + }, + }, + }) +} + +func TestParseCacheEntryRejectsInvalidInput(t *testing.T) { + runParseCacheEntryCases(t, []parseCacheEntryCase{ + { + name: "missing type is rejected", + in: []string{"ref=ghcr.io/x:cache"}, + wantErr: true, + }, + { + name: "empty type is rejected", + in: []string{"type=,ref=ghcr.io/x:cache"}, + wantErr: true, + }, + { + name: "field without equals in typed entry is rejected", + in: []string{"type=local,oops"}, + wantErr: true, + }, + { + name: "malformed csv is rejected", + in: []string{`type=local,"ref=x`}, + wantErr: true, + }, + }) +} + +func TestParseCacheEntryGhaTakesCredentialsFromEnvironment(t *testing.T) { + runParseCacheEntryCases(t, []parseCacheEntryCase{ + { + name: "gha entry takes token and url from environment", + in: []string{ghaScopeEntry}, + env: map[string]string{ + cacheRuntimeTokenEnv: cacheEnvToken, + cacheURLEnv: cacheEnvURL, + }, + want: []client.CacheOptionsEntry{ + {Type: "gha", Attrs: map[string]string{ + "scope": "x", + cacheAttrToken: cacheEnvToken, + cacheAttrURL: cacheEnvURL, + }}, + }, + }, + { + name: "explicit gha attrs take precedence over environment", + in: []string{"type=gha,token=explicit,url=https://explicit"}, + env: map[string]string{ + cacheRuntimeTokenEnv: cacheEnvToken, + cacheURLEnv: cacheEnvURL, + }, + want: []client.CacheOptionsEntry{ + {Type: "gha", Attrs: map[string]string{ + cacheAttrToken: "explicit", + cacheAttrURL: "https://explicit", + }}, + }, + }, + }) +} + +func TestParseCacheEntryDropsGhaWithoutCredentials(t *testing.T) { + runParseCacheEntryCases(t, []parseCacheEntryCase{ + { + name: "gha entry without credentials is dropped", + in: []string{ghaScopeEntry}, + want: []client.CacheOptionsEntry{}, + }, + { + name: "gha entry dropped when only url is available", + in: []string{ghaScopeEntry}, + env: map[string]string{ + cacheURLEnv: cacheEnvURL, + }, + want: []client.CacheOptionsEntry{}, + }, + { + name: "dropped gha entry does not drop sibling entries", + in: []string{ghaScopeEntry, "type=registry,ref=ghcr.io/r:1"}, + want: []client.CacheOptionsEntry{ + {Type: cacheTypeRegistry, Attrs: map[string]string{cacheAttrRef: "ghcr.io/r:1"}}, + }, + }, + }) +} From a22b5dad60228a212e21dfe088a8fa1113ab21d8 Mon Sep 17 00:00:00 2001 From: Samuel K Date: Mon, 26 Oct 2026 00:38:23 -0600 Subject: [PATCH 2/3] style(buildkit): apply golines formatting to cache parser tests --- pkg/devcontainer/buildkit/cache_test.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/pkg/devcontainer/buildkit/cache_test.go b/pkg/devcontainer/buildkit/cache_test.go index ddae390ca0..6b04443d5b 100644 --- a/pkg/devcontainer/buildkit/cache_test.go +++ b/pkg/devcontainer/buildkit/cache_test.go @@ -77,7 +77,10 @@ func TestParseCacheEntryParsesRefAndTypedFields(t *testing.T) { name: "typed entry keeps type and attrs", in: []string{"type=registry,ref=ghcr.io/x:cache"}, want: []client.CacheOptionsEntry{ - {Type: cacheTypeRegistry, Attrs: map[string]string{cacheAttrRef: "ghcr.io/x:cache"}}, + { + Type: cacheTypeRegistry, + Attrs: map[string]string{cacheAttrRef: "ghcr.io/x:cache"}, + }, }, }, { From b09c050d06ac8f1901d3e50c52bea3ed88df5fe4 Mon Sep 17 00:00:00 2001 From: Samuel K Date: Mon, 26 Oct 2026 12:18:35 -0600 Subject: [PATCH 3/3] test(buildkit): cover incomplete and mixed gha cache credentials --- pkg/devcontainer/buildkit/cache_test.go | 49 +++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/pkg/devcontainer/buildkit/cache_test.go b/pkg/devcontainer/buildkit/cache_test.go index 6b04443d5b..6cf65d7815 100644 --- a/pkg/devcontainer/buildkit/cache_test.go +++ b/pkg/devcontainer/buildkit/cache_test.go @@ -18,6 +18,10 @@ const ( cacheEnvToken = "env-token" cacheEnvURL = "https://env-cache" ghaScopeEntry = "type=gha,scope=x" + cacheTypeGHA = "gha" + cacheAttrScope = "scope" + cacheExplicitToken = "explicit-token" + cacheExplicitURL = "https://explicit-url" ) type parseCacheEntryCase struct { @@ -149,6 +153,34 @@ func TestParseCacheEntryGhaTakesCredentialsFromEnvironment(t *testing.T) { }}, }, }, + { + name: "explicit gha token combines with url from environment", + in: []string{ghaScopeEntry + ",token=" + cacheExplicitToken}, + env: map[string]string{ + cacheURLEnv: cacheEnvURL, + }, + want: []client.CacheOptionsEntry{ + {Type: cacheTypeGHA, Attrs: map[string]string{ + cacheAttrScope: "x", + cacheAttrToken: cacheExplicitToken, + cacheAttrURL: cacheEnvURL, + }}, + }, + }, + { + name: "explicit gha url combines with token from environment", + in: []string{ghaScopeEntry + ",url=" + cacheExplicitURL}, + env: map[string]string{ + cacheRuntimeTokenEnv: cacheEnvToken, + }, + want: []client.CacheOptionsEntry{ + {Type: cacheTypeGHA, Attrs: map[string]string{ + cacheAttrScope: "x", + cacheAttrToken: cacheEnvToken, + cacheAttrURL: cacheExplicitURL, + }}, + }, + }, }) } @@ -167,6 +199,23 @@ func TestParseCacheEntryDropsGhaWithoutCredentials(t *testing.T) { }, want: []client.CacheOptionsEntry{}, }, + { + name: "gha entry dropped when only token is available", + in: []string{ghaScopeEntry}, + env: map[string]string{ + cacheRuntimeTokenEnv: cacheEnvToken, + }, + want: []client.CacheOptionsEntry{}, + }, + { + name: "explicit empty gha token and url drop entry despite environment", + in: []string{ghaScopeEntry + ",token=,url="}, + env: map[string]string{ + cacheRuntimeTokenEnv: cacheEnvToken, + cacheURLEnv: cacheEnvURL, + }, + want: []client.CacheOptionsEntry{}, + }, { name: "dropped gha entry does not drop sibling entries", in: []string{ghaScopeEntry, "type=registry,ref=ghcr.io/r:1"},