debian-mirror-gitlab/lib/gitlab/ci/config.rb
2022-08-27 11:52:29 +05:30

177 lines
4.7 KiB
Ruby

# frozen_string_literal: true
module Gitlab
module Ci
#
# Base GitLab CI Configuration facade
#
class Config
include Gitlab::Utils::StrongMemoize
ConfigError = Class.new(StandardError)
TIMEOUT_SECONDS = 30.seconds
TIMEOUT_MESSAGE = 'Resolving config took longer than expected'
RESCUE_ERRORS = [
Gitlab::Config::Loader::FormatError,
Extendable::ExtensionError,
External::Processor::IncludeError,
Config::Yaml::Tags::TagError
].freeze
attr_reader :root, :context, :source_ref_path, :source, :logger
def initialize(config, project: nil, pipeline: nil, sha: nil, user: nil, parent_pipeline: nil, source: nil, logger: nil)
@logger = logger || ::Gitlab::Ci::Pipeline::Logger.new(project: project)
@source_ref_path = pipeline&.source_ref_path
@project = project
@context = self.logger.instrument(:config_build_context) do
pipeline ||= ::Ci::Pipeline.new(project: project, sha: sha, user: user, source: source)
build_context(project: project, pipeline: pipeline, sha: sha, user: user, parent_pipeline: parent_pipeline)
end
@context.set_deadline(TIMEOUT_SECONDS)
@source = source
@config = self.logger.instrument(:config_expand) do
expand_config(config)
end
@root = self.logger.instrument(:config_compose) do
Entry::Root.new(@config, project: project, user: user).tap(&:compose!)
end
rescue *rescue_errors => e
raise Config::ConfigError, e.message
end
def valid?
@root.valid?
end
def errors
@root.errors
end
def warnings
@root.warnings
end
def to_hash
@config
end
##
# Temporary method that should be removed after refactoring
#
def variables
root.variables_value
end
def variables_with_data
root.variables_entry.value_with_data
end
def stages
root.stages_value
end
def jobs
root.jobs_value
end
def workflow_rules
root.workflow_entry.rules_value
end
def normalized_jobs
@normalized_jobs ||= Ci::Config::Normalizer.new(jobs).normalize_jobs
end
def included_templates
@context.includes.filter_map { |i| i[:location] if i[:type] == :template }
end
def metadata
{
includes: @context.includes,
merged_yaml: @config&.deep_stringify_keys&.to_yaml
}
end
private
def expand_config(config)
build_config(config)
rescue Gitlab::Config::Loader::Yaml::DataTooLargeError => e
track_and_raise_for_dev_exception(e)
raise Config::ConfigError, e.message
rescue Gitlab::Ci::Config::External::Context::TimeoutError => e
track_and_raise_for_dev_exception(e)
raise Config::ConfigError, TIMEOUT_MESSAGE
end
def build_config(config)
initial_config = logger.instrument(:config_yaml_load) do
Config::Yaml.load!(config)
end
initial_config = logger.instrument(:config_external_process) do
Config::External::Processor.new(initial_config, @context).perform
end
initial_config = logger.instrument(:config_yaml_extend) do
Config::Extendable.new(initial_config).to_hash
end
initial_config = logger.instrument(:config_tags_resolve) do
Config::Yaml::Tags::Resolver.new(initial_config).to_hash
end
logger.instrument(:config_stages_inject) do
Config::EdgeStagesInjector.new(initial_config).to_hash
end
end
def find_sha(project)
branches = project&.repository&.branches || []
unless branches.empty?
project.repository.root_ref_sha
end
end
def build_context(project:, pipeline:, sha:, user:, parent_pipeline:)
Config::External::Context.new(
project: project,
sha: sha || find_sha(project),
user: user,
parent_pipeline: parent_pipeline,
variables: build_variables(pipeline: pipeline),
logger: logger)
end
def build_variables(pipeline:)
logger.instrument(:config_build_variables) do
pipeline
.variables_builder
.config_variables
end
end
def track_and_raise_for_dev_exception(error)
Gitlab::ErrorTracking.track_and_raise_for_dev_exception(error, @context.sentry_payload)
end
# Overridden in EE
def rescue_errors
RESCUE_ERRORS
end
end
end
end
Gitlab::Ci::Config.prepend_mod_with('Gitlab::Ci::ConfigEE')