468 lines
17 KiB
Ruby
468 lines
17 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require 'spec_helper'
|
|
|
|
RSpec.describe API::Ci::SecureFiles do
|
|
before do
|
|
stub_ci_secure_file_object_storage
|
|
stub_feature_flags(ci_secure_files: true)
|
|
stub_feature_flags(ci_secure_files_read_only: false)
|
|
end
|
|
|
|
let_it_be(:maintainer) { create(:user) }
|
|
let_it_be(:developer) { create(:user) }
|
|
let_it_be(:guest) { create(:user) }
|
|
let_it_be(:anonymous) { create(:user) }
|
|
let_it_be(:unconfirmed) { create(:user, :unconfirmed) }
|
|
let_it_be(:project) { create(:project, creator_id: maintainer.id) }
|
|
let_it_be(:secure_file) { create(:ci_secure_file, project: project) }
|
|
|
|
let(:file_params) do
|
|
{
|
|
file: fixture_file_upload('spec/fixtures/ci_secure_files/upload-keystore.jks'),
|
|
name: 'upload-keystore.jks'
|
|
}
|
|
end
|
|
|
|
before_all do
|
|
project.add_maintainer(maintainer)
|
|
project.add_developer(developer)
|
|
project.add_guest(guest)
|
|
end
|
|
|
|
describe 'GET /projects/:id/secure_files' do
|
|
context 'feature flag' do
|
|
it 'returns a 503 when the feature flag is disabled' do
|
|
stub_feature_flags(ci_secure_files: false)
|
|
|
|
get api("/projects/#{project.id}/secure_files", maintainer)
|
|
|
|
expect(response).to have_gitlab_http_status(:service_unavailable)
|
|
end
|
|
|
|
it 'returns a 200 when the feature flag is enabled' do
|
|
get api("/projects/#{project.id}/secure_files", maintainer)
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(json_response).to be_a(Array)
|
|
end
|
|
end
|
|
|
|
context 'ci_secure_files_read_only feature flag' do
|
|
context 'when the flag is enabled' do
|
|
before do
|
|
stub_feature_flags(ci_secure_files_read_only: true)
|
|
end
|
|
|
|
it 'returns a 503 when attempting to upload a file' do
|
|
stub_feature_flags(ci_secure_files_read_only: true)
|
|
|
|
expect do
|
|
post api("/projects/#{project.id}/secure_files", maintainer), params: file_params
|
|
end.not_to change { project.secure_files.count }
|
|
|
|
expect(response).to have_gitlab_http_status(:service_unavailable)
|
|
end
|
|
|
|
it 'returns a 200 when downloading a file' do
|
|
stub_feature_flags(ci_secure_files_read_only: true)
|
|
|
|
get api("/projects/#{project.id}/secure_files", developer)
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(json_response).to be_a(Array)
|
|
end
|
|
end
|
|
|
|
context 'when the flag is disabled' do
|
|
it 'returns a 201 when uploading a file when the ci_secure_files_read_only feature flag is disabled' do
|
|
expect do
|
|
post api("/projects/#{project.id}/secure_files", maintainer), params: file_params
|
|
end.to change { project.secure_files.count }.by(1)
|
|
|
|
expect(response).to have_gitlab_http_status(:created)
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'authenticated user with admin permissions' do
|
|
it 'returns project secure files' do
|
|
get api("/projects/#{project.id}/secure_files", maintainer)
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(json_response).to be_a(Array)
|
|
end
|
|
end
|
|
|
|
context 'authenticated user with read permissions' do
|
|
it 'returns project secure files' do
|
|
get api("/projects/#{project.id}/secure_files", developer)
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(json_response).to be_a(Array)
|
|
end
|
|
end
|
|
|
|
context 'authenticated user with guest permissions' do
|
|
it 'does not return project secure files' do
|
|
get api("/projects/#{project.id}/secure_files", guest)
|
|
|
|
expect(response).to have_gitlab_http_status(:forbidden)
|
|
end
|
|
end
|
|
|
|
context 'authenticated user with no permissions' do
|
|
it 'does not return project secure files' do
|
|
get api("/projects/#{project.id}/secure_files", anonymous)
|
|
|
|
expect(response).to have_gitlab_http_status(:not_found)
|
|
end
|
|
end
|
|
|
|
context 'unconfirmed user' do
|
|
it 'does not return project secure files' do
|
|
get api("/projects/#{project.id}/secure_files", unconfirmed)
|
|
|
|
expect(response).to have_gitlab_http_status(:not_found)
|
|
end
|
|
end
|
|
|
|
context 'unauthenticated user' do
|
|
it 'does not return project secure files' do
|
|
get api("/projects/#{project.id}/secure_files")
|
|
|
|
expect(response).to have_gitlab_http_status(:unauthorized)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'GET /projects/:id/secure_files/:secure_file_id' do
|
|
context 'authenticated user with admin permissions' do
|
|
it 'returns project secure file details' do
|
|
get api("/projects/#{project.id}/secure_files/#{secure_file.id}", maintainer)
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(json_response['name']).to eq(secure_file.name)
|
|
expect(json_response['expires_at']).to be nil
|
|
expect(json_response['metadata']).to be nil
|
|
end
|
|
|
|
it 'returns project secure file details with metadata when supported' do
|
|
secure_file_with_metadata = create(:ci_secure_file_with_metadata, project: project)
|
|
get api("/projects/#{project.id}/secure_files/#{secure_file_with_metadata.id}", maintainer)
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(json_response['name']).to eq(secure_file_with_metadata.name)
|
|
expect(json_response['expires_at']).to eq('2022-04-26T19:20:40.000Z')
|
|
expect(json_response['metadata'].keys).to match_array(%w[id issuer subject expires_at])
|
|
end
|
|
|
|
it 'responds with 404 Not Found if requesting non-existing secure file' do
|
|
get api("/projects/#{project.id}/secure_files/#{non_existing_record_id}", maintainer)
|
|
|
|
expect(response).to have_gitlab_http_status(:not_found)
|
|
end
|
|
end
|
|
|
|
context 'authenticated user with read permissions' do
|
|
it 'returns project secure file details' do
|
|
get api("/projects/#{project.id}/secure_files/#{secure_file.id}", developer)
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(json_response['name']).to eq(secure_file.name)
|
|
end
|
|
end
|
|
|
|
context 'authenticated user with no permissions' do
|
|
it 'does not return project secure file details' do
|
|
get api("/projects/#{project.id}/secure_files/#{secure_file.id}", anonymous)
|
|
|
|
expect(response).to have_gitlab_http_status(:not_found)
|
|
end
|
|
end
|
|
|
|
context 'unconfirmed user' do
|
|
it 'does not return project secure file details' do
|
|
get api("/projects/#{project.id}/secure_files/#{secure_file.id}", unconfirmed)
|
|
|
|
expect(response).to have_gitlab_http_status(:not_found)
|
|
end
|
|
end
|
|
|
|
context 'unauthenticated user' do
|
|
it 'does not return project secure file details' do
|
|
get api("/projects/#{project.id}/secure_files/#{secure_file.id}")
|
|
|
|
expect(response).to have_gitlab_http_status(:unauthorized)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'GET /projects/:id/secure_files/:secure_file_id/download' do
|
|
context 'authenticated user with admin permissions' do
|
|
it 'returns a secure file' do
|
|
sample_file = fixture_file('ci_secure_files/upload-keystore.jks')
|
|
secure_file.file = CarrierWaveStringFile.new(sample_file)
|
|
secure_file.save!
|
|
|
|
get api("/projects/#{project.id}/secure_files/#{secure_file.id}/download", maintainer)
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(Base64.encode64(response.body)).to eq(Base64.encode64(sample_file))
|
|
end
|
|
|
|
it 'responds with 404 Not Found if requesting non-existing secure file' do
|
|
get api("/projects/#{project.id}/secure_files/#{non_existing_record_id}/download", maintainer)
|
|
|
|
expect(response).to have_gitlab_http_status(:not_found)
|
|
end
|
|
end
|
|
|
|
context 'authenticated user with read permissions' do
|
|
it 'returns a secure file' do
|
|
sample_file = fixture_file('ci_secure_files/upload-keystore.jks')
|
|
secure_file.file = CarrierWaveStringFile.new(sample_file)
|
|
secure_file.save!
|
|
|
|
get api("/projects/#{project.id}/secure_files/#{secure_file.id}/download", developer)
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(Base64.encode64(response.body)).to eq(Base64.encode64(sample_file))
|
|
end
|
|
end
|
|
|
|
context 'authenticated user with no permissions' do
|
|
it 'does not return project secure file details' do
|
|
get api("/projects/#{project.id}/secure_files/#{secure_file.id}/download", anonymous)
|
|
|
|
expect(response).to have_gitlab_http_status(:not_found)
|
|
end
|
|
end
|
|
|
|
context 'unconfirmed user' do
|
|
it 'does not return project secure file details' do
|
|
get api("/projects/#{project.id}/secure_files/#{secure_file.id}/download", unconfirmed)
|
|
|
|
expect(response).to have_gitlab_http_status(:not_found)
|
|
end
|
|
end
|
|
|
|
context 'unauthenticated user' do
|
|
it 'does not return project secure file details' do
|
|
get api("/projects/#{project.id}/secure_files/#{secure_file.id}/download")
|
|
|
|
expect(response).to have_gitlab_http_status(:unauthorized)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'POST /projects/:id/secure_files' do
|
|
context 'authenticated user with admin permissions' do
|
|
it 'creates a secure file' do
|
|
expect do
|
|
post api("/projects/#{project.id}/secure_files", maintainer), params: file_params
|
|
end.to change { project.secure_files.count }.by(1)
|
|
|
|
expect(response).to have_gitlab_http_status(:created)
|
|
expect(json_response['name']).to eq('upload-keystore.jks')
|
|
expect(json_response['checksum']).to eq(secure_file.checksum)
|
|
expect(json_response['checksum_algorithm']).to eq('sha256')
|
|
|
|
secure_file = Ci::SecureFile.find(json_response['id'])
|
|
expect(secure_file.checksum).to eq(
|
|
Digest::SHA256.hexdigest(fixture_file('ci_secure_files/upload-keystore.jks'))
|
|
)
|
|
expect(json_response['id']).to eq(secure_file.id)
|
|
expect(Time.parse(json_response['created_at'])).to be_like_time(secure_file.created_at)
|
|
end
|
|
|
|
it 'uploads and downloads a secure file' do
|
|
post api("/projects/#{project.id}/secure_files", maintainer), params: file_params
|
|
|
|
secure_file_id = json_response['id']
|
|
|
|
get api("/projects/#{project.id}/secure_files/#{secure_file_id}/download", maintainer)
|
|
|
|
expect(Base64.encode64(response.body)).to eq(Base64.encode64(fixture_file_upload('spec/fixtures/ci_secure_files/upload-keystore.jks').read))
|
|
end
|
|
|
|
it 'returns an error when the file checksum fails to validate' do
|
|
secure_file.update!(checksum: 'foo')
|
|
|
|
expect do
|
|
get api("/projects/#{project.id}/secure_files/#{secure_file.id}/download", maintainer)
|
|
end.not_to change { project.secure_files.count }
|
|
|
|
expect(response.code).to eq("500")
|
|
end
|
|
|
|
it 'returns an error when no file is uploaded' do
|
|
expect do
|
|
post api("/projects/#{project.id}/secure_files", maintainer), params: { name: 'upload-keystore.jks' }
|
|
end.not_to change { project.secure_files.count }
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
expect(json_response['error']).to eq('file is missing')
|
|
end
|
|
|
|
it 'returns an error when the file name is missing' do
|
|
expect do
|
|
post api("/projects/#{project.id}/secure_files", maintainer), params: { file: fixture_file_upload('spec/fixtures/ci_secure_files/upload-keystore.jks') }
|
|
end.not_to change { project.secure_files.count }
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
expect(json_response['error']).to eq('name is missing')
|
|
end
|
|
|
|
it 'returns an error when the file name has already been used' do
|
|
post_params = {
|
|
name: secure_file.name,
|
|
file: fixture_file_upload('spec/fixtures/ci_secure_files/upload-keystore.jks')
|
|
}
|
|
|
|
expect do
|
|
post api("/projects/#{project.id}/secure_files", maintainer), params: post_params
|
|
end.not_to change { project.secure_files.count }
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
expect(json_response['message']['name']).to include('has already been taken')
|
|
end
|
|
|
|
it 'returns an error when an unexpected validation failure happens' do
|
|
allow_next_instance_of(Ci::SecureFile) do |instance|
|
|
allow(instance).to receive(:valid?).and_return(false)
|
|
allow(instance).to receive_message_chain(:errors, :any?).and_return(true)
|
|
allow(instance).to receive_message_chain(:errors, :messages).and_return(['Error 1', 'Error 2'])
|
|
end
|
|
|
|
expect do
|
|
post api("/projects/#{project.id}/secure_files", maintainer), params: file_params
|
|
end.not_to change { project.secure_files.count }
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
end
|
|
|
|
it 'returns a 413 error when the file size is too large' do
|
|
allow_next_instance_of(Ci::SecureFile) do |instance|
|
|
allow(instance).to receive_message_chain(:file, :size).and_return(6.megabytes.to_i)
|
|
end
|
|
|
|
expect do
|
|
post api("/projects/#{project.id}/secure_files", maintainer), params: file_params
|
|
end.not_to change { project.secure_files.count }
|
|
|
|
expect(response).to have_gitlab_http_status(:payload_too_large)
|
|
end
|
|
|
|
it 'returns an error when and invalid file name is supplied' do
|
|
params = file_params.merge(name: '../../upload-keystore.jks')
|
|
expect do
|
|
post api("/projects/#{project.id}/secure_files", maintainer), params: params
|
|
end.not_to change { project.secure_files.count }
|
|
|
|
expect(response).to have_gitlab_http_status(:internal_server_error)
|
|
end
|
|
end
|
|
|
|
context 'authenticated user with read permissions' do
|
|
it 'does not create a secure file' do
|
|
expect do
|
|
post api("/projects/#{project.id}/secure_files", developer)
|
|
end.not_to change { project.secure_files.count }
|
|
|
|
expect(response).to have_gitlab_http_status(:forbidden)
|
|
end
|
|
end
|
|
|
|
context 'authenticated user with no permissions' do
|
|
it 'does not create a secure file' do
|
|
expect do
|
|
post api("/projects/#{project.id}/secure_files", anonymous)
|
|
end.not_to change { project.secure_files.count }
|
|
|
|
expect(response).to have_gitlab_http_status(:not_found)
|
|
end
|
|
end
|
|
|
|
context 'unconfirmed user' do
|
|
it 'does not create a secure file' do
|
|
expect do
|
|
post api("/projects/#{project.id}/secure_files", unconfirmed)
|
|
end.not_to change { project.secure_files.count }
|
|
|
|
expect(response).to have_gitlab_http_status(:not_found)
|
|
end
|
|
end
|
|
|
|
context 'unauthenticated user' do
|
|
it 'does not create a secure file' do
|
|
expect do
|
|
post api("/projects/#{project.id}/secure_files")
|
|
end.not_to change { project.secure_files.count }
|
|
|
|
expect(response).to have_gitlab_http_status(:unauthorized)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'DELETE /projects/:id/secure_files/:secure_file_id' do
|
|
context 'authenticated user with admin permissions' do
|
|
it 'deletes the secure file' do
|
|
expect do
|
|
delete api("/projects/#{project.id}/secure_files/#{secure_file.id}", maintainer)
|
|
|
|
expect(response).to have_gitlab_http_status(:no_content)
|
|
end.to change { project.secure_files.count }
|
|
end
|
|
|
|
it 'responds with 404 Not Found if requesting non-existing secure_file' do
|
|
expect do
|
|
delete api("/projects/#{project.id}/secure_files/#{non_existing_record_id}", maintainer)
|
|
end.not_to change { project.secure_files.count }
|
|
|
|
expect(response).to have_gitlab_http_status(:not_found)
|
|
end
|
|
end
|
|
|
|
context 'authenticated user with read permissions' do
|
|
it 'does not delete the secure_file' do
|
|
expect do
|
|
delete api("/projects/#{project.id}/secure_files/#{secure_file.id}", developer)
|
|
end.not_to change { project.secure_files.count }
|
|
|
|
expect(response).to have_gitlab_http_status(:forbidden)
|
|
end
|
|
end
|
|
|
|
context 'authenticated user with no permissions' do
|
|
it 'does not delete the secure_file' do
|
|
expect do
|
|
delete api("/projects/#{project.id}/secure_files/#{secure_file.id}", anonymous)
|
|
end.not_to change { project.secure_files.count }
|
|
|
|
expect(response).to have_gitlab_http_status(:not_found)
|
|
end
|
|
end
|
|
|
|
context 'unconfirmed user' do
|
|
it 'does not delete the secure_file' do
|
|
expect do
|
|
delete api("/projects/#{project.id}/secure_files#{secure_file.id}", unconfirmed)
|
|
end.not_to change { project.secure_files.count }
|
|
|
|
expect(response).to have_gitlab_http_status(:not_found)
|
|
end
|
|
end
|
|
|
|
context 'unauthenticated user' do
|
|
it 'does not delete the secure_file' do
|
|
expect do
|
|
delete api("/projects/#{project.id}/secure_files/#{secure_file.id}")
|
|
end.not_to change { project.secure_files.count }
|
|
|
|
expect(response).to have_gitlab_http_status(:unauthorized)
|
|
end
|
|
end
|
|
end
|
|
end
|