debian-mirror-gitlab/spec/models/ci/bridge_spec.rb

611 lines
18 KiB
Ruby
Raw Normal View History

2019-07-07 11:18:12 +05:30
# frozen_string_literal: true
2019-02-15 15:39:39 +05:30
require 'spec_helper'
2023-03-04 22:38:38 +05:30
RSpec.describe Ci::Bridge, feature_category: :continuous_integration do
2020-03-13 15:44:24 +05:30
let_it_be(:project) { create(:project) }
let_it_be(:target_project) { create(:project, name: 'project', namespace: create(:namespace, name: 'my')) }
let_it_be(:pipeline) { create(:ci_pipeline, project: project) }
2019-02-15 15:39:39 +05:30
2022-05-07 20:08:51 +05:30
before_all do
create(:ci_pipeline_variable, pipeline: pipeline, key: 'PVAR1', value: 'PVAL1')
end
2019-02-15 15:39:39 +05:30
let(:bridge) do
2020-03-13 15:44:24 +05:30
create(:ci_bridge, :variables, status: :created,
options: options,
pipeline: pipeline)
end
let(:options) do
{ trigger: { project: 'my/project', branch: 'master' } }
2019-02-15 15:39:39 +05:30
end
2020-03-13 15:44:24 +05:30
it 'has many sourced pipelines' do
expect(bridge).to have_many(:sourced_pipelines)
end
2022-08-27 11:52:29 +05:30
it_behaves_like 'has ID tokens', :ci_bridge
2023-01-13 00:05:48 +05:30
it_behaves_like 'a retryable job'
2020-06-23 00:09:42 +05:30
it 'has one downstream pipeline' do
expect(bridge).to have_one(:sourced_pipeline)
expect(bridge).to have_one(:downstream_pipeline)
end
2023-03-04 22:38:38 +05:30
describe '#sourced_pipelines' do
subject { bridge.sourced_pipelines }
it 'raises error' do
expect { subject }.to raise_error RuntimeError, 'Ci::Bridge does not have sourced_pipelines association'
end
context 'when ci_bridge_remove_sourced_pipelines is disabled' do
before do
stub_feature_flags(ci_bridge_remove_sourced_pipelines: false)
end
it 'returns the sourced_pipelines association' do
expect(bridge.sourced_pipelines).to eq([])
end
end
end
2022-06-21 17:19:12 +05:30
describe '#retryable?' do
2022-07-16 23:28:13 +05:30
let(:bridge) { create(:ci_bridge, :success) }
2023-01-13 00:05:48 +05:30
it 'returns false' do
expect(bridge.retryable?).to eq(false)
2022-07-16 23:28:13 +05:30
end
end
context 'when there is a pipeline loop detected' do
let(:bridge) { create(:ci_bridge, :failed, failure_reason: :pipeline_loop_detected) }
it 'returns false' do
expect(bridge.failure_reason).to eq('pipeline_loop_detected')
expect(bridge.retryable?).to eq(false)
end
end
context 'when the pipeline depth has reached the max descendents' do
let(:bridge) { create(:ci_bridge, :failed, failure_reason: :reached_max_descendant_pipelines_depth) }
2022-06-21 17:19:12 +05:30
it 'returns false' do
2022-07-16 23:28:13 +05:30
expect(bridge.failure_reason).to eq('reached_max_descendant_pipelines_depth')
2022-06-21 17:19:12 +05:30
expect(bridge.retryable?).to eq(false)
end
end
2019-02-15 15:39:39 +05:30
describe '#tags' do
it 'only has a bridge tag' do
expect(bridge.tags).to eq [:bridge]
end
end
describe '#detailed_status' do
let(:user) { create(:user) }
let(:status) { bridge.detailed_status(user) }
it 'returns detailed status object' do
2019-10-12 21:52:04 +05:30
expect(status).to be_a Gitlab::Ci::Status::Created
2019-02-15 15:39:39 +05:30
end
end
2019-07-07 11:18:12 +05:30
2021-04-17 20:07:23 +05:30
describe '#scoped_variables' do
2019-07-07 11:18:12 +05:30
it 'returns a hash representing variables' do
variables = %w[
2022-11-25 23:54:43 +05:30
CI_JOB_NAME CI_JOB_NAME_SLUG CI_JOB_STAGE CI_COMMIT_SHA
CI_COMMIT_SHORT_SHA CI_COMMIT_BEFORE_SHA CI_COMMIT_REF_NAME
CI_COMMIT_REF_SLUG CI_PROJECT_ID CI_PROJECT_NAME CI_PROJECT_PATH
2020-07-28 23:09:34 +05:30
CI_PROJECT_PATH_SLUG CI_PROJECT_NAMESPACE CI_PROJECT_ROOT_NAMESPACE
CI_PIPELINE_IID CI_CONFIG_PATH CI_PIPELINE_SOURCE CI_COMMIT_MESSAGE
2019-07-31 22:56:46 +05:30
CI_COMMIT_TITLE CI_COMMIT_DESCRIPTION CI_COMMIT_REF_PROTECTED
2021-04-29 21:17:54 +05:30
CI_COMMIT_TIMESTAMP CI_COMMIT_AUTHOR
2019-07-07 11:18:12 +05:30
]
2021-04-17 20:07:23 +05:30
expect(bridge.scoped_variables.map { |v| v[:key] }).to include(*variables)
2019-07-07 11:18:12 +05:30
end
2021-01-29 00:20:46 +05:30
context 'when bridge has dependency which has dotenv variable' do
let(:test) { create(:ci_build, pipeline: pipeline, stage_idx: 0) }
let(:bridge) { create(:ci_bridge, pipeline: pipeline, stage_idx: 1, options: { dependencies: [test.name] }) }
let!(:job_variable) { create(:ci_job_variable, :dotenv_source, job: test) }
it 'includes inherited variable' do
2021-04-17 20:07:23 +05:30
expect(bridge.scoped_variables.to_hash).to include(job_variable.key => job_variable.value)
2021-01-29 00:20:46 +05:30
end
end
2019-07-07 11:18:12 +05:30
end
2020-03-13 15:44:24 +05:30
describe 'state machine transitions' do
context 'when bridge points towards downstream' do
2021-01-03 14:25:43 +05:30
%i[created manual].each do |status|
it "schedules downstream pipeline creation when the status is #{status}" do
bridge.status = status
2020-03-13 15:44:24 +05:30
2021-01-03 14:25:43 +05:30
bridge.enqueue!
2021-11-11 11:23:49 +05:30
2021-11-18 22:05:49 +05:30
expect(::Ci::CreateDownstreamPipelineWorker.jobs.last['args']).to eq([bridge.id])
2021-01-03 14:25:43 +05:30
end
2020-03-13 15:44:24 +05:30
end
2021-03-11 19:13:27 +05:30
it "schedules downstream pipeline creation when the status is waiting for resource" do
bridge.status = :waiting_for_resource
bridge.enqueue_waiting_for_resource!
2021-11-11 11:23:49 +05:30
2021-11-18 22:05:49 +05:30
expect(::Ci::CreateDownstreamPipelineWorker.jobs.last['args']).to match_array([bridge.id])
2021-03-11 19:13:27 +05:30
end
2021-01-03 14:25:43 +05:30
it 'raises error when the status is failed' do
bridge.status = :failed
2020-03-13 15:44:24 +05:30
2021-01-03 14:25:43 +05:30
expect { bridge.enqueue! }.to raise_error(StateMachines::InvalidTransition)
2020-03-13 15:44:24 +05:30
end
end
end
describe '#inherit_status_from_downstream!' do
let(:downstream_pipeline) { build(:ci_pipeline, status: downstream_status) }
before do
bridge.status = 'pending'
create(:ci_sources_pipeline, pipeline: downstream_pipeline, source_job: bridge)
end
subject { bridge.inherit_status_from_downstream!(downstream_pipeline) }
context 'when status is not supported' do
(::Ci::Pipeline::AVAILABLE_STATUSES - ::Ci::Pipeline::COMPLETED_STATUSES).map(&:to_s).each do |status|
context "when status is #{status}" do
let(:downstream_status) { status }
it 'returns false' do
expect(subject).to eq(false)
end
it 'does not change the bridge status' do
expect { subject }.not_to change { bridge.status }.from('pending')
end
end
end
end
context 'when status is supported' do
using RSpec::Parameterized::TableSyntax
where(:downstream_status, :upstream_status) do
[
%w[success success],
*::Ci::Pipeline.completed_statuses.without(:success).map { |status| [status.to_s, 'failed'] }
]
end
with_them do
it 'inherits the downstream status' do
expect { subject }.to change { bridge.status }.from('pending').to(upstream_status)
end
end
end
end
describe '#dependent?' do
subject { bridge.dependent? }
context 'when bridge has strategy depend' do
let(:options) { { trigger: { project: 'my/project', strategy: 'depend' } } }
it { is_expected.to be true }
end
context 'when bridge does not have strategy depend' do
it { is_expected.to be false }
end
end
describe '#yaml_variables' do
it 'returns YAML variables' do
expect(bridge.yaml_variables)
.to include(key: 'BRIDGE', value: 'cross', public: true)
end
end
describe '#downstream_variables' do
2023-01-13 00:05:48 +05:30
subject(:downstream_variables) { bridge.downstream_variables }
2020-03-13 15:44:24 +05:30
it 'returns variables that are going to be passed downstream' do
expect(bridge.downstream_variables)
.to include(key: 'BRIDGE', value: 'cross')
end
context 'when using variables interpolation' do
let(:yaml_variables) do
[
{
key: 'EXPANDED',
value: '$BRIDGE-bridge',
public: true
},
{
key: 'UPSTREAM_CI_PIPELINE_ID',
value: '$CI_PIPELINE_ID',
public: true
},
{
key: 'UPSTREAM_CI_PIPELINE_URL',
value: '$CI_PIPELINE_URL',
public: true
}
]
end
before do
bridge.yaml_variables.concat(yaml_variables)
end
it 'correctly expands variables with interpolation' do
expanded_values = pipeline
.persisted_variables
.to_hash
.transform_keys { |key| "UPSTREAM_#{key}" }
.map { |key, value| { key: key, value: value } }
.push(key: 'EXPANDED', value: 'cross-bridge')
expect(bridge.downstream_variables)
.to match(a_collection_including(*expanded_values))
end
end
context 'when recursive interpolation has been used' do
before do
bridge.yaml_variables << { key: 'EXPANDED', value: '$EXPANDED', public: true }
end
it 'does not expand variable recursively' do
expect(bridge.downstream_variables)
.to include(key: 'EXPANDED', value: '$EXPANDED')
end
end
2022-05-07 20:08:51 +05:30
context 'forward variables' do
using RSpec::Parameterized::TableSyntax
2022-07-23 23:45:48 +05:30
where(:yaml_variables, :pipeline_variables, :variables) do
nil | nil | %w[BRIDGE]
nil | false | %w[BRIDGE]
nil | true | %w[BRIDGE PVAR1]
false | nil | %w[]
false | false | %w[]
false | true | %w[PVAR1]
true | nil | %w[BRIDGE]
true | false | %w[BRIDGE]
true | true | %w[BRIDGE PVAR1]
2022-05-07 20:08:51 +05:30
end
with_them do
let(:options) do
{
trigger: {
project: 'my/project',
branch: 'master',
forward: { yaml_variables: yaml_variables,
pipeline_variables: pipeline_variables }.compact
}
}
end
it 'returns variables according to the forward value' do
expect(bridge.downstream_variables.map { |v| v[:key] }).to contain_exactly(*variables)
end
end
context 'when sending a variable via both yaml and pipeline' do
let(:pipeline) { create(:ci_pipeline, project: project) }
let(:options) do
{ trigger: { project: 'my/project', forward: { pipeline_variables: true } } }
end
before do
create(:ci_pipeline_variable, pipeline: pipeline, key: 'BRIDGE', value: 'new value')
end
it 'uses the pipeline variable' do
expect(bridge.downstream_variables).to contain_exactly(
{ key: 'BRIDGE', value: 'new value' }
)
end
end
2022-06-21 17:19:12 +05:30
context 'when the pipeline runs from a pipeline schedule' do
2023-01-13 00:05:48 +05:30
let(:pipeline_schedule) { create(:ci_pipeline_schedule, :nightly, project: project) }
2022-06-21 17:19:12 +05:30
let(:pipeline) { create(:ci_pipeline, pipeline_schedule: pipeline_schedule) }
let(:options) do
{ trigger: { project: 'my/project', forward: { pipeline_variables: true } } }
end
before do
pipeline_schedule.variables.create!(key: 'schedule_var_key', value: 'schedule var value')
end
it 'adds the schedule variable' do
expect(bridge.downstream_variables).to contain_exactly(
{ key: 'BRIDGE', value: 'cross' },
{ key: 'schedule_var_key', value: 'schedule var value' }
)
end
end
2022-05-07 20:08:51 +05:30
end
2023-01-13 00:05:48 +05:30
context 'when using raw variables' do
let(:options) do
{
trigger: {
project: 'my/project',
branch: 'master',
forward: { yaml_variables: true,
pipeline_variables: true }.compact
}
}
end
let(:yaml_variables) do
[
{
key: 'VAR6',
value: 'value6 $VAR1'
},
{
key: 'VAR7',
value: 'value7 $VAR1',
raw: true
}
]
end
let(:pipeline_schedule) { create(:ci_pipeline_schedule, :nightly, project: project) }
let(:pipeline) { create(:ci_pipeline, pipeline_schedule: pipeline_schedule) }
before do
create(:ci_pipeline_variable, pipeline: pipeline, key: 'VAR1', value: 'value1')
create(:ci_pipeline_variable, pipeline: pipeline, key: 'VAR2', value: 'value2 $VAR1')
create(:ci_pipeline_variable, pipeline: pipeline, key: 'VAR3', value: 'value3 $VAR1', raw: true)
pipeline_schedule.variables.create!(key: 'VAR4', value: 'value4 $VAR1')
pipeline_schedule.variables.create!(key: 'VAR5', value: 'value5 $VAR1', raw: true)
bridge.yaml_variables.concat(yaml_variables)
end
it 'expands variables according to their raw attributes' do
expect(downstream_variables).to contain_exactly(
{ key: 'BRIDGE', value: 'cross' },
{ key: 'VAR1', value: 'value1' },
{ key: 'VAR2', value: 'value2 value1' },
{ key: 'VAR3', value: 'value3 $VAR1', raw: true },
{ key: 'VAR4', value: 'value4 value1' },
{ key: 'VAR5', value: 'value5 $VAR1', raw: true },
{ key: 'VAR6', value: 'value6 value1' },
{ key: 'VAR7', value: 'value7 $VAR1', raw: true }
)
end
context 'when the FF ci_raw_variables_in_yaml_config is disabled' do
before do
stub_feature_flags(ci_raw_variables_in_yaml_config: false)
end
it 'ignores the raw attribute' do
expect(downstream_variables).to contain_exactly(
{ key: 'BRIDGE', value: 'cross' },
{ key: 'VAR1', value: 'value1' },
{ key: 'VAR2', value: 'value2 value1' },
{ key: 'VAR3', value: 'value3 value1' },
{ key: 'VAR4', value: 'value4 value1' },
{ key: 'VAR5', value: 'value5 value1' },
{ key: 'VAR6', value: 'value6 value1' },
{ key: 'VAR7', value: 'value7 value1' }
)
end
end
end
2020-03-13 15:44:24 +05:30
end
describe 'metadata support' do
it 'reads YAML variables from metadata' do
expect(bridge.yaml_variables).not_to be_empty
expect(bridge.metadata).to be_a Ci::BuildMetadata
expect(bridge.read_attribute(:yaml_variables)).to be_nil
expect(bridge.metadata.config_variables).to be bridge.yaml_variables
end
it 'reads options from metadata' do
expect(bridge.options).not_to be_empty
expect(bridge.metadata).to be_a Ci::BuildMetadata
expect(bridge.read_attribute(:options)).to be_nil
expect(bridge.metadata.config_options).to be bridge.options
end
end
describe '#triggers_child_pipeline?' do
subject { bridge.triggers_child_pipeline? }
context 'when bridge defines a downstream YAML' do
let(:options) do
{
trigger: {
include: 'path/to/child.yml'
}
}
end
it { is_expected.to be_truthy }
end
context 'when bridge does not define a downstream YAML' do
let(:options) do
{
trigger: {
project: project.full_path
}
}
end
it { is_expected.to be_falsey }
end
end
describe '#yaml_for_downstream' do
subject { bridge.yaml_for_downstream }
context 'when bridge defines a downstream YAML' do
let(:options) do
{
trigger: {
include: 'path/to/child.yml'
}
}
end
let(:yaml) do
<<~EOY
---
include: path/to/child.yml
EOY
end
it { is_expected.to eq yaml }
end
context 'when bridge does not define a downstream YAML' do
let(:options) { {} }
it { is_expected.to be_nil }
end
end
2022-08-27 11:52:29 +05:30
describe '#downstream_project_path' do
context 'when trigger is defined' do
context 'when using variable expansion' do
let(:options) { { trigger: { project: 'my/$BRIDGE/project' } } }
it 'correctly expands variables' do
expect(bridge.downstream_project_path).to eq('my/cross/project')
end
end
end
end
2020-03-13 15:44:24 +05:30
describe '#target_ref' do
context 'when trigger is defined' do
it 'returns a ref name' do
expect(bridge.target_ref).to eq 'master'
end
context 'when using variable expansion' do
let(:options) { { trigger: { project: 'my/project', branch: '$BRIDGE-master' } } }
it 'correctly expands variables' do
expect(bridge.target_ref).to eq('cross-master')
end
end
end
context 'when trigger does not have project defined' do
let(:options) { nil }
it 'returns nil' do
expect(bridge.target_ref).to be_nil
end
end
end
2021-01-03 14:25:43 +05:30
describe '#play' do
let(:downstream_project) { create(:project) }
let(:user) { create(:user) }
let(:bridge) { create(:ci_bridge, :playable, pipeline: pipeline, downstream: downstream_project) }
subject { bridge.play(user) }
before do
project.add_maintainer(user)
downstream_project.add_maintainer(user)
end
it 'enqueues the bridge' do
subject
expect(bridge).to be_pending
end
end
describe '#playable?' do
context 'when bridge is a manual action' do
subject { build_stubbed(:ci_bridge, :manual).playable? }
it { is_expected.to be_truthy }
end
context 'when build is not a manual action' do
subject { build_stubbed(:ci_bridge, :created).playable? }
it { is_expected.to be_falsey }
end
end
describe '#action?' do
context 'when bridge is a manual action' do
subject { build_stubbed(:ci_bridge, :manual).action? }
it { is_expected.to be_truthy }
end
context 'when build is not a manual action' do
subject { build_stubbed(:ci_bridge, :created).action? }
it { is_expected.to be_falsey }
end
end
2021-01-29 00:20:46 +05:30
describe '#dependency_variables' do
subject { bridge.dependency_variables }
context 'when downloading from previous stages' do
let!(:prepare1) { create(:ci_build, name: 'prepare1', pipeline: pipeline, stage_idx: 0) }
let!(:bridge) { create(:ci_bridge, pipeline: pipeline, stage_idx: 1) }
let!(:job_variable_1) { create(:ci_job_variable, :dotenv_source, job: prepare1) }
let!(:job_variable_2) { create(:ci_job_variable, job: prepare1) }
it 'inherits only dependent variables' do
expect(subject.to_hash).to eq(job_variable_1.key => job_variable_1.value)
end
end
context 'when using needs' do
let!(:prepare1) { create(:ci_build, name: 'prepare1', pipeline: pipeline, stage_idx: 0) }
let!(:prepare2) { create(:ci_build, name: 'prepare2', pipeline: pipeline, stage_idx: 0) }
let!(:prepare3) { create(:ci_build, name: 'prepare3', pipeline: pipeline, stage_idx: 0) }
let!(:bridge) do
create(:ci_bridge, pipeline: pipeline,
stage_idx: 1,
scheduling_type: 'dag',
needs_attributes: [{ name: 'prepare1', artifacts: true },
{ name: 'prepare2', artifacts: false }])
end
let!(:job_variable_1) { create(:ci_job_variable, :dotenv_source, job: prepare1) }
let!(:job_variable_2) { create(:ci_job_variable, :dotenv_source, job: prepare2) }
let!(:job_variable_3) { create(:ci_job_variable, :dotenv_source, job: prepare3) }
it 'inherits only needs with artifacts variables' do
expect(subject.to_hash).to eq(job_variable_1.key => job_variable_1.value)
end
end
end
2019-02-15 15:39:39 +05:30
end