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

1076 lines
38 KiB
Ruby
Raw Normal View History

2019-12-26 22:10:19 +05:30
# frozen_string_literal: true
2014-09-02 18:07:02 +05:30
require 'spec_helper'
2020-07-28 23:09:34 +05:30
RSpec.describe API::Files do
include RepoHelpers
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" }
2022-06-21 17:19:12 +05:30
let(:executable_file_path) { "files%2Fexecutables%2Fls" }
2020-04-08 14:13:33 +05:30
let(:rouge_file_path) { "%2e%2e%2f" }
2020-10-24 23:57:45 +05:30
let(:absolute_path) { "%2Fetc%2Fpasswd.rb" }
2020-04-08 14:13:33 +05:30
let(:invalid_file_message) { 'file_path should be a valid file path' }
2017-08-17 22:00:37 +05:30
let(:params) do
{
ref: 'master'
}
end
2020-10-24 23:57:45 +05:30
2022-06-21 17:19:12 +05:30
let(:executable_ref_params) do
{
ref: 'with-executables'
}
end
2017-08-17 22:00:37 +05:30
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
2021-12-11 22:18:48 +05:30
def expect_to_send_git_blob(url, params)
expect(Gitlab::Workhorse).to receive(:send_git_blob)
get url, params: params
expect(response).to have_gitlab_http_status(:ok)
expect(response.parsed_body).to be_empty
end
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
2020-10-24 23:57:45 +05:30
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
2018-11-08 19:23:39 +05:30
describe "HEAD /projects/:id/repository/files/:file_path" do
shared_examples_for 'repository files' do
2021-01-29 00:20:46 +05:30
let(:options) { {} }
2020-04-08 14:13:33 +05:30
it 'returns 400 when file path is invalid' do
2021-01-29 00:20:46 +05:30
head api(route(rouge_file_path), current_user, **options), params: params
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
end
2020-10-24 23:57:45 +05:30
it_behaves_like 'when path is absolute' do
2021-01-29 00:20:46 +05:30
subject { head api(route(absolute_path), current_user, **options), params: params }
2020-10-24 23:57:45 +05:30
end
2018-11-08 19:23:39 +05:30
it 'returns file attributes in headers' do
2021-01-29 00:20:46 +05:30
head api(route(file_path), current_user, **options), params: params
2018-11-08 19:23:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-11-08 19:23:39 +05:30
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
2021-11-11 11:23:49 +05:30
it 'caches sha256 of the content', :use_clean_rails_redis_caching do
head api(route(file_path), current_user, **options), params: params
expect(Rails.cache.fetch("blob_content_sha256:#{project.full_path}:#{response.headers['X-Gitlab-Blob-Id']}"))
.to eq('c440cd09bae50c4632cc58638ad33c6aa375b6109d811e76a9cc3a613c1e8887')
expect_next_instance_of(Gitlab::Git::Blob) do |instance|
expect(instance).not_to receive(:load_all_data!)
end
head api(route(file_path), current_user, **options), params: params
end
2018-11-08 19:23:39 +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"
2021-01-29 00:20:46 +05:30
head api(route(file_path), current_user, **options), params: params
2018-11-08 19:23:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-11-08 19:23:39 +05:30
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
2021-01-29 00:20:46 +05:30
head api(route("any%2Ffile"), current_user, **options)
2018-11-08 19:23:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2018-11-08 19:23:39 +05:30
end
end
context 'when file_path does not exist' do
it "responds with a 404 status" do
params[:ref] = 'master'
2021-01-29 00:20:46 +05:30
head api(route('app%2Fmodels%2Fapplication%2Erb'), current_user, **options), params: params
2018-11-08 19:23:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2018-11-08 19:23:39 +05:30
end
end
context 'when file_path does not exist' do
include_context 'disabled repository'
it "responds with a 403 status" do
2021-01-29 00:20:46 +05:30
head api(route(file_path), current_user, **options), params: params
2018-11-08 19:23:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2018-11-08 19:23:39 +05:30
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
2019-02-15 15:39:39 +05:30
head api(route(file_path), current_user), params: params
2018-11-08 19:23:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2018-11-08 19:23:39 +05:30
end
end
2019-02-15 15:39:39 +05:30
context 'when PATs are used' do
it_behaves_like 'repository files' do
let(:token) { create(:personal_access_token, scopes: ['read_repository'], user: user) }
2021-01-29 00:20:46 +05:30
let(:current_user) { nil }
let(:options) { { personal_access_token: token } }
2019-02-15 15:39:39 +05:30
end
end
2018-11-08 19:23:39 +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
2019-02-15 15:39:39 +05:30
let(:request) { head api(route(file_path), guest), params: params }
2018-11-08 19:23:39 +05:30
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
2021-01-29 00:20:46 +05:30
let(:options) { {} }
2020-06-23 00:09:42 +05:30
2020-04-08 14:13:33 +05:30
it 'returns 400 for invalid file path' do
2021-01-29 00:20:46 +05:30
get api(route(rouge_file_path), api_user, **options), params: params
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['error']).to eq(invalid_file_message)
end
2020-10-24 23:57:45 +05:30
it_behaves_like 'when path is absolute' do
2021-01-29 00:20:46 +05:30
subject { get api(route(absolute_path), api_user, **options), params: params }
2020-10-24 23:57:45 +05:30
end
2017-08-17 22:00:37 +05:30
it 'returns file attributes as json' do
2021-01-29 00:20:46 +05:30
get api(route(file_path), api_user, **options), params: params
2016-09-29 09:46:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
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')
2022-06-21 17:19:12 +05:30
expect(json_response['execute_filemode']).to eq(false)
2017-08-17 22:00:37 +05:30
expect(Base64.decode64(json_response['content']).lines.first).to eq("require 'fileutils'\n")
end
2022-06-21 17:19:12 +05:30
context 'for executable file' do
it 'returns file attributes as json' do
get api(route(executable_file_path), api_user, **options), params: executable_ref_params
aggregate_failures 'testing response' do
expect(response).to have_gitlab_http_status(:ok)
expect(json_response['file_path']).to eq(CGI.unescape(executable_file_path))
expect(json_response['file_name']).to eq('ls')
expect(json_response['last_commit_id']).to eq('6b8dc4a827797aa025ff6b8f425e583858a10d4f')
expect(json_response['content_sha256']).to eq('2c74b1181ef780dfb692c030d3a0df6e0b624135c38a9344e56b9f80007b6191')
expect(json_response['execute_filemode']).to eq(true)
expect(Base64.decode64(json_response['content']).lines.first).to eq("#!/bin/sh\n")
end
end
end
2017-09-10 17:25:29 +05:30
it 'returns json when file has txt extension' do
file_path = "bar%2Fbranch-test.txt"
2021-01-29 00:20:46 +05:30
get api(route(file_path), api_user, **options), params: params
2017-09-10 17:25:29 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2021-01-29 00:20:46 +05:30
expect(response.media_type).to eq('application/json')
2017-09-10 17:25:29 +05:30
end
2020-07-28 23:09:34 +05:30
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'
2021-01-29 00:20:46 +05:30
get api(route(file_path), api_user, **options), params: params
2020-07-28 23:09:34 +05:30
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
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"
2021-01-29 00:20:46 +05:30
get api(route(file_path), api_user, **options), params: params
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
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"
2021-12-11 22:18:48 +05:30
expect_to_send_git_blob(api(url, api_user, **options), params)
2019-03-02 22:35:43 +05:30
expect(headers[Gitlab::Workhorse::DETECT_HEADER]).to eq "true"
2017-08-17 22:00:37 +05:30
end
2019-10-12 21:52:04 +05:30
it 'returns blame file info' do
url = route(file_path) + '/blame'
2021-01-29 00:20:46 +05:30
get api(url, api_user, **options), params: params
2019-10-12 21:52:04 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2019-10-12 21:52:04 +05:30
end
2019-03-02 22:35:43 +05:30
it 'sets inline content disposition by default' do
2019-02-15 15:39:39 +05:30
url = route(file_path) + "/raw"
2021-01-29 00:20:46 +05:30
get api(url, api_user, **options), params: params
2019-02-15 15:39:39 +05:30
2019-03-02 22:35:43 +05:30
expect(headers['Content-Disposition']).to eq(%q(inline; filename="popen.rb"; filename*=UTF-8''popen.rb))
2019-02-15 15:39:39 +05:30
end
2017-08-17 22:00:37 +05:30
context 'when mandatory params are not given' do
it_behaves_like '400 response' do
2021-01-29 00:20:46 +05:30
let(:request) { get api(route("any%2Ffile"), current_user, **options) }
2017-08-17 22:00:37 +05:30
end
end
context 'when file_path does not exist' do
let(:params) { { ref: 'master' } }
it_behaves_like '404 response' do
2021-01-29 00:20:46 +05:30
let(:request) { get api(route('app%2Fmodels%2Fapplication%2Erb'), api_user, **options), params: params }
2017-08-17 22:00:37 +05:30
let(:message) { '404 File Not Found' }
end
end
context 'when repository is disabled' do
include_context 'disabled repository'
it_behaves_like '403 response' do
2021-01-29 00:20:46 +05:30
let(:request) { get api(route(file_path), api_user, **options), params: params }
2017-08-17 22:00:37 +05:30
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 }
2021-01-29 00:20:46 +05:30
let(:api_user) { nil }
2017-08-17 22:00:37 +05:30
end
end
2016-09-29 09:46:39 +05:30
2019-02-15 15:39:39 +05:30
context 'when PATs are used' do
it_behaves_like 'repository files' do
let(:token) { create(:personal_access_token, scopes: ['read_repository'], user: user) }
2020-06-23 00:09:42 +05:30
let(:current_user) { user }
2021-01-29 00:20:46 +05:30
let(:api_user) { nil }
let(:options) { { personal_access_token: token } }
2019-02-15 15:39:39 +05:30
end
end
2017-08-17 22:00:37 +05:30
context 'when unauthenticated', 'and project is private' do
it_behaves_like '404 response' do
2019-02-15 15:39:39 +05:30
let(:request) { get api(route(file_path)), params: params }
2017-08-17 22:00:37 +05:30
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 }
2021-01-29 00:20:46 +05:30
let(:api_user) { user }
2017-08-17 22:00:37 +05:30
end
end
context 'when authenticated', 'as a guest' do
it_behaves_like '403 response' do
2019-02-15 15:39:39 +05:30
let(:request) { get api(route(file_path), guest), params: params }
2017-08-17 22:00:37 +05:30
end
end
end
2019-10-12 21:52:04 +05:30
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
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2019-10-12 21:52:04 +05:30
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')
2022-06-21 17:19:12 +05:30
expect(response.headers['X-Gitlab-Execute-Filemode']).to eq("false")
end
context 'for executable file' do
it 'returns file attributes in headers' do
head api(route(executable_file_path) + '/blame', current_user), params: executable_ref_params
aggregate_failures 'testing response' do
expect(response).to have_gitlab_http_status(:ok)
expect(response.headers['X-Gitlab-File-Path']).to eq(CGI.unescape(executable_file_path))
expect(response.headers['X-Gitlab-File-Name']).to eq('ls')
expect(response.headers['X-Gitlab-Last-Commit-Id']).to eq('6b8dc4a827797aa025ff6b8f425e583858a10d4f')
expect(response.headers['X-Gitlab-Content-Sha256'])
.to eq('2c74b1181ef780dfb692c030d3a0df6e0b624135c38a9344e56b9f80007b6191')
expect(response.headers['X-Gitlab-Execute-Filemode']).to eq("true")
end
end
2019-10-12 21:52:04 +05:30
end
2020-04-08 14:13:33 +05:30
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
2020-10-24 23:57:45 +05:30
it_behaves_like 'when path is absolute' do
subject { get api(route(absolute_path) + '/blame', current_user), params: params }
end
2019-10-12 21:52:04 +05:30
it 'returns blame file attributes as json' do
get api(route(file_path) + '/blame', current_user), params: params
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2019-10-12 21:52:04 +05:30
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")
2020-01-01 13:55:28 +05:30
expect(range['commit']['authored_date']).to eq('2014-02-27T10:14:56.000+02:00')
2019-10-12 21:52:04 +05:30
expect(range['commit']['author_name']).to eq('Dmitriy Zaporozhets')
expect(range['commit']['author_email']).to eq('dmitriy.zaporozhets@gmail.com')
2020-01-01 13:55:28 +05:30
expect(range['commit']['committed_date']).to eq('2014-02-27T10:14:56.000+02:00')
2019-10-12 21:52:04 +05:30
expect(range['commit']['committer_name']).to eq('Dmitriy Zaporozhets')
expect(range['commit']['committer_email']).to eq('dmitriy.zaporozhets@gmail.com')
end
2022-07-16 23:28:13 +05:30
context 'with a range parameter' do
let(:params) { super().merge(range: { start: 2, end: 4 }) }
it 'returns file blame attributes as json for the range' do
get api(route(file_path) + '/blame', current_user), params: params
expect(response).to have_gitlab_http_status(:ok)
expect(json_response.size).to eq(2)
lines = json_response.map { |x| x['lines'] }
expect(lines.map(&:size)).to eq(expected_blame_range_sizes[1..2])
expect(lines.flatten).to eq(["require 'open3'", '', 'module Popen'])
end
context 'when start > end' do
let(:params) { super().merge(range: { start: 4, end: 2 }) }
it 'returns 400 error' do
get api(route(file_path) + '/blame', current_user), params: params
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']).to eq('range[start] must be less than or equal to range[end]')
end
end
context 'when range is incomplete' do
let(:params) { super().merge(range: { start: 1 }) }
it 'returns 400 error' do
get api(route(file_path) + '/blame', current_user), params: params
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['error']).to eq('range[end] is missing, range[end] is empty')
end
end
context 'when range contains negative integers' do
let(:params) { super().merge(range: { start: -2, end: -5 }) }
it 'returns 400 error' do
get api(route(file_path) + '/blame', current_user), params: params
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['error']).to eq('range[start] does not have a valid value, range[end] does not have a valid value')
end
end
context 'when range is missing' do
let(:params) { super().merge(range: { start: '', end: '' }) }
it 'returns 400 error' do
get api(route(file_path) + '/blame', current_user), params: params
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['error']).to eq('range[start] is empty, range[end] is empty')
end
end
end
2019-10-12 21:52:04 +05:30
it 'returns blame file info for files with dots' do
url = route('.gitignore') + '/blame'
get api(url, current_user), params: params
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2019-10-12 21:52:04 +05:30
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
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2019-10-12 21:52:04 +05:30
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
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2019-10-12 21:52:04 +05:30
end
end
end
2017-08-17 22:00:37 +05:30
describe "GET /projects/:id/repository/files/:file_path/raw" do
shared_examples_for 'repository raw files' do
2020-04-08 14:13:33 +05:30
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
2020-10-24 23:57:45 +05:30
it_behaves_like 'when path is absolute' do
subject { get api(route(absolute_path) + '/raw', current_user), params: params }
end
2017-08-17 22:00:37 +05:30
it 'returns raw file info' do
url = route(file_path) + "/raw"
2021-12-11 22:18:48 +05:30
expect_to_send_git_blob(api(url, current_user), params)
2018-03-17 18:26:18 +05:30
end
2021-04-29 21:17:54 +05:30
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"
2021-12-11 22:18:48 +05:30
expect_to_send_git_blob(api(url, current_user), {})
2021-04-29 21:17:54 +05:30
end
end
2018-03-17 18:26:18 +05:30
it 'returns raw file info for files with dots' do
url = route('.gitignore') + "/raw"
2021-12-11 22:18:48 +05:30
expect_to_send_git_blob(api(url, current_user), params)
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"
2021-12-11 22:18:48 +05:30
expect_to_send_git_blob(api(route(file_path) + "/raw", current_user), params)
2017-08-17 22:00:37 +05:30
end
2021-01-29 00:20:46 +05:30
it 'sets no-cache headers' do
url = route('.gitignore') + "/raw"
2020-02-01 01:16:34 +05:30
2021-12-11 22:18:48 +05:30
expect_to_send_git_blob(api(url, current_user), params)
2021-01-29 00:20:46 +05:30
2021-09-04 01:27:46 +05:30
expect(response.headers["Cache-Control"]).to eq("max-age=0, private, must-revalidate, no-store, no-cache")
2021-01-29 00:20:46 +05:30
expect(response.headers["Pragma"]).to eq("no-cache")
expect(response.headers["Expires"]).to eq("Fri, 01 Jan 1990 00:00:00 GMT")
2020-02-01 01:16:34 +05:30
end
2017-08-17 22:00:37 +05:30
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
2019-02-15 15:39:39 +05:30
let(:request) { get api(route('app%2Fmodels%2Fapplication%2Erb'), current_user), params: params }
2017-08-17 22:00:37 +05:30
let(:message) { '404 File Not Found' }
end
end
context 'when repository is disabled' do
include_context 'disabled repository'
it_behaves_like '403 response' do
2019-02-15 15:39:39 +05:30
let(:request) { get api(route(file_path), current_user), params: params }
2017-08-17 22:00:37 +05:30
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
2019-02-15 15:39:39 +05:30
let(:request) { get api(route(file_path)), params: params }
2017-08-17 22:00:37 +05:30
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
2019-02-15 15:39:39 +05:30
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"
2021-12-11 22:18:48 +05:30
url = api(route(file_path) + "/raw", personal_access_token: token)
2019-02-15 15:39:39 +05:30
2021-12-11 22:18:48 +05:30
expect_to_send_git_blob(url, params)
2017-08-17 22:00:37 +05:30
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
2022-06-21 17:19:12 +05:30
let(:executable_params) do
{
branch: "master",
content: "puts 8",
commit_message: "Added newfile",
execute_filemode: true
}
end
2020-04-08 14:13:33 +05:30
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
2020-10-24 23:57:45 +05:30
it_behaves_like 'when path is absolute' do
subject { post api(route(absolute_path), user), params: params }
end
2016-09-13 17:45:13 +05:30
it "creates a new file in project repo" do
2019-02-15 15:39:39 +05:30
post api(route(file_path), user), params: params
2016-09-29 09:46:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:created)
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)
2022-06-21 17:19:12 +05:30
expect(project.repository.blob_at_branch(params[:branch], CGI.unescape(file_path)).executable?).to eq(false)
end
it "creates a new executable file in project repo" do
post api(route(file_path), user), params: executable_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)
expect(project.repository.blob_at_branch(params[:branch], CGI.unescape(file_path)).executable?).to eq(true)
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
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
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] = ''
2019-02-15 15:39:39 +05:30
post api(route(file_path), user), params: params
2018-11-20 20:47:30 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2018-11-20 20:47:30 +05:30
end
2016-09-13 17:45:13 +05:30
it "returns a 400 if editor fails to create file" do
2020-01-01 13:55:28 +05:30
allow_next_instance_of(Repository) do |instance|
allow(instance).to receive(:create_file).and_raise(Gitlab::Git::CommitError, 'Cannot create file')
end
2014-09-02 18:07:02 +05:30
2019-02-15 15:39:39 +05:30
post api(route("any%2Etxt"), user), params: params
2016-09-29 09:46:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2014-09-02 18:07:02 +05:30
end
2016-09-29 09:46:39 +05:30
2019-02-15 15:39:39 +05:30
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
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2019-02-15 15:39:39 +05:30
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
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:created)
2019-02-15 15:39:39 +05:30
end
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
2019-02-15 15:39:39 +05:30
post api(route("new_file_with_author%2Etxt"), user), params: params
2016-09-29 09:46:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:created)
2021-01-29 00:20:46 +05:30
expect(response.media_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
2019-02-15 15:39:39 +05:30
post api(route("newfile%2Erb"), user), params: params
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:created)
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
2019-02-15 15:39:39 +05:30
put api(route(file_path), user), params: params
2016-09-29 09:46:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
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] = ''
2019-02-15 15:39:39 +05:30
put api(route(file_path), user), params: params
2018-11-20 20:47:30 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2018-11-20 20:47:30 +05:30
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
2019-02-15 15:39:39 +05:30
put api(route(file_path), user), params: params_with_stale_id
2017-09-10 17:25:29 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2020-01-01 13:55:28 +05:30
expect(json_response['message']).to eq(_('You are attempting to update a file that has changed since you started editing it.'))
2017-09-10 17:25:29 +05:30
end
it "updates existing file in project repo with accepts correct last commit id" do
last_commit = Gitlab::Git::Commit
2021-01-03 14:25:43 +05:30
.last_for_path(project.repository, 'master', Addressable::URI.unencode_component(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
2019-02-15 15:39:39 +05:30
put api(route(file_path), user), params: params_with_correct_id
2017-09-10 17:25:29 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
end
it "returns 400 when file path is invalid" do
last_commit = Gitlab::Git::Commit
2021-01-03 14:25:43 +05:30
.last_for_path(project.repository, 'master', Addressable::URI.unencode_component(file_path))
2020-04-08 14:13:33 +05:30
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)
2017-09-10 17:25:29 +05:30
end
2020-10-24 23:57:45 +05:30
it_behaves_like 'when path is absolute' do
let(:last_commit) do
Gitlab::Git::Commit
2021-01-03 14:25:43 +05:30
.last_for_path(project.repository, 'master', Addressable::URI.unencode_component(file_path))
2020-10-24 23:57:45 +05:30
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
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
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
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
2019-02-15 15:39:39 +05:30
put api(route(file_path), user), params: params
2016-09-29 09:46:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
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
2022-06-21 17:19:12 +05:30
context 'when specifying the execute_filemode' do
let(:executable_params) do
{
branch: 'master',
content: 'puts 8',
commit_message: 'Changed file',
execute_filemode: true
}
end
let(:non_executable_params) do
{
branch: 'with-executables',
content: 'puts 8',
commit_message: 'Changed file',
execute_filemode: false
}
end
it 'updates to executable file mode' do
put api(route(file_path), user), params: executable_params
aggregate_failures 'testing response' do
expect(response).to have_gitlab_http_status(:ok)
expect(project.repository.blob_at_branch(executable_params[:branch], CGI.unescape(file_path)).executable?).to eq(true)
end
end
it 'updates to non-executable file mode' do
put api(route(executable_file_path), user), params: non_executable_params
aggregate_failures 'testing response' do
expect(response).to have_gitlab_http_status(:ok)
expect(project.repository.blob_at_branch(non_executable_params[:branch], CGI.unescape(executable_file_path)).executable?).to eq(false)
end
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
2020-04-08 14:13:33 +05:30
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
2020-10-24 23:57:45 +05:30
it_behaves_like 'when path is absolute' do
subject { delete api(route(absolute_path), user), params: params }
end
2016-09-13 17:45:13 +05:30
it "deletes existing file in project repo" do
2019-02-15 15:39:39 +05:30
delete api(route(file_path), user), params: params
2016-09-29 09:46:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:no_content)
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
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
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] = ''
2019-02-15 15:39:39 +05:30
delete api(route(file_path), user), params: params
2018-11-20 20:47:30 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2018-11-20 20:47:30 +05:30
end
2017-08-17 22:00:37 +05:30
it "returns a 400 if fails to delete file" do
2020-01-01 13:55:28 +05:30
allow_next_instance_of(Repository) do |instance|
allow(instance).to receive(:delete_file).and_raise(Gitlab::Git::CommitError, 'Cannot delete file')
end
2014-09-02 18:07:02 +05:30
2019-02-15 15:39:39 +05:30
delete api(route(file_path), user), params: params
2016-09-29 09:46:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
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
2019-02-15 15:39:39 +05:30
delete api(route(file_path), user), params: params
2016-09-29 09:46:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:no_content)
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
2020-10-24 23:57:45 +05:30
2015-09-11 14:41:01 +05:30
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
2019-02-15 15:39:39 +05:30
post api(route(file_path), user), params: put_params
2015-09-11 14:41:01 +05:30
end
it "remains unchanged" do
2019-02-15 15:39:39 +05:30
get api(route(file_path), user), params: get_params
2016-09-29 09:46:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
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