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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe API::GroupVariables, feature_category: :secrets_management do
let_it_be(:group) { create(:group) }
let_it_be(:user) { create(:user) }
let(:access_level) {}
before do
group.add_member(user, access_level) if access_level
end
describe 'GET /groups/:id/variables' do
context 'authorized user with proper permissions' do
let(:access_level) { :owner }
it 'returns group variables' do
get api("/groups/#{group.id}/variables", user)
expect(response).to have_gitlab_http_status(:ok)
expect(json_response).to be_a(Array)
end
end
context 'authorized user with invalid permissions' do
let(:access_level) { :maintainer }
it 'does not return group variables' do
get api("/groups/#{group.id}/variables", user)
expect(response).to have_gitlab_http_status(:forbidden)
end
end
context 'unauthorized user' do
it 'does not return group variables' do
get api("/groups/#{group.id}/variables")
expect(response).to have_gitlab_http_status(:unauthorized)
end
end
end
describe 'GET /groups/:id/variables/:key' do
context 'authorized user with proper permissions' do
let(:access_level) { :owner }
context 'when variable is hidden' do
let_it_be(:variable) { create(:ci_group_variable, group: group, hidden: true, masked: true) }
it 'returns group variable details and cuts the value' do
get api("/groups/#{group.id}/variables/#{variable.key}", user)
expect(response).to have_gitlab_http_status(:ok)
expect(json_response['value']).to be_nil
expect(json_response['protected']).to eq(variable.protected?)
expect(json_response['hidden']).to eq(true)
expect(json_response['variable_type']).to eq(variable.variable_type)
expect(json_response['environment_scope']).to eq(variable.environment_scope)
expect(json_response['description']).to be_nil
end
end
context 'when variable is not hidden' do
let_it_be(:variable) { create(:ci_group_variable, group: group) }
it 'returns group variable details' do
get api("/groups/#{group.id}/variables/#{variable.key}", user)
expect(response).to have_gitlab_http_status(:ok)
expect(json_response['value']).to eq(variable.value)
expect(json_response['protected']).to eq(variable.protected?)
expect(json_response['hidden']).to eq(false)
expect(json_response['variable_type']).to eq(variable.variable_type)
expect(json_response['environment_scope']).to eq(variable.environment_scope)
expect(json_response['description']).to be_nil
end
end
it 'responds with 404 Not Found if requesting non-existing variable' do
get api("/groups/#{group.id}/variables/non_existing_variable", user)
expect(response).to have_gitlab_http_status(:not_found)
end
end
context 'authorized user with invalid permissions' do
let(:access_level) { :maintainer }
let_it_be(:variable) { create(:ci_group_variable, group: group, hidden: true, masked: true) }
it 'does not return group variable details' do
get api("/groups/#{group.id}/variables/#{variable.key}", user)
expect(response).to have_gitlab_http_status(:forbidden)
end
end
context 'unauthorized user' do
let_it_be(:variable) { create(:ci_group_variable, group: group, hidden: true, masked: true) }
it 'does not return group variable details' do
get api("/groups/#{group.id}/variables/#{variable.key}")
expect(response).to have_gitlab_http_status(:unauthorized)
end
end
end
describe 'POST /groups/:id/variables' do
let_it_be(:variable) { create(:ci_group_variable, group: group) }
context 'authorized user with proper permissions' do
let(:access_level) { :owner }
context 'when the group is below the plan limit for variables' do
it 'creates variable' do
expect do
post api("/groups/#{group.id}/variables", user), params: { key: 'TEST_VARIABLE_2', value: 'PROTECTED_VALUE_2', protected: true, masked: true, raw: true }
end.to change { group.variables.count }.by(1)
expect(response).to have_gitlab_http_status(:created)
expect(json_response['key']).to eq('TEST_VARIABLE_2')
expect(json_response['value']).to eq('PROTECTED_VALUE_2')
expect(json_response['protected']).to be_truthy
expect(json_response['hidden']).to eq(false)
expect(json_response['masked']).to be_truthy
expect(json_response['variable_type']).to eq('env_var')
expect(json_response['environment_scope']).to eq('*')
expect(json_response['raw']).to be_truthy
end
it 'creates variable with masked and hidden' do
expect do
post api("/groups/#{group.id}/variables", user), params: { key: 'TEST_VARIABLE_2', value: 'PROTECTED_VALUE_2', protected: true, masked_and_hidden: true, raw: true }
end.to change { group.variables.count }.by(1)
expect(response).to have_gitlab_http_status(:created)
expect(json_response['key']).to eq('TEST_VARIABLE_2')
expect(json_response['value']).to be_nil
expect(json_response['protected']).to be_truthy
expect(json_response['hidden']).to eq(true)
expect(json_response['masked']).to be_truthy
expect(json_response['variable_type']).to eq('env_var')
expect(json_response['environment_scope']).to eq('*')
expect(json_response['raw']).to be_truthy
end
it 'masks the new value when logging' do
masked_params = { 'key' => 'VAR_KEY', 'value' => '[FILTERED]', 'protected' => 'true', 'masked' => 'true' }
expect(::API::API::LOGGER).to receive(:info).with(include(params: include(masked_params)))
post api("/groups/#{group.id}/variables", user),
params: { key: 'VAR_KEY', value: 'SENSITIVE', protected: true, masked: true }
end
it 'creates variable with optional attributes' do
expect do
post api("/groups/#{group.id}/variables", user), params: { variable_type: 'file', key: 'TEST_VARIABLE_2', value: 'VALUE_2', description: 'description' }
end.to change { group.variables.count }.by(1)
expect(response).to have_gitlab_http_status(:created)
expect(json_response['key']).to eq('TEST_VARIABLE_2')
expect(json_response['value']).to eq('VALUE_2')
expect(json_response['protected']).to be_falsey
expect(json_response['hidden']).to eq(false)
expect(json_response['masked']).to be_falsey
expect(json_response['raw']).to be_falsey
expect(json_response['variable_type']).to eq('file')
expect(json_response['environment_scope']).to eq('*')
expect(json_response['description']).to eq('description')
end
it 'does not allow to duplicate variable key' do
expect do
post api("/groups/#{group.id}/variables", user), params: { key: variable.key, value: 'VALUE_2' }
end.to change { group.variables.count }.by(0)
expect(response).to have_gitlab_http_status(:bad_request)
end
end
context 'when the group is at the plan limit for variables' do
before do
create(:plan_limits, :default_plan, group_ci_variables: 1)
end
it 'returns a variable limit error' do
expect do
post api("/groups/#{group.id}/variables", user), params: { key: 'TOO_MANY_VARS', value: 'too many' }
end.not_to change { group.variables.count }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']['base']).to contain_exactly(
'Maximum number of group ci variables (1) exceeded'
)
end
end
end
context 'authorized user with invalid permissions' do
let(:access_level) { :maintainer }
it 'does not create variable' do
post api("/groups/#{group.id}/variables", user)
expect(response).to have_gitlab_http_status(:forbidden)
end
end
context 'unauthorized user' do
it 'does not create variable' do
post api("/groups/#{group.id}/variables")
expect(response).to have_gitlab_http_status(:unauthorized)
end
end
end
describe 'PUT /groups/:id/variables/:key' do
context 'authorized user with proper permissions' do
let(:access_level) { :owner }
context 'when variable is not hidden' do
let_it_be(:variable) { create(:ci_group_variable, group: group, hidden: false) }
it 'updates variable data' do
initial_variable = group.variables.reload.first
value_before = initial_variable.value
put api("/groups/#{group.id}/variables/#{variable.key}", user), params: { variable_type: 'file', value: 'VALUE_1_UP', protected: true, masked: true, raw: true, description: 'updated' }
updated_variable = group.variables.reload.first
expect(response).to have_gitlab_http_status(:ok)
expect(value_before).to eq(variable.value)
expect(updated_variable.value).to eq('VALUE_1_UP')
expect(updated_variable).to be_protected
expect(json_response['variable_type']).to eq('file')
expect(json_response['masked']).to be_truthy
expect(json_response['raw']).to be_truthy
expect(json_response['description']).to eq('updated')
end
it 'masks the new value when logging' do
masked_params = { 'value' => '[FILTERED]', 'protected' => 'true', 'masked' => 'true' }
expect(::API::API::LOGGER).to receive(:info).with(include(params: include(masked_params)))
put api("/groups/#{group.id}/variables/#{variable.key}", user),
params: { value: 'SENSITIVE', protected: true, masked: true }
end
it 'responds with 404 Not Found if requesting non-existing variable' do
put api("/groups/#{group.id}/variables/non_existing_variable", user)
expect(response).to have_gitlab_http_status(:not_found)
end
it 'responds with 400 if the update fails' do
put api("/groups/#{group.id}/variables/#{variable.key}", user), params: { value: 'shrt', masked: true }
expect(response).to have_gitlab_http_status(:bad_request)
expect(variable.reload.masked).to eq(false)
expect(json_response['message']).to eq('value' => ['is invalid'])
end
end
context 'when variable is hidden' do
let_it_be(:variable) { create(:ci_group_variable, group: group, hidden: true, masked: true) }
it 'unable to update masked attribute' do
put api("/groups/#{group.id}/variables/#{variable.key}", user), params: { variable_type: 'file', value: 'VALUE_1_UP', protected: true, masked: false, raw: true, description: 'updated' }
updated_variable = group.variables.reload.first
expect(response).to have_gitlab_http_status(:bad_request)
expected_error_message = 'Updating masked attribute is not allowed on updates for hidden variables.'
expect(json_response['message']['base']).to contain_exactly(expected_error_message)
expect(updated_variable).to be_masked
end
end
end
context 'authorized user with invalid permissions' do
let(:access_level) { :maintainer }
let_it_be(:variable) { create(:ci_group_variable, group: group) }
it 'does not update variable' do
put api("/groups/#{group.id}/variables/#{variable.key}", user)
expect(response).to have_gitlab_http_status(:forbidden)
end
end
context 'unauthorized user' do
let_it_be(:variable) { create(:ci_group_variable, group: group) }
it 'does not update variable' do
put api("/groups/#{group.id}/variables/#{variable.key}")
expect(response).to have_gitlab_http_status(:unauthorized)
end
end
end
describe 'DELETE /groups/:id/variables/:key' do
let_it_be(:variable) { create(:ci_group_variable, group: group) }
context 'authorized user with proper permissions' do
let(:access_level) { :owner }
it 'deletes variable' do
expect do
delete api("/groups/#{group.id}/variables/#{variable.key}", user)
expect(response).to have_gitlab_http_status(:no_content)
end.to change { group.variables.count }.by(-1)
end
it 'responds with 404 Not Found if requesting non-existing variable' do
delete api("/groups/#{group.id}/variables/non_existing_variable", user)
expect(response).to have_gitlab_http_status(:not_found)
end
it_behaves_like '412 response' do
let(:request) { api("/groups/#{group.id}/variables/#{variable.key}", user) }
end
end
context 'authorized user with invalid permissions' do
let(:access_level) { :maintainer }
it 'does not delete variable' do
delete api("/groups/#{group.id}/variables/#{variable.key}", user)
expect(response).to have_gitlab_http_status(:forbidden)
end
end
context 'unauthorized user' do
it 'does not delete variable' do
delete api("/groups/#{group.id}/variables/#{variable.key}")
expect(response).to have_gitlab_http_status(:unauthorized)
end
end
end
end
|
