debian-mirror-gitlab/spec/requests/api/files_spec.rb

529 lines
17 KiB
Ruby
Raw Normal View History

2014-09-02 18:07:02 +05:30
require 'spec_helper'
2017-08-17 22:00:37 +05:30
describe API::Files do
2014-09-02 18:07:02 +05:30
let(:user) { create(:user) }
2017-08-17 22:00:37 +05:30
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(:params) do
{
ref: 'master'
}
end
let(:author_email) { 'user@example.org' }
let(:author_name) { 'John Doe' }
2014-09-02 18:07:02 +05:30
2018-11-18 11:00:15 +05:30
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
2017-09-10 17:25:29 +05:30
before do
2018-03-17 18:26:18 +05:30
project.add_developer(user)
2017-09-10 17:25:29 +05:30
end
2014-09-02 18:07:02 +05:30
2017-08-17 22:00:37 +05:30
def route(file_path = nil)
"/projects/#{project.id}/repository/files/#{file_path}"
end
2014-09-02 18:07:02 +05:30
2018-11-18 11:00:15 +05:30
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
2018-11-08 19:23:39 +05:30
describe "HEAD /projects/:id/repository/files/:file_path" do
shared_examples_for 'repository files' do
it 'returns file attributes in headers' do
head api(route(file_path), current_user), params
expect(response).to have_gitlab_http_status(200)
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), params
expect(response).to have_gitlab_http_status(200)
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)
expect(response).to have_gitlab_http_status(400)
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), params
expect(response).to have_gitlab_http_status(404)
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), params
expect(response).to have_gitlab_http_status(403)
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
expect(response).to have_gitlab_http_status(404)
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 }
end
end
end
2017-08-17 22:00:37 +05:30
describe "GET /projects/:id/repository/files/:file_path" do
shared_examples_for 'repository files' do
it 'returns file attributes as json' do
get api(route(file_path), current_user), params
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(200)
2017-08-17 22:00:37 +05:30
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')
2018-11-08 19:23:39 +05:30
expect(json_response['content_sha256']).to eq('c440cd09bae50c4632cc58638ad33c6aa375b6109d811e76a9cc3a613c1e8887')
2017-08-17 22:00:37 +05:30
expect(Base64.decode64(json_response['content']).lines.first).to eq("require 'fileutils'\n")
end
2017-09-10 17:25:29 +05:30
it 'returns json when file has txt extension' do
file_path = "bar%2Fbranch-test.txt"
get api(route(file_path), current_user), params
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(200)
2017-09-10 17:25:29 +05:30
expect(response.content_type).to eq('application/json')
end
2017-08-17 22:00:37 +05:30
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), current_user), params
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(200)
2017-08-17 22:00:37 +05:30
expect(json_response['file_name']).to eq('commit.js.coffee')
2018-11-08 19:23:39 +05:30
expect(json_response['content_sha256']).to eq('08785f04375b47f81f46e68cc125d5ef368aa20576ddb53f91f4d83f1d04b929')
2017-08-17 22:00:37 +05:30
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, current_user), params
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(200)
2017-08-17 22:00:37 +05:30
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 }
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 }
end
end
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
context 'when unauthenticated', 'and project is public' do
it_behaves_like 'repository files' do
2017-09-10 17:25:29 +05:30
let(:project) { create(:project, :public, :repository) }
2017-08-17 22:00:37 +05:30
let(:current_user) { nil }
end
end
2016-09-29 09:46:39 +05:30
2017-08-17 22:00:37 +05:30
context 'when unauthenticated', 'and project is private' do
it_behaves_like '404 response' do
let(:request) { get api(route(file_path)), params }
let(:message) { '404 Project Not Found' }
end
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
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) { get api(route(file_path), guest), params }
end
end
end
describe "GET /projects/:id/repository/files/:file_path/raw" do
shared_examples_for 'repository raw files' do
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
2014-09-02 18:07:02 +05:30
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(200)
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
expect(response).to have_gitlab_http_status(200)
2017-08-17 22:00:37 +05:30
end
2016-09-29 09:46:39 +05:30
2017-08-17 22:00:37 +05:30
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
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(200)
2017-08-17 22:00:37 +05:30
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 }
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 }
end
end
end
context 'when unauthenticated', 'and project is public' do
it_behaves_like 'repository raw files' do
2017-09-10 17:25:29 +05:30
let(:project) { create(:project, :public, :repository) }
2017-08-17 22:00:37 +05:30
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 }
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 }
end
2014-09-02 18:07:02 +05:30
end
end
2017-08-17 22:00:37 +05:30
describe "POST /projects/:id/repository/files/:file_path" do
let!(:file_path) { "new_subfolder%2Fnewfile%2Erb" }
2018-11-20 20:47:30 +05:30
let(:params) do
2014-09-02 18:07:02 +05:30
{
2017-08-17 22:00:37 +05:30
branch: "master",
content: "puts 8",
commit_message: "Added newfile"
2014-09-02 18:07:02 +05:30
}
2015-09-11 14:41:01 +05:30
end
2014-09-02 18:07:02 +05:30
2016-09-13 17:45:13 +05:30
it "creates a new file in project repo" do
2018-11-20 20:47:30 +05:30
post api(route(file_path), user), params
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(201)
2017-08-17 22:00:37 +05:30
expect(json_response["file_path"]).to eq(CGI.unescape(file_path))
2016-09-29 09:46:39 +05:30
last_commit = project.repository.commit.raw
expect(last_commit.author_email).to eq(user.email)
expect(last_commit.author_name).to eq(user.name)
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
it "returns a 400 bad request if no mandatory params given" do
post api(route("any%2Etxt"), user)
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(400)
2014-09-02 18:07:02 +05:30
end
2018-11-20 20:47:30 +05:30
it 'returns a 400 bad request if the commit message is empty' do
params[:commit_message] = ''
post api(route(file_path), user), params
expect(response).to have_gitlab_http_status(400)
end
2016-09-13 17:45:13 +05:30
it "returns a 400 if editor fails to create file" do
2017-09-10 17:25:29 +05:30
allow_any_instance_of(Repository).to receive(:create_file)
2018-03-17 18:26:18 +05:30
.and_raise(Gitlab::Git::CommitError, 'Cannot create file')
2014-09-02 18:07:02 +05:30
2018-11-20 20:47:30 +05:30
post api(route("any%2Etxt"), user), params
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(400)
2014-09-02 18:07:02 +05:30
end
2016-09-29 09:46:39 +05:30
context "when specifying an author" do
it "creates a new file with the specified author" do
2018-11-20 20:47:30 +05:30
params.merge!(author_email: author_email, author_name: author_name)
2016-09-29 09:46:39 +05:30
2018-11-20 20:47:30 +05:30
post api(route("new_file_with_author%2Etxt"), user), params
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(201)
2017-09-10 17:25:29 +05:30
expect(response.content_type).to eq('application/json')
2016-09-29 09:46:39 +05:30
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
2017-08-17 22:00:37 +05:30
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
2018-11-20 20:47:30 +05:30
post api(route("newfile%2Erb"), user), params
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(201)
2017-08-17 22:00:37 +05:30
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
2014-09-02 18:07:02 +05:30
end
describe "PUT /projects/:id/repository/files" do
2018-11-20 20:47:30 +05:30
let(:params) do
2014-09-02 18:07:02 +05:30
{
2017-08-17 22:00:37 +05:30
branch: 'master',
2014-09-02 18:07:02 +05:30
content: 'puts 8',
commit_message: 'Changed file'
}
2015-09-11 14:41:01 +05:30
end
2014-09-02 18:07:02 +05:30
2016-09-13 17:45:13 +05:30
it "updates existing file in project repo" do
2018-11-20 20:47:30 +05:30
put api(route(file_path), user), params
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(200)
2017-08-17 22:00:37 +05:30
expect(json_response['file_path']).to eq(CGI.unescape(file_path))
2016-09-29 09:46:39 +05:30
last_commit = project.repository.commit.raw
expect(last_commit.author_email).to eq(user.email)
expect(last_commit.author_name).to eq(user.name)
2014-09-02 18:07:02 +05:30
end
2018-11-20 20:47:30 +05:30
it 'returns a 400 bad request if the commit message is empty' do
params[:commit_message] = ''
put api(route(file_path), user), params
expect(response).to have_gitlab_http_status(400)
end
2017-09-10 17:25:29 +05:30
it "returns a 400 bad request if update existing file with stale last commit id" do
2018-11-20 20:47:30 +05:30
params_with_stale_id = params.merge(last_commit_id: 'stale')
2017-09-10 17:25:29 +05:30
put api(route(file_path), user), params_with_stale_id
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(400)
2017-09-10 17:25:29 +05:30
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', URI.unescape(file_path))
2018-11-20 20:47:30 +05:30
params_with_correct_id = params.merge(last_commit_id: last_commit.id)
2017-09-10 17:25:29 +05:30
put api(route(file_path), user), params_with_correct_id
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(200)
2017-09-10 17:25:29 +05:30
end
2016-09-13 17:45:13 +05:30
it "returns a 400 bad request if no params given" do
2017-08-17 22:00:37 +05:30
put api(route(file_path), user)
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(400)
2014-09-02 18:07:02 +05:30
end
2016-09-29 09:46:39 +05:30
context "when specifying an author" do
it "updates a file with the specified author" do
2018-11-20 20:47:30 +05:30
params.merge!(author_email: author_email, author_name: author_name, content: "New content")
2016-09-29 09:46:39 +05:30
2018-11-20 20:47:30 +05:30
put api(route(file_path), user), params
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(200)
2016-09-29 09:46:39 +05:30
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
2014-09-02 18:07:02 +05:30
end
describe "DELETE /projects/:id/repository/files" do
2018-11-20 20:47:30 +05:30
let(:params) do
2014-09-02 18:07:02 +05:30
{
2017-08-17 22:00:37 +05:30
branch: 'master',
2014-09-02 18:07:02 +05:30
commit_message: 'Changed file'
}
2015-09-11 14:41:01 +05:30
end
2014-09-02 18:07:02 +05:30
2016-09-13 17:45:13 +05:30
it "deletes existing file in project repo" do
2018-11-20 20:47:30 +05:30
delete api(route(file_path), user), params
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(204)
2014-09-02 18:07:02 +05:30
end
2016-09-13 17:45:13 +05:30
it "returns a 400 bad request if no params given" do
2017-08-17 22:00:37 +05:30
delete api(route(file_path), user)
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(400)
2014-09-02 18:07:02 +05:30
end
2018-11-20 20:47:30 +05:30
it 'returns a 400 bad request if the commit message is empty' do
params[:commit_message] = ''
delete api(route(file_path), user), params
expect(response).to have_gitlab_http_status(400)
end
2017-08-17 22:00:37 +05:30
it "returns a 400 if fails to delete file" do
2018-03-17 18:26:18 +05:30
allow_any_instance_of(Repository).to receive(:delete_file).and_raise(Gitlab::Git::CommitError, 'Cannot delete file')
2014-09-02 18:07:02 +05:30
2018-11-20 20:47:30 +05:30
delete api(route(file_path), user), params
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(400)
2014-09-02 18:07:02 +05:30
end
2016-09-29 09:46:39 +05:30
context "when specifying an author" do
it "removes a file with the specified author" do
2018-11-20 20:47:30 +05:30
params.merge!(author_email: author_email, author_name: author_name)
2016-09-29 09:46:39 +05:30
2018-11-20 20:47:30 +05:30
delete api(route(file_path), user), params
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(204)
2016-09-29 09:46:39 +05:30
end
end
2014-09-02 18:07:02 +05:30
end
2015-09-11 14:41:01 +05:30
describe "POST /projects/:id/repository/files with binary file" do
2017-08-17 22:00:37 +05:30
let(:file_path) { 'test%2Ebin' }
2015-09-11 14:41:01 +05:30
let(:put_params) do
{
2017-08-17 22:00:37 +05:30
branch: 'master',
2015-09-11 14:41:01 +05:30
content: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEUAAACnej3aAAAAAXRSTlMAQObYZgAAAApJREFUCNdjYAAAAAIAAeIhvDMAAAAASUVORK5CYII=',
commit_message: 'Binary file with a \n should not be touched',
encoding: 'base64'
}
end
let(:get_params) do
{
2017-09-10 17:25:29 +05:30
ref: 'master'
2015-09-11 14:41:01 +05:30
}
end
before do
2017-08-17 22:00:37 +05:30
post api(route(file_path), user), put_params
2015-09-11 14:41:01 +05:30
end
it "remains unchanged" do
2017-08-17 22:00:37 +05:30
get api(route(file_path), user), get_params
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
expect(response).to have_gitlab_http_status(200)
2017-08-17 22:00:37 +05:30
expect(json_response['file_path']).to eq(CGI.unescape(file_path))
expect(json_response['file_name']).to eq(CGI.unescape(file_path))
2015-09-11 14:41:01 +05:30
expect(json_response['content']).to eq(put_params[:content])
end
end
2014-09-02 18:07:02 +05:30
end