GitLabgitlab-org
cli
main
1//go:build !integration
3package note
5import (
6 "fmt"
7 "net/http"
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/testing/cmdtest"
18)
20func Test_update_subcommand(t *testing.T) {
21 t.Parallel()
23 t.Run("update by note ID with message flag", func(t *testing.T) {
24 t.Parallel()
26 testClient := gitlabtesting.NewTestClient(t)
27 mockMR1(t, testClient)
29 testClient.MockDiscussions.EXPECT().
30 ListMergeRequestDiscussions("OWNER/REPO", int64(1), gomock.Any(), gomock.Any()).
31 Return(makeDiscussions(), nil, nil)
33 testClient.MockDiscussions.EXPECT().
34 UpdateMergeRequestDiscussionNote(
35 "OWNER/REPO",
36 int64(1),
37 "abc12345deadbeef1234567890abcdef12345678",
38 int64(100),
39 gomock.Any(),
40 gomock.Any(),
41 ).
42 Return(&gitlab.Note{ID: 100}, nil, nil)
44 exec := cmdtest.SetupCmdForTest(t, NewCmdNote, true,
45 cmdtest.WithGitLabClient(testClient.Client),
46 cmdtest.WithBaseRepo("OWNER", "REPO", ""),
47 )
49 output, err := exec(`update 1 100 -m "Updated body"`)
50 require.NoError(t, err)
51 assert.Contains(t, output.String(), "https://gitlab.com/OWNER/REPO/merge_requests/1#note_100")
52 })
54 t.Run("update note in second discussion", func(t *testing.T) {
55 t.Parallel()
57 testClient := gitlabtesting.NewTestClient(t)
58 mockMR1(t, testClient)
60 testClient.MockDiscussions.EXPECT().
61 ListMergeRequestDiscussions("OWNER/REPO", int64(1), gomock.Any(), gomock.Any()).
62 Return(makeDiscussions(), nil, nil)
64 testClient.MockDiscussions.EXPECT().
65 UpdateMergeRequestDiscussionNote(
66 "OWNER/REPO",
67 int64(1),
68 "def67890cafebabe1234567890abcdef12345678",
69 int64(200),
70 gomock.Any(),
71 gomock.Any(),
72 ).
73 Return(&gitlab.Note{ID: 200}, nil, nil)
75 exec := cmdtest.SetupCmdForTest(t, NewCmdNote, true,
76 cmdtest.WithGitLabClient(testClient.Client),
77 cmdtest.WithBaseRepo("OWNER", "REPO", ""),
78 )
80 output, err := exec(`update 1 200 -m "New body"`)
81 require.NoError(t, err)
82 assert.Contains(t, output.String(), "#note_200")
83 })
85 t.Run("update note found on second page", func(t *testing.T) {
86 t.Parallel()
88 testClient := gitlabtesting.NewTestClient(t)
89 mockMR1(t, testClient)
91 nextPageResponse := &gitlab.Response{
92 Response: &http.Response{StatusCode: http.StatusOK},
93 NextPage: 2,
94 }
95 lastPageResponse := &gitlab.Response{
96 Response: &http.Response{StatusCode: http.StatusOK},
97 }
99 // First page: no match.
100 testClient.MockDiscussions.EXPECT().
101 ListMergeRequestDiscussions("OWNER/REPO", int64(1), gomock.Any(), gomock.Any()).
102 Return([]*gitlab.Discussion{
103 {
104 ID: "abc12345deadbeef1234567890abcdef12345678",
105 Notes: []*gitlab.Note{
106 {ID: 100, Body: "First discussion"},
107 },
108 },
109 }, nextPageResponse, nil)
111 // Second page: match. No further pages should be requested.
112 testClient.MockDiscussions.EXPECT().
113 ListMergeRequestDiscussions("OWNER/REPO", int64(1), gomock.Any(), gomock.Any()).
114 Return([]*gitlab.Discussion{
115 {
116 ID: "def67890cafebabe1234567890abcdef12345678",
117 Notes: []*gitlab.Note{
118 {ID: 200, Body: "Second discussion"},
119 },
120 },
121 }, lastPageResponse, nil)
123 testClient.MockDiscussions.EXPECT().
124 UpdateMergeRequestDiscussionNote(
125 "OWNER/REPO",
126 int64(1),
127 "def67890cafebabe1234567890abcdef12345678",
128 int64(200),
129 gomock.Any(),
130 gomock.Any(),
131 ).
132 Return(&gitlab.Note{ID: 200}, nil, nil)
134 exec := cmdtest.SetupCmdForTest(t, NewCmdNote, true,
135 cmdtest.WithGitLabClient(testClient.Client),
136 cmdtest.WithBaseRepo("OWNER", "REPO", ""),
137 )
139 output, err := exec(`update 1 200 -m "New body"`)
140 require.NoError(t, err)
141 assert.Contains(t, output.String(), "#note_200")
142 })
144 t.Run("message from stdin", func(t *testing.T) {
145 t.Parallel()
147 testClient := gitlabtesting.NewTestClient(t)
148 mockMR1(t, testClient)
150 testClient.MockDiscussions.EXPECT().
151 ListMergeRequestDiscussions("OWNER/REPO", int64(1), gomock.Any(), gomock.Any()).
152 Return(makeDiscussions(), nil, nil)
154 testClient.MockDiscussions.EXPECT().
155 UpdateMergeRequestDiscussionNote(
156 "OWNER/REPO",
157 int64(1),
158 "abc12345deadbeef1234567890abcdef12345678",
159 int64(100),
160 gomock.Any(),
161 gomock.Any(),
162 ).
163 Return(&gitlab.Note{ID: 100}, nil, nil)
165 exec := cmdtest.SetupCmdForTest(t, NewCmdNote, false,
166 cmdtest.WithGitLabClient(testClient.Client),
167 cmdtest.WithBaseRepo("OWNER", "REPO", ""),
168 cmdtest.WithStdin("body from stdin"),
169 )
171 output, err := exec(`update 1 100`)
172 require.NoError(t, err)
173 assert.Contains(t, output.String(), "#note_100")
174 })
176 t.Run("empty message", func(t *testing.T) {
177 t.Parallel()
179 testClient := gitlabtesting.NewTestClient(t)
180 mockMR1(t, testClient)
182 testClient.MockDiscussions.EXPECT().
183 ListMergeRequestDiscussions("OWNER/REPO", int64(1), gomock.Any(), gomock.Any()).
184 Return(makeDiscussions(), nil, nil)
186 exec := cmdtest.SetupCmdForTest(t, NewCmdNote, false,
187 cmdtest.WithGitLabClient(testClient.Client),
188 cmdtest.WithBaseRepo("OWNER", "REPO", ""),
189 cmdtest.WithStdin(""),
190 )
192 _, err := exec(`update 1 100`)
193 require.Error(t, err)
194 assert.Contains(t, err.Error(), "aborted: note has an empty message")
195 })
197 t.Run("non-integer identifier", func(t *testing.T) {
198 t.Parallel()
200 testClient := gitlabtesting.NewTestClient(t)
202 exec := cmdtest.SetupCmdForTest(t, NewCmdNote, true,
203 cmdtest.WithGitLabClient(testClient.Client),
204 cmdtest.WithBaseRepo("OWNER", "REPO", ""),
205 )
207 _, err := exec(`update 1 abc12345 -m "body"`)
208 require.Error(t, err)
209 assert.Contains(t, err.Error(), "invalid note ID")
210 assert.Contains(t, err.Error(), "must be a numeric note ID")
211 })
213 t.Run("note ID not found", func(t *testing.T) {
214 t.Parallel()
216 testClient := gitlabtesting.NewTestClient(t)
217 mockMR1(t, testClient)
219 testClient.MockDiscussions.EXPECT().
220 ListMergeRequestDiscussions("OWNER/REPO", int64(1), gomock.Any(), gomock.Any()).
221 Return(makeDiscussions(), &gitlab.Response{Response: &http.Response{StatusCode: http.StatusOK}}, nil)
223 exec := cmdtest.SetupCmdForTest(t, NewCmdNote, true,
224 cmdtest.WithGitLabClient(testClient.Client),
225 cmdtest.WithBaseRepo("OWNER", "REPO", ""),
226 )
228 _, err := exec(`update 1 999999 -m "body"`)
229 require.Error(t, err)
230 assert.Contains(t, err.Error(), "note 999999 not found in merge request !1")
231 })
233 t.Run("note ID not found across multiple pages", func(t *testing.T) {
234 t.Parallel()
236 testClient := gitlabtesting.NewTestClient(t)
237 mockMR1(t, testClient)
239 nextPageResponse := &gitlab.Response{
240 Response: &http.Response{StatusCode: http.StatusOK},
241 NextPage: 2,
242 }
243 lastPageResponse := &gitlab.Response{
244 Response: &http.Response{StatusCode: http.StatusOK},
245 }
247 testClient.MockDiscussions.EXPECT().
248 ListMergeRequestDiscussions("OWNER/REPO", int64(1), gomock.Any(), gomock.Any()).
249 Return(makeDiscussions(), nextPageResponse, nil)
251 testClient.MockDiscussions.EXPECT().
252 ListMergeRequestDiscussions("OWNER/REPO", int64(1), gomock.Any(), gomock.Any()).
253 Return([]*gitlab.Discussion{
254 {
255 ID: "aaaa1111bbbb2222cccc3333dddd4444eeee5555",
256 Notes: []*gitlab.Note{
257 {ID: 300, Body: "Third discussion"},
258 },
259 },
260 }, lastPageResponse, nil)
262 exec := cmdtest.SetupCmdForTest(t, NewCmdNote, true,
263 cmdtest.WithGitLabClient(testClient.Client),
264 cmdtest.WithBaseRepo("OWNER", "REPO", ""),
265 )
267 _, err := exec(`update 1 999999 -m "body"`)
268 require.Error(t, err)
269 assert.Contains(t, err.Error(), "note 999999 not found in merge request !1")
270 })
272 t.Run("underlying API error during lookup is not masked as not-found", func(t *testing.T) {
273 t.Parallel()
275 testClient := gitlabtesting.NewTestClient(t)
276 mockMR1(t, testClient)
278 forbiddenResponse := &gitlab.Response{
279 Response: &http.Response{StatusCode: http.StatusForbidden},
280 }
281 testClient.MockDiscussions.EXPECT().
282 ListMergeRequestDiscussions("OWNER/REPO", int64(1), gomock.Any(), gomock.Any()).
283 Return(nil, forbiddenResponse, fmt.Errorf("403 Forbidden"))
285 exec := cmdtest.SetupCmdForTest(t, NewCmdNote, true,
286 cmdtest.WithGitLabClient(testClient.Client),
287 cmdtest.WithBaseRepo("OWNER", "REPO", ""),
288 )
290 _, err := exec(`update 1 100 -m "body"`)
291 require.Error(t, err)
292 assert.Contains(t, err.Error(), "403 Forbidden")
293 assert.NotContains(t, err.Error(), "not found", "a real API failure must not be reported as note-not-found")
294 })
296 t.Run("API error", func(t *testing.T) {
297 t.Parallel()
299 testClient := gitlabtesting.NewTestClient(t)
300 mockMR1(t, testClient)
302 testClient.MockDiscussions.EXPECT().
303 ListMergeRequestDiscussions("OWNER/REPO", int64(1), gomock.Any(), gomock.Any()).
304 Return(makeDiscussions(), nil, nil)
306 testClient.MockDiscussions.EXPECT().
307 UpdateMergeRequestDiscussionNote(
308 "OWNER/REPO",
309 int64(1),
310 "abc12345deadbeef1234567890abcdef12345678",
311 int64(100),
312 gomock.Any(),
313 gomock.Any(),
314 ).
315 Return(nil, nil, fmt.Errorf("403 Forbidden"))
317 exec := cmdtest.SetupCmdForTest(t, NewCmdNote, true,
318 cmdtest.WithGitLabClient(testClient.Client),
319 cmdtest.WithBaseRepo("OWNER", "REPO", ""),
320 )
322 _, err := exec(`update 1 100 -m "body"`)
323 require.Error(t, err)
324 assert.Contains(t, err.Error(), "failed to update note")
325 })
326}
Diagnostics8 git calls · 219 ms
CallStatusSizeTime0219 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 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 · 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: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=44Open pack map
fetchtree:02001.8 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=1857 git.response.cache=HIT git.response.duration_ms=2 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:0200746 B · hit3 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=746 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=f3d413a22af5a9c2fe9aa49709b1cb36d1351a7f 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=746 git.pkt.payload.max=719 git.sideband.band1.bytes=719 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=719 git.pack.trailer=330baf80c59a4208b55120dff7dd824b7952b790Open pack map
fetchtree:0200540 B · hit2 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=207 git.response.bytes=540 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=d1be7f980a856805fa31e30e01fff4db335cbe1b 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=540 git.pkt.payload.max=513 git.sideband.band1.bytes=513 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=513 git.pack.trailer=6c82398efd91c9e023d583b948fde889bd4991b2Open pack map
fetch2001.4 KiB207 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1409 git.response.cache=MISS git.response.duration_ms=207 git.fetch.wants=c0838886e27290a14a2c47cbafda849da54213a1 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=1409 git.pkt.payload.max=1382 git.sideband.band1.bytes=1382 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
- a5e2c3854bf6aedd
- Request
- 83ad0af8…
- 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