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

521 lines
16 KiB
Ruby
Raw Normal View History

2019-12-21 20:55:43 +05:30
# frozen_string_literal: true
2016-09-13 17:45:13 +05:30
require 'spec_helper'
2020-07-28 23:09:34 +05:30
RSpec.describe API::Deployments do
2021-04-29 21:17:54 +05:30
let_it_be(:user) { create(:user) }
let_it_be(:non_member) { create(:user) }
2016-09-13 17:45:13 +05:30
before do
2018-11-18 11:00:15 +05:30
project.add_maintainer(user)
2016-09-13 17:45:13 +05:30
end
describe 'GET /projects/:id/deployments' do
2021-04-29 21:17:54 +05:30
let_it_be(:project) { create(:project, :repository) }
2021-06-08 01:23:25 +05:30
let_it_be(:production) { create(:environment, :production, project: project) }
let_it_be(:staging) { create(:environment, :staging, project: project) }
let_it_be(:deployment_1) { create(:deployment, :success, project: project, environment: production, ref: 'master', created_at: Time.now, updated_at: Time.now) }
let_it_be(:deployment_2) { create(:deployment, :success, project: project, environment: staging, ref: 'master', created_at: 1.day.ago, updated_at: 2.hours.ago) }
let_it_be(:deployment_3) { create(:deployment, :success, project: project, environment: staging, ref: 'master', created_at: 2.days.ago, updated_at: 1.hour.ago) }
2021-04-29 21:17:54 +05:30
def perform_request(params = {})
get api("/projects/#{project.id}/deployments", user), params: params
end
2018-03-17 18:26:18 +05:30
2016-09-13 17:45:13 +05:30
context 'as member of the project' do
2018-03-17 18:26:18 +05:30
it 'returns projects deployments sorted by id asc' do
2021-04-29 21:17:54 +05:30
perform_request
2016-09-13 17:45:13 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2017-08-17 22:00:37 +05:30
expect(response).to include_pagination_headers
2016-09-13 17:45:13 +05:30
expect(json_response).to be_an Array
2018-03-17 18:26:18 +05:30
expect(json_response.size).to eq(3)
expect(json_response.first['iid']).to eq(deployment_1.iid)
2016-09-13 17:45:13 +05:30
expect(json_response.first['sha']).to match /\A\h{40}\z/
2018-03-17 18:26:18 +05:30
expect(json_response.second['iid']).to eq(deployment_2.iid)
expect(json_response.last['iid']).to eq(deployment_3.iid)
end
2020-01-01 13:55:28 +05:30
context 'with updated_at filters specified' do
it 'returns projects deployments with last update in specified datetime range' do
2021-06-08 01:23:25 +05:30
perform_request({ updated_before: 30.minutes.ago, updated_after: 90.minutes.ago, order_by: :updated_at })
2018-03-17 18:26:18 +05:30
2020-01-01 13:55:28 +05:30
expect(response).to have_gitlab_http_status(:ok)
expect(response).to include_pagination_headers
expect(json_response.first['id']).to eq(deployment_3.id)
end
2021-06-08 01:23:25 +05:30
context 'when forbidden order_by is specified' do
it 'returns projects deployments with last update in specified datetime range' do
perform_request({ updated_before: 30.minutes.ago, updated_after: 90.minutes.ago, order_by: :id })
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']).to include('`updated_at` filter and `updated_at` sorting must be paired')
end
end
2020-01-01 13:55:28 +05:30
end
2020-03-13 15:44:24 +05:30
context 'with the environment filter specifed' do
it 'returns deployments for the environment' do
2021-06-08 01:23:25 +05:30
perform_request({ environment: production.name })
2020-03-13 15:44:24 +05:30
expect(json_response.size).to eq(1)
expect(json_response.first['iid']).to eq(deployment_1.iid)
end
end
2020-01-01 13:55:28 +05:30
describe 'ordering' do
let(:order_by) { 'iid' }
let(:sort) { 'desc' }
2018-03-17 18:26:18 +05:30
subject { get api("/projects/#{project.id}/deployments?order_by=#{order_by}&sort=#{sort}", user) }
2020-01-01 13:55:28 +05:30
before do
subject
end
2018-03-17 18:26:18 +05:30
def expect_deployments(ordered_deployments)
2020-01-01 13:55:28 +05:30
expect(json_response.map { |d| d['id'] }).to eq(ordered_deployments.map(&:id))
2018-03-17 18:26:18 +05:30
end
2020-01-01 13:55:28 +05:30
it 'returns ordered deployments' do
2021-06-08 01:23:25 +05:30
expect(json_response.map { |i| i['id'] }).to eq([deployment_3.id, deployment_2.id, deployment_1.id])
2018-03-17 18:26:18 +05:30
end
2020-01-01 13:55:28 +05:30
context 'with invalid order_by' do
let(:order_by) { 'wrong_sorting_value' }
it 'returns error' do
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2020-01-01 13:55:28 +05:30
end
2018-03-17 18:26:18 +05:30
end
2020-01-01 13:55:28 +05:30
context 'with invalid sorting' do
let(:sort) { 'wrong_sorting_direction' }
it 'returns error' do
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2018-03-17 18:26:18 +05:30
end
end
2016-09-13 17:45:13 +05:30
end
2021-04-29 21:17:54 +05:30
it 'returns multiple deployments without N + 1' do
perform_request # warm up the cache
control_count = ActiveRecord::QueryRecorder.new { perform_request }.count
create(:deployment, :success, project: project, iid: 21, ref: 'master')
expect { perform_request }.not_to exceed_query_limit(control_count)
end
2016-09-13 17:45:13 +05:30
end
context 'as non member' do
it 'returns a 404 status code' do
get api("/projects/#{project.id}/deployments", non_member)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2016-09-13 17:45:13 +05:30
end
end
end
describe 'GET /projects/:id/deployments/:deployment_id' do
2018-03-17 18:26:18 +05:30
let(:project) { deployment.environment.project }
2018-12-13 13:39:08 +05:30
let!(:deployment) { create(:deployment, :success) }
2018-03-17 18:26:18 +05:30
2016-09-13 17:45:13 +05:30
context 'as a member of the project' do
it 'returns the projects deployment' do
get api("/projects/#{project.id}/deployments/#{deployment.id}", user)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2016-09-13 17:45:13 +05:30
expect(json_response['sha']).to match /\A\h{40}\z/
expect(json_response['id']).to eq(deployment.id)
end
end
context 'as non member' do
it 'returns a 404 status code' do
get api("/projects/#{project.id}/deployments/#{deployment.id}", non_member)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2016-09-13 17:45:13 +05:30
end
end
end
2019-12-21 20:55:43 +05:30
describe 'POST /projects/:id/deployments' do
let!(:project) { create(:project, :repository) }
2020-03-13 15:44:24 +05:30
# * ddd0f15ae83993f5cb66a927a28673882e99100b (HEAD -> master, origin/master, origin/HEAD) Merge branch 'po-fix-test-en
# |\
# | * 2d1db523e11e777e49377cfb22d368deec3f0793 Correct test_env.rb path for adding branch
# |/
# * 1e292f8fedd741b75372e19097c76d327140c312 Merge branch 'cherry-pick-ce369011' into 'master'
let_it_be(:sha) { 'ddd0f15ae83993f5cb66a927a28673882e99100b' }
let_it_be(:first_deployment_sha) { '1e292f8fedd741b75372e19097c76d327140c312' }
before do
# Creating the first deployment is an edge-case that is already covered by unit testing,
# here we want to see the behavior of a running system so we create a first deployment
post(
api("/projects/#{project.id}/deployments", user),
params: {
environment: 'production',
sha: first_deployment_sha,
ref: 'master',
tag: false,
status: 'success'
}
)
end
2019-12-21 20:55:43 +05:30
context 'as a maintainer' do
it 'creates a new deployment' do
post(
api("/projects/#{project.id}/deployments", user),
params: {
environment: 'production',
sha: sha,
ref: 'master',
tag: false,
status: 'success'
}
)
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(sha)
expect(json_response['ref']).to eq('master')
expect(json_response['environment']['name']).to eq('production')
end
it 'errors when creating a deployment with an invalid name' do
post(
api("/projects/#{project.id}/deployments", user),
params: {
environment: 'a' * 300,
sha: sha,
ref: 'master',
tag: false,
status: 'success'
}
)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:internal_server_error)
2019-12-21 20:55:43 +05:30
end
2019-12-26 22:10:19 +05:30
2020-01-01 13:55:28 +05:30
it 'links any merged merge requests to the deployment', :sidekiq_inline do
2019-12-26 22:10:19 +05:30
mr = create(
:merge_request,
:merged,
2020-03-13 15:44:24 +05:30
merge_commit_sha: sha,
2019-12-26 22:10:19 +05:30
target_project: project,
source_project: project,
target_branch: 'master',
source_branch: 'foo'
)
post(
api("/projects/#{project.id}/deployments", user),
params: {
environment: 'production',
sha: sha,
ref: 'master',
tag: false,
status: 'success'
}
)
deploy = project.deployments.last
expect(deploy.merge_requests).to eq([mr])
end
2019-12-21 20:55:43 +05:30
end
context 'as a developer' do
2019-12-26 22:10:19 +05:30
let(:developer) { create(:user) }
2019-12-21 20:55:43 +05:30
2019-12-26 22:10:19 +05:30
before do
2019-12-21 20:55:43 +05:30
project.add_developer(developer)
2019-12-26 22:10:19 +05:30
end
2019-12-21 20:55:43 +05:30
2019-12-26 22:10:19 +05:30
it 'creates a new deployment' do
2019-12-21 20:55:43 +05:30
post(
api("/projects/#{project.id}/deployments", developer),
params: {
environment: 'production',
sha: sha,
ref: 'master',
tag: false,
status: 'success'
}
)
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(sha)
expect(json_response['ref']).to eq('master')
end
2019-12-26 22:10:19 +05:30
2020-01-01 13:55:28 +05:30
it 'links any merged merge requests to the deployment', :sidekiq_inline do
2019-12-26 22:10:19 +05:30
mr = create(
:merge_request,
:merged,
2020-03-13 15:44:24 +05:30
merge_commit_sha: sha,
2019-12-26 22:10:19 +05:30
target_project: project,
source_project: project,
target_branch: 'master',
source_branch: 'foo'
)
post(
api("/projects/#{project.id}/deployments", developer),
params: {
environment: 'production',
sha: sha,
ref: 'master',
tag: false,
status: 'success'
}
)
deploy = project.deployments.last
expect(deploy.merge_requests).to eq([mr])
end
2020-03-13 15:44:24 +05:30
it 'links any picked merge requests to the deployment', :sidekiq_inline do
mr = create(
:merge_request,
:merged,
merge_commit_sha: sha,
target_project: project,
source_project: project,
target_branch: 'master',
source_branch: 'foo'
)
# we branch from the previous deployment and cherry-pick mr into the new branch
branch = project.repository.add_branch(developer, 'stable', first_deployment_sha)
expect(branch).not_to be_nil
result = ::Commits::CherryPickService
.new(project, developer, commit: mr.merge_commit, start_branch: 'stable', branch_name: 'stable')
.execute
expect(result[:status]).to eq(:success), result[:message]
pick_sha = result[:result]
post(
api("/projects/#{project.id}/deployments", developer),
params: {
environment: 'production',
sha: pick_sha,
ref: 'stable',
tag: false,
status: 'success'
}
)
deploy = project.deployments.last
expect(deploy.merge_requests).to eq([mr])
end
2019-12-21 20:55:43 +05:30
end
context 'as non member' do
it 'returns a 404 status code' do
post(
api( "/projects/#{project.id}/deployments", non_member),
params: {
environment: 'production',
sha: '123',
ref: 'master',
tag: false,
status: 'success'
}
)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2019-12-21 20:55:43 +05:30
end
end
end
describe 'PUT /projects/:id/deployments/:deployment_id' do
2019-12-26 22:10:19 +05:30
let(:project) { create(:project, :repository) }
2019-12-21 20:55:43 +05:30
let(:build) { create(:ci_build, :failed, project: project) }
let(:environment) { create(:environment, project: project) }
let(:deploy) do
create(
:deployment,
:failed,
project: project,
environment: environment,
2019-12-26 22:10:19 +05:30
deployable: nil,
sha: project.commit.sha
2019-12-21 20:55:43 +05:30
)
end
context 'as a maintainer' do
it 'returns a 403 when updating a deployment with a build' do
2021-04-29 21:17:54 +05:30
deploy.update!(deployable: build)
2019-12-21 20:55:43 +05:30
put(
api("/projects/#{project.id}/deployments/#{deploy.id}", user),
params: { status: 'success' }
)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2019-12-21 20:55:43 +05:30
end
it 'updates a deployment without an associated build' do
put(
api("/projects/#{project.id}/deployments/#{deploy.id}", user),
params: { status: 'success' }
)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2019-12-21 20:55:43 +05:30
expect(json_response['status']).to eq('success')
end
2019-12-26 22:10:19 +05:30
2021-11-18 22:05:49 +05:30
it 'returns an error when an invalid status transition is detected' do
put(
api("/projects/#{project.id}/deployments/#{deploy.id}", user),
params: { status: 'running' }
)
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']['status']).to include(%Q{cannot transition via \"run\"})
end
2019-12-26 22:10:19 +05:30
it 'links merge requests when the deployment status changes to success', :sidekiq_inline do
mr = create(
:merge_request,
:merged,
target_project: project,
source_project: project,
target_branch: 'master',
source_branch: 'foo'
)
put(
api("/projects/#{project.id}/deployments/#{deploy.id}", user),
params: { status: 'success' }
)
deploy = project.deployments.last
expect(deploy.merge_requests).to eq([mr])
end
2019-12-21 20:55:43 +05:30
end
context 'as a developer' do
let(:developer) { create(:user) }
before do
project.add_developer(developer)
end
it 'returns a 403 when updating a deployment with a build' do
2021-04-29 21:17:54 +05:30
deploy.update!(deployable: build)
2019-12-21 20:55:43 +05:30
put(
api("/projects/#{project.id}/deployments/#{deploy.id}", developer),
params: { status: 'success' }
)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2019-12-21 20:55:43 +05:30
end
it 'updates a deployment without an associated build' do
put(
api("/projects/#{project.id}/deployments/#{deploy.id}", developer),
params: { status: 'success' }
)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2019-12-21 20:55:43 +05:30
expect(json_response['status']).to eq('success')
end
end
context 'as non member' do
it 'returns a 404 status code' do
put(
api("/projects/#{project.id}/deployments/#{deploy.id}", non_member),
params: { status: 'success' }
)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2019-12-21 20:55:43 +05:30
end
end
end
2020-01-01 13:55:28 +05:30
2020-03-13 15:44:24 +05:30
describe 'GET /projects/:id/deployments/:deployment_id/merge_requests' do
let(:project) { create(:project, :repository) }
let!(:deployment) { create(:deployment, :success, project: project) }
2020-01-01 13:55:28 +05:30
2020-03-13 15:44:24 +05:30
subject { get api("/projects/#{project.id}/deployments/#{deployment.id}/merge_requests", user) }
context 'when a user is not a member of the deployment project' do
let(:user) { build(:user) }
2020-01-01 13:55:28 +05:30
2020-03-13 15:44:24 +05:30
it 'returns a 404 status code' do
subject
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2020-01-01 13:55:28 +05:30
end
2020-03-13 15:44:24 +05:30
end
context 'when a user member of the deployment project' do
let_it_be(:project2) { create(:project) }
2021-09-30 23:02:18 +05:30
2020-03-13 15:44:24 +05:30
let!(:merge_request1) { create(:merge_request, source_project: project, target_project: project) }
let!(:merge_request2) { create(:merge_request, source_project: project, target_project: project, state: 'closed') }
let!(:merge_request3) { create(:merge_request, source_project: project2, target_project: project2) }
it 'returns the relevant merge requests linked to a deployment for a project' do
2020-05-24 23:13:21 +05:30
deployment.link_merge_requests(MergeRequest.where(id: [merge_request1.id, merge_request2.id]))
2020-03-13 15:44:24 +05:30
subject
2020-01-01 13:55:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
expect(response).to include_pagination_headers
2020-03-13 15:44:24 +05:30
expect(json_response.map { |d| d['id'] }).to contain_exactly(merge_request1.id, merge_request2.id)
2020-01-01 13:55:28 +05:30
end
2020-03-13 15:44:24 +05:30
context 'when a deployment is not associated to any existing merge requests' do
it 'returns an empty array' do
subject
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2020-03-13 15:44:24 +05:30
expect(json_response).to eq([])
end
2020-01-01 13:55:28 +05:30
end
2020-03-13 15:44:24 +05:30
end
end
2020-01-01 13:55:28 +05:30
2020-03-13 15:44:24 +05:30
context 'prevent N + 1 queries' do
context 'when the endpoint returns multiple records' do
let(:project) { create(:project, :repository) }
let!(:deployment) { create(:deployment, :success, project: project) }
2020-01-01 13:55:28 +05:30
2021-06-08 01:23:25 +05:30
subject { get api("/projects/#{project.id}/deployments?order_by=id&sort=asc", user) }
2020-03-13 15:44:24 +05:30
it 'succeeds', :aggregate_failures do
subject
2020-01-01 13:55:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2020-01-01 13:55:28 +05:30
expect(json_response.size).to eq(1)
end
2020-03-13 15:44:24 +05:30
context 'with 10 more records' do
it 'does not increase the query count', :aggregate_failures do
create_list(:deployment, 10, :success, project: project)
expect { subject }.not_to be_n_plus_1_query
2020-01-01 13:55:28 +05:30
2020-03-13 15:44:24 +05:30
expect(json_response.size).to eq(11)
end
2020-01-01 13:55:28 +05:30
end
end
end
2016-09-13 17:45:13 +05:30
end