Improve consistency and duplication for Merge Request API
* Follow REST for merge request API route * Remove repeating comments API for MR Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
This commit is contained in:
parent
ca171b8190
commit
dfb8803c1c
|
@ -14,6 +14,8 @@ v 8.5.0 (unreleased)
|
||||||
- Track project import failure
|
- Track project import failure
|
||||||
- Fix visibility level text in admin area (Zeger-Jan van de Weg)
|
- Fix visibility level text in admin area (Zeger-Jan van de Weg)
|
||||||
- Update the ExternalIssue regex pattern (Blake Hitchcock)
|
- Update the ExternalIssue regex pattern (Blake Hitchcock)
|
||||||
|
- Deprecate API "merge_request/:merge_request_id/comments". Use "merge_requests/:merge_request_id/notes" instead
|
||||||
|
- Deprecate API "merge_request/:merge_request_id/...". Use "merge_requests/:merge_request_id/..." instead
|
||||||
|
|
||||||
v 8.4.2
|
v 8.4.2
|
||||||
- Bump required gitlab-workhorse version to bring in a fix for missing
|
- Bump required gitlab-workhorse version to bring in a fix for missing
|
||||||
|
|
|
@ -60,7 +60,7 @@ Parameters:
|
||||||
Shows information about a single merge request.
|
Shows information about a single merge request.
|
||||||
|
|
||||||
```
|
```
|
||||||
GET /projects/:id/merge_request/:merge_request_id
|
GET /projects/:id/merge_requests/:merge_request_id
|
||||||
```
|
```
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
@ -105,7 +105,7 @@ Parameters:
|
||||||
Get a list of merge request commits.
|
Get a list of merge request commits.
|
||||||
|
|
||||||
```
|
```
|
||||||
GET /projects/:id/merge_request/:merge_request_id/commits
|
GET /projects/:id/merge_requests/:merge_request_id/commits
|
||||||
```
|
```
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
@ -142,7 +142,7 @@ Parameters:
|
||||||
Shows information about the merge request including its files and changes.
|
Shows information about the merge request including its files and changes.
|
||||||
|
|
||||||
```
|
```
|
||||||
GET /projects/:id/merge_request/:merge_request_id/changes
|
GET /projects/:id/merge_requests/:merge_request_id/changes
|
||||||
```
|
```
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
@ -264,7 +264,7 @@ If an error occurs, an error number and a message explaining the reason is retur
|
||||||
Updates an existing merge request. You can change the target branch, title, or even close the MR.
|
Updates an existing merge request. You can change the target branch, title, or even close the MR.
|
||||||
|
|
||||||
```
|
```
|
||||||
PUT /projects/:id/merge_request/:merge_request_id
|
PUT /projects/:id/merge_requests/:merge_request_id
|
||||||
```
|
```
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
@ -323,7 +323,7 @@ If merge request is already merged or closed - you get 405 and error message 'Me
|
||||||
If you don't have permissions to accept this merge request - you'll get a 401
|
If you don't have permissions to accept this merge request - you'll get a 401
|
||||||
|
|
||||||
```
|
```
|
||||||
PUT /projects/:id/merge_request/:merge_request_id/merge
|
PUT /projects/:id/merge_requests/:merge_request_id/merge
|
||||||
```
|
```
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
@ -373,7 +373,7 @@ If the merge request is already merged or closed - you get 405 and error message
|
||||||
|
|
||||||
In case the merge request is not set to be merged when the build succeeds, you'll also get a 406 error.
|
In case the merge request is not set to be merged when the build succeeds, you'll also get a 406 error.
|
||||||
```
|
```
|
||||||
PUT /projects/:id/merge_request/:merge_request_id/cancel_merge_when_build_succeeds
|
PUT /projects/:id/merge_requests/:merge_request_id/cancel_merge_when_build_succeeds
|
||||||
```
|
```
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
|
@ -409,66 +409,6 @@ Parameters:
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Post comment to MR
|
|
||||||
|
|
||||||
Adds a comment to a merge request.
|
|
||||||
|
|
||||||
```
|
|
||||||
POST /projects/:id/merge_request/:merge_request_id/comments
|
|
||||||
```
|
|
||||||
|
|
||||||
Parameters:
|
|
||||||
|
|
||||||
- `id` (required) - The ID of a project
|
|
||||||
- `merge_request_id` (required) - ID of merge request
|
|
||||||
- `note` (required) - Text of comment
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"note": "text1"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Get the comments on a MR
|
|
||||||
|
|
||||||
Gets all the comments associated with a merge request.
|
|
||||||
|
|
||||||
```
|
|
||||||
GET /projects/:id/merge_request/:merge_request_id/comments
|
|
||||||
```
|
|
||||||
|
|
||||||
Parameters:
|
|
||||||
|
|
||||||
- `id` (required) - The ID of a project
|
|
||||||
- `merge_request_id` (required) - ID of merge request
|
|
||||||
|
|
||||||
```json
|
|
||||||
[
|
|
||||||
{
|
|
||||||
"note": "this is the 1st comment on the 2merge merge request",
|
|
||||||
"author": {
|
|
||||||
"id": 11,
|
|
||||||
"username": "admin",
|
|
||||||
"email": "admin@example.com",
|
|
||||||
"name": "Administrator",
|
|
||||||
"state": "active",
|
|
||||||
"created_at": "2014-03-06T08:17:35.000Z"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"note": "Status changed to closed",
|
|
||||||
"author": {
|
|
||||||
"id": 11,
|
|
||||||
"username": "admin",
|
|
||||||
"email": "admin@example.com",
|
|
||||||
"name": "Administrator",
|
|
||||||
"state": "active",
|
|
||||||
"created_at": "2014-03-06T08:17:35.000Z"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
```
|
|
||||||
|
|
||||||
## Comments on merge requets
|
## Comments on merge requets
|
||||||
|
|
||||||
Comments are done via the notes resource.
|
Comments are done via the [notes](notes.md) resource.
|
||||||
|
|
|
@ -59,55 +59,6 @@ module API
|
||||||
present paginate(merge_requests), with: Entities::MergeRequest
|
present paginate(merge_requests), with: Entities::MergeRequest
|
||||||
end
|
end
|
||||||
|
|
||||||
# Show MR
|
|
||||||
#
|
|
||||||
# Parameters:
|
|
||||||
# id (required) - The ID of a project
|
|
||||||
# merge_request_id (required) - The ID of MR
|
|
||||||
#
|
|
||||||
# Example:
|
|
||||||
# GET /projects/:id/merge_request/:merge_request_id
|
|
||||||
#
|
|
||||||
get ":id/merge_request/:merge_request_id" do
|
|
||||||
merge_request = user_project.merge_requests.find(params[:merge_request_id])
|
|
||||||
|
|
||||||
authorize! :read_merge_request, merge_request
|
|
||||||
|
|
||||||
present merge_request, with: Entities::MergeRequest
|
|
||||||
end
|
|
||||||
|
|
||||||
# Show MR commits
|
|
||||||
#
|
|
||||||
# Parameters:
|
|
||||||
# id (required) - The ID of a project
|
|
||||||
# merge_request_id (required) - The ID of MR
|
|
||||||
#
|
|
||||||
# Example:
|
|
||||||
# GET /projects/:id/merge_request/:merge_request_id/commits
|
|
||||||
#
|
|
||||||
get ':id/merge_request/:merge_request_id/commits' do
|
|
||||||
merge_request = user_project.merge_requests.
|
|
||||||
find(params[:merge_request_id])
|
|
||||||
authorize! :read_merge_request, merge_request
|
|
||||||
present merge_request.commits, with: Entities::RepoCommit
|
|
||||||
end
|
|
||||||
|
|
||||||
# Show MR changes
|
|
||||||
#
|
|
||||||
# Parameters:
|
|
||||||
# id (required) - The ID of a project
|
|
||||||
# merge_request_id (required) - The ID of MR
|
|
||||||
#
|
|
||||||
# Example:
|
|
||||||
# GET /projects/:id/merge_request/:merge_request_id/changes
|
|
||||||
#
|
|
||||||
get ':id/merge_request/:merge_request_id/changes' do
|
|
||||||
merge_request = user_project.merge_requests.
|
|
||||||
find(params[:merge_request_id])
|
|
||||||
authorize! :read_merge_request, merge_request
|
|
||||||
present merge_request, with: Entities::MergeRequestChanges
|
|
||||||
end
|
|
||||||
|
|
||||||
# Create MR
|
# Create MR
|
||||||
#
|
#
|
||||||
# Parameters:
|
# Parameters:
|
||||||
|
@ -148,146 +99,206 @@ module API
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Update MR
|
# Routing "merge_request/:merge_request_id/..." is DEPRECATED and WILL BE REMOVED in version 9.0
|
||||||
|
# Use "merge_requests/:merge_request_id/..." instead.
|
||||||
#
|
#
|
||||||
# Parameters:
|
[":id/merge_request/:merge_request_id", ":id/merge_requests/:merge_request_id"].each do |path|
|
||||||
# id (required) - The ID of a project
|
# Show MR
|
||||||
# merge_request_id (required) - ID of MR
|
#
|
||||||
# target_branch - The target branch
|
# Parameters:
|
||||||
# assignee_id - Assignee user ID
|
# id (required) - The ID of a project
|
||||||
# title - Title of MR
|
# merge_request_id (required) - The ID of MR
|
||||||
# state_event - Status of MR. (close|reopen|merge)
|
#
|
||||||
# description - Description of MR
|
# Example:
|
||||||
# labels (optional) - Labels for a MR as a comma-separated list
|
# GET /projects/:id/merge_requests/:merge_request_id
|
||||||
# Example:
|
#
|
||||||
# PUT /projects/:id/merge_request/:merge_request_id
|
get path do
|
||||||
#
|
merge_request = user_project.merge_requests.find(params[:merge_request_id])
|
||||||
put ":id/merge_request/:merge_request_id" do
|
|
||||||
attrs = attributes_for_keys [:target_branch, :assignee_id, :title, :state_event, :description]
|
|
||||||
merge_request = user_project.merge_requests.find(params[:merge_request_id])
|
|
||||||
authorize! :update_merge_request, merge_request
|
|
||||||
|
|
||||||
# Ensure source_branch is not specified
|
authorize! :read_merge_request, merge_request
|
||||||
if params[:source_branch].present?
|
|
||||||
render_api_error!('Source branch cannot be changed', 400)
|
present merge_request, with: Entities::MergeRequest
|
||||||
end
|
end
|
||||||
|
|
||||||
# Validate label names in advance
|
# Show MR commits
|
||||||
if (errors = validate_label_params(params)).any?
|
#
|
||||||
render_api_error!({ labels: errors }, 400)
|
# Parameters:
|
||||||
|
# id (required) - The ID of a project
|
||||||
|
# merge_request_id (required) - The ID of MR
|
||||||
|
#
|
||||||
|
# Example:
|
||||||
|
# GET /projects/:id/merge_requests/:merge_request_id/commits
|
||||||
|
#
|
||||||
|
get "#{path}/commits" do
|
||||||
|
merge_request = user_project.merge_requests.
|
||||||
|
find(params[:merge_request_id])
|
||||||
|
authorize! :read_merge_request, merge_request
|
||||||
|
present merge_request.commits, with: Entities::RepoCommit
|
||||||
end
|
end
|
||||||
|
|
||||||
merge_request = ::MergeRequests::UpdateService.new(user_project, current_user, attrs).execute(merge_request)
|
# Show MR changes
|
||||||
|
#
|
||||||
|
# Parameters:
|
||||||
|
# id (required) - The ID of a project
|
||||||
|
# merge_request_id (required) - The ID of MR
|
||||||
|
#
|
||||||
|
# Example:
|
||||||
|
# GET /projects/:id/merge_requests/:merge_request_id/changes
|
||||||
|
#
|
||||||
|
get "#{path}/changes" do
|
||||||
|
merge_request = user_project.merge_requests.
|
||||||
|
find(params[:merge_request_id])
|
||||||
|
authorize! :read_merge_request, merge_request
|
||||||
|
present merge_request, with: Entities::MergeRequestChanges
|
||||||
|
end
|
||||||
|
|
||||||
if merge_request.valid?
|
# Update MR
|
||||||
# Find or create labels and attach to issue
|
#
|
||||||
unless params[:labels].nil?
|
# Parameters:
|
||||||
merge_request.remove_labels
|
# id (required) - The ID of a project
|
||||||
merge_request.add_labels_by_names(params[:labels].split(","))
|
# merge_request_id (required) - ID of MR
|
||||||
|
# target_branch - The target branch
|
||||||
|
# assignee_id - Assignee user ID
|
||||||
|
# title - Title of MR
|
||||||
|
# state_event - Status of MR. (close|reopen|merge)
|
||||||
|
# description - Description of MR
|
||||||
|
# labels (optional) - Labels for a MR as a comma-separated list
|
||||||
|
# Example:
|
||||||
|
# PUT /projects/:id/merge_requests/:merge_request_id
|
||||||
|
#
|
||||||
|
put path do
|
||||||
|
attrs = attributes_for_keys [:target_branch, :assignee_id, :title, :state_event, :description]
|
||||||
|
merge_request = user_project.merge_requests.find(params[:merge_request_id])
|
||||||
|
authorize! :update_merge_request, merge_request
|
||||||
|
|
||||||
|
# Ensure source_branch is not specified
|
||||||
|
if params[:source_branch].present?
|
||||||
|
render_api_error!('Source branch cannot be changed', 400)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Validate label names in advance
|
||||||
|
if (errors = validate_label_params(params)).any?
|
||||||
|
render_api_error!({ labels: errors }, 400)
|
||||||
|
end
|
||||||
|
|
||||||
|
merge_request = ::MergeRequests::UpdateService.new(user_project, current_user, attrs).execute(merge_request)
|
||||||
|
|
||||||
|
if merge_request.valid?
|
||||||
|
# Find or create labels and attach to issue
|
||||||
|
unless params[:labels].nil?
|
||||||
|
merge_request.remove_labels
|
||||||
|
merge_request.add_labels_by_names(params[:labels].split(","))
|
||||||
|
end
|
||||||
|
|
||||||
|
present merge_request, with: Entities::MergeRequest
|
||||||
|
else
|
||||||
|
handle_merge_request_errors! merge_request.errors
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Merge MR
|
||||||
|
#
|
||||||
|
# Parameters:
|
||||||
|
# id (required) - The ID of a project
|
||||||
|
# merge_request_id (required) - ID of MR
|
||||||
|
# merge_commit_message (optional) - Custom merge commit message
|
||||||
|
# should_remove_source_branch (optional) - When true, the source branch will be deleted if possible
|
||||||
|
# merge_when_build_succeeds (optional) - When true, this MR will be merged when the build succeeds
|
||||||
|
# Example:
|
||||||
|
# PUT /projects/:id/merge_requests/:merge_request_id/merge
|
||||||
|
#
|
||||||
|
put "#{path}/merge" do
|
||||||
|
merge_request = user_project.merge_requests.find(params[:merge_request_id])
|
||||||
|
|
||||||
|
# Merge request can not be merged
|
||||||
|
# because user dont have permissions to push into target branch
|
||||||
|
unauthorized! unless merge_request.can_be_merged_by?(current_user)
|
||||||
|
not_allowed! if !merge_request.open? || merge_request.work_in_progress?
|
||||||
|
|
||||||
|
merge_request.check_if_can_be_merged
|
||||||
|
|
||||||
|
render_api_error!('Branch cannot be merged', 406) unless merge_request.can_be_merged?
|
||||||
|
|
||||||
|
merge_params = {
|
||||||
|
commit_message: params[:merge_commit_message],
|
||||||
|
should_remove_source_branch: params[:should_remove_source_branch]
|
||||||
|
}
|
||||||
|
|
||||||
|
if parse_boolean(params[:merge_when_build_succeeds]) && merge_request.ci_commit && merge_request.ci_commit.active?
|
||||||
|
::MergeRequests::MergeWhenBuildSucceedsService.new(merge_request.target_project, current_user, merge_params).
|
||||||
|
execute(merge_request)
|
||||||
|
else
|
||||||
|
::MergeRequests::MergeService.new(merge_request.target_project, current_user, merge_params).
|
||||||
|
execute(merge_request)
|
||||||
end
|
end
|
||||||
|
|
||||||
present merge_request, with: Entities::MergeRequest
|
present merge_request, with: Entities::MergeRequest
|
||||||
else
|
|
||||||
handle_merge_request_errors! merge_request.errors
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Merge MR
|
|
||||||
#
|
|
||||||
# Parameters:
|
|
||||||
# id (required) - The ID of a project
|
|
||||||
# merge_request_id (required) - ID of MR
|
|
||||||
# merge_commit_message (optional) - Custom merge commit message
|
|
||||||
# should_remove_source_branch (optional) - When true, the source branch will be deleted if possible
|
|
||||||
# merge_when_build_succeeds (optional) - When true, this MR will be merged when the build succeeds
|
|
||||||
# Example:
|
|
||||||
# PUT /projects/:id/merge_request/:merge_request_id/merge
|
|
||||||
#
|
|
||||||
put ":id/merge_request/:merge_request_id/merge" do
|
|
||||||
merge_request = user_project.merge_requests.find(params[:merge_request_id])
|
|
||||||
|
|
||||||
# Merge request can not be merged
|
|
||||||
# because user dont have permissions to push into target branch
|
|
||||||
unauthorized! unless merge_request.can_be_merged_by?(current_user)
|
|
||||||
not_allowed! if !merge_request.open? || merge_request.work_in_progress?
|
|
||||||
|
|
||||||
merge_request.check_if_can_be_merged
|
|
||||||
|
|
||||||
render_api_error!('Branch cannot be merged', 406) unless merge_request.can_be_merged?
|
|
||||||
|
|
||||||
merge_params = {
|
|
||||||
commit_message: params[:merge_commit_message],
|
|
||||||
should_remove_source_branch: params[:should_remove_source_branch]
|
|
||||||
}
|
|
||||||
|
|
||||||
if parse_boolean(params[:merge_when_build_succeeds]) && merge_request.ci_commit && merge_request.ci_commit.active?
|
|
||||||
::MergeRequests::MergeWhenBuildSucceedsService.new(merge_request.target_project, current_user, merge_params).
|
|
||||||
execute(merge_request)
|
|
||||||
else
|
|
||||||
::MergeRequests::MergeService.new(merge_request.target_project, current_user, merge_params).
|
|
||||||
execute(merge_request)
|
|
||||||
end
|
end
|
||||||
|
|
||||||
present merge_request, with: Entities::MergeRequest
|
# Cancel Merge if Merge When build succeeds is enabled
|
||||||
end
|
# Parameters:
|
||||||
|
# id (required) - The ID of a project
|
||||||
|
# merge_request_id (required) - ID of MR
|
||||||
|
#
|
||||||
|
post "#{path}/cancel_merge_when_build_succeeds" do
|
||||||
|
merge_request = user_project.merge_requests.find(params[:merge_request_id])
|
||||||
|
|
||||||
# Cancel Merge if Merge When build succeeds is enabled
|
unauthorized! unless merge_request.can_cancel_merge_when_build_succeeds?(current_user)
|
||||||
# Parameters:
|
|
||||||
# id (required) - The ID of a project
|
|
||||||
# merge_request_id (required) - ID of MR
|
|
||||||
#
|
|
||||||
post ":id/merge_request/:merge_request_id/cancel_merge_when_build_succeeds" do
|
|
||||||
merge_request = user_project.merge_requests.find(params[:merge_request_id])
|
|
||||||
|
|
||||||
unauthorized! unless merge_request.can_cancel_merge_when_build_succeeds?(current_user)
|
::MergeRequest::MergeWhenBuildSucceedsService.new(merge_request.target_project, current_user).cancel(merge_request)
|
||||||
|
end
|
||||||
|
|
||||||
::MergeRequest::MergeWhenBuildSucceedsService.new(merge_request.target_project, current_user).cancel(merge_request)
|
# Duplicate. DEPRECATED and WILL BE REMOVED in 9.0.
|
||||||
end
|
# Use GET "/projects/:id/merge_requests/:merge_request_id/notes" instead
|
||||||
|
#
|
||||||
|
# Get a merge request's comments
|
||||||
|
#
|
||||||
|
# Parameters:
|
||||||
|
# id (required) - The ID of a project
|
||||||
|
# merge_request_id (required) - ID of MR
|
||||||
|
# Examples:
|
||||||
|
# GET /projects/:id/merge_requests/:merge_request_id/comments
|
||||||
|
#
|
||||||
|
get "#{path}/comments" do
|
||||||
|
merge_request = user_project.merge_requests.find(params[:merge_request_id])
|
||||||
|
|
||||||
# Get a merge request's comments
|
authorize! :read_merge_request, merge_request
|
||||||
#
|
|
||||||
# Parameters:
|
|
||||||
# id (required) - The ID of a project
|
|
||||||
# merge_request_id (required) - ID of MR
|
|
||||||
# Examples:
|
|
||||||
# GET /projects/:id/merge_request/:merge_request_id/comments
|
|
||||||
#
|
|
||||||
get ":id/merge_request/:merge_request_id/comments" do
|
|
||||||
merge_request = user_project.merge_requests.find(params[:merge_request_id])
|
|
||||||
|
|
||||||
authorize! :read_merge_request, merge_request
|
present paginate(merge_request.notes.fresh), with: Entities::MRNote
|
||||||
|
end
|
||||||
|
|
||||||
present paginate(merge_request.notes.fresh), with: Entities::MRNote
|
# Duplicate. DEPRECATED and WILL BE REMOVED in 9.0.
|
||||||
end
|
# Use POST "/projects/:id/merge_requests/:merge_request_id/notes" instead
|
||||||
|
#
|
||||||
|
# Post comment to merge request
|
||||||
|
#
|
||||||
|
# Parameters:
|
||||||
|
# id (required) - The ID of a project
|
||||||
|
# merge_request_id (required) - ID of MR
|
||||||
|
# note (required) - Text of comment
|
||||||
|
# Examples:
|
||||||
|
# POST /projects/:id/merge_requests/:merge_request_id/comments
|
||||||
|
#
|
||||||
|
post "#{path}/comments" do
|
||||||
|
required_attributes! [:note]
|
||||||
|
|
||||||
# Post comment to merge request
|
merge_request = user_project.merge_requests.find(params[:merge_request_id])
|
||||||
#
|
|
||||||
# Parameters:
|
|
||||||
# id (required) - The ID of a project
|
|
||||||
# merge_request_id (required) - ID of MR
|
|
||||||
# note (required) - Text of comment
|
|
||||||
# Examples:
|
|
||||||
# POST /projects/:id/merge_request/:merge_request_id/comments
|
|
||||||
#
|
|
||||||
post ":id/merge_request/:merge_request_id/comments" do
|
|
||||||
required_attributes! [:note]
|
|
||||||
|
|
||||||
merge_request = user_project.merge_requests.find(params[:merge_request_id])
|
authorize! :create_note, merge_request
|
||||||
|
|
||||||
authorize! :create_note, merge_request
|
opts = {
|
||||||
|
note: params[:note],
|
||||||
|
noteable_type: 'MergeRequest',
|
||||||
|
noteable_id: merge_request.id
|
||||||
|
}
|
||||||
|
|
||||||
opts = {
|
note = ::Notes::CreateService.new(user_project, current_user, opts).execute
|
||||||
note: params[:note],
|
|
||||||
noteable_type: 'MergeRequest',
|
|
||||||
noteable_id: merge_request.id
|
|
||||||
}
|
|
||||||
|
|
||||||
note = ::Notes::CreateService.new(user_project, current_user, opts).execute
|
if note.save
|
||||||
|
present note, with: Entities::MRNote
|
||||||
if note.save
|
else
|
||||||
present note, with: Entities::MRNote
|
render_api_error!("Failed to save note #{note.errors.messages}", 400)
|
||||||
else
|
end
|
||||||
render_api_error!("Failed to save note #{note.errors.messages}", 400)
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
|
@ -109,9 +109,9 @@ describe API::API, api: true do
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe "GET /projects/:id/merge_request/:merge_request_id" do
|
describe "GET /projects/:id/merge_requests/:merge_request_id" do
|
||||||
it "should return merge_request" do
|
it "should return merge_request" do
|
||||||
get api("/projects/#{project.id}/merge_request/#{merge_request.id}", user)
|
get api("/projects/#{project.id}/merge_requests/#{merge_request.id}", user)
|
||||||
expect(response.status).to eq(200)
|
expect(response.status).to eq(200)
|
||||||
expect(json_response['title']).to eq(merge_request.title)
|
expect(json_response['title']).to eq(merge_request.title)
|
||||||
expect(json_response['iid']).to eq(merge_request.iid)
|
expect(json_response['iid']).to eq(merge_request.iid)
|
||||||
|
@ -126,14 +126,14 @@ describe API::API, api: true do
|
||||||
end
|
end
|
||||||
|
|
||||||
it "should return a 404 error if merge_request_id not found" do
|
it "should return a 404 error if merge_request_id not found" do
|
||||||
get api("/projects/#{project.id}/merge_request/999", user)
|
get api("/projects/#{project.id}/merge_requests/999", user)
|
||||||
expect(response.status).to eq(404)
|
expect(response.status).to eq(404)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe 'GET /projects/:id/merge_request/:merge_request_id/commits' do
|
describe 'GET /projects/:id/merge_requests/:merge_request_id/commits' do
|
||||||
context 'valid merge request' do
|
context 'valid merge request' do
|
||||||
before { get api("/projects/#{project.id}/merge_request/#{merge_request.id}/commits", user) }
|
before { get api("/projects/#{project.id}/merge_requests/#{merge_request.id}/commits", user) }
|
||||||
let(:commit) { merge_request.commits.first }
|
let(:commit) { merge_request.commits.first }
|
||||||
|
|
||||||
it { expect(response.status).to eq 200 }
|
it { expect(response.status).to eq 200 }
|
||||||
|
@ -143,20 +143,20 @@ describe API::API, api: true do
|
||||||
end
|
end
|
||||||
|
|
||||||
it 'returns a 404 when merge_request_id not found' do
|
it 'returns a 404 when merge_request_id not found' do
|
||||||
get api("/projects/#{project.id}/merge_request/999/commits", user)
|
get api("/projects/#{project.id}/merge_requests/999/commits", user)
|
||||||
expect(response.status).to eq(404)
|
expect(response.status).to eq(404)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe 'GET /projects/:id/merge_request/:merge_request_id/changes' do
|
describe 'GET /projects/:id/merge_requests/:merge_request_id/changes' do
|
||||||
it 'should return the change information of the merge_request' do
|
it 'should return the change information of the merge_request' do
|
||||||
get api("/projects/#{project.id}/merge_request/#{merge_request.id}/changes", user)
|
get api("/projects/#{project.id}/merge_requests/#{merge_request.id}/changes", user)
|
||||||
expect(response.status).to eq 200
|
expect(response.status).to eq 200
|
||||||
expect(json_response['changes'].size).to eq(merge_request.diffs.size)
|
expect(json_response['changes'].size).to eq(merge_request.diffs.size)
|
||||||
end
|
end
|
||||||
|
|
||||||
it 'returns a 404 when merge_request_id not found' do
|
it 'returns a 404 when merge_request_id not found' do
|
||||||
get api("/projects/#{project.id}/merge_request/999/changes", user)
|
get api("/projects/#{project.id}/merge_requests/999/changes", user)
|
||||||
expect(response.status).to eq(404)
|
expect(response.status).to eq(404)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
@ -311,19 +311,19 @@ describe API::API, api: true do
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe "PUT /projects/:id/merge_request/:merge_request_id to close MR" do
|
describe "PUT /projects/:id/merge_requests/:merge_request_id to close MR" do
|
||||||
it "should return merge_request" do
|
it "should return merge_request" do
|
||||||
put api("/projects/#{project.id}/merge_request/#{merge_request.id}", user), state_event: "close"
|
put api("/projects/#{project.id}/merge_requests/#{merge_request.id}", user), state_event: "close"
|
||||||
expect(response.status).to eq(200)
|
expect(response.status).to eq(200)
|
||||||
expect(json_response['state']).to eq('closed')
|
expect(json_response['state']).to eq('closed')
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe "PUT /projects/:id/merge_request/:merge_request_id/merge" do
|
describe "PUT /projects/:id/merge_requests/:merge_request_id/merge" do
|
||||||
let(:ci_commit) { create(:ci_commit_without_jobs) }
|
let(:ci_commit) { create(:ci_commit_without_jobs) }
|
||||||
|
|
||||||
it "should return merge_request in case of success" do
|
it "should return merge_request in case of success" do
|
||||||
put api("/projects/#{project.id}/merge_request/#{merge_request.id}/merge", user)
|
put api("/projects/#{project.id}/merge_requests/#{merge_request.id}/merge", user)
|
||||||
|
|
||||||
expect(response.status).to eq(200)
|
expect(response.status).to eq(200)
|
||||||
end
|
end
|
||||||
|
@ -332,7 +332,7 @@ describe API::API, api: true do
|
||||||
allow_any_instance_of(MergeRequest).
|
allow_any_instance_of(MergeRequest).
|
||||||
to receive(:can_be_merged?).and_return(false)
|
to receive(:can_be_merged?).and_return(false)
|
||||||
|
|
||||||
put api("/projects/#{project.id}/merge_request/#{merge_request.id}/merge", user)
|
put api("/projects/#{project.id}/merge_requests/#{merge_request.id}/merge", user)
|
||||||
|
|
||||||
expect(response.status).to eq(406)
|
expect(response.status).to eq(406)
|
||||||
expect(json_response['message']).to eq('Branch cannot be merged')
|
expect(json_response['message']).to eq('Branch cannot be merged')
|
||||||
|
@ -340,14 +340,14 @@ describe API::API, api: true do
|
||||||
|
|
||||||
it "should return 405 if merge_request is not open" do
|
it "should return 405 if merge_request is not open" do
|
||||||
merge_request.close
|
merge_request.close
|
||||||
put api("/projects/#{project.id}/merge_request/#{merge_request.id}/merge", user)
|
put api("/projects/#{project.id}/merge_requests/#{merge_request.id}/merge", user)
|
||||||
expect(response.status).to eq(405)
|
expect(response.status).to eq(405)
|
||||||
expect(json_response['message']).to eq('405 Method Not Allowed')
|
expect(json_response['message']).to eq('405 Method Not Allowed')
|
||||||
end
|
end
|
||||||
|
|
||||||
it "should return 405 if merge_request is a work in progress" do
|
it "should return 405 if merge_request is a work in progress" do
|
||||||
merge_request.update_attribute(:title, "WIP: #{merge_request.title}")
|
merge_request.update_attribute(:title, "WIP: #{merge_request.title}")
|
||||||
put api("/projects/#{project.id}/merge_request/#{merge_request.id}/merge", user)
|
put api("/projects/#{project.id}/merge_requests/#{merge_request.id}/merge", user)
|
||||||
expect(response.status).to eq(405)
|
expect(response.status).to eq(405)
|
||||||
expect(json_response['message']).to eq('405 Method Not Allowed')
|
expect(json_response['message']).to eq('405 Method Not Allowed')
|
||||||
end
|
end
|
||||||
|
@ -355,7 +355,7 @@ describe API::API, api: true do
|
||||||
it "should return 401 if user has no permissions to merge" do
|
it "should return 401 if user has no permissions to merge" do
|
||||||
user2 = create(:user)
|
user2 = create(:user)
|
||||||
project.team << [user2, :reporter]
|
project.team << [user2, :reporter]
|
||||||
put api("/projects/#{project.id}/merge_request/#{merge_request.id}/merge", user2)
|
put api("/projects/#{project.id}/merge_requests/#{merge_request.id}/merge", user2)
|
||||||
expect(response.status).to eq(401)
|
expect(response.status).to eq(401)
|
||||||
expect(json_response['message']).to eq('401 Unauthorized')
|
expect(json_response['message']).to eq('401 Unauthorized')
|
||||||
end
|
end
|
||||||
|
@ -364,7 +364,7 @@ describe API::API, api: true do
|
||||||
allow_any_instance_of(MergeRequest).to receive(:ci_commit).and_return(ci_commit)
|
allow_any_instance_of(MergeRequest).to receive(:ci_commit).and_return(ci_commit)
|
||||||
allow(ci_commit).to receive(:active?).and_return(true)
|
allow(ci_commit).to receive(:active?).and_return(true)
|
||||||
|
|
||||||
put api("/projects/#{project.id}/merge_request/#{merge_request.id}/merge", user), merge_when_build_succeeds: true
|
put api("/projects/#{project.id}/merge_requests/#{merge_request.id}/merge", user), merge_when_build_succeeds: true
|
||||||
|
|
||||||
expect(response.status).to eq(200)
|
expect(response.status).to eq(200)
|
||||||
expect(json_response['title']).to eq('Test')
|
expect(json_response['title']).to eq('Test')
|
||||||
|
@ -372,33 +372,33 @@ describe API::API, api: true do
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe "PUT /projects/:id/merge_request/:merge_request_id" do
|
describe "PUT /projects/:id/merge_requests/:merge_request_id" do
|
||||||
it "should return merge_request" do
|
it "should return merge_request" do
|
||||||
put api("/projects/#{project.id}/merge_request/#{merge_request.id}", user), title: "New title"
|
put api("/projects/#{project.id}/merge_requests/#{merge_request.id}", user), title: "New title"
|
||||||
expect(response.status).to eq(200)
|
expect(response.status).to eq(200)
|
||||||
expect(json_response['title']).to eq('New title')
|
expect(json_response['title']).to eq('New title')
|
||||||
end
|
end
|
||||||
|
|
||||||
it "should return merge_request" do
|
it "should return merge_request" do
|
||||||
put api("/projects/#{project.id}/merge_request/#{merge_request.id}", user), description: "New description"
|
put api("/projects/#{project.id}/merge_requests/#{merge_request.id}", user), description: "New description"
|
||||||
expect(response.status).to eq(200)
|
expect(response.status).to eq(200)
|
||||||
expect(json_response['description']).to eq('New description')
|
expect(json_response['description']).to eq('New description')
|
||||||
end
|
end
|
||||||
|
|
||||||
it "should return 400 when source_branch is specified" do
|
it "should return 400 when source_branch is specified" do
|
||||||
put api("/projects/#{project.id}/merge_request/#{merge_request.id}", user),
|
put api("/projects/#{project.id}/merge_requests/#{merge_request.id}", user),
|
||||||
source_branch: "master", target_branch: "master"
|
source_branch: "master", target_branch: "master"
|
||||||
expect(response.status).to eq(400)
|
expect(response.status).to eq(400)
|
||||||
end
|
end
|
||||||
|
|
||||||
it "should return merge_request with renamed target_branch" do
|
it "should return merge_request with renamed target_branch" do
|
||||||
put api("/projects/#{project.id}/merge_request/#{merge_request.id}", user), target_branch: "wiki"
|
put api("/projects/#{project.id}/merge_requests/#{merge_request.id}", user), target_branch: "wiki"
|
||||||
expect(response.status).to eq(200)
|
expect(response.status).to eq(200)
|
||||||
expect(json_response['target_branch']).to eq('wiki')
|
expect(json_response['target_branch']).to eq('wiki')
|
||||||
end
|
end
|
||||||
|
|
||||||
it 'should return 400 on invalid label names' do
|
it 'should return 400 on invalid label names' do
|
||||||
put api("/projects/#{project.id}/merge_request/#{merge_request.id}",
|
put api("/projects/#{project.id}/merge_requests/#{merge_request.id}",
|
||||||
user),
|
user),
|
||||||
title: 'new issue',
|
title: 'new issue',
|
||||||
labels: 'label, ?'
|
labels: 'label, ?'
|
||||||
|
@ -407,11 +407,11 @@ describe API::API, api: true do
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe "POST /projects/:id/merge_request/:merge_request_id/comments" do
|
describe "POST /projects/:id/merge_requests/:merge_request_id/comments" do
|
||||||
it "should return comment" do
|
it "should return comment" do
|
||||||
original_count = merge_request.notes.size
|
original_count = merge_request.notes.size
|
||||||
|
|
||||||
post api("/projects/#{project.id}/merge_request/#{merge_request.id}/comments", user), note: "My comment"
|
post api("/projects/#{project.id}/merge_requests/#{merge_request.id}/comments", user), note: "My comment"
|
||||||
expect(response.status).to eq(201)
|
expect(response.status).to eq(201)
|
||||||
expect(json_response['note']).to eq('My comment')
|
expect(json_response['note']).to eq('My comment')
|
||||||
expect(json_response['author']['name']).to eq(user.name)
|
expect(json_response['author']['name']).to eq(user.name)
|
||||||
|
@ -420,20 +420,20 @@ describe API::API, api: true do
|
||||||
end
|
end
|
||||||
|
|
||||||
it "should return 400 if note is missing" do
|
it "should return 400 if note is missing" do
|
||||||
post api("/projects/#{project.id}/merge_request/#{merge_request.id}/comments", user)
|
post api("/projects/#{project.id}/merge_requests/#{merge_request.id}/comments", user)
|
||||||
expect(response.status).to eq(400)
|
expect(response.status).to eq(400)
|
||||||
end
|
end
|
||||||
|
|
||||||
it "should return 404 if note is attached to non existent merge request" do
|
it "should return 404 if note is attached to non existent merge request" do
|
||||||
post api("/projects/#{project.id}/merge_request/404/comments", user),
|
post api("/projects/#{project.id}/merge_requests/404/comments", user),
|
||||||
note: 'My comment'
|
note: 'My comment'
|
||||||
expect(response.status).to eq(404)
|
expect(response.status).to eq(404)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe "GET :id/merge_request/:merge_request_id/comments" do
|
describe "GET :id/merge_requests/:merge_request_id/comments" do
|
||||||
it "should return merge_request comments ordered by created_at" do
|
it "should return merge_request comments ordered by created_at" do
|
||||||
get api("/projects/#{project.id}/merge_request/#{merge_request.id}/comments", user)
|
get api("/projects/#{project.id}/merge_requests/#{merge_request.id}/comments", user)
|
||||||
expect(response.status).to eq(200)
|
expect(response.status).to eq(200)
|
||||||
expect(json_response).to be_an Array
|
expect(json_response).to be_an Array
|
||||||
expect(json_response.length).to eq(2)
|
expect(json_response.length).to eq(2)
|
||||||
|
@ -443,7 +443,7 @@ describe API::API, api: true do
|
||||||
end
|
end
|
||||||
|
|
||||||
it "should return a 404 error if merge_request_id not found" do
|
it "should return a 404 error if merge_request_id not found" do
|
||||||
get api("/projects/#{project.id}/merge_request/999/comments", user)
|
get api("/projects/#{project.id}/merge_requests/999/comments", user)
|
||||||
expect(response.status).to eq(404)
|
expect(response.status).to eq(404)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
Loading…
Reference in New Issue