debian-mirror-gitlab/lib/gitlab/ci/config/entry/root.rb

152 lines
4.7 KiB
Ruby
Raw Normal View History

2019-09-30 21:07:59 +05:30
# frozen_string_literal: true
module Gitlab
module Ci
class Config
module Entry
##
# This class represents a global entry - root Entry for entire
# GitLab CI Configuration file.
#
class Root < ::Gitlab::Config::Entry::Node
include ::Gitlab::Config::Entry::Configurable
ALLOWED_KEYS = %i[default include before_script image services
2019-12-26 22:10:19 +05:30
after_script variables stages types cache workflow].freeze
2019-09-30 21:07:59 +05:30
validations do
validates :config, allowed_keys: ALLOWED_KEYS
end
# reserved:
# defines whether the node name is reserved
# the reserved name cannot be used a job name
# reserved should not be used as it will make
# breaking change to `.gitlab-ci.yml`
entry :default, Entry::Default,
description: 'Default configuration for all jobs.',
default: {}
entry :include, Entry::Includes,
description: 'List of external YAML files to include.',
reserved: true
2022-04-04 11:22:00 +05:30
entry :before_script, Entry::Commands,
2019-09-30 21:07:59 +05:30
description: 'Script that will be executed before each job.',
reserved: true
entry :image, Entry::Image,
description: 'Docker image that will be used to execute jobs.',
reserved: true
entry :services, Entry::Services,
description: 'Docker images that will be linked to the container.',
reserved: true
2022-04-04 11:22:00 +05:30
entry :after_script, Entry::Commands,
2019-09-30 21:07:59 +05:30
description: 'Script that will be executed after each job.',
reserved: true
entry :variables, Entry::Variables,
description: 'Environment variables that will be used.',
2021-02-22 17:27:13 +05:30
metadata: { use_value_data: true },
2019-09-30 21:07:59 +05:30
reserved: true
entry :stages, Entry::Stages,
description: 'Configuration of stages for this pipeline.',
reserved: true
entry :types, Entry::Stages,
description: 'Deprecated: stages for this pipeline.',
2022-03-02 08:16:31 +05:30
reserved: true,
2022-04-04 11:22:00 +05:30
deprecation: { deprecated: '9.0', warning: '14.8', removed: '15.0' }
2019-09-30 21:07:59 +05:30
2021-06-08 01:23:25 +05:30
entry :cache, Entry::Caches,
2019-09-30 21:07:59 +05:30
description: 'Configure caching between build jobs.',
reserved: true
2019-12-26 22:10:19 +05:30
entry :workflow, Entry::Workflow,
2020-04-08 14:13:33 +05:30
description: 'List of evaluable rules to determine Pipeline status',
default: {}
2019-12-26 22:10:19 +05:30
2020-04-08 14:13:33 +05:30
dynamic_helpers :jobs
2019-09-30 21:07:59 +05:30
delegate :before_script_value,
:image_value,
:services_value,
:after_script_value,
2020-04-08 14:13:33 +05:30
:cache_value, to: :default_entry
2019-09-30 21:07:59 +05:30
attr_reader :jobs_config
class << self
include ::Gitlab::Utils::StrongMemoize
def reserved_nodes_names
strong_memoize(:reserved_nodes_names) do
self.nodes.select do |_, node|
node.reserved?
end.keys
end
end
end
def initialize(config, **metadata)
super do
filter_jobs!
end
end
def compose!(_deps = nil)
super(self) do
compose_deprecated_entries!
compose_jobs!
end
end
private
# rubocop: disable CodeReuse/ActiveRecord
def compose_jobs!
factory = ::Gitlab::Config::Entry::Factory.new(Entry::Jobs)
.value(jobs_config)
.with(key: :jobs, parent: self,
description: 'Jobs definition for this pipeline')
@entries[:jobs] = factory.create!
end
# rubocop: enable CodeReuse/ActiveRecord
def compose_deprecated_entries!
##
# Deprecated `:types` key workaround - if types are defined and
# stages are not defined we use types definition as stages.
2022-04-04 11:22:00 +05:30
# This keyword will be removed in 15.0:
# https://gitlab.com/gitlab-org/gitlab/-/issues/346823
2019-09-30 21:07:59 +05:30
#
2022-03-02 08:16:31 +05:30
if types_defined?
@entries[:stages] = @entries[:types] unless stages_defined?
log_and_warn_deprecated_entry(@entries[:types])
2019-09-30 21:07:59 +05:30
end
@entries.delete(:types)
end
def filter_jobs!
return unless @config.is_a?(Hash)
@jobs_config = @config
2019-12-04 20:38:33 +05:30
.except(*self.class.reserved_nodes_names)
2019-09-30 21:07:59 +05:30
.select do |name, config|
2020-11-24 15:15:51 +05:30
Entry::Jobs.find_type(name, config).present? || ALLOWED_KEYS.exclude?(name)
2019-09-30 21:07:59 +05:30
end
2019-12-04 20:38:33 +05:30
@config = @config.except(*@jobs_config.keys)
2019-09-30 21:07:59 +05:30
end
end
end
end
end
end