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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::Ci::Config::Entry::Cache do
using RSpec::Parameterized::TableSyntax
subject(:entry) { described_class.new(config) }
describe 'validations' do
before do
entry.compose!
end
context 'when entry config value is correct' do
let(:policy) { nil }
let(:key) { 'some key' }
let(:when_config) { nil }
let(:unprotect) { false }
let(:fallback_keys) { [] }
let(:config) do
{
key: key,
untracked: true,
paths: ['some/path/'],
unprotect: unprotect
}.tap do |config|
config[:policy] = policy if policy
config[:when] = when_config if when_config
config[:fallback_keys] = fallback_keys if fallback_keys
end
end
describe '#value' do
shared_examples 'hash key value' do
it 'returns hash value' do
expect(entry.value).to eq(
key: key,
untracked: true,
paths: ['some/path/'],
policy: 'pull-push',
when: 'on_success',
unprotect: false,
fallback_keys: []
)
end
end
it_behaves_like 'hash key value'
context 'with files' do
let(:key) { { files: %w[a-file other-file] } }
it_behaves_like 'hash key value'
end
context 'with files and prefix' do
let(:key) { { files: %w[a-file other-file], prefix: 'prefix-value' } }
it_behaves_like 'hash key value'
end
context 'with prefix' do
let(:key) { { prefix: 'prefix-value' } }
it 'key is nil' do
expect(entry.value).to match(a_hash_including(key: nil))
end
end
context 'with option `unprotect` specified' do
let(:unprotect) { true }
it 'returns true' do
expect(entry.value).to match(a_hash_including(unprotect: true))
end
end
context 'with `policy`' do
where(:policy, :result) do
'pull-push' | 'pull-push'
'push' | 'push'
'pull' | 'pull'
'unknown' | 'unknown' # invalid
end
with_them do
it { expect(entry.value).to include(policy: result) }
end
end
context 'without `policy`' do
it 'assigns policy to default' do
expect(entry.value).to include(policy: 'pull-push')
end
end
context 'with `when`' do
where(:when_config, :result) do
'on_success' | 'on_success'
'on_failure' | 'on_failure'
'always' | 'always'
'unknown' | 'unknown' # invalid
end
with_them do
it { expect(entry.value).to include(when: result) }
end
end
context 'without `when`' do
it 'assigns when to default' do
expect(entry.value).to include(when: 'on_success')
end
end
context 'with `fallback_keys`' do
let(:fallback_keys) { %w[key-1 key-2] }
it 'matches the list of fallback keys' do
expect(entry.value).to match(a_hash_including(fallback_keys: %w[key-1 key-2]))
end
end
context 'without `fallback_keys`' do
it 'assigns an empty list' do
expect(entry.value).to match(a_hash_including(fallback_keys: []))
end
end
end
describe '#valid?' do
it { is_expected.to be_valid }
context 'with files' do
let(:key) { { files: %w[a-file other-file] } }
it { is_expected.to be_valid }
end
end
context 'with `policy`' do
where(:policy, :valid) do
'pull-push' | true
'push' | true
'pull' | true
'unknown' | false
end
with_them do
it 'returns expected validity' do
expect(entry.valid?).to eq(valid)
end
end
end
context 'with `when`' do
where(:when_config, :valid) do
'on_success' | true
'on_failure' | true
'always' | true
'unknown' | false
end
with_them do
it 'returns expected validity' do
expect(entry.valid?).to eq(valid)
end
end
end
context 'with key missing' do
let(:config) do
{ untracked: true,
paths: ['some/path/'] }
end
describe '#value' do
it 'sets key with the default' do
expect(entry.value[:key])
.to eq(Gitlab::Ci::Config::Entry::Key.default)
end
end
end
end
context 'when entry value is not correct' do
describe '#errors' do
subject { entry.errors }
context 'when is not a hash' do
let(:config) { 'ls' }
it 'reports errors with config value' do
is_expected.to include 'cache config should be a hash'
end
end
context 'when descendants are invalid' do
context 'with invalid keys' do
let(:config) { { key: 1 } }
it 'reports error with descendants' do
is_expected.to include 'key should be a hash, a string or a symbol'
end
end
context 'with empty key' do
let(:config) { { key: {} } }
it 'reports error with descendants' do
is_expected.to include 'key config missing required keys: files'
end
end
context 'with invalid files' do
let(:config) { { key: { files: 'a-file' } } }
it 'reports error with descendants' do
is_expected.to include 'key:files config should be an array of strings'
end
end
context 'with prefix without files' do
let(:config) { { key: { prefix: 'a-prefix' } } }
it 'reports error with descendants' do
is_expected.to include 'key config missing required keys: files'
end
end
context 'when there is an unknown key present' do
let(:config) { { key: { unknown: 'a-file' } } }
it 'reports error with descendants' do
is_expected.to include 'key config contains unknown keys: unknown'
end
end
end
context 'when there is an unknown key present' do
let(:config) { { invalid: true } }
it 'reports error with descendants' do
is_expected.to include 'cache config contains unknown keys: invalid'
end
end
context 'when the `when` keyword is not a valid string' do
context 'when `when` is unknown' do
let(:config) { { when: 'unknown' } }
it 'returns error' do
is_expected.to include('cache when should be one of: on_success, on_failure, always')
end
end
context 'when it is an array' do
let(:config) { { when: ['always'] } }
it 'returns error' do
expect(entry).not_to be_valid
is_expected.to include('cache when should be a string')
end
end
context 'when it is a boolean' do
let(:config) { { when: true } }
it 'returns error' do
expect(entry).not_to be_valid
is_expected.to include('cache when should be a string')
end
end
end
context 'when the `policy` keyword is not a valid string' do
context 'when `policy` is unknown' do
let(:config) { { policy: 'unknown' } }
it 'returns error' do
is_expected.to include('cache policy should be one of: pull-push, push, pull')
end
end
context 'when it is an array' do
let(:config) { { policy: ['pull-push'] } }
it 'returns error' do
expect(entry).not_to be_valid
is_expected.to include('cache policy should be a string')
end
end
context 'when it is a boolean' do
let(:config) { { policy: true } }
it 'returns error' do
expect(entry).not_to be_valid
is_expected.to include('cache policy should be a string')
end
end
end
end
end
end
end
|