Welcome to mirror list, hosted at ThFree Co, Russian Federation.

ml_model_packages_spec.rb « api « requests « spec - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 3166298b430ccd584bfc88ff65387392c9e234aa (plain)
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::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(: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
    # :visibility, :user_role, :member, :token_type, :valid_token, :expected_status
    def authorize_permissions_table
      :public  | :developer  | true  | :personal_access_token | true  | :success
      :public  | :guest      | true  | :personal_access_token | true  | :forbidden
      :public  | :developer  | true  | :personal_access_token | false | :unauthorized
      :public  | :guest      | true  | :personal_access_token | false | :unauthorized
      :public  | :developer  | false | :personal_access_token | true  | :forbidden
      :public  | :guest      | false | :personal_access_token | true  | :forbidden
      :public  | :developer  | false | :personal_access_token | false | :unauthorized
      :public  | :guest      | false | :personal_access_token | false | :unauthorized
      :public  | :anonymous  | false | :personal_access_token | true  | :unauthorized
      :private | :developer  | true  | :personal_access_token | true  | :success
      :private | :guest      | true  | :personal_access_token | true  | :forbidden
      :private | :developer  | true  | :personal_access_token | false | :unauthorized
      :private | :guest      | true  | :personal_access_token | false | :unauthorized
      :private | :developer  | false | :personal_access_token | true  | :not_found
      :private | :guest      | false | :personal_access_token | true  | :not_found
      :private | :developer  | false | :personal_access_token | false | :unauthorized
      :private | :guest      | false | :personal_access_token | false | :unauthorized
      :private | :anonymous  | false | :personal_access_token | true  | :unauthorized
      :public  | :developer  | true  | :job_token             | true  | :success
      :public  | :guest      | true  | :job_token             | true  | :forbidden
      :public  | :developer  | true  | :job_token             | false | :unauthorized
      :public  | :guest      | true  | :job_token             | false | :unauthorized
      :public  | :developer  | false | :job_token             | true  | :forbidden
      :public  | :guest      | false | :job_token             | true  | :forbidden
      :public  | :developer  | false | :job_token             | false | :unauthorized
      :public  | :guest      | false | :job_token             | false | :unauthorized
      :private | :developer  | true  | :job_token             | true  | :success
      :private | :guest      | true  | :job_token             | true  | :forbidden
      :private | :developer  | true  | :job_token             | false | :unauthorized
      :private | :guest      | true  | :job_token             | false | :unauthorized
      :private | :developer  | false | :job_token             | true  | :not_found
      :private | :guest      | false | :job_token             | true  | :not_found
      :private | :developer  | false | :job_token             | false | :unauthorized
      :private | :guest      | false | :job_token             | false | :unauthorized
      :public  | :developer  | true  | :deploy_token          | true  | :success
      :public  | :developer  | true  | :deploy_token          | false | :unauthorized
      :private | :developer  | true  | :deploy_token          | true  | :success
      :private | :developer  | true  | :deploy_token          | false | :unauthorized
    end

    # :visibility, :user_role, :member, :token_type, :valid_token, :expected_status
    def download_permissions_tables
      :public  | :developer  | true  | :personal_access_token | true  |  :success
      :public  | :guest      | true  | :personal_access_token | true  |  :success
      :public  | :developer  | true  | :personal_access_token | false |  :unauthorized
      :public  | :guest      | true  | :personal_access_token | false |  :unauthorized
      :public  | :developer  | false | :personal_access_token | true  |  :success
      :public  | :guest      | false | :personal_access_token | true  |  :success
      :public  | :developer  | false | :personal_access_token | false |  :unauthorized
      :public  | :guest      | false | :personal_access_token | false |  :unauthorized
      :public  | :anonymous  | false | :personal_access_token | true  |  :success
      :private | :developer  | true  | :personal_access_token | true  |  :success
      :private | :guest      | true  | :personal_access_token | true  |  :forbidden
      :private | :developer  | true  | :personal_access_token | false |  :unauthorized
      :private | :guest      | true  | :personal_access_token | false |  :unauthorized
      :private | :developer  | false | :personal_access_token | true | :not_found
      :private | :guest      | false | :personal_access_token | true  |  :not_found
      :private | :developer  | false | :personal_access_token | false |  :unauthorized
      :private | :guest      | false | :personal_access_token | false |  :unauthorized
      :private | :anonymous  | false | :personal_access_token | true  |  :not_found
      :public  | :developer  | true  | :job_token             | true  |  :success
      :public  | :guest      | true  | :job_token             | true  |  :success
      :public  | :developer  | true  | :job_token             | false |  :unauthorized
      :public  | :guest      | true  | :job_token             | false |  :unauthorized
      :public  | :developer  | false | :job_token             | true  |  :success
      :public  | :guest      | false | :job_token             | true  |  :success
      :public  | :developer  | false | :job_token             | false |  :unauthorized
      :public  | :guest      | false | :job_token             | false |  :unauthorized
      :private | :developer  | true  | :job_token             | true  |  :success
      :private | :guest      | true  | :job_token             | true  |  :forbidden
      :private | :developer  | true  | :job_token             | false |  :unauthorized
      :private | :guest      | true  | :job_token             | false |  :unauthorized
      :private | :developer  | false | :job_token             | true  |  :not_found
      :private | :guest      | false | :job_token             | true  |  :not_found
      :private | :developer  | false | :job_token             | false |  :unauthorized
      :private | :guest      | false | :job_token             | false |  :unauthorized
      :public  | :developer  | true  | :deploy_token          | true  |  :success
      :public  | :developer  | true  | :deploy_token          | false |  :unauthorized
      :private | :developer  | true  | :deploy_token          | true  |  :success
      :private | :developer  | true  | :deploy_token          | false |  :unauthorized
    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_name/:model_version/:file_name/authorize' do
    include_context 'ml model authorize permissions table'

    let(:token) { tokens[:personal_access_token] }
    let(:user_headers) { { 'HTTP_AUTHORIZATION' => token } }
    let(:headers) { user_headers.merge(workhorse_headers) }
    let(:request) { authorize_upload_file(headers) }
    let(:model_name) { 'my_package' }
    let(:file_name) { 'myfile.tar.gz' }

    subject(:api_response) do
      url = "/projects/#{project.id}/packages/ml_models/#{model_name}/0.0.1/#{file_name}/authorize"

      put api(url), headers: headers

      response
    end

    describe 'user access' do
      where(:visibility, :user_role, :member, :token_type, :valid_token, :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 ? {} : { 'HTTP_AUTHORIZATION' => 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

    describe 'application security' do
      where(:model_name, :file_name) do
        'my-package/../'         | 'myfile.tar.gz'
        'my-package%2f%2e%2e%2f' | 'myfile.tar.gz'
        'my_package'             | '../.ssh%2fauthorized_keys'
        'my_package'             | '%2e%2e%2f.ssh%2fauthorized_keys'
      end

      with_them do
        it 'rejects malicious request' do
          is_expected.to have_gitlab_http_status(:bad_request)
        end
      end
    end
  end

  describe 'PUT /api/v4/projects/:id/packages/ml_models/:model_name/:model_version/: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) { { 'HTTP_AUTHORIZATION' => 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(:model_name) { 'my_package' }

    subject(:api_response) do
      url = "/projects/#{project.id}/packages/ml_models/#{model_name}/0.0.1/#{file_name}"

      workhorse_finalize(
        api(url),
        method: :put,
        file_key: file_key,
        params: params,
        headers: headers,
        send_rewritten_field: send_rewritten_field
      )

      response
    end

    describe 'success' do
      it 'creates a new package' do
        expect { api_response }.to change { Packages::PackageFile.count }.by(1)
        expect(api_response).to have_gitlab_http_status(:created)
      end
    end

    describe 'user access' do
      where(:visibility, :user_role, :member, :token_type, :valid_token, :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 ? {} : { 'HTTP_AUTHORIZATION' => token } }

        before do
          project.update_column(:visibility_level, Gitlab::VisibilityLevel.level_value(visibility.to_s))
        end

        if params[:expected_status] == :success
          it_behaves_like 'process ml model package upload'
        else
          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
  end

  describe 'GET /api/v4/projects/:project_id/packages/ml_models/:model_name/:model_version/:file_name' do
    include_context 'ml model authorize permissions table'

    let_it_be(:package) { create(:ml_model_package, project: project, name: 'model', version: '0.0.1') }
    let_it_be(:package_file) { create(:package_file, :generic, package: package, file_name: 'model.md5') }

    let(:model_name) { package.name }
    let(:model_version) { package.version }
    let(:file_name) { package_file.file_name }

    let(:token) { tokens[:personal_access_token] }
    let(:user_headers) { { 'HTTP_AUTHORIZATION' => token } }
    let(:headers) { user_headers.merge(workhorse_headers) }

    subject(:api_response) do
      url = "/projects/#{project.id}/packages/ml_models/#{model_name}/#{model_version}/#{file_name}"

      get api(url), headers: headers

      response
    end

    describe 'user access' do
      where(:visibility, :user_role, :member, :token_type, :valid_token, :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 ? {} : { 'HTTP_AUTHORIZATION' => token } }

        before do
          project.update_column(:visibility_level, Gitlab::VisibilityLevel.level_value(visibility.to_s))
        end

        if params[:expected_status] == :success
          it_behaves_like 'process ml model package download'
        else
          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
  end
end