GitLabgitlab-org

cli

main
ply6 git calls33 ms97 KiB5 cachedprotocol v2
118 lines3.6 KiBRaw
1package cmdutils
3import (
4 "bytes"
5 "io"
6 "os"
7 "testing"
9 "github.com/spf13/cobra"
10 "github.com/stretchr/testify/assert"
11 "github.com/stretchr/testify/require"
13 "gitlab.com/gitlab-org/cli/internal/iostreams"
16func attachTestCmd(t *testing.T) *cobra.Command {
17 t.Helper()
19 cmd := &cobra.Command{Use: "test", RunE: func(*cobra.Command, []string) error { return nil }}
20 cmd.Flags().String(descriptionFlag, "", "")
21 AddDescriptionFileFlag(cmd, "issue")
23 var attach []string
24 AddAttachFlag(cmd, &attach, "description")
26 return cmd
29func attachTestIOStreams(stdin string) *iostreams.IOStreams {
30 return iostreams.New(
31 iostreams.WithStdin(io.NopCloser(bytes.NewBufferString(stdin)), false),
32 iostreams.WithStdout(io.Discard, false),
33 iostreams.WithStderr(io.Discard, false),
34 )
37func TestAddAttachFlag_MarksTheFlagExperimental(t *testing.T) {
38 t.Parallel()
40 flag := attachTestCmd(t).Flags().Lookup(attachFlag)
41 require.NotNil(t, flag)
42 assert.Contains(t, flag.Usage, "(EXPERIMENTAL)")
43 // stringArray, not stringSlice: attachment paths may contain commas.
44 assert.Equal(t, "stringArray", flag.Value.Type())
47func TestResolveDescriptionFile_RejectsSharingStdinWithAnAttachment(t *testing.T) {
48 t.Parallel()
50 cmd := attachTestCmd(t)
51 require.NoError(t, cmd.ParseFlags([]string{"--description-file", "-", "--attach", "-"}))
53 err := ResolveDescriptionFile(attachTestIOStreams("body text"), cmd)
54 require.Error(t, err)
55 assert.Contains(t, err.Error(), "cannot both read from")
58func TestResolveDescriptionFile_AllowsAnAttachmentFromStdinWithAFileDescription(t *testing.T) {
59 t.Parallel()
61 cmd := attachTestCmd(t)
62 path := t.TempDir() + "/body.md"
63 require.NoError(t, os.WriteFile(path, []byte("from a file"), 0o600))
64 require.NoError(t, cmd.ParseFlags([]string{"--description-file", path, "--attach", "-"}))
66 require.NoError(t, ResolveDescriptionFile(attachTestIOStreams(""), cmd))
68 description, err := cmd.Flags().GetString(descriptionFlag)
69 require.NoError(t, err)
70 assert.Equal(t, "from a file", description)
73func TestResolveDescriptionFile_AllowsStdinDescriptionWithAFileAttachment(t *testing.T) {
74 t.Parallel()
76 cmd := attachTestCmd(t)
77 require.NoError(t, cmd.ParseFlags([]string{"--description-file", "-", "--attach", "./screenshot.png"}))
79 require.NoError(t, ResolveDescriptionFile(attachTestIOStreams("body from stdin"), cmd))
81 description, err := cmd.Flags().GetString(descriptionFlag)
82 require.NoError(t, err)
83 assert.Equal(t, "body from stdin", description)
86func TestAppendAttachments_NoPathsLeavesTheBodyAlone(t *testing.T) {
87 t.Parallel()
89 body, err := AppendAttachments(t.Context(), attachTestIOStreams(""), nil, "OWNER/REPO", "unchanged", nil)
90 require.NoError(t, err)
91 assert.Equal(t, "unchanged", body)
94func TestSkipNoteBody(t *testing.T) {
95 t.Parallel()
97 tests := []struct {
98 name string
99 attach []string
100 isTTY bool
101 want bool
102 }{
103 {name: "no attachment reads the body", attach: nil, isTTY: true, want: false},
104 {name: "file attachment with piped stdin reads the body", attach: []string{"./a.png"}, isTTY: false, want: false},
105 {name: "stdin attachment claims stdin", attach: []string{"./a.png", "-"}, isTTY: false, want: true},
106 {name: "stdin attachment on a terminal", attach: []string{"-"}, isTTY: true, want: true},
107 {name: "file attachment on a terminal does not prompt", attach: []string{"./a.png"}, isTTY: true, want: true},
108 }
110 for _, tc := range tests {
111 t.Run(tc.name, func(t *testing.T) {
112 t.Parallel()
114 ios := iostreams.New(iostreams.WithStdin(io.NopCloser(bytes.NewBufferString("")), tc.isTTY))
115 assert.Equal(t, tc.want, SkipNoteBody(ios, tc.attach))
116 })
117 }
Diagnostics6 git calls · 33 ms
CallStatusSizeTime033 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 · hit8 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=8
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=44
Open pack map
fetchcombine:blob:none+tree:2 · deepen 12004.2 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=4273
git.response.cache=HIT
git.response.duration_ms=2
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 · 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=1238
git.response.cache=HIT
git.response.duration_ms=4
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 KiB · hit19 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=1248
git.response.cache=HIT
git.response.duration_ms=19
git.fetch.wants=027358cd1decfd7f5650c04b6d4f660dec03b5ca
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=1248
git.pkt.payload.max=1221
git.sideband.band1.bytes=1221
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
a5e1300cf87fa9fe
Request
e80e0509…
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