GitLabgitlab-org

cli

main
ply9 git calls227 ms100 KiB7 cachedprotocol v2
232 lines8.3 KiBRaw
1//go:build !integration
3package update_kubeconfig
5import (
6 "os"
7 "path/filepath"
8 "testing"
9 "time"
11 "github.com/stretchr/testify/assert"
12 "github.com/stretchr/testify/require"
13 "go.uber.org/mock/gomock"
14 "k8s.io/client-go/tools/clientcmd"
15 clientcmdapi "k8s.io/client-go/tools/clientcmd/api"
17 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
18 gitlabtesting "gitlab.com/gitlab-org/api/client-go/v3/testing"
20 "gitlab.com/gitlab-org/cli/internal/commands/cluster/agent/agentutils"
21 "gitlab.com/gitlab-org/cli/internal/testing/cmdtest"
24func TestAgent_UpdateKubeConfig_GlabExec(t *testing.T) {
25 // GIVEN
26 startingConfig := clientcmdapi.NewConfig()
28 // WHEN
29 params := updateKubeconfigParams{
30 startingConfig: *startingConfig,
31 glabExecutable: "glab",
32 glHost: "gitlab.example.com",
33 glRepoFullName: "gitlab-user/repo",
34 glUser: "gitlab-user",
35 kasK8sProxyURL: "https://kas.gitlab.example.com/k8s-proxy",
36 agent: &gitlab.Agent{ID: 42, Name: "test-agent", ConfigProject: gitlab.ConfigProject{PathWithNamespace: "foo/bar"}},
37 tokenExpiryDuration: 42 * time.Hour,
38 cacheMode: agentutils.ForcedFilesystemCacheMode,
39 checkRevoked: false,
40 }
41 modifiedConfig, contextName := updateKubeconfig(params)
43 // THEN
44 // verify the cluster entry
45 assert.Contains(t, modifiedConfig.Clusters, "gitlab_example_com")
46 assert.Equal(t, "https://kas.gitlab.example.com/k8s-proxy", modifiedConfig.Clusters["gitlab_example_com"].Server)
48 // verify auth info entry
49 assert.Contains(t, modifiedConfig.AuthInfos, "gitlab_example_com-42")
50 actualExec := modifiedConfig.AuthInfos["gitlab_example_com-42"].Exec
51 assert.Equal(t, k8sAuthInfoExecApiVersion, actualExec.APIVersion)
52 assert.Equal(t, "glab", actualExec.Command)
53 assert.Equal(t, []string{"cluster", "agent", "get-token", "--agent", "42", "--repo", "gitlab-user/repo", "--token-expiry-duration", "42h0m0s", "--cache-mode", agentutils.ForcedFilesystemCacheMode}, actualExec.Args)
54 assert.Equal(t, []clientcmdapi.ExecEnvVar{{Name: "GITLAB_HOST", Value: "gitlab.example.com"}}, actualExec.Env)
55 assert.Equal(t, clientcmdapi.NeverExecInteractiveMode, actualExec.InteractiveMode)
56 assert.Empty(t, modifiedConfig.AuthInfos["gitlab_example_com-42"].Token)
57 assert.Empty(t, modifiedConfig.AuthInfos["gitlab_example_com-42"].TokenFile)
59 // verify context entry
60 assert.Contains(t, modifiedConfig.Contexts, "gitlab_example_com-foo_bar-test-agent")
61 actualContext := modifiedConfig.Contexts["gitlab_example_com-foo_bar-test-agent"]
62 assert.Equal(t, "gitlab_example_com", actualContext.Cluster)
63 assert.Equal(t, "gitlab_example_com-42", actualContext.AuthInfo)
65 // verify returned context name
66 assert.Equal(t, "gitlab_example_com-foo_bar-test-agent", contextName)
69const testContextName = "gitlab_example_com-foo_bar-test-agent"
71func setupUpdateKubeconfigCmd(t *testing.T) cmdtest.CmdExecFunc {
72 t.Helper()
74 tc := gitlabtesting.NewTestClient(t)
75 tc.MockMetadata.EXPECT().GetMetadata(gomock.Any()).Return(&gitlab.Metadata{
76 KAS: gitlab.MetadataKAS{Enabled: true, ExternalK8SProxyURL: "https://kas.gitlab.example.com/k8s-proxy"},
77 }, nil, nil)
78 tc.MockClusterAgents.EXPECT().GetAgent("OWNER/REPO", int64(42), gomock.Any()).Return(&gitlab.Agent{
79 ID: 42,
80 Name: "test-agent",
81 ConfigProject: gitlab.ConfigProject{PathWithNamespace: "foo/bar"},
82 }, nil, nil)
83 tc.MockUsers.EXPECT().CurrentUser(gomock.Any()).Return(&gitlab.User{Username: "gitlab-user"}, nil, nil)
85 return cmdtest.SetupCmdForTest(
86 t,
87 NewCmdAgentUpdateKubeconfig,
88 false,
89 cmdtest.WithGitLabClient(tc.Client),
90 cmdtest.WithBaseRepo("OWNER", "REPO", "gitlab.example.com"),
91 )
94func requireContextInKubeconfig(t *testing.T, path string) {
95 t.Helper()
97 config, err := clientcmd.LoadFromFile(path)
98 require.NoError(t, err)
99 assert.Contains(t, config.Contexts, testContextName)
102func TestAgentUpdateKubeconfig_Snap_WritesToRealHome(t *testing.T) {
103 realHome := t.TempDir()
104 t.Setenv("SNAP_REAL_HOME", realHome)
105 t.Setenv("KUBECONFIG", "")
106 exec := setupUpdateKubeconfigCmd(t)
108 out, err := exec("--agent 42")
110 require.NoError(t, err)
111 assert.Contains(t, out.OutBuf.String(), "Updated context "+testContextName)
112 requireContextInKubeconfig(t, filepath.Join(realHome, ".kube", "config"))
115func TestAgentUpdateKubeconfig_Snap_KubeconfigEnvVarWins(t *testing.T) {
116 realHome := t.TempDir()
117 kubeconfig := filepath.Join(t.TempDir(), "kubeconfig")
118 t.Setenv("SNAP_REAL_HOME", realHome)
119 t.Setenv("KUBECONFIG", kubeconfig)
120 exec := setupUpdateKubeconfigCmd(t)
122 _, err := exec("--agent 42")
124 require.NoError(t, err)
125 requireContextInKubeconfig(t, kubeconfig)
126 assert.NoFileExists(t, filepath.Join(realHome, ".kube", "config"))
129func TestAgentUpdateKubeconfig_Snap_KubeconfigFlagWins(t *testing.T) {
130 realHome := t.TempDir()
131 kubeconfig := filepath.Join(t.TempDir(), "kubeconfig")
132 t.Setenv("SNAP_REAL_HOME", realHome)
133 t.Setenv("KUBECONFIG", "")
134 exec := setupUpdateKubeconfigCmd(t)
136 _, err := exec("--agent 42 --kubeconfig " + kubeconfig)
138 require.NoError(t, err)
139 requireContextInKubeconfig(t, kubeconfig)
140 assert.NoFileExists(t, filepath.Join(realHome, ".kube", "config"))
143func TestAgentUpdateKubeconfig_PermissionDenied(t *testing.T) {
144 if os.Geteuid() == 0 {
145 t.Skip("root ignores file permissions")
146 }
148 unwritableDir := func(t *testing.T, dir string) string {
149 t.Helper()
150 require.NoError(t, os.MkdirAll(dir, 0o700))
151 require.NoError(t, os.Chmod(dir, 0o500))
152 t.Cleanup(func() { _ = os.Chmod(dir, 0o700) })
153 return filepath.Join(dir, "config")
154 }
155 unreadableFile := func(t *testing.T, dir string) string {
156 t.Helper()
157 require.NoError(t, os.MkdirAll(dir, 0o700))
158 path := filepath.Join(dir, "config")
159 require.NoError(t, os.WriteFile(path, nil, 0o000))
160 return path
161 }
162 unreadableOtherFile := func(t *testing.T, dir string) string {
163 t.Helper()
164 require.NoError(t, os.MkdirAll(dir, 0o700))
165 path := filepath.Join(dir, "other")
166 require.NoError(t, os.WriteFile(path, nil, 0o000))
167 return path
168 }
169 realKubeDir := func(realHome string) string { return filepath.Join(realHome, ".kube") }
170 otherDir := func(string) string { return "" }
172 tests := []struct {
173 name string
174 // dir picks where the kubeconfig lives from SNAP_REAL_HOME; "" means a temporary directory.
175 dir func(realHome string) string
176 kubeconfig func(t *testing.T, dir string) string
177 snap bool
178 defaultPath bool
179 viaFlag bool
180 wantHint bool
181 }{
182 {name: "snap write to default path shows connect hint", dir: realKubeDir, kubeconfig: unwritableDir, snap: true, defaultPath: true, wantHint: true},
183 {name: "snap read of ~/.kube/config shows connect hint", dir: realKubeDir, kubeconfig: unreadableFile, snap: true, wantHint: true},
184 {name: "snap read of other file under ~/.kube returns plain error", dir: realKubeDir, kubeconfig: unreadableOtherFile, snap: true, wantHint: false},
185 {name: "snap write outside ~/.kube returns plain error", dir: otherDir, kubeconfig: unwritableDir, snap: true, wantHint: false},
186 {name: "snap read of --kubeconfig outside ~/.kube returns plain error", dir: otherDir, kubeconfig: unreadableFile, snap: true, viaFlag: true, wantHint: false},
187 {name: "non-snap write returns plain error", dir: otherDir, kubeconfig: unwritableDir, snap: false, wantHint: false},
188 {name: "non-snap read returns plain error", dir: otherDir, kubeconfig: unreadableFile, snap: false, wantHint: false},
189 }
191 for _, tt := range tests {
192 t.Run(tt.name, func(t *testing.T) {
193 realHome := t.TempDir()
194 if tt.snap {
195 t.Setenv("SNAP_REAL_HOME", realHome)
196 } else {
197 t.Setenv("SNAP_REAL_HOME", "")
198 }
199 dir := tt.dir(realHome)
200 if dir == "" {
201 dir = t.TempDir()
202 }
203 kubeconfig := tt.kubeconfig(t, dir)
204 args := "--agent 42"
205 switch {
206 case tt.defaultPath:
207 t.Setenv("KUBECONFIG", "")
208 case tt.viaFlag:
209 t.Setenv("KUBECONFIG", "")
210 args += " --kubeconfig " + kubeconfig
211 default:
212 t.Setenv("KUBECONFIG", kubeconfig)
213 }
214 exec := setupUpdateKubeconfigCmd(t)
216 _, err := exec(args)
218 require.ErrorContains(t, err, "permission denied")
219 if tt.wantHint {
220 assert.ErrorContains(t, err, "sudo snap connect glab:dot-kube-config")
221 } else {
222 assert.NotContains(t, err.Error(), "snap connect")
223 }
224 })
225 }
228func TestNewPathOptions_DefaultsToHomeOutsideSnap(t *testing.T) {
229 t.Setenv("SNAP_REAL_HOME", "")
231 assert.Equal(t, clientcmd.RecommendedHomeFile, newPathOptions().GlobalFile)
Diagnostics9 git calls · 227 ms
CallStatusSizeTime0227 ms
discover200185 B2 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=185
git.server.agent=git/2.56.g1891de4-Linux
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch server-option object-format
git.server.fetch=shallow wait-for-done filter
git.protocol.version=2
git.pkt.frames=9
git.pkt.data=7
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=185
git.pkt.payload.max=35
ls-refs20058 KiB · hit3 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
git.response.bytes=59849
git.response.cache=HIT
git.response.duration_ms=3
git.protocol.version=2
git.pkt.frames=731
git.pkt.data=730
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=59849
git.pkt.payload.max=143
git.ls_refs.count=730
git.ls_refs.head=refs/heads/main
fetchtree:0 · deepen 1020032 KiB · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=32926
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=22
git.pkt.data=20
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=32926
git.pkt.payload.max=32046
git.sideband.band1.bytes=32046
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=80
git.pack.bytes=32046
git.pack.ofs_delta=36
git.pack.ref_delta=0
git.pack.chain.max=2
git.pack.trailer=cb0bad5d7ffc514895d8b21c4dd470327f90bc91
git.pack.full=44
Open pack map
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=4273
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=combine:blob:none+tree:2
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=1
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=7
git.pkt.data=5
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=4273
git.pkt.payload.max=4173
git.sideband.band1.bytes=4173
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=11
git.pack.bytes=4173
git.fetch.wide.objects=11
git.fetch.wide.extra_bytes=3930
git.fetch.wide.blobs=0
fetchtree:02001.8 KiB · hit5 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=5
git.response.bytes=1857
git.response.cache=HIT
git.response.duration_ms=5
git.fetch.filter=tree:0
git.fetch.wants=dce174ff8c632a19d17eea99c8a9b7c37fb2b592
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1857
git.pkt.payload.max=1830
git.sideband.band1.bytes=1830
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=1830
git.pack.trailer=fb03183b7909876778f740d196d7516811003517
Open pack map
fetchtree:0200200 B · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=200
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=9988d47506dcbe3004b8b72cbdb9d66d6d75cda4
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=200
git.pkt.payload.max=173
git.sideband.band1.bytes=173
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=173
git.pack.trailer=948ee807a1ee817af67f2df94421a202e82325f9
Open pack map
fetchtree:0200405 B · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=405
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=d271680e941992259de0ff84d4a04bcbba55f531
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=405
git.pkt.payload.max=378
git.sideband.band1.bytes=378
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=378
git.pack.trailer=adfacba5ff1f4fcf28dcaac12e2874f6d48a7934
Open pack map
fetchtree:0200155 B · hit1 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=1
git.response.bytes=155
git.response.cache=HIT
git.response.duration_ms=1
git.fetch.filter=tree:0
git.fetch.wants=08c4e6a65fb9c1ba574151c1ff6b1c7552c6f984
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=155
git.pkt.payload.max=128
git.sideband.band1.bytes=128
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=128
git.pack.trailer=c3d76cd4a9cafbfa1321fea3678012ad974c1479
Open pack map
fetch2002.4 KiB212 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=212
git.response.bytes=2469
git.response.cache=MISS
git.response.duration_ms=212
git.fetch.wants=edcf22d59733e15dcac2834789e8592e8cbc916a
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=2469
git.pkt.payload.max=2442
git.sideband.band1.bytes=2442
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://gitlab.com/gitlab-org/cli
Ref
refs/heads/main
Commit
0dd7574dce9e385c5c30540e6c15657adc6bdce9
cf-ray
a5eb08f61e8321ca
Request
d10a4c8b…
Protocol
v2 · sha1
Agent
git/2.56.g1891de4-Linux
Filter
advertised
Fetch
shallow wait-for-done filter
Capabilities
agent ls-refs fetch server-option object-format