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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe WorkItem, feature_category: :portfolio_management do
using RSpec::Parameterized::TableSyntax
let_it_be(:reusable_project) { create(:project) }
describe 'associations' do
it { is_expected.to belong_to(:namespace) }
it { is_expected.to have_one(:work_item_parent).class_name('WorkItem') }
it 'has one `parent_link`' do
is_expected.to have_one(:parent_link)
.class_name('::WorkItems::ParentLink')
.with_foreign_key('work_item_id')
end
it 'has many `work_item_children`' do
is_expected.to have_many(:work_item_children)
.class_name('WorkItem')
.with_foreign_key('work_item_id')
end
it 'has many `work_item_children_by_relative_position`' do
is_expected.to have_many(:work_item_children_by_relative_position)
.class_name('WorkItem')
.with_foreign_key('work_item_id')
end
it 'has many `child_links`' do
is_expected.to have_many(:child_links)
.class_name('::WorkItems::ParentLink')
.with_foreign_key('work_item_parent_id')
end
end
describe '.work_item_children_by_relative_position' do
subject { parent_item.reload.work_item_children_by_relative_position }
let_it_be(:parent_item) { create(:work_item, :objective, project: reusable_project) }
let_it_be(:oldest_item) { create(:work_item, :objective, created_at: 5.hours.ago, project: reusable_project) }
let_it_be(:middle_item) { create(:work_item, :objective, project: reusable_project) }
let_it_be(:newest_item) { create(:work_item, :objective, created_at: 5.hours.from_now, project: reusable_project) }
let_it_be_with_reload(:link_to_oldest_item) do
create(:parent_link, work_item_parent: parent_item, work_item: oldest_item)
end
let_it_be_with_reload(:link_to_middle_item) do
create(:parent_link, work_item_parent: parent_item, work_item: middle_item)
end
let_it_be_with_reload(:link_to_newest_item) do
create(:parent_link, work_item_parent: parent_item, work_item: newest_item)
end
context 'when ordered by relative position and created_at' do
using RSpec::Parameterized::TableSyntax
where(:oldest_item_position, :middle_item_position, :newest_item_position, :expected_order) do
nil | nil | nil | lazy { [oldest_item, middle_item, newest_item] }
nil | nil | 1 | lazy { [newest_item, oldest_item, middle_item] }
nil | 1 | 2 | lazy { [middle_item, newest_item, oldest_item] }
2 | 3 | 1 | lazy { [newest_item, oldest_item, middle_item] }
1 | 2 | 3 | lazy { [oldest_item, middle_item, newest_item] }
end
with_them do
before do
link_to_oldest_item.update!(relative_position: oldest_item_position)
link_to_middle_item.update!(relative_position: middle_item_position)
link_to_newest_item.update!(relative_position: newest_item_position)
end
it { is_expected.to eq(expected_order) }
end
end
end
describe '#noteable_target_type_name' do
it 'returns `issue` as the target name' do
work_item = build(:work_item)
expect(work_item.noteable_target_type_name).to eq('issue')
end
end
describe '#widgets' do
subject { build(:work_item).widgets }
it 'returns instances of supported widgets' do
is_expected.to include(
instance_of(WorkItems::Widgets::Description),
instance_of(WorkItems::Widgets::Hierarchy),
instance_of(WorkItems::Widgets::Labels),
instance_of(WorkItems::Widgets::Assignees),
instance_of(WorkItems::Widgets::StartAndDueDate)
)
end
end
describe '#get_widget' do
let(:work_item) { build(:work_item, description: 'foo') }
it 'returns widget object' do
expect(work_item.get_widget(:description)).to be_an_instance_of(WorkItems::Widgets::Description)
end
context 'when widget does not exist' do
it 'returns nil' do
expect(work_item.get_widget(:nop)).to be_nil
end
end
end
describe '#supports_assignee?' do
Gitlab::DatabaseImporters::WorkItems::BaseTypeImporter::WIDGETS_FOR_TYPE.each_pair do |base_type, widgets|
specify do
work_item = build(:work_item, base_type)
supports_assignee = widgets.include?(:assignees)
expect(work_item.supports_assignee?).to eq(supports_assignee)
end
end
end
describe '#supported_quick_action_commands' do
let(:work_item) { build(:work_item, :task) }
subject { work_item.supported_quick_action_commands }
it 'returns quick action commands supported for all work items' do
is_expected.to include(:title, :reopen, :close, :cc, :tableflip, :shrug, :type)
end
context 'when work item supports the assignee widget' do
it 'returns assignee related quick action commands' do
is_expected.to include(:assign, :unassign, :reassign)
end
end
context 'when work item does not the assignee widget' do
let(:work_item) { build(:work_item, :test_case) }
it 'omits assignee related quick action commands' do
is_expected.not_to include(:assign, :unassign, :reassign)
end
end
context 'when work item supports the labels widget' do
it 'returns labels related quick action commands' do
is_expected.to include(:label, :labels, :relabel, :remove_label, :unlabel)
end
end
context 'when work item does not support the labels widget' do
let(:work_item) { build(:work_item, :incident) }
it 'omits labels related quick action commands' do
is_expected.not_to include(:label, :labels, :relabel, :remove_label, :unlabel)
end
end
context 'when work item supports the start and due date widget' do
it 'returns due date related quick action commands' do
is_expected.to include(:due, :remove_due_date)
end
end
context 'when work item does not support the start and due date widget' do
let(:work_item) { build(:work_item, :incident) }
it 'omits due date related quick action commands' do
is_expected.not_to include(:due, :remove_due_date)
end
end
end
describe 'transform_quick_action_params' do
let(:work_item) { build(:work_item, :task) }
subject(:transformed_params) do
work_item.transform_quick_action_params({
title: 'bar',
assignee_ids: ['foo']
})
end
it 'correctly separates widget params from regular params' do
expect(transformed_params).to eq({
common: {
title: 'bar'
},
widgets: {
assignees_widget: {
assignee_ids: ['foo']
}
}
})
end
end
describe 'callbacks' do
describe 'record_create_action' do
it 'records the creation action after saving' do
expect(Gitlab::UsageDataCounters::WorkItemActivityUniqueCounter).to receive(:track_work_item_created_action)
# During the work item transition we also want to track work items as issues
expect(Gitlab::UsageDataCounters::IssueActivityUniqueCounter).to receive(:track_issue_created_action)
create(:work_item)
end
it_behaves_like 'issue_edit snowplow tracking' do
let(:work_item) { create(:work_item) }
let(:property) { Gitlab::UsageDataCounters::IssueActivityUniqueCounter::ISSUE_CREATED }
let(:project) { work_item.project }
let(:user) { work_item.author }
subject(:service_action) { work_item }
end
end
context 'work item namespace' do
let(:work_item) { build(:work_item, project: reusable_project) }
it 'sets the namespace_id' do
expect(work_item).to be_valid
expect(work_item.namespace).to eq(reusable_project.project_namespace)
end
context 'when work item is saved' do
it 'sets the namespace_id' do
work_item.save!
expect(work_item.reload.namespace).to eq(reusable_project.project_namespace)
end
end
context 'when existing work item is saved' do
let(:work_item) { create(:work_item) }
before do
work_item.update!(namespace_id: nil)
end
it 'sets the namespace id' do
work_item.update!(title: "#{work_item.title} and something extra")
expect(work_item.namespace).to eq(work_item.project.project_namespace)
end
end
end
end
describe 'validations' do
subject { work_item.valid? }
describe 'issue_type' do
let(:work_item) { build(:work_item, issue_type: issue_type) }
context 'when a valid type' do
let(:issue_type) { :issue }
it { is_expected.to eq(true) }
end
context 'empty type' do
let(:issue_type) { nil }
it { is_expected.to eq(false) }
end
end
describe 'confidentiality' do
let_it_be(:project) { create(:project) }
context 'when parent and child are confidential' do
let_it_be(:parent) { create(:work_item, confidential: true, project: project) }
let_it_be(:child) { create(:work_item, :task, confidential: true, project: project) }
let_it_be(:link) { create(:parent_link, work_item: child, work_item_parent: parent) }
it 'does not allow to make child non-confidential' do
child.confidential = false
expect(child).not_to be_valid
expect(child.errors[:base])
.to include(_('A non-confidential work item cannot have a confidential parent.'))
end
it 'allows to make parent non-confidential' do
parent.confidential = false
expect(parent).to be_valid
end
end
context 'when parent and child are non-confidential' do
let_it_be(:parent) { create(:work_item, project: project) }
let_it_be(:child) { create(:work_item, :task, project: project) }
let_it_be(:link) { create(:parent_link, work_item: child, work_item_parent: parent) }
it 'does not allow to make parent confidential' do
parent.confidential = true
expect(parent).not_to be_valid
expect(parent.errors[:base]).to include(
_('A confidential work item cannot have a parent that already has non-confidential children.')
)
end
it 'allows to make child confidential' do
child.confidential = true
expect(child).to be_valid
end
end
context 'when creating new child' do
let_it_be(:child) { build(:work_item, project: project) }
it 'does not allow to set confidential parent' do
child.work_item_parent = create(:work_item, confidential: true, project: project)
expect(child).not_to be_valid
expect(child.errors[:base])
.to include('A non-confidential work item cannot have a confidential parent.')
end
end
end
end
describe '#link_reference_pattern' do
let(:match_data) { described_class.link_reference_pattern.match(link_reference_url) }
context 'with work item url' do
let(:link_reference_url) { 'http://localhost/namespace/project/-/work_items/1' }
it 'matches with expected attributes' do
expect(match_data['namespace']).to eq('namespace')
expect(match_data['project']).to eq('project')
expect(match_data['work_item']).to eq('1')
end
end
end
context 'with hierarchy' do
let_it_be(:type1) { create(:work_item_type, namespace: reusable_project.namespace) }
let_it_be(:type2) { create(:work_item_type, namespace: reusable_project.namespace) }
let_it_be(:type3) { create(:work_item_type, namespace: reusable_project.namespace) }
let_it_be(:type4) { create(:work_item_type, namespace: reusable_project.namespace) }
let_it_be(:hierarchy_restriction1) { create(:hierarchy_restriction, parent_type: type1, child_type: type2) }
let_it_be(:hierarchy_restriction2) { create(:hierarchy_restriction, parent_type: type2, child_type: type2) }
let_it_be(:hierarchy_restriction3) { create(:hierarchy_restriction, parent_type: type2, child_type: type3) }
let_it_be(:hierarchy_restriction4) { create(:hierarchy_restriction, parent_type: type3, child_type: type3) }
let_it_be(:hierarchy_restriction5) { create(:hierarchy_restriction, parent_type: type3, child_type: type4) }
let_it_be(:item1) { create(:work_item, work_item_type: type1, project: reusable_project) }
let_it_be(:item2_1) { create(:work_item, work_item_type: type2, project: reusable_project) }
let_it_be(:item2_2) { create(:work_item, work_item_type: type2, project: reusable_project) }
let_it_be(:item3_1) { create(:work_item, work_item_type: type3, project: reusable_project) }
let_it_be(:item3_2) { create(:work_item, work_item_type: type3, project: reusable_project) }
let_it_be(:item4) { create(:work_item, work_item_type: type4, project: reusable_project) }
let_it_be(:ignored_ancestor) { create(:work_item, work_item_type: type1, project: reusable_project) }
let_it_be(:ignored_descendant) { create(:work_item, work_item_type: type4, project: reusable_project) }
let_it_be(:link1) { create(:parent_link, work_item_parent: item1, work_item: item2_1) }
let_it_be(:link2) { create(:parent_link, work_item_parent: item2_1, work_item: item2_2) }
let_it_be(:link3) { create(:parent_link, work_item_parent: item2_2, work_item: item3_1) }
let_it_be(:link4) { create(:parent_link, work_item_parent: item3_1, work_item: item3_2) }
let_it_be(:link5) { create(:parent_link, work_item_parent: item3_2, work_item: item4) }
describe '#ancestors' do
it 'returns all ancestors in ascending order' do
expect(item3_1.ancestors).to eq([item2_2, item2_1, item1])
end
it 'returns an empty array if there are no ancestors' do
expect(item1.ancestors).to be_empty
end
end
describe '#same_type_base_and_ancestors' do
it 'returns self and all ancestors of the same type in ascending order' do
expect(item3_2.same_type_base_and_ancestors).to eq([item3_2, item3_1])
end
it 'returns self if there are no ancestors of the same type' do
expect(item3_1.same_type_base_and_ancestors).to match_array([item3_1])
end
end
describe '#same_type_descendants_depth' do
it 'returns max descendants depth including self' do
expect(item3_1.same_type_descendants_depth).to eq(2)
end
it 'returns 1 if there are no descendants' do
expect(item1.same_type_descendants_depth).to eq(1)
end
end
end
describe '#allowed_work_item_type_change' do
let_it_be(:all_types) { WorkItems::Type::BASE_TYPES.keys }
it 'is possible to change between all types', :aggregate_failures do
all_types.each do |type|
work_item = build(:work_item, type, project: reusable_project)
(all_types - [type]).each do |new_type|
work_item.work_item_type_id = WorkItems::Type.default_by_type(new_type).id
expect(work_item).to be_valid, "#{type} to #{new_type}"
end
end
end
context 'with ParentLink relation' do
let_it_be(:old_type) { create(:work_item_type) }
let_it_be(:new_type) { create(:work_item_type) }
context 'with hierarchy restrictions' do
let_it_be(:child_type) { create(:work_item_type) }
let_it_be_with_reload(:parent) { create(:work_item, work_item_type: old_type, project: reusable_project) }
let_it_be_with_reload(:child) { create(:work_item, work_item_type: child_type, project: reusable_project) }
let_it_be(:hierarchy_restriction) do
create(:hierarchy_restriction, parent_type: old_type, child_type: child_type)
end
let_it_be(:link) { create(:parent_link, work_item_parent: parent, work_item: child) }
context 'when child items restrict the type change' do
before do
parent.work_item_type = new_type
end
context 'when child items are compatible with the new type' do
let_it_be(:hierarchy_restriction_new_type) do
create(:hierarchy_restriction, parent_type: new_type, child_type: child_type)
end
it 'allows to change types' do
expect(parent).to be_valid
expect(parent.errors).to be_empty
end
end
context 'when child items are not compatible with the new type' do
it 'does not allow to change types' do
expect(parent).not_to be_valid
expect(parent.errors[:work_item_type_id])
.to include("cannot be changed to #{new_type.name} with these child item types.")
end
end
end
context 'when the parent restricts the type change' do
before do
child.work_item_type = new_type
end
it 'does not allow to change types' do
expect(child.valid?).to eq(false)
expect(child.errors[:work_item_type_id])
.to include("cannot be changed to #{new_type.name} with #{parent.work_item_type.name} as parent type.")
end
end
end
context 'with hierarchy depth restriction' do
let_it_be_with_reload(:item1) { create(:work_item, work_item_type: new_type, project: reusable_project) }
let_it_be_with_reload(:item2) { create(:work_item, work_item_type: new_type, project: reusable_project) }
let_it_be_with_reload(:item3) { create(:work_item, work_item_type: new_type, project: reusable_project) }
let_it_be_with_reload(:item4) { create(:work_item, work_item_type: new_type, project: reusable_project) }
let_it_be(:hierarchy_restriction1) do
create(:hierarchy_restriction, parent_type: old_type, child_type: new_type)
end
let_it_be(:hierarchy_restriction2) do
create(:hierarchy_restriction, parent_type: new_type, child_type: old_type)
end
let_it_be_with_reload(:hierarchy_restriction3) do
create(:hierarchy_restriction, parent_type: new_type, child_type: new_type, maximum_depth: 4)
end
let_it_be(:link1) { create(:parent_link, work_item_parent: item1, work_item: item2) }
let_it_be(:link2) { create(:parent_link, work_item_parent: item2, work_item: item3) }
let_it_be(:link3) { create(:parent_link, work_item_parent: item3, work_item: item4) }
before do
hierarchy_restriction3.update!(maximum_depth: maximum_depth)
end
shared_examples 'validates the depth correctly' do
before do
work_item.update!(work_item_type: old_type)
end
context 'when it is valid' do
let(:maximum_depth) { 4 }
it 'allows to change types' do
work_item.work_item_type = new_type
expect(work_item).to be_valid
end
end
context 'when it is not valid' do
let(:maximum_depth) { 3 }
it 'does not allow to change types' do
work_item.work_item_type = new_type
expect(work_item).not_to be_valid
expect(work_item.errors[:work_item_type_id]).to include("reached maximum depth")
end
end
end
context 'with the highest ancestor' do
let_it_be_with_reload(:work_item) { item1 }
it_behaves_like 'validates the depth correctly'
end
context 'with a child item' do
let_it_be_with_reload(:work_item) { item2 }
it_behaves_like 'validates the depth correctly'
end
context 'with the last child item' do
let_it_be_with_reload(:work_item) { item4 }
it_behaves_like 'validates the depth correctly'
end
context 'when ancestor is still the old type' do
let_it_be(:hierarchy_restriction4) do
create(:hierarchy_restriction, parent_type: old_type, child_type: old_type)
end
before do
item1.update!(work_item_type: old_type)
item2.update!(work_item_type: old_type)
end
context 'when it exceeds maximum depth' do
let(:maximum_depth) { 2 }
it 'does not allow to change types' do
item2.work_item_type = new_type
expect(item2).not_to be_valid
expect(item2.errors[:work_item_type_id]).to include("reached maximum depth")
end
end
context 'when it does not exceed maximum depth' do
let(:maximum_depth) { 3 }
it 'does allow to change types' do
item2.work_item_type = new_type
expect(item2).to be_valid
end
end
end
end
end
end
end
|