GitLabgitlab-org
cli
main
1//go:build !integration
3package config
5import (
6 "errors"
7 "fmt"
8 "os"
9 "strings"
10 "sync"
11 "testing"
13 "github.com/stretchr/testify/assert"
14 "github.com/stretchr/testify/require"
15 "github.com/zalando/go-keyring"
16)
18// The sentinel name must be unique per probe so concurrent probes never contend
19// for one entry. go-keyring's mock replaces unconditionally, so the failure a
20// shared name causes on some backends cannot be reproduced in-process;
21// uniqueness is the invariant that prevents it, so that is what these tests pin.
22func TestKeyringProbeService_IsUniquePerCall(t *testing.T) {
23 first, second := keyringProbeService(), keyringProbeService()
25 assert.NotEqual(t, first, second)
26 for _, name := range []string{first, second} {
27 assert.True(t, strings.HasPrefix(name, keyringProbePrefix+":"),
28 "%q should carry the probe prefix so leaked sentinels stay identifiable", name)
29 assert.Contains(t, name, fmt.Sprintf(":%d:", os.Getpid()),
30 "%q should be scoped to this process", name)
31 }
32}
34func TestKeyringProbeService_IsUniqueAcrossGoroutines(t *testing.T) {
35 const n = 64
37 var (
38 mu sync.Mutex
39 wg sync.WaitGroup
40 names = make(map[string]struct{}, n)
41 )
42 for range n {
43 wg.Go(func() {
44 name := keyringProbeService()
45 mu.Lock()
46 defer mu.Unlock()
47 names[name] = struct{}{}
48 })
49 }
50 wg.Wait()
52 assert.Len(t, names, n, "every concurrent probe must get its own sentinel name")
53}
55func TestKeyringWriteError_ReturnsTheBackendError(t *testing.T) {
56 sentinel := errors.New("keychain said no")
57 keyring.MockInitWithError(sentinel)
58 t.Cleanup(keyring.MockInit)
60 assert.ErrorIs(t, keyringWriteError(), sentinel)
61}
63func TestKeyringWriteError_CleansUpItsSentinel(t *testing.T) {
64 keyring.MockInit()
65 t.Cleanup(keyring.MockInit)
67 // Predict the name the probe will use rather than calling keyringProbeService,
68 // which would consume the sequence and leave this looking up a name the probe
69 // never wrote.
70 next := fmt.Sprintf("%s:%d:%d", keyringProbePrefix, os.Getpid(), keyringProbeSeq.Load()+1)
71 require.NoError(t, keyringWriteError())
73 _, err := keyring.Get(next, "")
74 assert.ErrorIs(t, err, keyring.ErrNotFound, "the probe must not leave a sentinel behind")
75}
77// A keyring failure must carry the backend's own error. Without it the message
78// reads as an unexplained permissions problem.
79func TestCredentialWriteProbe_SurfacesTheKeyringError(t *testing.T) {
80 keyring.MockInitWithError(errors.New("exit status 45"))
81 t.Cleanup(keyring.MockInit)
83 cfg := NewBlankConfigInDir(t.TempDir())
84 require.NoError(t, cfg.Set("gitlab.com", "use_keyring", "true"))
86 err := CredentialWriteProbe(cfg, "gitlab.com")
87 require.Error(t, err)
88 assert.Contains(t, err.Error(), "not accepting writes")
89 assert.Contains(t, err.Error(), "exit status 45",
90 "the backend's own error should be reported, not just that the write failed")
91}
Diagnostics6 git calls · 29 ms
CallStatusSizeTime029 ms
discover200185 B4 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch 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=3 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 · 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=4273 git.response.cache=HIT git.response.duration_ms=3 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.4 KiB · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=19 git.response.bytes=1391 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=e9da9edfdcf44933ee5fa121d411de326220161c 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=1391 git.pkt.payload.max=1364 git.sideband.band1.bytes=1364 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=1364 git.pack.trailer=bf750bd385ed98d15e1fea1289d3b00caa61d64cOpen pack map
fetch2001.3 KiB · hit19 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1318 git.response.cache=HIT git.response.duration_ms=19 git.fetch.wants=54cfbd5e0c172e3f395c66eb4f641cc40ebfb389 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=1318 git.pkt.payload.max=1291 git.sideband.band1.bytes=1291 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
- a5e222546abaa87d
- Request
- 6e874f01…
- 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