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
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Integrations::Jira, feature_category: :integrations do
include AssetsHelpers
let_it_be(:project) { create(:project, :repository) }
let(:current_user) { build_stubbed(:user) }
let(:url) { 'http://jira.example.com' }
let(:api_url) { 'http://api-jira.example.com' }
let(:username) { 'jira-username' }
let(:jira_auth_type) { 0 }
let(:jira_issue_prefix) { '' }
let(:jira_issue_regex) { '' }
let(:password) { 'jira-password' }
let(:project_key) { nil }
let(:transition_id) { 'test27' }
let(:server_info_results) { { 'deploymentType' => 'Cloud' } }
let(:jira_integration) do
described_class.new(
project: project,
url: url,
username: username,
password: password,
project_key: project_key
)
end
before do
WebMock.stub_request(:get, /serverInfo/).to_return(body: server_info_results.to_json)
end
it_behaves_like Integrations::ResetSecretFields do
let(:integration) { jira_integration }
end
describe 'validations' do
subject { jira_integration }
context 'when integration is active' do
before do
jira_integration.active = true
# Don't auto-fill URLs from gitlab.yml
stub_config(issues_tracker: {})
end
it { is_expected.to be_valid }
it { is_expected.to validate_presence_of(:url) }
it { is_expected.to validate_presence_of(:username) }
it { is_expected.to validate_presence_of(:password) }
it { is_expected.to validate_presence_of(:jira_auth_type) }
it { is_expected.to validate_length_of(:jira_issue_regex).is_at_most(255) }
it { is_expected.to validate_length_of(:jira_issue_prefix).is_at_most(255) }
it { is_expected.to validate_inclusion_of(:jira_auth_type).in_array([0, 1]) }
it_behaves_like 'issue tracker integration URL attribute', :url
it_behaves_like 'issue tracker integration URL attribute', :api_url
context 'with personal_access_token_authorization' do
before do
jira_integration.jira_auth_type = 1
end
it { is_expected.not_to validate_presence_of(:username) }
end
context 'when URL is for Jira Cloud' do
before do
jira_integration.url = 'https://test.atlassian.net'
end
it 'is valid when jira_auth_type is basic' do
jira_integration.jira_auth_type = 0
expect(jira_integration).to be_valid
end
it 'is invalid when jira_auth_type is PAT' do
jira_integration.jira_auth_type = 1
expect(jira_integration).not_to be_valid
end
end
end
context 'when integration is inactive' do
before do
jira_integration.active = false
end
it { is_expected.to be_valid }
it { is_expected.not_to validate_presence_of(:url) }
it { is_expected.not_to validate_presence_of(:username) }
it { is_expected.not_to validate_presence_of(:password) }
it { is_expected.not_to validate_presence_of(:jira_auth_type) }
it { is_expected.not_to validate_length_of(:jira_issue_regex).is_at_most(255) }
it { is_expected.not_to validate_length_of(:jira_issue_prefix).is_at_most(255) }
it { is_expected.not_to validate_inclusion_of(:jira_auth_type).in_array([0, 1]) }
end
describe 'jira_issue_transition_id' do
it 'accepts a blank value' do
jira_integration.jira_issue_transition_id = ' '
expect(jira_integration).to be_valid
end
it 'accepts any string containing numbers' do
jira_integration.jira_issue_transition_id = 'foo 23 bar'
expect(jira_integration).to be_valid
end
it 'does not accept a string without numbers' do
jira_integration.jira_issue_transition_id = 'foo bar'
expect(jira_integration).not_to be_valid
expect(jira_integration.errors.full_messages).to eq(
[
'Jira issue transition IDs must be a list of numbers that can be split with , or ;'
])
end
end
end
describe '#options' do
let(:options) do
{
project: project,
active: true,
username: 'username',
password: 'test',
jira_issue_transition_id: 24,
url: 'http://jira.test.com:1234/path/'
}
end
let(:integration) { described_class.create!(options) }
it 'sets the URL properly' do
# jira-ruby gem parses the URI and handles trailing slashes fine:
# https://github.com/sumoheavy/jira-ruby/blob/v1.7.0/lib/jira/http_client.rb#L62
expect(integration.options[:site]).to eq('http://jira.test.com:1234')
end
it 'leaves out trailing slashes in context' do
expect(integration.options[:context_path]).to eq('/path')
end
context 'URL without a path' do
before do
integration.url = 'http://jira.test.com/'
end
it 'leaves out trailing slashes in context' do
expect(integration.options[:site]).to eq('http://jira.test.com')
expect(integration.options[:context_path]).to eq('')
end
end
context 'URL with query string parameters' do
before do
integration.url << '?nosso&foo=bar'
end
it 'removes query string parameters' do
expect(integration.options[:site]).to eq('http://jira.test.com:1234')
expect(integration.options[:context_path]).to eq('/path')
end
end
context 'username with trailing whitespaces' do
before do
options.merge!(username: 'username ')
end
it 'leaves out trailing whitespaces in username' do
expect(integration.options[:username]).to eq('username')
end
end
it 'provides additional cookies to allow basic auth with oracle webgate' do
expect(integration.options[:use_cookies]).to eq(true)
expect(integration.options[:additional_cookies]).to eq(['OBBasicAuth=fromDialog'])
end
context 'using api URL' do
before do
options.merge!(api_url: 'http://jira.test.com/api_path/')
end
it 'leaves out trailing slashes in context' do
expect(integration.options[:context_path]).to eq('/api_path')
end
end
end
describe '#fields' do
let(:integration) { jira_integration }
subject(:fields) { integration.fields }
it 'returns custom fields' do
expect(fields.pluck(:name)).to eq(%w[url api_url jira_auth_type username password jira_issue_regex jira_issue_prefix jira_issue_transition_id])
end
end
describe '#sections' do
let(:integration) { jira_integration }
subject(:sections) { integration.sections.map { |s| s[:type] } }
context 'when project_level? is true' do
before do
allow(integration).to receive(:project_level?).and_return(true)
end
it 'includes SECTION_TYPE_JIRA_ISSUES' do
expect(sections).to include(described_class::SECTION_TYPE_JIRA_ISSUES)
end
it 'section SECTION_TYPE_JIRA_ISSUES has `plan` attribute' do
jira_issues_section = integration.sections.find { |s| s[:type] == described_class::SECTION_TYPE_JIRA_ISSUES }
expect(jira_issues_section[:plan]).to eq('premium')
end
end
context 'when project_level? is false' do
before do
allow(integration).to receive(:project_level?).and_return(false)
end
it 'does not include SECTION_TYPE_JIRA_ISSUES' do
expect(sections).not_to include(described_class::SECTION_TYPE_JIRA_ISSUES)
end
end
end
describe '#reference_pattern' do
using RSpec::Parameterized::TableSyntax
where(:key, :result) do
'#123' | ''
'1#23#12' | ''
'JIRA-1234A' | 'JIRA-1234'
'JIRA-1234-some_tag' | 'JIRA-1234'
'JIRA-1234_some_tag' | 'JIRA-1234'
'EXT_EXT-1234' | 'EXT_EXT-1234'
'EXT3_EXT-1234' | 'EXT3_EXT-1234'
'3EXT_EXT-1234' | ''
'CVE-2022-123' | ''
'CVE-123' | 'CVE-123'
'abc-JIRA-1234' | 'JIRA-1234'
end
with_them do
specify do
expect(jira_integration.reference_pattern.match(key).to_s).to eq(result)
end
end
context 'with match prefix' do
before do
jira_integration.jira_issue_prefix = 'jira#'
end
where(:key, :result, :issue_key) do
'jira##123' | '' | ''
'jira#1#23#12' | '' | ''
'jira#JIRA-1234A' | 'jira#JIRA-1234' | 'JIRA-1234'
'jira#JIRA-1234-some_tag' | 'jira#JIRA-1234' | 'JIRA-1234'
'JIRA-1234A' | '' | ''
'JIRA-1234-some_tag' | '' | ''
'myjira#JIRA-1234-some_tag' | '' | ''
'MYjira#JIRA-1234-some_tag' | '' | ''
'my-jira#JIRA-1234-some_tag' | 'jira#JIRA-1234' | 'JIRA-1234'
end
with_them do
specify do
expect(jira_integration.reference_pattern.match(key).to_s).to eq(result)
expect(jira_integration.reference_pattern.match(key)[:issue]).to eq(issue_key) unless result.empty?
end
end
end
context 'with trailing space in jira_issue_prefix' do
before do
jira_integration.jira_issue_prefix = 'Jira# '
end
it 'leaves the trailing space' do
expect(jira_integration.jira_issue_prefix).to eq('Jira# ')
end
it 'pulls the issue ID without a prefix' do
expect(jira_integration.reference_pattern.match('Jira# FOO-123')[:issue]).to eq('FOO-123')
end
end
context 'with custom issue pattern' do
before do
jira_integration.jira_issue_regex = '[A-Z][0-9]-[0-9]+'
end
where(:key, :result) do
'J1-123' | 'J1-123'
'AAbJ J1-123' | 'J1-123'
'#A1-123' | 'A1-123'
'J1-1234-some_tag' | 'J1-1234'
'J1-1234A' | 'J1-1234'
'J1-1234-some_tag' | 'J1-1234'
'JI1-123' | ''
'J1I-123' | ''
'JI-123' | ''
'#123' | ''
end
with_them do
specify do
expect(jira_integration.reference_pattern.match(key).to_s).to eq(result)
end
end
end
end
describe '.valid_jira_cloud_url?' do
using RSpec::Parameterized::TableSyntax
where(:url, :result) do
'https://abc.atlassian.net' | true
'http://abc.atlassian.net' | false
'abc.atlassian.net' | false # This is how it behaves currently, but we may need to consider adding scheme if missing
'https://somethingelse.com' | false
'javascript://test.atlassian.net/%250dalert(document.domain)' | false
'https://example.com".atlassian.net' | false
nil | false
end
with_them do
specify do
expect(described_class.valid_jira_cloud_url?(url)).to eq(result)
end
end
end
describe '#create' do
let(:params) do
{
project: project,
url: url,
api_url: api_url,
jira_auth_type: jira_auth_type,
username: username, password: password,
jira_issue_regex: jira_issue_regex,
jira_issue_prefix: jira_issue_prefix,
jira_issue_transition_id: transition_id
}
end
subject(:integration) { described_class.create!(params) }
it 'does not store data into properties' do
expect(integration.properties).to be_empty
end
it 'stores data in data_fields correctly' do
expect(integration.jira_tracker_data.url).to eq(url)
expect(integration.jira_tracker_data.api_url).to eq(api_url)
expect(integration.jira_tracker_data.jira_auth_type).to eq(jira_auth_type)
expect(integration.jira_tracker_data.username).to eq(username)
expect(integration.jira_tracker_data.password).to eq(password)
expect(integration.jira_tracker_data.jira_issue_regex).to eq(jira_issue_regex)
expect(integration.jira_tracker_data.jira_issue_prefix).to eq(jira_issue_prefix)
expect(integration.jira_tracker_data.jira_issue_transition_id).to eq(transition_id)
expect(integration.jira_tracker_data.deployment_cloud?).to be_truthy
end
context 'when loading serverInfo' do
context 'with a Cloud instance' do
let(:server_info_results) { { 'deploymentType' => 'Cloud' } }
it 'is detected' do
expect(integration.jira_tracker_data).to be_deployment_cloud
end
end
context 'with a Server instance' do
let(:server_info_results) { { 'deploymentType' => 'Server' } }
it 'is detected' do
expect(integration.jira_tracker_data).to be_deployment_server
end
end
context 'from an Unknown instance' do
let(:server_info_results) { { 'deploymentType' => 'FutureCloud' } }
context 'and URL ends in .atlassian.net' do
let(:api_url) { 'https://example-api.atlassian.net' }
it 'deployment_type is set to cloud' do
expect(integration.jira_tracker_data).to be_deployment_cloud
end
end
context 'and URL is something else' do
let(:api_url) { 'https://my-jira-api.someserver.com' }
it 'deployment_type is set to server' do
expect(integration.jira_tracker_data).to be_deployment_server
end
end
end
context 'and no ServerInfo response is received' do
let(:server_info_results) { {} }
context 'and URL ends in .atlassian.net' do
let(:api_url) { 'https://example-api.atlassian.net' }
it 'deployment_type is set to cloud' do
expect(Gitlab::AppLogger).to receive(:warn).with(message: "Jira API returned no ServerInfo, setting deployment_type from URL", server_info: server_info_results, url: api_url)
expect(integration.jira_tracker_data).to be_deployment_cloud
end
end
context 'and URL is something else' do
let(:api_url) { 'https://my-jira-api.someserver.com' }
it 'deployment_type is set to server' do
expect(Gitlab::AppLogger).to receive(:warn).with(message: "Jira API returned no ServerInfo, setting deployment_type from URL", server_info: server_info_results, url: api_url)
expect(integration.jira_tracker_data).to be_deployment_server
end
end
end
end
end
# we need to make sure we are able to read both from properties and jira_tracker_data table
# TODO: change this as part of https://gitlab.com/gitlab-org/gitlab/issues/29404
context 'overriding properties' do
shared_examples 'handles jira fields' do
context 'reading data' do
it 'reads data correctly' do
expect(integration.url).to eq(url)
expect(integration.api_url).to eq(api_url)
expect(integration.username).to eq(username)
expect(integration.password).to eq(password)
expect(integration.jira_issue_transition_id).to eq(transition_id)
end
end
describe '#update' do
context 'basic update' do
let_it_be(:new_username) { 'new_username' }
let_it_be(:new_url) { 'http://jira-new.example.com' }
before do
integration.update!(username: new_username, url: new_url, password: password)
end
it 'stores updated data in jira_tracker_data table' do
data = integration.jira_tracker_data.reload
expect(data.url).to eq(new_url)
expect(data.api_url).to eq(api_url)
expect(data.username).to eq(new_username)
expect(data.password).to eq(password)
expect(data.jira_issue_transition_id).to eq(transition_id)
end
end
context 'when updating the url, api_url, username, or password' do
context 'when updating the integration' do
it 'updates deployment type' do
integration.update!(url: 'http://first.url', password: password)
integration.jira_tracker_data.update!(deployment_type: 'server')
expect(integration.jira_tracker_data.deployment_server?).to be_truthy
integration.update!(api_url: 'http://another.url', password: password)
integration.jira_tracker_data.reload
expect(integration.jira_tracker_data.deployment_cloud?).to be_truthy
expect(WebMock).to have_requested(:get, /serverInfo/).twice
end
end
context 'when removing the integration' do
let(:server_info_results) { {} }
it 'updates deployment type' do
integration.update!(url: nil, api_url: nil, active: false)
integration.jira_tracker_data.reload
expect(integration.jira_tracker_data.deployment_unknown?).to be_truthy
end
end
it 'calls serverInfo for url' do
integration.update!(url: 'http://first.url', password: password)
expect(WebMock).to have_requested(:get, /serverInfo/)
end
it 'calls serverInfo for api_url' do
integration.update!(api_url: 'http://another.url', password: password)
expect(WebMock).to have_requested(:get, /serverInfo/)
end
it 'calls serverInfo for username' do
integration.update!(username: 'test-user')
expect(WebMock).to have_requested(:get, /serverInfo/)
end
it 'calls serverInfo for password' do
integration.update!(password: 'test-password')
expect(WebMock).to have_requested(:get, /serverInfo/)
end
end
context 'when not updating the url, api_url, username, or password' do
it 'does not update deployment type' do
expect { integration.update!(jira_issue_transition_id: 'jira_issue_transition_id') }
.to raise_error(ActiveRecord::RecordInvalid)
expect(WebMock).not_to have_requested(:get, /serverInfo/)
end
end
end
end
# this will be removed as part of https://gitlab.com/gitlab-org/gitlab/issues/29404
context 'with properties' do
let(:data_params) do
{
url: url, api_url: api_url,
username: username, password: password,
jira_issue_transition_id: transition_id
}
end
context 'when data are stored in properties' do
let(:integration) do
create(:jira_integration, :without_properties_callback, project: project, properties: data_params.merge(additional: 'something'))
end
it_behaves_like 'handles jira fields'
end
context 'when data are stored in separated fields' do
let(:integration) do
create(:jira_integration, data_params.merge(properties: {}, project: project))
end
it_behaves_like 'handles jira fields'
end
context 'when data are stored in both properties and separated fields' do
let(:integration) do
create(:jira_integration, :without_properties_callback, properties: data_params, project: project).tap do |integration|
create(:jira_tracker_data, data_params.merge(integration: integration))
end
end
it_behaves_like 'handles jira fields'
end
end
end
describe '#client' do
before do
stub_request(:get, 'http://jira.example.com/foo')
end
it 'uses the default GitLab::HTTP timeouts' do
timeouts = Gitlab::HTTP::DEFAULT_TIMEOUT_OPTIONS
expect(Gitlab::HTTP).to receive(:httparty_perform_request)
.with(Net::HTTP::Get, '/foo', hash_including(timeouts)).and_call_original
jira_integration.client.get('/foo')
end
context 'with basic auth' do
before do
jira_integration.jira_auth_type = 0
end
it 'uses correct authorization options' do
expect_next_instance_of(JIRA::Client) do |instance|
expect(instance.request_client.options).to include(
additional_cookies: ['OBBasicAuth=fromDialog'],
auth_type: :basic,
use_cookies: true,
password: jira_integration.password,
username: jira_integration.username
)
end
jira_integration.client.get('/foo')
end
end
context 'with personal access token auth' do
before do
jira_integration.jira_auth_type = 1
end
it 'uses correct authorization options' do
expect_next_instance_of(JIRA::Client) do |instance|
expect(instance.request_client.options).to include(
default_headers: { "Authorization" => "Bearer #{password}" }
)
end
jira_integration.client.get('/foo')
end
end
end
describe '#find_issue' do
let(:issue_key) { 'JIRA-123' }
let(:issue_url) { "#{url}/rest/api/2/issue/#{issue_key}" }
before do
stub_request(:get, issue_url).with(basic_auth: [username, password])
end
it 'calls the Jira API to get the issue' do
jira_integration.find_issue(issue_key)
expect(WebMock).to have_requested(:get, issue_url)
end
context 'with options' do
let(:issue_url) { "#{url}/rest/api/2/issue/#{issue_key}?expand=renderedFields,transitions" }
it 'calls the Jira API with the options to get the issue' do
jira_integration.find_issue(issue_key, rendered_fields: true, transitions: true)
expect(WebMock).to have_requested(:get, issue_url)
end
end
context 'with restricted restrict_project_key option' do
subject(:find_issue) { jira_integration.find_issue(issue_key, restrict_project_key: true) }
it { is_expected.to eq(nil) }
context 'and project_key matches' do
let(:project_key) { 'JIRA' }
it 'calls the Jira API to get the issue' do
find_issue
expect(WebMock).to have_requested(:get, issue_url)
end
end
end
end
describe '#close_issue' do
let(:custom_base_url) { 'http://custom_url' }
shared_examples 'close_issue' do
let(:issue_key) { 'JIRA-123' }
let(:issue_url) { "#{url}/rest/api/2/issue/#{issue_key}" }
let(:transitions_url) { "#{issue_url}/transitions" }
let(:comment_url) { "#{issue_url}/comment" }
let(:remote_link_url) { "#{issue_url}/remotelink" }
let(:transitions) { nil }
let(:issue_fields) do
{
id: issue_key,
self: issue_url,
transitions: transitions
}
end
subject(:close_issue) do
jira_integration.close_issue(resource, ExternalIssue.new(issue_key, project))
end
before do
jira_integration.jira_issue_transition_id = '999'
# These stubs are needed to test Integrations::Jira#close_issue.
# We close the issue then do another request to API to check if it got closed.
# Here is stubbed the API return with a closed and an opened issues.
open_issue = JIRA::Resource::Issue.new(jira_integration.client, attrs: issue_fields.deep_stringify_keys)
closed_issue = open_issue.dup
allow(open_issue).to receive(:resolution).and_return(false)
allow(closed_issue).to receive(:resolution).and_return(true)
allow(JIRA::Resource::Issue).to receive(:find).and_return(open_issue, closed_issue)
allow_any_instance_of(JIRA::Resource::Issue).to receive(:key).and_return(issue_key)
allow(JIRA::Resource::Remotelink).to receive(:all).and_return([])
WebMock.stub_request(:get, issue_url).with(basic_auth: %w(jira-username jira-password))
WebMock.stub_request(:post, transitions_url).with(basic_auth: %w(jira-username jira-password))
WebMock.stub_request(:post, comment_url).with(basic_auth: %w(jira-username jira-password))
WebMock.stub_request(:post, remote_link_url).with(basic_auth: %w(jira-username jira-password))
end
let(:external_issue) { ExternalIssue.new('JIRA-123', project) }
def close_issue
jira_integration.close_issue(resource, external_issue, current_user)
end
it 'calls Jira API' do
close_issue
expect(WebMock).to have_requested(:post, comment_url).with(
body: /Issue solved with/
).once
end
it 'tracks usage' do
expect(Gitlab::UsageDataCounters::HLLRedisCounter)
.to receive(:track_event)
.with('i_ecosystem_jira_service_close_issue', values: current_user.id)
close_issue
end
it_behaves_like 'Snowplow event tracking with RedisHLL context' do
subject { close_issue }
let(:category) { 'Integrations::Jira' }
let(:action) { 'perform_integrations_action' }
let(:namespace) { project.namespace }
let(:user) { current_user }
let(:label) { 'redis_hll_counters.ecosystem.ecosystem_total_unique_counts_monthly' }
let(:property) { 'i_ecosystem_jira_service_close_issue' }
end
it 'does not fail if remote_link.all on issue returns nil' do
allow(JIRA::Resource::Remotelink).to receive(:all).and_return(nil)
expect { close_issue }.not_to raise_error
end
# Check https://developer.atlassian.com/jiradev/jira-platform/guides/other/guide-jira-remote-issue-links/fields-in-remote-issue-links
# for more information
it 'creates Remote Link reference in Jira for comment' do
close_issue
favicon_path = "http://localhost/assets/#{find_asset('favicon.png').digest_path}"
# Creates comment
expect(WebMock).to have_requested(:post, comment_url)
# Creates Remote Link in Jira issue fields
expect(WebMock).to have_requested(:post, remote_link_url).with(
body: hash_including(
GlobalID: 'GitLab',
relationship: 'mentioned on',
object: {
url: "#{Gitlab.config.gitlab.url}/#{project.full_path}/-/commit/#{commit_id}",
title: "Solved by commit #{commit_id}.",
icon: { title: 'GitLab', url16x16: favicon_path },
status: { resolved: true }
}
)
).once
end
context 'when "comment_on_event_enabled" is set to false' do
it 'creates Remote Link reference but does not create comment' do
allow(jira_integration).to receive_messages(comment_on_event_enabled: false)
close_issue
expect(WebMock).not_to have_requested(:post, comment_url)
expect(WebMock).to have_requested(:post, remote_link_url)
end
end
context 'when Remote Link already exists' do
let(:remote_link) do
double(
'remote link',
object: {
url: "#{Gitlab.config.gitlab.url}/#{project.full_path}/-/commit/#{commit_id}"
}.with_indifferent_access
)
end
it 'does not create comment' do
allow(JIRA::Resource::Remotelink).to receive(:all).and_return([remote_link])
expect(remote_link).to receive(:save!)
close_issue
expect(WebMock).not_to have_requested(:post, comment_url)
end
end
it 'does not send comment or remote links to issues already closed' do
allow_any_instance_of(JIRA::Resource::Issue).to receive(:resolution).and_return(true)
close_issue
expect(WebMock).not_to have_requested(:post, comment_url)
expect(WebMock).not_to have_requested(:post, remote_link_url)
end
it 'does not send comment or remote links to issues with unknown resolution' do
allow_any_instance_of(JIRA::Resource::Issue).to receive(:respond_to?).with(:resolution).and_return(false)
close_issue
expect(WebMock).not_to have_requested(:post, comment_url)
expect(WebMock).not_to have_requested(:post, remote_link_url)
end
it 'references the GitLab commit' do
stub_config_setting(base_url: custom_base_url)
close_issue
expect(WebMock).to have_requested(:post, comment_url).with(
body: %r{#{custom_base_url}/#{project.full_path}/-/commit/#{commit_id}}
).once
end
it 'references the GitLab commit' do
stub_config_setting(relative_url_root: '/gitlab')
stub_config_setting(url: Settings.send(:build_gitlab_url))
allow(described_class).to receive(:default_url_options) do
{ script_name: '/gitlab' }
end
close_issue
expect(WebMock).to have_requested(:post, comment_url).with(
body: %r{#{Gitlab.config.gitlab.url}/#{project.full_path}/-/commit/#{commit_id}}
).once
end
it 'logs exception when transition id is not valid' do
allow(jira_integration).to receive(:log_exception)
WebMock.stub_request(:post, transitions_url).with(basic_auth: %w(jira-username jira-password)).and_raise("Bad Request")
close_issue
expect(jira_integration).to have_received(:log_exception).with(
kind_of(StandardError),
message: 'Issue transition failed',
client_url: "http://jira.example.com"
)
end
it 'calls the api with jira_issue_transition_id' do
close_issue
expect(WebMock).to have_requested(:post, transitions_url).with(
body: /"id":"999"/
).once
end
context 'when custom transition IDs are blank' do
before do
jira_integration.jira_issue_transition_id = ''
end
it 'does not transition the issue' do
close_issue
expect(WebMock).not_to have_requested(:post, transitions_url)
end
end
context 'when using automatic issue transitions' do
let(:transitions) do
[
{ id: '1' },
{ id: '2', to: { statusCategory: { key: 'new' } } },
{ id: '3', to: { statusCategory: { key: 'done' } } },
{ id: '4', to: { statusCategory: { key: 'done' } } }
]
end
before do
jira_integration.jira_issue_transition_automatic = true
close_issue
end
it 'uses the next transition with a status category of done' do
expect(WebMock).to have_requested(:post, transitions_url).with(
body: /"id":"3"/
).once
end
context 'when no done transition is available' do
let(:transitions) do
[
{ id: '1', to: { statusCategory: { key: 'new' } } }
]
end
it 'does not attempt to transition' do
expect(WebMock).not_to have_requested(:post, transitions_url)
end
end
context 'when no valid transitions are returned' do
let(:transitions) { 'foo' }
it 'does not attempt to transition' do
expect(WebMock).not_to have_requested(:post, transitions_url)
end
end
end
context 'when using multiple transition ids' do
before do
allow(jira_integration).to receive_messages(jira_issue_transition_id: '1,2,3')
end
it 'calls the api with transition ids separated by comma' do
close_issue
1.upto(3) do |transition_id|
expect(WebMock).to have_requested(:post, transitions_url).with(
body: /"id":"#{transition_id}"/
).once
end
expect(WebMock).to have_requested(:post, comment_url)
end
it 'calls the api with transition ids separated by semicolon' do
allow(jira_integration).to receive_messages(jira_issue_transition_id: '1;2;3')
close_issue
1.upto(3) do |transition_id|
expect(WebMock).to have_requested(:post, transitions_url).with(
body: /"id":"#{transition_id}"/
).once
end
expect(WebMock).to have_requested(:post, comment_url)
end
context 'when a transition fails' do
before do
WebMock.stub_request(:post, transitions_url).with(basic_auth: %w(jira-username jira-password)).to_return do |request|
{ status: request.body.include?('"id":"2"') ? 500 : 200 }
end
end
it 'stops the sequence' do
close_issue
1.upto(2) do |transition_id|
expect(WebMock).to have_requested(:post, transitions_url).with(
body: /"id":"#{transition_id}"/
)
end
expect(WebMock).not_to have_requested(:post, transitions_url).with(
body: /"id":"3"/
)
expect(WebMock).not_to have_requested(:post, comment_url)
end
end
end
end
context 'when resource is a merge request' do
let_it_be(:resource) { create(:merge_request, source_project: project) }
let(:commit_id) { resource.diff_head_sha }
it_behaves_like 'close_issue'
end
context 'when resource is a commit' do
let(:resource) { project.commit('master') }
let(:commit_id) { resource.id }
it_behaves_like 'close_issue'
end
end
describe '#create_cross_reference_note' do
let_it_be(:user) { build_stubbed(:user) }
let(:jira_issue) { ExternalIssue.new('JIRA-123', project) }
let(:success_message) { 'SUCCESS: Successfully posted to http://jira.example.com.' }
let(:favicon_path) { "http://localhost/assets/#{find_asset('favicon.png').digest_path}" }
subject { jira_integration.create_cross_reference_note(jira_issue, resource, user) }
shared_examples 'handles cross-references' do
let(:resource_name) { jira_integration.send(:mentionable_name, resource) }
let(:resource_url) { jira_integration.send(:build_entity_url, resource_name, resource.to_param) }
let(:issue_url) { "#{url}/rest/api/2/issue/JIRA-123" }
let(:comment_url) { "#{issue_url}/comment" }
let(:remote_link_url) { "#{issue_url}/remotelink" }
before do
allow(JIRA::Resource::Remotelink).to receive(:all).and_return([])
stub_request(:get, issue_url).with(basic_auth: [username, password])
stub_request(:post, comment_url).with(basic_auth: [username, password])
stub_request(:post, remote_link_url).with(basic_auth: [username, password])
end
context 'when enabled' do
before do
allow(jira_integration).to receive(:can_cross_reference?) { true }
end
it 'creates a comment and remote link' do
expect(subject).to eq(success_message)
expect(WebMock).to have_requested(:post, comment_url).with(body: comment_body).once
expect(WebMock).to have_requested(:post, remote_link_url).with(
body: hash_including(
GlobalID: 'GitLab',
relationship: 'mentioned on',
object: {
url: resource_url,
title: "#{resource.model_name.human} - #{resource.title}",
icon: { title: 'GitLab', url16x16: favicon_path },
status: { resolved: false }
}
)
).once
end
context 'when comment already exists' do
before do
allow(jira_integration).to receive(:comment_exists?) { true }
end
it 'does not create a comment or remote link' do
expect(subject).to be_nil
expect(WebMock).not_to have_requested(:post, comment_url)
expect(WebMock).not_to have_requested(:post, remote_link_url)
end
end
context 'when remote link already exists' do
let(:link) { double(object: { 'url' => resource_url }) }
before do
allow(jira_integration).to receive(:find_remote_link).and_return(link)
end
it 'updates the remote link but does not create a comment' do
expect(link).to receive(:save!)
expect(subject).to eq(success_message)
expect(WebMock).not_to have_requested(:post, comment_url)
end
end
end
context 'when disabled' do
before do
allow(jira_integration).to receive(:can_cross_reference?) { false }
end
it 'does not create a comment or remote link' do
expect(subject).to eq("Events for #{resource_name.pluralize.humanize(capitalize: false)} are disabled.")
expect(WebMock).not_to have_requested(:post, comment_url)
expect(WebMock).not_to have_requested(:post, remote_link_url)
end
end
it 'tracks usage' do
expect(Gitlab::UsageDataCounters::HLLRedisCounter)
.to receive(:track_event)
.with('i_ecosystem_jira_service_cross_reference', values: user.id)
subject
end
it_behaves_like 'Snowplow event tracking with RedisHLL context' do
let(:category) { 'Integrations::Jira' }
let(:action) { 'perform_integrations_action' }
let(:namespace) { project.namespace }
let(:user) { current_user }
let(:label) { 'redis_hll_counters.ecosystem.ecosystem_total_unique_counts_monthly' }
let(:property) { 'i_ecosystem_jira_service_cross_reference' }
end
end
context 'for commits' do
it_behaves_like 'handles cross-references' do
let(:resource) { project.commit('master') }
let(:comment_body) { /mentioned this issue in \[a commit\|.* on branch \[master\|/ }
end
end
context 'for issues' do
it_behaves_like 'handles cross-references' do
let(:resource) { build_stubbed(:issue, project: project) }
let(:comment_body) { /mentioned this issue in \[a issue\|/ }
end
end
context 'for merge requests' do
it_behaves_like 'handles cross-references' do
let(:resource) { build_stubbed(:merge_request, source_project: project) }
let(:comment_body) { /mentioned this issue in \[a merge request\|.* on branch \[master\|/ }
end
end
context 'for notes' do
it_behaves_like 'handles cross-references' do
let(:resource) { build_stubbed(:note, project: project) }
let(:comment_body) { /mentioned this issue in \[a note\|/ }
end
end
context 'for snippets' do
it_behaves_like 'handles cross-references' do
let(:resource) { build_stubbed(:snippet, project: project) }
let(:comment_body) { /mentioned this issue in \[a snippet\|/ }
end
end
end
describe '#test' do
let(:server_info_results) { { 'url' => 'http://url', 'deploymentType' => 'Cloud' } }
def server_info
jira_integration.test(nil)
end
context 'when the test succeeds' do
it 'gets Jira project with URL when API URL not set' do
expect(server_info).to eq(success: true, result: server_info_results)
expect(WebMock).to have_requested(:get, /jira.example.com/)
end
it 'gets Jira project with API URL if set' do
jira_integration.update!(api_url: 'http://jira.api.com')
expect(server_info).to eq(success: true, result: server_info_results)
expect(WebMock).to have_requested(:get, /jira.api.com/)
end
end
context 'when the test fails' do
it 'returns result with the error' do
test_url = 'http://jira.example.com/rest/api/2/serverInfo'
error_message = 'Some specific failure.'
WebMock.stub_request(:get, test_url).with(basic_auth: [username, password])
.to_raise(JIRA::HTTPError.new(double(message: error_message)))
expect(jira_integration).to receive(:log_exception).with(
kind_of(JIRA::HTTPError),
message: 'Error sending message',
client_url: 'http://jira.example.com'
)
expect(jira_integration.test(nil)).to eq(success: false, result: error_message)
end
end
end
describe 'project and issue urls' do
context 'when gitlab.yml was initialized' do
it 'is prepopulated with the settings' do
settings = {
'jira' => {
'url' => 'http://jira.sample/projects/project_a',
'api_url' => 'http://jira.sample/api'
}
}
allow(Gitlab.config).to receive(:issues_tracker).and_return(settings)
integration = project.create_jira_integration(active: true)
expect(integration.url).to eq('http://jira.sample/projects/project_a')
expect(integration.api_url).to eq('http://jira.sample/api')
end
end
it 'removes trailing slashes from url' do
integration = described_class.new(url: 'http://jira.test.com/path/', project: project)
expect(integration.url).to eq('http://jira.test.com/path')
end
end
describe 'favicon urls' do
it 'includes the standard favicon' do
props = described_class.new.send(:build_remote_link_props, url: 'http://example.com', title: 'title')
expect(props[:object][:icon][:url16x16]).to match %r{^http://localhost/assets/favicon(?:-\h+).png$}
end
it 'includes returns the custom favicon' do
create :appearance, favicon: fixture_file_upload('spec/fixtures/dk.png')
props = described_class.new.send(:build_remote_link_props, url: 'http://example.com', title: 'title')
expect(props[:object][:icon][:url16x16]).to match %r{^http://localhost/uploads/-/system/appearance/favicon/\d+/dk.png$}
end
end
context 'generating external URLs' do
let(:integration) { described_class.new(url: 'http://jira.test.com/path/', project: project) }
describe '#web_url' do
it 'handles paths, slashes, and query string' do
expect(integration.web_url).to eq(integration.url)
expect(integration.web_url('subpath/')).to eq('http://jira.test.com/path/subpath')
expect(integration.web_url('/subpath/')).to eq('http://jira.test.com/path/subpath')
expect(integration.web_url('subpath', foo: :bar)).to eq('http://jira.test.com/path/subpath?foo=bar')
end
it 'preserves existing query string' do
integration.url = 'http://jira.test.com/path/?nosso&foo=bar%20bar'
expect(integration.web_url).to eq("http://jira.test.com/path?foo=bar%20bar&nosso")
expect(integration.web_url('subpath/')).to eq('http://jira.test.com/path/subpath?foo=bar%20bar&nosso')
expect(integration.web_url('/subpath/')).to eq('http://jira.test.com/path/subpath?foo=bar%20bar&nosso')
expect(integration.web_url('subpath', bar: 'baz baz')).to eq('http://jira.test.com/path/subpath?bar=baz%20baz&foo=bar%20bar&nosso')
end
it 'returns an empty string if URL is not set' do
integration.url = nil
expect(integration.web_url).to eq('')
end
it 'includes Atlassian referrer for SaaS', :saas do
expect(integration.web_url).to eq("http://jira.test.com/path?#{described_class::ATLASSIAN_REFERRER_GITLAB_COM.to_query}")
allow(Gitlab).to receive(:staging?).and_return(true)
expect(integration.web_url).to eq(integration.url)
end
it 'includes Atlassian referrer for self-managed' do
allow(Gitlab).to receive(:dev_or_test_env?).and_return(false)
expect(integration.web_url).to eq("http://jira.test.com/path?#{described_class::ATLASSIAN_REFERRER_SELF_MANAGED.to_query}")
end
end
describe '#project_url' do
it 'returns the correct URL' do
expect(integration.project_url).to eq('http://jira.test.com/path')
end
it 'returns an empty string if URL is not set' do
integration.url = nil
expect(integration.project_url).to eq('')
end
end
describe '#issues_url' do
it 'returns the correct URL' do
expect(integration.issues_url).to eq('http://jira.test.com/path/browse/:id')
end
it 'returns an empty string if URL is not set' do
integration.url = nil
expect(integration.issues_url).to eq('')
end
end
describe '#new_issue_url' do
it 'returns the correct URL' do
expect(integration.new_issue_url).to eq('http://jira.test.com/path/secure/CreateIssue!default.jspa')
end
it 'returns an empty string if URL is not set' do
integration.url = nil
expect(integration.new_issue_url).to eq('')
end
end
end
describe '#issue_transition_enabled?' do
it 'returns true if automatic transitions are enabled' do
jira_integration.jira_issue_transition_automatic = true
expect(jira_integration.issue_transition_enabled?).to be(true)
end
it 'returns true if custom transitions are set' do
jira_integration.jira_issue_transition_id = '1, 2, 3'
expect(jira_integration.issue_transition_enabled?).to be(true)
end
it 'returns false if automatic and custom transitions are disabled' do
expect(jira_integration.issue_transition_enabled?).to be(false)
end
end
describe 'valid_connection? and configured?' do
before do
allow(jira_integration).to receive(:test).with(nil).and_return(test_result)
end
context 'when the test fails' do
let(:test_result) { { success: false } }
it 'is falsey' do
expect(jira_integration).not_to be_valid_connection
end
it 'implies that configured? is also falsey' do
expect(jira_integration).not_to be_configured
end
end
context 'when the test succeeds' do
let(:test_result) { { success: true } }
it 'is truthy' do
expect(jira_integration).to be_valid_connection
end
context 'when the integration is active' do
before do
jira_integration.active = true
end
it 'implies that configured? is also truthy' do
expect(jira_integration).to be_configured
end
end
context 'when the integration is inactive' do
before do
jira_integration.active = false
end
it 'implies that configured? is falsey' do
expect(jira_integration).not_to be_configured
end
end
end
end
end
|