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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe API::Ml::Mlflow::RegisteredModels, feature_category: :mlops do
let_it_be(:project) { create(:project) }
let_it_be(:developer) { create(:user, developer_of: project) }
let_it_be(:model) do
create(:ml_models, :with_metadata, project: project)
end
let_it_be(:tokens) do
{
write: create(:personal_access_token, scopes: %w[read_api api], user: developer),
read: create(:personal_access_token, scopes: %w[read_api], user: developer),
no_access: create(:personal_access_token, scopes: %w[read_user], user: developer),
different_user: create(:personal_access_token, scopes: %w[read_api api], user: build(:user))
}
end
let(:current_user) { developer }
let(:access_token) { tokens[:write] }
let(:headers) { { 'Authorization' => "Bearer #{access_token.token}" } }
let(:project_id) { project.id }
let(:default_params) { {} }
let(:params) { default_params }
let(:request) { get api(route), params: params, headers: headers }
let(:json_response) { Gitlab::Json.parse(api_response.body) }
subject(:api_response) do
request
response
end
describe 'GET /projects/:id/ml/mlflow/api/2.0/mlflow/registered-models/get' do
let(:model_name) { model.name }
let(:route) { "/projects/#{project_id}/ml/mlflow/api/2.0/mlflow/registered-models/get?name=#{model_name}" }
it 'returns the model', :aggregate_failures do
is_expected.to have_gitlab_http_status(:ok)
is_expected.to match_response_schema('ml/get_model')
end
describe 'Error States' do
context 'when has access' do
context 'and model does not exist' do
let(:model_name) { 'foo' }
it_behaves_like 'MLflow|Not Found - Resource Does Not Exist'
end
context 'and name is not passed' do
let(:route) { "/projects/#{project_id}/ml/mlflow/api/2.0/mlflow/registered-models/get" }
it_behaves_like 'MLflow|Not Found - Resource Does Not Exist'
end
end
it_behaves_like 'MLflow|an authenticated resource'
it_behaves_like 'MLflow|a read-only model registry resource'
end
end
describe 'POST /projects/:id/ml/mlflow/api/2.0/mlflow/registered-models/create' do
let(:route) do
"/projects/#{project_id}/ml/mlflow/api/2.0/mlflow/registered-models/create"
end
let(:params) { { name: 'my-model-name' } }
let(:request) { post api(route), params: params, headers: headers }
it 'creates the model', :aggregate_failures do
is_expected.to have_gitlab_http_status(:ok)
expect(json_response).to include('registered_model')
end
describe 'Error States' do
context 'when the model name is not passed' do
let(:params) { {} }
it_behaves_like 'MLflow|an invalid request'
end
context 'when the model name already exists' do
let(:existing_model) do
create(:ml_models, user: current_user, project: project)
end
let(:params) { { name: existing_model.name } }
it "is Bad Request", :aggregate_failures do
is_expected.to have_gitlab_http_status(:bad_request)
expect(json_response).to include({ 'error_code' => 'RESOURCE_ALREADY_EXISTS' })
end
end
context 'when project does not exist' do
let(:route) { "/projects/#{non_existing_record_id}/ml/mlflow/api/2.0/mlflow/registered-models/create" }
it "is Not Found", :aggregate_failures do
is_expected.to have_gitlab_http_status(:not_found)
expect(json_response['message']).to eq('404 Project Not Found')
end
end
# TODO: Ensure consisted error responses https://gitlab.com/gitlab-org/gitlab/-/issues/429731
context 'when a duplicate tag name is supplied' do
let(:params) do
{ name: 'my-model-name', tags: [{ key: 'key1', value: 'value1' }, { key: 'key1', value: 'value2' }] }
end
it "creates the model with only the second tag", :aggregate_failures do
expect(json_response).to include({ 'error_code' => 'RESOURCE_ALREADY_EXISTS' })
end
end
# TODO: Ensure consisted error responses https://gitlab.com/gitlab-org/gitlab/-/issues/429731
context 'when an empty tag name is supplied' do
let(:params) do
{ name: 'my-model-name', tags: [{ key: '', value: 'value1' }, { key: 'key1', value: 'value2' }] }
end
it "creates the model with only the second tag", :aggregate_failures do
expect(json_response).to include({ 'error_code' => 'RESOURCE_ALREADY_EXISTS' })
end
end
it_behaves_like 'MLflow|an authenticated resource'
it_behaves_like 'MLflow|a read/write model registry resource'
end
end
describe 'PATCH /projects/:id/ml/mlflow/api/2.0/mlflow/registered-models/update' do
let(:model_name) { model.name }
let(:model_description) { 'updated model description' }
let(:params) { { name: model_name, description: model_description } }
let(:route) { "/projects/#{project_id}/ml/mlflow/api/2.0/mlflow/registered-models/update" }
let(:request) { patch api(route), params: params, headers: headers }
it 'returns the updated model', :aggregate_failures do
is_expected.to have_gitlab_http_status(:ok)
is_expected.to match_response_schema('ml/update_model')
expect(json_response["registered_model"]["description"]).to eq(model_description)
end
describe 'Error States' do
context 'when has access' do
context 'and model does not exist' do
let(:model_name) { 'foo' }
it_behaves_like 'MLflow|Not Found - Resource Does Not Exist'
end
context 'and name is not passed' do
let(:params) { { description: model_description } }
it_behaves_like 'MLflow|Not Found - Resource Does Not Exist'
end
end
it_behaves_like 'MLflow|an authenticated resource'
it_behaves_like 'MLflow|a read/write model registry resource'
end
end
describe 'POST /projects/:id/ml/mlflow/api/2.0/mlflow/registered-models/get-latest-versions' do
let_it_be(:version1) { create(:ml_model_versions, model: model, created_at: 1.week.ago) }
let_it_be(:version2) { create(:ml_model_versions, model: model, created_at: 1.day.ago) }
let(:model_name) { model.name }
let(:params) { { name: model_name } }
let(:route) { "/projects/#{project_id}/ml/mlflow/api/2.0/mlflow/registered-models/get-latest-versions" }
let(:request) { post api(route), params: params, headers: headers }
it 'returns an array with the most recently created model version', :aggregate_failures do
is_expected.to have_gitlab_http_status(:ok)
is_expected.to match_response_schema('ml/get_latest_versions')
expect(json_response["model_versions"][0]["name"]).to eq(model_name)
expect(json_response["model_versions"][0]["version"]).to eq(version2.id.to_s)
end
describe 'Error States' do
context 'when has access' do
context 'and model does not exist' do
let(:model_name) { 'foo' }
it_behaves_like 'MLflow|Not Found - Resource Does Not Exist'
end
context 'and name is not passed' do
let(:params) { {} }
it_behaves_like 'MLflow|Not Found - Resource Does Not Exist'
end
end
it_behaves_like 'MLflow|an authenticated resource'
it_behaves_like 'MLflow|a read-only model registry resource'
end
end
describe 'DELETE /projects/:id/ml/mlflow/api/2.0/mlflow/registered-models/delete' do
let(:model_name) { model.name }
let(:params) { { name: model_name } }
let(:route) { "/projects/#{project_id}/ml/mlflow/api/2.0/mlflow/registered-models/delete" }
let(:request) { delete api(route), params: params, headers: headers }
it 'returns a success response', :aggregate_failures do
is_expected.to have_gitlab_http_status(:ok)
expect(json_response).to eq({})
end
describe 'Error States' do
context 'when destroy fails' do
it 'returns an error' do
allow(Ml::DestroyModelService).to receive_message_chain(:new,
:execute).and_return(ServiceResponse.error(message: ""))
is_expected.to have_gitlab_http_status(:bad_request)
expect(json_response["message"]).to eq("Model could not be deleted")
end
end
context 'when has access' do
context 'and model does not exist' do
let(:model_name) { 'foo' }
it_behaves_like 'MLflow|Not Found - Resource Does Not Exist'
end
context 'and name is not passed' do
let(:params) { {} }
it_behaves_like 'MLflow|Not Found - Resource Does Not Exist'
end
end
it_behaves_like 'MLflow|an authenticated resource'
it_behaves_like 'MLflow|a read/write model registry resource'
end
end
describe 'GET /projects/:id/ml/mlflow/api/2.0/mlflow/registered-models/search' do
let_it_be(:model2) do
create(:ml_models, :with_metadata, project: project)
end
let(:route) { "/projects/#{project_id}/ml/mlflow/api/2.0/mlflow/registered-models/search" }
it 'returns all the models', :aggregate_failures do
is_expected.to have_gitlab_http_status(:ok)
is_expected.to match_response_schema('ml/list_models')
expect(json_response["registered_models"].count).to be(2)
end
context "with a valid filter supplied" do
let(:filter) { "name='#{model2.name}'" }
let(:route) { "/projects/#{project_id}/ml/mlflow/api/2.0/mlflow/registered-models/search?filter=#{filter}" }
it 'returns only the models for the given filter' do
is_expected.to have_gitlab_http_status(:ok)
expect(json_response["registered_models"].count).to be(1)
end
end
context "with an invalid filter supplied" do
let(:filter) { "description='foo'" }
let(:route) { "/projects/#{project_id}/ml/mlflow/api/2.0/mlflow/registered-models/search?filter=#{filter}" }
it 'returns an error' do
is_expected.to have_gitlab_http_status(:bad_request)
expect(json_response).to include({ 'error_code' => 'INVALID_PARAMETER_VALUE' })
end
end
describe 'Error States' do
it_behaves_like 'MLflow|an authenticated resource'
it_behaves_like 'MLflow|a read-only model registry resource'
end
end
end
|
