GitLabgitlab-org
cli
main
1//go:build !integration
3package get_token
5import (
6 "encoding/json"
7 "errors"
8 "io"
9 "os"
10 "path/filepath"
11 "testing"
12 "time"
14 "github.com/stretchr/testify/assert"
15 "github.com/stretchr/testify/require"
16 "github.com/zalando/go-keyring"
18 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
19)
21type mockStorage struct {
22 data map[string][]byte
23}
25func (m *mockStorage) get(id string) ([]byte, error) {
26 if data, exists := m.data[id]; exists {
27 return data, nil
28 }
29 return nil, errNotFound
30}
32func (m *mockStorage) set(id string, data []byte) error {
33 if m.data == nil {
34 m.data = make(map[string][]byte)
35 }
36 m.data[id] = data
37 return nil
38}
40func TestCache_unpopulated(t *testing.T) {
41 // GIVEN
42 createdPAT := &gitlab.PersonalAccessToken{
43 Name: "sentinel",
44 Token: "redacted",
45 ExpiresAt: new(gitlab.ISOTime(time.Now().UTC().Add(1 * time.Hour))),
46 }
47 c := &cache{
48 id: "test-id",
49 createFunc: func() (*gitlab.PersonalAccessToken, error) {
50 return createdPAT, nil
51 },
52 storage: &mockStorage{},
53 }
55 // WHEN
56 pat, err := c.get()
58 // THEN
59 require.NoError(t, err)
60 require.Equal(t, createdPAT, pat)
61}
63func TestCache_createError(t *testing.T) {
64 // GIVEN
65 expectedErr := errors.New("sentinel")
66 c := &cache{
67 id: "test-id",
68 createFunc: func() (*gitlab.PersonalAccessToken, error) {
69 return nil, expectedErr
70 },
71 storage: &mockStorage{},
72 }
74 // WHEN
75 _, err := c.get()
77 // THEN
78 require.ErrorIs(t, err, expectedErr)
79}
81func TestCache_hit(t *testing.T) {
82 // GIVEN
83 token := &gitlab.PersonalAccessToken{
84 Token: "any-token",
85 ExpiresAt: new(gitlab.ISOTime(time.Now().UTC().Add(tokenExpiryDurationDefault))),
86 }
88 mockStore := &mockStorage{}
90 // Manually populate cache with valid token
91 tokenData, err := json.Marshal(token)
92 require.NoError(t, err)
93 err = mockStore.set("test-id", tokenData)
94 require.NoError(t, err)
96 c := &cache{
97 id: "test-id",
98 createFunc: func() (*gitlab.PersonalAccessToken, error) {
99 return nil, errors.New("sentinel - should not be called")
100 },
101 isTokenRevoked: func(t *gitlab.PersonalAccessToken) (bool, error) {
102 return false, nil
103 },
104 storage: mockStore,
105 }
107 // WHEN
108 pat, err := c.get()
110 // THEN
111 require.NoError(t, err)
112 require.Equal(t, "any-token", pat.Token)
113}
115func TestCache_tokenExpired(t *testing.T) {
116 // GIVEN
117 expiredToken := &gitlab.PersonalAccessToken{
118 Token: "expired-token",
119 ExpiresAt: new(gitlab.ISOTime(time.Now().UTC().Add(-1 * time.Hour))),
120 }
122 newToken := &gitlab.PersonalAccessToken{
123 Token: "new-token",
124 ExpiresAt: new(gitlab.ISOTime(time.Now().UTC().Add(tokenExpiryDurationDefault))),
125 }
127 mockStore := &mockStorage{}
128 // Manually set expired token in storage
129 expiredData, err := json.Marshal(expiredToken)
130 require.NoError(t, err)
131 err = mockStore.set("test-id", expiredData)
132 require.NoError(t, err)
134 c := cache{
135 id: "test-id",
136 createFunc: func() (*gitlab.PersonalAccessToken, error) {
137 return newToken, nil
138 },
139 isTokenRevoked: func(t *gitlab.PersonalAccessToken) (bool, error) {
140 return false, nil
141 },
142 storage: mockStore,
143 }
145 // WHEN
146 pat, err := c.get()
148 // THEN
149 require.NoError(t, err)
150 require.Equal(t, "new-token", pat.Token)
151}
153func TestCache_tokenRevoked(t *testing.T) {
154 // GIVEN
155 revokedToken := &gitlab.PersonalAccessToken{
156 Token: "revoked-token",
157 Revoked: true,
158 ExpiresAt: new(gitlab.ISOTime(time.Now().UTC().Add(-1 * time.Hour))),
159 }
161 newToken := &gitlab.PersonalAccessToken{
162 Token: "new-token",
163 ExpiresAt: new(gitlab.ISOTime(time.Now().UTC().Add(tokenExpiryDurationDefault))),
164 }
166 mockStore := &mockStorage{}
167 // Manually set revoked token in storage
168 revokedData, err := json.Marshal(revokedToken)
169 require.NoError(t, err)
170 err = mockStore.set("test-id", revokedData)
171 require.NoError(t, err)
173 c := cache{
174 id: "test-id",
175 createFunc: func() (*gitlab.PersonalAccessToken, error) {
176 return newToken, nil
177 },
178 isTokenRevoked: func(t *gitlab.PersonalAccessToken) (bool, error) {
179 return true, nil
180 },
181 storage: mockStore,
182 }
184 // WHEN
185 pat, err := c.get()
187 // THEN
188 require.NoError(t, err)
189 require.Equal(t, "new-token", pat.Token)
190}
192func TestKeyringStorage_get(t *testing.T) {
193 // GIVEN
194 keyring.MockInit()
196 // populate keyring
197 err := keyring.Set(keyringService, "test-id", "any-data")
198 require.NoError(t, err)
199 s := keyringStorage{}
201 // WHEN
202 data, err := s.get("test-id")
204 // THEN
205 require.NoError(t, err)
206 assert.Equal(t, []byte("any-data"), data)
207}
209func TestKeyringStorage_get_NotFound(t *testing.T) {
210 // GIVEN
211 keyring.MockInit()
213 s := keyringStorage{}
215 // WHEN
216 _, err := s.get("test-id")
218 // THEN
219 require.ErrorIs(t, err, errNotFound)
220}
222func TestKeyringStorage_get_Unsupported(t *testing.T) {
223 // GIVEN
224 keyring.MockInitWithError(keyring.ErrUnsupportedPlatform)
226 s := keyringStorage{}
228 // WHEN
229 _, err := s.get("test-id")
231 // THEN
232 require.ErrorIs(t, err, errUnsupportedPlatform)
233}
235func TestKeyringStorage_set(t *testing.T) {
236 // GIVEN
237 keyring.MockInit()
239 s := keyringStorage{}
241 // WHEN
242 err := s.set("test-id", []byte("any-data"))
244 // THEN
245 require.NoError(t, err)
246 setData, err := keyring.Get(keyringService, "test-id")
247 require.NoError(t, err)
248 assert.Equal(t, "any-data", setData)
249}
251func TestFileStorage_get(t *testing.T) {
252 // GIVEN
253 d := testDir(t)
254 defer d.Close()
255 f, err := d.OpenFile("test-id", os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0o400)
256 require.NoError(t, err)
257 _, err = f.WriteString("any-data")
258 require.NoError(t, err)
259 require.NoError(t, f.Sync())
260 require.NoError(t, f.Close())
262 s := fileStorage{root: d}
264 // WHEN
265 data, err := s.get("test-id")
267 // THEN
268 require.NoError(t, err)
269 assert.Equal(t, []byte("any-data"), data)
270}
272func TestFileStorage_get_NotFound(t *testing.T) {
273 // GIVEN
274 d := testDir(t)
275 defer d.Close()
277 s := fileStorage{root: d}
279 // WHEN
280 _, err := s.get("test-id")
282 // THEN
283 require.ErrorIs(t, err, errNotFound)
284}
286func TestFileStorage_set(t *testing.T) {
287 // GIVEN
288 d := testDir(t)
289 defer d.Close()
291 s := fileStorage{root: d}
293 // WHEN
294 err := s.set("test-id", []byte("any-data"))
296 // THEN
297 require.NoError(t, err)
298 assert.FileExists(t, filepath.Join(d.Name(), "test-id"))
299 f, err := d.Open("test-id")
300 require.NoError(t, err)
301 data, err := io.ReadAll(f)
302 require.NoError(t, err)
303 assert.Equal(t, []byte("any-data"), data)
304}
306func testDir(t *testing.T) *os.Root {
307 t.Helper()
309 d, err := os.OpenRoot(t.TempDir())
310 require.NoError(t, err)
312 return d
313}
Diagnostics9 git calls · 331 ms
CallStatusSizeTime0331 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 KiB3 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=UPDATING 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=44Open pack map
fetchcombine:blob:none+tree:2 · deepen 12004.2 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=4273 git.response.cache=HIT git.response.duration_ms=4 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 · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=3 git.response.bytes=1857 git.response.cache=HIT git.response.duration_ms=3 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 · 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=948ee807a1ee817af67f2df94421a202e82325f9Open 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=adfacba5ff1f4fcf28dcaac12e2874f6d48a7934Open pack map
fetchtree:0200263 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=263 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=2c1df054e09d18899b4c74c207905511ed57f752 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=263 git.pkt.payload.max=236 git.sideband.band1.bytes=236 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=236 git.pack.trailer=6ae3f3b63c9b4fb1e4060b9efa24a84240bbb33eOpen pack map
fetch2001.4 KiB315 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=315 git.response.bytes=1433 git.response.cache=MISS git.response.duration_ms=315 git.fetch.wants=ff70159bbaee7ae47cfba89bd6c282b4a600fad5 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=1433 git.pkt.payload.max=1406 git.sideband.band1.bytes=1406 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
- a5eb08b76f1a21ca
- Request
- 9aadc02f…
- 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