2018-09-11 10:26:57 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2018-09-08 06:09:14 -04:00
|
|
|
module Gitlab
|
|
|
|
module Ci
|
2018-10-16 09:09:36 -04:00
|
|
|
class Config
|
|
|
|
module External
|
|
|
|
module File
|
|
|
|
class Base
|
2018-10-18 08:13:26 -04:00
|
|
|
include Gitlab::Utils::StrongMemoize
|
|
|
|
|
2019-01-02 06:51:15 -05:00
|
|
|
attr_reader :location, :params, :context, :errors
|
2018-10-18 08:13:26 -04:00
|
|
|
|
2018-10-19 10:37:57 -04:00
|
|
|
YAML_WHITELIST_EXTENSION = /.+\.(yml|yaml)$/i.freeze
|
2018-09-08 06:09:14 -04:00
|
|
|
|
2019-01-02 06:51:15 -05:00
|
|
|
def initialize(params, context)
|
|
|
|
@params = params
|
|
|
|
@context = context
|
2018-10-18 08:13:26 -04:00
|
|
|
@errors = []
|
|
|
|
|
2018-10-19 10:16:30 -04:00
|
|
|
validate!
|
2018-10-18 08:13:26 -04:00
|
|
|
end
|
|
|
|
|
2019-01-02 06:51:15 -05:00
|
|
|
def matching?
|
|
|
|
location.present?
|
|
|
|
end
|
|
|
|
|
2019-08-26 15:12:52 -04:00
|
|
|
def invalid_location_type?
|
|
|
|
!location.is_a?(String)
|
|
|
|
end
|
|
|
|
|
2018-10-18 08:13:26 -04:00
|
|
|
def invalid_extension?
|
2019-01-02 06:51:15 -05:00
|
|
|
location.nil? || !::File.basename(location).match?(YAML_WHITELIST_EXTENSION)
|
2018-10-16 09:09:36 -04:00
|
|
|
end
|
2018-09-08 06:09:14 -04:00
|
|
|
|
2018-10-16 09:09:36 -04:00
|
|
|
def valid?
|
2018-10-18 08:13:26 -04:00
|
|
|
errors.none?
|
|
|
|
end
|
|
|
|
|
|
|
|
def error_message
|
|
|
|
errors.first
|
2018-10-16 09:09:36 -04:00
|
|
|
end
|
2018-09-08 06:09:14 -04:00
|
|
|
|
2018-10-16 09:09:36 -04:00
|
|
|
def content
|
2018-10-18 08:13:26 -04:00
|
|
|
raise NotImplementedError, 'subclass must implement fetching raw content'
|
2018-10-16 09:09:36 -04:00
|
|
|
end
|
2018-09-08 06:09:14 -04:00
|
|
|
|
2018-10-18 08:13:26 -04:00
|
|
|
def to_hash
|
2019-01-14 05:55:51 -05:00
|
|
|
expanded_content_hash
|
2018-10-18 08:13:26 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
protected
|
|
|
|
|
2019-01-14 05:55:51 -05:00
|
|
|
def expanded_content_hash
|
|
|
|
return unless content_hash
|
|
|
|
|
|
|
|
strong_memoize(:expanded_content_yaml) do
|
|
|
|
expand_includes(content_hash)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def content_hash
|
|
|
|
strong_memoize(:content_yaml) do
|
|
|
|
Gitlab::Config::Loader::Yaml.new(content).load!
|
|
|
|
end
|
|
|
|
rescue Gitlab::Config::Loader::FormatError
|
|
|
|
nil
|
|
|
|
end
|
|
|
|
|
2018-10-19 10:16:30 -04:00
|
|
|
def validate!
|
2019-09-24 14:06:05 -04:00
|
|
|
validate_execution_time!
|
2018-10-19 10:16:30 -04:00
|
|
|
validate_location!
|
|
|
|
validate_content! if errors.none?
|
|
|
|
validate_hash! if errors.none?
|
|
|
|
end
|
|
|
|
|
2019-09-24 14:06:05 -04:00
|
|
|
def validate_execution_time!
|
|
|
|
context.check_execution_time!
|
|
|
|
end
|
|
|
|
|
2018-10-18 08:13:26 -04:00
|
|
|
def validate_location!
|
2019-08-26 15:12:52 -04:00
|
|
|
if invalid_location_type?
|
|
|
|
errors.push("Included file `#{location}` needs to be a string")
|
|
|
|
elsif invalid_extension?
|
2018-10-18 08:13:26 -04:00
|
|
|
errors.push("Included file `#{location}` does not have YAML extension!")
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def validate_content!
|
2018-10-19 10:16:30 -04:00
|
|
|
if content.blank?
|
2018-10-18 08:13:26 -04:00
|
|
|
errors.push("Included file `#{location}` is empty or does not exist!")
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def validate_hash!
|
2018-10-19 10:16:30 -04:00
|
|
|
if to_hash.blank?
|
2018-10-18 08:13:26 -04:00
|
|
|
errors.push("Included file `#{location}` does not have valid YAML syntax!")
|
|
|
|
end
|
2018-10-16 09:09:36 -04:00
|
|
|
end
|
2019-01-14 05:55:51 -05:00
|
|
|
|
|
|
|
def expand_includes(hash)
|
2019-09-24 14:06:05 -04:00
|
|
|
External::Processor.new(hash, context.mutate(expand_context_attrs)).perform
|
2019-01-14 05:55:51 -05:00
|
|
|
end
|
|
|
|
|
2019-09-24 14:06:05 -04:00
|
|
|
def expand_context_attrs
|
|
|
|
{}
|
2019-01-14 05:55:51 -05:00
|
|
|
end
|
2018-09-08 06:09:14 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|