debian-mirror-gitlab/lib/gitlab/ci/config/entry/job.rb
2018-03-17 18:26:18 +05:30

157 lines
5.2 KiB
Ruby

module Gitlab
module Ci
class Config
module Entry
##
# Entry that represents a concrete CI/CD job.
#
class Job < Node
include Configurable
include Attributable
ALLOWED_KEYS = %i[tags script only except type image services allow_failure
type stage when artifacts cache dependencies before_script
after_script variables environment coverage retry].freeze
validations do
validates :config, allowed_keys: ALLOWED_KEYS
validates :config, presence: true
validates :script, presence: true
validates :name, presence: true
validates :name, type: Symbol
with_options allow_nil: true do
validates :tags, array_of_strings: true
validates :allow_failure, boolean: true
validates :retry, numericality: { only_integer: true,
greater_than_or_equal_to: 0,
less_than_or_equal_to: 2 }
validates :when,
inclusion: { in: %w[on_success on_failure always manual],
message: 'should be on_success, on_failure, ' \
'always or manual' }
validates :dependencies, array_of_strings: true
end
end
entry :before_script, Entry::Script,
description: 'Global before script overridden in this job.'
entry :script, Entry::Commands,
description: 'Commands that will be executed in this job.'
entry :stage, Entry::Stage,
description: 'Pipeline stage this job will be executed into.'
entry :type, Entry::Stage,
description: 'Deprecated: stage this job will be executed into.'
entry :after_script, Entry::Script,
description: 'Commands that will be executed when finishing job.'
entry :cache, Entry::Cache,
description: 'Cache definition for this job.'
entry :image, Entry::Image,
description: 'Image that will be used to execute this job.'
entry :services, Entry::Services,
description: 'Services that will be used to execute this job.'
entry :only, Entry::Policy,
description: 'Refs policy this job will be executed for.'
entry :except, Entry::Policy,
description: 'Refs policy this job will be executed for.'
entry :variables, Entry::Variables,
description: 'Environment variables available for this job.'
entry :artifacts, Entry::Artifacts,
description: 'Artifacts configuration for this job.'
entry :environment, Entry::Environment,
description: 'Environment configuration for this job.'
entry :coverage, Entry::Coverage,
description: 'Coverage configuration for this job.'
helpers :before_script, :script, :stage, :type, :after_script,
:cache, :image, :services, :only, :except, :variables,
:artifacts, :commands, :environment, :coverage, :retry
attributes :script, :tags, :allow_failure, :when, :dependencies, :retry
def compose!(deps = nil)
super do
if type_defined? && !stage_defined?
@entries[:stage] = @entries[:type]
end
@entries.delete(:type)
end
inherit!(deps)
end
def name
@metadata[:name]
end
def value
@config.merge(to_hash.compact)
end
def commands
(before_script_value.to_a + script_value.to_a).join("\n")
end
def manual_action?
self.when == 'manual'
end
def ignored?
allow_failure.nil? ? manual_action? : allow_failure
end
private
def inherit!(deps)
return unless deps
self.class.nodes.each_key do |key|
global_entry = deps[key]
job_entry = self[key]
if global_entry.specified? && !job_entry.specified?
@entries[key] = global_entry
end
end
end
def to_hash
{ name: name,
before_script: before_script_value,
script: script_value,
commands: commands,
image: image_value,
services: services_value,
stage: stage_value,
cache: cache_value,
only: only_value,
except: except_value,
variables: variables_defined? ? variables_value : nil,
environment: environment_defined? ? environment_value : nil,
environment_name: environment_defined? ? environment_value[:name] : nil,
coverage: coverage_defined? ? coverage_value : nil,
retry: retry_defined? ? retry_value.to_i : nil,
artifacts: artifacts_value,
after_script: after_script_value,
ignore: ignored? }
end
end
end
end
end
end