1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Notes::QuickActionsService, feature_category: :team_planning do
shared_context 'note on noteable' do
let_it_be(:project) { create(:project, :repository) }
let_it_be(:maintainer) { create(:user).tap { |u| project.add_maintainer(u) } }
let_it_be(:assignee) { create(:user) }
before do
project.add_maintainer(assignee)
end
end
shared_examples 'note on noteable that supports quick actions' do
include_context 'note on noteable'
before do
note.note = note_text
end
let!(:milestone) { create(:milestone, project: project) }
let!(:labels) { create_pair(:label, project: project) }
describe 'note with only command' do
describe '/close, /label, /assign & /milestone' do
let(:note_text) do
%(/close\n/label ~#{labels.first.name} ~#{labels.last.name}\n/assign @#{assignee.username}\n/milestone %"#{milestone.name}")
end
it 'closes noteable, sets labels, assigns, and sets milestone to noteable, and leave no note' do
content = execute(note)
expect(content).to be_empty
expect(note.noteable).to be_closed
expect(note.noteable.labels).to match_array(labels)
expect(note.noteable.assignees).to eq([assignee])
expect(note.noteable.milestone).to eq(milestone)
end
end
context '/relate' do
let_it_be(:issue) { create(:issue, project: project) }
let_it_be(:other_issue) { create(:issue, project: project) }
let(:note_text) { "/relate #{other_issue.to_reference}" }
let(:note) { create(:note_on_issue, noteable: issue, project: project, note: note_text) }
context 'user cannot relate issues', :sidekiq_inline do
before do
project.team.find_member(maintainer.id).destroy!
project.update!(visibility: Gitlab::VisibilityLevel::PUBLIC)
end
it 'does not create issue relation' do
expect { execute(note) }.not_to change { IssueLink.count }
end
end
context 'user is allowed to relate issues' do
it 'creates issue relation' do
expect { execute(note) }.to change { IssueLink.count }.by(1)
end
end
end
describe '/reopen' do
before do
note.noteable.close!
expect(note.noteable).to be_closed
end
let(:note_text) { '/reopen' }
it 'opens the noteable, and leave no note' do
content = execute(note)
expect(content).to be_empty
expect(note.noteable).to be_open
end
end
describe '/spend' do
context 'when note is not persisted' do
let(:note_text) { '/spend 1h' }
it 'adds time to noteable, adds timelog with nil note_id and has no content' do
content = execute(note)
expect(content).to be_empty
expect(note.noteable.time_spent).to eq(3600)
expect(Timelog.last.note_id).to be_nil
end
end
context 'when note is persisted' do
let(:note_text) { "a note \n/spend 1h" }
it 'updates the spent time and populates timelog with note_id' do
new_content, update_params = service.execute(note)
note.update!(note: new_content)
service.apply_updates(update_params, note)
expect(Timelog.last.note_id).to eq(note.id)
end
end
context 'adds a system note' do
context 'when not specifying a date' do
let(:note_text) { "/spend 1h" }
it 'does not include the date' do
_, update_params = service.execute(note)
service.apply_updates(update_params, note)
expect(Note.last.note).to eq('added 1h of time spent')
end
end
context 'when specifying a date' do
let(:note_text) { "/spend 1h 2020-01-01" }
it 'does include the date' do
_, update_params = service.execute(note)
service.apply_updates(update_params, note)
expect(Note.last.note).to eq('added 1h of time spent at 2020-01-01')
end
end
end
end
end
describe '/estimate' do
before do
# reset to 10 minutes before each test
note.noteable.update!(time_estimate: 600)
end
shared_examples 'does not update time_estimate and displays the correct error message' do
it 'shows validation error message' do
content = execute(note)
expect(content).to be_empty
expect(note.noteable.errors[:time_estimate]).to include('must have a valid format and be greater than or equal to zero.')
expect(note.noteable.reload.time_estimate).to eq(600)
end
end
context 'when the time estimate is valid' do
let(:note_text) { '/estimate 1h' }
it 'adds time estimate to noteable' do
content = execute(note)
expect(content).to be_empty
expect(note.noteable.reload.time_estimate).to eq(3600)
end
end
context 'when the time estimate is 0' do
let(:note_text) { '/estimate 0' }
it 'adds time estimate to noteable' do
content = execute(note)
expect(content).to be_empty
expect(note.noteable.reload.time_estimate).to eq(0)
end
end
context 'when the time estimate is invalid' do
let(:note_text) { '/estimate a' }
include_examples "does not update time_estimate and displays the correct error message"
end
context 'when the time estimate is partially invalid' do
let(:note_text) { '/estimate 1d 3id' }
include_examples "does not update time_estimate and displays the correct error message"
end
context 'when the time estimate is negative' do
let(:note_text) { '/estimate -1h' }
include_examples "does not update time_estimate and displays the correct error message"
end
end
describe 'note with command & text' do
describe '/close, /label, /assign & /milestone' do
let(:note_text) do
%(HELLO\n/close\n/label ~#{labels.first.name} ~#{labels.last.name}\n/assign @#{assignee.username}\n/milestone %"#{milestone.name}"\nWORLD)
end
it 'closes noteable, sets labels, assigns, and sets milestone to noteable' do
content = execute(note)
expect(content).to eq "HELLO\nWORLD"
expect(note.noteable).to be_closed
expect(note.noteable.labels).to match_array(labels)
expect(note.noteable.assignees).to eq([assignee])
expect(note.noteable.milestone).to eq(milestone)
end
end
describe '/reopen' do
before do
note.noteable.close
expect(note.noteable).to be_closed
end
let(:note_text) { "HELLO\n/reopen\nWORLD" }
it 'opens the noteable' do
content = execute(note)
expect(content).to eq "HELLO\nWORLD"
expect(note.noteable).to be_open
end
end
end
describe '/milestone' do
let(:issue) { create(:issue, project: project) }
let(:note_text) { %(/milestone %"#{milestone.name}") }
let(:note) { create(:note_on_issue, noteable: issue, project: project, note: note_text) }
context 'on an incident' do
before do
issue.update!(work_item_type: WorkItems::Type.default_by_type(:incident))
end
it 'leaves the note empty' do
expect(execute(note)).to be_empty
end
it 'assigns the milestone' do
expect { execute(note) }.to change { issue.reload.milestone }.from(nil).to(milestone)
end
end
context 'on a merge request' do
let(:note_mr) { create(:note_on_merge_request, project: project, note: note_text) }
it 'leaves the note empty' do
expect(execute(note_mr)).to be_empty
end
it 'assigns the milestone' do
expect { execute(note) }.to change { issue.reload.milestone }.from(nil).to(milestone)
end
end
end
describe '/remove_milestone' do
let(:issue) { create(:issue, project: project, milestone: milestone) }
let(:note_text) { '/remove_milestone' }
let(:note) { create(:note_on_issue, noteable: issue, project: project, note: note_text) }
context 'on an issue' do
it 'leaves the note empty' do
expect(execute(note)).to be_empty
end
it 'removes the milestone' do
expect { execute(note) }.to change { issue.reload.milestone }.from(milestone).to(nil)
end
end
context 'on an incident' do
before do
issue.update!(work_item_type: WorkItems::Type.default_by_type(:incident))
end
it 'leaves the note empty' do
expect(execute(note)).to be_empty
end
it 'removes the milestone' do
expect { execute(note) }.to change { issue.reload.milestone }.from(milestone).to(nil)
end
end
context 'on a merge request' do
let(:note_mr) { create(:note_on_merge_request, project: project, note: note_text) }
it 'leaves the note empty' do
expect(execute(note_mr)).to be_empty
end
it 'removes the milestone' do
expect { execute(note) }.to change { issue.reload.milestone }.from(milestone).to(nil)
end
end
end
describe '/promote_to' do
shared_examples 'promotes work item' do |from:, to:|
it 'leaves the note empty' do
expect(execute(note)).to be_empty
end
it 'promotes to provided type' do
expect { execute(note) }.to change { noteable.work_item_type.base_type }.from(from).to(to)
end
end
context 'on a task' do
let_it_be_with_reload(:noteable) { create(:work_item, :task, project: project) }
let_it_be(:note_text) { '/promote_to Issue' }
let_it_be(:note) { create(:note, noteable: noteable, project: project, note: note_text) }
it_behaves_like 'promotes work item', from: 'task', to: 'issue'
context 'when type name is lower case' do
let_it_be(:note_text) { '/promote_to issue' }
it_behaves_like 'promotes work item', from: 'task', to: 'issue'
end
end
context 'on an issue' do
let_it_be_with_reload(:noteable) { create(:work_item, :issue, project: project) }
let_it_be(:note_text) { '/promote_to Incident' }
let_it_be(:note) { create(:note, noteable: noteable, project: project, note: note_text) }
it_behaves_like 'promotes work item', from: 'issue', to: 'incident'
context 'when type name is lower case' do
let_it_be(:note_text) { '/promote_to incident' }
it_behaves_like 'promotes work item', from: 'issue', to: 'incident'
end
end
end
end
describe '.supported?' do
include_context 'note on noteable'
let(:note) { create(:note_on_issue, project: project) }
context 'with a note on an issue' do
it 'returns true' do
expect(described_class.supported?(note)).to be_truthy
end
end
context 'with a note on a commit' do
let(:note) { create(:note_on_commit, project: project) }
it 'returns false' do
expect(described_class.supported?(note)).to be_truthy
end
end
end
describe '#supported?' do
include_context 'note on noteable'
it 'delegates to the class method' do
service = described_class.new(project, maintainer)
note = create(:note_on_issue, project: project)
expect(described_class).to receive(:supported?).with(note)
service.supported?(note)
end
end
describe '#execute' do
let(:service) { described_class.new(project, maintainer) }
it_behaves_like 'note on noteable that supports quick actions' do
let_it_be(:issue, reload: true) { create(:issue, project: project) }
let(:note) { build(:note_on_issue, project: project, noteable: issue) }
end
it_behaves_like 'note on noteable that supports quick actions' do
let_it_be(:incident, reload: true) { create(:incident, project: project) }
let(:note) { build(:note_on_issue, project: project, noteable: incident) }
end
it_behaves_like 'note on noteable that supports quick actions' do
let(:merge_request) { create(:merge_request, source_project: project) }
let(:note) { build(:note_on_merge_request, project: project, noteable: merge_request) }
end
context 'note on work item that supports quick actions' do
include_context 'note on noteable'
let_it_be(:work_item, reload: true) { create(:work_item, project: project) }
let(:note) { build(:note_on_work_item, project: project, noteable: work_item) }
let!(:labels) { create_pair(:label, project: project) }
before do
note.note = note_text
end
describe 'note with only command' do
describe '/close, /label & /assign' do
let(:note_text) do
%(/close\n/label ~#{labels.first.name} ~#{labels.last.name}\n/assign @#{assignee.username}\n)
end
it 'closes noteable, sets labels, assigns and leave no note' do
content = execute(note)
expect(content).to be_empty
expect(note.noteable).to be_closed
expect(note.noteable.labels).to match_array(labels)
expect(note.noteable.assignees).to eq([assignee])
end
end
describe '/reopen' do
before do
note.noteable.close!
expect(note.noteable).to be_closed
end
let(:note_text) { '/reopen' }
it 'opens the noteable, and leave no note' do
content = execute(note)
expect(content).to be_empty
expect(note.noteable).to be_open
end
end
end
describe 'note with command & text' do
describe '/close, /label, /assign' do
let(:note_text) do
%(HELLO\n/close\n/label ~#{labels.first.name} ~#{labels.last.name}\n/assign @#{assignee.username}\nWORLD)
end
it 'closes noteable, sets labels, assigns, and sets milestone to noteable' do
content = execute(note)
expect(content).to eq "HELLO\nWORLD"
expect(note.noteable).to be_closed
expect(note.noteable.labels).to match_array(labels)
expect(note.noteable.assignees).to eq([assignee])
end
end
describe '/reopen' do
before do
note.noteable.close
expect(note.noteable).to be_closed
end
let(:note_text) { "HELLO\n/reopen\nWORLD" }
it 'opens the noteable' do
content = execute(note)
expect(content).to eq "HELLO\nWORLD"
expect(note.noteable).to be_open
end
end
end
end
end
describe '#apply_updates' do
include_context 'note on noteable'
let_it_be(:issue) { create(:issue, project: project) }
let_it_be(:work_item, reload: true) { create(:work_item, :issue, project: project) }
let_it_be(:merge_request) { create(:merge_request, source_project: project) }
let_it_be(:issue_note) { create(:note_on_issue, project: project, noteable: issue) }
let_it_be(:work_item_note) { create(:note, project: project, noteable: work_item) }
let_it_be(:mr_note) { create(:note_on_merge_request, project: project, noteable: merge_request) }
let_it_be(:commit_note) { create(:note_on_commit, project: project) }
let(:update_params) { {} }
subject(:apply_updates) { described_class.new(project, maintainer).apply_updates(update_params, note) }
context 'with a note on an issue' do
let(:note) { issue_note }
it 'returns successful service response if update returned no errors' do
update_params[:confidential] = true
expect(apply_updates.success?).to be true
end
it 'returns service response with errors if update failed' do
update_params[:title] = ""
expect(apply_updates.success?).to be false
expect(apply_updates.message).to include("Title can't be blank")
end
end
context 'with a note on a merge request' do
let(:note) { mr_note }
it 'returns successful service response if update returned no errors' do
update_params[:title] = 'New title'
expect(apply_updates.success?).to be true
end
it 'returns service response with errors if update failed' do
update_params[:title] = ""
expect(apply_updates.success?).to be false
expect(apply_updates.message).to include("Title can't be blank")
end
end
context 'with a note on a work item' do
let(:note) { work_item_note }
before do
update_params[:confidential] = true
end
it 'returns successful service response if update returned no errors' do
expect(apply_updates.success?).to be true
end
it 'returns service response with errors if update failed' do
task = create(:work_item, :task, project: project)
create(:parent_link, work_item: task, work_item_parent: work_item)
expect(apply_updates.success?).to be false
expect(apply_updates.message)
.to include("A confidential work item cannot have a parent that already has non-confidential children.")
end
end
context 'with a note on a commit' do
let(:note) { commit_note }
it 'returns successful service response if update returned no errors' do
update_params[:tag_name] = 'test'
expect(apply_updates.success?).to be true
end
it 'returns service response with errors if update failed' do
update_params[:tag_name] = '-test'
expect(apply_updates.success?).to be false
expect(apply_updates.message).to include('Tag name invalid')
end
end
end
context 'CE restriction for issue assignees' do
describe '/assign' do
let(:project) { create(:project) }
let(:assignee) { create(:user) }
let(:maintainer) { create(:user) }
let(:service) { described_class.new(project, maintainer) }
let(:note) { create(:note_on_issue, note: note_text, project: project) }
let(:note_text) do
%(/assign @#{assignee.username} @#{maintainer.username}\n")
end
before do
stub_licensed_features(multiple_issue_assignees: false)
project.add_maintainer(maintainer)
project.add_maintainer(assignee)
end
it 'adds only one assignee from the list' do
execute(note)
expect(note.noteable.assignees.count).to eq(1)
end
end
end
def execute(note)
content, update_params = service.execute(note)
service.apply_updates(update_params, note)
content
end
end
|