497 lines
18 KiB
Ruby
497 lines
18 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require 'spec_helper'
|
|
|
|
RSpec.describe Ci::Processable do
|
|
let_it_be(:project) { create(:project) }
|
|
let_it_be(:pipeline) { create(:ci_pipeline, project: project) }
|
|
|
|
describe 'delegations' do
|
|
subject { Ci::Processable.new }
|
|
|
|
it { is_expected.to delegate_method(:merge_request?).to(:pipeline) }
|
|
it { is_expected.to delegate_method(:merge_request_ref?).to(:pipeline) }
|
|
it { is_expected.to delegate_method(:legacy_detached_merge_request_pipeline?).to(:pipeline) }
|
|
end
|
|
|
|
describe '#clone' do
|
|
let(:user) { create(:user) }
|
|
|
|
let(:new_processable) do
|
|
new_proc = processable.clone(current_user: user)
|
|
new_proc.save!
|
|
|
|
new_proc
|
|
end
|
|
|
|
let_it_be(:stage) { create(:ci_stage, project: project, pipeline: pipeline, name: 'test') }
|
|
|
|
shared_context 'processable bridge' do
|
|
let_it_be(:downstream_project) { create(:project, :repository) }
|
|
|
|
let_it_be_with_refind(:processable) do
|
|
create(:ci_bridge, :success,
|
|
pipeline: pipeline, downstream: downstream_project, description: 'a trigger job', stage_id: stage.id)
|
|
end
|
|
|
|
let(:clone_accessors) { ::Ci::Bridge.clone_accessors }
|
|
let(:reject_accessors) { [] }
|
|
let(:ignore_accessors) { [] }
|
|
end
|
|
|
|
shared_context 'processable build' do
|
|
let_it_be(:another_pipeline) { create(:ci_empty_pipeline, project: project) }
|
|
|
|
let_it_be_with_refind(:processable) do
|
|
create(:ci_build, :failed, :picked, :expired, :erased, :queued, :coverage, :tags,
|
|
:allowed_to_fail, :on_tag, :triggered, :teardown_environment, :resource_group,
|
|
description: 'my-job', stage: 'test', stage_id: stage.id,
|
|
pipeline: pipeline, auto_canceled_by: another_pipeline,
|
|
scheduled_at: 10.seconds.since)
|
|
end
|
|
|
|
let_it_be(:internal_job_variable) { create(:ci_job_variable, job: processable) }
|
|
|
|
let(:clone_accessors) do
|
|
%i[pipeline project ref tag options name allow_failure stage stage_idx trigger_request yaml_variables
|
|
when environment coverage_regex description tag_list protected needs_attributes job_variables_attributes
|
|
resource_group scheduling_type ci_stage partition_id id_tokens]
|
|
end
|
|
|
|
let(:reject_accessors) do
|
|
%i[id status user token_encrypted coverage runner artifacts_expire_at
|
|
created_at updated_at started_at finished_at queued_at erased_by
|
|
erased_at auto_canceled_by job_artifacts job_artifacts_archive
|
|
job_artifacts_metadata job_artifacts_trace job_artifacts_junit
|
|
job_artifacts_sast job_artifacts_secret_detection job_artifacts_dependency_scanning
|
|
job_artifacts_container_scanning job_artifacts_cluster_image_scanning job_artifacts_dast
|
|
job_artifacts_license_scanning
|
|
job_artifacts_performance job_artifacts_browser_performance job_artifacts_load_performance
|
|
job_artifacts_lsif job_artifacts_terraform job_artifacts_cluster_applications
|
|
job_artifacts_codequality job_artifacts_metrics scheduled_at
|
|
job_variables waiting_for_resource_at job_artifacts_metrics_referee
|
|
job_artifacts_network_referee job_artifacts_dotenv
|
|
job_artifacts_cobertura needs job_artifacts_accessibility
|
|
job_artifacts_requirements job_artifacts_coverage_fuzzing
|
|
job_artifacts_api_fuzzing terraform_state_versions job_artifacts_cyclonedx].freeze
|
|
end
|
|
|
|
let(:ignore_accessors) do
|
|
%i[type namespace lock_version target_url base_tags trace_sections
|
|
commit_id deployment erased_by_id project_id
|
|
runner_id tag_taggings taggings tags trigger_request_id
|
|
user_id auto_canceled_by_id retried failure_reason
|
|
sourced_pipelines sourced_pipeline artifacts_file_store artifacts_metadata_store
|
|
metadata runner_session trace_chunks upstream_pipeline_id
|
|
artifacts_file artifacts_metadata artifacts_size commands
|
|
resource resource_group_id processed security_scans author
|
|
pipeline_id report_results pending_state pages_deployments
|
|
queuing_entry runtime_metadata trace_metadata
|
|
dast_site_profile dast_scanner_profile stage_id dast_site_profiles_build
|
|
dast_scanner_profiles_build].freeze
|
|
end
|
|
|
|
before_all do
|
|
# Create artifacts to check that the associations are rejected when cloning
|
|
Ci::JobArtifact::TYPE_AND_FORMAT_PAIRS.each do |file_type, file_format|
|
|
create(:ci_job_artifact, file_format,
|
|
file_type: file_type, job: processable, expire_at: processable.artifacts_expire_at)
|
|
end
|
|
|
|
create(:ci_job_variable, :dotenv_source, job: processable)
|
|
create(:terraform_state_version, build: processable)
|
|
end
|
|
|
|
before do
|
|
processable.update!(retried: false, status: :success)
|
|
end
|
|
end
|
|
|
|
shared_examples_for 'clones the processable' do
|
|
before_all do
|
|
processable.update!(stage: 'test', stage_id: stage.id)
|
|
|
|
create(:ci_build_need, build: processable)
|
|
end
|
|
|
|
describe 'clone accessors' do
|
|
let(:forbidden_associations) do
|
|
Ci::Build.reflect_on_all_associations.each_with_object(Set.new) do |assoc, memo|
|
|
memo << assoc.name unless assoc.macro == :belongs_to
|
|
end
|
|
end
|
|
|
|
it 'clones the processable attributes', :aggregate_failures do
|
|
clone_accessors.each do |attribute|
|
|
expect(attribute).not_to be_in(forbidden_associations), "association #{attribute} must be `belongs_to`"
|
|
expect(processable.send(attribute)).not_to be_nil, "old processable attribute #{attribute} should not be nil"
|
|
expect(new_processable.send(attribute)).not_to be_nil, "new processable attribute #{attribute} should not be nil"
|
|
expect(new_processable.send(attribute)).to eq(processable.send(attribute)), "new processable attribute #{attribute} should match old processable"
|
|
end
|
|
end
|
|
|
|
it 'clones only the needs attributes' do
|
|
expect(new_processable.needs.size).to be(1)
|
|
expect(processable.needs.exists?).to be_truthy
|
|
|
|
expect(new_processable.needs_attributes).to match(processable.needs_attributes)
|
|
expect(new_processable.needs).not_to match(processable.needs)
|
|
end
|
|
|
|
context 'when the processable has protected: nil' do
|
|
before do
|
|
processable.update_attribute(:protected, nil)
|
|
end
|
|
|
|
it 'clones the protected job attribute' do
|
|
expect(new_processable.protected).to be_nil
|
|
expect(new_processable.protected).to eq processable.protected
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'reject accessors' do
|
|
it 'does not clone rejected attributes' do
|
|
reject_accessors.each do |attribute|
|
|
expect(new_processable.send(attribute)).not_to eq(processable.send(attribute)), "processable attribute #{attribute} should not have been cloned"
|
|
end
|
|
end
|
|
end
|
|
|
|
it 'creates a new processable that represents the old processable' do
|
|
expect(new_processable.name).to eq processable.name
|
|
end
|
|
end
|
|
|
|
context 'when the processable to be cloned is a bridge' do
|
|
include_context 'processable bridge'
|
|
|
|
it_behaves_like 'clones the processable'
|
|
end
|
|
|
|
context 'when the processable to be cloned is a build' do
|
|
include_context 'processable build'
|
|
|
|
it_behaves_like 'clones the processable'
|
|
|
|
it 'has the correct number of known attributes', :aggregate_failures do
|
|
processed_accessors = clone_accessors + reject_accessors
|
|
known_accessors = processed_accessors + ignore_accessors
|
|
|
|
current_accessors =
|
|
Ci::Build.attribute_names.map(&:to_sym) +
|
|
Ci::Build.attribute_aliases.keys.map(&:to_sym) +
|
|
Ci::Build.reflect_on_all_associations.map(&:name) +
|
|
[:tag_list, :needs_attributes, :job_variables_attributes, :id_tokens]
|
|
|
|
current_accessors.uniq!
|
|
|
|
expect(current_accessors).to include(*processed_accessors)
|
|
expect(known_accessors).to include(*current_accessors)
|
|
end
|
|
|
|
context 'when it has a deployment' do
|
|
let!(:processable) do
|
|
create(:ci_build, :with_deployment, :deploy_to_production,
|
|
pipeline: pipeline, stage_id: stage.id, project: project)
|
|
end
|
|
|
|
it 'persists the expanded environment name' do
|
|
expect(new_processable.metadata.expanded_environment_name).to eq('production')
|
|
end
|
|
end
|
|
|
|
context 'when it has a dynamic environment' do
|
|
let_it_be(:other_developer) { create(:user).tap { |u| project.add_developer(u) } }
|
|
|
|
let(:environment_name) { 'review/$CI_COMMIT_REF_SLUG-$GITLAB_USER_ID' }
|
|
|
|
let!(:processable) do
|
|
create(:ci_build, :with_deployment,
|
|
environment: environment_name,
|
|
options: { environment: { name: environment_name } },
|
|
pipeline: pipeline, stage_id: stage.id, project: project,
|
|
user: other_developer)
|
|
end
|
|
|
|
it 're-uses the previous persisted environment' do
|
|
expect(processable.persisted_environment.name).to eq("review/#{processable.ref}-#{other_developer.id}")
|
|
|
|
expect(new_processable.persisted_environment.name).to eq("review/#{processable.ref}-#{other_developer.id}")
|
|
end
|
|
end
|
|
|
|
context 'when the processable has job variables' do
|
|
it 'only clones the internal job variables' do
|
|
expect(new_processable.job_variables.size).to eq(1)
|
|
expect(new_processable.job_variables.first.key).to eq(internal_job_variable.key)
|
|
expect(new_processable.job_variables.first.value).to eq(internal_job_variable.value)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
describe '#retryable' do
|
|
shared_examples_for 'retryable processable' do
|
|
context 'when processable is successful' do
|
|
before do
|
|
processable.success!
|
|
end
|
|
|
|
it { is_expected.to be_retryable }
|
|
end
|
|
|
|
context 'when processable is failed' do
|
|
before do
|
|
processable.drop!
|
|
end
|
|
|
|
it { is_expected.to be_retryable }
|
|
end
|
|
|
|
context 'when processable is canceled' do
|
|
before do
|
|
processable.cancel!
|
|
end
|
|
|
|
it { is_expected.to be_retryable }
|
|
end
|
|
end
|
|
|
|
shared_examples_for 'non-retryable processable' do
|
|
context 'when processable is skipped' do
|
|
before do
|
|
processable.skip!
|
|
end
|
|
|
|
it { is_expected.not_to be_retryable }
|
|
end
|
|
|
|
context 'when processable is degenerated' do
|
|
before do
|
|
processable.degenerate!
|
|
end
|
|
|
|
it { is_expected.not_to be_retryable }
|
|
end
|
|
|
|
context 'when a canceled processable has been retried already' do
|
|
before do
|
|
project.add_developer(create(:user))
|
|
processable.cancel!
|
|
processable.update!(retried: true)
|
|
end
|
|
|
|
it { is_expected.not_to be_retryable }
|
|
end
|
|
end
|
|
|
|
context 'when the processable is a build' do
|
|
subject(:processable) { create(:ci_build, pipeline: pipeline) }
|
|
|
|
context 'when the processable is retryable' do
|
|
it_behaves_like 'retryable processable'
|
|
|
|
context 'when deployment is rejected' do
|
|
before do
|
|
processable.drop!(:deployment_rejected)
|
|
end
|
|
|
|
it { is_expected.not_to be_retryable }
|
|
end
|
|
|
|
context 'when build is waiting for deployment approval' do
|
|
subject { build_stubbed(:ci_build, :manual, environment: 'production') }
|
|
|
|
before do
|
|
create(:deployment, :blocked, deployable: subject)
|
|
end
|
|
|
|
it { is_expected.not_to be_retryable }
|
|
end
|
|
end
|
|
|
|
context 'when the processable is non-retryable' do
|
|
it_behaves_like 'non-retryable processable'
|
|
|
|
context 'when processable is running' do
|
|
before do
|
|
processable.run!
|
|
end
|
|
|
|
it { is_expected.not_to be_retryable }
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
describe '#aggregated_needs_names' do
|
|
let(:with_aggregated_needs) { pipeline.processables.select_with_aggregated_needs(project) }
|
|
|
|
context 'with created status' do
|
|
let!(:processable) { create(:ci_build, :created, project: project, pipeline: pipeline) }
|
|
|
|
context 'with needs' do
|
|
before do
|
|
create(:ci_build_need, build: processable, name: 'test1')
|
|
create(:ci_build_need, build: processable, name: 'test2')
|
|
end
|
|
|
|
it 'returns all processables' do
|
|
expect(with_aggregated_needs).to contain_exactly(processable)
|
|
end
|
|
|
|
it 'returns all needs' do
|
|
expect(with_aggregated_needs.first.aggregated_needs_names).to contain_exactly('test1', 'test2')
|
|
end
|
|
end
|
|
|
|
context 'without needs' do
|
|
it 'returns all processables' do
|
|
expect(with_aggregated_needs).to contain_exactly(processable)
|
|
end
|
|
|
|
it 'returns empty needs' do
|
|
expect(with_aggregated_needs.first.aggregated_needs_names).to be_nil
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'validate presence of scheduling_type' do
|
|
using RSpec::Parameterized::TableSyntax
|
|
|
|
subject { build(:ci_build, project: project, pipeline: pipeline, importing: importing) }
|
|
|
|
where(:importing, :should_validate) do
|
|
false | true
|
|
true | false
|
|
end
|
|
|
|
with_them do
|
|
context 'on create' do
|
|
it 'validates presence' do
|
|
if should_validate
|
|
is_expected.to validate_presence_of(:scheduling_type).on(:create)
|
|
else
|
|
is_expected.not_to validate_presence_of(:scheduling_type).on(:create)
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'on update' do
|
|
it { is_expected.not_to validate_presence_of(:scheduling_type).on(:update) }
|
|
end
|
|
end
|
|
end
|
|
|
|
describe '.populate_scheduling_type!' do
|
|
let!(:build_without_needs) { create(:ci_build, project: project, pipeline: pipeline) }
|
|
let!(:build_with_needs) { create(:ci_build, project: project, pipeline: pipeline) }
|
|
let!(:needs_relation) { create(:ci_build_need, build: build_with_needs) }
|
|
let!(:another_build) { create(:ci_build, project: project) }
|
|
|
|
before do
|
|
Ci::Processable.update_all(scheduling_type: nil)
|
|
end
|
|
|
|
it 'populates scheduling_type of processables' do
|
|
expect do
|
|
pipeline.processables.populate_scheduling_type!
|
|
end.to change(pipeline.processables.where(scheduling_type: nil), :count).from(2).to(0)
|
|
|
|
expect(build_without_needs.reload.scheduling_type).to eq('stage')
|
|
expect(build_with_needs.reload.scheduling_type).to eq('dag')
|
|
end
|
|
|
|
it 'does not affect processables from other pipelines' do
|
|
pipeline.processables.populate_scheduling_type!
|
|
expect(another_build.reload.scheduling_type).to be_nil
|
|
end
|
|
end
|
|
|
|
describe '#needs_attributes' do
|
|
let(:build) { create(:ci_build, :created, project: project, pipeline: pipeline) }
|
|
|
|
subject { build.needs_attributes }
|
|
|
|
context 'with needs' do
|
|
before do
|
|
create(:ci_build_need, build: build, name: 'test1')
|
|
create(:ci_build_need, build: build, name: 'test2')
|
|
end
|
|
|
|
it 'returns all needs attributes' do
|
|
is_expected.to contain_exactly(
|
|
{ 'artifacts' => true, 'name' => 'test1', 'optional' => false },
|
|
{ 'artifacts' => true, 'name' => 'test2', 'optional' => false }
|
|
)
|
|
end
|
|
end
|
|
|
|
context 'without needs' do
|
|
it { is_expected.to be_empty }
|
|
end
|
|
end
|
|
|
|
describe 'state transition with resource group' do
|
|
let(:resource_group) { create(:ci_resource_group, project: project) }
|
|
|
|
context 'when build status is created' do
|
|
let(:build) { create(:ci_build, :created, project: project, resource_group: resource_group) }
|
|
|
|
it 'is waiting for resource when build is enqueued' do
|
|
expect(Ci::ResourceGroups::AssignResourceFromResourceGroupWorker).to receive(:perform_async).with(resource_group.id)
|
|
|
|
expect { build.enqueue! }.to change { build.status }.from('created').to('waiting_for_resource')
|
|
|
|
expect(build.waiting_for_resource_at).not_to be_nil
|
|
end
|
|
|
|
context 'when build is waiting for resource' do
|
|
before do
|
|
build.update_column(:status, 'waiting_for_resource')
|
|
end
|
|
|
|
it 'is enqueued when build requests resource' do
|
|
expect { build.enqueue_waiting_for_resource! }.to change { build.status }.from('waiting_for_resource').to('pending')
|
|
end
|
|
|
|
it 'releases a resource when build finished' do
|
|
expect(build.resource_group).to receive(:release_resource_from).with(build).and_return(true).and_call_original
|
|
expect(Ci::ResourceGroups::AssignResourceFromResourceGroupWorker).to receive(:perform_async).with(build.resource_group_id)
|
|
|
|
build.enqueue_waiting_for_resource!
|
|
build.success!
|
|
end
|
|
|
|
it 're-checks the resource group even if the processable does not retain a resource' do
|
|
expect(build.resource_group).to receive(:release_resource_from).with(build).and_return(false).and_call_original
|
|
expect(Ci::ResourceGroups::AssignResourceFromResourceGroupWorker).to receive(:perform_async).with(build.resource_group_id)
|
|
|
|
build.success!
|
|
end
|
|
|
|
context 'when build has prerequisites' do
|
|
before do
|
|
allow(build).to receive(:any_unmet_prerequisites?) { true }
|
|
end
|
|
|
|
it 'is preparing when build is enqueued' do
|
|
expect { build.enqueue_waiting_for_resource! }.to change { build.status }.from('waiting_for_resource').to('preparing')
|
|
end
|
|
end
|
|
|
|
context 'when there are no available resources' do
|
|
before do
|
|
resource_group.assign_resource_to(create(:ci_build))
|
|
end
|
|
|
|
it 'stays as waiting for resource when build requests resource' do
|
|
expect { build.enqueue_waiting_for_resource }.not_to change { build.status }
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|