GitLabgitlab-org
cli
main
1package clear
3import (
4 "encoding/base64"
5 "encoding/json"
6 "os"
7 "path/filepath"
8 "strconv"
9 "testing"
10 "time"
12 "github.com/MakeNowJust/heredoc/v2"
13 "github.com/stretchr/testify/assert"
14 "github.com/stretchr/testify/require"
15 "github.com/zalando/go-keyring"
16 "go.uber.org/mock/gomock"
18 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
19 gitlab_testing "gitlab.com/gitlab-org/api/client-go/v3/testing"
21 "gitlab.com/gitlab-org/cli/internal/testing/cmdtest"
22)
24// helper to write a filesystem cached token under <cacheDir>/gitlab/<base64(url)>-<agentID>
25func writeFSToken(t *testing.T, gitlabURL string, agentID int64, pat *gitlab.PersonalAccessToken) string {
26 t.Helper()
28 // Use os.UserCacheDir to get the actual cache directory that the code will use
29 // This ensures compatibility across Windows, Linux, and macOS
30 actualCacheDir, err := os.UserCacheDir()
31 require.NoError(t, err)
33 enc := base64.StdEncoding.EncodeToString([]byte(gitlabURL))
34 fname := enc + "-" + strconv.FormatInt(agentID, 10)
35 dir := filepath.Join(actualCacheDir, "gitlab")
36 require.NoError(t, os.MkdirAll(dir, 0o700))
37 fp := filepath.Join(dir, fname)
38 data, err := json.Marshal(pat)
39 require.NoError(t, err)
40 require.NoError(t, os.WriteFile(fp, data, 0o600))
41 return fp
42}
44// setUserCacheDir points Go's UserCacheDir to tempDir for this process (Windows, Unix, and macOS)
45func setUserCacheDir(t *testing.T, tempDir string) {
46 t.Helper()
47 t.Setenv("LocalAppData", tempDir) // Windows
48 t.Setenv("LOCALAPPDATA", tempDir) // Windows
49 t.Setenv("XDG_CACHE_HOME", tempDir) // Unix (Linux, BSD, etc.)
50 t.Setenv("HOME", tempDir) // macOS (uses $HOME/Library/Caches)
51}
53func TestClear_ValidationError_NoSources(t *testing.T) {
54 keyring.MockInit()
55 tc := gitlab_testing.NewTestClient(t, gitlab.WithBaseURL("https://gitlab.example.com"))
56 exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(tc.Client))
58 _, err := exec("--filesystem=false --keyring=false")
59 require.Error(t, err)
60 assert.Contains(t, err.Error(), "at least one cache source must be enabled")
61}
63func TestClear_NoTokens_ReportsEmpty(t *testing.T) {
64 keyring.MockInit()
65 tc := gitlab_testing.NewTestClient(t, gitlab.WithBaseURL("https://gitlab.example.com"))
66 exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(tc.Client))
68 cacheDir := t.TempDir()
69 setUserCacheDir(t, cacheDir)
71 out, err := exec("--filesystem --keyring=false --revoke=false")
72 require.NoError(t, err)
73 assert.Equal(t, heredoc.Doc(`
74 No cached tokens found to clear.
75 `), out.String())
76 assert.Empty(t, out.Stderr())
77}
79func TestClear_FilesystemTokens_DeletesFiles(t *testing.T) {
80 keyring.MockInit()
81 tc := gitlab_testing.NewTestClient(t, gitlab.WithBaseURL("https://gitlab.example.com"))
82 exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(tc.Client))
84 cacheDir := t.TempDir()
85 setUserCacheDir(t, cacheDir)
87 pat := &gitlab.PersonalAccessToken{ID: 123, Name: "token1"}
88 filePath := writeFSToken(t, tc.Client.BaseURL().String(), 5, pat)
90 // verify file exists before clear
91 _, err := os.Stat(filePath)
92 require.NoError(t, err, "token file should exist before clear")
94 out, err := exec("--filesystem --keyring=false --revoke=false")
95 require.NoError(t, err)
96 assert.Contains(t, out.String(), "Found 1 cached token(s) to clear")
97 assert.Contains(t, out.String(), "Cleared token for agent 5 from filesystem")
98 assert.Contains(t, out.String(), "Successfully cleared 1 token(s) from cache")
100 // verify file deleted after clear
101 _, err = os.Stat(filePath)
102 assert.True(t, os.IsNotExist(err), "token file should be deleted after clear")
103}
105func TestClear_WithRevoke_ActiveToken(t *testing.T) {
106 keyring.MockInit()
107 tc := gitlab_testing.NewTestClient(t, gitlab.WithBaseURL("https://gitlab.example.com"))
108 exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(tc.Client))
110 cacheDir := t.TempDir()
111 setUserCacheDir(t, cacheDir)
113 expires := new(gitlab.ISOTime(time.Now().UTC().Add(24 * time.Hour)))
114 pat := &gitlab.PersonalAccessToken{ID: 456, Name: "active-token", ExpiresAt: expires, Revoked: false}
115 writeFSToken(t, tc.Client.BaseURL().String(), 10, pat)
117 // mock revocation API call
118 tc.MockPersonalAccessTokens.EXPECT().
119 RevokePersonalAccessTokenByID(int64(456), gomock.Any()).
120 Return(&gitlab.Response{}, nil).
121 Times(1)
123 out, err := exec("--filesystem --keyring=false --revoke=true")
124 require.NoError(t, err)
125 assert.Contains(t, out.String(), "Revoking tokens on GitLab server")
126 assert.Contains(t, out.String(), "Revoking token for agent 10")
127 assert.Contains(t, out.String(), "Successfully revoked token for agent 10")
128 assert.Contains(t, out.String(), "Cleared token for agent 10 from filesystem")
129}
131func TestClear_WithRevoke_SkipsExpiredToken(t *testing.T) {
132 keyring.MockInit()
133 tc := gitlab_testing.NewTestClient(t, gitlab.WithBaseURL("https://gitlab.example.com"))
134 exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(tc.Client))
136 cacheDir := t.TempDir()
137 setUserCacheDir(t, cacheDir)
139 expires := new(gitlab.ISOTime(time.Now().Add(-24 * time.Hour)))
140 pat := &gitlab.PersonalAccessToken{ID: 789, Name: "expired-token", ExpiresAt: expires, Revoked: false}
141 writeFSToken(t, tc.Client.BaseURL().String(), 15, pat)
143 // no API call expected for expired token
144 tc.MockPersonalAccessTokens.EXPECT().
145 RevokePersonalAccessTokenByID(gomock.Any(), gomock.Any()).
146 Times(0)
148 out, err := exec("--filesystem --keyring=false --revoke=true")
149 require.NoError(t, err)
150 assert.Contains(t, out.String(), "Token for agent 15 is expired, skipping revocation")
151 assert.Contains(t, out.String(), "Cleared token for agent 15 from filesystem")
152}
154func TestClear_WithRevoke_SkipsAlreadyRevokedToken(t *testing.T) {
155 keyring.MockInit()
156 tc := gitlab_testing.NewTestClient(t, gitlab.WithBaseURL("https://gitlab.example.com"))
157 exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(tc.Client))
159 cacheDir := t.TempDir()
160 setUserCacheDir(t, cacheDir)
162 pat := &gitlab.PersonalAccessToken{ID: 999, Name: "revoked-token", Revoked: true}
163 writeFSToken(t, tc.Client.BaseURL().String(), 20, pat)
165 // no API call expected for already revoked token
166 tc.MockPersonalAccessTokens.EXPECT().
167 RevokePersonalAccessTokenByID(gomock.Any(), gomock.Any()).
168 Times(0)
170 out, err := exec("--filesystem --keyring=false --revoke=true")
171 require.NoError(t, err)
172 assert.Contains(t, out.String(), "Token for agent 20 is already revoked, skipping")
173 assert.Contains(t, out.String(), "Cleared token for agent 20 from filesystem")
174}
176func TestClear_FilterAgents_OnlySpecified(t *testing.T) {
177 keyring.MockInit()
178 tc := gitlab_testing.NewTestClient(t, gitlab.WithBaseURL("https://gitlab.example.com"))
179 exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(tc.Client))
181 cacheDir := t.TempDir()
182 setUserCacheDir(t, cacheDir)
184 pat1 := &gitlab.PersonalAccessToken{ID: 100, Name: "token-agent-30"}
185 pat2 := &gitlab.PersonalAccessToken{ID: 200, Name: "token-agent-31"}
186 file1 := writeFSToken(t, tc.Client.BaseURL().String(), 30, pat1)
187 file2 := writeFSToken(t, tc.Client.BaseURL().String(), 31, pat2)
189 out, err := exec("--filesystem --keyring=false --revoke=false --agent 30")
190 require.NoError(t, err)
191 assert.Contains(t, out.String(), "Found 1 cached token(s) to clear")
192 assert.Contains(t, out.String(), "Cleared token for agent 30 from filesystem")
193 assert.NotContains(t, out.String(), "agent 31")
195 // verify only agent 30 file deleted
196 _, err = os.Stat(file1)
197 assert.True(t, os.IsNotExist(err), "agent 30 token should be deleted")
198 _, err = os.Stat(file2)
199 assert.NoError(t, err, "agent 31 token should still exist")
200}
202func TestClear_KeyringRequiresAgentFlag(t *testing.T) {
203 keyring.MockInit()
204 tc := gitlab_testing.NewTestClient(t, gitlab.WithBaseURL("https://gitlab.example.com"))
205 exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithGitLabClient(tc.Client))
207 out, err := exec("--filesystem=false --keyring=true --revoke=false")
208 require.NoError(t, err)
209 assert.Contains(t, out.String(), "No cached tokens found to clear")
210 assert.Contains(t, out.Stderr(), "Warning: failed to read keyring tokens")
211 assert.Contains(t, out.Stderr(), "keyring token clearing requires --agent flag")
212}
Diagnostics11 git calls · 837 ms
CallStatusSizeTime0837 ms
discover200185 B145 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 · hit420 ms
git.upload-pack ls-refs http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=243 git.response.bytes=59849 git.response.cache=HIT git.response.duration_ms=275 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 · hit19 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=4 git.response.bytes=32926 git.response.cache=HIT git.response.duration_ms=19 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=44Open pack map
fetchtree:02001.1 KiB · hit13 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=11 git.response.bytes=1112 git.response.cache=HIT git.response.duration_ms=13 git.fetch.filter=tree:0 git.fetch.wants=fed5065f0120a857fec6fa567dcdacfd34c3187b 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=1112 git.pkt.payload.max=1085 git.sideband.band1.bytes=1085 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=1085 git.pack.trailer=792a8e6885c3db50fcc6be7a28de09363c6fb5e4Open pack map
fetchtree:0200890 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=890 git.response.cache=HIT git.response.duration_ms=1 git.fetch.filter=tree:0 git.fetch.wants=11daffb8433226c87be08ba8cfc35154e4957d77 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=890 git.pkt.payload.max=863 git.sideband.band1.bytes=863 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=863 git.pack.trailer=b909e7b7573f11b0bb74a32781c8c5e4e19277f4Open pack map
fetchtree:02001.8 KiB · hit4 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=4 git.response.bytes=1857 git.response.cache=HIT git.response.duration_ms=4 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=fb03183b7909876778f740d196d7516811003517Open pack map
fetchtree:0200200 B · hit5 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=4 git.response.bytes=200 git.response.cache=HIT git.response.duration_ms=5 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=948ee807a1ee817af67f2df94421a202e82325f9Open pack map
fetchtree:0200405 B · hit4 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=4 git.response.bytes=405 git.response.cache=HIT git.response.duration_ms=4 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=adfacba5ff1f4fcf28dcaac12e2874f6d48a7934Open pack map
fetchtree:0200175 B · hit4 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=4 git.response.bytes=175 git.response.cache=HIT git.response.duration_ms=4 git.fetch.filter=tree:0 git.fetch.wants=b2f8b8171cc11242e253b76b9b852197f2ebc178 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=175 git.pkt.payload.max=148 git.sideband.band1.bytes=148 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=148 git.pack.trailer=e894e38a7c0abf202dc4cff099138af128997f53Open pack map
fetchtree:0200171 B · hit7 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=171 git.response.cache=HIT git.response.duration_ms=7 git.fetch.filter=tree:0 git.fetch.wants=d36ff29c8cad8e5deac20b4b4585e3fcf9d32106 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=171 git.pkt.payload.max=144 git.sideband.band1.bytes=144 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=144 git.pack.trailer=8136ef1922cc3608c27aec688cf8596c3b07d46bOpen pack map
fetch2002.0 KiB351 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=351 git.response.bytes=2012 git.response.cache=MISS git.response.duration_ms=351 git.fetch.wants=85a010f81b067df722d3e6fba3c5bf9a94ed0088 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=2012 git.pkt.payload.max=1985 git.sideband.band1.bytes=1985 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
- a5eb149e9e25cf75
- Request
- d3a4a63e…
- 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