912 lines
31 KiB
Ruby
912 lines
31 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require 'spec_helper'
|
|
|
|
RSpec.describe API::Files do
|
|
include RepoHelpers
|
|
|
|
let(:user) { create(:user) }
|
|
let!(:project) { create(:project, :repository, namespace: user.namespace ) }
|
|
let(:guest) { create(:user) { |u| project.add_guest(u) } }
|
|
let(:file_path) { "files%2Fruby%2Fpopen%2Erb" }
|
|
let(:rouge_file_path) { "%2e%2e%2f" }
|
|
let(:absolute_path) { "%2Fetc%2Fpasswd.rb" }
|
|
let(:invalid_file_message) { 'file_path should be a valid file path' }
|
|
let(:params) do
|
|
{
|
|
ref: 'master'
|
|
}
|
|
end
|
|
|
|
let(:author_email) { 'user@example.org' }
|
|
let(:author_name) { 'John Doe' }
|
|
|
|
let(:helper) do
|
|
fake_class = Class.new do
|
|
include ::API::Helpers::HeadersHelpers
|
|
|
|
attr_reader :headers
|
|
|
|
def initialize
|
|
@headers = {}
|
|
end
|
|
|
|
def header(key, value)
|
|
@headers[key] = value
|
|
end
|
|
end
|
|
|
|
fake_class.new
|
|
end
|
|
|
|
before do
|
|
project.add_developer(user)
|
|
end
|
|
|
|
def route(file_path = nil)
|
|
"/projects/#{project.id}/repository/files/#{file_path}"
|
|
end
|
|
|
|
context 'http headers' do
|
|
it 'converts value into string' do
|
|
helper.set_http_headers(test: 1)
|
|
|
|
expect(helper.headers).to eq({ 'X-Gitlab-Test' => '1' })
|
|
end
|
|
|
|
it 'raises exception if value is an Enumerable' do
|
|
expect { helper.set_http_headers(test: [1]) }.to raise_error(ArgumentError)
|
|
end
|
|
end
|
|
|
|
shared_examples 'when path is absolute' do
|
|
it 'returns 400 when file path is absolute' do
|
|
subject
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
|
|
if response.body.present?
|
|
expect(json_response['error']).to eq(invalid_file_message)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe "HEAD /projects/:id/repository/files/:file_path" do
|
|
shared_examples_for 'repository files' do
|
|
let(:options) { {} }
|
|
|
|
it 'returns 400 when file path is invalid' do
|
|
head api(route(rouge_file_path), current_user, **options), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
end
|
|
|
|
it_behaves_like 'when path is absolute' do
|
|
subject { head api(route(absolute_path), current_user, **options), params: params }
|
|
end
|
|
|
|
it 'returns file attributes in headers' do
|
|
head api(route(file_path), current_user, **options), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(response.headers['X-Gitlab-File-Path']).to eq(CGI.unescape(file_path))
|
|
expect(response.headers['X-Gitlab-File-Name']).to eq('popen.rb')
|
|
expect(response.headers['X-Gitlab-Last-Commit-Id']).to eq('570e7b2abdd848b95f2f578043fc23bd6f6fd24d')
|
|
expect(response.headers['X-Gitlab-Content-Sha256']).to eq('c440cd09bae50c4632cc58638ad33c6aa375b6109d811e76a9cc3a613c1e8887')
|
|
end
|
|
|
|
it 'returns file by commit sha' do
|
|
# This file is deleted on HEAD
|
|
file_path = "files%2Fjs%2Fcommit%2Ejs%2Ecoffee"
|
|
params[:ref] = "6f6d7e7ed97bb5f0054f2b1df789b39ca89b6ff9"
|
|
|
|
head api(route(file_path), current_user, **options), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(response.headers['X-Gitlab-File-Name']).to eq('commit.js.coffee')
|
|
expect(response.headers['X-Gitlab-Content-Sha256']).to eq('08785f04375b47f81f46e68cc125d5ef368aa20576ddb53f91f4d83f1d04b929')
|
|
end
|
|
|
|
context 'when mandatory params are not given' do
|
|
it "responds with a 400 status" do
|
|
head api(route("any%2Ffile"), current_user, **options)
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
end
|
|
end
|
|
|
|
context 'when file_path does not exist' do
|
|
it "responds with a 404 status" do
|
|
params[:ref] = 'master'
|
|
|
|
head api(route('app%2Fmodels%2Fapplication%2Erb'), current_user, **options), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:not_found)
|
|
end
|
|
end
|
|
|
|
context 'when file_path does not exist' do
|
|
include_context 'disabled repository'
|
|
|
|
it "responds with a 403 status" do
|
|
head api(route(file_path), current_user, **options), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:forbidden)
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'when unauthenticated', 'and project is public' do
|
|
it_behaves_like 'repository files' do
|
|
let(:project) { create(:project, :public, :repository) }
|
|
let(:current_user) { nil }
|
|
end
|
|
end
|
|
|
|
context 'when unauthenticated', 'and project is private' do
|
|
it "responds with a 404 status" do
|
|
current_user = nil
|
|
|
|
head api(route(file_path), current_user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:not_found)
|
|
end
|
|
end
|
|
|
|
context 'when PATs are used' do
|
|
it_behaves_like 'repository files' do
|
|
let(:token) { create(:personal_access_token, scopes: ['read_repository'], user: user) }
|
|
let(:current_user) { nil }
|
|
let(:options) { { personal_access_token: token } }
|
|
end
|
|
end
|
|
|
|
context 'when authenticated', 'as a developer' do
|
|
it_behaves_like 'repository files' do
|
|
let(:current_user) { user }
|
|
end
|
|
end
|
|
|
|
context 'when authenticated', 'as a guest' do
|
|
it_behaves_like '403 response' do
|
|
let(:request) { head api(route(file_path), guest), params: params }
|
|
end
|
|
end
|
|
end
|
|
|
|
describe "GET /projects/:id/repository/files/:file_path" do
|
|
shared_examples_for 'repository files' do
|
|
let(:options) { {} }
|
|
|
|
it 'returns 400 for invalid file path' do
|
|
get api(route(rouge_file_path), api_user, **options), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
expect(json_response['error']).to eq(invalid_file_message)
|
|
end
|
|
|
|
it_behaves_like 'when path is absolute' do
|
|
subject { get api(route(absolute_path), api_user, **options), params: params }
|
|
end
|
|
|
|
it 'returns file attributes as json' do
|
|
get api(route(file_path), api_user, **options), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(json_response['file_path']).to eq(CGI.unescape(file_path))
|
|
expect(json_response['file_name']).to eq('popen.rb')
|
|
expect(json_response['last_commit_id']).to eq('570e7b2abdd848b95f2f578043fc23bd6f6fd24d')
|
|
expect(json_response['content_sha256']).to eq('c440cd09bae50c4632cc58638ad33c6aa375b6109d811e76a9cc3a613c1e8887')
|
|
expect(Base64.decode64(json_response['content']).lines.first).to eq("require 'fileutils'\n")
|
|
end
|
|
|
|
it 'returns json when file has txt extension' do
|
|
file_path = "bar%2Fbranch-test.txt"
|
|
|
|
get api(route(file_path), api_user, **options), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(response.media_type).to eq('application/json')
|
|
end
|
|
|
|
context 'with filename with pathspec characters' do
|
|
let(:file_path) { ':wq' }
|
|
let(:newrev) { project.repository.commit('master').sha }
|
|
|
|
before do
|
|
create_file_in_repo(project, 'master', 'master', file_path, 'Test file')
|
|
end
|
|
|
|
it 'returns JSON wth commit SHA' do
|
|
params[:ref] = 'master'
|
|
|
|
get api(route(file_path), api_user, **options), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(json_response['file_path']).to eq(file_path)
|
|
expect(json_response['file_name']).to eq(file_path)
|
|
expect(json_response['last_commit_id']).to eq(newrev)
|
|
end
|
|
end
|
|
|
|
it 'returns file by commit sha' do
|
|
# This file is deleted on HEAD
|
|
file_path = "files%2Fjs%2Fcommit%2Ejs%2Ecoffee"
|
|
params[:ref] = "6f6d7e7ed97bb5f0054f2b1df789b39ca89b6ff9"
|
|
|
|
get api(route(file_path), api_user, **options), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(json_response['file_name']).to eq('commit.js.coffee')
|
|
expect(json_response['content_sha256']).to eq('08785f04375b47f81f46e68cc125d5ef368aa20576ddb53f91f4d83f1d04b929')
|
|
expect(Base64.decode64(json_response['content']).lines.first).to eq("class Commit\n")
|
|
end
|
|
|
|
it 'returns raw file info' do
|
|
url = route(file_path) + "/raw"
|
|
expect(Gitlab::Workhorse).to receive(:send_git_blob)
|
|
|
|
get api(url, api_user, **options), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(headers[Gitlab::Workhorse::DETECT_HEADER]).to eq "true"
|
|
end
|
|
|
|
it 'returns blame file info' do
|
|
url = route(file_path) + '/blame'
|
|
|
|
get api(url, api_user, **options), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
end
|
|
|
|
it 'sets inline content disposition by default' do
|
|
url = route(file_path) + "/raw"
|
|
|
|
get api(url, api_user, **options), params: params
|
|
|
|
expect(headers['Content-Disposition']).to eq(%q(inline; filename="popen.rb"; filename*=UTF-8''popen.rb))
|
|
end
|
|
|
|
context 'when mandatory params are not given' do
|
|
it_behaves_like '400 response' do
|
|
let(:request) { get api(route("any%2Ffile"), current_user, **options) }
|
|
end
|
|
end
|
|
|
|
context 'when file_path does not exist' do
|
|
let(:params) { { ref: 'master' } }
|
|
|
|
it_behaves_like '404 response' do
|
|
let(:request) { get api(route('app%2Fmodels%2Fapplication%2Erb'), api_user, **options), params: params }
|
|
let(:message) { '404 File Not Found' }
|
|
end
|
|
end
|
|
|
|
context 'when repository is disabled' do
|
|
include_context 'disabled repository'
|
|
|
|
it_behaves_like '403 response' do
|
|
let(:request) { get api(route(file_path), api_user, **options), params: params }
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'when unauthenticated', 'and project is public' do
|
|
it_behaves_like 'repository files' do
|
|
let(:project) { create(:project, :public, :repository) }
|
|
let(:current_user) { nil }
|
|
let(:api_user) { nil }
|
|
end
|
|
end
|
|
|
|
context 'when PATs are used' do
|
|
it_behaves_like 'repository files' do
|
|
let(:token) { create(:personal_access_token, scopes: ['read_repository'], user: user) }
|
|
let(:current_user) { user }
|
|
let(:api_user) { nil }
|
|
let(:options) { { personal_access_token: token } }
|
|
end
|
|
end
|
|
|
|
context 'when unauthenticated', 'and project is private' do
|
|
it_behaves_like '404 response' do
|
|
let(:request) { get api(route(file_path)), params: params }
|
|
let(:message) { '404 Project Not Found' }
|
|
end
|
|
end
|
|
|
|
context 'when authenticated', 'as a developer' do
|
|
it_behaves_like 'repository files' do
|
|
let(:current_user) { user }
|
|
let(:api_user) { user }
|
|
end
|
|
end
|
|
|
|
context 'when authenticated', 'as a guest' do
|
|
it_behaves_like '403 response' do
|
|
let(:request) { get api(route(file_path), guest), params: params }
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'GET /projects/:id/repository/files/:file_path/blame' do
|
|
shared_examples_for 'repository blame files' do
|
|
let(:expected_blame_range_sizes) do
|
|
[3, 2, 1, 2, 1, 1, 1, 1, 8, 1, 3, 1, 2, 1, 4, 1, 2, 2]
|
|
end
|
|
|
|
let(:expected_blame_range_commit_ids) do
|
|
%w[
|
|
913c66a37b4a45b9769037c55c2d238bd0942d2e
|
|
874797c3a73b60d2187ed6e2fcabd289ff75171e
|
|
913c66a37b4a45b9769037c55c2d238bd0942d2e
|
|
874797c3a73b60d2187ed6e2fcabd289ff75171e
|
|
570e7b2abdd848b95f2f578043fc23bd6f6fd24d
|
|
874797c3a73b60d2187ed6e2fcabd289ff75171e
|
|
913c66a37b4a45b9769037c55c2d238bd0942d2e
|
|
874797c3a73b60d2187ed6e2fcabd289ff75171e
|
|
570e7b2abdd848b95f2f578043fc23bd6f6fd24d
|
|
913c66a37b4a45b9769037c55c2d238bd0942d2e
|
|
874797c3a73b60d2187ed6e2fcabd289ff75171e
|
|
913c66a37b4a45b9769037c55c2d238bd0942d2e
|
|
874797c3a73b60d2187ed6e2fcabd289ff75171e
|
|
570e7b2abdd848b95f2f578043fc23bd6f6fd24d
|
|
874797c3a73b60d2187ed6e2fcabd289ff75171e
|
|
913c66a37b4a45b9769037c55c2d238bd0942d2e
|
|
874797c3a73b60d2187ed6e2fcabd289ff75171e
|
|
913c66a37b4a45b9769037c55c2d238bd0942d2e
|
|
]
|
|
end
|
|
|
|
it 'returns file attributes in headers' do
|
|
head api(route(file_path) + '/blame', current_user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(response.headers['X-Gitlab-File-Path']).to eq(CGI.unescape(file_path))
|
|
expect(response.headers['X-Gitlab-File-Name']).to eq('popen.rb')
|
|
expect(response.headers['X-Gitlab-Last-Commit-Id']).to eq('570e7b2abdd848b95f2f578043fc23bd6f6fd24d')
|
|
expect(response.headers['X-Gitlab-Content-Sha256'])
|
|
.to eq('c440cd09bae50c4632cc58638ad33c6aa375b6109d811e76a9cc3a613c1e8887')
|
|
end
|
|
|
|
it 'returns 400 when file path is invalid' do
|
|
get api(route(rouge_file_path) + '/blame', current_user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
expect(json_response['error']).to eq(invalid_file_message)
|
|
end
|
|
|
|
it_behaves_like 'when path is absolute' do
|
|
subject { get api(route(absolute_path) + '/blame', current_user), params: params }
|
|
end
|
|
|
|
it 'returns blame file attributes as json' do
|
|
get api(route(file_path) + '/blame', current_user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(json_response.map { |x| x['lines'].size }).to eq(expected_blame_range_sizes)
|
|
expect(json_response.map { |x| x['commit']['id'] }).to eq(expected_blame_range_commit_ids)
|
|
range = json_response[0]
|
|
expect(range['lines']).to eq(["require 'fileutils'", "require 'open3'", ''])
|
|
expect(range['commit']['id']).to eq('913c66a37b4a45b9769037c55c2d238bd0942d2e')
|
|
expect(range['commit']['parent_ids']).to eq(['cfe32cf61b73a0d5e9f13e774abde7ff789b1660'])
|
|
expect(range['commit']['message'])
|
|
.to eq("Files, encoding and much more\n\nSigned-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>\n")
|
|
|
|
expect(range['commit']['authored_date']).to eq('2014-02-27T10:14:56.000+02:00')
|
|
expect(range['commit']['author_name']).to eq('Dmitriy Zaporozhets')
|
|
expect(range['commit']['author_email']).to eq('dmitriy.zaporozhets@gmail.com')
|
|
|
|
expect(range['commit']['committed_date']).to eq('2014-02-27T10:14:56.000+02:00')
|
|
expect(range['commit']['committer_name']).to eq('Dmitriy Zaporozhets')
|
|
expect(range['commit']['committer_email']).to eq('dmitriy.zaporozhets@gmail.com')
|
|
end
|
|
|
|
it 'returns blame file info for files with dots' do
|
|
url = route('.gitignore') + '/blame'
|
|
|
|
get api(url, current_user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
end
|
|
|
|
it 'returns file by commit sha' do
|
|
# This file is deleted on HEAD
|
|
file_path = 'files%2Fjs%2Fcommit%2Ejs%2Ecoffee'
|
|
params[:ref] = '6f6d7e7ed97bb5f0054f2b1df789b39ca89b6ff9'
|
|
|
|
get api(route(file_path) + '/blame', current_user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
end
|
|
|
|
context 'when mandatory params are not given' do
|
|
it_behaves_like '400 response' do
|
|
let(:request) { get api(route('any%2Ffile/blame'), current_user) }
|
|
end
|
|
end
|
|
|
|
context 'when file_path does not exist' do
|
|
let(:params) { { ref: 'master' } }
|
|
|
|
it_behaves_like '404 response' do
|
|
let(:request) { get api(route('app%2Fmodels%2Fapplication%2Erb/blame'), current_user), params: params }
|
|
let(:message) { '404 File Not Found' }
|
|
end
|
|
end
|
|
|
|
context 'when commit does not exist' do
|
|
let(:params) { { ref: '1111111111111111111111111111111111111111' } }
|
|
|
|
it_behaves_like '404 response' do
|
|
let(:request) { get api(route(file_path + '/blame'), current_user), params: params }
|
|
let(:message) { '404 Commit Not Found' }
|
|
end
|
|
end
|
|
|
|
context 'when repository is disabled' do
|
|
include_context 'disabled repository'
|
|
|
|
it_behaves_like '403 response' do
|
|
let(:request) { get api(route(file_path + '/blame'), current_user), params: params }
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'when unauthenticated', 'and project is public' do
|
|
it_behaves_like 'repository blame files' do
|
|
let(:project) { create(:project, :public, :repository) }
|
|
let(:current_user) { nil }
|
|
end
|
|
end
|
|
|
|
context 'when unauthenticated', 'and project is private' do
|
|
it_behaves_like '404 response' do
|
|
let(:request) { get api(route(file_path)), params: params }
|
|
let(:message) { '404 Project Not Found' }
|
|
end
|
|
end
|
|
|
|
context 'when authenticated', 'as a developer' do
|
|
it_behaves_like 'repository blame files' do
|
|
let(:current_user) { user }
|
|
end
|
|
end
|
|
|
|
context 'when authenticated', 'as a guest' do
|
|
it_behaves_like '403 response' do
|
|
let(:request) { get api(route(file_path) + '/blame', guest), params: params }
|
|
end
|
|
end
|
|
|
|
context 'when PATs are used' do
|
|
it 'returns blame file by commit sha' do
|
|
token = create(:personal_access_token, scopes: ['read_repository'], user: user)
|
|
|
|
# This file is deleted on HEAD
|
|
file_path = 'files%2Fjs%2Fcommit%2Ejs%2Ecoffee'
|
|
params[:ref] = '6f6d7e7ed97bb5f0054f2b1df789b39ca89b6ff9'
|
|
|
|
get api(route(file_path) + '/blame', personal_access_token: token), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe "GET /projects/:id/repository/files/:file_path/raw" do
|
|
shared_examples_for 'repository raw files' do
|
|
it 'returns 400 when file path is invalid' do
|
|
get api(route(rouge_file_path) + "/raw", current_user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
expect(json_response['error']).to eq(invalid_file_message)
|
|
end
|
|
|
|
it_behaves_like 'when path is absolute' do
|
|
subject { get api(route(absolute_path) + '/raw', current_user), params: params }
|
|
end
|
|
|
|
it 'returns raw file info' do
|
|
url = route(file_path) + "/raw"
|
|
expect(Gitlab::Workhorse).to receive(:send_git_blob)
|
|
|
|
get api(url, current_user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
end
|
|
|
|
context 'when ref is not provided' do
|
|
before do
|
|
stub_application_setting(default_branch_name: 'main')
|
|
end
|
|
|
|
it 'returns response :ok', :aggregate_failures do
|
|
url = route(file_path) + "/raw"
|
|
expect(Gitlab::Workhorse).to receive(:send_git_blob)
|
|
|
|
get api(url, current_user), params: {}
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
end
|
|
end
|
|
|
|
it 'returns raw file info for files with dots' do
|
|
url = route('.gitignore') + "/raw"
|
|
expect(Gitlab::Workhorse).to receive(:send_git_blob)
|
|
|
|
get api(url, current_user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
end
|
|
|
|
it 'returns file by commit sha' do
|
|
# This file is deleted on HEAD
|
|
file_path = "files%2Fjs%2Fcommit%2Ejs%2Ecoffee"
|
|
params[:ref] = "6f6d7e7ed97bb5f0054f2b1df789b39ca89b6ff9"
|
|
expect(Gitlab::Workhorse).to receive(:send_git_blob)
|
|
|
|
get api(route(file_path) + "/raw", current_user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
end
|
|
|
|
it 'sets no-cache headers' do
|
|
url = route('.gitignore') + "/raw"
|
|
expect(Gitlab::Workhorse).to receive(:send_git_blob)
|
|
|
|
get api(url, current_user), params: params
|
|
|
|
expect(response.headers["Cache-Control"]).to eq("max-age=0, private, must-revalidate, no-store, no-cache")
|
|
expect(response.headers["Pragma"]).to eq("no-cache")
|
|
expect(response.headers["Expires"]).to eq("Fri, 01 Jan 1990 00:00:00 GMT")
|
|
end
|
|
|
|
context 'when mandatory params are not given' do
|
|
it_behaves_like '400 response' do
|
|
let(:request) { get api(route("any%2Ffile"), current_user) }
|
|
end
|
|
end
|
|
|
|
context 'when file_path does not exist' do
|
|
let(:params) { { ref: 'master' } }
|
|
|
|
it_behaves_like '404 response' do
|
|
let(:request) { get api(route('app%2Fmodels%2Fapplication%2Erb'), current_user), params: params }
|
|
let(:message) { '404 File Not Found' }
|
|
end
|
|
end
|
|
|
|
context 'when repository is disabled' do
|
|
include_context 'disabled repository'
|
|
|
|
it_behaves_like '403 response' do
|
|
let(:request) { get api(route(file_path), current_user), params: params }
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'when unauthenticated', 'and project is public' do
|
|
it_behaves_like 'repository raw files' do
|
|
let(:project) { create(:project, :public, :repository) }
|
|
let(:current_user) { nil }
|
|
end
|
|
end
|
|
|
|
context 'when unauthenticated', 'and project is private' do
|
|
it_behaves_like '404 response' do
|
|
let(:request) { get api(route(file_path)), params: params }
|
|
let(:message) { '404 Project Not Found' }
|
|
end
|
|
end
|
|
|
|
context 'when authenticated', 'as a developer' do
|
|
it_behaves_like 'repository raw files' do
|
|
let(:current_user) { user }
|
|
end
|
|
end
|
|
|
|
context 'when authenticated', 'as a guest' do
|
|
it_behaves_like '403 response' do
|
|
let(:request) { get api(route(file_path), guest), params: params }
|
|
end
|
|
end
|
|
|
|
context 'when PATs are used' do
|
|
it 'returns file by commit sha' do
|
|
token = create(:personal_access_token, scopes: ['read_repository'], user: user)
|
|
|
|
# This file is deleted on HEAD
|
|
file_path = "files%2Fjs%2Fcommit%2Ejs%2Ecoffee"
|
|
params[:ref] = "6f6d7e7ed97bb5f0054f2b1df789b39ca89b6ff9"
|
|
expect(Gitlab::Workhorse).to receive(:send_git_blob)
|
|
|
|
get api(route(file_path) + "/raw", personal_access_token: token), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe "POST /projects/:id/repository/files/:file_path" do
|
|
let!(:file_path) { "new_subfolder%2Fnewfile%2Erb" }
|
|
let(:params) do
|
|
{
|
|
branch: "master",
|
|
content: "puts 8",
|
|
commit_message: "Added newfile"
|
|
}
|
|
end
|
|
|
|
it 'returns 400 when file path is invalid' do
|
|
post api(route(rouge_file_path), user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
expect(json_response['error']).to eq(invalid_file_message)
|
|
end
|
|
|
|
it_behaves_like 'when path is absolute' do
|
|
subject { post api(route(absolute_path), user), params: params }
|
|
end
|
|
|
|
it "creates a new file in project repo" do
|
|
post api(route(file_path), user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:created)
|
|
expect(json_response["file_path"]).to eq(CGI.unescape(file_path))
|
|
last_commit = project.repository.commit.raw
|
|
expect(last_commit.author_email).to eq(user.email)
|
|
expect(last_commit.author_name).to eq(user.name)
|
|
end
|
|
|
|
it "returns a 400 bad request if no mandatory params given" do
|
|
post api(route("any%2Etxt"), user)
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
end
|
|
|
|
it 'returns a 400 bad request if the commit message is empty' do
|
|
params[:commit_message] = ''
|
|
|
|
post api(route(file_path), user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
end
|
|
|
|
it "returns a 400 if editor fails to create file" do
|
|
allow_next_instance_of(Repository) do |instance|
|
|
allow(instance).to receive(:create_file).and_raise(Gitlab::Git::CommitError, 'Cannot create file')
|
|
end
|
|
|
|
post api(route("any%2Etxt"), user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
end
|
|
|
|
context 'with PATs' do
|
|
it 'returns 403 with `read_repository` scope' do
|
|
token = create(:personal_access_token, scopes: ['read_repository'], user: user)
|
|
|
|
post api(route(file_path), personal_access_token: token), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:forbidden)
|
|
end
|
|
|
|
it 'returns 201 with `api` scope' do
|
|
token = create(:personal_access_token, scopes: ['api'], user: user)
|
|
|
|
post api(route(file_path), personal_access_token: token), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:created)
|
|
end
|
|
end
|
|
|
|
context "when specifying an author" do
|
|
it "creates a new file with the specified author" do
|
|
params.merge!(author_email: author_email, author_name: author_name)
|
|
|
|
post api(route("new_file_with_author%2Etxt"), user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:created)
|
|
expect(response.media_type).to eq('application/json')
|
|
last_commit = project.repository.commit.raw
|
|
expect(last_commit.author_email).to eq(author_email)
|
|
expect(last_commit.author_name).to eq(author_name)
|
|
end
|
|
end
|
|
|
|
context 'when the repo is empty' do
|
|
let!(:project) { create(:project_empty_repo, namespace: user.namespace ) }
|
|
|
|
it "creates a new file in project repo" do
|
|
post api(route("newfile%2Erb"), user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:created)
|
|
expect(json_response['file_path']).to eq('newfile.rb')
|
|
last_commit = project.repository.commit.raw
|
|
expect(last_commit.author_email).to eq(user.email)
|
|
expect(last_commit.author_name).to eq(user.name)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe "PUT /projects/:id/repository/files" do
|
|
let(:params) do
|
|
{
|
|
branch: 'master',
|
|
content: 'puts 8',
|
|
commit_message: 'Changed file'
|
|
}
|
|
end
|
|
|
|
it "updates existing file in project repo" do
|
|
put api(route(file_path), user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(json_response['file_path']).to eq(CGI.unescape(file_path))
|
|
last_commit = project.repository.commit.raw
|
|
expect(last_commit.author_email).to eq(user.email)
|
|
expect(last_commit.author_name).to eq(user.name)
|
|
end
|
|
|
|
it 'returns a 400 bad request if the commit message is empty' do
|
|
params[:commit_message] = ''
|
|
|
|
put api(route(file_path), user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
end
|
|
|
|
it "returns a 400 bad request if update existing file with stale last commit id" do
|
|
params_with_stale_id = params.merge(last_commit_id: 'stale')
|
|
|
|
put api(route(file_path), user), params: params_with_stale_id
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
expect(json_response['message']).to eq(_('You are attempting to update a file that has changed since you started editing it.'))
|
|
end
|
|
|
|
it "updates existing file in project repo with accepts correct last commit id" do
|
|
last_commit = Gitlab::Git::Commit
|
|
.last_for_path(project.repository, 'master', Addressable::URI.unencode_component(file_path))
|
|
params_with_correct_id = params.merge(last_commit_id: last_commit.id)
|
|
|
|
put api(route(file_path), user), params: params_with_correct_id
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
end
|
|
|
|
it "returns 400 when file path is invalid" do
|
|
last_commit = Gitlab::Git::Commit
|
|
.last_for_path(project.repository, 'master', Addressable::URI.unencode_component(file_path))
|
|
params_with_correct_id = params.merge(last_commit_id: last_commit.id)
|
|
|
|
put api(route(rouge_file_path), user), params: params_with_correct_id
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
expect(json_response['error']).to eq(invalid_file_message)
|
|
end
|
|
|
|
it_behaves_like 'when path is absolute' do
|
|
let(:last_commit) do
|
|
Gitlab::Git::Commit
|
|
.last_for_path(project.repository, 'master', Addressable::URI.unencode_component(file_path))
|
|
end
|
|
|
|
let(:params_with_correct_id) { params.merge(last_commit_id: last_commit.id) }
|
|
|
|
subject { put api(route(absolute_path), user), params: params_with_correct_id }
|
|
end
|
|
|
|
it "returns a 400 bad request if no params given" do
|
|
put api(route(file_path), user)
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
end
|
|
|
|
context "when specifying an author" do
|
|
it "updates a file with the specified author" do
|
|
params.merge!(author_email: author_email, author_name: author_name, content: "New content")
|
|
|
|
put api(route(file_path), user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
last_commit = project.repository.commit.raw
|
|
expect(last_commit.author_email).to eq(author_email)
|
|
expect(last_commit.author_name).to eq(author_name)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe "DELETE /projects/:id/repository/files" do
|
|
let(:params) do
|
|
{
|
|
branch: 'master',
|
|
commit_message: 'Changed file'
|
|
}
|
|
end
|
|
|
|
it 'returns 400 when file path is invalid' do
|
|
delete api(route(rouge_file_path), user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
expect(json_response['error']).to eq(invalid_file_message)
|
|
end
|
|
|
|
it_behaves_like 'when path is absolute' do
|
|
subject { delete api(route(absolute_path), user), params: params }
|
|
end
|
|
|
|
it "deletes existing file in project repo" do
|
|
delete api(route(file_path), user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:no_content)
|
|
end
|
|
|
|
it "returns a 400 bad request if no params given" do
|
|
delete api(route(file_path), user)
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
end
|
|
|
|
it 'returns a 400 bad request if the commit message is empty' do
|
|
params[:commit_message] = ''
|
|
|
|
delete api(route(file_path), user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
end
|
|
|
|
it "returns a 400 if fails to delete file" do
|
|
allow_next_instance_of(Repository) do |instance|
|
|
allow(instance).to receive(:delete_file).and_raise(Gitlab::Git::CommitError, 'Cannot delete file')
|
|
end
|
|
|
|
delete api(route(file_path), user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
end
|
|
|
|
context "when specifying an author" do
|
|
it "removes a file with the specified author" do
|
|
params.merge!(author_email: author_email, author_name: author_name)
|
|
|
|
delete api(route(file_path), user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:no_content)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe "POST /projects/:id/repository/files with binary file" do
|
|
let(:file_path) { 'test%2Ebin' }
|
|
let(:put_params) do
|
|
{
|
|
branch: 'master',
|
|
content: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEUAAACnej3aAAAAAXRSTlMAQObYZgAAAApJREFUCNdjYAAAAAIAAeIhvDMAAAAASUVORK5CYII=',
|
|
commit_message: 'Binary file with a \n should not be touched',
|
|
encoding: 'base64'
|
|
}
|
|
end
|
|
|
|
let(:get_params) do
|
|
{
|
|
ref: 'master'
|
|
}
|
|
end
|
|
|
|
before do
|
|
post api(route(file_path), user), params: put_params
|
|
end
|
|
|
|
it "remains unchanged" do
|
|
get api(route(file_path), user), params: get_params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
expect(json_response['file_path']).to eq(CGI.unescape(file_path))
|
|
expect(json_response['file_name']).to eq(CGI.unescape(file_path))
|
|
expect(json_response['content']).to eq(put_params[:content])
|
|
end
|
|
end
|
|
end
|