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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe ::API::MlModelPackages, feature_category: :mlops do
include HttpBasicAuthHelpers
include PackagesManagerApiSpecHelpers
include WorkhorseHelpers
using RSpec::Parameterized::TableSyntax
include_context 'workhorse headers'
let_it_be(:project, reload: true) { create(:project) }
let_it_be(:personal_access_token) { create(:personal_access_token) }
let_it_be(:job) { create(:ci_build, :running, user: personal_access_token.user, project: project) }
let_it_be(:deploy_token) { create(:deploy_token, read_package_registry: true, write_package_registry: true) }
let_it_be(:project_deploy_token) { create(:project_deploy_token, deploy_token: deploy_token, project: project) }
let_it_be(:another_project, reload: true) { create(:project) }
let_it_be(:model) { create(:ml_models, user: project.owner, project: project) }
let_it_be(:model_version) { create(:ml_model_versions, :with_package, model: model, version: '0.1.0') }
let(:snowplow_gitlab_standard_context) do
{ user: user, project: project, namespace: project.namespace, property: 'i_package_ml_model_user' }
end
let_it_be(:tokens) do
{
personal_access_token: personal_access_token.token,
deploy_token: deploy_token.token,
job_token: job.token
}
end
let(:user) { personal_access_token.user }
let(:user_role) { :developer }
let(:member) { true }
let(:ci_build) { create(:ci_build, :running, user: user, project: project) }
let(:project_to_enable_ff) { project }
let(:headers) { {} }
shared_context 'ml model authorize permissions table' do # rubocop:disable RSpec/ContextWording
# rubocop:disable Metrics/AbcSize
# :valid_token, :user_role, :visibility, :member, :token_type, :expected_status
def authorize_permissions_table
false | :developer | :private | true | :job_token | :unauthorized
false | :developer | :private | true | :personal_access_token | :unauthorized
false | :developer | :public | true | :job_token | :unauthorized
false | :developer | :public | true | :personal_access_token | :unauthorized
false | :guest | :private | true | :job_token | :unauthorized
false | :guest | :private | true | :personal_access_token | :unauthorized
false | :guest | :public | true | :job_token | :unauthorized
false | :guest | :public | true | :personal_access_token | :unauthorized
true | :anonymous | :private | false | :personal_access_token | :unauthorized
true | :anonymous | :public | false | :personal_access_token | :unauthorized
true | :developer | :private | true | :job_token | :success
true | :developer | :private | true | :personal_access_token | :success
true | :developer | :public | true | :job_token | :success
true | :developer | :public | true | :personal_access_token | :success
true | :guest | :private | true | :job_token | :forbidden
true | :guest | :private | true | :personal_access_token | :forbidden
true | :guest | :public | true | :job_token | :forbidden
true | :guest | :public | true | :personal_access_token | :forbidden
true | :reporter | :private | true | :job_token | :forbidden
true | :reporter | :private | true | :personal_access_token | :forbidden
true | :reporter | :public | true | :job_token | :forbidden
true | :reporter | :public | true | :personal_access_token | :forbidden
end
# ::valid_token, :user_role, visibility, :member, :token_type, :expected_status
def download_permissions_tables
false | :developer | :private | true | :job_token | :unauthorized
false | :developer | :private | true | :personal_access_token | :unauthorized
false | :developer | :public | true | :job_token | :unauthorized
false | :developer | :public | true | :personal_access_token | :unauthorized
false | :guest | :private | true | :job_token | :unauthorized
false | :guest | :private | true | :personal_access_token | :unauthorized
false | :guest | :public | true | :job_token | :unauthorized
false | :guest | :public | true | :personal_access_token | :unauthorized
true | :anonymous | :private | false | :personal_access_token | :not_found
true | :anonymous | :public | false | :personal_access_token | :success
true | :developer | :private | true | :job_token | :success
true | :developer | :private | true | :personal_access_token | :success
true | :developer | :public | true | :job_token | :success
true | :developer | :public | true | :personal_access_token | :success
true | :guest | :private | true | :job_token | :forbidden
true | :guest | :private | true | :personal_access_token | :forbidden
true | :guest | :public | true | :job_token | :success
true | :guest | :public | true | :personal_access_token | :success
true | :reporter | :private | true | :job_token | :success
true | :reporter | :private | true | :personal_access_token | :success
true | :reporter | :public | true | :job_token | :success
true | :reporter | :public | true | :personal_access_token | :success
end
# rubocop:enable Metrics/AbcSize
end
before do
project.send("add_#{user_role}", user) if member && user_role != :anonymous
end
describe 'PUT /api/v4/projects/:id/packages/ml_models/:model_version_id/files/(*path)/:file_name/authorize' do
include_context 'ml model authorize permissions table'
let_it_be(:file_name) { 'model.md5' }
let(:token) { tokens[:personal_access_token] }
let(:user_headers) { { 'Authorization' => "Bearer #{token}" } }
let(:headers) { user_headers.merge(workhorse_headers) }
let(:request) { authorize_upload_file(headers) }
let(:model_name) { model_version.name }
let(:version) { model_version.version }
let(:file_path) { '' }
let(:full_path) { "#{file_path}#{file_name}" }
subject(:api_response) do
url = "/projects/#{project.id}/packages/ml_models/#{model_version.id}/files/#{full_path}/authorize"
put api(url), headers: headers
response
end
context 'when file has path' do
let(:file_path) { 'my_dir' }
it { is_expected.to have_gitlab_http_status(:success) }
end
describe 'user access' do
where(:valid_token, :user_role, :visibility, :member, :token_type, :expected_status) do
authorize_permissions_table
end
with_them do
let(:token) { valid_token ? tokens[token_type] : 'invalid-token123' }
let(:user_headers) { user_role == :anonymous ? {} : { 'Authorization' => "Bearer #{token}" } }
before do
project.update_column(:visibility_level, Gitlab::VisibilityLevel.level_value(visibility.to_s))
end
context 'when file does not have path' do
it { is_expected.to have_gitlab_http_status(expected_status) }
end
end
it_behaves_like 'Endpoint not found if read_model_registry not available'
end
describe 'application security' do
context 'when path has back directory' do
let(:file_name) { '../.ssh%2fauthorized_keys' }
it 'rejects malicious request' do
is_expected.to have_gitlab_http_status(:bad_request)
end
end
context 'when path has invalid characters' do
let(:file_name) { '%2e%2e%2f.ssh%2fauthorized_keys' }
it 'rejects malicious request' do
is_expected.to have_gitlab_http_status(:bad_request)
end
end
end
end
# rubocop:disable RSpec/MultipleMemoizedHelpers -- This test requires many different variables to be set
describe 'PUT /api/v4/projects/:id/packages/ml_models/:model_version_id/(*path)/files/:file_name' do
include_context 'ml model authorize permissions table'
let_it_be(:file_name) { 'model.md5' }
let(:token) { tokens[:personal_access_token] }
let(:user_headers) { { 'Authorization' => "Bearer #{token}" } }
let(:headers) { user_headers.merge(workhorse_headers) }
let(:params) { { file: temp_file(file_name) } }
let(:file_key) { :file }
let(:send_rewritten_field) { true }
let(:version_id) { model_version.id }
let(:file_path) { '' }
let(:full_path) { "#{file_path}#{file_name}" }
let(:saved_file_name) { file_name }
subject(:api_response) do
url = "/projects/#{project.id}/packages/ml_models/#{version_id}/files/#{full_path}"
workhorse_finalize(
api(url),
method: :put,
file_key: file_key,
params: params,
headers: headers,
send_rewritten_field: send_rewritten_field
)
response
end
describe 'upload' do
context 'when file does not have path' do
it_behaves_like 'process ml model package upload'
end
context 'when file has path' do
let(:file_path) { 'my_dir/' }
let(:saved_file_name) { "my_dir%2F#{file_name}" }
it_behaves_like 'process ml model package upload'
end
context 'when file is for candidate' do
let_it_be(:candidate) do
create(:ml_candidates, project: model.project, experiment: model.default_experiment, model_version: nil)
end
let(:version_id) { "candidate:#{candidate.iid}" }
it 'creates package files', :aggregate_failures do
expect { api_response }
.to change { Packages::PackageFile.count }.by(1)
.and change { Packages::Package.count }.by(1)
expect(api_response).to have_gitlab_http_status(:created)
package_file = project.packages.last.package_files.reload.last
expect(package_file.file_name).to eq(saved_file_name)
expect(package_file.package.name).to eq(model.name)
expect(package_file.package.version).to eq("candidate_#{candidate.iid}")
end
context 'when candidate does not exist' do
let(:version_id) { "candidate:#{non_existing_record_id}" }
it { is_expected.to have_gitlab_http_status(:not_found) }
end
end
it_behaves_like 'Not found when model version does not exist'
end
describe 'user access' do
where(:valid_token, :user_role, :visibility, :member, :token_type, :expected_status) do
authorize_permissions_table
end
with_them do
let(:token) { valid_token ? tokens[token_type] : 'invalid-token123' }
let(:user_headers) { user_role == :anonymous ? {} : { 'Authorization' => "Bearer #{token}" } }
before do
project.update_column(:visibility_level, Gitlab::VisibilityLevel.level_value(visibility.to_s))
end
it { is_expected.to have_gitlab_http_status(expected_status) }
end
it_behaves_like 'Endpoint not found if read_model_registry not available'
it_behaves_like 'Endpoint not found if write_model_registry not available'
end
end
describe 'GET /api/v4/projects/:project_id/packages/ml_models/:model_version_id/files/(*path)/:file_name' do
include_context 'ml model authorize permissions table'
let_it_be(:file_name) { Addressable::URI.escape('Mo_de-l v12.md5') }
let_it_be(:package) { model_version.package }
let_it_be(:package_file_1) { create(:package_file, :generic, package: package, file_name: file_name) }
let_it_be(:package_file_2) { create(:package_file, :generic, package: package, file_name: "my_dir%2F#{file_name}") }
let(:file_path) { '' }
let(:full_path) { "#{file_path}#{file_name}" }
let(:saved_file_name) { file_name }
let(:version_id) { model_version.id }
let(:token) { tokens[:personal_access_token] }
let(:user_headers) { { 'Authorization' => "Bearer #{token}" } }
let(:headers) { user_headers.merge(workhorse_headers) }
subject(:api_response) do
url = "/projects/#{project.id}/packages/ml_models/#{version_id}/files/#{full_path}"
get api(url), headers: headers
response
end
describe 'download' do
it_behaves_like 'process ml model package download'
context 'when file has path' do
let(:file_path) { 'my_dir/' }
it_behaves_like 'process ml model package download'
end
it_behaves_like 'Not found when model version does not exist'
end
describe 'user access' do
where(:valid_token, :user_role, :visibility, :member, :token_type, :expected_status) do
download_permissions_tables
end
with_them do
let(:token) { valid_token ? tokens[token_type] : 'invalid-token123' }
let(:user_headers) { user_role == :anonymous ? {} : { 'Authorization' => "Bearer #{token}" } }
before do
project.update_column(:visibility_level, Gitlab::VisibilityLevel.level_value(visibility.to_s))
end
it { is_expected.to have_gitlab_http_status(expected_status) }
end
it_behaves_like 'Endpoint not found if read_model_registry not available'
end
end
# rubocop:enable RSpec/MultipleMemoizedHelpers
end
|
