Commit d1b59476 authored by Grzegorz Bizon's avatar Grzegorz Bizon

Make pipeline processing specs more consistent

parent 364fc01e
require 'spec_helper' require 'spec_helper'
describe Ci::ProcessPipelineService, :services do describe Ci::ProcessPipelineService, '#execute', :services do
let(:user) { create(:user) } let(:user) { create(:user) }
let(:project) { create(:empty_project) } let(:project) { create(:empty_project) }
...@@ -12,363 +12,389 @@ describe Ci::ProcessPipelineService, :services do ...@@ -12,363 +12,389 @@ describe Ci::ProcessPipelineService, :services do
project.add_developer(user) project.add_developer(user)
end end
describe '#execute' do context 'start queuing next builds' do
context 'start queuing next builds' do before do
before do create_build('linux', stage_idx: 0)
create_build('linux', stage_idx: 0) create_build('mac', stage_idx: 0)
create_build('mac', stage_idx: 0) create_build('rspec', stage_idx: 1)
create_build('rspec', stage_idx: 1) create_build('rubocop', stage_idx: 1)
create_build('rubocop', stage_idx: 1) create_build('deploy', stage_idx: 2)
create_build('deploy', stage_idx: 2) end
end
it 'processes a pipeline' do it 'processes a pipeline' do
expect(process_pipeline).to be_truthy expect(process_pipeline).to be_truthy
succeed_pending
expect(builds.success.count).to eq(2)
expect(process_pipeline).to be_truthy succeed_pending
succeed_pending
expect(builds.success.count).to eq(4)
expect(process_pipeline).to be_truthy expect(builds.success.count).to eq(2)
succeed_pending expect(process_pipeline).to be_truthy
expect(builds.success.count).to eq(5)
expect(process_pipeline).to be_falsey succeed_pending
end
it 'does not process pipeline if existing stage is running' do expect(builds.success.count).to eq(4)
expect(process_pipeline).to be_truthy expect(process_pipeline).to be_truthy
expect(builds.pending.count).to eq(2)
expect(process_pipeline).to be_falsey succeed_pending
expect(builds.pending.count).to eq(2)
end expect(builds.success.count).to eq(5)
expect(process_pipeline).to be_falsey
end end
context 'custom stage with first job allowed to fail' do it 'does not process pipeline if existing stage is running' do
before do expect(process_pipeline).to be_truthy
create_build('clean_job', stage_idx: 0, allow_failure: true) expect(builds.pending.count).to eq(2)
create_build('test_job', stage_idx: 1, allow_failure: true)
end
it 'automatically triggers a next stage when build finishes' do expect(process_pipeline).to be_falsey
expect(builds.pending.count).to eq(2)
end
end
context 'custom stage with first job allowed to fail' do
before do
create_build('clean_job', stage_idx: 0, allow_failure: true)
create_build('test_job', stage_idx: 1, allow_failure: true)
end
it 'automatically triggers a next stage when build finishes' do
expect(process_pipeline).to be_truthy
expect(builds_statuses).to eq ['pending']
fail_running_or_pending
expect(builds_statuses).to eq ['failed', 'pending']
end
end
context 'properly creates builds when optional actions are defined' do
before do
create_build('build', stage_idx: 0)
create_build('test', stage_idx: 1)
create_build('test_failure', stage_idx: 2, when: 'on_failure')
create_build('deploy', stage_idx: 3)
create_build('production', stage_idx: 3, when: 'manual', allow_failure: true)
create_build('cleanup', stage_idx: 4, when: 'always')
create_build('clear cache', stage_idx: 4, when: 'manual', allow_failure: true)
end
context 'when builds are successful' do
it 'properly creates builds' do
expect(process_pipeline).to be_truthy expect(process_pipeline).to be_truthy
expect(builds.pluck(:status)).to contain_exactly('pending') expect(builds_names).to eq ['build']
expect(builds_statuses).to eq ['pending']
succeed_running_or_pending
expect(builds_names).to eq ['build', 'test']
expect(builds_statuses).to eq ['success', 'pending']
succeed_running_or_pending
pipeline.builds.running_or_pending.each(&:drop) expect(builds_names).to eq ['build', 'test', 'deploy']
expect(builds.pluck(:status)).to contain_exactly('failed', 'pending') expect(builds_statuses).to eq ['success', 'success', 'pending']
succeed_running_or_pending
expect(builds_names).to eq ['build', 'test', 'deploy', 'cleanup']
expect(builds_statuses).to eq ['success', 'success', 'success', 'pending']
succeed_running_or_pending
expect(builds_statuses).to eq ['success', 'success', 'success', 'success']
expect(pipeline.reload.status).to eq 'success'
end end
end end
context 'properly creates builds when optional actions are defined' do context 'when test job fails' do
before do it 'properly creates builds' do
create_build('build', stage_idx: 0) expect(process_pipeline).to be_truthy
create_build('test', stage_idx: 1) expect(builds_names).to eq ['build']
create_build('test_failure', stage_idx: 2, when: 'on_failure') expect(builds_statuses).to eq ['pending']
create_build('deploy', stage_idx: 3)
create_build('production', stage_idx: 3, when: 'manual', allow_failure: true)
create_build('cleanup', stage_idx: 4, when: 'always')
create_build('clear cache', stage_idx: 4, when: 'manual', allow_failure: true)
end
context 'when builds are successful' do succeed_running_or_pending
it 'properly creates builds' do
expect(process_pipeline).to be_truthy
expect(builds.pluck(:name)).to contain_exactly('build')
expect(builds.pluck(:status)).to contain_exactly('pending')
pipeline.builds.running_or_pending.each(&:success)
expect(builds.pluck(:name)).to contain_exactly('build', 'test')
expect(builds.pluck(:status)).to contain_exactly('success', 'pending')
pipeline.builds.running_or_pending.each(&:success)
expect(builds.pluck(:name)).to contain_exactly('build', 'test', 'deploy')
expect(builds.pluck(:status)).to contain_exactly('success', 'success', 'pending')
pipeline.builds.running_or_pending.each(&:success)
expect(builds.pluck(:name)).to contain_exactly('build', 'test', 'deploy', 'cleanup')
expect(builds.pluck(:status)).to contain_exactly('success', 'success', 'success', 'pending')
pipeline.builds.running_or_pending.each(&:success)
expect(builds.pluck(:status)).to contain_exactly('success', 'success', 'success', 'success')
pipeline.reload
expect(pipeline.status).to eq('success')
end
end
context 'when test job fails' do expect(builds_names).to eq ['build', 'test']
it 'properly creates builds' do expect(builds_statuses).to eq ['success', 'pending']
expect(process_pipeline).to be_truthy
expect(builds.pluck(:name)).to contain_exactly('build')
expect(builds.pluck(:status)).to contain_exactly('pending')
pipeline.builds.running_or_pending.each(&:success)
expect(builds.pluck(:name)).to contain_exactly('build', 'test')
expect(builds.pluck(:status)).to contain_exactly('success', 'pending')
pipeline.builds.running_or_pending.each(&:drop)
expect(builds.pluck(:name)).to contain_exactly('build', 'test', 'test_failure')
expect(builds.pluck(:status)).to contain_exactly('success', 'failed', 'pending')
pipeline.builds.running_or_pending.each(&:success)
expect(builds.pluck(:name)).to contain_exactly('build', 'test', 'test_failure', 'cleanup')
expect(builds.pluck(:status)).to contain_exactly('success', 'failed', 'success', 'pending')
pipeline.builds.running_or_pending.each(&:success)
expect(builds.pluck(:status)).to contain_exactly('success', 'failed', 'success', 'success')
pipeline.reload
expect(pipeline.status).to eq('failed')
end
end
context 'when test and test_failure jobs fail' do fail_running_or_pending
it 'properly creates builds' do
expect(process_pipeline).to be_truthy
expect(builds.pluck(:name)).to contain_exactly('build')
expect(builds.pluck(:status)).to contain_exactly('pending')
pipeline.builds.running_or_pending.each(&:success)
expect(builds.pluck(:name)).to contain_exactly('build', 'test')
expect(builds.pluck(:status)).to contain_exactly('success', 'pending')
pipeline.builds.running_or_pending.each(&:drop)
expect(builds.pluck(:name)).to contain_exactly('build', 'test', 'test_failure')
expect(builds.pluck(:status)).to contain_exactly('success', 'failed', 'pending')
pipeline.builds.running_or_pending.each(&:drop)
expect(builds.pluck(:name)).to contain_exactly('build', 'test', 'test_failure', 'cleanup')
expect(builds.pluck(:status)).to contain_exactly('success', 'failed', 'failed', 'pending')
pipeline.builds.running_or_pending.each(&:success)
expect(builds.pluck(:name)).to contain_exactly('build', 'test', 'test_failure', 'cleanup')
expect(builds.pluck(:status)).to contain_exactly('success', 'failed', 'failed', 'success')
pipeline.reload
expect(pipeline.status).to eq('failed')
end
end
context 'when deploy job fails' do expect(builds_names).to eq ['build', 'test', 'test_failure']
it 'properly creates builds' do expect(builds_statuses).to eq ['success', 'failed', 'pending']
expect(process_pipeline).to be_truthy
expect(builds.pluck(:name)).to contain_exactly('build')
expect(builds.pluck(:status)).to contain_exactly('pending')
pipeline.builds.running_or_pending.each(&:success)
expect(builds.pluck(:name)).to contain_exactly('build', 'test')
expect(builds.pluck(:status)).to contain_exactly('success', 'pending')
pipeline.builds.running_or_pending.each(&:success)
expect(builds.pluck(:name)).to contain_exactly('build', 'test', 'deploy')
expect(builds.pluck(:status)).to contain_exactly('success', 'success', 'pending')
pipeline.builds.running_or_pending.each(&:drop)
expect(builds.pluck(:name)).to contain_exactly('build', 'test', 'deploy', 'cleanup')
expect(builds.pluck(:status)).to contain_exactly('success', 'success', 'failed', 'pending')
pipeline.builds.running_or_pending.each(&:success)
expect(builds.pluck(:status)).to contain_exactly('success', 'success', 'failed', 'success')
pipeline.reload
expect(pipeline.status).to eq('failed')
end
end
context 'when build is canceled in the second stage' do succeed_running_or_pending
it 'does not schedule builds after build has been canceled' do
expect(process_pipeline).to be_truthy
expect(builds.pluck(:name)).to contain_exactly('build')
expect(builds.pluck(:status)).to contain_exactly('pending')
pipeline.builds.running_or_pending.each(&:success)
expect(builds.running_or_pending).not_to be_empty expect(builds_names).to eq ['build', 'test', 'test_failure', 'cleanup']
expect(builds_statuses).to eq ['success', 'failed', 'success', 'pending']
expect(builds.pluck(:name)).to contain_exactly('build', 'test') succeed_running_or_pending
expect(builds.pluck(:status)).to contain_exactly('success', 'pending')
pipeline.builds.running_or_pending.each(&:cancel)
expect(builds.running_or_pending).to be_empty expect(builds_statuses).to eq ['success', 'failed', 'success', 'success']
expect(pipeline.reload.status).to eq('canceled') expect(pipeline.reload.status).to eq 'failed'
end
end end
end
context 'when test and test_failure jobs fail' do
it 'properly creates builds' do
expect(process_pipeline).to be_truthy
expect(builds_names).to eq ['build']
expect(builds_statuses).to eq ['pending']
succeed_running_or_pending
expect(builds_names).to eq ['build', 'test']
expect(builds_statuses).to eq ['success', 'pending']
fail_running_or_pending
context 'when listing optional manual actions' do expect(builds_names).to eq ['build', 'test', 'test_failure']
it 'returns only for skipped builds' do expect(builds_statuses).to eq ['success', 'failed', 'pending']
# currently all builds are created
expect(process_pipeline).to be_truthy
expect(manual_actions).to be_empty
# succeed stage build fail_running_or_pending
pipeline.builds.running_or_pending.each(&:success)
expect(manual_actions).to be_empty
# succeed stage test expect(builds_names).to eq ['build', 'test', 'test_failure', 'cleanup']
pipeline.builds.running_or_pending.each(&:success) expect(builds_statuses).to eq ['success', 'failed', 'failed', 'pending']
expect(manual_actions).to be_one # production
# succeed stage deploy succeed_running_or_pending
pipeline.builds.running_or_pending.each(&:success)
expect(manual_actions).to be_many # production and clear cache expect(builds_names).to eq ['build', 'test', 'test_failure', 'cleanup']
end expect(builds_statuses).to eq ['success', 'failed', 'failed', 'success']
expect(pipeline.reload.status).to eq('failed')
end end
end end
context 'when there are manual/on_failure jobs in earlier stages' do context 'when deploy job fails' do
before do it 'properly creates builds' do
builds expect(process_pipeline).to be_truthy
process_pipeline expect(builds_names).to eq ['build']
builds.each(&:reload) expect(builds_statuses).to eq ['pending']
end
context 'when first stage has only optional manual actions' do succeed_running_or_pending
let(:builds) do
[create_build('build', stage_idx: 0, when: 'manual', allow_failure: true),
create_build('check', stage_idx: 1),
create_build('test', stage_idx: 2)]
end
it 'starts from the second stage' do expect(builds_names).to eq ['build', 'test']
expect(builds.map(&:status)).to eq(%w[skipped pending created]) expect(builds_statuses).to eq ['success', 'pending']
end
end
context 'when second stage has only optional manual actions' do succeed_running_or_pending
let(:builds) do
[create_build('check', stage_idx: 0),
create_build('build', stage_idx: 1, when: 'manual', allow_failure: true),
create_build('test', stage_idx: 2)]
end
it 'skips second stage and continues on third stage' do expect(builds_names).to eq ['build', 'test', 'deploy']
expect(builds.map(&:status)).to eq(%w[pending created created]) expect(builds_statuses).to eq ['success', 'success', 'pending']
builds.first.success fail_running_or_pending
builds.each(&:reload)
expect(builds.map(&:status)).to eq(%w[success skipped pending]) expect(builds_names).to eq ['build', 'test', 'deploy', 'cleanup']
end expect(builds_statuses).to eq ['success', 'success', 'failed', 'pending']
succeed_running_or_pending
expect(builds_statuses).to eq ['success', 'success', 'failed', 'success']
expect(pipeline.reload.status).to eq('failed')
end end
end
context 'when second stage has only on_failure jobs' do context 'when build is canceled in the second stage' do
let(:builds) do it 'does not schedule builds after build has been canceled' do
[create_build('check', stage_idx: 0), expect(process_pipeline).to be_truthy
create_build('build', stage_idx: 1, when: 'on_failure'), expect(builds_names).to eq ['build']
create_build('test', stage_idx: 2)] expect(builds_statuses).to eq ['pending']
end
succeed_running_or_pending
it 'skips second stage and continues on third stage' do expect(builds.running_or_pending).not_to be_empty
expect(builds.map(&:status)).to eq(%w[pending created created]) expect(builds_names).to eq ['build', 'test']
expect(builds_statuses).to eq ['success', 'pending']
builds.first.success cancel_running_or_pending
builds.each(&:reload)
expect(builds.map(&:status)).to eq(%w[success skipped pending]) expect(builds.running_or_pending).to be_empty
end expect(pipeline.reload.status).to eq 'canceled'
end end
end end
context 'when failed build in the middle stage is retried' do context 'when listing optional manual actions' do
context 'when failed build is the only unsuccessful build in the stage' do it 'returns only for skipped builds' do
before do # currently all builds are created
create_build('build:1', stage_idx: 0) expect(process_pipeline).to be_truthy
create_build('build:2', stage_idx: 0) expect(manual_actions).to be_empty
create_build('test:1', stage_idx: 1)
create_build('test:2', stage_idx: 1)
create_build('deploy:1', stage_idx: 2)
create_build('deploy:2', stage_idx: 2)
end
it 'does trigger builds in the next stage' do
expect(process_pipeline).to be_truthy
expect(builds.pluck(:name)).to contain_exactly('build:1', 'build:2')
pipeline.builds.running_or_pending.each(&:success) # succeed stage build
succeed_running_or_pending
expect(builds.pluck(:name)) expect(manual_actions).to be_empty
.to contain_exactly('build:1', 'build:2', 'test:1', 'test:2')
pipeline.builds.find_by(name: 'test:1').success # succeed stage test
pipeline.builds.find_by(name: 'test:2').drop succeed_running_or_pending
expect(builds.pluck(:name)) expect(manual_actions).to be_one # production
.to contain_exactly('build:1', 'build:2', 'test:1', 'test:2')
Ci::Build.retry(pipeline.builds.find_by(name: 'test:2'), user).success # succeed stage deploy
succeed_running_or_pending
expect(builds.pluck(:name)).to contain_exactly( expect(manual_actions).to be_many # production and clear cache
'build:1', 'build:2', 'test:1', 'test:2', 'test:2', 'deploy:1', 'deploy:2')
end
end end
end end
end
context 'when there are manual/on_failure jobs in earlier stages' do
context 'when first stage has only optional manual actions' do
before do
create_build('build', stage_idx: 0, when: 'manual', allow_failure: true)
create_build('check', stage_idx: 1)
create_build('test', stage_idx: 2)
context 'when there are builds that are not created yet' do process_pipeline
let(:pipeline) do
create(:ci_pipeline, config: config)
end end
let(:config) do it 'starts from the second stage' do
{ rspec: { stage: 'test', script: 'rspec' }, expect(all_builds_statuses).to eq %w[skipped pending created]
deploy: { stage: 'deploy', script: 'rsync' } }
end end
end
context 'when second stage has only optional manual actions' do
before do before do
create_build('linux', stage: 'build', stage_idx: 0) create_build('check', stage_idx: 0)
create_build('mac', stage: 'build', stage_idx: 0) create_build('build', stage_idx: 1, when: 'manual', allow_failure: true)
create_build('test', stage_idx: 2)
process_pipeline
end end
it 'processes the pipeline' do it 'skips second stage and continues on third stage' do
# Currently we have five builds with state created expect(all_builds_statuses).to eq(%w[pending created created])
#
expect(builds.count).to eq(0)
expect(all_builds.count).to eq(2)
# Process builds service will enqueue builds from the first stage. builds.first.success
#
process_pipeline expect(all_builds_statuses).to eq(%w[success skipped pending])
end
end
expect(builds.count).to eq(2) context 'when second stage has only on_failure jobs' do
expect(all_builds.count).to eq(2) before do
create_build('check', stage_idx: 0)
create_build('build', stage_idx: 1, when: 'on_failure')
create_build('test', stage_idx: 2)
# When builds succeed we will enqueue remaining builds.
#
# We will have 2 succeeded, 1 pending (from stage test), total 4 (two
# additional build from `.gitlab-ci.yml`).
#
succeed_pending
process_pipeline process_pipeline
end
expect(builds.success.count).to eq(2) it 'skips second stage and continues on third stage' do
expect(builds.pending.count).to eq(1) expect(all_builds_statuses).to eq(%w[pending created created])
expect(all_builds.count).to eq(4)
# When pending merge_when_pipeline_succeeds in stage test, we enqueue deploy stage. builds.first.success
#
succeed_pending
process_pipeline
expect(builds.pending.count).to eq(1) expect(all_builds_statuses).to eq(%w[success skipped pending])
expect(builds.success.count).to eq(3) end
expect(all_builds.count).to eq(4) end
end
# When the last one succeeds we have 4 successful builds. context 'when failed build in the middle stage is retried' do
# context 'when failed build is the only unsuccessful build in the stage' do
succeed_pending before do
process_pipeline create_build('build:1', stage_idx: 0)
create_build('build:2', stage_idx: 0)
create_build('test:1', stage_idx: 1)
create_build('test:2', stage_idx: 1)
create_build('deploy:1', stage_idx: 2)
create_build('deploy:2', stage_idx: 2)
end
it 'does trigger builds in the next stage' do
expect(process_pipeline).to be_truthy
expect(builds_names).to eq ['build:1', 'build:2']
expect(builds.success.count).to eq(4) succeed_running_or_pending
expect(all_builds.count).to eq(4)
expect(builds_names).to eq ['build:1', 'build:2', 'test:1', 'test:2']
pipeline.builds.find_by(name: 'test:1').success
pipeline.builds.find_by(name: 'test:2').drop
expect(builds_names).to eq ['build:1', 'build:2', 'test:1', 'test:2']
Ci::Build.retry(pipeline.builds.find_by(name: 'test:2'), user).success
expect(builds_names).to eq ['build:1', 'build:2', 'test:1', 'test:2',
'test:2', 'deploy:1', 'deploy:2']
end end
end end
end end
context 'when there are builds that are not created yet' do
let(:pipeline) do
create(:ci_pipeline, config: config)
end
let(:config) do
{ rspec: { stage: 'test', script: 'rspec' },
deploy: { stage: 'deploy', script: 'rsync' } }
end
before do
create_build('linux', stage: 'build', stage_idx: 0)
create_build('mac', stage: 'build', stage_idx: 0)
end
it 'processes the pipeline' do
# Currently we have five builds with state created
#
expect(builds.count).to eq(0)
expect(all_builds.count).to eq(2)
# Process builds service will enqueue builds from the first stage.
#
process_pipeline
expect(builds.count).to eq(2)
expect(all_builds.count).to eq(2)
# When builds succeed we will enqueue remaining builds.
#
# We will have 2 succeeded, 1 pending (from stage test), total 4 (two
# additional build from `.gitlab-ci.yml`).
#
succeed_pending
process_pipeline
expect(builds.success.count).to eq(2)
expect(builds.pending.count).to eq(1)
expect(all_builds.count).to eq(4)
# When pending merge_when_pipeline_succeeds in stage test, we enqueue deploy stage.
#
succeed_pending
process_pipeline
expect(builds.pending.count).to eq(1)
expect(builds.success.count).to eq(3)
expect(all_builds.count).to eq(4)
# When the last one succeeds we have 4 successful builds.
#
succeed_pending
process_pipeline
expect(builds.success.count).to eq(4)
expect(all_builds.count).to eq(4)
end
end
def all_builds def all_builds
pipeline.builds pipeline.builds.order(:stage_idx, :id)
end end
def builds def builds
all_builds.where.not(status: [:created, :skipped]) all_builds.where.not(status: [:created, :skipped])
end end
def builds_names
builds.pluck(:name)
end
def builds_statuses
builds.pluck(:status)
end
def all_builds_statuses
all_builds.pluck(:status)
end
def process_pipeline def process_pipeline
described_class.new(pipeline.project, user).execute(pipeline) described_class.new(pipeline.project, user).execute(pipeline)
end end
...@@ -377,6 +403,18 @@ describe Ci::ProcessPipelineService, :services do ...@@ -377,6 +403,18 @@ describe Ci::ProcessPipelineService, :services do
builds.pending.update_all(status: 'success') builds.pending.update_all(status: 'success')
end end
def succeed_running_or_pending
pipeline.builds.running_or_pending.each(&:success)
end
def fail_running_or_pending
pipeline.builds.running_or_pending.each(&:drop)
end
def cancel_running_or_pending
pipeline.builds.running_or_pending.each(&:cancel)
end
delegate :manual_actions, to: :pipeline delegate :manual_actions, to: :pipeline
def create_build(name, **opts) def create_build(name, **opts)
......
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