GitLabgitlab-org

cli

main
ply6 git calls362 ms97 KiB4 cachedprotocol v2
132 lines3.6 KiBRaw
1//go:build !integration
3package cmdutils
5import (
6 "os"
7 "path/filepath"
8 "strings"
9 "testing"
11 "github.com/spf13/cobra"
12 "github.com/stretchr/testify/assert"
13 "github.com/stretchr/testify/require"
16const testSecretEnv = "GLAB_TEST_SECRET_FILE"
18func newSecretFile(t *testing.T, args ...string) *SecretFile {
19 t.Helper()
21 cmd := &cobra.Command{}
22 s := AddSecretFileFlag(cmd, "token-file", "token", testSecretEnv, "to use")
23 require.NoError(t, cmd.ParseFlags(args))
24 return s
27func writeSecret(t *testing.T, content string) string {
28 t.Helper()
30 path := filepath.Join(t.TempDir(), "secret")
31 require.NoError(t, os.WriteFile(path, []byte(content), 0o600))
32 return path
35func TestSecretFile_Help(t *testing.T) {
36 t.Parallel()
38 cmd := &cobra.Command{}
39 AddSecretFileFlag(cmd, "token-file", "token", testSecretEnv, "to use")
40 assert.Equal(t, "Path to a file with the token to use. Use - to read from standard input. Defaults to the "+testSecretEnv+" environment variable.", cmd.Flags().Lookup("token-file").Usage)
43func TestSecretFile_HelpEnvironment(t *testing.T) {
44 t.Parallel()
46 cmd := &cobra.Command{Annotations: map[string]string{"other": "kept"}}
47 AddSecretFileFlag(cmd, "token-file", "token", testSecretEnv, "to use")
48 AddSecretFileFlag(cmd, "key-file", "key", "GLAB_TEST_KEY_FILE", "to sign with")
49 assert.Equal(t, "kept", cmd.Annotations["other"])
50 assert.Equal(t, testSecretEnv+": the token to use, used when --token-file is not set.\nGLAB_TEST_KEY_FILE: the key to sign with, used when --key-file is not set.\n", cmd.Annotations["help:environment"])
53func TestSecretFile_ReadFile(t *testing.T) {
54 t.Parallel()
56 path := writeSecret(t, " s3cret\n")
57 s := newSecretFile(t, "--token-file", path)
59 got, err := s.Read(strings.NewReader("unused"))
60 require.NoError(t, err)
61 assert.Equal(t, "s3cret", got)
62 assert.True(t, s.IsSet())
63 assert.Equal(t, path, s.File())
64 assert.False(t, s.FromStdin())
67func TestSecretFile_ReadStdin(t *testing.T) {
68 t.Parallel()
70 s := newSecretFile(t, "--token-file", "-")
72 got, err := s.Read(strings.NewReader("s3cret\n"))
73 require.NoError(t, err)
74 assert.Equal(t, "s3cret", got)
75 assert.True(t, s.FromStdin())
78func TestSecretFile_Errors(t *testing.T) {
79 t.Parallel()
81 tests := []struct {
82 name string
83 args []string
84 wantErr string
85 }{
86 {name: "missing file", args: []string{"--token-file", "/nonexistent/secret"}, wantErr: "failed to read --token-file"},
87 {name: "empty file", args: []string{"--token-file", writeSecret(t, " \n")}, wantErr: "the token is empty"},
88 }
89 for _, tc := range tests {
90 t.Run(tc.name, func(t *testing.T) {
91 t.Parallel()
93 _, err := newSecretFile(t, tc.args...).Read(strings.NewReader(""))
94 require.Error(t, err)
95 assert.Contains(t, err.Error(), tc.wantErr)
96 })
97 }
100// The tests below set the environment, so they cannot run in parallel.
102func TestSecretFile_ReadEnvironment(t *testing.T) {
103 t.Setenv(testSecretEnv, "s3cret")
104 s := newSecretFile(t)
106 got, err := s.Read(strings.NewReader("unused"))
107 require.NoError(t, err)
108 assert.Equal(t, "s3cret", got)
109 assert.True(t, s.IsSet())
110 assert.Empty(t, s.File())
111 assert.Equal(t, testSecretEnv, s.Env())
114func TestSecretFile_FileOverridesEnvironment(t *testing.T) {
115 t.Setenv(testSecretEnv, "from-env")
116 s := newSecretFile(t, "--token-file", writeSecret(t, "from-file"))
118 got, err := s.Read(strings.NewReader(""))
119 require.NoError(t, err)
120 assert.Equal(t, "from-file", got)
123func TestSecretFile_NotSet(t *testing.T) {
124 t.Setenv(testSecretEnv, "")
125 s := newSecretFile(t)
127 assert.False(t, s.IsSet())
128 _, err := s.Read(strings.NewReader(""))
129 var flagErr *FlagError
130 require.ErrorAs(t, err, &flagErr)
131 assert.EqualError(t, err, "pass --token-file or set "+testSecretEnv)
Diagnostics6 git calls · 362 ms
CallStatusSizeTime0362 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 · hit2 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=59849
git.response.cache=HIT
git.response.duration_ms=2
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 · 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=32926
git.response.cache=HIT
git.response.duration_ms=3
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 · 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.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=1238
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=c10f4b8b760c3fec7ed8ca85e428d5bc523f8e17
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=1238
git.pkt.payload.max=1211
git.sideband.band1.bytes=1211
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=1211
git.pack.trailer=7373aa350f2a611db7d4116eb1450c92f18a27ca
Open pack map
fetch2001.2 KiB353 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=353
git.response.bytes=1215
git.response.cache=MISS
git.response.duration_ms=353
git.fetch.wants=fab9c4a6cb4a9ab461b47fe408f87dafab01d94d
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=1215
git.pkt.payload.max=1188
git.sideband.band1.bytes=1188
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
a5e20553cfddc69c
Request
69a5b15e…
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