debian-mirror-gitlab/app/models/ci/build.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

1338 lines
41 KiB
Ruby
Raw Normal View History

2018-11-18 11:00:15 +05:30
# frozen_string_literal: true
2015-09-25 12:07:36 +05:30
module Ci
2020-03-13 15:44:24 +05:30
class Build < Ci::Processable
2022-08-13 15:12:31 +05:30
prepend Ci::BulkInsertableTags
2019-03-02 22:35:43 +05:30
include Ci::Metadatable
2019-07-07 11:18:12 +05:30
include Ci::Contextable
2016-09-29 09:46:39 +05:30
include TokenAuthenticatable
2016-11-03 12:29:30 +05:30
include AfterCommitQueue
2017-08-17 22:00:37 +05:30
include Presentable
2018-03-17 18:26:18 +05:30
include Importable
2020-04-08 14:13:33 +05:30
include Ci::HasRef
2022-10-11 01:57:18 +05:30
include Ci::TrackEnvironmentUsage
2022-05-07 20:08:51 +05:30
2022-01-26 12:08:38 +05:30
extend ::Gitlab::Utils::Override
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
belongs_to :project, inverse_of: :builds
2017-08-17 22:00:37 +05:30
belongs_to :runner
belongs_to :trigger_request
2016-04-02 18:10:28 +05:30
belongs_to :erased_by, class_name: 'User'
2023-05-27 22:25:52 +05:30
belongs_to :pipeline, class_name: 'Ci::Pipeline', foreign_key: :commit_id, inverse_of: :builds
2015-09-25 12:07:36 +05:30
2018-11-18 11:00:15 +05:30
RUNNER_FEATURES = {
2019-07-07 11:18:12 +05:30
upload_multiple_artifacts: -> (build) { build.publishes_artifacts_reports? },
2020-05-24 23:13:21 +05:30
refspecs: -> (build) { build.merge_request_ref? },
2020-06-23 00:09:42 +05:30
artifacts_exclude: -> (build) { build.supports_artifacts_exclude? },
2021-03-08 18:12:59 +05:30
multi_build_steps: -> (build) { build.multi_build_steps? },
2023-07-09 08:55:56 +05:30
return_exit_code: -> (build) { build.exit_codes_defined? },
fallback_cache_keys: -> (build) { build.fallback_cache_keys_defined? }
2018-11-18 11:00:15 +05:30
}.freeze
2020-05-24 23:13:21 +05:30
DEGRADATION_THRESHOLD_VARIABLE_NAME = 'DEGRADATION_THRESHOLD'
2021-04-29 21:17:54 +05:30
RUNNERS_STATUS_CACHE_EXPIRATION = 1.minute
2020-05-24 23:13:21 +05:30
2022-05-07 20:08:51 +05:30
DEPLOYMENT_NAMES = %w[deploy release rollout].freeze
2022-10-11 01:57:18 +05:30
has_one :deployment, as: :deployable, class_name: 'Deployment', inverse_of: :deployable
2023-04-23 21:23:45 +05:30
has_one :pending_state, class_name: 'Ci::BuildPendingState', foreign_key: :build_id, inverse_of: :build
2023-05-27 22:25:52 +05:30
has_one :queuing_entry, class_name: 'Ci::PendingBuild', foreign_key: :build_id, inverse_of: :build
has_one :runtime_metadata, class_name: 'Ci::RunningBuild', foreign_key: :build_id, inverse_of: :build
2020-11-24 15:15:51 +05:30
has_many :trace_chunks, class_name: 'Ci::BuildTraceChunk', foreign_key: :build_id, inverse_of: :build
2023-04-23 21:23:45 +05:30
has_many :report_results, class_name: 'Ci::BuildReportResult', foreign_key: :build_id, inverse_of: :build
2022-07-16 23:28:13 +05:30
has_one :namespace, through: :project
2018-03-17 18:26:18 +05:30
2021-11-18 22:05:49 +05:30
# Projects::DestroyService destroys Ci::Pipelines, which use_fast_destroy on :job_artifacts
# before we delete builds. By doing this, the relation should be empty and not fire any
# DELETE queries when the Ci::Build is destroyed. The next step is to remove `dependent: :destroy`.
# Details: https://gitlab.com/gitlab-org/gitlab/-/issues/24644#note_689472685
2018-10-15 14:42:47 +05:30
has_many :job_artifacts, class_name: 'Ci::JobArtifact', foreign_key: :job_id, dependent: :destroy, inverse_of: :job # rubocop:disable Cop/ActiveRecordDependent
2023-03-04 22:38:38 +05:30
has_many :job_variables, class_name: 'Ci::JobVariable', foreign_key: :job_id, inverse_of: :job
2023-05-27 22:25:52 +05:30
has_many :sourced_pipelines, class_name: 'Ci::Sources::Pipeline', foreign_key: :source_job_id, inverse_of: :build
2018-11-18 11:00:15 +05:30
2023-04-23 21:23:45 +05:30
has_many :pages_deployments, foreign_key: :ci_build_id, inverse_of: :ci_build
2020-11-24 15:15:51 +05:30
2018-11-18 11:00:15 +05:30
Ci::JobArtifact.file_types.each do |key, value|
2023-04-23 21:23:45 +05:30
has_one :"job_artifacts_#{key}", -> { where(file_type: value) }, class_name: 'Ci::JobArtifact', foreign_key: :job_id, inverse_of: :job
2018-11-18 11:00:15 +05:30
end
2017-08-17 22:00:37 +05:30
2023-06-20 00:43:36 +05:30
has_one :runner_manager_build, class_name: 'Ci::RunnerManagerBuild', foreign_key: :build_id, inverse_of: :build,
2023-05-27 22:25:52 +05:30
autosave: true
2023-06-20 00:43:36 +05:30
has_one :runner_manager, foreign_key: :runner_machine_id, through: :runner_manager_build, class_name: 'Ci::RunnerManager'
2018-11-08 19:23:39 +05:30
2023-04-23 21:23:45 +05:30
has_one :runner_session, class_name: 'Ci::BuildRunnerSession', validate: true, foreign_key: :build_id, inverse_of: :build
has_one :trace_metadata, class_name: 'Ci::BuildTraceMetadata', foreign_key: :build_id, inverse_of: :build
has_many :terraform_state_versions, class_name: 'Terraform::StateVersion', foreign_key: :ci_build_id, inverse_of: :build
2021-11-18 22:05:49 +05:30
2020-01-01 13:55:28 +05:30
accepts_nested_attributes_for :runner_session, update_only: true
2019-10-12 21:52:04 +05:30
accepts_nested_attributes_for :job_variables
2018-11-08 19:23:39 +05:30
delegate :url, to: :runner_session, prefix: true, allow_nil: true
delegate :terminal_specification, to: :runner_session, allow_nil: true
2020-06-23 00:09:42 +05:30
delegate :service_specification, to: :runner_session, allow_nil: true
2018-10-15 14:42:47 +05:30
delegate :gitlab_deploy_token, to: :project
2022-05-07 20:08:51 +05:30
delegate :harbor_integration, to: :project
2023-03-17 16:20:25 +05:30
delegate :apple_app_store_integration, to: :project
2023-05-27 22:25:52 +05:30
delegate :google_play_integration, to: :project
2018-12-05 23:21:45 +05:30
delegate :trigger_short_token, to: :trigger_request, allow_nil: true
2022-07-16 23:28:13 +05:30
delegate :ensure_persistent_ref, to: :pipeline
2023-03-04 22:38:38 +05:30
delegate :enable_debug_trace!, to: :metadata
delegate :debug_trace_enabled?, to: :metadata
2018-05-09 12:01:36 +05:30
2017-09-10 17:25:29 +05:30
serialize :options # rubocop:disable Cop/ActiveRecordSerialize
serialize :yaml_variables, Gitlab::Serializer::Ci::Variables # rubocop:disable Cop/ActiveRecordSerialize
2017-08-17 22:00:37 +05:30
delegate :name, to: :project, prefix: true
2015-09-25 12:07:36 +05:30
validates :coverage, numericality: true, allow_blank: true
2017-08-17 22:00:37 +05:30
validates :ref, presence: true
2015-09-25 12:07:36 +05:30
2019-12-04 20:38:33 +05:30
scope :not_interruptible, -> do
2022-11-25 23:54:43 +05:30
joins(:metadata)
.where.not(Ci::BuildMetadata.table_name => { id: Ci::BuildMetadata.scoped_build.with_interruptible.select(:id) })
2019-12-04 20:38:33 +05:30
end
2020-11-24 15:15:51 +05:30
scope :unstarted, -> { where(runner_id: nil) }
2022-11-25 23:54:43 +05:30
2023-04-23 21:23:45 +05:30
scope :with_any_artifacts, -> do
where('EXISTS (?)',
Ci::JobArtifact.select(1).where("#{Ci::Build.quoted_table_name}.id = #{Ci::JobArtifact.quoted_table_name}.job_id")
)
end
2020-11-24 15:15:51 +05:30
scope :with_downloadable_artifacts, -> do
2020-05-24 23:13:21 +05:30
where('EXISTS (?)',
Ci::JobArtifact.select(1)
2023-03-04 22:38:38 +05:30
.where("#{Ci::Build.quoted_table_name}.id = #{Ci::JobArtifact.quoted_table_name}.job_id")
2020-05-24 23:13:21 +05:30
.where(file_type: Ci::JobArtifact::DOWNLOADABLE_TYPES)
)
2018-03-17 18:26:18 +05:30
end
2018-11-08 19:23:39 +05:30
2022-11-25 23:54:43 +05:30
scope :with_erasable_artifacts, -> do
where('EXISTS (?)',
Ci::JobArtifact.select(1)
2023-03-04 22:38:38 +05:30
.where("#{Ci::Build.quoted_table_name}.id = #{Ci::JobArtifact.quoted_table_name}.job_id")
2022-11-25 23:54:43 +05:30
.where(file_type: Ci::JobArtifact.erasable_file_types)
)
end
2021-01-29 00:20:46 +05:30
scope :in_pipelines, ->(pipelines) do
where(pipeline: pipelines)
end
2018-12-05 23:21:45 +05:30
scope :with_existing_job_artifacts, ->(query) do
2023-03-04 22:38:38 +05:30
where('EXISTS (?)', ::Ci::JobArtifact.select(1).where("#{Ci::Build.quoted_table_name}.id = #{Ci::JobArtifact.quoted_table_name}.job_id").merge(query))
2018-12-05 23:21:45 +05:30
end
2020-11-24 15:15:51 +05:30
scope :without_archived_trace, -> do
2023-03-04 22:38:38 +05:30
where('NOT EXISTS (?)', Ci::JobArtifact.select(1).where("#{Ci::Build.quoted_table_name}.id = #{Ci::JobArtifact.quoted_table_name}.job_id").trace)
2018-11-08 19:23:39 +05:30
end
2022-07-23 23:45:48 +05:30
scope :with_artifacts, ->(artifact_scope) do
with_existing_job_artifacts(artifact_scope)
2018-12-05 23:21:45 +05:30
.eager_load_job_artifacts
2018-11-18 11:00:15 +05:30
end
2018-12-05 23:21:45 +05:30
scope :eager_load_job_artifacts, -> { includes(:job_artifacts) }
2021-09-30 23:02:18 +05:30
scope :eager_load_tags, -> { includes(:tags) }
2023-05-27 22:25:52 +05:30
scope :eager_load_for_archiving_trace, -> { preload(:project, :pending_state) }
2018-12-05 23:21:45 +05:30
2020-01-01 13:55:28 +05:30
scope :eager_load_everything, -> do
includes(
[
{ pipeline: [:project, :user] },
:job_artifacts_archive,
:metadata,
:trigger_request,
:project,
:user,
:tags
]
)
end
2019-12-26 22:10:19 +05:30
scope :with_exposed_artifacts, -> do
joins(:metadata).merge(Ci::BuildMetadata.with_exposed_artifacts)
.includes(:metadata, :job_artifacts_metadata)
end
2021-03-08 18:12:59 +05:30
scope :with_project_and_metadata, -> do
if Feature.enabled?(:non_public_artifacts, type: :development)
2021-10-27 15:23:28 +05:30
joins(:metadata).includes(:metadata).preload(:project)
2021-03-08 18:12:59 +05:30
end
end
2020-11-24 15:15:51 +05:30
scope :with_artifacts_not_expired, -> { with_downloadable_artifacts.where('artifacts_expire_at IS NULL OR artifacts_expire_at > ?', Time.current) }
2022-01-26 12:08:38 +05:30
scope :with_pipeline_locked_artifacts, -> { joins(:pipeline).where('pipeline.locked': Ci::Pipeline.lockeds[:artifacts_locked]) }
2020-11-24 15:15:51 +05:30
scope :last_month, -> { where('created_at > ?', Date.today - 1.month) }
scope :manual_actions, -> { where(when: :manual, status: COMPLETED_STATUSES + %i[manual]) }
scope :scheduled_actions, -> { where(when: :delayed, status: COMPLETED_STATUSES + %i[scheduled]) }
2018-03-17 18:26:18 +05:30
scope :ref_protected, -> { where(protected: true) }
2023-03-04 22:38:38 +05:30
scope :with_live_trace, -> { where('EXISTS (?)', Ci::BuildTraceChunk.where("#{quoted_table_name}.id = #{Ci::BuildTraceChunk.quoted_table_name}.build_id").select(1)) }
2019-12-04 20:38:33 +05:30
scope :with_stale_live_trace, -> { with_live_trace.finished_before(12.hours.ago) }
scope :finished_before, -> (date) { finished.where('finished_at < ?', date) }
2021-12-11 22:18:48 +05:30
scope :license_management_jobs, -> { where(name: %i(license_management license_scanning)) } # handle license rename https://gitlab.com/gitlab-org/gitlab/issues/8911
2018-03-17 18:26:18 +05:30
2019-12-21 20:55:43 +05:30
scope :with_secure_reports_from_config_options, -> (job_types) do
2022-11-25 23:54:43 +05:30
joins(:metadata).where("#{Ci::BuildMetadata.quoted_table_name}.config_options -> 'artifacts' -> 'reports' ?| array[:job_types]", job_types: job_types)
2019-12-21 20:55:43 +05:30
end
2020-04-22 19:07:51 +05:30
scope :with_coverage, -> { where.not(coverage: nil) }
2021-09-04 01:27:46 +05:30
scope :without_coverage, -> { where(coverage: nil) }
scope :with_coverage_regex, -> { where.not(coverage_regex: nil) }
2020-04-22 19:07:51 +05:30
2015-09-25 12:07:36 +05:30
acts_as_taggable
2023-05-27 22:25:52 +05:30
add_authentication_token_field :token,
encrypted: :required,
format_with_prefix: :partition_id_prefix_in_16_bit_encode
2016-09-29 09:46:39 +05:30
2021-09-04 01:27:46 +05:30
after_save :stick_build_if_status_changed
2018-03-17 18:26:18 +05:30
after_create unless: :importing? do |build|
2022-10-11 01:57:18 +05:30
run_after_commit { build.execute_hooks }
2018-03-17 18:26:18 +05:30
end
2023-04-23 21:23:45 +05:30
after_commit :track_ci_secrets_management_id_tokens_usage, on: :create, if: :id_tokens?
2016-06-02 11:05:42 +05:30
class << self
2017-09-10 17:25:29 +05:30
# This is needed for url_for to work,
# as the controller is JobsController
def model_name
ActiveModel::Name.new(self, nil, 'job')
end
2020-11-24 15:15:51 +05:30
def with_preloads
2021-03-11 19:13:27 +05:30
preload(:job_artifacts_archive, :job_artifacts, :tags, project: [:namespace])
2020-11-24 15:15:51 +05:30
end
2022-06-21 17:19:12 +05:30
def clone_accessors
%i[pipeline project ref tag options name
2022-10-11 01:57:18 +05:30
allow_failure stage stage_idx trigger_request
2022-06-21 17:19:12 +05:30
yaml_variables when environment coverage_regex
description tag_list protected needs_attributes
2022-10-11 01:57:18 +05:30
job_variables_attributes resource_group scheduling_type
2022-11-25 23:54:43 +05:30
ci_stage partition_id id_tokens].freeze
2022-06-21 17:19:12 +05:30
end
2015-09-25 12:07:36 +05:30
end
2016-09-13 17:45:13 +05:30
state_machine :status do
2019-07-07 11:18:12 +05:30
event :enqueue do
transition [:created, :skipped, :manual, :scheduled] => :preparing, if: :any_unmet_prerequisites?
end
2020-03-13 15:44:24 +05:30
event :enqueue_scheduled do
transition scheduled: :preparing, if: :any_unmet_prerequisites?
transition scheduled: :pending
end
event :enqueue_preparing do
transition preparing: :pending
end
2017-08-17 22:00:37 +05:30
event :actionize do
transition created: :manual
end
2018-12-05 23:21:45 +05:30
event :schedule do
transition created: :scheduled
end
event :unschedule do
transition scheduled: :manual
end
2020-03-13 15:44:24 +05:30
before_transition on: :enqueue_scheduled do |build|
build.scheduled_at.nil? || build.scheduled_at.past? # If false is returned, it stops the transition
2018-12-05 23:21:45 +05:30
end
before_transition scheduled: any do |build|
build.scheduled_at = nil
end
before_transition created: :scheduled do |build|
build.scheduled_at = build.options_scheduled_at
end
2020-03-13 15:44:24 +05:30
before_transition on: :enqueue_preparing do |build|
!build.any_unmet_prerequisites? # If false is returned, it stops the transition
end
2022-03-02 08:16:31 +05:30
before_transition on: :enqueue do |build|
!build.waiting_for_deployment_approval? # If false is returned, it stops the transition
end
2023-03-04 22:38:38 +05:30
before_transition any => [:pending] do |build|
build.ensure_token
2023-01-13 00:05:48 +05:30
true
end
2018-12-05 23:21:45 +05:30
after_transition created: :scheduled do |build|
build.run_after_commit do
Ci::BuildScheduleWorker.perform_at(build.scheduled_at, build.id)
end
end
2019-07-07 11:18:12 +05:30
after_transition any => [:preparing] do |build|
build.run_after_commit do
Ci::BuildPrepareWorker.perform_async(id)
end
end
2021-09-04 01:27:46 +05:30
# rubocop:disable CodeReuse/ServiceClass
after_transition any => [:pending] do |build, transition|
Ci::UpdateBuildQueueService.new.push(build, transition)
2017-08-17 22:00:37 +05:30
build.run_after_commit do
BuildQueueWorker.perform_async(id)
2022-10-11 01:57:18 +05:30
build.execute_hooks
2017-08-17 22:00:37 +05:30
end
end
2021-09-04 01:27:46 +05:30
after_transition pending: any do |build, transition|
Ci::UpdateBuildQueueService.new.pop(build, transition)
end
after_transition any => [:running] do |build, transition|
Ci::UpdateBuildQueueService.new.track(build, transition)
end
after_transition running: any do |build, transition|
Ci::UpdateBuildQueueService.new.untrack(build, transition)
Ci::BuildRunnerSession.where(build: build).delete_all
end
# rubocop:enable CodeReuse/ServiceClass
#
after_transition pending: :running do |build|
build.ensure_metadata.update_timeout_state
end
2016-04-02 18:10:28 +05:30
after_transition pending: :running do |build|
2016-11-03 12:29:30 +05:30
build.run_after_commit do
2022-07-16 23:28:13 +05:30
build.ensure_persistent_ref
2020-01-01 13:55:28 +05:30
2022-10-11 01:57:18 +05:30
build.execute_hooks
2016-11-03 12:29:30 +05:30
end
2015-12-23 02:04:40 +05:30
end
2015-09-25 12:07:36 +05:30
2016-04-02 18:10:28 +05:30
after_transition any => [:success, :failed, :canceled] do |build|
2016-11-03 12:29:30 +05:30
build.run_after_commit do
2021-01-03 14:25:43 +05:30
build.run_status_commit_hooks!
2022-08-13 15:12:31 +05:30
Ci::BuildFinishedWorker.perform_async(id)
2022-08-27 11:52:29 +05:30
observe_report_types
2016-11-03 12:29:30 +05:30
end
2015-09-25 12:07:36 +05:30
end
after_transition any => [:success] do |build|
2016-11-03 12:29:30 +05:30
build.run_after_commit do
BuildSuccessWorker.perform_async(id)
2018-11-08 19:23:39 +05:30
PagesWorker.perform_async(:deploy, id) if build.pages_generator?
end
end
2017-09-10 17:25:29 +05:30
2019-02-15 15:39:39 +05:30
after_transition any => [:failed] do |build|
next unless build.project
2018-12-13 13:39:08 +05:30
2020-10-24 23:57:45 +05:30
if build.auto_retry_allowed?
2018-04-04 21:44:52 +05:30
begin
2022-06-21 17:19:12 +05:30
# rubocop: disable CodeReuse/ServiceClass
Ci::RetryJobService.new(build.project, build.user).execute(build)
# rubocop: enable CodeReuse/ServiceClass
2022-08-27 11:52:29 +05:30
rescue Gitlab::Access::AccessDeniedError => e
Gitlab::AppLogger.error "Unable to auto-retry job #{build.id}: #{e}"
2018-04-04 21:44:52 +05:30
end
2017-09-10 17:25:29 +05:30
end
end
2018-03-17 18:26:18 +05:30
2021-11-18 22:05:49 +05:30
# Synchronize Deployment Status
# Please note that the data integirty is not assured because we can't use
# a database transaction due to DB decomposition.
after_transition do |build, transition|
next if transition.loopback?
next unless build.project
build.run_after_commit do
build.deployment&.sync_status_with(build)
end
end
2018-05-09 12:01:36 +05:30
end
2021-09-04 01:27:46 +05:30
def self.build_matchers(project)
unique_params = [
:protected,
Arel.sql("(#{arel_tag_names_array.to_sql})")
]
group(*unique_params).pluck('array_agg(id)', *unique_params).map do |values|
Gitlab::Ci::Matching::BuildMatcher.new({
build_ids: values[0],
protected: values[1],
tag_list: values[2],
project: project
})
end
end
def build_matcher
strong_memoize(:build_matcher) do
Gitlab::Ci::Matching::BuildMatcher.new({
protected: protected?,
tag_list: tag_list,
build_ids: [id],
project: project
})
end
end
2020-10-24 23:57:45 +05:30
def auto_retry_allowed?
auto_retry.allowed?
end
2022-03-02 08:16:31 +05:30
def auto_retry_expected?
failed? && auto_retry_allowed?
end
2017-08-17 22:00:37 +05:30
def detailed_status(current_user)
Gitlab::Ci::Status::Build::Factory
2023-04-23 21:23:45 +05:30
.new(present, current_user)
2017-08-17 22:00:37 +05:30
.fabricate!
2016-08-24 12:49:21 +05:30
end
2018-12-13 13:39:08 +05:30
def other_manual_actions
2023-04-23 21:23:45 +05:30
pipeline.manual_actions.reject { |action| action.name == name }
2016-08-24 12:49:21 +05:30
end
2018-12-13 13:39:08 +05:30
def other_scheduled_actions
2023-04-23 21:23:45 +05:30
pipeline.scheduled_actions.reject { |action| action.name == name }
2018-12-13 13:39:08 +05:30
end
2018-11-08 19:23:39 +05:30
def pages_generator?
Gitlab.config.pages.enabled &&
2023-04-23 21:23:45 +05:30
name == 'pages'
2018-11-08 19:23:39 +05:30
end
2019-07-07 11:18:12 +05:30
def runnable?
true
end
2018-12-13 13:39:08 +05:30
def archived?
return true if degenerated?
archive_builds_older_than = Gitlab::CurrentSettings.current_application_settings.archive_builds_older_than
archive_builds_older_than.present? && created_at < archive_builds_older_than
end
2016-08-24 12:49:21 +05:30
def playable?
2022-03-02 08:16:31 +05:30
action? && !archived? && (manual? || scheduled? || retryable?) && !waiting_for_deployment_approval?
end
def waiting_for_deployment_approval?
2023-03-04 22:38:38 +05:30
manual? && deployment_job? && deployment&.blocked?
2018-12-05 23:21:45 +05:30
end
2023-01-13 00:05:48 +05:30
def outdated_deployment?
strong_memoize(:outdated_deployment) do
2023-03-04 22:38:38 +05:30
deployment_job? &&
2023-01-13 00:05:48 +05:30
incomplete? &&
2022-10-11 01:57:18 +05:30
project.ci_forward_deployment_enabled? &&
deployment&.older_than_last_successful_deployment?
end
end
2018-12-05 23:21:45 +05:30
def schedulable?
2018-12-13 13:39:08 +05:30
self.when == 'delayed' && options[:start_in].present?
2018-12-05 23:21:45 +05:30
end
def options_scheduled_at
ChronicDuration.parse(options[:start_in])&.seconds&.from_now
2016-08-24 12:49:21 +05:30
end
2017-08-17 22:00:37 +05:30
def action?
2018-12-05 23:21:45 +05:30
%w[manual delayed].include?(self.when)
2017-08-17 22:00:37 +05:30
end
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ServiceClass
2019-10-12 21:52:04 +05:30
def play(current_user, job_variables_attributes = nil)
2017-08-17 22:00:37 +05:30
Ci::PlayBuildService
.new(project, current_user)
2019-10-12 21:52:04 +05:30
.execute(self, job_variables_attributes)
2017-08-17 22:00:37 +05:30
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ServiceClass
2017-08-17 22:00:37 +05:30
def cancelable?
2018-11-20 20:47:30 +05:30
active? || created?
2016-08-24 12:49:21 +05:30
end
2017-09-10 17:25:29 +05:30
def retries_count
2023-04-23 21:23:45 +05:30
pipeline.builds.retried.where(name: name).count
2017-09-10 17:25:29 +05:30
end
2021-03-11 19:13:27 +05:30
override :all_met_to_become_pending?
def all_met_to_become_pending?
super && !any_unmet_prerequisites?
end
2019-07-07 11:18:12 +05:30
def any_unmet_prerequisites?
prerequisites.present?
end
def prerequisites
Gitlab::Ci::Build::Prerequisite::Factory.new(self).unmet
end
2023-01-13 00:05:48 +05:30
def persisted_environment
return unless has_environment_keyword?
strong_memoize(:persisted_environment) do
# This code path has caused N+1s in the past, since environments are only indirectly
# associated to builds and pipelines; see https://gitlab.com/gitlab-org/gitlab/-/issues/326445
# We therefore batch-load them to prevent dormant N+1s until we found a proper solution.
BatchLoader.for(expanded_environment_name).batch(key: project_id) do |names, loader, args|
Environment.where(name: names, project: args[:key]).find_each do |environment|
loader.call(environment.name, environment)
end
end
end
end
def persisted_environment=(environment)
strong_memoize(:persisted_environment) { environment }
end
# If build.persisted_environment is a BatchLoader, we need to remove
# the method proxy in order to clone into new item here
# https://github.com/exAspArk/batch-loader/issues/31
def actual_persisted_environment
persisted_environment.respond_to?(:__sync) ? persisted_environment.__sync : persisted_environment
end
2017-08-17 22:00:37 +05:30
def expanded_environment_name
2023-01-13 00:05:48 +05:30
return unless has_environment_keyword?
2018-05-09 12:01:36 +05:30
strong_memoize(:expanded_environment_name) do
2020-04-08 14:13:33 +05:30
# We're using a persisted expanded environment name in order to avoid
# variable expansion per request.
2020-10-24 23:57:45 +05:30
if metadata&.expanded_environment_name.present?
2020-04-08 14:13:33 +05:30
metadata.expanded_environment_name
else
2022-08-27 11:52:29 +05:30
ExpandVariables.expand(environment, -> { simple_variables.sort_and_expand_all })
2020-04-08 14:13:33 +05:30
end
2018-05-09 12:01:36 +05:30
end
2015-11-26 14:37:03 +05:30
end
2020-01-01 13:55:28 +05:30
def expanded_kubernetes_namespace
2023-01-13 00:05:48 +05:30
return unless has_environment_keyword?
2020-01-01 13:55:28 +05:30
namespace = options.dig(:environment, :kubernetes, :namespace)
if namespace.present?
strong_memoize(:expanded_kubernetes_namespace) do
ExpandVariables.expand(namespace, -> { simple_variables })
end
end
end
2023-01-13 00:05:48 +05:30
def has_environment_keyword?
2017-08-17 22:00:37 +05:30
environment.present?
end
2023-03-04 22:38:38 +05:30
def deployment_job?
2023-04-23 21:23:45 +05:30
has_environment_keyword? && environment_action == 'start'
2017-08-17 22:00:37 +05:30
end
def stops_environment?
2023-04-23 21:23:45 +05:30
has_environment_keyword? && environment_action == 'stop'
2017-08-17 22:00:37 +05:30
end
def environment_action
2023-04-23 21:23:45 +05:30
options.fetch(:environment, {}).fetch(:action, 'start') if options
2017-08-17 22:00:37 +05:30
end
2022-08-27 11:52:29 +05:30
def environment_tier_from_options
2023-04-23 21:23:45 +05:30
options.dig(:environment, :deployment_tier) if options
2021-04-17 20:07:23 +05:30
end
2022-08-27 11:52:29 +05:30
def environment_tier
environment_tier_from_options || persisted_environment.try(:tier)
end
2018-03-17 18:26:18 +05:30
def triggered_by?(current_user)
user == current_user
end
2018-12-13 13:39:08 +05:30
def on_stop
options&.dig(:environment, :on_stop)
end
2022-07-23 23:45:48 +05:30
def stop_action_successful?
success?
end
2019-07-07 11:18:12 +05:30
##
# All variables, including persisted environment variables.
2017-08-17 22:00:37 +05:30
#
2019-07-07 11:18:12 +05:30
def variables
strong_memoize(:variables) do
Gitlab::Ci::Variables::Collection.new
.concat(persisted_variables)
2021-02-22 17:27:13 +05:30
.concat(dependency_proxy_variables)
2020-04-22 19:07:51 +05:30
.concat(job_jwt_variables)
2019-07-07 11:18:12 +05:30
.concat(scoped_variables)
2019-10-12 21:52:04 +05:30
.concat(job_variables)
2019-07-07 11:18:12 +05:30
.concat(persisted_environment_variables)
end
2017-08-17 22:00:37 +05:30
end
2019-07-07 11:18:12 +05:30
def persisted_variables
2018-05-09 12:01:36 +05:30
Gitlab::Ci::Variables::Collection.new.tap do |variables|
2019-07-07 11:18:12 +05:30
break variables unless persisted?
variables
.concat(pipeline.persisted_variables)
.append(key: 'CI_JOB_ID', value: id.to_s)
.append(key: 'CI_JOB_URL', value: Gitlab::Routing.url_helpers.project_job_url(project, self))
.append(key: 'CI_JOB_TOKEN', value: token.to_s, public: false, masked: true)
2021-04-17 20:07:23 +05:30
.append(key: 'CI_JOB_STARTED_AT', value: started_at&.iso8601)
2023-06-20 00:43:36 +05:30
if Feature.disabled?(:ci_remove_legacy_predefined_variables, project)
variables
.append(key: 'CI_BUILD_ID', value: id.to_s)
.append(key: 'CI_BUILD_TOKEN', value: token.to_s, public: false, masked: true)
end
variables
2020-10-24 23:57:45 +05:30
.append(key: 'CI_REGISTRY_USER', value: ::Gitlab::Auth::CI_JOB_USER)
2019-07-07 11:18:12 +05:30
.append(key: 'CI_REGISTRY_PASSWORD', value: token.to_s, public: false, masked: true)
.append(key: 'CI_REPOSITORY_URL', value: repo_url.to_s, public: false)
.concat(deploy_token_variables)
2022-05-07 20:08:51 +05:30
.concat(harbor_variables)
2023-03-17 16:20:25 +05:30
.concat(apple_app_store_variables)
2023-05-27 22:25:52 +05:30
.concat(google_play_variables)
2018-05-09 12:01:36 +05:30
end
end
2019-07-07 11:18:12 +05:30
def persisted_environment_variables
Gitlab::Ci::Variables::Collection.new.tap do |variables|
break variables unless persisted? && persisted_environment.present?
variables.concat(persisted_environment.predefined_variables)
2021-09-04 01:27:46 +05:30
variables.append(key: 'CI_ENVIRONMENT_ACTION', value: environment_action)
2022-08-27 11:52:29 +05:30
variables.append(key: 'CI_ENVIRONMENT_TIER', value: environment_tier)
2021-09-04 01:27:46 +05:30
2019-07-07 11:18:12 +05:30
# Here we're passing unexpanded environment_url for runner to expand,
# and we need to make sure that CI_ENVIRONMENT_NAME and
# CI_ENVIRONMENT_SLUG so on are available for the URL be expanded.
variables.append(key: 'CI_ENVIRONMENT_URL', value: environment_url) if environment_url
2018-05-09 12:01:36 +05:30
end
end
2019-07-07 11:18:12 +05:30
def deploy_token_variables
Gitlab::Ci::Variables::Collection.new.tap do |variables|
break variables unless gitlab_deploy_token
2018-05-09 12:01:36 +05:30
2019-07-07 11:18:12 +05:30
variables.append(key: 'CI_DEPLOY_USER', value: gitlab_deploy_token.username)
variables.append(key: 'CI_DEPLOY_PASSWORD', value: gitlab_deploy_token.token, public: false, masked: true)
end
2017-08-17 22:00:37 +05:30
end
2021-02-22 17:27:13 +05:30
def dependency_proxy_variables
Gitlab::Ci::Variables::Collection.new.tap do |variables|
break variables unless Gitlab.config.dependency_proxy.enabled
variables.append(key: 'CI_DEPENDENCY_PROXY_USER', value: ::Gitlab::Auth::CI_JOB_USER)
variables.append(key: 'CI_DEPENDENCY_PROXY_PASSWORD', value: token.to_s, public: false, masked: true)
end
end
2022-05-07 20:08:51 +05:30
def harbor_variables
return [] unless harbor_integration.try(:activated?)
Gitlab::Ci::Variables::Collection.new(harbor_integration.ci_variables)
end
2023-03-17 16:20:25 +05:30
def apple_app_store_variables
return [] unless apple_app_store_integration.try(:activated?)
return [] unless pipeline.protected_ref?
Gitlab::Ci::Variables::Collection.new(apple_app_store_integration.ci_variables)
end
2023-05-27 22:25:52 +05:30
def google_play_variables
return [] unless google_play_integration.try(:activated?)
return [] unless pipeline.protected_ref?
Gitlab::Ci::Variables::Collection.new(google_play_integration.ci_variables)
end
2018-03-17 18:26:18 +05:30
def features
2021-04-17 20:07:23 +05:30
{
trace_sections: true,
failure_reasons: self.class.failure_reasons.keys
}
2018-03-17 18:26:18 +05:30
end
def merge_request
2020-04-22 19:07:51 +05:30
strong_memoize(:merge_request) do
pipeline.all_merge_requests.order(iid: :asc).first
end
2015-09-25 12:07:36 +05:30
end
def repo_url
2019-02-15 15:39:39 +05:30
return unless token
2020-10-24 23:57:45 +05:30
auth = "#{::Gitlab::Auth::CI_JOB_USER}:#{token}@"
2018-03-17 18:26:18 +05:30
project.http_url_to_repo.sub(%r{^https?://}) do |prefix|
2015-12-23 02:04:40 +05:30
prefix + auth
end
2015-09-25 12:07:36 +05:30
end
def allow_git_fetch
2015-12-23 02:04:40 +05:30
project.build_allow_git_fetch
2015-09-25 12:07:36 +05:30
end
def update_coverage
2017-08-17 22:00:37 +05:30
coverage = trace.extract_coverage(coverage_regex)
2018-11-18 11:00:15 +05:30
update(coverage: coverage) if coverage.present?
2015-09-25 12:07:36 +05:30
end
2017-08-17 22:00:37 +05:30
def trace
Gitlab::Ci::Trace.new(self)
2016-09-29 09:46:39 +05:30
end
2016-04-02 18:10:28 +05:30
def has_trace?
2017-08-17 22:00:37 +05:30
trace.exist?
2016-06-02 11:05:42 +05:30
end
2015-09-25 12:07:36 +05:30
2019-10-12 21:52:04 +05:30
def has_live_trace?
2022-07-23 23:45:48 +05:30
trace.live?
2019-10-12 21:52:04 +05:30
end
def has_archived_trace?
2022-07-16 23:28:13 +05:30
trace.archived?
2019-10-12 21:52:04 +05:30
end
2019-09-04 21:01:54 +05:30
def artifacts_file
job_artifacts_archive&.file
end
def artifacts_size
job_artifacts_archive&.size
end
def artifacts_metadata
job_artifacts_metadata&.file
end
def artifacts?
!artifacts_expired? && artifacts_file&.exists?
end
2020-11-24 15:15:51 +05:30
def locked_artifacts?
pipeline.artifacts_locked? && artifacts_file&.exists?
end
2020-10-24 23:57:45 +05:30
# This method is similar to #artifacts? but it includes the artifacts
# locking mechanics. A new method was created to prevent breaking existing
# behavior and avoid introducing N+1s.
def available_artifacts?
(!artifacts_expired? || pipeline.artifacts_locked?) && job_artifacts_archive&.exists?
end
2019-09-04 21:01:54 +05:30
def artifacts_metadata?
artifacts? && artifacts_metadata&.exists?
end
2018-12-05 23:21:45 +05:30
def has_job_artifacts?
job_artifacts.any?
2018-11-18 11:00:15 +05:30
end
2020-06-23 00:09:42 +05:30
def has_test_reports?
2022-10-11 01:57:18 +05:30
job_artifacts.of_report_type(:test).exists?
end
2021-11-11 11:23:49 +05:30
def ensure_trace_metadata!
2023-03-04 22:38:38 +05:30
Ci::BuildTraceMetadata.find_or_upsert_for!(id, partition_id)
2021-11-11 11:23:49 +05:30
end
2019-12-26 22:10:19 +05:30
def artifacts_expose_as
options.dig(:artifacts, :expose_as)
end
def artifacts_paths
options.dig(:artifacts, :paths)
end
2017-08-17 22:00:37 +05:30
def needs_touch?
2020-06-23 00:09:42 +05:30
Time.current - updated_at > 15.minutes.to_i
end
def valid_token?(token)
2022-07-16 23:28:13 +05:30
self.token && token.present? && ActiveSupport::SecurityUtils.secure_compare(token, self.token)
2015-11-26 14:37:03 +05:30
end
2023-03-17 16:20:25 +05:30
def remove_token!
2023-05-27 22:25:52 +05:30
update!(token_encrypted: nil)
2023-03-17 16:20:25 +05:30
end
2022-01-26 12:08:38 +05:30
# acts_as_taggable uses this method create/remove tags with contexts
# defined by taggings and to get those contexts it executes a query.
# We don't use any other contexts except `tags`, so we don't need it.
override :custom_contexts
def custom_contexts
[]
end
2021-09-30 23:02:18 +05:30
def tag_list
if tags.loaded?
tags.map(&:name)
else
super
end
end
2016-06-02 11:05:42 +05:30
def has_tags?
tag_list.any?
2015-10-24 18:46:33 +05:30
end
def any_runners_online?
2021-09-04 01:27:46 +05:30
cache_for_online_runners do
project.any_online_runners? { |runner| runner.match_build_if_online?(self) }
2021-04-29 21:17:54 +05:30
end
end
def any_runners_available?
2021-09-04 01:27:46 +05:30
cache_for_available_runners do
2022-03-02 08:16:31 +05:30
project.active_runners.exists?
2021-04-29 21:17:54 +05:30
end
2015-10-24 18:46:33 +05:30
end
2016-06-02 11:05:42 +05:30
def stuck?
2015-10-24 18:46:33 +05:30
pending? && !any_runners_online?
end
2015-12-23 02:04:40 +05:30
def execute_hooks
2016-04-02 18:10:28 +05:30
return unless project
2022-07-23 23:45:48 +05:30
return if user&.blocked?
2018-03-17 18:26:18 +05:30
2023-05-27 22:25:52 +05:30
ActiveRecord::Associations::Preloader.new(records: [self], associations: { runner: :tags }).call
2022-08-27 11:52:29 +05:30
2020-01-01 13:55:28 +05:30
project.execute_hooks(build_data.dup, :job_hooks) if project.has_active_hooks?(:job_hooks)
2021-09-30 23:02:18 +05:30
project.execute_integrations(build_data.dup, :job_hooks) if project.has_active_integrations?(:job_hooks)
2015-12-23 02:04:40 +05:30
end
2018-05-09 12:01:36 +05:30
def browsable_artifacts?
artifacts_metadata?
end
2021-03-08 18:12:59 +05:30
def artifacts_public?
return true unless Feature.enabled?(:non_public_artifacts, type: :development)
artifacts_public = options.dig(:artifacts, :public)
return true if artifacts_public.nil? # Default artifacts:public to true
options.dig(:artifacts, :public)
end
2016-01-29 22:53:50 +05:30
def artifacts_metadata_entry(path, **options)
2018-11-18 11:00:15 +05:30
artifacts_metadata.open do |metadata_stream|
2018-05-09 12:01:36 +05:30
metadata = Gitlab::Ci::Build::Artifacts::Metadata.new(
2018-11-18 11:00:15 +05:30
metadata_stream,
2018-05-09 12:01:36 +05:30
path,
**options)
2016-08-24 12:49:21 +05:30
2018-05-09 12:01:36 +05:30
metadata.to_entry
end
end
2015-12-23 02:04:40 +05:30
2016-04-02 18:10:28 +05:30
def erasable?
2018-12-05 23:21:45 +05:30
complete? && (artifacts? || has_job_artifacts? || has_trace?)
2016-04-02 18:10:28 +05:30
end
def erased?
2023-04-23 21:23:45 +05:30
!erased_at.nil?
2016-04-02 18:10:28 +05:30
end
def artifacts_expired?
2020-06-23 00:09:42 +05:30
artifacts_expire_at && artifacts_expire_at < Time.current
end
def artifacts_expire_in
2020-06-23 00:09:42 +05:30
artifacts_expire_at - Time.current if artifacts_expire_at
end
def artifacts_expire_in=(value)
self.artifacts_expire_at =
if value
2017-08-17 22:00:37 +05:30
ChronicDuration.parse(value)&.seconds&.from_now
end
end
2021-01-03 14:25:43 +05:30
def has_expired_locked_archive_artifacts?
locked_artifacts? &&
artifacts_expire_at.present? && artifacts_expire_at < Time.current
end
2020-03-13 15:44:24 +05:30
def has_expiring_archive_artifacts?
has_expiring_artifacts? && job_artifacts_archive.present?
2017-08-17 22:00:37 +05:30
end
2020-07-28 23:09:34 +05:30
def self.keep_artifacts!
update_all(artifacts_expire_at: nil)
Ci::JobArtifact.where(job: self.select(:id)).update_all(expire_at: nil)
end
def keep_artifacts!
2023-04-23 21:23:45 +05:30
update(artifacts_expire_at: nil)
job_artifacts.update_all(expire_at: nil)
end
2023-04-23 21:23:45 +05:30
def artifact_for_type(type)
2021-03-11 19:13:27 +05:30
file_types = Ci::JobArtifact.associated_file_types_for(type)
file_types_ids = file_types&.map { |file_type| Ci::JobArtifact.file_types[file_type] }
2023-04-23 21:23:45 +05:30
job_artifacts.find_by(file_type: file_types_ids)
2018-12-05 23:21:45 +05:30
end
2017-08-17 22:00:37 +05:30
def steps
[Gitlab::Ci::Build::Step.from_commands(self),
2020-06-23 00:09:42 +05:30
Gitlab::Ci::Build::Step.from_release(self),
2017-08-17 22:00:37 +05:30
Gitlab::Ci::Build::Step.from_after_script(self)].compact
end
2023-03-04 22:38:38 +05:30
def runtime_hooks
Gitlab::Ci::Build::Hook.from_hooks(self)
end
2017-08-17 22:00:37 +05:30
def image
Gitlab::Ci::Build::Image.from_image(self)
end
def services
Gitlab::Ci::Build::Image.from_services(self)
end
def cache
2021-04-17 20:07:23 +05:30
cache = Array.wrap(options[:cache])
2018-03-17 18:26:18 +05:30
2023-07-09 08:55:56 +05:30
cache.each do |single_cache|
single_cache[:fallback_keys] = [] unless single_cache.key?(:fallback_keys)
end
2021-04-17 20:07:23 +05:30
if project.jobs_cache_index
cache = cache.map do |single_cache|
2023-07-09 08:55:56 +05:30
cache = single_cache.merge(key: "#{single_cache[:key]}-#{project.jobs_cache_index}")
fallback = cache.slice(:fallback_keys).transform_values { |keys| keys.map { |key| "#{key}-#{project.jobs_cache_index}" } }
cache.merge(fallback.compact)
2021-04-17 20:07:23 +05:30
end
2018-03-17 18:26:18 +05:30
end
2022-06-21 17:19:12 +05:30
return cache unless project.ci_separated_caches
2022-05-03 16:02:30 +05:30
cache.map do |entry|
2023-03-17 16:20:25 +05:30
type_suffix = !entry[:unprotect] && pipeline.protected_ref? ? 'protected' : 'non_protected'
2023-07-09 08:55:56 +05:30
cache = entry.merge(key: "#{entry[:key]}-#{type_suffix}")
fallback = cache.slice(:fallback_keys).transform_values { |keys| keys.map { |key| "#{key}-#{type_suffix}" } }
cache.merge(fallback.compact)
2022-05-03 16:02:30 +05:30
end
2017-08-17 22:00:37 +05:30
end
2023-07-09 08:55:56 +05:30
def fallback_cache_keys_defined?
Array.wrap(options[:cache]).any? { |cache| cache[:fallback_keys].present? }
end
2017-08-17 22:00:37 +05:30
def credentials
Gitlab::Ci::Build::Credentials::Factory.new(self).create!
end
2018-11-18 11:00:15 +05:30
def has_valid_build_dependencies?
2020-04-22 19:07:51 +05:30
dependencies.valid?
end
2018-11-18 11:00:15 +05:30
2020-04-22 19:07:51 +05:30
def invalid_dependencies
dependencies.invalid_local
2018-03-17 18:26:18 +05:30
end
def valid_dependency?
2021-10-27 15:23:28 +05:30
return false if artifacts_expired? && !pipeline.artifacts_locked?
2018-03-17 18:26:18 +05:30
return false if erased?
true
end
2018-11-18 11:00:15 +05:30
def runner_required_feature_names
strong_memoize(:runner_required_feature_names) do
RUNNER_FEATURES.select do |feature, method|
method.call(self)
end.keys
end
end
def supported_runner?(features)
runner_required_feature_names.all? do |feature_name|
features&.dig(feature_name)
end
end
def publishes_artifacts_reports?
options&.dig(:artifacts, :reports)&.any?
end
2020-06-23 00:09:42 +05:30
def supports_artifacts_exclude?
2021-09-30 23:02:18 +05:30
options&.dig(:artifacts, :exclude)&.any?
2020-06-23 00:09:42 +05:30
end
2020-07-28 23:09:34 +05:30
def multi_build_steps?
2020-10-24 23:57:45 +05:30
options.dig(:release)&.any?
2020-06-23 00:09:42 +05:30
end
2020-11-24 15:15:51 +05:30
def hide_secrets(data, metrics = ::Gitlab::Ci::Trace::Metrics.new)
2017-08-17 22:00:37 +05:30
return unless trace
2020-11-24 15:15:51 +05:30
data.dup.tap do |trace|
Gitlab::Ci::MaskSecret.mask!(trace, project.runners_token) if project
Gitlab::Ci::MaskSecret.mask!(trace, token) if token
if trace != data
metrics.increment_trace_operation(operation: :mutated)
end
end
2017-08-17 22:00:37 +05:30
end
2018-03-17 18:26:18 +05:30
def serializable_hash(options = {})
super(options).merge(when: read_attribute(:when))
end
2018-11-08 19:23:39 +05:30
def has_terminal?
running? && runner_session_url.present?
end
2018-11-18 11:00:15 +05:30
def collect_test_reports!(test_reports)
2022-10-11 01:57:18 +05:30
each_report(Ci::JobArtifact.file_types_for_report(:test)) do |file_type, blob|
Gitlab::Ci::Parsers.fabricate!(file_type).parse!(blob, test_reports, job: self)
2018-11-18 11:00:15 +05:30
end
2022-10-11 01:57:18 +05:30
test_reports
2018-11-18 11:00:15 +05:30
end
2020-05-24 23:13:21 +05:30
def collect_accessibility_reports!(accessibility_report)
2022-08-27 11:52:29 +05:30
each_report(Ci::JobArtifact.file_types_for_report(:accessibility)) do |file_type, blob|
2020-05-24 23:13:21 +05:30
Gitlab::Ci::Parsers.fabricate!(file_type).parse!(blob, accessibility_report)
end
accessibility_report
end
2021-02-22 17:27:13 +05:30
def collect_codequality_reports!(codequality_report)
2022-08-27 11:52:29 +05:30
each_report(Ci::JobArtifact.file_types_for_report(:codequality)) do |file_type, blob|
2023-01-13 00:05:48 +05:30
Gitlab::Ci::Parsers.fabricate!(file_type).parse!(blob, codequality_report, { project: project, commit_sha: pipeline.sha })
2021-02-22 17:27:13 +05:30
end
codequality_report
end
2020-05-24 23:13:21 +05:30
def collect_terraform_reports!(terraform_reports)
2022-08-27 11:52:29 +05:30
each_report(::Ci::JobArtifact.file_types_for_report(:terraform)) do |file_type, blob, report_artifact|
2020-05-24 23:13:21 +05:30
::Gitlab::Ci::Parsers.fabricate!(file_type).parse!(blob, terraform_reports, artifact: report_artifact)
end
terraform_reports
end
2019-09-04 21:01:54 +05:30
def report_artifacts
2022-07-23 23:45:48 +05:30
job_artifacts.all_reports
2019-09-04 21:01:54 +05:30
end
2018-12-05 23:21:45 +05:30
# Virtual deployment status depending on the environment status.
def deployment_status
2023-03-04 22:38:38 +05:30
return unless deployment_job?
2018-12-05 23:21:45 +05:30
if success?
return successful_deployment_status
2018-12-13 13:39:08 +05:30
elsif failed?
2018-12-05 23:21:45 +05:30
return :failed
end
:creating
end
2019-12-26 22:10:19 +05:30
# Consider this object to have a structural integrity problems
def doom!
2021-11-11 11:23:49 +05:30
transaction do
update_columns(status: :failed, failure_reason: :data_integrity_failure)
all_queuing_entries.delete_all
2022-03-02 08:16:31 +05:30
all_runtime_metadata.delete_all
2021-11-11 11:23:49 +05:30
end
2022-03-02 08:16:31 +05:30
2022-07-23 23:45:48 +05:30
deployment&.sync_status_with(self)
2022-03-02 08:16:31 +05:30
Gitlab::AppLogger.info(
message: 'Build doomed',
class: self.class.name,
build_id: id,
pipeline_id: pipeline_id,
project_id: project_id)
2019-12-26 22:10:19 +05:30
end
2020-05-24 23:13:21 +05:30
def degradation_threshold
var = yaml_variables.find { |v| v[:key] == DEGRADATION_THRESHOLD_VARIABLE_NAME }
var[:value]&.to_i if var
end
2020-11-24 15:15:51 +05:30
def remove_pending_state!
pending_state.try(:delete)
end
2021-01-03 14:25:43 +05:30
def run_on_status_commit(&block)
status_commit_hooks.push(block)
end
def max_test_cases_per_report
# NOTE: This is temporary and will be replaced later by a value
# that would come from an actual application limit.
::Gitlab.com? ? 500_000 : 0
end
2021-02-22 17:27:13 +05:30
def debug_mode?
2023-03-04 22:38:38 +05:30
# perform the check on both sides in case the runner version is old
debug_trace_enabled? ||
Gitlab::Utils.to_boolean(variables['CI_DEBUG_SERVICES']&.value, default: false) ||
Gitlab::Utils.to_boolean(variables['CI_DEBUG_TRACE']&.value, default: false)
2021-02-22 17:27:13 +05:30
end
2021-03-08 18:12:59 +05:30
def drop_with_exit_code!(failure_reason, exit_code)
2022-08-27 11:52:29 +05:30
failure_reason ||= :unknown_failure
result = drop!(::Gitlab::Ci::Build::Status::Reason.new(self, failure_reason, exit_code))
::Ci::TrackFailedBuildWorker.perform_async(id, exit_code, failure_reason)
result
2021-03-08 18:12:59 +05:30
end
def exit_codes_defined?
options.dig(:allow_failure_criteria, :exit_codes).present?
end
2021-09-04 01:27:46 +05:30
def create_queuing_entry!
::Ci::PendingBuild.upsert_from_build!(self)
end
##
# We can have only one queuing entry or running build tracking entry,
# because there is a unique index on `build_id` in each table, but we need
# a relation to remove these entries more efficiently in a single statement
# without actually loading data.
#
def all_queuing_entries
2023-04-23 21:23:45 +05:30
::Ci::PendingBuild.where(build_id: id)
2021-09-04 01:27:46 +05:30
end
def all_runtime_metadata
2023-04-23 21:23:45 +05:30
::Ci::RunningBuild.where(build_id: id)
2021-09-04 01:27:46 +05:30
end
def shared_runner_build?
runner&.instance_type?
end
2022-01-26 12:08:38 +05:30
def job_variables_attributes
strong_memoize(:job_variables_attributes) do
job_variables.internal_source.map do |variable|
variable.attributes.except('id', 'job_id', 'encrypted_value', 'encrypted_value_iv').tap do |attrs|
attrs[:value] = variable.value
end
end
end
end
2022-03-02 08:16:31 +05:30
def allowed_to_fail_with_code?(exit_code)
options
.dig(:allow_failure_criteria, :exit_codes)
.to_a
.include?(exit_code)
end
2022-07-23 23:45:48 +05:30
def each_report(report_types)
job_artifacts_for_types(report_types).each do |report_artifact|
report_artifact.each_blob do |blob|
yield report_artifact.file_type, blob, report_artifact
end
end
end
2022-08-27 11:52:29 +05:30
def clone(current_user:, new_job_variables_attributes: [])
new_build = super
if action? && new_job_variables_attributes.any?
new_build.job_variables = []
new_build.job_variables_attributes = new_job_variables_attributes
end
new_build
end
def job_artifact_types
job_artifacts.map(&:file_type)
end
2022-10-11 01:57:18 +05:30
def test_suite_name
if matrix_build?
name
else
group_name
end
end
2021-01-03 14:25:43 +05:30
protected
def run_status_commit_hooks!
status_commit_hooks.reverse_each do |hook|
instance_eval(&hook)
end
end
2016-08-24 12:49:21 +05:30
private
2016-06-02 11:05:42 +05:30
2022-07-23 23:45:48 +05:30
def matrix_build?
options.dig(:parallel, :matrix).present?
end
2021-09-04 01:27:46 +05:30
def stick_build_if_status_changed
return unless saved_change_to_status?
return unless running?
2021-11-18 22:05:49 +05:30
self.class.sticking.stick(:build, id)
2021-09-04 01:27:46 +05:30
end
2021-01-03 14:25:43 +05:30
def status_commit_hooks
@status_commit_hooks ||= []
end
2020-10-24 23:57:45 +05:30
def auto_retry
strong_memoize(:auto_retry) do
Gitlab::Ci::Build::AutoRetry.new(self)
end
end
2020-01-01 13:55:28 +05:30
def build_data
2021-06-08 01:23:25 +05:30
strong_memoize(:build_data) { Gitlab::DataBuilder::Build.build(self) }
2020-01-01 13:55:28 +05:30
end
2018-12-05 23:21:45 +05:30
def successful_deployment_status
2018-12-13 13:39:08 +05:30
if deployment&.last?
:last
else
:out_of_date
2018-12-05 23:21:45 +05:30
end
end
def job_artifacts_for_types(report_types)
# Use select to leverage cached associations and avoid N+1 queries
job_artifacts.select { |artifact| artifact.file_type.in?(report_types) }
end
2017-09-10 17:25:29 +05:30
def environment_url
options&.dig(:environment, :url) || persisted_environment&.external_url
end
2020-04-08 14:13:33 +05:30
def environment_status
strong_memoize(:environment_status) do
2023-01-13 00:05:48 +05:30
if has_environment_keyword? && merge_request
2020-04-08 14:13:33 +05:30
EnvironmentStatus.new(project, persisted_environment, merge_request, pipeline.sha)
end
end
end
2020-03-13 15:44:24 +05:30
def has_expiring_artifacts?
2020-06-23 00:09:42 +05:30
artifacts_expire_at.present? && artifacts_expire_at > Time.current
2020-03-13 15:44:24 +05:30
end
2020-04-22 19:07:51 +05:30
def job_jwt_variables
2023-07-09 08:55:56 +05:30
if id_tokens?
2022-11-25 23:54:43 +05:30
id_tokens_variables
else
2023-07-09 08:55:56 +05:30
predefined_jwt_variables
2022-11-25 23:54:43 +05:30
end
end
2023-03-04 22:38:38 +05:30
def predefined_jwt_variables
2020-04-22 19:07:51 +05:30
Gitlab::Ci::Variables::Collection.new.tap do |variables|
jwt = Gitlab::Ci::Jwt.for_build(self)
2022-03-02 08:16:31 +05:30
jwt_v2 = Gitlab::Ci::JwtV2.for_build(self)
2020-04-22 19:07:51 +05:30
variables.append(key: 'CI_JOB_JWT', value: jwt, public: false, masked: true)
2022-03-02 08:16:31 +05:30
variables.append(key: 'CI_JOB_JWT_V1', value: jwt, public: false, masked: true)
variables.append(key: 'CI_JOB_JWT_V2', value: jwt_v2, public: false, masked: true)
2021-01-29 00:20:46 +05:30
rescue OpenSSL::PKey::RSAError, Gitlab::Ci::Jwt::NoSigningKeyError => e
2020-05-05 14:28:15 +05:30
Gitlab::ErrorTracking.track_exception(e)
2020-04-22 19:07:51 +05:30
end
end
2021-03-08 18:12:59 +05:30
2022-11-25 23:54:43 +05:30
def id_tokens_variables
Gitlab::Ci::Variables::Collection.new.tap do |variables|
id_tokens.each do |var_name, token_data|
2023-03-04 22:38:38 +05:30
token = Gitlab::Ci::JwtV2.for_build(self, aud: token_data['aud'])
2022-11-25 23:54:43 +05:30
variables.append(key: var_name, value: token, public: false, masked: true)
end
rescue OpenSSL::PKey::RSAError, Gitlab::Ci::Jwt::NoSigningKeyError => e
Gitlab::ErrorTracking.track_exception(e)
end
end
2021-04-29 21:17:54 +05:30
def cache_for_online_runners(&block)
Rails.cache.fetch(
['has-online-runners', id],
expires_in: RUNNERS_STATUS_CACHE_EXPIRATION
) { yield }
end
def cache_for_available_runners(&block)
Rails.cache.fetch(
['has-available-runners', project.id],
expires_in: RUNNERS_STATUS_CACHE_EXPIRATION
) { yield }
end
2022-08-27 11:52:29 +05:30
def observe_report_types
2022-10-11 01:57:18 +05:30
return unless ::Gitlab.com?
2022-08-27 11:52:29 +05:30
report_types = options&.dig(:artifacts, :reports)&.keys || []
report_types.each do |report_type|
next unless Ci::JobArtifact::REPORT_TYPES.include?(report_type)
::Gitlab::Ci::Artifacts::Metrics
.build_completed_report_type_counter(report_type)
.increment(status: status)
end
end
2023-04-23 21:23:45 +05:30
def track_ci_secrets_management_id_tokens_usage
::Gitlab::UsageDataCounters::HLLRedisCounter.track_event('i_ci_secrets_management_id_tokens_build_created', values: user_id)
Gitlab::Tracking.event(
self.class.to_s,
'create_id_tokens',
namespace: namespace,
user: user,
label: 'redis_hll_counters.ci_secrets_management.i_ci_secrets_management_id_tokens_build_created_monthly',
ultimate_namespace_id: namespace.root_ancestor.id,
context: [Gitlab::Tracking::ServicePingContext.new(
data_source: :redis_hll,
event: 'i_ci_secrets_management_id_tokens_build_created'
).to_context]
)
end
2023-05-27 22:25:52 +05:30
def partition_id_prefix_in_16_bit_encode
"#{partition_id.to_s(16)}_"
end
2015-09-25 12:07:36 +05:30
end
end
2019-12-04 20:38:33 +05:30
2021-06-08 01:23:25 +05:30
Ci::Build.prepend_mod_with('Ci::Build')