GitLabgitlab-org

cli

main
ply8 git calls368 ms98 KiB6 cachedprotocol v2
113 lines3.8 KiBRaw
1//go:build !integration
3package update
5import (
6 "os"
7 "path/filepath"
8 "testing"
10 "github.com/stretchr/testify/assert"
11 "github.com/stretchr/testify/require"
12 "go.uber.org/mock/gomock"
14 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
15 gitlabtesting "gitlab.com/gitlab-org/api/client-go/v3/testing"
17 "gitlab.com/gitlab-org/cli/internal/glinstance"
18 "gitlab.com/gitlab-org/cli/internal/testing/cmdtest"
21func writeAttachFixture(t *testing.T, name string) string {
22 t.Helper()
24 path := filepath.Join(t.TempDir(), name)
25 require.NoError(t, os.WriteFile(path, []byte("\x89PNG\r\n\x1a\nfake png body"), 0o600))
26 return path
29func expectUpdate(tc *gitlabtesting.TestClient) func() *string {
30 var gotDescription *string
31 tc.MockWorkItems.EXPECT().
32 UpdateWorkItem("OWNER/REPO", int64(42), gomock.Any(), gomock.Any()).
33 DoAndReturn(func(_ string, _ int64, opts *gitlab.UpdateWorkItemOptions, _ ...gitlab.RequestOptionFunc) (*gitlab.WorkItem, *gitlab.Response, error) {
34 gotDescription = opts.Description
35 return &gitlab.WorkItem{IID: 42, WebURL: "https://gitlab.com/OWNER/REPO/-/work_items/42"}, &gitlab.Response{}, nil
36 })
37 return func() *string { return gotDescription }
40func TestWorkItemsUpdate_AttachFetchesAndAppendsToTheExistingDescription(t *testing.T) {
41 path := writeAttachFixture(t, "screenshot.png")
43 tc := gitlabtesting.NewTestClient(t)
44 tc.MockWorkItems.EXPECT().
45 GetWorkItem("OWNER/REPO", int64(42), gomock.Any()).
46 Return(&gitlab.WorkItem{IID: 42, Description: "Original body."}, &gitlab.Response{}, nil)
47 tc.MockProjectMarkdownUploads.EXPECT().
48 UploadProjectMarkdown("OWNER/REPO", gomock.Any(), "screenshot.png", gomock.Any()).
49 Return(&gitlab.ProjectMarkdownUploadedFile{Markdown: "![screenshot](/uploads/abc/screenshot.png)"}, nil, nil)
50 description := expectUpdate(tc)
52 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
53 cmdtest.WithGitLabClient(tc.Client),
54 cmdtest.WithBaseRepo("OWNER", "REPO", glinstance.DefaultHostname),
55 )
57 _, err := exec(`42 --attach ` + path)
58 require.NoError(t, err)
60 require.NotNil(t, description())
61 assert.Equal(t, "Original body.\n\n![screenshot](/uploads/abc/screenshot.png)", *description())
64func TestWorkItemsUpdate_AttachWithDescriptionSkipsTheFetch(t *testing.T) {
65 path := writeAttachFixture(t, "screenshot.png")
67 tc := gitlabtesting.NewTestClient(t)
68 // No GetWorkItem expectation: the extra round trip must not happen.
69 tc.MockProjectMarkdownUploads.EXPECT().
70 UploadProjectMarkdown("OWNER/REPO", gomock.Any(), "screenshot.png", gomock.Any()).
71 Return(&gitlab.ProjectMarkdownUploadedFile{Markdown: "![screenshot](/uploads/abc/screenshot.png)"}, nil, nil)
72 description := expectUpdate(tc)
74 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
75 cmdtest.WithGitLabClient(tc.Client),
76 cmdtest.WithBaseRepo("OWNER", "REPO", glinstance.DefaultHostname),
77 )
79 _, err := exec(`42 --description "Replaced body." --attach ` + path)
80 require.NoError(t, err)
82 require.NotNil(t, description())
83 assert.Equal(t, "Replaced body.\n\n![screenshot](/uploads/abc/screenshot.png)", *description())
86func TestWorkItemsUpdate_AttachIsRejectedWithGroup(t *testing.T) {
87 tc := gitlabtesting.NewTestClient(t)
89 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
90 cmdtest.WithGitLabClient(tc.Client),
91 cmdtest.WithBaseRepo("OWNER", "REPO", glinstance.DefaultHostname),
92 )
94 _, err := exec(`42 --group my-group --attach ./screenshot.png`)
95 require.Error(t, err)
96 assert.Contains(t, err.Error(), "group")
97 assert.Contains(t, err.Error(), "attach")
100func TestWorkItemsUpdate_NoAttachDoesNotFetchTheDescription(t *testing.T) {
101 tc := gitlabtesting.NewTestClient(t)
102 description := expectUpdate(tc)
104 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
105 cmdtest.WithGitLabClient(tc.Client),
106 cmdtest.WithBaseRepo("OWNER", "REPO", glinstance.DefaultHostname),
107 )
109 _, err := exec(`42 --title "new title"`)
110 require.NoError(t, err)
112 assert.Nil(t, description())
Diagnostics8 git calls · 368 ms
CallStatusSizeTime0368 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 · hit5 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=4
git.response.bytes=59849
git.response.cache=HIT
git.response.duration_ms=5
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 · 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=fb03183b7909876778f740d196d7516811003517
Open pack map
fetchtree:0200317 B · 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=317
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=33cd62a3f1bc55e6bd56a9b96f181ff12c30955a
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=317
git.pkt.payload.max=290
git.sideband.band1.bytes=290
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=290
git.pack.trailer=5711d3cc007ef3bd902f87854e977c46d0913d04
Open pack map
fetchtree:0200170 B · 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=170
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=21db039062ee6d041ad414dc4572fef7eccec043
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=170
git.pkt.payload.max=143
git.sideband.band1.bytes=143
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=143
git.pack.trailer=9a371b3c0ac0d73d3fe90ebc27ca40d9383b3a90
Open pack map
fetch2001.2 KiB350 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=350
git.response.bytes=1181
git.response.cache=MISS
git.response.duration_ms=350
git.fetch.wants=79a4c291b6dc9a8bed5b85378436295719281c0e
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=1181
git.pkt.payload.max=1154
git.sideband.band1.bytes=1154
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
a5e2779159c3d806
Request
f4fffef5…
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