Skip to content

G
gitlab-ce
Commit 023a3f7a authored by Rémy Coutable's avatar Rémy Coutable
Browse files
Options

Fix the /projects/:id/repository/commits endpoint to handle dots in the ref... 

Fix the /projects/:id/repository/commits endpoint to handle dots in the ref name when the project full path contains a `/`
Signed-off-by: default avatarRémy Coutable <remy@rymai.me>
parent feb8974c
Show whitespace changes
Inline Side-by-side
Showing with 592 additions and 173 deletions
changelogs/unreleased/rc-fix-commits-api.yml 0 → 100644
View file @ 023a3f7a
---
title: Fix the /projects/:id/repository/commits endpoint to handle dots in the ref
name when the project full path contains a `/`
merge_request: 13370
author:
lib/api/commits.rb
View file @ 023a3f7a
...@@ -4,13 +4,14 @@ module API ...@@ -4,13 +4,14 @@ module API
class Commits < Grape::API class Commits < Grape::API
include PaginationParams include PaginationParams
before { authenticate! } COMMIT_ENDPOINT_REQUIREMENTS = API::PROJECT_ENDPOINT_REQUIREMENTS.merge(sha: API::NO_SLASH_URL_PART_REGEX)
before { authorize! :download_code, user_project } before { authorize! :download_code, user_project }
params do params do
requires :id, type: String, desc: 'The ID of a project' requires :id, type: String, desc: 'The ID of a project'
end end
resource :projects, requirements: { id: %r{[^/]+} } do resource :projects, requirements: API::PROJECT_ENDPOINT_REQUIREMENTS do
desc 'Get a project repository commits' do desc 'Get a project repository commits' do
success Entities::RepoCommit success Entities::RepoCommit
end end
...@@ -21,7 +22,7 @@ module API ...@@ -21,7 +22,7 @@ module API
optional :path, type: String, desc: 'The file path' optional :path, type: String, desc: 'The file path'
use :pagination use :pagination
end end
get ":id/repository/commits" do get ':id/repository/commits' do
path = params[:path] path = params[:path]
before = params[:until] before = params[:until]
after = params[:since] after = params[:since]
...@@ -60,7 +61,7 @@ module API ...@@ -60,7 +61,7 @@ module API
optional :author_email, type: String, desc: 'Author email for commit' optional :author_email, type: String, desc: 'Author email for commit'
optional :author_name, type: String, desc: 'Author name for commit' optional :author_name, type: String, desc: 'Author name for commit'
end end
post ":id/repository/commits" do post ':id/repository/commits' do
authorize! :push_code, user_project authorize! :push_code, user_project
attrs = declared_params attrs = declared_params
...@@ -79,42 +80,42 @@ module API ...@@ -79,42 +80,42 @@ module API
desc 'Get a specific commit of a project' do desc 'Get a specific commit of a project' do
success Entities::RepoCommitDetail success Entities::RepoCommitDetail
failure [[404, 'Not Found']] failure [[404, 'Commit Not Found']]
end end
params do params do
requires :sha, type: String, desc: 'A commit sha, or the name of a branch or tag' requires :sha, type: String, desc: 'A commit sha, or the name of a branch or tag'
end end
get ":id/repository/commits/:sha" do get ':id/repository/commits/:sha', requirements: COMMIT_ENDPOINT_REQUIREMENTS do
commit = user_project.commit(params[:sha]) commit = user_project.commit(params[:sha])
not_found! "Commit" unless commit not_found! 'Commit' unless commit
present commit, with: Entities::RepoCommitDetail present commit, with: Entities::RepoCommitDetail
end end
desc 'Get the diff for a specific commit of a project' do desc 'Get the diff for a specific commit of a project' do
failure [[404, 'Not Found']] failure [[404, 'Commit Not Found']]
end end
params do params do
requires :sha, type: String, desc: 'A commit sha, or the name of a branch or tag' requires :sha, type: String, desc: 'A commit sha, or the name of a branch or tag'
end end
get ":id/repository/commits/:sha/diff" do get ':id/repository/commits/:sha/diff', requirements: COMMIT_ENDPOINT_REQUIREMENTS do
commit = user_project.commit(params[:sha]) commit = user_project.commit(params[:sha])
not_found! "Commit" unless commit not_found! 'Commit' unless commit
commit.raw_diffs.to_a commit.raw_diffs.to_a
end end
desc "Get a commit's comments" do desc "Get a commit's comments" do
success Entities::CommitNote success Entities::CommitNote
failure [[404, 'Not Found']] failure [[404, 'Commit Not Found']]
end end
params do params do
use :pagination use :pagination
requires :sha, type: String, desc: 'A commit sha, or the name of a branch or tag' requires :sha, type: String, desc: 'A commit sha, or the name of a branch or tag'
end end
get ':id/repository/commits/:sha/comments' do get ':id/repository/commits/:sha/comments', requirements: COMMIT_ENDPOINT_REQUIREMENTS do
commit = user_project.commit(params[:sha]) commit = user_project.commit(params[:sha])
not_found! 'Commit' unless commit not_found! 'Commit' unless commit
...@@ -128,10 +129,10 @@ module API ...@@ -128,10 +129,10 @@ module API
success Entities::RepoCommit success Entities::RepoCommit
end end
params do params do
requires :sha, type: String, desc: 'A commit sha to be cherry picked' requires :sha, type: String, desc: 'A commit sha, or the name of a branch or tag to be cherry picked'
requires :branch, type: String, desc: 'The name of the branch' requires :branch, type: String, desc: 'The name of the branch'
end end
post ':id/repository/commits/:sha/cherry_pick' do post ':id/repository/commits/:sha/cherry_pick', requirements: COMMIT_ENDPOINT_REQUIREMENTS do
authorize! :push_code, user_project authorize! :push_code, user_project
commit = user_project.commit(params[:sha]) commit = user_project.commit(params[:sha])
...@@ -160,7 +161,7 @@ module API ...@@ -160,7 +161,7 @@ module API
success Entities::CommitNote success Entities::CommitNote
end end
params do params do
requires :sha, type: String, regexp: /\A\h{6,40}\z/, desc: "The commit's SHA" requires :sha, type: String, desc: 'A commit sha, or the name of a branch or tag on which to post a comment'
requires :note, type: String, desc: 'The text of the comment' requires :note, type: String, desc: 'The text of the comment'
optional :path, type: String, desc: 'The file path' optional :path, type: String, desc: 'The file path'
given :path do given :path do
...@@ -168,7 +169,7 @@ module API ...@@ -168,7 +169,7 @@ module API
requires :line_type, type: String, values: %w(new old), default: 'new', desc: 'The type of the line' requires :line_type, type: String, values: %w(new old), default: 'new', desc: 'The type of the line'
end end
end end
post ':id/repository/commits/:sha/comments' do post ':id/repository/commits/:sha/comments', requirements: COMMIT_ENDPOINT_REQUIREMENTS do
commit = user_project.commit(params[:sha]) commit = user_project.commit(params[:sha])
not_found! 'Commit' unless commit not_found! 'Commit' unless commit
......
spec/fixtures/api/schemas/public_api/v4/comment.json 0 → 100644
View file @ 023a3f7a
{
"type": "object",
"required" : [
"name",
"message",
"commit",
"release"
],
"properties" : {
"name": { "type": "string" },
"message": { "type": ["string", "null"] },
"commit": { "$ref": "commit/basic.json" },
"release": {
"oneOf": [
{ "type": "null" },
{ "$ref": "release.json" }
]
}
},
"additionalProperties": false
}
spec/fixtures/api/schemas/public_api/v4/commit/detail.json 0 → 100644
View file @ 023a3f7a
{
"type": "object",
"allOf": [
{ "$ref": "basic.json" },
{
"required" : [
"stats",
"status"
],
"properties": {
"stats": { "$ref": "../commit_stats.json" },
"status": { "type": ["string", "null"] }
}
}
]
}
spec/fixtures/api/schemas/public_api/v4/commit_note.json 0 → 100644
View file @ 023a3f7a
{
"type": "object",
"required" : [
"note",
"path",
"line",
"line_type",
"author",
"created_at"
],
"properties" : {
"note": { "type": ["string", "null"] },
"path": { "type": ["string", "null"] },
"line": { "type": ["integer", "null"] },
"line_type": { "type": ["string", "null"] },
"author": { "$ref": "user/basic.json" },
"created_at": { "type": "date" }
}
}
spec/fixtures/api/schemas/public_api/v4/commit_notes.json 0 → 100644
View file @ 023a3f7a
{
"type": "array",
"items": { "$ref": "commit_note.json" }
}
spec/fixtures/api/schemas/public_api/v4/commit_stats.json 0 → 100644
View file @ 023a3f7a
{
"type": "object",
"required" : [
"additions",
"deletions",
"total"
],
"properties" : {
"additions": { "type": "integer" },
"deletions": { "type": "integer" },
"total": { "type": "integer" }
},
"additionalProperties": false
}
spec/fixtures/api/schemas/public_api/v4/commits.json 0 → 100644
View file @ 023a3f7a
{
"type": "array",
"items": { "$ref": "commit/basic.json" }
}
spec/fixtures/api/schemas/public_api/v4/user/basic.json 0 → 100644
View file @ 023a3f7a
{
"type": "object",
"required": [
"id",
"state",
"avatar_url",
"web_url"
],
"properties": {
"id": { "type": "integer" },
"state": { "type": "string" },
"avatar_url": { "type": "string" },
"web_url": { "type": "string" }
}
}
spec/requests/api/commits_spec.rb
View file @ 023a3f7a
...@@ -3,29 +3,27 @@ require 'mime/types' ...@@ -3,29 +3,27 @@ require 'mime/types'
describe API::Commits do describe API::Commits do
let(:user) { create(:user) } let(:user) { create(:user) }
let(:user2) { create(:user) } let(:guest) { create(:user).tap { |u| project.add_guest(u) } }
let!(:project) { create(:project, :repository, creator: user, namespace: user.namespace) } let(:project) { create(:project, :repository, creator: user, path: 'my.project') }
let!(:guest) { create(:project_member, :guest, user: user2, project: project) } let(:branch_with_dot) { project.repository.find_branch('ends-with.json') }
let!(:note) { create(:note_on_commit, author: user, project: project, commit_id: project.repository.commit.id, note: 'a comment on a commit') } let(:branch_with_slash) { project.repository.find_branch('improve/awesome') }
let!(:another_note) { create(:note_on_commit, author: user, project: project, commit_id: project.repository.commit.id, note: 'another comment on a commit') }
before do let(:project_id) { project.id }
project.team << [user, :reporter] let(:current_user) { nil }
end
describe "List repository commits" do
context "authorized user" do
before do before do
project.team << [user2, :reporter] project.add_master(user)
end end
describe 'GET /projects/:id/repository/commits' do
context 'authorized user' do
it "returns project commits" do it "returns project commits" do
commit = project.repository.commit commit = project.repository.commit
get api("/projects/#{project.id}/repository/commits", user) get api("/projects/#{project_id}/repository/commits", user)
expect(response).to have_http_status(200) expect(response).to have_http_status(200)
expect(json_response).to be_an Array expect(response).to match_response_schema('public_api/v4/commits')
expect(json_response.first['id']).to eq(commit.id) expect(json_response.first['id']).to eq(commit.id)
expect(json_response.first['committer_name']).to eq(commit.committer_name) expect(json_response.first['committer_name']).to eq(commit.committer_name)
expect(json_response.first['committer_email']).to eq(commit.committer_email) expect(json_response.first['committer_email']).to eq(commit.committer_email)
...@@ -34,7 +32,7 @@ describe API::Commits do ...@@ -34,7 +32,7 @@ describe API::Commits do
it 'include correct pagination headers' do it 'include correct pagination headers' do
commit_count = project.repository.count_commits(ref: 'master').to_s commit_count = project.repository.count_commits(ref: 'master').to_s
get api("/projects/#{project.id}/repository/commits", user) get api("/projects/#{project_id}/repository/commits", user)
expect(response).to include_pagination_headers expect(response).to include_pagination_headers
expect(response.headers['X-Total']).to eq(commit_count) expect(response.headers['X-Total']).to eq(commit_count)
...@@ -44,8 +42,9 @@ describe API::Commits do ...@@ -44,8 +42,9 @@ describe API::Commits do
context "unauthorized user" do context "unauthorized user" do
it "does not return project commits" do it "does not return project commits" do
get api("/projects/#{project.id}/repository/commits") get api("/projects/#{project_id}/repository/commits")
expect(response).to have_http_status(401)
expect(response).to have_http_status(404)
end end
end end
...@@ -54,7 +53,7 @@ describe API::Commits do ...@@ -54,7 +53,7 @@ describe API::Commits do
commits = project.repository.commits("master") commits = project.repository.commits("master")
after = commits.second.created_at after = commits.second.created_at
get api("/projects/#{project.id}/repository/commits?since=#{after.utc.iso8601}", user) get api("/projects/#{project_id}/repository/commits?since=#{after.utc.iso8601}", user)
expect(json_response.size).to eq 2 expect(json_response.size).to eq 2
expect(json_response.first["id"]).to eq(commits.first.id) expect(json_response.first["id"]).to eq(commits.first.id)
...@@ -66,7 +65,7 @@ describe API::Commits do ...@@ -66,7 +65,7 @@ describe API::Commits do
after = commits.second.created_at after = commits.second.created_at
commit_count = project.repository.count_commits(ref: 'master', after: after).to_s commit_count = project.repository.count_commits(ref: 'master', after: after).to_s
get api("/projects/#{project.id}/repository/commits?since=#{after.utc.iso8601}", user) get api("/projects/#{project_id}/repository/commits?since=#{after.utc.iso8601}", user)
expect(response).to include_pagination_headers expect(response).to include_pagination_headers
expect(response.headers['X-Total']).to eq(commit_count) expect(response.headers['X-Total']).to eq(commit_count)
...@@ -79,7 +78,7 @@ describe API::Commits do ...@@ -79,7 +78,7 @@ describe API::Commits do
commits = project.repository.commits("master") commits = project.repository.commits("master")
before = commits.second.created_at before = commits.second.created_at
get api("/projects/#{project.id}/repository/commits?until=#{before.utc.iso8601}", user) get api("/projects/#{project_id}/repository/commits?until=#{before.utc.iso8601}", user)
if commits.size >= 20 if commits.size >= 20
expect(json_response.size).to eq(20) expect(json_response.size).to eq(20)
...@@ -96,7 +95,7 @@ describe API::Commits do ...@@ -96,7 +95,7 @@ describe API::Commits do
before = commits.second.created_at before = commits.second.created_at
commit_count = project.repository.count_commits(ref: 'master', before: before).to_s commit_count = project.repository.count_commits(ref: 'master', before: before).to_s
get api("/projects/#{project.id}/repository/commits?until=#{before.utc.iso8601}", user) get api("/projects/#{project_id}/repository/commits?until=#{before.utc.iso8601}", user)
expect(response).to include_pagination_headers expect(response).to include_pagination_headers
expect(response.headers['X-Total']).to eq(commit_count) expect(response.headers['X-Total']).to eq(commit_count)
...@@ -106,7 +105,7 @@ describe API::Commits do ...@@ -106,7 +105,7 @@ describe API::Commits do
context "invalid xmlschema date parameters" do context "invalid xmlschema date parameters" do
it "returns an invalid parameter error message" do it "returns an invalid parameter error message" do
get api("/projects/#{project.id}/repository/commits?since=invalid-date", user) get api("/projects/#{project_id}/repository/commits?since=invalid-date", user)
expect(response).to have_http_status(400) expect(response).to have_http_status(400)
expect(json_response['error']).to eq('since is invalid') expect(json_response['error']).to eq('since is invalid')
...@@ -118,7 +117,7 @@ describe API::Commits do ...@@ -118,7 +117,7 @@ describe API::Commits do
path = 'files/ruby/popen.rb' path = 'files/ruby/popen.rb'
commit_count = project.repository.count_commits(ref: 'master', path: path).to_s commit_count = project.repository.count_commits(ref: 'master', path: path).to_s
get api("/projects/#{project.id}/repository/commits?path=#{path}", user) get api("/projects/#{project_id}/repository/commits?path=#{path}", user)
expect(json_response.size).to eq(3) expect(json_response.size).to eq(3)
expect(json_response.first["id"]).to eq("570e7b2abdd848b95f2f578043fc23bd6f6fd24d") expect(json_response.first["id"]).to eq("570e7b2abdd848b95f2f578043fc23bd6f6fd24d")
...@@ -130,7 +129,7 @@ describe API::Commits do ...@@ -130,7 +129,7 @@ describe API::Commits do
path = 'files/ruby/popen.rb' path = 'files/ruby/popen.rb'
commit_count = project.repository.count_commits(ref: 'master', path: path).to_s commit_count = project.repository.count_commits(ref: 'master', path: path).to_s
get api("/projects/#{project.id}/repository/commits?path=#{path}", user) get api("/projects/#{project_id}/repository/commits?path=#{path}", user)
expect(response).to include_pagination_headers expect(response).to include_pagination_headers
expect(response.headers['X-Total']).to eq(commit_count) expect(response.headers['X-Total']).to eq(commit_count)
...@@ -143,7 +142,7 @@ describe API::Commits do ...@@ -143,7 +142,7 @@ describe API::Commits do
let(:per_page) { 5 } let(:per_page) { 5 }
let(:ref_name) { 'master' } let(:ref_name) { 'master' }
let!(:request) do let!(:request) do
get api("/projects/#{project.id}/repository/commits?page=#{page}&per_page=#{per_page}&ref_name=#{ref_name}", user) get api("/projects/#{project_id}/repository/commits?page=#{page}&per_page=#{per_page}&ref_name=#{ref_name}", user)
end end
it 'returns correct headers' do it 'returns correct headers' do
...@@ -181,10 +180,10 @@ describe API::Commits do ...@@ -181,10 +180,10 @@ describe API::Commits do
end end
describe "POST /projects/:id/repository/commits" do describe "POST /projects/:id/repository/commits" do
let!(:url) { "/projects/#{project.id}/repository/commits" } let!(:url) { "/projects/#{project_id}/repository/commits" }
it 'returns a 403 unauthorized for user without permissions' do it 'returns a 403 unauthorized for user without permissions' do
post api(url, user2) post api(url, guest)
expect(response).to have_http_status(403) expect(response).to have_http_status(403)
end end
...@@ -227,7 +226,7 @@ describe API::Commits do ...@@ -227,7 +226,7 @@ describe API::Commits do
it 'a new file in project repo' do it 'a new file in project repo' do
post api(url, user), valid_c_params post api(url, user), valid_c_params
expect(response).to have_http_status(201) expect(response).to have_gitlab_http_status(201)
expect(json_response['title']).to eq(message) expect(json_response['title']).to eq(message)
expect(json_response['committer_name']).to eq(user.name) expect(json_response['committer_name']).to eq(user.name)
expect(json_response['committer_email']).to eq(user.email) expect(json_response['committer_email']).to eq(user.email)
...@@ -453,13 +452,17 @@ describe API::Commits do ...@@ -453,13 +452,17 @@ describe API::Commits do
end end
end end
describe "Get a single commit" do describe 'GET /projects/:id/repository/commits/:sha' do
context "authorized user" do let(:commit) { project.repository.commit }
it "returns a commit by sha" do let(:commit_id) { commit.id }
get api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}", user) let(:route) { "/projects/#{project_id}/repository/commits/#{commit_id}" }
expect(response).to have_http_status(200) shared_examples_for 'ref commit' do
commit = project.repository.commit it 'returns the ref last commit' do
get api(route, current_user)
expect(response).to have_gitlab_http_status(200)
expect(response).to match_response_schema('public_api/v4/commit/detail')
expect(json_response['id']).to eq(commit.id) expect(json_response['id']).to eq(commit.id)
expect(json_response['short_id']).to eq(commit.short_id) expect(json_response['short_id']).to eq(commit.short_id)
expect(json_response['title']).to eq(commit.title) expect(json_response['title']).to eq(commit.title)
...@@ -474,222 +477,539 @@ describe API::Commits do ...@@ -474,222 +477,539 @@ describe API::Commits do
expect(json_response['stats']['additions']).to eq(commit.stats.additions) expect(json_response['stats']['additions']).to eq(commit.stats.additions)
expect(json_response['stats']['deletions']).to eq(commit.stats.deletions) expect(json_response['stats']['deletions']).to eq(commit.stats.deletions)
expect(json_response['stats']['total']).to eq(commit.stats.total) expect(json_response['stats']['total']).to eq(commit.stats.total)
expect(json_response['status']).to be_nil
end end
it "returns a 404 error if not found" do context 'when ref does not exist' do
get api("/projects/#{project.id}/repository/commits/invalid_sha", user) let(:commit_id) { 'unknown' }
expect(response).to have_http_status(404)
it_behaves_like '404 response' do
let(:request) { get api(route, current_user) }
let(:message) { '404 Commit Not Found' }
end
end end
it "returns nil for commit without CI" do context 'when repository is disabled' do
get api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}", user) include_context 'disabled repository'
it_behaves_like '403 response' do
let(:request) { get api(route, current_user) }
end
end
end
context 'when unauthenticated', 'and project is public' do
let(:project) { create(:project, :public, :repository) }
it_behaves_like 'ref commit'
end
context 'when unauthenticated', 'and project is private' do
it_behaves_like '404 response' do
let(:request) { get api(route) }
let(:message) { '404 Project Not Found' }
end
end
context 'when authenticated', 'as a master' do
let(:current_user) { user }
it_behaves_like 'ref commit'
context 'when branch contains a dot' do
let(:commit) { project.repository.commit(branch_with_dot.name) }
let(:commit_id) { branch_with_dot.name }
it_behaves_like 'ref commit'
end
context 'when branch contains a slash' do
let(:commit_id) { branch_with_slash.name }
it_behaves_like '404 response' do
let(:request) { get api(route, current_user) }
end
end
context 'when branch contains an escaped slash' do
let(:commit) { project.repository.commit(branch_with_slash.name) }
let(:commit_id) { CGI.escape(branch_with_slash.name) }
it_behaves_like 'ref commit'
end
context 'requesting with the escaped project full path' do
let(:project_id) { CGI.escape(project.full_path) }
it_behaves_like 'ref commit'
context 'when branch contains a dot' do
let(:commit) { project.repository.commit(branch_with_dot.name) }
let(:commit_id) { branch_with_dot.name }
it_behaves_like 'ref commit'
end
end
context 'when the ref has a pipeline' do
let!(:pipeline) { project.pipelines.create(source: :push, ref: 'master', sha: commit.sha) }
it 'includes a "created" status' do
get api(route, current_user)
expect(response).to have_http_status(200) expect(response).to have_http_status(200)
expect(json_response['status']).to be_nil expect(response).to match_response_schema('public_api/v4/commit/detail')
expect(json_response['status']).to eq('created')
end end
it "returns status for CI" do context 'when pipeline succeeds' do
pipeline = project.pipelines.create(source: :push, ref: 'master', sha: project.repository.commit.sha) before do
pipeline.update(status: 'success') pipeline.update(status: 'success')
end
get api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}", user) it 'includes a "success" status' do
get api(route, current_user)
expect(response).to have_http_status(200) expect(response).to have_http_status(200)
expect(json_response['status']).to eq(pipeline.status) expect(response).to match_response_schema('public_api/v4/commit/detail')
expect(json_response['status']).to eq('success')
end
end
end
end
end end
it "returns status for CI when pipeline is created" do describe 'GET /projects/:id/repository/commits/:sha/diff' do
project.pipelines.create(source: :push, ref: 'master', sha: project.repository.commit.sha) let(:commit) { project.repository.commit }
let(:commit_id) { commit.id }
let(:route) { "/projects/#{project_id}/repository/commits/#{commit_id}/diff" }
get api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}", user) shared_examples_for 'ref diff' do
it 'returns the diff of the selected commit' do
get api(route, current_user)
expect(response).to have_http_status(200) expect(response).to have_gitlab_http_status(200)
expect(json_response['status']).to eq("created") expect(json_response.size).to be >= 1
expect(json_response.first.keys).to include 'diff'
end
context 'when ref does not exist' do
let(:commit_id) { 'unknown' }
it_behaves_like '404 response' do
let(:request) { get api(route, current_user) }
let(:message) { '404 Commit Not Found' }
end end
end end
context "unauthorized user" do context 'when repository is disabled' do
it "does not return the selected commit" do include_context 'disabled repository'
get api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}")
expect(response).to have_http_status(401) it_behaves_like '403 response' do
let(:request) { get api(route, current_user) }
end end
end end
end end
describe "Get the diff of a commit" do context 'when unauthenticated', 'and project is public' do
context "authorized user" do let(:project) { create(:project, :public, :repository) }
before do
project.team << [user2, :reporter] it_behaves_like 'ref diff'
end end
it "returns the diff of the selected commit" do context 'when unauthenticated', 'and project is private' do
get api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}/diff", user) it_behaves_like '404 response' do
expect(response).to have_http_status(200) let(:request) { get api(route) }
let(:message) { '404 Project Not Found' }
end
end
context 'when authenticated', 'as a master' do
let(:current_user) { user }
expect(json_response).to be_an Array it_behaves_like 'ref diff'
expect(json_response.length).to be >= 1
expect(json_response.first.keys).to include "diff" context 'when branch contains a dot' do
let(:commit_id) { branch_with_dot.name }
it_behaves_like 'ref diff'
end end
it "returns a 404 error if invalid commit" do context 'when branch contains a slash' do
get api("/projects/#{project.id}/repository/commits/invalid_sha/diff", user) let(:commit_id) { branch_with_slash.name }
expect(response).to have_http_status(404)
it_behaves_like '404 response' do
let(:request) { get api(route, current_user) }
end end
end end
context "unauthorized user" do context 'when branch contains an escaped slash' do
it "does not return the diff of the selected commit" do let(:commit_id) { CGI.escape(branch_with_slash.name) }
get api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}/diff")
expect(response).to have_http_status(401) it_behaves_like 'ref diff'
end
context 'requesting with the escaped project full path' do
let(:project_id) { CGI.escape(project.full_path) }
it_behaves_like 'ref diff'
context 'when branch contains a dot' do
let(:commit_id) { branch_with_dot.name }
it_behaves_like 'ref diff'
end
end end
end end
end end
describe 'Get the comments of a commit' do describe 'GET /projects/:id/repository/commits/:sha/comments' do
context 'authorized user' do let(:commit) { project.repository.commit }
it 'returns merge_request comments' do let(:commit_id) { commit.id }
get api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}/comments", user) let(:route) { "/projects/#{project_id}/repository/commits/#{commit_id}/comments" }
expect(response).to have_http_status(200)
expect(response).to include_pagination_headers shared_examples_for 'ref comments' do
expect(json_response).to be_an Array context 'when ref exists' do
expect(json_response.length).to eq(2) before do
create(:note_on_commit, author: user, project: project, commit_id: commit.id, note: 'a comment on a commit')
create(:note_on_commit, author: user, project: project, commit_id: commit.id, note: 'another comment on a commit')
end
it 'returns the diff of the selected commit' do
get api(route, current_user)
expect(response).to have_gitlab_http_status(200)
expect(response).to match_response_schema('public_api/v4/commit_notes')
expect(json_response.size).to eq(2)
expect(json_response.first['note']).to eq('a comment on a commit') expect(json_response.first['note']).to eq('a comment on a commit')
expect(json_response.first['author']['id']).to eq(user.id) expect(json_response.first['author']['id']).to eq(user.id)
end end
end
it 'returns a 404 error if merge_request_id not found' do context 'when ref does not exist' do
get api("/projects/#{project.id}/repository/commits/1234ab/comments", user) let(:commit_id) { 'unknown' }
expect(response).to have_http_status(404)
it_behaves_like '404 response' do
let(:request) { get api(route, current_user) }
let(:message) { '404 Commit Not Found' }
end
end end
context 'when repository is disabled' do
include_context 'disabled repository'
it_behaves_like '403 response' do
let(:request) { get api(route, current_user) }
end
end
end
context 'when unauthenticated', 'and project is public' do
let(:project) { create(:project, :public, :repository) }
it_behaves_like 'ref comments'
end end
context 'unauthorized user' do context 'when unauthenticated', 'and project is private' do
it 'does not return the diff of the selected commit' do it_behaves_like '404 response' do
get api("/projects/#{project.id}/repository/commits/1234ab/comments") let(:request) { get api(route) }
expect(response).to have_http_status(401) let(:message) { '404 Project Not Found' }
end
end
context 'when authenticated', 'as a master' do
let(:current_user) { user }
it_behaves_like 'ref comments'
context 'when branch contains a dot' do
let(:commit) { project.repository.commit(branch_with_dot.name) }
let(:commit_id) { branch_with_dot.name }
it_behaves_like 'ref comments'
end
context 'when branch contains a slash' do
let(:commit) { project.repository.commit(branch_with_slash.name) }
let(:commit_id) { branch_with_slash.name }
it_behaves_like '404 response' do
let(:request) { get api(route, current_user) }
end
end
context 'when branch contains an escaped slash' do
let(:commit) { project.repository.commit(branch_with_slash.name) }
let(:commit_id) { CGI.escape(branch_with_slash.name) }
it_behaves_like 'ref comments'
end
context 'requesting with the escaped project full path' do
let(:project_id) { CGI.escape(project.full_path) }
it_behaves_like 'ref comments'
context 'when branch contains a dot' do
let(:commit) { project.repository.commit(branch_with_dot.name) }
let(:commit_id) { branch_with_dot.name }
it_behaves_like 'ref comments'
end
end end
end end
context 'when the commit is present on two projects' do context 'when the commit is present on two projects' do
let(:forked_project) { create(:project, :repository, creator: user2, namespace: user2.namespace) } let(:forked_project) { create(:project, :repository, creator: guest, namespace: guest.namespace) }
let!(:forked_project_note) { create(:note_on_commit, author: user2, project: forked_project, commit_id: forked_project.repository.commit.id, note: 'a comment on a commit for fork') } let!(:forked_project_note) { create(:note_on_commit, author: guest, project: forked_project, commit_id: forked_project.repository.commit.id, note: 'a comment on a commit for fork') }
let(:project_id) { forked_project.id }
let(:commit_id) { forked_project.repository.commit.id }
it 'returns the comments for the target project' do it 'returns the comments for the target project' do
get api("/projects/#{forked_project.id}/repository/commits/#{forked_project.repository.commit.id}/comments", user2) get api(route, guest)
expect(response).to have_http_status(200) expect(response).to have_gitlab_http_status(200)
expect(json_response.length).to eq(1) expect(response).to match_response_schema('public_api/v4/commit_notes')
expect(json_response.size).to eq(1)
expect(json_response.first['note']).to eq('a comment on a commit for fork') expect(json_response.first['note']).to eq('a comment on a commit for fork')
expect(json_response.first['author']['id']).to eq(user2.id) expect(json_response.first['author']['id']).to eq(guest.id)
end end
end end
end end
describe 'POST :id/repository/commits/:sha/cherry_pick' do describe 'POST :id/repository/commits/:sha/cherry_pick' do
let(:master_pickable_commit) { project.commit('7d3b0f7cff5f37573aea97cebfd5692ea1689924') } let(:commit) { project.commit('7d3b0f7cff5f37573aea97cebfd5692ea1689924') }
let(:commit_id) { commit.id }
let(:branch) { 'master' }
let(:route) { "/projects/#{project_id}/repository/commits/#{commit_id}/cherry_pick" }
shared_examples_for 'ref cherry-pick' do
context 'when ref exists' do
it 'cherry-picks the ref commit' do
post api(route, current_user), branch: branch
expect(response).to have_gitlab_http_status(201)
expect(response).to match_response_schema('public_api/v4/commit/basic')
expect(json_response['title']).to eq(commit.title)
expect(json_response['message']).to eq(commit.message)
expect(json_response['author_name']).to eq(commit.author_name)
expect(json_response['committer_name']).to eq(user.name)
end
end
context 'authorized user' do context 'when repository is disabled' do
it 'cherry picks a commit' do include_context 'disabled repository'
post api("/projects/#{project.id}/repository/commits/#{master_pickable_commit.id}/cherry_pick", user), branch: 'master'
expect(response).to have_http_status(201) it_behaves_like '403 response' do
expect(json_response['title']).to eq(master_pickable_commit.title) let(:request) { post api(route, current_user), branch: 'master' }
expect(json_response['message']).to eq(master_pickable_commit.message) end
expect(json_response['author_name']).to eq(master_pickable_commit.author_name) end
expect(json_response['committer_name']).to eq(user.name)
end end
it 'returns 400 if commit is already included in the target branch' do context 'when unauthenticated', 'and project is public' do
post api("/projects/#{project.id}/repository/commits/#{master_pickable_commit.id}/cherry_pick", user), branch: 'markdown' let(:project) { create(:project, :public, :repository) }
expect(response).to have_http_status(400) it_behaves_like '403 response' do
expect(json_response['message']).to include('Sorry, we cannot cherry-pick this commit automatically.') let(:request) { post api(route), branch: 'master' }
end
end end
it 'returns 400 if you are not allowed to push to the target branch' do context 'when unauthenticated', 'and project is private' do
project.team << [user2, :developer] it_behaves_like '404 response' do
protected_branch = create(:protected_branch, project: project, name: 'feature') let(:request) { post api(route), branch: 'master' }
let(:message) { '404 Project Not Found' }
end
end
post api("/projects/#{project.id}/repository/commits/#{master_pickable_commit.id}/cherry_pick", user2), branch: protected_branch.name context 'when authenticated', 'as an owner' do
let(:current_user) { user }
expect(response).to have_http_status(400) it_behaves_like 'ref cherry-pick'
expect(json_response['message']).to eq('You are not allowed to push into this branch')
context 'when ref does not exist' do
let(:commit_id) { 'unknown' }
it_behaves_like '404 response' do
let(:request) { post api(route, current_user), branch: 'master' }
let(:message) { '404 Commit Not Found' }
end
end
context 'when branch is missing' do
it_behaves_like '400 response' do
let(:request) { post api(route, current_user) }
end
end end
it 'returns 400 for missing parameters' do context 'when branch does not exist' do
post api("/projects/#{project.id}/repository/commits/#{master_pickable_commit.id}/cherry_pick", user) it_behaves_like '404 response' do
let(:request) { post api(route, current_user), branch: 'foo' }
let(:message) { '404 Branch Not Found' }
end
end
expect(response).to have_http_status(400) context 'when commit is already included in the target branch' do
expect(json_response['error']).to eq('branch is missing') it_behaves_like '400 response' do
let(:request) { post api(route, current_user), branch: 'markdown' }
end
end end
it 'returns 404 if commit is not found' do context 'when ref contains a dot' do
post api("/projects/#{project.id}/repository/commits/abcd0123/cherry_pick", user), branch: 'master' let(:commit) { project.repository.commit(branch_with_dot.name) }
let(:commit_id) { branch_with_dot.name }
expect(response).to have_http_status(404) it_behaves_like 'ref cherry-pick'
expect(json_response['message']).to eq('404 Commit Not Found')
end end
it 'returns 404 if branch is not found' do context 'when ref contains a slash' do
post api("/projects/#{project.id}/repository/commits/#{master_pickable_commit.id}/cherry_pick", user), branch: 'foo' let(:commit_id) { branch_with_slash.name }
expect(response).to have_http_status(404) it_behaves_like '404 response' do
expect(json_response['message']).to eq('404 Branch Not Found') let(:request) { post api(route, current_user), branch: 'master' }
end
end end
it 'returns 400 for missing parameters' do context 'requesting with the escaped project full path' do
post api("/projects/#{project.id}/repository/commits/#{master_pickable_commit.id}/cherry_pick", user) let(:project_id) { CGI.escape(project.full_path) }
expect(response).to have_http_status(400) it_behaves_like 'ref cherry-pick'
expect(json_response['error']).to eq('branch is missing')
context 'when ref contains a dot' do
let(:commit) { project.repository.commit(branch_with_dot.name) }
let(:commit_id) { branch_with_dot.name }
it_behaves_like 'ref cherry-pick'
end
end end
end end
context 'unauthorized user' do context 'when authenticated', 'as a developer' do
it 'does not cherry pick the commit' do let(:current_user) { guest }
post api("/projects/#{project.id}/repository/commits/#{master_pickable_commit.id}/cherry_pick"), branch: 'master'
expect(response).to have_http_status(401) before do
project.add_developer(guest)
end
context 'when branch is protected' do
before do
create(:protected_branch, project: project, name: 'feature')
end
it 'returns 400 if you are not allowed to push to the target branch' do
post api(route, current_user), branch: 'feature'
expect(response).to have_gitlab_http_status(400)
expect(json_response['message']).to eq('You are not allowed to push into this branch')
end
end end
end end
end end
describe 'Post comment to commit' do describe 'POST /projects/:id/repository/commits/:sha/comments' do
context 'authorized user' do let(:commit) { project.repository.commit }
it 'returns comment' do let(:commit_id) { commit.id }
post api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}/comments", user), note: 'My comment' let(:note) { 'My comment' }
expect(response).to have_http_status(201) let(:route) { "/projects/#{project_id}/repository/commits/#{commit_id}/comments" }
shared_examples_for 'ref new comment' do
context 'when ref exists' do
it 'creates the comment' do
post api(route, current_user), note: note
expect(response).to have_gitlab_http_status(201)
expect(response).to match_response_schema('public_api/v4/commit_note')
expect(json_response['note']).to eq('My comment') expect(json_response['note']).to eq('My comment')
expect(json_response['path']).to be_nil expect(json_response['path']).to be_nil
expect(json_response['line']).to be_nil expect(json_response['line']).to be_nil
expect(json_response['line_type']).to be_nil expect(json_response['line_type']).to be_nil
end end
end
context 'when repository is disabled' do
include_context 'disabled repository'
it_behaves_like '403 response' do
let(:request) { post api(route, current_user), note: 'My comment' }
end
end
end
context 'when unauthenticated', 'and project is public' do
let(:project) { create(:project, :public, :repository) }
it_behaves_like '400 response' do
let(:request) { post api(route), note: 'My comment' }
end
end
context 'when unauthenticated', 'and project is private' do
it_behaves_like '404 response' do
let(:request) { post api(route), note: 'My comment' }
let(:message) { '404 Project Not Found' }
end
end
context 'when authenticated', 'as an owner' do
let(:current_user) { user }
it_behaves_like 'ref new comment'
it 'returns the inline comment' do it 'returns the inline comment' do
post api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}/comments", user), note: 'My comment', path: project.repository.commit.raw_diffs.first.new_path, line: 1, line_type: 'new' post api(route, current_user), note: 'My comment', path: project.repository.commit.raw_diffs.first.new_path, line: 1, line_type: 'new'
expect(response).to have_http_status(201) expect(response).to have_gitlab_http_status(201)
expect(response).to match_response_schema('public_api/v4/commit_note')
expect(json_response['note']).to eq('My comment') expect(json_response['note']).to eq('My comment')
expect(json_response['path']).to eq(project.repository.commit.raw_diffs.first.new_path) expect(json_response['path']).to eq(project.repository.commit.raw_diffs.first.new_path)
expect(json_response['line']).to eq(1) expect(json_response['line']).to eq(1)
expect(json_response['line_type']).to eq('new') expect(json_response['line_type']).to eq('new')
end end
context 'when ref does not exist' do
let(:commit_id) { 'unknown' }
it_behaves_like '404 response' do
let(:request) { post api(route, current_user), note: 'My comment' }
let(:message) { '404 Commit Not Found' }
end
end
it 'returns 400 if note is missing' do it 'returns 400 if note is missing' do
post api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}/comments", user) post api(route, current_user)
expect(response).to have_http_status(400)
expect(response).to have_gitlab_http_status(400)
end end
it 'returns 404 if note is attached to non existent commit' do context 'when ref contains a dot' do
post api("/projects/#{project.id}/repository/commits/1234ab/comments", user), note: 'My comment' let(:commit_id) { branch_with_dot.name }
expect(response).to have_http_status(404)
it_behaves_like 'ref new comment'
end
context 'when ref contains a slash' do
let(:commit_id) { branch_with_slash.name }
it_behaves_like '404 response' do
let(:request) { post api(route, current_user), note: 'My comment' }
end
end end
context 'when ref contains an escaped slash' do
let(:commit_id) { CGI.escape(branch_with_slash.name) }
it_behaves_like 'ref new comment'
end end
context 'unauthorized user' do context 'requesting with the escaped project full path' do
it 'does not return the diff of the selected commit' do let(:project_id) { CGI.escape(project.full_path) }
post api("/projects/#{project.id}/repository/commits/#{project.repository.commit.id}/comments")
expect(response).to have_http_status(401) it_behaves_like 'ref new comment'
context 'when ref contains a dot' do
let(:commit_id) { branch_with_dot.name }
it_behaves_like 'ref new comment'
end
end end
end end
end end
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7