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

522 lines
18 KiB
Ruby
Raw Normal View History

2019-12-26 22:10:19 +05:30
# frozen_string_literal: true
2016-06-02 11:05:42 +05:30
require 'spec_helper'
2020-07-28 23:09:34 +05:30
RSpec.describe API::CommitStatuses do
2021-09-04 01:27:46 +05:30
let_it_be(:project) { create(:project, :repository) }
let_it_be(:commit) { project.repository.commit }
let_it_be(:guest) { create_user(:guest) }
let_it_be(:reporter) { create_user(:reporter) }
let_it_be(:developer) { create_user(:developer) }
let_it_be(:sha) { commit.id }
2016-06-02 11:05:42 +05:30
describe "GET /projects/:id/repository/commits/:sha/statuses" do
let(:get_url) { "/projects/#{project.id}/repository/commits/#{sha}/statuses" }
context 'ci commit exists' do
2021-04-29 21:17:54 +05:30
let!(:master) { project.ci_pipelines.create!(source: :push, sha: commit.id, ref: 'master', protected: false) }
let!(:develop) { project.ci_pipelines.create!(source: :push, sha: commit.id, ref: 'develop', protected: false) }
2016-06-02 11:05:42 +05:30
context "reporter user" do
let(:statuses_id) { json_response.map { |status| status['id'] } }
def create_status(commit, opts = {})
create(:commit_status, { pipeline: commit, ref: commit.ref }.merge(opts))
2016-06-02 11:05:42 +05:30
end
2017-08-17 22:00:37 +05:30
let!(:status1) { create_status(master, status: 'running', retried: true) }
let!(:status2) { create_status(master, name: 'coverage', status: 'pending', retried: true) }
2016-06-02 11:05:42 +05:30
let!(:status3) { create_status(develop, status: 'running', allow_failure: true) }
let!(:status4) { create_status(master, name: 'coverage', status: 'success') }
let!(:status5) { create_status(develop, name: 'coverage', status: 'success') }
let!(:status6) { create_status(master, status: 'success') }
context 'latest commit statuses' do
2017-09-10 17:25:29 +05:30
before do
get api(get_url, reporter)
end
2016-06-02 11:05:42 +05:30
it 'returns latest commit statuses' do
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2016-06-02 11:05:42 +05:30
2017-08-17 22:00:37 +05:30
expect(response).to include_pagination_headers
2016-06-02 11:05:42 +05:30
expect(json_response).to be_an Array
expect(statuses_id).to contain_exactly(status3.id, status4.id, status5.id, status6.id)
2018-03-17 18:26:18 +05:30
json_response.sort_by! { |status| status['id'] }
expect(json_response.map { |status| status['allow_failure'] }).to eq([true, false, false, false])
2016-06-02 11:05:42 +05:30
end
end
context 'all commit statuses' do
2017-09-10 17:25:29 +05:30
before do
2019-02-15 15:39:39 +05:30
get api(get_url, reporter), params: { all: 1 }
2017-09-10 17:25:29 +05:30
end
2016-06-02 11:05:42 +05:30
it 'returns all commit statuses' do
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(response).to include_pagination_headers
2016-06-02 11:05:42 +05:30
expect(json_response).to be_an Array
expect(statuses_id).to contain_exactly(status1.id, status2.id,
status3.id, status4.id,
status5.id, status6.id)
end
end
context 'latest commit statuses for specific ref' do
2017-09-10 17:25:29 +05:30
before do
2019-02-15 15:39:39 +05:30
get api(get_url, reporter), params: { ref: 'develop' }
2017-09-10 17:25:29 +05:30
end
2016-06-02 11:05:42 +05:30
it 'returns latest commit statuses for specific ref' do
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(response).to include_pagination_headers
2016-06-02 11:05:42 +05:30
expect(json_response).to be_an Array
expect(statuses_id).to contain_exactly(status3.id, status5.id)
end
end
context 'latest commit statues for specific name' do
2017-09-10 17:25:29 +05:30
before do
2019-02-15 15:39:39 +05:30
get api(get_url, reporter), params: { name: 'coverage' }
2017-09-10 17:25:29 +05:30
end
2016-06-02 11:05:42 +05:30
it 'return latest commit statuses for specific name' do
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(response).to include_pagination_headers
2016-06-02 11:05:42 +05:30
expect(json_response).to be_an Array
expect(statuses_id).to contain_exactly(status4.id, status5.id)
end
end
end
end
context 'ci commit does not exist' do
2017-09-10 17:25:29 +05:30
before do
get api(get_url, reporter)
end
2016-06-02 11:05:42 +05:30
it 'returns empty array' do
2020-04-22 19:07:51 +05:30
expect(response).to have_gitlab_http_status(:ok)
2016-06-02 11:05:42 +05:30
expect(json_response).to be_an Array
expect(json_response).to be_empty
end
end
context "guest user" do
2017-09-10 17:25:29 +05:30
before do
get api(get_url, guest)
end
2016-06-02 11:05:42 +05:30
2016-09-13 17:45:13 +05:30
it "does not return project commits" do
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2016-06-02 11:05:42 +05:30
end
end
context "unauthorized user" do
2017-09-10 17:25:29 +05:30
before do
get api(get_url)
end
2016-06-02 11:05:42 +05:30
2016-09-13 17:45:13 +05:30
it "does not return project commits" do
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:unauthorized)
2016-06-02 11:05:42 +05:30
end
end
end
describe 'POST /projects/:id/statuses/:sha' do
let(:post_url) { "/projects/#{project.id}/statuses/#{sha}" }
context 'developer user' do
2019-12-21 20:55:43 +05:30
context 'uses only required parameters' do
%w[pending running success failed canceled].each do |status|
context "for #{status}" do
context 'when pipeline for sha does not exists' do
it 'creates commit status' do
post api(post_url, developer), params: { state: status }
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:created)
2019-12-21 20:55:43 +05:30
expect(json_response['sha']).to eq(commit.id)
expect(json_response['status']).to eq(status)
expect(json_response['name']).to eq('default')
expect(json_response['ref']).not_to be_empty
expect(json_response['target_url']).to be_nil
expect(json_response['description']).to be_nil
if status == 'failed'
expect(CommitStatus.find(json_response['id'])).to be_api_failure
end
end
end
end
end
context 'when pipeline already exists for the specified sha' do
let!(:pipeline) { create(:ci_pipeline, project: project, sha: sha, ref: 'ref') }
let(:params) { { state: 'pending' } }
shared_examples_for 'creates a commit status for the existing pipeline' do
it do
expect do
post api(post_url, developer), params: params
end.not_to change { Ci::Pipeline.count }
job = pipeline.statuses.find_by_name(json_response['name'])
2016-09-29 09:46:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:created)
2019-12-21 20:55:43 +05:30
expect(job.status).to eq('pending')
2020-02-01 01:16:34 +05:30
expect(job.stage_idx).to eq(GenericCommitStatus::EXTERNAL_STAGE_IDX)
2016-09-29 09:46:39 +05:30
end
end
2019-12-21 20:55:43 +05:30
it_behaves_like 'creates a commit status for the existing pipeline'
context 'with pipeline for merge request' do
let!(:merge_request) { create(:merge_request, :with_detached_merge_request_pipeline, source_project: project) }
let!(:pipeline) { merge_request.all_pipelines.last }
let(:sha) { pipeline.sha }
it_behaves_like 'creates a commit status for the existing pipeline'
end
2016-09-29 09:46:39 +05:30
end
end
context 'transitions status from pending' do
before do
2019-02-15 15:39:39 +05:30
post api(post_url, developer), params: { state: 'pending' }
2016-09-29 09:46:39 +05:30
end
%w[running success failed canceled].each do |status|
it "to #{status}" do
2019-02-15 15:39:39 +05:30
expect { post api(post_url, developer), params: { state: status } }.not_to change { CommitStatus.count }
2016-09-29 09:46:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:created)
2016-09-29 09:46:39 +05:30
expect(json_response['status']).to eq(status)
end
2016-06-02 11:05:42 +05:30
end
end
context 'with all optional parameters' do
2017-08-17 22:00:37 +05:30
context 'when creating a commit status' do
2017-09-10 17:25:29 +05:30
subject do
2019-02-15 15:39:39 +05:30
post api(post_url, developer), params: {
2017-08-17 22:00:37 +05:30
state: 'success',
context: 'coverage',
2017-09-10 17:25:29 +05:30
ref: 'master',
2017-08-17 22:00:37 +05:30
description: 'test',
coverage: 80.0,
target_url: 'http://gitlab.com/status'
}
2017-09-10 17:25:29 +05:30
end
it 'creates commit status' do
subject
2016-06-02 11:05:42 +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['sha']).to eq(commit.id)
expect(json_response['status']).to eq('success')
expect(json_response['name']).to eq('coverage')
2017-09-10 17:25:29 +05:30
expect(json_response['ref']).to eq('master')
2017-08-17 22:00:37 +05:30
expect(json_response['coverage']).to eq(80.0)
expect(json_response['description']).to eq('test')
expect(json_response['target_url']).to eq('http://gitlab.com/status')
end
2017-09-10 17:25:29 +05:30
context 'when merge request exists for given branch' do
let!(:merge_request) { create(:merge_request, source_project: project, source_branch: 'master', target_branch: 'develop') }
it 'sets head pipeline' do
subject
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:created)
2017-09-10 17:25:29 +05:30
expect(merge_request.reload.head_pipeline).not_to be_nil
end
end
2016-06-02 11:05:42 +05:30
end
2021-09-04 01:27:46 +05:30
context 'when updating a commit status' do
let(:parameters) do
{
state: 'success',
name: 'coverage',
ref: 'master'
}
end
let(:updatable_optional_attributes) do
{
description: 'new description',
coverage: 90.0
}
end
# creating the initial commit status
2017-08-17 22:00:37 +05:30
before do
2019-02-15 15:39:39 +05:30
post api(post_url, developer), params: {
2017-08-17 22:00:37 +05:30
state: 'running',
context: 'coverage',
2017-09-10 17:25:29 +05:30
ref: 'master',
2017-08-17 22:00:37 +05:30
description: 'coverage test',
2021-09-04 01:27:46 +05:30
coverage: 10.0,
2017-08-17 22:00:37 +05:30
target_url: 'http://gitlab.com/status'
}
2021-09-04 01:27:46 +05:30
end
2017-08-17 22:00:37 +05:30
2021-09-04 01:27:46 +05:30
subject(:send_request) do
2019-02-15 15:39:39 +05:30
post api(post_url, developer), params: {
2021-09-04 01:27:46 +05:30
**parameters,
**updatable_optional_attributes
2017-08-17 22:00:37 +05:30
}
end
it 'updates a commit status' do
2021-09-04 01:27:46 +05:30
send_request
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['sha']).to eq(commit.id)
expect(json_response['status']).to eq('success')
expect(json_response['name']).to eq('coverage')
2017-09-10 17:25:29 +05:30
expect(json_response['ref']).to eq('master')
2017-08-17 22:00:37 +05:30
expect(json_response['coverage']).to eq(90.0)
expect(json_response['description']).to eq('new description')
expect(json_response['target_url']).to eq('http://gitlab.com/status')
end
it 'does not create a new commit status' do
2021-09-04 01:27:46 +05:30
expect { send_request }.not_to change { CommitStatus.count }
end
context 'when the `state` parameter is sent the same' do
let(:parameters) do
{
state: 'running',
name: 'coverage',
ref: 'master'
}
end
it 'does not update the commit status' do
send_request
expect(response).to have_gitlab_http_status(:bad_request)
commit_status = project.commit_statuses.find_by!(name: 'coverage')
expect(commit_status.description).to eq('coverage test')
expect(commit_status.coverage).to eq(10.0)
end
2017-08-17 22:00:37 +05:30
end
2016-06-02 11:05:42 +05:30
end
2019-10-12 21:52:04 +05:30
context 'when a pipeline id is specified' do
2021-04-29 21:17:54 +05:30
let!(:first_pipeline) { project.ci_pipelines.create!(source: :push, sha: commit.id, ref: 'master', status: 'created') }
let!(:other_pipeline) { project.ci_pipelines.create!(source: :push, sha: commit.id, ref: 'master', status: 'created') }
2019-10-12 21:52:04 +05:30
subject do
post api(post_url, developer), params: {
pipeline_id: other_pipeline.id,
state: 'success',
ref: 'master'
}
end
2019-12-26 22:10:19 +05:30
it 'update the correct pipeline', :sidekiq_might_not_need_inline do
2019-10-12 21:52:04 +05:30
subject
expect(first_pipeline.reload.status).to eq('created')
expect(other_pipeline.reload.status).to eq('success')
end
end
2016-06-02 11:05:42 +05:30
end
2017-09-10 17:25:29 +05:30
context 'when retrying a commit status' do
2021-04-17 20:07:23 +05:30
subject(:post_request) do
2017-09-10 17:25:29 +05:30
post api(post_url, developer),
2019-02-15 15:39:39 +05:30
params: { state: 'failed', name: 'test', ref: 'master' }
2017-09-10 17:25:29 +05:30
post api(post_url, developer),
2019-02-15 15:39:39 +05:30
params: { state: 'success', name: 'test', ref: 'master' }
2017-09-10 17:25:29 +05:30
end
it 'correctly posts a new commit status' do
2021-04-17 20:07:23 +05:30
post_request
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:created)
2017-09-10 17:25:29 +05:30
expect(json_response['sha']).to eq(commit.id)
expect(json_response['status']).to eq('success')
end
2021-04-17 20:07:23 +05:30
context 'feature flags' do
using RSpec::Parameterized::TableSyntax
where(:ci_fix_commit_status_retried, :ci_remove_update_retried_from_process_pipeline, :previous_statuses_retried) do
true | true | true
true | false | true
false | true | false
false | false | true
end
with_them do
before do
stub_feature_flags(
ci_fix_commit_status_retried: ci_fix_commit_status_retried,
ci_remove_update_retried_from_process_pipeline: ci_remove_update_retried_from_process_pipeline
)
end
it 'retries a commit status', :sidekiq_might_not_need_inline do
post_request
expect(CommitStatus.count).to eq 2
if previous_statuses_retried
expect(CommitStatus.first).to be_retried
expect(CommitStatus.last.pipeline).to be_success
else
expect(CommitStatus.first).not_to be_retried
expect(CommitStatus.last.pipeline).to be_failed
end
end
end
2017-09-10 17:25:29 +05:30
end
end
2017-08-17 22:00:37 +05:30
context 'when status is invalid' do
2017-09-10 17:25:29 +05:30
before do
2019-02-15 15:39:39 +05:30
post api(post_url, developer), params: { state: 'invalid' }
2017-09-10 17:25:29 +05:30
end
2016-06-02 11:05:42 +05:30
it 'does not create commit status' do
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2016-06-02 11:05:42 +05:30
end
end
2017-08-17 22:00:37 +05:30
context 'when request without a state made' do
2017-09-10 17:25:29 +05:30
before do
post api(post_url, developer)
end
2016-06-02 11:05:42 +05:30
it 'does not create commit status' do
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2016-06-02 11:05:42 +05:30
end
end
2020-02-01 01:16:34 +05:30
context 'when updating a protected ref' do
before do
create(:protected_branch, project: project, name: 'master')
post api(post_url, user), params: { state: 'running', ref: 'master' }
end
context 'with user as developer' do
let(:user) { developer }
it 'does not create commit status' do
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2020-02-01 01:16:34 +05:30
end
end
context 'with user as maintainer' do
let(:user) { create_user(:maintainer) }
it 'creates commit status' do
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:created)
2020-02-01 01:16:34 +05:30
end
end
end
2017-08-17 22:00:37 +05:30
context 'when commit SHA is invalid' do
2016-06-02 11:05:42 +05:30
let(:sha) { 'invalid_sha' }
2017-09-10 17:25:29 +05:30
before do
2019-02-15 15:39:39 +05:30
post api(post_url, developer), params: { state: 'running' }
2017-09-10 17:25:29 +05:30
end
2016-06-02 11:05:42 +05:30
it 'returns not found error' do
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2016-06-02 11:05:42 +05:30
end
end
2017-08-17 22:00:37 +05:30
context 'when target URL is an invalid address' do
before do
2019-02-15 15:39:39 +05:30
post api(post_url, developer), params: {
state: 'pending',
target_url: 'invalid url'
}
2017-08-17 22:00:37 +05:30
end
it 'responds with bad request status and validation errors' do
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2017-08-17 22:00:37 +05:30
expect(json_response['message']['target_url'])
2019-12-21 20:55:43 +05:30
.to include 'is blocked: Only allowed schemes are http, https'
2019-07-31 22:56:46 +05:30
end
end
context 'when target URL is an unsupported scheme' do
before do
post api(post_url, developer), params: {
state: 'pending',
target_url: 'git://example.com'
}
end
it 'responds with bad request status and validation errors' do
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2019-07-31 22:56:46 +05:30
expect(json_response['message']['target_url'])
.to include 'is blocked: Only allowed schemes are http, https'
2017-08-17 22:00:37 +05:30
end
end
2020-02-01 01:16:34 +05:30
context 'when trying to update a status of a different type' do
let!(:pipeline) { create(:ci_pipeline, project: project, sha: sha, ref: 'ref') }
let!(:ci_build) { create(:ci_build, pipeline: pipeline, name: 'test-job') }
let(:params) { { state: 'pending', name: 'test-job' } }
before do
post api(post_url, developer), params: params
end
it 'responds with bad request status and validation errors' do
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2020-02-01 01:16:34 +05:30
expect(json_response['message']['name'])
.to include 'has already been taken'
end
end
2016-06-02 11:05:42 +05:30
end
context 'reporter user' do
2017-09-10 17:25:29 +05:30
before do
2019-02-15 15:39:39 +05:30
post api(post_url, reporter), params: { state: 'running' }
2017-09-10 17:25:29 +05:30
end
2016-06-02 11:05:42 +05:30
2016-09-13 17:45:13 +05:30
it 'does not create commit status' do
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2016-06-02 11:05:42 +05:30
end
end
context 'guest user' do
2017-09-10 17:25:29 +05:30
before do
2019-02-15 15:39:39 +05:30
post api(post_url, guest), params: { state: 'running' }
2017-09-10 17:25:29 +05:30
end
2016-06-02 11:05:42 +05:30
2016-09-13 17:45:13 +05:30
it 'does not create commit status' do
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2016-06-02 11:05:42 +05:30
end
end
context 'unauthorized user' do
2017-09-10 17:25:29 +05:30
before do
post api(post_url)
end
2016-06-02 11:05:42 +05:30
2016-09-13 17:45:13 +05:30
it 'does not create commit status' do
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:unauthorized)
2016-06-02 11:05:42 +05:30
end
end
end
def create_user(access_level_trait)
user = create(:user)
create(:project_member, access_level_trait, user: user, project: project)
user
end
end