gitlab-ce/spec/requests/api/ml_model_packages_spec.rb

201 lines
8.5 KiB
Ruby

# 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
# rubocop:enable Metrics/AbcSize
end
before do
project.send("add_#{user_role}", user) if member && user_role != :anonymous
end
subject(:api_response) do
request
response
end
describe 'PUT /api/v4/projects/:id/packages/ml_models/:package_name/:package_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) }
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(:param_name, :param_value) do
:package_name | 'my-package/../'
:package_name | 'my-package%2f%2e%2e%2f'
:file_name | '../.ssh%2fauthorized_keys'
:file_name | '%2e%2e%2f.ssh%2fauthorized_keys'
end
with_them do
let(:request) { authorize_upload_file(headers, param_name => param_value) }
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/:package_name/:package_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(:request) do
upload_file(headers)
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
def authorize_upload_file(request_headers, package_name: 'mypackage', file_name: 'myfile.tar.gz')
url = "/projects/#{project.id}/packages/ml_models/#{package_name}/0.0.1/#{file_name}/authorize"
put api(url), headers: request_headers
end
def upload_file(request_headers, package_name: 'mypackage')
url = "/projects/#{project.id}/packages/ml_models/#{package_name}/0.0.1/#{file_name}"
workhorse_finalize(
api(url),
method: :put,
file_key: file_key,
params: params,
headers: request_headers,
send_rewritten_field: send_rewritten_field
)
end
end