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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe ::Gitlab::Ci::Config::Entry::Needs, feature_category: :pipeline_composition do
subject(:needs) { described_class.new(config) }
before do
needs.metadata[:allowed_needs] = %i[job cross_dependency]
end
describe 'validations' do
before do
needs.compose!
end
context 'when entry config value is correct' do
let(:config) { ['job_name'] }
describe '#valid?' do
it { is_expected.to be_valid }
end
end
context 'when config value has wrong type' do
let(:config) { 123 }
describe '#valid?' do
it { is_expected.not_to be_valid }
end
describe '#errors' do
it 'returns error about incorrect type' do
expect(needs.errors)
.to include('needs config can only be a hash or an array')
end
end
end
context 'when wrong needs type is used' do
let(:config) { [123] }
describe '#valid?' do
it { is_expected.not_to be_valid }
end
describe '#errors' do
it 'returns error about incorrect type' do
expect(needs.errors).to contain_exactly(
'need has an unsupported type')
end
end
end
context 'when wrong needs type is used' do
let(:config) { [{ job: 'job_name', artifacts: true, some: :key }] }
describe '#valid?' do
it { is_expected.not_to be_valid }
end
describe '#errors' do
it 'returns error about incorrect type' do
expect(needs.errors).to contain_exactly(
'need config contains unknown keys: some')
end
end
end
context 'when needs value is a hash' do
context 'with a job value' do
let(:config) do
{ job: 'job_name' }
end
describe '#valid?' do
it { is_expected.to be_valid }
end
end
context 'with a parallel value that is a numeric value' do
let(:config) do
{ job: 'job_name', parallel: 2 }
end
describe '#valid?' do
it { is_expected.not_to be_valid }
end
describe '#errors' do
it 'returns errors about number values being invalid for needs:parallel' do
expect(needs.errors).to match_array(["needs config cannot use \"parallel: <number>\"."])
end
end
end
end
context 'when needs:parallel value is incorrect' do
context 'with a keyword that is not "matrix"' do
let(:config) do
[
{ job: 'job_name', parallel: { not_matrix: [{ one: 'aaa', two: 'bbb' }] } }
]
end
describe '#valid?' do
it { is_expected.not_to be_valid }
end
describe '#errors' do
it 'returns errors about incorrect matrix keyword' do
expect(needs.errors).to match_array([
'need:parallel config contains unknown keys: not_matrix',
'need:parallel config missing required keys: matrix'
])
end
end
end
context 'with a number value' do
let(:config) { [{ job: 'job_name', parallel: 2 }] }
describe '#valid?' do
it { is_expected.not_to be_valid }
end
describe '#errors' do
it 'returns errors about number values being invalid for needs:parallel' do
expect(needs.errors).to match_array(["needs config cannot use \"parallel: <number>\"."])
end
end
end
end
context 'when needs:parallel:matrix value is empty' do
let(:config) { [{ job: 'job_name', parallel: { matrix: {} } }] }
describe '#valid?' do
it { is_expected.not_to be_valid }
end
describe '#errors' do
it 'returns error about incorrect type' do
expect(needs.errors).to contain_exactly(
'need:parallel:matrix config should be an array of hashes')
end
end
end
context 'when needs:parallel:matrix value is incorrect' do
let(:config) { [{ job: 'job_name', parallel: { matrix: 'aaa' } }] }
describe '#valid?' do
it { is_expected.not_to be_valid }
end
describe '#errors' do
it 'returns error about incorrect type' do
expect(needs.errors).to contain_exactly(
'need:parallel:matrix config should be an array of hashes')
end
end
end
context 'when needs:parallel:matrix value is correct' do
context 'with a simple config' do
let(:config) do
[
{ job: 'job_name', parallel: { matrix: [{ A: 'a1', B: 'b1' }] } }
]
end
describe '#valid?' do
it { is_expected.to be_valid }
end
end
context 'with a complex config' do
let(:config) do
[
{
job: 'job_name1',
artifacts: true,
parallel: { matrix: [{ A: %w[a1 a2], B: %w[b1 b2 b3], C: %w[c1 c2] }] }
},
{
job: 'job_name2',
parallel: {
matrix: [
{ A: %w[a1 a2], D: %w[d1 d2] },
{ E: %w[e1 e2], F: ['f1'] },
{ C: %w[c1 c2 c3], G: %w[g1 g2], H: ['h1'] }
]
}
}
]
end
describe '#valid?' do
it { is_expected.to be_valid }
end
end
end
context 'with too many cross pipeline dependencies' do
let(:limit) { described_class::NEEDS_CROSS_PIPELINE_DEPENDENCIES_LIMIT }
let(:config) do
Array.new(limit.next) do |index|
{ pipeline: "$UPSTREAM_PIPELINE_#{index}", job: 'job-1' }
end
end
describe '#valid?' do
it { is_expected.not_to be_valid }
end
describe '#errors' do
it 'returns error about incorrect type' do
expect(needs.errors).to contain_exactly(
"needs config must be less than or equal to #{limit}")
end
end
end
end
describe '.compose!' do
shared_examples 'entry with descendant nodes' do
describe '#descendants' do
it 'creates valid descendant nodes' do
expect(needs.descendants.count).to eq 2
expect(needs.descendants)
.to all(be_an_instance_of(::Gitlab::Ci::Config::Entry::Need))
end
end
end
context 'when valid job entries composed' do
let(:config) { %w[first_job_name second_job_name] }
before do
needs.compose!
end
describe '#value' do
it 'returns key value' do
expect(needs.value).to eq(
job: [
{ name: 'first_job_name', artifacts: true, optional: false },
{ name: 'second_job_name', artifacts: true, optional: false }
]
)
end
end
it_behaves_like 'entry with descendant nodes'
end
context 'with complex job entries composed' do
let(:config) do
[
{ job: 'first_job_name', artifacts: true, optional: false },
{ job: 'second_job_name', artifacts: false, optional: false }
]
end
before do
needs.compose!
end
describe '#value' do
it 'returns key value' do
expect(needs.value).to eq(
job: [
{ name: 'first_job_name', artifacts: true, optional: false },
{ name: 'second_job_name', artifacts: false, optional: false }
]
)
end
end
it_behaves_like 'entry with descendant nodes'
end
context 'with mixed job entries composed' do
let(:config) do
[
'first_job_name',
{ job: 'second_job_name', artifacts: false }
]
end
before do
needs.compose!
end
describe '#value' do
it 'returns key value' do
expect(needs.value).to eq(
job: [
{ name: 'first_job_name', artifacts: true, optional: false },
{ name: 'second_job_name', artifacts: false, optional: false }
]
)
end
end
it_behaves_like 'entry with descendant nodes'
end
context 'with empty config' do
let(:config) do
[]
end
before do
needs.compose!
end
describe '#value' do
it 'returns empty value' do
expect(needs.value).to eq({})
end
end
end
end
end
|
