debian-mirror-gitlab/lib/gitlab/ci/config/external/mapper.rb
2022-04-04 11:22:00 +05:30

188 lines
5.6 KiB
Ruby

# frozen_string_literal: true
module Gitlab
module Ci
class Config
module External
class Mapper
include Gitlab::Utils::StrongMemoize
MAX_INCLUDES = 100
FILE_CLASSES = [
External::File::Remote,
External::File::Template,
External::File::Local,
External::File::Project,
External::File::Artifact
].freeze
Error = Class.new(StandardError)
AmbigiousSpecificationError = Class.new(Error)
TooManyIncludesError = Class.new(Error)
def initialize(values, context)
@locations = Array.wrap(values.fetch(:include, []))
@context = context
end
def process
return [] if locations.empty?
logger.instrument(:config_mapper_process) do
process_without_instrumentation
end
end
private
attr_reader :locations, :context
delegate :expandset, :logger, to: :context
def process_without_instrumentation
locations
.compact
.map(&method(:normalize_location))
.filter_map(&method(:verify_rules))
.flat_map(&method(:expand_project_files))
.flat_map(&method(:expand_wildcard_paths))
.map(&method(:expand_variables))
.each(&method(:verify_duplicates!))
.map(&method(:select_first_matching))
end
def normalize_location(location)
logger.instrument(:config_mapper_normalize) do
normalize_location_without_instrumentation(location)
end
end
# convert location if String to canonical form
def normalize_location_without_instrumentation(location)
if location.is_a?(String)
expanded_location = expand_variables(location)
normalize_location_string(expanded_location)
else
location.deep_symbolize_keys
end
end
def verify_rules(location)
logger.instrument(:config_mapper_rules) do
verify_rules_without_instrumentation(location)
end
end
def verify_rules_without_instrumentation(location)
return unless Rules.new(location[:rules]).evaluate(context).pass?
location
end
def expand_project_files(location)
return location unless location[:project]
Array.wrap(location[:file]).map do |file|
location.merge(file: file)
end
end
def expand_wildcard_paths(location)
logger.instrument(:config_mapper_wildcards) do
expand_wildcard_paths_without_instrumentation(location)
end
end
def expand_wildcard_paths_without_instrumentation(location)
# We only support local files for wildcard paths
return location unless location[:local] && location[:local].include?('*')
context.project.repository.search_files_by_wildcard_path(location[:local], context.sha).map do |path|
{ local: path }
end
end
def normalize_location_string(location)
if ::Gitlab::UrlSanitizer.valid?(location)
{ remote: location }
else
{ local: location }
end
end
def verify_duplicates!(location)
logger.instrument(:config_mapper_verify) do
verify_max_includes_and_add_location!(location)
end
end
def verify_max_includes_and_add_location!(location)
if expandset.count >= MAX_INCLUDES
raise TooManyIncludesError, "Maximum of #{MAX_INCLUDES} nested includes are allowed!"
end
# Scope location to context to allow support of
# relative includes
scoped_location = location.merge(
context_project: context.project,
context_sha: context.sha)
expandset.add(scoped_location)
end
def select_first_matching(location)
logger.instrument(:config_mapper_select) do
select_first_matching_without_instrumentation(location)
end
end
def select_first_matching_without_instrumentation(location)
matching = FILE_CLASSES.map do |file_class|
file_class.new(location, context)
end.select(&:matching?)
raise AmbigiousSpecificationError, "Include `#{masked_location(location.to_json)}` needs to match exactly one accessor!" unless matching.one?
matching.first
end
def expand_variables(data)
logger.instrument(:config_mapper_variables) do
expand_variables_without_instrumentation(data)
end
end
def expand_variables_without_instrumentation(data)
if data.is_a?(String)
expand(data)
else
transform(data)
end
end
def transform(data)
data.transform_values do |values|
case values
when Array
values.map { |value| expand(value.to_s) }
when String
expand(values)
else
values
end
end
end
def expand(data)
ExpandVariables.expand(data, -> { context.variables_hash })
end
def masked_location(location)
context.mask_variables_from(location)
end
end
end
end
end
end