gitlab-org--gitlab-foss/app/models/ci/build.rb

523 lines
14 KiB
Ruby
Raw Normal View History

2015-08-25 21:42:46 -04:00
module Ci
2015-10-06 06:01:16 -04:00
class Build < CommitStatus
include TokenAuthenticatable
include AfterCommitQueue
include Presentable
belongs_to :runner
belongs_to :trigger_request
belongs_to :erased_by, class_name: 'User'
2015-08-25 21:42:46 -04:00
has_many :deployments, as: :deployable
has_one :last_deployment, -> { order('deployments.id DESC') }, as: :deployable, class_name: 'Deployment'
# The "environment" field for builds is a String, and is the unexpanded name
def persisted_environment
@persisted_environment ||= Environment.find_by(
name: expanded_environment_name,
2017-03-17 19:06:11 -04:00
project: project
)
end
serialize :options # rubocop:disable Cop/ActiverecordSerialize
serialize :yaml_variables, Gitlab::Serializer::Ci::Variables # rubocop:disable Cop/ActiverecordSerialize
2015-08-25 21:42:46 -04:00
2017-02-22 17:35:08 -05:00
delegate :name, to: :project, prefix: true
2015-08-25 21:42:46 -04:00
validates :coverage, numericality: true, allow_blank: true
2017-02-21 19:40:04 -05:00
validates :ref, presence: true
2015-08-25 21:42:46 -04:00
scope :unstarted, ->() { where(runner_id: nil) }
2015-10-02 07:46:38 -04:00
scope :ignore_failures, ->() { where(allow_failure: false) }
2016-07-20 11:42:07 -04:00
scope :with_artifacts, ->() { where.not(artifacts_file: [nil, '']) }
scope :with_artifacts_not_expired, ->() { with_artifacts.where('artifacts_expire_at IS NULL OR artifacts_expire_at > ?', Time.now) }
2016-06-08 11:18:54 -04:00
scope :with_expired_artifacts, ->() { with_artifacts.where('artifacts_expire_at < ?', Time.now) }
2016-07-07 06:56:02 -04:00
scope :last_month, ->() { where('created_at > ?', Date.today - 1.month) }
scope :manual_actions, ->() { where(when: :manual, status: COMPLETED_STATUSES + [:manual]) }
2015-08-25 21:42:46 -04:00
mount_uploader :artifacts_file, ArtifactUploader
mount_uploader :artifacts_metadata, ArtifactUploader
2015-08-25 21:42:46 -04:00
acts_as_taggable
add_authentication_token_field :token
before_save :update_artifacts_size, if: :artifacts_file_changed?
before_save :ensure_token
before_destroy { unscoped_project }
2016-03-31 13:51:28 -04:00
after_create :execute_hooks
after_commit :update_project_statistics_after_save, on: [:create, :update]
after_commit :update_project_statistics, on: :destroy
2015-08-25 21:42:46 -04:00
class << self
# This is needed for url_for to work,
# as the controller is JobsController
def model_name
ActiveModel::Name.new(self, nil, 'job')
end
2015-08-25 21:42:46 -04:00
def first_pending
pending.unstarted.order('created_at ASC').first
end
def retry(build, current_user)
Ci::RetryBuildService
.new(build.project, current_user)
.execute(build)
2015-08-25 21:42:46 -04:00
end
end
state_machine :status do
event :actionize do
transition created: :manual
2017-02-28 10:48:39 -05:00
end
after_transition any => [:pending] do |build|
build.run_after_commit do
2016-12-15 16:29:47 -05:00
BuildQueueWorker.perform_async(id)
end
end
after_transition pending: :running do |build|
build.run_after_commit do
BuildHooksWorker.perform_async(id)
end
end
after_transition any => [:success, :failed, :canceled] do |build|
build.run_after_commit do
BuildFinishedWorker.perform_async(id)
end
2015-08-25 21:42:46 -04:00
end
2016-06-10 17:36:54 -04:00
after_transition any => [:success] do |build|
build.run_after_commit do
BuildSuccessWorker.perform_async(id)
2016-06-10 17:36:54 -04:00
end
end
2015-08-25 21:42:46 -04:00
end
def detailed_status(current_user)
Gitlab::Ci::Status::Build::Factory
.new(self, current_user)
.fabricate!
2016-12-08 03:51:36 -05:00
end
def other_actions
pipeline.manual_actions.where.not(name: name)
end
2016-07-16 12:39:58 -04:00
def playable?
action? && (manual? || complete?)
2017-02-28 10:48:39 -05:00
end
def action?
self.when == 'manual'
end
def play(current_user)
Ci::PlayBuildService
.new(project, current_user)
.execute(self)
2016-07-16 12:39:58 -04:00
end
2016-12-08 04:40:56 -05:00
def cancelable?
active?
end
def retryable?
2017-04-06 08:31:38 -04:00
success? || failed? || canceled?
end
def latest?
!retried?
2016-03-31 13:51:28 -04:00
end
def expanded_environment_name
ExpandVariables.expand(environment, simple_variables) if environment
end
2016-11-17 06:08:28 -05:00
def has_environment?
environment.present?
2016-11-17 06:08:28 -05:00
end
def starts_environment?
2016-11-17 06:08:28 -05:00
has_environment? && self.environment_action == 'start'
end
def stops_environment?
2016-11-17 06:08:28 -05:00
has_environment? && self.environment_action == 'stop'
end
def environment_action
self.options.fetch(:environment, {}).fetch(:action, 'start') if self.options
end
def outdated_deployment?
success? && !last_deployment.try(:last?)
end
def depends_on_builds
# Get builds of the same type
latest_builds = self.pipeline.builds.latest
# Return builds from previous stages
latest_builds.where('stage_idx < ?', stage_idx)
end
2015-08-25 21:42:46 -04:00
def timeout
2015-12-04 06:55:23 -05:00
project.build_timeout
2015-08-25 21:42:46 -04:00
end
2016-12-13 14:21:30 -05:00
# A slugified version of the build ref, suitable for inclusion in URLs and
# domain names. Rules:
#
# * Lowercased
# * Anything not matching [a-z0-9-] is replaced with a -
# * Maximum length is 63 bytes
def ref_slug
slugified = ref.to_s.downcase
slugified.gsub(/[^a-z0-9]/, '-')[0..62]
end
# Variables whose value does not depend on environment
def simple_variables
2016-07-20 07:17:21 -04:00
variables = predefined_variables
variables += project.predefined_variables
variables += pipeline.predefined_variables
variables += runner.predefined_variables if runner
variables += project.container_registry_variables
variables += project.deployment_variables if has_environment?
variables += yaml_variables
variables += user_variables
variables += project.secret_variables_for(ref).map(&:to_runner_variable)
variables += trigger_request.user_variables if trigger_request
variables
2015-08-25 21:42:46 -04:00
end
# All variables, including those dependent on environment, which could
# contain unexpanded variables.
def variables
simple_variables.concat(persisted_environment_variables)
end
def merge_request
return @merge_request if defined?(@merge_request)
2017-05-29 03:58:20 -04:00
@merge_request ||=
begin
merge_requests = MergeRequest.includes(:merge_request_diff)
.where(source_branch: ref,
source_project: pipeline.project)
2017-05-29 03:58:20 -04:00
.reorder(iid: :desc)
merge_requests.find do |merge_request|
merge_request.commits_sha.include?(pipeline.sha)
end
end
end
2015-08-25 21:42:46 -04:00
def repo_url
2016-09-16 06:46:33 -04:00
auth = "gitlab-ci-token:#{ensure_token!}@"
2015-12-04 06:55:23 -05:00
project.http_url_to_repo.sub(/^https?:\/\//) do |prefix|
prefix + auth
end
2015-08-25 21:42:46 -04:00
end
def allow_git_fetch
2015-12-04 06:55:23 -05:00
project.build_allow_git_fetch
2015-08-25 21:42:46 -04:00
end
def update_coverage
coverage = trace.extract_coverage(coverage_regex)
update_attributes(coverage: coverage) if coverage.present?
2015-08-25 21:42:46 -04:00
end
def trace
Gitlab::Ci::Trace.new(self)
end
def has_trace?
trace.exist?
2016-08-25 07:53:20 -04:00
end
def trace=(data)
raise NotImplementedError
2016-03-31 07:24:14 -04:00
end
def old_trace
read_attribute(:trace)
2016-03-29 09:34:18 -04:00
end
def erase_old_trace!
write_attribute(:trace, nil)
save
2015-08-25 21:42:46 -04:00
end
def needs_touch?
Time.now - updated_at > 15.minutes.to_i
end
2016-05-18 18:43:00 -04:00
def valid_token?(token)
self.token && ActiveSupport::SecurityUtils.variable_size_secure_compare(token, self.token)
end
def has_tags?
tag_list.any?
end
def any_runners_online?
project.any_runners? { |runner| runner.active? && runner.online? && runner.can_pick?(self) }
end
def stuck?
pending? && !any_runners_online?
end
def execute_hooks
return unless project
build_data = Gitlab::DataBuilder::Build.build(self)
project.execute_hooks(build_data.dup, :job_hooks)
project.execute_services(build_data.dup, :job_hooks)
PagesService.new(build_data).execute
2016-06-01 10:50:32 -04:00
project.running_or_pending_build_count(force: true)
end
def artifacts?
!artifacts_expired? && artifacts_file.exists?
end
def artifacts_metadata?
artifacts? && artifacts_metadata.exists?
end
def artifacts_metadata_entry(path, **options)
metadata = Gitlab::Ci::Build::Artifacts::Metadata.new(
artifacts_metadata.path,
path,
**options)
metadata.to_entry
end
2016-05-18 16:21:51 -04:00
def erase_artifacts!
remove_artifacts_file!
remove_artifacts_metadata!
save
2016-05-18 16:21:51 -04:00
end
def erase(opts = {})
return false unless erasable?
2016-05-18 16:21:51 -04:00
erase_artifacts!
erase_trace!
update_erased!(opts[:erased_by])
end
def erasable?
complete? && (artifacts? || has_trace?)
end
def erased?
!self.erased_at.nil?
end
2016-05-18 16:21:51 -04:00
def artifacts_expired?
artifacts_expire_at && artifacts_expire_at < Time.now
2016-05-18 16:21:51 -04:00
end
def artifacts_expire_in
artifacts_expire_at - Time.now if artifacts_expire_at
end
def artifacts_expire_in=(value)
2016-06-10 15:45:06 -04:00
self.artifacts_expire_at =
if value
ChronicDuration.parse(value)&.seconds&.from_now
2016-06-10 15:45:06 -04:00
end
end
def has_expiring_artifacts?
2017-05-29 03:58:20 -04:00
artifacts_expire_at.present? && artifacts_expire_at > Time.now
end
2016-06-08 11:18:54 -04:00
def keep_artifacts!
2016-05-18 16:21:51 -04:00
self.update(artifacts_expire_at: nil)
end
def coverage_regex
super || project.try(:build_coverage_regex)
end
def when
read_attribute(:when) || build_attributes_from_config[:when] || 'on_success'
end
def yaml_variables
read_attribute(:yaml_variables) || build_attributes_from_config[:yaml_variables] || []
end
def user_variables
return [] if user.blank?
[
{ key: 'GITLAB_USER_ID', value: user.id.to_s, public: true },
{ key: 'GITLAB_USER_EMAIL', value: user.email, public: true }
]
end
2017-02-15 19:05:44 -05:00
def steps
2017-03-07 06:30:34 -05:00
[Gitlab::Ci::Build::Step.from_commands(self),
Gitlab::Ci::Build::Step.from_after_script(self)].compact
2017-02-15 19:05:44 -05:00
end
def image
Gitlab::Ci::Build::Image.from_image(self)
2017-02-15 19:05:44 -05:00
end
def services
Gitlab::Ci::Build::Image.from_services(self)
2017-02-15 19:05:44 -05:00
end
def artifacts
[options[:artifacts]]
2017-02-15 19:05:44 -05:00
end
def cache
[options[:cache]]
2017-02-15 19:05:44 -05:00
end
2016-11-20 14:43:50 -05:00
def credentials
Gitlab::Ci::Build::Credentials::Factory.new(self).create!
2016-11-20 14:43:50 -05:00
end
def dependencies
return [] if empty_dependencies?
depended_jobs = depends_on_builds
2017-03-18 19:35:17 -04:00
return depended_jobs unless options[:dependencies].present?
2017-03-18 19:35:17 -04:00
depended_jobs.select do |job|
options[:dependencies].include?(job.name)
end
end
def empty_dependencies?
options[:dependencies]&.empty?
end
def hide_secrets(trace)
return unless trace
trace = trace.dup
Ci::MaskSecret.mask!(trace, project.runners_token) if project
Ci::MaskSecret.mask!(trace, token)
trace
end
private
def update_artifacts_size
self.artifacts_size = if artifacts_file.exists?
artifacts_file.size
else
nil
end
end
def erase_trace!
trace.erase!
end
def update_erased!(user = nil)
2016-06-08 11:18:54 -04:00
self.update(erased_by: user, erased_at: Time.now, artifacts_expire_at: nil)
end
def unscoped_project
2017-03-17 19:06:11 -04:00
@unscoped_project ||= Project.unscoped.find_by(id: project_id)
end
CI_REGISTRY_USER = 'gitlab-ci-token'.freeze
def predefined_variables
2016-07-20 07:17:21 -04:00
variables = [
{ key: 'CI', value: 'true', public: true },
{ key: 'GITLAB_CI', value: 'true', public: true },
{ key: 'CI_SERVER_NAME', value: 'GitLab', public: true },
{ key: 'CI_SERVER_VERSION', value: Gitlab::VERSION, public: true },
{ key: 'CI_SERVER_REVISION', value: Gitlab::REVISION, public: true },
{ key: 'CI_JOB_ID', value: id.to_s, public: true },
{ key: 'CI_JOB_NAME', value: name, public: true },
{ key: 'CI_JOB_STAGE', value: stage, public: true },
{ key: 'CI_JOB_TOKEN', value: token, public: false },
2017-03-07 11:37:05 -05:00
{ key: 'CI_COMMIT_SHA', value: sha, public: true },
{ key: 'CI_COMMIT_REF_NAME', value: ref, public: true },
{ key: 'CI_COMMIT_REF_SLUG', value: ref_slug, public: true },
{ key: 'CI_REGISTRY_USER', value: CI_REGISTRY_USER, public: true },
{ key: 'CI_REGISTRY_PASSWORD', value: token, public: false },
{ key: 'CI_REPOSITORY_URL', value: repo_url, public: false }
]
variables << { key: "CI_COMMIT_TAG", value: ref, public: true } if tag?
variables << { key: "CI_PIPELINE_TRIGGERED", value: 'true', public: true } if trigger_request
variables << { key: "CI_JOB_MANUAL", value: 'true', public: true } if action?
variables.concat(legacy_variables)
end
def persisted_environment_variables
return [] unless persisted_environment
2017-05-25 10:14:22 -04:00
variables = 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 << { key: 'CI_ENVIRONMENT_URL', value: environment_url, public: true } if environment_url
2017-05-25 10:14:22 -04:00
variables
end
def legacy_variables
variables = [
2016-07-20 07:17:21 -04:00
{ key: 'CI_BUILD_ID', value: id.to_s, public: true },
{ key: 'CI_BUILD_TOKEN', value: token, public: false },
{ key: 'CI_BUILD_REF', value: sha, public: true },
{ key: 'CI_BUILD_BEFORE_SHA', value: before_sha, public: true },
{ key: 'CI_BUILD_REF_NAME', value: ref, public: true },
2016-12-13 14:21:30 -05:00
{ key: 'CI_BUILD_REF_SLUG', value: ref_slug, public: true },
2016-07-20 07:17:21 -04:00
{ key: 'CI_BUILD_NAME', value: name, public: true },
{ key: 'CI_BUILD_STAGE', value: stage, public: true }
2016-07-20 07:17:21 -04:00
]
variables << { key: "CI_BUILD_TAG", value: ref, public: true } if tag?
variables << { key: "CI_BUILD_TRIGGERED", value: 'true', public: true } if trigger_request
variables << { key: "CI_BUILD_MANUAL", value: 'true', public: true } if action?
variables
end
def environment_url
options&.dig(:environment, :url) || persisted_environment&.external_url
end
def build_attributes_from_config
return {} unless pipeline.config_processor
pipeline.config_processor.build_attributes(name)
end
2016-09-19 06:38:03 -04:00
def update_project_statistics
return unless project
ProjectCacheWorker.perform_async(project_id, [], [:build_artifacts_size])
end
def update_project_statistics_after_save
if previous_changes.include?('artifacts_size')
update_project_statistics
end
end
2015-08-25 21:42:46 -04:00
end
end