openvox 8.19.0

data/lib/puppet/pops/lookup/hiera_config.rb

@@ -0,0 +1,823 @@
+# frozen_string_literal: true
+
+require_relative 'data_dig_function_provider'
+require_relative 'data_hash_function_provider'
+require_relative 'lookup_key_function_provider'
+require_relative 'location_resolver'
+
+module Puppet::Pops
+module Lookup
+# @api private
+class ScopeLookupCollectingInvocation < Invocation
+  def initialize(scope)
+    super(scope)
+    @scope_interpolations = []
+  end
+
+  def remember_scope_lookup(key, root_key, segments, value)
+    @scope_interpolations << [key, root_key, segments, value] unless !value.nil? && key.start_with?('::')
+  end
+
+  def scope_interpolations
+    # Save extra checks by keeping the array unique with respect to the key (first entry)
+    @scope_interpolations.uniq! { |si| si[0] }
+    @scope_interpolations
+  end
+
+  # Yield invocation that remembers all but the given name
+  def with_local_memory_eluding(name)
+    save_si = @scope_interpolations
+    @scope_interpolations = []
+    result = yield
+    save_si.concat(@scope_interpolations.reject { |entry| entry[1] == name })
+    @scope_interpolations = save_si
+    result
+  end
+end
+
+# @api private
+class HieraConfig
+  include LocationResolver
+  include LabelProvider
+
+  CONFIG_FILE_NAME = 'hiera.yaml'
+
+  KEY_NAME = 'name'
+  KEY_VERSION = 'version'
+  KEY_DATADIR = 'datadir'
+  KEY_DEFAULT_HIERARCHY = 'default_hierarchy'
+  KEY_HIERARCHY = 'hierarchy'
+  KEY_PLAN_HIERARCHY = 'plan_hierarchy'
+  KEY_LOGGER = 'logger'
+  KEY_OPTIONS = 'options'
+  KEY_PATH = 'path'
+  KEY_PATHS = 'paths'
+  KEY_MAPPED_PATHS = 'mapped_paths'
+  KEY_GLOB = 'glob'
+  KEY_GLOBS = 'globs'
+  KEY_URI = 'uri'
+  KEY_URIS = 'uris'
+  KEY_DEFAULTS = 'defaults'
+  KEY_DATA_HASH = DataHashFunctionProvider::TAG
+  KEY_LOOKUP_KEY = LookupKeyFunctionProvider::TAG
+  KEY_DATA_DIG = DataDigFunctionProvider::TAG
+  KEY_V3_DATA_HASH = V3DataHashFunctionProvider::TAG
+  KEY_V3_LOOKUP_KEY = V3LookupKeyFunctionProvider::TAG
+  KEY_V3_BACKEND = V3BackendFunctionProvider::TAG
+  KEY_V4_DATA_HASH = V4DataHashFunctionProvider::TAG
+  KEY_BACKEND = 'backend'
+  KEY_EXTENSION = 'extension'
+
+  FUNCTION_KEYS = [KEY_DATA_HASH, KEY_LOOKUP_KEY, KEY_DATA_DIG, KEY_V3_BACKEND]
+  ALL_FUNCTION_KEYS = FUNCTION_KEYS + [KEY_V4_DATA_HASH]
+  LOCATION_KEYS = [KEY_PATH, KEY_PATHS, KEY_GLOB, KEY_GLOBS, KEY_URI, KEY_URIS, KEY_MAPPED_PATHS]
+  FUNCTION_PROVIDERS = {
+    KEY_DATA_HASH => DataHashFunctionProvider,
+    KEY_DATA_DIG => DataDigFunctionProvider,
+    KEY_LOOKUP_KEY => LookupKeyFunctionProvider,
+    KEY_V3_DATA_HASH => V3DataHashFunctionProvider,
+    KEY_V3_BACKEND => V3BackendFunctionProvider,
+    KEY_V3_LOOKUP_KEY => V3LookupKeyFunctionProvider,
+    KEY_V4_DATA_HASH => V4DataHashFunctionProvider
+  }
+
+  def self.v4_function_config(config_root, function_name, owner)
+    unless Puppet[:strict] == :off
+      Puppet.warn_once('deprecations', 'legacy_provider_function',
+                       _("Using of legacy data provider function '%{function_name}'. Please convert to a 'data_hash' function") % { function_name: function_name })
+    end
+    HieraConfigV5.new(config_root, nil,
+                      {
+                        KEY_VERSION => 5,
+                        KEY_HIERARCHY => [
+                          {
+                            KEY_NAME => "Legacy function '#{function_name}'",
+                            KEY_V4_DATA_HASH => function_name
+                          }
+                        ]
+                      }.freeze,
+                      owner)
+  end
+
+  def self.config_exist?(config_root)
+    config_path = config_root + CONFIG_FILE_NAME
+    config_path.exist?
+  end
+
+  def self.symkeys_to_string(struct)
+    case struct
+    when Hash
+      map = {}
+      struct.each_pair { |k, v| map[k.is_a?(Symbol) ? k.to_s : k] = symkeys_to_string(v) }
+      map
+    when Array
+      struct.map { |v| symkeys_to_string(v) }
+    else
+      struct
+    end
+  end
+
+  # Creates a new HieraConfig from the given _config_root_. This is where the 'hiera.yaml' is expected to be found
+  # and is also the base location used when resolving relative paths.
+  #
+  # @param lookup_invocation [Invocation] Invocation data containing scope, overrides, and defaults
+  # @param config_path [Pathname] Absolute path to the configuration file
+  # @param owner [ConfiguredDataProvider] The data provider that will own the created configuration
+  # @return [LookupConfiguration] the configuration
+  def self.create(lookup_invocation, config_path, owner)
+    if config_path.is_a?(Hash)
+      config_path = nil
+      loaded_config = config_path
+    else
+      config_root = config_path.parent
+      if config_path.exist?
+        env_context = EnvironmentContext.adapt(lookup_invocation.scope.compiler.environment)
+        loaded_config = env_context.cached_file_data(config_path) do |content|
+          parsed = Puppet::Util::Yaml.safe_load(content, [Symbol], config_path)
+
+          # For backward compatibility, we must treat an empty file, or a yaml that doesn't
+          # produce a Hash as Hiera version 3 default.
+          if parsed.is_a?(Hash)
+            parsed
+          else
+            Puppet.warning(_("%{config_path}: File exists but does not contain a valid YAML hash. Falling back to Hiera version 3 default config") % { config_path: config_path })
+            HieraConfigV3::DEFAULT_CONFIG_HASH
+          end
+        end
+      else
+        config_path = nil
+        loaded_config = HieraConfigV5::DEFAULT_CONFIG_HASH
+      end
+    end
+
+    version = loaded_config[KEY_VERSION] || loaded_config[:version]
+    version = version.nil? ? 3 : version.to_i
+    case version
+    when 5
+      HieraConfigV5.new(config_root, config_path, loaded_config, owner)
+    when 4
+      HieraConfigV4.new(config_root, config_path, loaded_config, owner)
+    when 3
+      HieraConfigV3.new(config_root, config_path, loaded_config, owner)
+    else
+      issue = Issues::HIERA_UNSUPPORTED_VERSION
+      raise Puppet::DataBinding::LookupError.new(
+        issue.format(:version => version), config_path, nil, nil, nil, issue.issue_code
+      )
+    end
+  end
+
+  attr_reader :config_path
+
+  # Creates a new HieraConfig from the given _config_root_. This is where the 'lookup.yaml' is expected to be found
+  # and is also the base location used when resolving relative paths.
+  #
+  # @param config_path [Pathname] Absolute path to the configuration
+  # @param loaded_config [Hash] the loaded configuration
+  def initialize(config_root, config_path, loaded_config, owner)
+    @config_root = config_root
+    @config_path = config_path
+    @loaded_config = loaded_config
+    @config = validate_config(self.class.symkeys_to_string(@loaded_config), owner)
+    @data_providers = nil
+  end
+
+  def fail(issue, args = EMPTY_HASH, line = nil)
+    raise Puppet::DataBinding::LookupError.new(
+      issue.format(args.merge(:label => self)), @config_path, line, nil, nil, issue.issue_code
+    )
+  end
+
+  def has_default_hierarchy?
+    false
+  end
+
+  # Returns the data providers for this config
+  #
+  # @param lookup_invocation [Invocation] Invocation data containing scope, overrides, and defaults
+  # @param parent_data_provider [DataProvider] The data provider that loaded this configuration
+  # @return [Array<DataProvider>] the data providers
+  def configured_data_providers(lookup_invocation, parent_data_provider, use_default_hierarchy = false)
+    unless @data_providers && scope_interpolations_stable?(lookup_invocation)
+      if @data_providers
+        lookup_invocation.report_text { _('Hiera configuration recreated due to change of scope variables used in interpolation expressions') }
+      end
+      slc_invocation = ScopeLookupCollectingInvocation.new(lookup_invocation.scope)
+      begin
+        @data_providers = create_configured_data_providers(slc_invocation, parent_data_provider, false)
+        if has_default_hierarchy?
+          @default_data_providers = create_configured_data_providers(slc_invocation, parent_data_provider, true)
+        end
+      rescue StandardError => e
+        # Raise a LookupError with a RUNTIME_ERROR issue to prevent this being translated to an evaluation error triggered in the pp file
+        # where the lookup started
+        if e.message =~ /^Undefined variable '([^']+)'/
+          var = ::Regexp.last_match(1)
+          fail(Issues::HIERA_UNDEFINED_VARIABLE, { :name => var }, find_line_matching(/%\{['"]?#{var}['"]?}/))
+        end
+        raise e
+      end
+      @scope_interpolations = slc_invocation.scope_interpolations
+    end
+    use_default_hierarchy ? @default_data_providers : @data_providers
+  end
+
+  # Find first line in configuration that matches regexp after given line. Comments are stripped
+  def find_line_matching(regexp, start_line = 1)
+    line_number = 0
+    File.foreach(@config_path) do |line|
+      line_number += 1
+      next if line_number < start_line
+
+      quote = nil
+      stripped = ''.dup
+      line.each_codepoint do |cp|
+        case cp
+        when 0x22, 0x27 # double or single quote
+          if quote == cp
+            quote = nil
+          elsif quote.nil?
+            quote = cp
+          end
+        when 0x23 # unquoted hash mark
+          break
+        end
+        stripped << cp
+      end
+      return line_number if stripped =~ regexp
+    end
+    nil
+  end
+
+  def scope_interpolations_stable?(lookup_invocation)
+    if @scope_interpolations.empty?
+      true
+    else
+      scope = lookup_invocation.scope
+      lookup_invocation.without_explain do
+        @scope_interpolations.all? do |key, root_key, segments, old_value|
+          value = Puppet.override(avoid_hiera_interpolation_errors: true) { scope[root_key] }
+          unless value.nil? || segments.empty?
+            found = nil;
+            catch(:no_such_key) { found = sub_lookup(key, lookup_invocation, segments, value) }
+            value = found;
+          end
+          old_value.eql?(value)
+        end
+      end
+    end
+  end
+
+  # @api private
+  def create_configured_data_providers(lookup_invocation, parent_data_provider, use_default_hierarchy)
+    self.class.not_implemented(self, 'create_configured_data_providers')
+  end
+
+  def validate_config(config, owner)
+    self.class.not_implemented(self, 'validate_config')
+  end
+
+  def version
+    self.class.not_implemented(self, 'version')
+  end
+
+  def name
+    "hiera configuration version #{version}"
+  end
+
+  def create_hiera3_backend_provider(name, backend, parent_data_provider, datadir, paths, hiera3_config)
+    # Custom backend. Hiera 3 must be installed, its logger configured, and it must be made aware of the loaded config
+    raise Puppet::DataBinding::LookupError, 'Hiera 3 is not installed' unless Puppet.features.hiera?
+
+    if Hiera::Config.instance_variable_defined?(:@config) && (current_config = Hiera::Config.instance_variable_get(:@config)).is_a?(Hash)
+      current_config.each_pair do |key, val|
+        case key
+        when :hierarchy, :backends
+          hiera3_config[key] = ([val] + [hiera3_config[key]]).flatten.uniq
+        else
+          hiera3_config[key] = val
+        end
+      end
+    elsif hiera3_config.include?(KEY_LOGGER)
+      Hiera.logger = hiera3_config[KEY_LOGGER].to_s
+    else
+      Hiera.logger = 'puppet'
+    end
+
+    unless Hiera::Interpolate.const_defined?(:PATCHED_BY_HIERA_5)
+      # Replace the class methods 'hiera_interpolate' and 'alias_interpolate' with a method that wires back and performs global
+      # lookups using the lookup framework. This is necessary since the classic Hiera is made aware only of custom backends.
+      class << Hiera::Interpolate
+        hiera_interpolate = proc do |_data, key, scope, _extra_data, context|
+          override = context[:order_override]
+          invocation = Puppet::Pops::Lookup::Invocation.current
+          unless override.nil? && invocation.global_only?
+            invocation = Puppet::Pops::Lookup::Invocation.new(scope)
+            invocation.set_global_only
+            invocation.set_hiera_v3_location_overrides(override) unless override.nil?
+          end
+          Puppet::Pops::Lookup::LookupAdapter.adapt(scope.compiler).lookup(key, invocation, nil)
+        end
+
+        send(:remove_method, :hiera_interpolate)
+        send(:remove_method, :alias_interpolate)
+        send(:define_method, :hiera_interpolate, hiera_interpolate)
+        send(:define_method, :alias_interpolate, hiera_interpolate)
+      end
+      Hiera::Interpolate.send(:const_set, :PATCHED_BY_HIERA_5, true)
+    end
+
+    Hiera::Config.instance_variable_set(:@config, hiera3_config)
+
+    # Use a special lookup_key that delegates to the backend
+    paths = nil if !paths.nil? && paths.empty?
+    create_data_provider(name, parent_data_provider, KEY_V3_BACKEND, 'hiera_v3_data', { KEY_DATADIR => datadir, KEY_BACKEND => backend }, paths)
+  end
+
+  private
+
+  def create_data_provider(name, parent_data_provider, function_kind, function_name, options, locations)
+    FUNCTION_PROVIDERS[function_kind].new(name, parent_data_provider, function_name, options, locations)
+  end
+
+  def self.not_implemented(impl, method_name)
+    raise NotImplementedError, "The class #{impl.class.name} should have implemented the method #{method_name}()"
+  end
+  private_class_method :not_implemented
+end
+
+# @api private
+class HieraConfigV3 < HieraConfig
+  KEY_BACKENDS = 'backends'
+  KEY_MERGE_BEHAVIOR = 'merge_behavior'
+  KEY_DEEP_MERGE_OPTIONS = 'deep_merge_options'
+
+  def self.config_type
+    return @@CONFIG_TYPE if class_variable_defined?(:@@CONFIG_TYPE)
+
+    tf = Types::TypeFactory
+    nes_t = Types::PStringType::NON_EMPTY
+
+    # This is a hash, not a type. Contained backends are added prior to validation
+    @@CONFIG_TYPE = {
+      tf.optional(KEY_VERSION) => tf.range(3, 3),
+      tf.optional(KEY_BACKENDS) => tf.variant(nes_t, tf.array_of(nes_t)),
+      tf.optional(KEY_LOGGER) => nes_t,
+      tf.optional(KEY_MERGE_BEHAVIOR) => tf.enum('deep', 'deeper', 'native'),
+      tf.optional(KEY_DEEP_MERGE_OPTIONS) => tf.hash_kv(nes_t, tf.variant(tf.string, tf.boolean)),
+      tf.optional(KEY_HIERARCHY) => tf.variant(nes_t, tf.array_of(nes_t))
+    }
+  end
+
+  def create_configured_data_providers(lookup_invocation, parent_data_provider, _)
+    scope = lookup_invocation.scope
+    unless scope.is_a?(Hiera::Scope)
+      lookup_invocation = Invocation.new(
+        Hiera::Scope.new(scope),
+        lookup_invocation.override_values,
+        lookup_invocation.default_values,
+        lookup_invocation.explainer
+      )
+    end
+
+    default_datadir = File.join(Puppet.settings[:codedir], 'environments', '%{::environment}', 'hieradata')
+    data_providers = {}
+
+    [@config[KEY_BACKENDS]].flatten.each do |backend|
+      if data_providers.include?(backend)
+        first_line = find_line_matching(/[^\w]#{backend}(?:[^\w]|$)/)
+        line = find_line_matching(/[^\w]#{backend}(?:[^\w]|$)/, first_line + 1) if first_line
+        unless line
+          line = first_line
+          first_line = nil
+        end
+        fail(Issues::HIERA_BACKEND_MULTIPLY_DEFINED, { :name => backend, :first_line => first_line }, line)
+      end
+      original_paths = [@config[KEY_HIERARCHY]].flatten
+      backend_config = @config[backend]
+      if backend_config.nil?
+        backend_config = EMPTY_HASH
+      else
+        backend_config = interpolate(backend_config, lookup_invocation, false)
+      end
+      datadir = Pathname(backend_config[KEY_DATADIR] || interpolate(default_datadir, lookup_invocation, false))
+      ext = backend_config[KEY_EXTENSION]
+      if ext.nil?
+        ext = backend == 'hocon' ? '.conf' : ".#{backend}"
+      else
+        ext = ".#{ext}"
+      end
+      paths = resolve_paths(datadir, original_paths, lookup_invocation, @config_path.nil?, ext)
+      data_providers[backend] =
+        if %w[json yaml].include? backend
+          create_data_provider(backend, parent_data_provider, KEY_V3_DATA_HASH,
+                               "#{backend}_data", { KEY_DATADIR => datadir },
+                               paths)
+        elsif backend == 'hocon' && Puppet.features.hocon?
+          create_data_provider(backend, parent_data_provider, KEY_V3_DATA_HASH,
+                               'hocon_data', { KEY_DATADIR => datadir }, paths)
+        elsif backend == 'eyaml' && Puppet.features.hiera_eyaml?
+          create_data_provider(backend, parent_data_provider,
+                               KEY_V3_LOOKUP_KEY, 'eyaml_lookup_key',
+                               backend_config.merge(KEY_DATADIR => datadir),
+                               paths)
+        else
+          create_hiera3_backend_provider(backend, backend,
+                                         parent_data_provider, datadir, paths,
+                                         @loaded_config)
+        end
+    end
+    data_providers.values
+  end
+
+  DEFAULT_CONFIG_HASH = {
+    KEY_BACKENDS => %w[yaml],
+    KEY_HIERARCHY => %w[nodes/%{::trusted.certname} common],
+    KEY_MERGE_BEHAVIOR => 'native'
+  }
+
+  def validate_config(config, owner)
+    unless Puppet[:strict] == :off
+      Puppet.warn_once('deprecations', 'hiera.yaml',
+                       _("%{config_path}: Use of 'hiera.yaml' version 3 is deprecated. It should be converted to version 5") % { config_path: @config_path }, config_path.to_s)
+    end
+    config[KEY_VERSION] ||= 3
+    config[KEY_BACKENDS] ||= DEFAULT_CONFIG_HASH[KEY_BACKENDS]
+    config[KEY_HIERARCHY] ||= DEFAULT_CONFIG_HASH[KEY_HIERARCHY]
+    config[KEY_MERGE_BEHAVIOR] ||= DEFAULT_CONFIG_HASH[KEY_MERGE_BEHAVIOR]
+    config[KEY_DEEP_MERGE_OPTIONS] ||= {}
+
+    backends = [config[KEY_BACKENDS]].flatten
+
+    # Create the final struct used for validation (backends are included as keys to arbitrary configs in the form of a hash)
+    tf = Types::TypeFactory
+    backend_elements = {}
+    backends.each { |backend| backend_elements[tf.optional(backend)] = tf.hash_kv(Types::PStringType::NON_EMPTY, tf.any) }
+    v3_struct = tf.struct(self.class.config_type.merge(backend_elements))
+
+    Types::TypeAsserter.assert_instance_of(["The Lookup Configuration at '%s'", @config_path], v3_struct, config)
+  end
+
+  def merge_strategy
+    @merge_strategy ||= create_merge_strategy
+  end
+
+  def version
+    3
+  end
+
+  private
+
+  def create_merge_strategy
+    key = @config[KEY_MERGE_BEHAVIOR]
+    case key
+    when nil, 'native'
+      MergeStrategy.strategy(nil)
+    when 'array'
+      MergeStrategy.strategy(:unique)
+    when 'deep', 'deeper'
+      merge = { 'strategy' => key == 'deep' ? 'reverse_deep' : 'unconstrained_deep' }
+      dm_options = @config[KEY_DEEP_MERGE_OPTIONS]
+      merge.merge!(dm_options) if dm_options
+      MergeStrategy.strategy(merge)
+    end
+  end
+end
+
+# @api private
+class HieraConfigV4 < HieraConfig
+  def self.config_type
+    return @@CONFIG_TYPE if class_variable_defined?(:@@CONFIG_TYPE)
+
+    tf = Types::TypeFactory
+    nes_t = Types::PStringType::NON_EMPTY
+
+    @@CONFIG_TYPE =
+      tf.struct({
+                  KEY_VERSION => tf.range(4, 4),
+                  tf.optional(KEY_DATADIR) => nes_t,
+                  tf.optional(KEY_HIERARCHY) => tf.array_of(tf.struct(
+                                                              KEY_BACKEND => nes_t,
+                                                              KEY_NAME => nes_t,
+                                                              tf.optional(KEY_DATADIR) => nes_t,
+                                                              tf.optional(KEY_PATH) => nes_t,
+                                                              tf.optional(KEY_PATHS) => tf.array_of(nes_t)
+                                                            ))
+                })
+  end
+
+  def create_configured_data_providers(lookup_invocation, parent_data_provider, _)
+    default_datadir = @config[KEY_DATADIR]
+    data_providers = {}
+
+    @config[KEY_HIERARCHY].each do |he|
+      name = he[KEY_NAME]
+      if data_providers.include?(name)
+        first_line = find_line_matching(/\s+name:\s+['"]?#{name}(?:[^\w]|$)/)
+        line = find_line_matching(/\s+name:\s+['"]?#{name}(?:[^\w]|$)/, first_line + 1) if first_line
+        unless line
+          line = first_line
+          first_line = nil
+        end
+        fail(Issues::HIERA_HIERARCHY_NAME_MULTIPLY_DEFINED, { :name => name, :first_line => first_line }, line)
+      end
+      original_paths = he[KEY_PATHS] || [he[KEY_PATH] || name]
+      datadir = @config_root + (he[KEY_DATADIR] || default_datadir)
+      provider_name = he[KEY_BACKEND]
+      data_providers[name] =
+        if %w[json yaml].include?(provider_name)
+          create_data_provider(name, parent_data_provider, KEY_DATA_HASH,
+                               "#{provider_name}_data", {},
+                               resolve_paths(datadir,
+                                             original_paths,
+                                             lookup_invocation,
+                                             @config_path.nil?,
+                                             ".#{provider_name}"))
+        elsif provider_name == 'hocon' && Puppet.features.hocon?
+          create_data_provider(name, parent_data_provider, KEY_DATA_HASH,
+                               'hocon_data', {},
+                               resolve_paths(datadir,
+                                             original_paths,
+                                             lookup_invocation,
+                                             @config_path.nil?,
+                                             '.conf'))
+        else
+          fail(Issues::HIERA_NO_PROVIDER_FOR_BACKEND,
+               { :name => provider_name },
+               find_line_matching(/[^\w]#{provider_name}(?:[^\w]|$)/))
+        end
+    end
+    data_providers.values
+  end
+
+  def validate_config(config, owner)
+    unless Puppet[:strict] == :off
+      Puppet.warn_once('deprecations', 'hiera.yaml',
+                       _("%{config_path}: Use of 'hiera.yaml' version 4 is deprecated. It should be converted to version 5") % { config_path: @config_path }, config_path.to_s)
+    end
+    config[KEY_DATADIR] ||= 'data'
+    config[KEY_HIERARCHY] ||= [{ KEY_NAME => 'common', KEY_BACKEND => 'yaml' }]
+    Types::TypeAsserter.assert_instance_of(["The Lookup Configuration at '%s'", @config_path], self.class.config_type, config)
+  end
+
+  def version
+    4
+  end
+end
+
+# @api private
+class HieraConfigV5 < HieraConfig
+  def self.config_type
+    return @@CONFIG_TYPE if class_variable_defined?(:@@CONFIG_TYPE_V5)
+
+    tf = Types::TypeFactory
+    nes_t = Types::PStringType::NON_EMPTY
+
+    # Validated using Ruby URI implementation
+    uri_t = Types::PStringType::NON_EMPTY
+
+    # The option name must start with a letter and end with a letter or digit. May contain underscore and dash.
+    option_name_t = tf.pattern(/\A[A-Za-z](:?[0-9A-Za-z_-]*[0-9A-Za-z])?\z/)
+
+    hierarchy_t =
+      tf.array_of(tf.struct(
+                    {
+                      KEY_NAME => nes_t,
+                      tf.optional(KEY_OPTIONS) => tf.hash_kv(option_name_t, tf.data),
+                      tf.optional(KEY_DATA_HASH) => nes_t,
+                      tf.optional(KEY_LOOKUP_KEY) => nes_t,
+                      tf.optional(KEY_V3_BACKEND) => nes_t,
+                      tf.optional(KEY_V4_DATA_HASH) => nes_t,
+                      tf.optional(KEY_DATA_DIG) => nes_t,
+                      tf.optional(KEY_PATH) => nes_t,
+                      tf.optional(KEY_PATHS) => tf.array_of(nes_t, tf.range(1, :default)),
+                      tf.optional(KEY_GLOB) => nes_t,
+                      tf.optional(KEY_GLOBS) => tf.array_of(nes_t, tf.range(1, :default)),
+                      tf.optional(KEY_URI) => uri_t,
+                      tf.optional(KEY_URIS) => tf.array_of(uri_t, tf.range(1, :default)),
+                      tf.optional(KEY_MAPPED_PATHS) => tf.array_of(nes_t, tf.range(3, 3)),
+                      tf.optional(KEY_DATADIR) => nes_t
+                    }
+                  ))
+
+    @@CONFIG_TYPE =
+      tf.struct({
+                  KEY_VERSION => tf.range(5, 5),
+                  tf.optional(KEY_DEFAULTS) => tf.struct(
+                    {
+                      tf.optional(KEY_DATA_HASH) => nes_t,
+                      tf.optional(KEY_LOOKUP_KEY) => nes_t,
+                      tf.optional(KEY_DATA_DIG) => nes_t,
+                      tf.optional(KEY_DATADIR) => nes_t,
+                      tf.optional(KEY_OPTIONS) => tf.hash_kv(option_name_t, tf.data),
+                    }
+                  ),
+                  tf.optional(KEY_HIERARCHY) => hierarchy_t,
+                  tf.optional(KEY_PLAN_HIERARCHY) => hierarchy_t,
+                  tf.optional(KEY_DEFAULT_HIERARCHY) => hierarchy_t
+                })
+  end
+
+  def create_configured_data_providers(lookup_invocation, parent_data_provider, use_default_hierarchy)
+    defaults = @config[KEY_DEFAULTS] || EMPTY_HASH
+    datadir = defaults[KEY_DATADIR] || 'data'
+
+    # Hashes enumerate their values in the order that the corresponding keys were inserted so it's safe to use
+    # a hash for the data_providers.
+    data_providers = {}
+
+    if @config.include?(KEY_DEFAULT_HIERARCHY)
+      unless parent_data_provider.is_a?(ModuleDataProvider)
+        fail(Issues::HIERA_DEFAULT_HIERARCHY_NOT_IN_MODULE, EMPTY_HASH, find_line_matching(/\s+default_hierarchy:/))
+      end
+    elsif use_default_hierarchy
+      return data_providers
+    end
+
+    compiler = Puppet.lookup(:pal_compiler) { nil }
+    config_key = if compiler.is_a?(Puppet::Pal::ScriptCompiler) && !@config[KEY_PLAN_HIERARCHY].nil?
+                   KEY_PLAN_HIERARCHY
+                 elsif use_default_hierarchy
+                   KEY_DEFAULT_HIERARCHY
+                 else
+                   KEY_HIERARCHY
+                 end
+    @config[config_key].each do |he|
+      name = he[KEY_NAME]
+      if data_providers.include?(name)
+        first_line = find_line_matching(/\s+name:\s+['"]?#{name}(?:[^\w]|$)/)
+        line = find_line_matching(/\s+name:\s+['"]?#{name}(?:[^\w]|$)/, first_line + 1) if first_line
+        unless line
+          line = first_line
+          first_line = nil
+        end
+        fail(Issues::HIERA_HIERARCHY_NAME_MULTIPLY_DEFINED, { :name => name, :first_line => first_line }, line)
+      end
+      function_kind = ALL_FUNCTION_KEYS.find { |key| he.include?(key) }
+      if function_kind.nil?
+        function_kind = FUNCTION_KEYS.find { |key| defaults.include?(key) }
+        function_name = defaults[function_kind]
+      else
+        function_name = he[function_kind]
+      end
+
+      entry_datadir = @config_root + (he[KEY_DATADIR] || datadir)
+      entry_datadir = Pathname(interpolate(entry_datadir.to_s, lookup_invocation, false))
+      location_key = LOCATION_KEYS.find { |key| he.include?(key) }
+      locations = []
+      Puppet.override(avoid_hiera_interpolation_errors: true) do
+        locations = case location_key
+                    when KEY_PATHS
+                      resolve_paths(entry_datadir, he[location_key], lookup_invocation, @config_path.nil?)
+                    when KEY_PATH
+                      resolve_paths(entry_datadir, [he[location_key]], lookup_invocation, @config_path.nil?)
+                    when KEY_GLOBS
+                      expand_globs(entry_datadir, he[location_key], lookup_invocation)
+                    when KEY_GLOB
+                      expand_globs(entry_datadir, [he[location_key]], lookup_invocation)
+                    when KEY_URIS
+                      expand_uris(he[location_key], lookup_invocation)
+                    when KEY_URI
+                      expand_uris([he[location_key]], lookup_invocation)
+                    when KEY_MAPPED_PATHS
+                      expand_mapped_paths(entry_datadir, he[location_key], lookup_invocation)
+                    else
+                      nil
+                    end
+      end
+      next if @config_path.nil? && !locations.nil? && locations.empty? # Default config and no existing paths found
+
+      options = he[KEY_OPTIONS] || defaults[KEY_OPTIONS]
+      options = options.nil? ? EMPTY_HASH : interpolate(options, lookup_invocation, false)
+      if function_kind == KEY_V3_BACKEND
+        v3options = { :datadir => entry_datadir.to_s }
+        options.each_pair { |k, v| v3options[k.to_sym] = v }
+        data_providers[name] =
+          create_hiera3_backend_provider(name,
+                                         function_name,
+                                         parent_data_provider,
+                                         entry_datadir,
+                                         locations,
+                                         {
+                                           :hierarchy =>
+                                             if locations.nil?
+                                               []
+                                             else
+                                               locations.map do |loc|
+                                                 path = loc.original_location
+                                                 path.end_with?(".#{function_name}") ? path[0..-(function_name.length + 2)] : path
+                                               end
+                                             end,
+                                           function_name.to_sym => v3options,
+                                           :backends => [function_name],
+                                           :logger => 'puppet'
+                                         })
+      else
+        data_providers[name] = create_data_provider(name, parent_data_provider, function_kind, function_name, options, locations)
+      end
+    end
+    data_providers.values
+  end
+
+  def has_default_hierarchy?
+    @config.include?(KEY_DEFAULT_HIERARCHY)
+  end
+
+  RESERVED_OPTION_KEYS = %w[path uri].freeze
+
+  DEFAULT_CONFIG_HASH = {
+    KEY_VERSION => 5,
+    KEY_DEFAULTS => {
+      KEY_DATADIR => 'data',
+      KEY_DATA_HASH => 'yaml_data'
+    },
+    KEY_HIERARCHY => [
+      {
+        KEY_NAME => 'Common',
+        KEY_PATH => 'common.yaml',
+      }
+    ]
+  }.freeze
+
+  def validate_config(config, owner)
+    config[KEY_DEFAULTS] ||= DEFAULT_CONFIG_HASH[KEY_DEFAULTS]
+    config[KEY_HIERARCHY] ||= DEFAULT_CONFIG_HASH[KEY_HIERARCHY]
+
+    Types::TypeAsserter.assert_instance_of(["The Lookup Configuration at '%s'", @config_path], self.class.config_type, config)
+    defaults = config[KEY_DEFAULTS]
+    validate_defaults(defaults) unless defaults.nil?
+    config[KEY_HIERARCHY].each { |he| validate_hierarchy(he, defaults, owner) }
+    if config.include?(KEY_PLAN_HIERARCHY)
+      config[KEY_PLAN_HIERARCHY].each { |he| validate_hierarchy(he, defaults, owner) }
+    end
+
+    if config.include?(KEY_DEFAULT_HIERARCHY)
+      unless owner.is_a?(ModuleDataProvider)
+        fail(Issues::HIERA_DEFAULT_HIERARCHY_NOT_IN_MODULE, EMPTY_HASH, find_line_matching(/(?:^|\s+)#{KEY_DEFAULT_HIERARCHY}:/))
+      end
+
+      config[KEY_DEFAULT_HIERARCHY].each { |he| validate_hierarchy(he, defaults, owner) }
+    end
+    config
+  end
+
+  def validate_hierarchy(he, defaults, owner)
+    name = he[KEY_NAME]
+    case ALL_FUNCTION_KEYS.count { |key| he.include?(key) }
+    when 0
+      if defaults.nil? || FUNCTION_KEYS.count { |key| defaults.include?(key) } == 0
+        fail(Issues::HIERA_MISSING_DATA_PROVIDER_FUNCTION, :name => name)
+      end
+    when 1
+      # OK
+    else
+      fail(Issues::HIERA_MULTIPLE_DATA_PROVIDER_FUNCTIONS, :name => name)
+    end
+
+    v3_backend = he[KEY_V3_BACKEND]
+    unless v3_backend.nil?
+      unless owner.is_a?(GlobalDataProvider)
+        fail(Issues::HIERA_V3_BACKEND_NOT_GLOBAL, EMPTY_HASH, find_line_matching(/\s+#{KEY_V3_BACKEND}:/))
+      end
+
+      if v3_backend == 'json' || v3_backend == 'yaml' || v3_backend == 'hocon' && Puppet.features.hocon?
+        # Disallow use of backends that have corresponding "data_hash" functions in version 5
+        fail(Issues::HIERA_V3_BACKEND_REPLACED_BY_DATA_HASH, { :function_name => v3_backend },
+             find_line_matching(/\s+#{KEY_V3_BACKEND}:\s*['"]?#{v3_backend}(?:[^\w]|$)/))
+      end
+    end
+
+    if LOCATION_KEYS.count { |key| he.include?(key) } > 1
+      fail(Issues::HIERA_MULTIPLE_LOCATION_SPECS, :name => name)
+    end
+
+    options = he[KEY_OPTIONS]
+    unless options.nil?
+      RESERVED_OPTION_KEYS.each do |key|
+        fail(Issues::HIERA_OPTION_RESERVED_BY_PUPPET, :key => key, :name => name) if options.include?(key)
+      end
+    end
+  end
+
+  def validate_defaults(defaults)
+    case FUNCTION_KEYS.count { |key| defaults.include?(key) }
+    when 0, 1
+      # OK
+    else
+      fail(Issues::HIERA_MULTIPLE_DATA_PROVIDER_FUNCTIONS_IN_DEFAULT)
+    end
+
+    options = defaults[KEY_OPTIONS]
+    unless options.nil?
+      RESERVED_OPTION_KEYS.each do |key|
+        fail(Issues::HIERA_DEFAULT_OPTION_RESERVED_BY_PUPPET, :key => key) if options.include?(key)
+      end
+    end
+  end
+
+  def version
+    5
+  end
+end
+end
+end