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

991 lines
29 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
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
2018-05-09 12:01:36 +05:30
include ObjectStorage::BackgroundMove
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
2020-01-01 13:55:28 +05:30
include IgnorableColumns
2016-09-29 09:46:39 +05:30
2019-02-15 15:39:39 +05:30
BuildArchivedError = Class.new(StandardError)
2020-01-01 13:55:28 +05:30
ignore_columns :artifacts_file, :artifacts_file_store, :artifacts_metadata, :artifacts_metadata_store, :artifacts_size, :commands, remove_after: '2019-12-15', remove_with: '12.7'
2019-02-15 15:39: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'
2020-03-13 15:44:24 +05:30
belongs_to :resource_group, class_name: 'Ci::ResourceGroup', inverse_of: :builds
belongs_to :pipeline, class_name: 'Ci::Pipeline', foreign_key: :commit_id
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? },
refspecs: -> (build) { build.merge_request_ref? }
2018-11-18 11:00:15 +05:30
}.freeze
2019-12-26 22:10:19 +05:30
DEFAULT_RETRIES = {
scheduler_failure: 2
}.freeze
2018-12-13 13:39:08 +05:30
has_one :deployment, as: :deployable, class_name: 'Deployment'
2020-03-13 15:44:24 +05:30
has_one :resource, class_name: 'Ci::Resource', inverse_of: :build
2018-03-17 18:26:18 +05:30
has_many :trace_sections, class_name: 'Ci::BuildTraceSection'
2018-10-15 14:42:47 +05:30
has_many :trace_chunks, class_name: 'Ci::BuildTraceChunk', foreign_key: :build_id
2018-03-17 18:26:18 +05:30
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
2019-10-12 21:52:04 +05:30
has_many :job_variables, class_name: 'Ci::JobVariable', foreign_key: :job_id
2019-12-21 20:55:43 +05:30
has_many :sourced_pipelines, class_name: 'Ci::Sources::Pipeline', foreign_key: :source_job_id
2018-11-18 11:00:15 +05:30
Ci::JobArtifact.file_types.each do |key, value|
has_one :"job_artifacts_#{key}", -> { where(file_type: value) }, class_name: 'Ci::JobArtifact', inverse_of: :job, foreign_key: :job_id
end
2017-08-17 22:00:37 +05:30
2018-11-08 19:23:39 +05:30
has_one :runner_session, class_name: 'Ci::BuildRunnerSession', validate: true, inverse_of: :build
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
2018-10-15 14:42:47 +05:30
delegate :gitlab_deploy_token, to: :project
2018-12-05 23:21:45 +05:30
delegate :trigger_short_token, to: :trigger_request, allow_nil: true
2018-05-09 12:01:36 +05:30
##
2019-03-02 22:35:43 +05:30
# Since Gitlab 11.5, deployments records started being created right after
# `ci_builds` creation. We can look up a relevant `environment` through
2020-04-08 14:13:33 +05:30
# `deployment` relation today.
2019-12-04 20:38:33 +05:30
# (See more https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/22380)
2018-05-09 12:01:36 +05:30
#
2020-04-08 14:13:33 +05:30
# Since Gitlab 12.9, we started persisting the expanded environment name to
# avoid repeated variables expansion in `action: stop` builds as well.
2017-08-17 22:00:37 +05:30
def persisted_environment
2018-05-09 12:01:36 +05:30
return unless has_environment?
strong_memoize(:persisted_environment) do
2019-03-02 22:35:43 +05:30
deployment&.environment ||
Environment.find_by(name: expanded_environment_name, project: project)
2018-05-09 12:01:36 +05:30
end
2017-08-17 22:00:37 +05:30
end
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
joins(:metadata).where('ci_builds_metadata.id NOT IN (?)',
Ci::BuildMetadata.scoped_build.with_interruptible.select(:id))
end
2015-09-25 12:07:36 +05:30
scope :unstarted, ->() { where(runner_id: nil) }
2015-10-24 18:46:33 +05:30
scope :ignore_failures, ->() { where(allow_failure: false) }
2018-03-27 19:54:05 +05:30
scope :with_artifacts_archive, ->() do
2019-09-04 21:01:54 +05:30
where('EXISTS (?)', Ci::JobArtifact.select(1).where('ci_builds.id = ci_job_artifacts.job_id').archive)
2018-03-17 18:26:18 +05:30
end
2018-11-08 19:23:39 +05:30
2018-12-05 23:21:45 +05:30
scope :with_existing_job_artifacts, ->(query) do
where('EXISTS (?)', ::Ci::JobArtifact.select(1).where('ci_builds.id = ci_job_artifacts.job_id').merge(query))
end
2018-11-20 20:47:30 +05:30
scope :with_archived_trace, ->() do
2018-12-05 23:21:45 +05:30
with_existing_job_artifacts(Ci::JobArtifact.trace)
2018-11-20 20:47:30 +05:30
end
2018-11-08 19:23:39 +05:30
scope :without_archived_trace, ->() do
where('NOT EXISTS (?)', Ci::JobArtifact.select(1).where('ci_builds.id = ci_job_artifacts.job_id').trace)
end
2019-07-07 11:18:12 +05:30
scope :with_reports, ->(reports_scope) do
with_existing_job_artifacts(reports_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) }
2020-03-13 15:44:24 +05:30
scope :eager_load_job_artifacts_archive, -> { includes(:job_artifacts_archive) }
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
2018-03-27 19:54:05 +05:30
scope :with_artifacts_not_expired, ->() { with_artifacts_archive.where('artifacts_expire_at IS NULL OR artifacts_expire_at > ?', Time.now) }
scope :with_expired_artifacts, ->() { with_artifacts_archive.where('artifacts_expire_at < ?', Time.now) }
2016-08-24 12:49:21 +05:30
scope :last_month, ->() { where('created_at > ?', Date.today - 1.month) }
2018-12-05 23:21:45 +05:30
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) }
2018-11-08 19:23:39 +05:30
scope :with_live_trace, -> { where('EXISTS (?)', Ci::BuildTraceChunk.where('ci_builds.id = ci_build_trace_chunks.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) }
2018-03-17 18:26:18 +05:30
2019-12-21 20:55:43 +05:30
scope :with_secure_reports_from_options, -> (job_type) { where('options like :job_type', job_type: "%:artifacts:%:reports:%:#{job_type}:%") }
scope :with_secure_reports_from_config_options, -> (job_types) do
joins(:metadata).where("ci_builds_metadata.config_options -> 'artifacts' -> 'reports' ?| array[:job_types]", job_types: job_types)
end
2018-03-17 18:26:18 +05:30
scope :matches_tag_ids, -> (tag_ids) do
matcher = ::ActsAsTaggableOn::Tagging
2019-02-15 15:39:39 +05:30
.where(taggable_type: CommitStatus.name)
2018-03-17 18:26:18 +05:30
.where(context: 'tags')
.where('taggable_id = ci_builds.id')
.where.not(tag_id: tag_ids).select('1')
where("NOT EXISTS (?)", matcher)
end
scope :with_any_tags, -> do
matcher = ::ActsAsTaggableOn::Tagging
2019-02-15 15:39:39 +05:30
.where(taggable_type: CommitStatus.name)
2018-03-17 18:26:18 +05:30
.where(context: 'tags')
.where('taggable_id = ci_builds.id').select('1')
where("EXISTS (?)", matcher)
end
2015-09-25 12:07:36 +05:30
2019-09-04 21:01:54 +05:30
scope :queued_before, ->(time) { where(arel_table[:queued_at].lt(time)) }
2020-01-01 13:55:28 +05:30
scope :order_id_desc, -> { order('ci_builds.id DESC') }
2015-11-26 14:37:03 +05:30
2020-04-08 14:13:33 +05:30
scope :preload_project_and_pipeline_project, -> do
preload(Ci::Pipeline::PROJECT_ROUTE_AND_NAMESPACE_ROUTE,
pipeline: Ci::Pipeline::PROJECT_ROUTE_AND_NAMESPACE_ROUTE)
end
2020-03-13 15:44:24 +05:30
2020-04-22 19:07:51 +05:30
scope :with_coverage, -> { where.not(coverage: nil) }
2015-09-25 12:07:36 +05:30
acts_as_taggable
2019-07-07 11:18:12 +05:30
add_authentication_token_field :token, encrypted: :optional
2016-09-29 09:46:39 +05:30
before_save :ensure_token
2017-08-17 22:00:37 +05:30
before_destroy { unscoped_project }
2018-03-17 18:26:18 +05:30
after_create unless: :importing? do |build|
run_after_commit { BuildHooksWorker.perform_async(build.id) }
end
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
2015-09-25 12:07:36 +05:30
def first_pending
pending.unstarted.order('created_at ASC').first
end
2017-08-17 22:00:37 +05:30
def retry(build, current_user)
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ServiceClass
2017-08-17 22:00:37 +05:30
Ci::RetryBuildService
.new(build.project, current_user)
.execute(build)
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ServiceClass
2015-09-25 12:07:36 +05:30
end
end
2016-09-13 17:45:13 +05:30
state_machine :status do
2019-07-07 11:18:12 +05:30
event :enqueue do
2020-03-13 15:44:24 +05:30
transition [:created, :skipped, :manual, :scheduled] => :waiting_for_resource, if: :requires_resource?
2019-07-07 11:18:12 +05:30
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: :waiting_for_resource, if: :requires_resource?
transition scheduled: :preparing, if: :any_unmet_prerequisites?
transition scheduled: :pending
end
event :enqueue_waiting_for_resource do
transition waiting_for_resource: :preparing, if: :any_unmet_prerequisites?
transition waiting_for_resource: :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 any => :waiting_for_resource do |build|
build.waiting_for_resource_at = Time.now
end
before_transition on: :enqueue_waiting_for_resource do |build|
next unless build.requires_resource?
build.resource_group.assign_resource_to(build) # If false is returned, it stops the transition
end
after_transition any => :waiting_for_resource do |build|
build.run_after_commit do
Ci::ResourceGroups::AssignResourceFromResourceGroupWorker
.perform_async(build.resource_group_id)
end
end
before_transition on: :enqueue_preparing do |build|
!build.any_unmet_prerequisites? # If false is returned, it stops the transition
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
2017-08-17 22:00:37 +05:30
after_transition any => [:pending] do |build|
build.run_after_commit do
BuildQueueWorker.perform_async(id)
end
end
2016-04-02 18:10:28 +05:30
after_transition pending: :running do |build|
2018-12-13 13:39:08 +05:30
build.deployment&.run
2016-11-03 12:29:30 +05:30
build.run_after_commit do
2020-01-01 13:55:28 +05:30
build.pipeline.persistent_ref.create
2016-11-03 12:29:30 +05:30
BuildHooksWorker.perform_async(id)
end
2015-12-23 02:04:40 +05:30
end
2015-09-25 12:07:36 +05:30
2020-03-13 15:44:24 +05:30
after_transition any => ::Ci::Build.completed_statuses do |build|
next unless build.resource_group_id.present?
next unless build.resource_group.release_resource_from(build)
build.run_after_commit do
Ci::ResourceGroups::AssignResourceFromResourceGroupWorker
.perform_async(build.resource_group_id)
end
end
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
BuildFinishedWorker.perform_async(id)
end
2015-09-25 12:07:36 +05:30
end
after_transition any => [:success] do |build|
2018-12-13 13:39:08 +05:30
build.deployment&.succeed
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
before_transition any => [:failed] do |build|
2018-03-17 18:26:18 +05:30
next unless build.project
2019-02-15 15:39:39 +05:30
next unless build.deployment
begin
build.deployment.drop!
rescue => e
2020-01-01 13:55:28 +05:30
Gitlab::ErrorTracking.track_and_raise_for_dev_exception(e, build_id: build.id)
2019-02-15 15:39:39 +05:30
end
2017-09-10 17:25:29 +05:30
2019-02-15 15:39:39 +05:30
true
end
after_transition any => [:failed] do |build|
next unless build.project
2018-12-13 13:39:08 +05:30
if build.retry_failure?
2018-04-04 21:44:52 +05:30
begin
Ci::Build.retry(build, build.user)
rescue Gitlab::Access::AccessDeniedError => ex
2019-09-30 21:07:59 +05:30
Rails.logger.error "Unable to auto-retry job #{build.id}: #{ex}" # rubocop:disable Gitlab/RailsLogger
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
2018-05-09 12:01:36 +05:30
after_transition pending: :running do |build|
build.ensure_metadata.update_timeout_state
end
2018-11-08 19:23:39 +05:30
after_transition running: any do |build|
Ci::BuildRunnerSession.where(build: build).delete_all
end
2018-12-13 13:39:08 +05:30
after_transition any => [:skipped, :canceled] do |build|
build.deployment&.cancel
end
2018-05-09 12:01:36 +05:30
end
2017-08-17 22:00:37 +05:30
def detailed_status(current_user)
Gitlab::Ci::Status::Build::Factory
.new(self, current_user)
.fabricate!
2016-08-24 12:49:21 +05:30
end
2018-12-13 13:39:08 +05:30
def other_manual_actions
2016-08-24 12:49:21 +05:30
pipeline.manual_actions.where.not(name: name)
end
2018-12-13 13:39:08 +05:30
def other_scheduled_actions
pipeline.scheduled_actions.where.not(name: name)
end
2018-11-08 19:23:39 +05:30
def pages_generator?
Gitlab.config.pages.enabled &&
self.name == 'pages'
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?
2018-12-13 13:39:08 +05:30
action? && !archived? && (manual? || scheduled? || retryable?)
2018-12-05 23:21:45 +05:30
end
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
2015-11-26 14:37:03 +05:30
def retryable?
2018-12-13 13:39:08 +05:30
!archived? && (success? || failed? || canceled?)
2017-08-17 22:00:37 +05:30
end
2017-09-10 17:25:29 +05:30
def retries_count
pipeline.builds.retried.where(name: self.name).count
end
2019-12-26 22:10:19 +05:30
def retry_failure?
max_allowed_retries = nil
max_allowed_retries ||= options_retry_max if retry_on_reason_or_always?
max_allowed_retries ||= DEFAULT_RETRIES.fetch(failure_reason.to_sym, 0)
max_allowed_retries > 0 && retries_count < max_allowed_retries
2018-12-13 13:39:08 +05:30
end
2019-12-26 22:10:19 +05:30
def options_retry_max
options_retry[:max]
2018-12-13 13:39:08 +05:30
end
2019-12-26 22:10:19 +05:30
def options_retry_when
options_retry.fetch(:when, ['always'])
end
2018-12-13 13:39:08 +05:30
2019-12-26 22:10:19 +05:30
def retry_on_reason_or_always?
options_retry_when.include?(failure_reason.to_s) ||
options_retry_when.include?('always')
2017-09-10 17:25:29 +05:30
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
2017-08-17 22:00:37 +05:30
def expanded_environment_name
2018-05-09 12:01:36 +05:30
return unless has_environment?
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.
if Feature.enabled?(:ci_persisted_expanded_environment_name, project, default_enabled: true) &&
metadata&.expanded_environment_name.present?
metadata.expanded_environment_name
else
ExpandVariables.expand(environment, -> { simple_variables })
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
return unless has_environment?
namespace = options.dig(:environment, :kubernetes, :namespace)
if namespace.present?
strong_memoize(:expanded_kubernetes_namespace) do
ExpandVariables.expand(namespace, -> { simple_variables })
end
end
end
2020-03-13 15:44:24 +05:30
def requires_resource?
Feature.enabled?(:ci_resource_group, project, default_enabled: true) &&
self.resource_group_id.present?
end
2017-08-17 22:00:37 +05:30
def has_environment?
environment.present?
end
def starts_environment?
has_environment? && self.environment_action == 'start'
end
def stops_environment?
has_environment? && self.environment_action == 'stop'
end
def environment_action
self.options.fetch(:environment, {}).fetch(:action, 'start') if self.options
end
def outdated_deployment?
2018-12-13 13:39:08 +05:30
success? && !deployment.try(:last?)
2015-11-26 14:37:03 +05:30
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
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)
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)
2020-04-08 14:13:33 +05:30
.concat(environment_changed_page_variables)
2019-07-07 11:18:12 +05:30
.concat(persisted_environment_variables)
.to_runner_variables
end
2017-08-17 22:00:37 +05:30
end
2019-12-04 20:38:33 +05:30
CI_REGISTRY_USER = 'gitlab-ci-token'
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)
.append(key: 'CI_BUILD_ID', value: id.to_s)
.append(key: 'CI_BUILD_TOKEN', value: token.to_s, public: false, masked: true)
.append(key: 'CI_REGISTRY_USER', value: CI_REGISTRY_USER)
.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)
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)
# 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
2020-04-08 14:13:33 +05:30
def environment_changed_page_variables
Gitlab::Ci::Variables::Collection.new.tap do |variables|
break variables unless environment_status
variables.append(key: 'CI_MERGE_REQUEST_CHANGED_PAGE_PATHS', value: environment_status.changed_paths.join(','))
variables.append(key: 'CI_MERGE_REQUEST_CHANGED_PAGE_URLS', value: environment_status.changed_urls.join(','))
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
2018-03-17 18:26:18 +05:30
def features
{ trace_sections: true }
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
auth = "gitlab-ci-token:#{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
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ServiceClass
2018-03-17 18:26:18 +05:30
def parse_trace_sections!
ExtractSectionsFromBuildTraceService.new(project, user).execute(self)
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ServiceClass
2018-03-17 18:26:18 +05:30
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?
trace.live_trace_exist?
end
def has_archived_trace?
trace.archived_trace_exist?
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
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
2018-11-08 19:23:39 +05:30
def has_old_trace?
old_trace.present?
end
2017-08-17 22:00:37 +05:30
def trace=(data)
raise NotImplementedError
2015-09-25 12:07:36 +05:30
end
2017-08-17 22:00:37 +05:30
def old_trace
read_attribute(:trace)
2015-09-25 12:07:36 +05:30
end
2017-08-17 22:00:37 +05:30
def erase_old_trace!
2018-11-08 19:23:39 +05:30
return unless has_old_trace?
2018-04-04 21:44:52 +05:30
update_column(:trace, nil)
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?
Time.now - updated_at > 15.minutes.to_i
end
def valid_token?(token)
2019-09-30 21:07:59 +05:30
self.token && ActiveSupport::SecurityUtils.secure_compare(token, self.token)
2015-11-26 14:37:03 +05:30
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?
2016-06-22 15:30:34 +05:30
project.any_runners? { |runner| runner.active? && runner.online? && runner.can_pick?(self) }
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
2018-03-17 18:26:18 +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)
project.execute_services(build_data.dup, :job_hooks) if project.has_active_services?(: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
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
2018-12-05 23:21:45 +05:30
# and use that for `ExpireBuildInstanceArtifactsWorker`?
def erase_erasable_artifacts!
job_artifacts.erasable.destroy_all # rubocop: disable DestroyAll
2018-11-18 11:00:15 +05:30
end
2016-04-02 18:10:28 +05:30
def erase(opts = {})
return false unless erasable?
2018-12-05 23:21:45 +05:30
job_artifacts.destroy_all # rubocop: disable DestroyAll
2016-04-02 18:10:28 +05:30
erase_trace!
update_erased!(opts[:erased_by])
end
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?
!self.erased_at.nil?
end
def artifacts_expired?
artifacts_expire_at && artifacts_expire_at < Time.now
end
def artifacts_expire_in
artifacts_expire_at - Time.now 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
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
def keep_artifacts!
self.update(artifacts_expire_at: nil)
2018-03-17 18:26:18 +05:30
self.job_artifacts.update_all(expire_at: nil)
end
2018-12-05 23:21:45 +05:30
def artifacts_file_for_type(type)
2019-09-04 21:01:54 +05:30
job_artifacts.find_by(file_type: Ci::JobArtifact.file_types[type])&.file
2018-12-05 23:21:45 +05:30
end
2017-08-17 22:00:37 +05:30
def coverage_regex
super || project.try(:build_coverage_regex)
end
def steps
[Gitlab::Ci::Build::Step.from_commands(self),
Gitlab::Ci::Build::Step.from_after_script(self)].compact
end
def image
Gitlab::Ci::Build::Image.from_image(self)
end
def services
Gitlab::Ci::Build::Image.from_services(self)
end
def cache
2018-03-17 18:26:18 +05:30
cache = options[:cache]
if cache && project.jobs_cache_index
cache = cache.merge(
key: "#{cache[:key]}-#{project.jobs_cache_index}")
end
[cache]
2017-08-17 22:00:37 +05:30
end
def credentials
Gitlab::Ci::Build::Credentials::Factory.new(self).create!
end
2020-01-01 13:55:28 +05:30
def all_dependencies
2020-04-22 19:07:51 +05:30
dependencies.all
2017-08-17 22:00:37 +05:30
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?
return false if artifacts_expired?
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
2017-08-17 22:00:37 +05:30
def hide_secrets(trace)
return unless trace
trace = trace.dup
2018-03-17 18:26:18 +05:30
Gitlab::Ci::MaskSecret.mask!(trace, project.runners_token) if project
2019-02-15 15:39:39 +05:30
Gitlab::Ci::MaskSecret.mask!(trace, token) if token
2017-08-17 22:00:37 +05:30
trace
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)
test_reports.get_suite(group_name).tap do |test_suite|
2018-12-05 23:21:45 +05:30
each_report(Ci::JobArtifact::TEST_REPORT_FILE_TYPES) do |file_type, blob|
2020-04-22 19:07:51 +05:30
Gitlab::Ci::Parsers.fabricate!(file_type).parse!(blob, test_suite, job: self)
2018-11-18 11:00:15 +05:30
end
end
end
2020-04-08 14:13:33 +05:30
def collect_coverage_reports!(coverage_report)
each_report(Ci::JobArtifact::COVERAGE_REPORT_FILE_TYPES) do |file_type, blob|
Gitlab::Ci::Parsers.fabricate!(file_type).parse!(blob, coverage_report)
end
coverage_report
end
2019-09-04 21:01:54 +05:30
def report_artifacts
job_artifacts.with_reports
end
2018-12-05 23:21:45 +05:30
# Virtual deployment status depending on the environment status.
def deployment_status
2019-07-07 11:18:12 +05:30
return unless starts_environment?
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!
update_columns(
status: :failed,
failure_reason: :data_integrity_failure)
end
2016-08-24 12:49:21 +05:30
private
2016-06-02 11:05:42 +05:30
2020-04-22 19:07:51 +05:30
def dependencies
strong_memoize(:dependencies) do
Ci::BuildDependencies.new(self)
end
end
2020-01-01 13:55:28 +05:30
def build_data
@build_data ||= Gitlab::DataBuilder::Build.build(self)
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 each_report(report_types)
job_artifacts_for_types(report_types).each do |report_artifact|
report_artifact.each_blob do |blob|
2020-01-01 13:55:28 +05:30
yield report_artifact.file_type, blob, report_artifact
2018-11-18 11:00:15 +05:30
end
end
end
2018-12-05 23:21:45 +05:30
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
2016-08-24 12:49:21 +05:30
def erase_trace!
2017-08-17 22:00:37 +05:30
trace.erase!
2015-09-25 12:07:36 +05:30
end
2016-08-24 12:49:21 +05:30
def update_erased!(user = nil)
self.update(erased_by: user, erased_at: Time.now, artifacts_expire_at: nil)
2015-09-25 12:07:36 +05:30
end
2015-10-24 18:46:33 +05:30
2017-08-17 22:00:37 +05:30
def unscoped_project
@unscoped_project ||= Project.unscoped.find_by(id: project_id)
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
if has_environment? && merge_request
EnvironmentStatus.new(project, persisted_environment, merge_request, pipeline.sha)
end
end
end
2018-12-13 13:39:08 +05:30
# The format of the retry option changed in GitLab 11.5: Before it was
# integer only, after it is a hash. New builds are created with the new
# format, but builds created before GitLab 11.5 and saved in database still
# have the old integer only format. This method returns the retry option
# normalized as a hash in 11.5+ format.
2019-12-26 22:10:19 +05:30
def options_retry
strong_memoize(:options_retry) do
2019-02-15 15:39:39 +05:30
value = options&.dig(:retry)
value = value.is_a?(Integer) ? { max: value } : value.to_h
value.with_indifferent_access
end
2018-12-13 13:39:08 +05:30
end
2020-03-13 15:44:24 +05:30
def has_expiring_artifacts?
artifacts_expire_at.present? && artifacts_expire_at > Time.now
end
2020-04-22 19:07:51 +05:30
def job_jwt_variables
Gitlab::Ci::Variables::Collection.new.tap do |variables|
break variables unless Feature.enabled?(:ci_job_jwt, project, default_enabled: true)
jwt = Gitlab::Ci::Jwt.for_build(self)
variables.append(key: 'CI_JOB_JWT', value: jwt, public: false, masked: true)
end
end
2015-09-25 12:07:36 +05:30
end
end
2019-12-04 20:38:33 +05:30
Ci::Build.prepend_if_ee('EE::Ci::Build')