GitLabgitlab-org
cli
main
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"
19)
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
27}
29func setupAttachUpdate(t *testing.T, existingDescription string) (*gitlabtesting.TestClient, func() *string, cmdtest.CmdExecFunc) {
30 t.Helper()
32 tc := gitlabtesting.NewTestClient(t)
33 tc.MockIssues.EXPECT().
34 GetIssue("OWNER/REPO", int64(42)).
35 Return(&gitlab.Issue{IID: 42, Title: "issueTitle", Description: existingDescription}, nil, nil)
37 var gotDescription *string
38 tc.MockIssues.EXPECT().
39 UpdateIssue("OWNER/REPO", int64(42), gomock.Any()).
40 DoAndReturn(func(_ any, _ int64, opts *gitlab.UpdateIssueOptions, _ ...gitlab.RequestOptionFunc) (*gitlab.Issue, *gitlab.Response, error) {
41 gotDescription = opts.Description
42 return &gitlab.Issue{IID: 42, WebURL: "https://gitlab.com/OWNER/REPO/-/issues/42"}, nil, nil
43 })
45 exec := cmdtest.SetupCmdForTest(t, NewCmdUpdate, false,
46 cmdtest.WithGitLabClient(tc.Client),
47 cmdtest.WithBaseRepo("OWNER", "REPO", glinstance.DefaultHostname),
48 )
50 return tc, func() *string { return gotDescription }, exec
51}
53func TestIssueUpdate_AttachAppendsToTheExistingDescription(t *testing.T) {
54 path := writeAttachFixture(t, "screenshot.png")
56 tc, description, exec := setupAttachUpdate(t, "Original body.")
57 tc.MockProjectMarkdownUploads.EXPECT().
58 UploadProjectMarkdown("OWNER/REPO", gomock.Any(), "screenshot.png", gomock.Any()).
59 Return(&gitlab.ProjectMarkdownUploadedFile{Markdown: ""}, nil, nil)
61 _, err := exec(`42 --attach ` + path)
62 require.NoError(t, err)
64 require.NotNil(t, description())
65 assert.Equal(t, "Original body.\n\n", *description())
66}
68func TestIssueUpdate_AttachWithDescriptionReplacesTheBody(t *testing.T) {
69 path := writeAttachFixture(t, "screenshot.png")
71 tc, description, exec := setupAttachUpdate(t, "Original body.")
72 tc.MockProjectMarkdownUploads.EXPECT().
73 UploadProjectMarkdown("OWNER/REPO", gomock.Any(), "screenshot.png", gomock.Any()).
74 Return(&gitlab.ProjectMarkdownUploadedFile{Markdown: ""}, nil, nil)
76 _, err := exec(`42 --description "Replaced body." --attach ` + path)
77 require.NoError(t, err)
79 require.NotNil(t, description())
80 assert.Equal(t, "Replaced body.\n\n", *description())
81}
83func TestIssueUpdate_AttachReportsTheFileCount(t *testing.T) {
84 first := writeAttachFixture(t, "first.png")
85 second := writeAttachFixture(t, "second.png")
87 tc, _, exec := setupAttachUpdate(t, "Original body.")
88 tc.MockProjectMarkdownUploads.EXPECT().
89 UploadProjectMarkdown("OWNER/REPO", gomock.Any(), gomock.Any(), gomock.Any()).
90 Return(&gitlab.ProjectMarkdownUploadedFile{Markdown: ""}, nil, nil).
91 Times(2)
93 output, err := exec(`42 --attach ` + first + ` --attach ` + second)
94 require.NoError(t, err)
95 assert.Contains(t, output.String(), "attached 2 files")
96}
98func TestIssueUpdate_NoAttachLeavesTheDescriptionUnset(t *testing.T) {
99 tc := gitlabtesting.NewTestClient(t)
100 tc.MockIssues.EXPECT().
101 GetIssue("OWNER/REPO", int64(42)).
102 Return(&gitlab.Issue{IID: 42, Description: "Original body."}, nil, nil)
104 var gotDescription *string
105 tc.MockIssues.EXPECT().
106 UpdateIssue("OWNER/REPO", int64(42), gomock.Any()).
107 DoAndReturn(func(_ any, _ int64, opts *gitlab.UpdateIssueOptions, _ ...gitlab.RequestOptionFunc) (*gitlab.Issue, *gitlab.Response, error) {
108 gotDescription = opts.Description
109 return &gitlab.Issue{IID: 42, WebURL: "https://gitlab.com/OWNER/REPO/-/issues/42"}, nil, nil
110 })
112 exec := cmdtest.SetupCmdForTest(t, NewCmdUpdate, false,
113 cmdtest.WithGitLabClient(tc.Client),
114 cmdtest.WithBaseRepo("OWNER", "REPO", glinstance.DefaultHostname),
115 )
117 _, err := exec(`42 --title "new title"`)
118 require.NoError(t, err)
120 assert.Nil(t, gotDescription)
121}
Diagnostics8 git calls · 275 ms
CallStatusSizeTime0275 ms
discover200185 B3 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 KiB2 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=UPDATING 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 · 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=4 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.8 KiB · hit4 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=4 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=fb03183b7909876778f740d196d7516811003517Open pack map
fetchtree:0200492 B · hit3 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=492 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=409e7038e253494f94691a22a250deee77ba03bf 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=492 git.pkt.payload.max=465 git.sideband.band1.bytes=465 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=465 git.pack.trailer=c8a67aa26d573734cf0c8f302f8c1dd08e47d76aOpen pack map
fetchtree:0200211 B · hit4 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=256 git.response.bytes=211 git.response.cache=HIT git.response.duration_ms=4 git.fetch.filter=tree:0 git.fetch.wants=223946acadcafdcc7d72618ed1be1c04a332ea22 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=211 git.pkt.payload.max=184 git.sideband.band1.bytes=184 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=184 git.pack.trailer=4892bf72a4513d7bc02bb1fb3a31f2c4f0883c30Open pack map
fetch2001.2 KiB258 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1239 git.response.cache=MISS git.response.duration_ms=258 git.fetch.wants=81ffaf485b1a620c41254122230ed6ee057f49a7 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=1239 git.pkt.payload.max=1212 git.sideband.band1.bytes=1212 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
- a5e29c18dc7ac465
- Request
- 5d8f261b…
- 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