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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Ci::CreateCommitStatusService, :clean_gitlab_redis_cache, feature_category: :continuous_integration do
using RSpec::Parameterized::TableSyntax
subject(:response) { execute_service(params) }
let_it_be_with_refind(:project) { create(:project, :repository) }
let_it_be(:commit) { project.repository.commit }
let_it_be(:guest) { create_user(:guest) }
let_it_be(:reporter) { create_user(:reporter) }
let_it_be(:developer) { create_user(:developer) }
let(:user) { developer }
let(:sha) { commit.id }
let(:params) { { state: 'pending' } }
let(:job) { response.payload[:job] }
%w[pending running success failed canceled].each do |status|
context "for #{status}" do
let(:params) { { state: status } }
context 'when pipeline for sha does not exists' do
it 'creates commit status and sets pipeline iid' do
expect(response).to be_success
expect(job.sha).to eq(commit.id)
expect(job.status).to eq(status)
expect(job.name).to eq('default')
expect(job.ref).not_to be_empty
expect(job.target_url).to be_nil
expect(job.description).to be_nil
expect(job.pipeline_id).not_to be_nil
expect(CommitStatus.find(job.id)).to be_api_failure if status == 'failed'
expect(::Ci::Pipeline.last.iid).not_to be_nil
end
end
end
end
context 'when status transitions from pending' do
before do
execute_service(state: 'pending')
end
%w[running success failed canceled].each do |status|
context "for #{status}" do
let(:params) { { state: status } }
it "changes to #{status}" do
expect { response }
.to not_change { ::Ci::Pipeline.count }.from(1)
.and not_change { ::Ci::Stage.count }.from(1)
.and not_change { ::CommitStatus.count }.from(1)
expect(response).to be_success
expect(job.status).to eq(status)
end
end
end
context 'for invalid transition' do
let(:params) { { state: 'pending' } }
it 'returns bad request and error message' do
expect { response }
.to not_change { ::Ci::Pipeline.count }.from(1)
.and not_change { ::Ci::Stage.count }.from(1)
.and not_change { ::CommitStatus.count }.from(1)
expect(response).to be_error
expect(response.http_status).to eq(:bad_request)
expect(response.message).to eq(
"Cannot transition status via :enqueue from :pending (Reason(s): Status cannot transition via \"enqueue\")"
)
end
end
end
context 'with all optional parameters' do
context 'when creating a commit status' do
let(:params) do
{
sha: sha,
state: 'success',
context: 'coverage',
ref: 'master',
description: 'test',
coverage: 80.0,
target_url: 'http://gitlab.com/status'
}
end
it 'creates commit status' do
expect { response }
.to change { ::Ci::Pipeline.count }.by(1)
.and change { ::Ci::Stage.count }.by(1)
.and change { ::CommitStatus.count }.by(1)
expect(response).to be_success
expect(job.sha).to eq(commit.id)
expect(job.status).to eq('success')
expect(job.name).to eq('coverage')
expect(job.ref).to eq('master')
expect(job.coverage).to eq(80.0)
expect(job.description).to eq('test')
expect(job.target_url).to eq('http://gitlab.com/status')
end
context 'when merge request exists for given branch' do
let!(:merge_request) do
create(:merge_request, source_project: project, source_branch: 'master', target_branch: 'develop')
end
it 'sets head pipeline' do
expect { response }
.to change { ::Ci::Pipeline.count }.by(1)
.and change { ::Ci::Stage.count }.by(1)
.and change { ::CommitStatus.count }.by(1)
expect(response).to be_success
expect(merge_request.reload.head_pipeline).not_to be_nil
end
end
end
context 'when updating a commit status' do
let(:parameters) do
{
state: 'success',
name: 'coverage',
ref: 'master'
}
end
let(:updatable_optional_attributes) do
{
description: 'new description',
coverage: 90.0
}
end
let(:params) { parameters.merge(updatable_optional_attributes) }
# creating the initial commit status
before do
execute_service(
sha: sha,
state: 'running',
context: 'coverage',
ref: 'master',
description: 'coverage test',
coverage: 10.0,
target_url: 'http://gitlab.com/status'
)
end
it 'updates a commit status' do
expect { response }
.to not_change { ::Ci::Pipeline.count }.from(1)
.and not_change { ::Ci::Stage.count }.from(1)
.and not_change { ::CommitStatus.count }.from(1)
expect(response).to be_success
expect(job.sha).to eq(commit.id)
expect(job.status).to eq('success')
expect(job.name).to eq('coverage')
expect(job.ref).to eq('master')
expect(job.coverage).to eq(90.0)
expect(job.description).to eq('new description')
expect(job.target_url).to eq('http://gitlab.com/status')
end
context 'when the `state` parameter is sent the same' do
let(:parameters) do
{
sha: sha,
state: 'running',
name: 'coverage',
ref: 'master'
}
end
it 'does not update the commit status' do
expect { response }
.to not_change { ::Ci::Pipeline.count }.from(1)
.and not_change { ::Ci::Stage.count }.from(1)
.and not_change { ::CommitStatus.count }.from(1)
expect(response).to be_error
expect(response.http_status).to eq(:bad_request)
expect(response.message).to eq(
"Cannot transition status via :run from :running (Reason(s): Status cannot transition via \"run\")"
)
commit_status = project.commit_statuses.find_by!(name: 'coverage')
expect(commit_status.description).to eq('coverage test')
expect(commit_status.coverage).to eq(10.0)
end
end
end
context 'when a pipeline id is specified' do
let!(:first_pipeline) do
project.ci_pipelines.build(source: :push, sha: commit.id, ref: 'master', status: 'created').tap do |p|
p.ensure_project_iid! # Necessary to avoid cross-database modification error
p.save!
end
end
let!(:other_pipeline) do
project.ci_pipelines.build(source: :push, sha: commit.id, ref: 'master', status: 'created').tap do |p|
p.ensure_project_iid! # Necessary to avoid cross-database modification error
p.save!
end
end
let(:params) do
{
sha: sha,
pipeline_id: other_pipeline.id,
state: 'success',
ref: 'master'
}
end
it 'update the correct pipeline', :sidekiq_might_not_need_inline do
expect { response }
.to not_change { ::Ci::Pipeline.count }.from(2)
.and change { ::Ci::Stage.count }.by(1)
.and change { ::CommitStatus.count }.by(1)
expect(first_pipeline.reload.status).to eq('created')
expect(other_pipeline.reload.status).to eq('success')
end
end
end
context 'when retrying a commit status' do
subject(:response) do
execute_service(state: 'failed', name: 'test', ref: 'master')
execute_service(state: 'success', name: 'test', ref: 'master')
end
it 'correctly posts a new commit status' do
expect { response }
.to change { ::Ci::Pipeline.count }.by(1)
.and change { ::Ci::Stage.count }.by(1)
.and change { ::CommitStatus.count }.by(2)
expect(response).to be_success
expect(job.sha).to eq(commit.id)
expect(job.status).to eq('success')
end
it 'retries the commit status', :sidekiq_might_not_need_inline do
response
expect(CommitStatus.count).to eq 2
expect(CommitStatus.first).to be_retried
expect(CommitStatus.last.pipeline).to be_success
end
end
context 'when status is invalid' do
let(:params) { { state: 'invalid' } }
it 'does not create commit status' do
expect { response }
.to change { ::Ci::Pipeline.count }.by(1)
.and change { ::Ci::Stage.count }.by(1)
.and not_change { ::CommitStatus.count }.from(0)
expect(response).to be_error
expect(response.http_status).to eq(:bad_request)
expect(response.message).to eq('invalid state')
end
end
context 'when request without a state made' do
let(:params) { {} }
it 'does not create commit status' do
expect { response }
.to not_change { ::Ci::Pipeline.count }.from(0)
.and not_change { ::Ci::Stage.count }.from(0)
.and not_change { ::CommitStatus.count }.from(0)
expect(response).to be_error
expect(response.http_status).to eq(:bad_request)
expect(response.message).to eq('State is required')
end
end
context 'when updating a protected ref' do
let(:params) { { state: 'running', ref: 'master' } }
before do
create(:protected_branch, project: project, name: 'master')
end
context 'with user as developer' do
let(:user) { developer }
it 'does not create commit status' do
expect { response }
.to change { ::Ci::Pipeline.count }.by(1)
.and not_change { ::Ci::Stage.count }.from(0)
.and not_change { ::CommitStatus.count }.from(0)
expect(response).to be_error
expect(response.http_status).to eq(:forbidden)
expect(response.message).to eq('403 Forbidden')
end
end
context 'with user as maintainer' do
let(:user) { create_user(:maintainer) }
it 'creates commit status' do
expect { response }
.to change { ::Ci::Pipeline.count }.by(1)
.and change { ::Ci::Stage.count }.by(1)
.and change { ::CommitStatus.count }.by(1)
expect(response).to be_success
end
end
end
context 'when commit SHA is invalid' do
let(:sha) { 'invalid_sha' }
let(:params) { { state: 'running', sha: sha } }
it 'returns not found error' do
expect { response }
.to not_change { ::Ci::Pipeline.count }.from(0)
.and not_change { ::Ci::Stage.count }.from(0)
.and not_change { ::CommitStatus.count }.from(0)
expect(response).to be_error
expect(response.http_status).to eq(:not_found)
expect(response.message).to eq('404 Commit Not Found')
end
end
context 'when target URL is an invalid address' do
let(:params) { { state: 'pending', target_url: 'invalid url' } }
it 'responds with bad request status and validation errors' do
expect { response }
.to change { ::Ci::Pipeline.count }.by(1)
.and change { ::Ci::Stage.count }.by(1)
.and not_change { ::CommitStatus.count }.from(0)
expect(response).to be_error
expect(response.http_status).to eq(:bad_request)
expect(response.message[:target_url])
.to include 'is blocked: Only allowed schemes are http, https'
end
end
context 'when target URL is an unsupported scheme' do
let(:params) { { state: 'pending', target_url: 'git://example.com' } }
it 'responds with bad request status and validation errors' do
expect { response }
.to change { ::Ci::Pipeline.count }.by(1)
.and change { ::Ci::Stage.count }.by(1)
.and not_change { ::CommitStatus.count }.from(0)
expect(response).to be_error
expect(response.http_status).to eq(:bad_request)
expect(response.message[:target_url])
.to include 'is blocked: Only allowed schemes are http, https'
end
end
context 'when trying to update a status of a different type' do
let!(:pipeline) { create(:ci_pipeline, project: project, sha: sha, ref: 'ref') }
let!(:ci_build) { create(:ci_build, pipeline: pipeline, name: 'test-job') }
let(:params) { { state: 'pending', name: 'test-job' } }
before do
execute_service(params)
end
it 'responds with bad request status and validation errors' do
expect { response }
.to not_change { ::Ci::Pipeline.count }.from(1)
.and not_change { ::Ci::Stage.count }.from(2)
.and not_change { ::CommitStatus.count }.from(1)
expect(response).to be_error
expect(response.http_status).to eq(:bad_request)
expect(response.message[:name])
.to include 'has already been taken'
end
end
context 'with partitions', :ci_partitionable do
let(:current_partition_id) { ci_testing_partition_id }
let(:params) { { state: 'running' } }
before do
allow(Ci::Pipeline)
.to receive(:current_partition_value) { current_partition_id }
end
it 'creates records in the current partition' do
expect { response }
.to change { ::Ci::Pipeline.count }.by(1)
.and change { ::Ci::Stage.count }.by(1)
.and change { ::CommitStatus.count }.by(1)
expect(response).to be_success
status = CommitStatus.find(job.id)
expect(status.partition_id).to eq(current_partition_id)
expect(status.pipeline.partition_id).to eq(current_partition_id)
end
end
context 'for race condition' do
let(:licenses_snyk_params) { { state: 'running', name: 'licenses', description: 'testing' } }
let(:security_snyk_params) { { state: 'running', name: 'security', description: 'testing' } }
let(:snyk_params_list) { [licenses_snyk_params, security_snyk_params] }
it 'creates one pipeline and two jobs (one for licenses, one for security)' do
expect do
snyk_params_list.map do |snyk_params|
Thread.new do
response = execute_service(snyk_params)
expect(response).to be_success
end
end.each(&:join)
end
.to change { ::Ci::Pipeline.count }.by(1)
.and change { ::Ci::Stage.count }.by(1)
.and change { ::CommitStatus.count }.by(2)
end
end
def create_user(access_level_trait)
user = create(:user)
create(:project_member, access_level_trait, user: user, project: project)
user
end
def execute_service(params = self.params)
described_class
.new(project, user, params)
.execute(optional_commit_status_params: params.slice(*%i[target_url description coverage]))
end
end
|