GitLabgitlab-org

cli

main
ply6 git calls239 ms97 KiB4 cachedprotocol v2
112 lines3.2 KiBRaw
1package config
3import (
4 "os"
5 "path/filepath"
6 "testing"
8 "github.com/stretchr/testify/assert"
9 "github.com/stretchr/testify/require"
10 "github.com/zalando/go-keyring"
13// unwritableDir returns a path whose parent is a regular file, so MkdirAll
14// fails with ENOTDIR. Chmod is ignored when tests run as root, as in CI.
15func unwritableDir(t *testing.T) string {
16 t.Helper()
18 blocker := filepath.Join(t.TempDir(), "blocker")
19 require.NoError(t, os.WriteFile(blocker, nil, 0o600))
20 return filepath.Join(blocker, "glab-cli")
23func TestCredentialWriteProbe_PassesForAWritableDirectory(t *testing.T) {
24 keyring.MockInit()
25 t.Cleanup(keyring.MockInit)
27 dir := t.TempDir()
28 require.NoError(t, CredentialWriteProbe(NewBlankConfigInDir(dir), "gitlab.com"))
30 _, err := os.Stat(filepath.Join(dir, writeProbeFilename))
31 assert.ErrorIs(t, err, os.ErrNotExist)
34func TestCredentialWriteProbe_FailsForAnUnwritableDirectory(t *testing.T) {
35 keyring.MockInit()
36 t.Cleanup(keyring.MockInit)
38 err := CredentialWriteProbe(NewBlankConfigInDir(unwritableDir(t)), "gitlab.com")
39 require.Error(t, err)
40 assert.Contains(t, err.Error(), "not accepting writes")
43// Write() is already a no-op for an in-memory config, so the probe must not
44// invent a failure the real write would not hit.
45func TestCredentialWriteProbe_PassesForAnInMemoryConfig(t *testing.T) {
46 keyring.MockInit()
47 t.Cleanup(keyring.MockInit)
49 cfg := NewFromString(`
50---
51hosts:
52 gitlab.com:
53 token: token1
54`)
55 require.NoError(t, CredentialWriteProbe(cfg, "gitlab.com"))
58// The directory is fine, but the refresh would write the rotated tokens to the
59// keyring, so a keyring that rejects writes must still fail the probe.
60func TestCredentialWriteProbe_FailsWhenKeyringModeHostHasNoWritableKeyring(t *testing.T) {
61 keyring.MockInitWithError(assert.AnError)
62 t.Cleanup(keyring.MockInit)
64 cfg := NewFromStringInDir(`
65---
66hosts:
67 gitlab.com:
68 use_keyring: "true"
69 token: token1
70`, t.TempDir())
72 err := CredentialWriteProbe(cfg, "gitlab.com")
73 require.ErrorIs(t, err, ErrKeyringUnavailable)
74 require.ErrorIs(t, err, assert.AnError)
75 assert.EqualError(t, err, `host "gitlab.com" stores credentials in the operating system keyring, but the keyring is not accepting writes: assert.AnError general error for testing`)
78// A failed use_keyring read must not be reported as "not keyring mode": that
79// skips the keyring check and reports the write will succeed.
80func TestCredentialWriteProbe_SurfacesUseKeyringReadFailure(t *testing.T) {
81 keyring.MockInit()
82 t.Cleanup(keyring.MockInit)
84 err := CredentialWriteProbe(unreadableConfig{}, "gitlab.com")
85 require.Error(t, err)
86 assert.Contains(t, err.Error(), "keyring")
87 assert.ErrorIs(t, err, assert.AnError)
90type unreadableConfig struct {
91 Config
94func (unreadableConfig) Get(string, string) (string, error) {
95 return "", assert.AnError
98// A file-mode host must not be blocked by an unavailable keyring: headless
99// Linux and CI runners have none and refresh through the file fine.
100func TestCredentialWriteProbe_IgnoresKeyringForAFileModeHost(t *testing.T) {
101 keyring.MockInitWithError(assert.AnError)
102 t.Cleanup(keyring.MockInit)
104 cfg := NewFromStringInDir(`
105---
106hosts:
107 gitlab.com:
108 token: token1
109`, t.TempDir())
111 require.NoError(t, CredentialWriteProbe(cfg, "gitlab.com"))
Diagnostics6 git calls · 239 ms
CallStatusSizeTime0239 ms
discover200185 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
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
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:0 · deepen 1020032 KiB · hit5 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=5
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
fetchtree:02001.4 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=1391
git.response.cache=HIT
git.response.duration_ms=4
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=bf750bd385ed98d15e1fea1289d3b00caa61d64c
Open pack map
fetch2001.2 KiB229 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=229
git.response.bytes=1184
git.response.cache=MISS
git.response.duration_ms=229
git.fetch.wants=547532a9f728e1594926fca56adfb1639cad56aa
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=1184
git.pkt.payload.max=1157
git.sideband.band1.bytes=1157
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
a5e23395093ba594
Request
5762e8d7…
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