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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::Ci::Config::External::Mapper do
include StubRequests
let_it_be(:project) { create(:project, :repository) }
let_it_be(:user) { project.owner }
let(:local_file) { '/lib/gitlab/ci/templates/non-existent-file.yml' }
let(:remote_url) { 'https://gitlab.com/gitlab-org/gitlab-foss/blob/1234/.gitlab-ci-1.yml' }
let(:template_file) { 'Auto-DevOps.gitlab-ci.yml' }
let(:variables) { project.predefined_variables }
let(:context_params) { { project: project, sha: '123456', user: user, variables: variables } }
let(:context) { Gitlab::Ci::Config::External::Context.new(**context_params) }
let(:file_content) do
<<~HEREDOC
image: 'image:1.0'
HEREDOC
end
subject(:mapper) { described_class.new(values, context) }
before do
stub_full_request(remote_url).to_return(body: file_content)
allow_next_instance_of(Gitlab::Ci::Config::External::Context) do |instance|
allow(instance).to receive(:check_execution_time!)
end
end
describe '#process' do
subject(:process) { mapper.process }
shared_examples 'logging config file fetch' do |key, count|
it 'propagates the pipeline logger' do
process
fetch_content_log_count = mapper
.logger
.observations_hash
.dig(key, 'count')
expect(fetch_content_log_count).to eq(count)
end
end
context "when single 'include' keyword is defined" do
context 'when the string is a local file' do
let(:values) do
{ include: local_file,
image: 'image:1.0' }
end
it 'returns File instances' do
expect(subject).to contain_exactly(
an_instance_of(Gitlab::Ci::Config::External::File::Local))
end
it_behaves_like 'logging config file fetch', 'config_file_fetch_local_content_duration_s', 1
end
context 'when the key is a local file hash' do
let(:values) do
{ include: { 'local' => local_file },
image: 'image:1.0' }
end
it 'returns File instances' do
expect(subject).to contain_exactly(
an_instance_of(Gitlab::Ci::Config::External::File::Local))
end
end
context 'when the string is a remote file' do
let(:values) do
{ include: remote_url, image: 'image:1.0' }
end
it 'returns File instances' do
expect(subject).to contain_exactly(
an_instance_of(Gitlab::Ci::Config::External::File::Remote))
end
it_behaves_like 'logging config file fetch', 'config_file_fetch_remote_content_duration_s', 1
end
context 'when the key is a remote file hash' do
let(:values) do
{ include: { 'remote' => remote_url },
image: 'image:1.0' }
end
it 'returns File instances' do
expect(subject).to contain_exactly(
an_instance_of(Gitlab::Ci::Config::External::File::Remote))
end
end
context 'when the key is a template file hash' do
let(:values) do
{ include: { 'template' => template_file },
image: 'image:1.0' }
end
it 'returns File instances' do
expect(subject).to contain_exactly(
an_instance_of(Gitlab::Ci::Config::External::File::Template))
end
it_behaves_like 'logging config file fetch', 'config_file_fetch_template_content_duration_s', 1
end
context 'when the key is not valid' do
let(:local_file) { 'secret-file.yml' }
let(:values) do
{ include: { invalid: local_file },
image: 'image:1.0' }
end
it 'returns ambigious specification error' do
expect { subject }.to raise_error(described_class::AmbigiousSpecificationError, '`{"invalid":"secret-file.yml"}` does not have a valid subkey for include. Valid subkeys are: `local`, `project`, `remote`, `template`, `artifact`')
end
end
context 'when the key is a hash of local and remote' do
let(:variables) { Gitlab::Ci::Variables::Collection.new([{ 'key' => 'GITLAB_TOKEN', 'value' => 'secret-file', 'masked' => true }]) }
let(:local_file) { 'secret-file.yml' }
let(:remote_url) { 'https://gitlab.com/secret-file.yml' }
let(:values) do
{ include: { 'local' => local_file, 'remote' => remote_url },
image: 'image:1.0' }
end
it 'returns ambigious specification error' do
expect { subject }.to raise_error(described_class::AmbigiousSpecificationError, 'Each include must use only one of: `local`, `project`, `remote`, `template`, `artifact`')
end
end
context "when the key is a project's file" do
let(:values) do
{ include: { project: project.full_path, file: local_file },
image: 'image:1.0' }
end
it 'returns File instances' do
expect(subject).to contain_exactly(
an_instance_of(Gitlab::Ci::Config::External::File::Project))
end
it_behaves_like 'logging config file fetch', 'config_file_fetch_project_content_duration_s', 1
end
context "when the key is project's files" do
let(:values) do
{ include: { project: project.full_path, file: [local_file, 'another_file_path.yml'] },
image: 'image:1.0' }
end
it 'returns two File instances' do
expect(subject).to contain_exactly(
an_instance_of(Gitlab::Ci::Config::External::File::Project),
an_instance_of(Gitlab::Ci::Config::External::File::Project))
end
it_behaves_like 'logging config file fetch', 'config_file_fetch_project_content_duration_s', 2
end
end
context "when 'include' is defined as an array" do
let(:values) do
{ include: [remote_url, local_file],
image: 'image:1.0' }
end
it 'returns Files instances' do
expect(subject).to all(respond_to(:valid?))
expect(subject).to all(respond_to(:content))
end
end
context "when 'include' is defined as an array of hashes" do
let(:values) do
{ include: [{ remote: remote_url }, { local: local_file }],
image: 'image:1.0' }
end
it 'returns Files instances' do
expect(subject).to all(respond_to(:valid?))
expect(subject).to all(respond_to(:content))
end
context 'when it has ambigious match' do
let(:values) do
{ include: [{ remote: remote_url, local: local_file }],
image: 'image:1.0' }
end
it 'returns ambigious specification error' do
expect { subject }.to raise_error(described_class::AmbigiousSpecificationError)
end
end
end
context "when 'include' is not defined" do
let(:values) do
{
image: 'image:1.0'
}
end
it 'returns an empty array' do
expect(subject).to be_empty
end
end
context "when duplicate 'include's are defined" do
let(:values) do
{ include: [
{ 'local' => local_file },
{ 'local' => local_file }
],
image: 'image:1.0' }
end
it 'does not raise an exception' do
expect { process }.not_to raise_error
end
it 'has expanset with one' do
process
expect(mapper.expandset.size).to eq(1)
end
end
context 'when passing max number of files' do
let(:values) do
{ include: [
{ 'local' => local_file },
{ 'remote' => remote_url }
],
image: 'image:1.0' }
end
it 'does not raise an exception' do
allow(context).to receive(:max_includes).and_return(2)
expect { subject }.not_to raise_error
end
end
context "when too many 'includes' are defined" do
let(:values) do
{ include: [
{ 'local' => local_file },
{ 'remote' => remote_url }
],
image: 'image:1.0' }
end
it 'raises an exception' do
allow(context).to receive(:max_includes).and_return(1)
expect { subject }.to raise_error(described_class::TooManyIncludesError)
end
context 'when including multiple files from a project' do
let(:values) do
{ include: { project: project.full_path, file: [local_file, 'another_file_path.yml'] } }
end
it 'raises an exception' do
allow(context).to receive(:max_includes).and_return(1)
expect { subject }.to raise_error(described_class::TooManyIncludesError)
end
end
end
context "when 'include' section uses project variable" do
let(:full_local_file_path) { '$CI_PROJECT_PATH' + local_file }
context 'when local file is included as a single string' do
let(:values) do
{ include: full_local_file_path }
end
it 'expands the variable', :aggregate_failures do
expect(subject[0].location).to eq(project.full_path + local_file)
expect(subject).to contain_exactly(an_instance_of(Gitlab::Ci::Config::External::File::Local))
end
end
context 'when remote file is included as a single string' do
let(:remote_url) { "#{Gitlab.config.gitlab.url}/radio/.gitlab-ci.yml" }
let(:values) do
{ include: '$CI_SERVER_URL/radio/.gitlab-ci.yml' }
end
it 'expands the variable', :aggregate_failures do
expect(subject[0].location).to eq(remote_url)
expect(subject).to contain_exactly(an_instance_of(Gitlab::Ci::Config::External::File::Remote))
end
end
context 'defined as an array' do
let(:values) do
{ include: [full_local_file_path, remote_url],
image: 'image:1.0' }
end
it 'expands the variable' do
expect(subject[0].location).to eq(project.full_path + local_file)
expect(subject[1].location).to eq(remote_url)
end
end
context 'defined as an array of hashes' do
let(:values) do
{ include: [{ local: full_local_file_path }, { remote: remote_url }],
image: 'image:1.0' }
end
it 'expands the variable' do
expect(subject[0].location).to eq(project.full_path + local_file)
expect(subject[1].location).to eq(remote_url)
end
end
context 'local file hash' do
let(:values) do
{ include: { 'local' => full_local_file_path } }
end
it 'expands the variable' do
expect(subject[0].location).to eq(project.full_path + local_file)
end
end
context 'project name' do
let(:values) do
{ include: { project: '$CI_PROJECT_PATH', file: local_file },
image: 'image:1.0' }
end
it 'expands the variable', :aggregate_failures do
expect(subject[0].project_name).to eq(project.full_path)
expect(subject).to contain_exactly(an_instance_of(Gitlab::Ci::Config::External::File::Project))
end
end
context 'with multiple files' do
let(:values) do
{ include: { project: project.full_path, file: [full_local_file_path, 'another_file_path.yml'] },
image: 'image:1.0' }
end
it 'expands the variable' do
expect(subject[0].location).to eq(project.full_path + local_file)
expect(subject[1].location).to eq('another_file_path.yml')
end
end
context 'when include variable has an unsupported type for variable expansion' do
let(:values) do
{ include: { project: project.id, file: local_file },
image: 'image:1.0' }
end
it 'does not invoke expansion for the variable', :aggregate_failures do
expect(ExpandVariables).not_to receive(:expand).with(project.id, context_params[:variables])
expect { subject }.to raise_error(described_class::AmbigiousSpecificationError)
end
end
end
context 'when local file path has wildcard' do
let(:project) { create(:project, :repository) }
let(:values) do
{ include: 'myfolder/*.yml' }
end
before do
allow_next_instance_of(Repository) do |repository|
allow(repository).to receive(:search_files_by_wildcard_path).with('myfolder/*.yml', '123456') do
['myfolder/file1.yml', 'myfolder/file2.yml']
end
end
end
it 'includes the matched local files' do
expect(subject).to contain_exactly(an_instance_of(Gitlab::Ci::Config::External::File::Local),
an_instance_of(Gitlab::Ci::Config::External::File::Local))
expect(subject.map(&:location)).to contain_exactly('myfolder/file1.yml', 'myfolder/file2.yml')
end
end
context "when 'include' has rules" do
let(:values) do
{ include: [{ remote: remote_url },
{ local: local_file, rules: [{ if: "$CI_PROJECT_ID == '#{project_id}'" }] }],
image: 'image:1.0' }
end
context 'when the rules matches' do
let(:project_id) { project.id }
it 'includes the file' do
expect(subject).to contain_exactly(an_instance_of(Gitlab::Ci::Config::External::File::Remote),
an_instance_of(Gitlab::Ci::Config::External::File::Local))
end
end
context 'when the rules does not match' do
let(:project_id) { non_existing_record_id }
it 'does not include the file' do
expect(subject).to contain_exactly(an_instance_of(Gitlab::Ci::Config::External::File::Remote))
end
end
end
context "when locations are same after masking variables" do
let(:variables) do
Gitlab::Ci::Variables::Collection.new(
[
{ 'key' => 'GITLAB_TOKEN', 'value' => 'secret-file1', 'masked' => true },
{ 'key' => 'GITLAB_TOKEN', 'value' => 'secret-file2', 'masked' => true }
])
end
let(:values) do
{ include: [
{ 'local' => 'hello/secret-file1.yml' },
{ 'local' => 'hello/secret-file2.yml' }
],
image: 'ruby:2.7' }
end
it 'has expanset with two' do
process
expect(mapper.expandset.size).to eq(2)
end
end
end
end
|