2015-09-25 12:07:36 +05:30
|
|
|
module Ci
|
|
|
|
class GitlabCiYamlProcessor
|
2016-06-16 23:09:34 +05:30
|
|
|
class ValidationError < StandardError; end
|
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
include Gitlab::Ci::Config::Node::LegacyValidationHelpers
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
attr_reader :path, :cache, :stages
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2015-11-26 14:37:03 +05:30
|
|
|
def initialize(config, path = nil)
|
2016-06-16 23:09:34 +05:30
|
|
|
@ci_config = Gitlab::Ci::Config.new(config)
|
|
|
|
@config = @ci_config.to_hash
|
|
|
|
@path = path
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
unless @ci_config.valid?
|
|
|
|
raise ValidationError, @ci_config.errors.first
|
|
|
|
end
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
initial_parsing
|
2016-06-16 23:09:34 +05:30
|
|
|
rescue Gitlab::Ci::Config::Loader::FormatError => e
|
|
|
|
raise ValidationError, e.message
|
2015-09-25 12:07:36 +05:30
|
|
|
end
|
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
def jobs_for_ref(ref, tag = false, trigger_request = nil)
|
|
|
|
@jobs.select do |_, job|
|
|
|
|
process?(job[:only], job[:except], ref, tag, trigger_request)
|
2016-06-22 15:30:34 +05:30
|
|
|
end
|
2015-09-25 12:07:36 +05:30
|
|
|
end
|
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
def jobs_for_stage_and_ref(stage, ref, tag = false, trigger_request = nil)
|
|
|
|
jobs_for_ref(ref, tag, trigger_request).select do |_, job|
|
|
|
|
job[:stage] == stage
|
2015-09-25 12:07:36 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
def builds_for_ref(ref, tag = false, trigger_request = nil)
|
|
|
|
jobs_for_ref(ref, tag, trigger_request).map do |name, _|
|
|
|
|
build_attributes(name)
|
|
|
|
end
|
2016-06-02 11:05:42 +05:30
|
|
|
end
|
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
def builds_for_stage_and_ref(stage, ref, tag = false, trigger_request = nil)
|
|
|
|
jobs_for_stage_and_ref(stage, ref, tag, trigger_request).map do |name, _|
|
|
|
|
build_attributes(name)
|
|
|
|
end
|
2016-06-02 11:05:42 +05:30
|
|
|
end
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
def builds
|
|
|
|
@jobs.map do |name, _|
|
|
|
|
build_attributes(name)
|
|
|
|
end
|
2015-09-25 12:07:36 +05:30
|
|
|
end
|
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
def build_attributes(name)
|
|
|
|
job = @jobs[name.to_sym] || {}
|
2015-09-25 12:07:36 +05:30
|
|
|
{
|
2016-08-24 12:49:21 +05:30
|
|
|
stage_idx: @stages.index(job[:stage]),
|
2015-09-25 12:07:36 +05:30
|
|
|
stage: job[:stage],
|
2016-08-24 12:49:21 +05:30
|
|
|
##
|
|
|
|
# Refactoring note:
|
|
|
|
# - before script behaves differently than after script
|
|
|
|
# - after script returns an array of commands
|
|
|
|
# - before script should be a concatenated command
|
|
|
|
commands: [job[:before_script] || @before_script, job[:script]].flatten.compact.join("\n"),
|
2015-10-24 18:46:33 +05:30
|
|
|
tag_list: job[:tags] || [],
|
2016-09-13 17:45:13 +05:30
|
|
|
name: job[:name].to_s,
|
2015-09-25 12:07:36 +05:30
|
|
|
allow_failure: job[:allow_failure] || false,
|
2015-10-24 18:46:33 +05:30
|
|
|
when: job[:when] || 'on_success',
|
2016-06-16 23:09:34 +05:30
|
|
|
environment: job[:environment],
|
2016-08-24 12:49:21 +05:30
|
|
|
yaml_variables: yaml_variables(name),
|
2015-09-25 12:07:36 +05:30
|
|
|
options: {
|
|
|
|
image: job[:image] || @image,
|
2015-11-26 14:37:03 +05:30
|
|
|
services: job[:services] || @services,
|
|
|
|
artifacts: job[:artifacts],
|
|
|
|
cache: job[:cache] || @cache,
|
2016-06-02 11:05:42 +05:30
|
|
|
dependencies: job[:dependencies],
|
|
|
|
after_script: job[:after_script] || @after_script,
|
2015-09-25 12:07:36 +05:30
|
|
|
}.compact
|
|
|
|
}
|
|
|
|
end
|
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
private
|
2016-06-16 23:09:34 +05:30
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
def initial_parsing
|
2016-09-13 17:45:13 +05:30
|
|
|
##
|
|
|
|
# Global config
|
|
|
|
#
|
2016-08-24 12:49:21 +05:30
|
|
|
@before_script = @ci_config.before_script
|
|
|
|
@image = @ci_config.image
|
|
|
|
@after_script = @ci_config.after_script
|
|
|
|
@services = @ci_config.services
|
|
|
|
@variables = @ci_config.variables
|
|
|
|
@stages = @ci_config.stages
|
|
|
|
@cache = @ci_config.cache
|
2016-06-02 11:05:42 +05:30
|
|
|
|
2016-09-13 17:45:13 +05:30
|
|
|
##
|
|
|
|
# Jobs
|
|
|
|
#
|
|
|
|
@jobs = @ci_config.jobs
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2016-09-13 17:45:13 +05:30
|
|
|
@jobs.each do |name, job|
|
|
|
|
# logical validation for job
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2016-09-13 17:45:13 +05:30
|
|
|
validate_job_stage!(name, job)
|
|
|
|
validate_job_dependencies!(name, job)
|
|
|
|
end
|
2016-08-24 12:49:21 +05:30
|
|
|
end
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
def yaml_variables(name)
|
2016-09-13 17:45:13 +05:30
|
|
|
variables = (@variables || {})
|
|
|
|
.merge(job_variables(name))
|
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
variables.map do |key, value|
|
|
|
|
{ key: key, value: value, public: true }
|
2015-09-25 12:07:36 +05:30
|
|
|
end
|
2016-08-24 12:49:21 +05:30
|
|
|
end
|
2015-09-25 12:07:36 +05:30
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
def job_variables(name)
|
|
|
|
job = @jobs[name.to_sym]
|
|
|
|
return {} unless job
|
2016-06-16 23:09:34 +05:30
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
job[:variables] || {}
|
|
|
|
end
|
2015-11-26 14:37:03 +05:30
|
|
|
|
2015-12-23 02:04:40 +05:30
|
|
|
def validate_job_stage!(name, job)
|
2016-09-13 17:45:13 +05:30
|
|
|
return unless job[:stage]
|
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
unless job[:stage].is_a?(String) && job[:stage].in?(@stages)
|
|
|
|
raise ValidationError, "#{name} job: stage parameter should be #{@stages.join(", ")}"
|
2015-11-26 14:37:03 +05:30
|
|
|
end
|
2015-12-23 02:04:40 +05:30
|
|
|
end
|
2015-11-26 14:37:03 +05:30
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
def validate_job_dependencies!(name, job)
|
2016-09-13 17:45:13 +05:30
|
|
|
return unless job[:dependencies]
|
2016-06-02 11:05:42 +05:30
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
stage_index = @stages.index(job[:stage])
|
2016-06-02 11:05:42 +05:30
|
|
|
|
|
|
|
job[:dependencies].each do |dependency|
|
|
|
|
raise ValidationError, "#{name} job: undefined dependency: #{dependency}" unless @jobs[dependency.to_sym]
|
|
|
|
|
2016-08-24 12:49:21 +05:30
|
|
|
unless @stages.index(@jobs[dependency.to_sym][:stage]) < stage_index
|
2016-06-02 11:05:42 +05:30
|
|
|
raise ValidationError, "#{name} job: dependency #{dependency} is not defined in prior stages"
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def process?(only_params, except_params, ref, tag, trigger_request)
|
2015-11-26 14:37:03 +05:30
|
|
|
if only_params.present?
|
2016-06-02 11:05:42 +05:30
|
|
|
return false unless matching?(only_params, ref, tag, trigger_request)
|
2015-11-26 14:37:03 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
if except_params.present?
|
2016-06-02 11:05:42 +05:30
|
|
|
return false if matching?(except_params, ref, tag, trigger_request)
|
2015-11-26 14:37:03 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
true
|
|
|
|
end
|
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
def matching?(patterns, ref, tag, trigger_request)
|
2015-11-26 14:37:03 +05:30
|
|
|
patterns.any? do |pattern|
|
2016-06-02 11:05:42 +05:30
|
|
|
match_ref?(pattern, ref, tag, trigger_request)
|
2015-11-26 14:37:03 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
def match_ref?(pattern, ref, tag, trigger_request)
|
2015-11-26 14:37:03 +05:30
|
|
|
pattern, path = pattern.split('@', 2)
|
|
|
|
return false if path && path != self.path
|
|
|
|
return true if tag && pattern == 'tags'
|
|
|
|
return true if !tag && pattern == 'branches'
|
2016-06-02 11:05:42 +05:30
|
|
|
return true if trigger_request.present? && pattern == 'triggers'
|
2015-11-26 14:37:03 +05:30
|
|
|
|
|
|
|
if pattern.first == "/" && pattern.last == "/"
|
|
|
|
Regexp.new(pattern[1...-1]) =~ ref
|
|
|
|
else
|
|
|
|
pattern == ref
|
|
|
|
end
|
2015-09-25 12:07:36 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|