2018-12-05 23:21:45 +05:30
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2014-09-02 18:07:02 +05:30
|
|
|
require 'mime/types'
|
|
|
|
|
|
|
|
module API
|
2020-07-28 23:09:34 +05:30
|
|
|
class Branches < Grape::API::Instance
|
2017-08-17 22:00:37 +05:30
|
|
|
include PaginationParams
|
|
|
|
|
2019-02-15 15:39:39 +05:30
|
|
|
BRANCH_ENDPOINT_REQUIREMENTS = API::NAMESPACE_OR_PROJECT_REQUIREMENTS.merge(branch: API::NO_SLASH_URL_PART_REGEX)
|
2017-09-10 17:25:29 +05:30
|
|
|
|
2020-05-24 23:13:21 +05:30
|
|
|
after_validation { content_type "application/json" }
|
|
|
|
|
2019-09-30 21:07:59 +05:30
|
|
|
before do
|
|
|
|
require_repository_enabled!
|
|
|
|
authorize! :download_code, user_project
|
|
|
|
end
|
2014-09-02 18:07:02 +05:30
|
|
|
|
2018-03-17 18:26:18 +05:30
|
|
|
helpers do
|
2018-03-27 19:54:05 +05:30
|
|
|
params :filter_params do
|
|
|
|
optional :search, type: String, desc: 'Return list of branches matching the search criteria'
|
2018-11-18 11:00:15 +05:30
|
|
|
optional :sort, type: String, desc: 'Return list of branches sorted by the given field'
|
2018-03-27 19:54:05 +05:30
|
|
|
end
|
2018-03-17 18:26:18 +05:30
|
|
|
end
|
|
|
|
|
2017-08-17 22:00:37 +05:30
|
|
|
params do
|
|
|
|
requires :id, type: String, desc: 'The ID of a project'
|
|
|
|
end
|
2019-02-15 15:39:39 +05:30
|
|
|
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
|
2017-08-17 22:00:37 +05:30
|
|
|
desc 'Get a project repository branches' do
|
2018-03-17 18:26:18 +05:30
|
|
|
success Entities::Branch
|
2017-08-17 22:00:37 +05:30
|
|
|
end
|
|
|
|
params do
|
|
|
|
use :pagination
|
2018-03-27 19:54:05 +05:30
|
|
|
use :filter_params
|
2020-07-28 23:09:34 +05:30
|
|
|
|
|
|
|
optional :page_token, type: String, desc: 'Name of branch to start the paginaition from'
|
2017-08-17 22:00:37 +05:30
|
|
|
end
|
2017-09-10 17:25:29 +05:30
|
|
|
get ':id/repository/branches' do
|
2019-12-26 22:10:19 +05:30
|
|
|
user_project.preload_protected_branches
|
2016-08-24 12:49:21 +05:30
|
|
|
|
2018-03-17 18:26:18 +05:30
|
|
|
repository = user_project.repository
|
2018-03-27 19:54:05 +05:30
|
|
|
|
2020-07-28 23:09:34 +05:30
|
|
|
if Feature.enabled?(:branch_list_keyset_pagination, user_project)
|
|
|
|
branches = BranchesFinder.new(repository, declared_params(include_missing: false)).execute(gitaly_pagination: true)
|
|
|
|
else
|
|
|
|
branches = BranchesFinder.new(repository, declared_params(include_missing: false)).execute
|
|
|
|
branches = paginate(::Kaminari.paginate_array(branches))
|
|
|
|
end
|
|
|
|
|
2018-03-17 18:26:18 +05:30
|
|
|
merged_branch_names = repository.merged_branch_names(branches.map(&:name))
|
2014-09-02 18:07:02 +05:30
|
|
|
|
2018-03-27 19:54:05 +05:30
|
|
|
present(
|
2019-07-07 11:18:12 +05:30
|
|
|
branches,
|
2018-03-27 19:54:05 +05:30
|
|
|
with: Entities::Branch,
|
2018-11-08 19:23:39 +05:30
|
|
|
current_user: current_user,
|
2018-03-27 19:54:05 +05:30
|
|
|
project: user_project,
|
|
|
|
merged_branch_names: merged_branch_names
|
|
|
|
)
|
2017-08-17 22:00:37 +05:30
|
|
|
end
|
2016-08-24 12:49:21 +05:30
|
|
|
|
2018-03-17 18:26:18 +05:30
|
|
|
resource ':id/repository/branches/:branch', requirements: BRANCH_ENDPOINT_REQUIREMENTS do
|
|
|
|
desc 'Get a single branch' do
|
|
|
|
success Entities::Branch
|
|
|
|
end
|
|
|
|
params do
|
|
|
|
requires :branch, type: String, desc: 'The name of the branch'
|
|
|
|
end
|
|
|
|
head do
|
2020-03-13 15:44:24 +05:30
|
|
|
user_project.repository.branch_exists?(params[:branch]) ? no_content! : not_found!
|
2018-03-17 18:26:18 +05:30
|
|
|
end
|
|
|
|
get do
|
|
|
|
branch = find_branch!(params[:branch])
|
|
|
|
|
2018-11-08 19:23:39 +05:30
|
|
|
present branch, with: Entities::Branch, current_user: current_user, project: user_project
|
2018-03-17 18:26:18 +05:30
|
|
|
end
|
2014-09-02 18:07:02 +05:30
|
|
|
end
|
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
# Note: This API will be deprecated in favor of the protected branches API.
|
2016-09-13 17:45:13 +05:30
|
|
|
# Note: The internal data model moved from `developers_can_{merge,push}` to `allowed_to_{merge,push}`
|
|
|
|
# in `gitlab-org/gitlab-ce!5081`. The API interface has not been changed (to maintain compatibility),
|
|
|
|
# but it works with the changed data model to infer `developers_can_merge` and `developers_can_push`.
|
2017-08-17 22:00:37 +05:30
|
|
|
desc 'Protect a single branch' do
|
2018-03-17 18:26:18 +05:30
|
|
|
success Entities::Branch
|
2017-08-17 22:00:37 +05:30
|
|
|
end
|
|
|
|
params do
|
2018-12-05 23:21:45 +05:30
|
|
|
requires :branch, type: String, desc: 'The name of the branch', allow_blank: false
|
2017-08-17 22:00:37 +05:30
|
|
|
optional :developers_can_push, type: Boolean, desc: 'Flag if developers can push to that branch'
|
|
|
|
optional :developers_can_merge, type: Boolean, desc: 'Flag if developers can merge to that branch'
|
|
|
|
end
|
2018-12-05 23:21:45 +05:30
|
|
|
# rubocop: disable CodeReuse/ActiveRecord
|
2017-09-10 17:25:29 +05:30
|
|
|
put ':id/repository/branches/:branch/protect', requirements: BRANCH_ENDPOINT_REQUIREMENTS do
|
2014-09-02 18:07:02 +05:30
|
|
|
authorize_admin_project
|
|
|
|
|
2018-03-17 18:26:18 +05:30
|
|
|
branch = find_branch!(params[:branch])
|
2017-08-17 22:00:37 +05:30
|
|
|
|
|
|
|
protected_branch = user_project.protected_branches.find_by(name: branch.name)
|
2016-09-13 17:45:13 +05:30
|
|
|
|
|
|
|
protected_branch_params = {
|
2017-08-17 22:00:37 +05:30
|
|
|
name: branch.name,
|
|
|
|
developers_can_push: params[:developers_can_push],
|
|
|
|
developers_can_merge: params[:developers_can_merge]
|
2016-09-13 17:45:13 +05:30
|
|
|
}
|
|
|
|
|
2016-11-03 12:29:30 +05:30
|
|
|
service_args = [user_project, current_user, protected_branch_params]
|
2016-09-13 17:45:13 +05:30
|
|
|
|
2016-11-03 12:29:30 +05:30
|
|
|
protected_branch = if protected_branch
|
2018-03-17 18:26:18 +05:30
|
|
|
::ProtectedBranches::LegacyApiUpdateService.new(*service_args).execute(protected_branch)
|
2016-11-03 12:29:30 +05:30
|
|
|
else
|
2018-03-17 18:26:18 +05:30
|
|
|
::ProtectedBranches::LegacyApiCreateService.new(*service_args).execute
|
2016-11-03 12:29:30 +05:30
|
|
|
end
|
2016-09-13 17:45:13 +05:30
|
|
|
|
2016-11-03 12:29:30 +05:30
|
|
|
if protected_branch.valid?
|
2018-11-08 19:23:39 +05:30
|
|
|
present branch, with: Entities::Branch, current_user: current_user, project: user_project
|
2016-08-24 12:49:21 +05:30
|
|
|
else
|
2016-11-03 12:29:30 +05:30
|
|
|
render_api_error!(protected_branch.errors.full_messages, 422)
|
2016-08-24 12:49:21 +05:30
|
|
|
end
|
2014-09-02 18:07:02 +05:30
|
|
|
end
|
2018-12-05 23:21:45 +05:30
|
|
|
# rubocop: enable CodeReuse/ActiveRecord
|
2014-09-02 18:07:02 +05:30
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
# Note: This API will be deprecated in favor of the protected branches API.
|
2017-08-17 22:00:37 +05:30
|
|
|
desc 'Unprotect a single branch' do
|
2018-03-17 18:26:18 +05:30
|
|
|
success Entities::Branch
|
2017-08-17 22:00:37 +05:30
|
|
|
end
|
|
|
|
params do
|
2018-12-05 23:21:45 +05:30
|
|
|
requires :branch, type: String, desc: 'The name of the branch', allow_blank: false
|
2017-08-17 22:00:37 +05:30
|
|
|
end
|
2018-12-05 23:21:45 +05:30
|
|
|
# rubocop: disable CodeReuse/ActiveRecord
|
2017-09-10 17:25:29 +05:30
|
|
|
put ':id/repository/branches/:branch/unprotect', requirements: BRANCH_ENDPOINT_REQUIREMENTS do
|
2014-09-02 18:07:02 +05:30
|
|
|
authorize_admin_project
|
|
|
|
|
2018-03-17 18:26:18 +05:30
|
|
|
branch = find_branch!(params[:branch])
|
2017-08-17 22:00:37 +05:30
|
|
|
protected_branch = user_project.protected_branches.find_by(name: branch.name)
|
|
|
|
protected_branch&.destroy
|
2014-09-02 18:07:02 +05:30
|
|
|
|
2018-11-08 19:23:39 +05:30
|
|
|
present branch, with: Entities::Branch, current_user: current_user, project: user_project
|
2014-09-02 18:07:02 +05:30
|
|
|
end
|
2018-12-05 23:21:45 +05:30
|
|
|
# rubocop: enable CodeReuse/ActiveRecord
|
2014-09-02 18:07:02 +05:30
|
|
|
|
2017-08-17 22:00:37 +05:30
|
|
|
desc 'Create branch' do
|
2018-03-17 18:26:18 +05:30
|
|
|
success Entities::Branch
|
2017-08-17 22:00:37 +05:30
|
|
|
end
|
|
|
|
params do
|
2018-12-05 23:21:45 +05:30
|
|
|
requires :branch, type: String, desc: 'The name of the branch', allow_blank: false
|
|
|
|
requires :ref, type: String, desc: 'Create branch from commit sha or existing branch', allow_blank: false
|
2017-08-17 22:00:37 +05:30
|
|
|
end
|
2017-09-10 17:25:29 +05:30
|
|
|
post ':id/repository/branches' do
|
2014-09-02 18:07:02 +05:30
|
|
|
authorize_push_project
|
2017-08-17 22:00:37 +05:30
|
|
|
|
2020-01-01 13:55:28 +05:30
|
|
|
result = ::Branches::CreateService.new(user_project, current_user)
|
2017-09-10 17:25:29 +05:30
|
|
|
.execute(params[:branch], params[:ref])
|
2014-09-02 18:07:02 +05:30
|
|
|
|
2015-04-26 12:48:37 +05:30
|
|
|
if result[:status] == :success
|
|
|
|
present result[:branch],
|
2018-03-17 18:26:18 +05:30
|
|
|
with: Entities::Branch,
|
2018-11-08 19:23:39 +05:30
|
|
|
current_user: current_user,
|
2015-04-26 12:48:37 +05:30
|
|
|
project: user_project
|
|
|
|
else
|
|
|
|
render_api_error!(result[:message], 400)
|
|
|
|
end
|
2014-09-02 18:07:02 +05:30
|
|
|
end
|
|
|
|
|
2017-08-17 22:00:37 +05:30
|
|
|
desc 'Delete a branch'
|
|
|
|
params do
|
2018-12-05 23:21:45 +05:30
|
|
|
requires :branch, type: String, desc: 'The name of the branch', allow_blank: false
|
2017-08-17 22:00:37 +05:30
|
|
|
end
|
2017-09-10 17:25:29 +05:30
|
|
|
delete ':id/repository/branches/:branch', requirements: BRANCH_ENDPOINT_REQUIREMENTS do
|
2014-09-02 18:07:02 +05:30
|
|
|
authorize_push_project
|
2017-08-17 22:00:37 +05:30
|
|
|
|
2018-03-17 18:26:18 +05:30
|
|
|
branch = find_branch!(params[:branch])
|
|
|
|
|
|
|
|
commit = user_project.repository.commit(branch.dereferenced_target)
|
|
|
|
|
|
|
|
destroy_conditionally!(commit, last_updated: commit.authored_date) do
|
2020-01-01 13:55:28 +05:30
|
|
|
result = ::Branches::DeleteService.new(user_project, current_user)
|
2018-03-17 18:26:18 +05:30
|
|
|
.execute(params[:branch])
|
2014-09-02 18:07:02 +05:30
|
|
|
|
2019-07-31 22:56:46 +05:30
|
|
|
if result.error?
|
|
|
|
render_api_error!(result.message, result.http_status)
|
2018-03-17 18:26:18 +05:30
|
|
|
end
|
2014-09-02 18:07:02 +05:30
|
|
|
end
|
|
|
|
end
|
2017-08-17 22:00:37 +05:30
|
|
|
|
|
|
|
desc 'Delete all merged branches'
|
2017-09-10 17:25:29 +05:30
|
|
|
delete ':id/repository/merged_branches' do
|
2020-01-01 13:55:28 +05:30
|
|
|
::Branches::DeleteMergedService.new(user_project, current_user).async_execute
|
2017-08-17 22:00:37 +05:30
|
|
|
|
|
|
|
accepted!
|
|
|
|
end
|
2014-09-02 18:07:02 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|