debian-mirror-gitlab/lib/gitlab/ci/config/external/file/base.rb

104 lines
2.6 KiB
Ruby
Raw Normal View History

2018-12-13 13:39:08 +05:30
# frozen_string_literal: true
module Gitlab
module Ci
class Config
module External
module File
class Base
include Gitlab::Utils::StrongMemoize
2019-02-15 15:39:39 +05:30
attr_reader :location, :params, :context, :errors
2018-12-13 13:39:08 +05:30
YAML_WHITELIST_EXTENSION = /.+\.(yml|yaml)$/i.freeze
2019-07-07 11:18:12 +05:30
Context = Struct.new(:project, :sha, :user, :expandset)
2019-02-15 15:39:39 +05:30
def initialize(params, context)
@params = params
@context = context
2018-12-13 13:39:08 +05:30
@errors = []
validate!
end
2019-02-15 15:39:39 +05:30
def matching?
location.present?
end
2018-12-13 13:39:08 +05:30
def invalid_extension?
2019-02-15 15:39:39 +05:30
location.nil? || !::File.basename(location).match?(YAML_WHITELIST_EXTENSION)
2018-12-13 13:39:08 +05:30
end
def valid?
errors.none?
end
def error_message
errors.first
end
def content
raise NotImplementedError, 'subclass must implement fetching raw content'
end
def to_hash
2019-07-07 11:18:12 +05:30
expanded_content_hash
2019-05-18 00:54:41 +05:30
end
2019-05-30 16:15:17 +05:30
protected
2019-07-07 11:18:12 +05:30
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-12-13 13:39:08 +05:30
def validate!
validate_location!
validate_content! if errors.none?
validate_hash! if errors.none?
end
def validate_location!
if invalid_extension?
errors.push("Included file `#{location}` does not have YAML extension!")
end
end
def validate_content!
if content.blank?
errors.push("Included file `#{location}` is empty or does not exist!")
end
end
def validate_hash!
if to_hash.blank?
errors.push("Included file `#{location}` does not have valid YAML syntax!")
end
end
2019-07-07 11:18:12 +05:30
def expand_includes(hash)
External::Processor.new(hash, **expand_context).perform
end
def expand_context
{ project: nil, sha: nil, user: nil, expandset: context.expandset }
end
2018-12-13 13:39:08 +05:30
end
end
end
end
end
end