puppet 6.0.5-x64-mingw32 → 8.8.1-x64-mingw32

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'data_dig_function_provider'
 require_relative 'data_hash_function_provider'
 require_relative 'lookup_key_function_provider'
@@ -5,7 +7,6 @@ require_relative 'location_resolver'
 
 module Puppet::Pops
 module Lookup
-
 # @api private
 class ScopeLookupCollectingInvocation < Invocation
   def initialize(scope)
@@ -41,21 +42,22 @@ class HieraConfig
 
   CONFIG_FILE_NAME = 'hiera.yaml'
 
-  KEY_NAME = 'name'.freeze
-  KEY_VERSION = 'version'.freeze
-  KEY_DATADIR = 'datadir'.freeze
-  KEY_DEFAULT_HIERARCHY = 'default_hierarchy'.freeze
-  KEY_HIERARCHY = 'hierarchy'.freeze
-  KEY_LOGGER = 'logger'.freeze
-  KEY_OPTIONS = 'options'.freeze
-  KEY_PATH = 'path'.freeze
-  KEY_PATHS = 'paths'.freeze
-  KEY_MAPPED_PATHS = 'mapped_paths'.freeze
-  KEY_GLOB = 'glob'.freeze
-  KEY_GLOBS = 'globs'.freeze
-  KEY_URI = 'uri'.freeze
-  KEY_URIS = 'uris'.freeze
-  KEY_DEFAULTS = 'defaults'.freeze
+  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
@@ -63,8 +65,8 @@ class HieraConfig
   KEY_V3_LOOKUP_KEY = V3LookupKeyFunctionProvider::TAG
   KEY_V3_BACKEND = V3BackendFunctionProvider::TAG
   KEY_V4_DATA_HASH = V4DataHashFunctionProvider::TAG
-  KEY_BACKEND = 'backend'.freeze
-  KEY_EXTENSION = 'extension'.freeze
+  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]
@@ -82,20 +84,19 @@ class HieraConfig
   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 })
+                       _("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
-    )
+                      {
+                        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)
@@ -104,10 +105,10 @@ class HieraConfig
   end
 
   def self.symkeys_to_string(struct)
-    case(struct)
+    case struct
     when Hash
       map = {}
-      struct.each_pair {|k,v| map[ k.is_a?(Symbol) ? k.to_s : k] = symkeys_to_string(v) }
+      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) }
@@ -161,11 +162,12 @@ class HieraConfig
     else
       issue = Issues::HIERA_UNSUPPORTED_VERSION
       raise Puppet::DataBinding::LookupError.new(
-        issue.format(:version => version),  config_path, nil, nil, nil, issue.issue_code)
+        issue.format(:version => version), config_path, nil, nil, nil, issue.issue_code
+      )
     end
   end
 
-  attr_reader :config_path, :version
+  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.
@@ -182,7 +184,8 @@ class HieraConfig
 
   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)
+      issue.format(args.merge(:label => self)), @config_path, line, nil, nil, issue.issue_code
+    )
   end
 
   def has_default_hierarchy?
@@ -209,7 +212,7 @@ class HieraConfig
         # 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 = $1
+          var = ::Regexp.last_match(1)
           fail(Issues::HIERA_UNDEFINED_VARIABLE, { :name => var }, find_line_matching(/%\{['"]?#{var}['"]?}/))
         end
         raise e
@@ -225,16 +228,18 @@ class HieraConfig
     File.foreach(@config_path) do |line|
       line_number += 1
       next if line_number < start_line
+
       quote = nil
-      stripped = ''
+      stripped = ''.dup
       line.each_codepoint do |cp|
-        if cp == 0x22 || cp == 0x27 # double or single quote
+        case cp
+        when 0x22, 0x27 # double or single quote
           if quote == cp
             quote = nil
           elsif quote.nil?
             quote = cp
           end
-        elsif cp == 0x23 # unquoted hash mark
+        when 0x23 # unquoted hash mark
           break
         end
         stripped << cp
@@ -251,7 +256,7 @@ class HieraConfig
       scope = lookup_invocation.scope
       lookup_invocation.without_explain do
         @scope_interpolations.all? do |key, root_key, segments, old_value|
-          value = scope[root_key]
+          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) }
@@ -281,8 +286,9 @@ class HieraConfig
   end
 
   def create_hiera3_backend_provider(name, backend, parent_data_provider, datadir, paths, hiera3_config)
-    # Custom backend. Hiera v3 must be installed, it's logger configured, and it must be made aware of the loaded config
-    require 'hiera'
+    # 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
@@ -292,19 +298,17 @@ class HieraConfig
           hiera3_config[key] = val
         end
       end
+    elsif hiera3_config.include?(KEY_LOGGER)
+      Hiera.logger = hiera3_config[KEY_LOGGER].to_s
     else
-      if hiera3_config.include?(KEY_LOGGER)
-        Hiera.logger = hiera3_config[KEY_LOGGER].to_s
-      else
-        Hiera.logger = 'puppet'
-      end
+      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.new do |data, key, scope, extra_data, context|
+        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?
@@ -339,22 +343,24 @@ class HieraConfig
   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'.freeze
-  KEY_MERGE_BEHAVIOR = 'merge_behavior'.freeze
-  KEY_DEEP_MERGE_OPTIONS = 'deep_merge_options'.freeze
+  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_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'),
@@ -370,7 +376,8 @@ class HieraConfigV3 < HieraConfig
         Hiera::Scope.new(scope),
         lookup_invocation.override_values,
         lookup_invocation.default_values,
-        lookup_invocation.explainer)
+        lookup_invocation.explainer
+      )
     end
 
     default_datadir = File.join(Puppet.settings[:codedir], 'environments', '%{::environment}', 'hieradata')
@@ -401,30 +408,38 @@ class HieraConfigV3 < HieraConfig
         ext = ".#{ext}"
       end
       paths = resolve_paths(datadir, original_paths, lookup_invocation, @config_path.nil?, ext)
-      data_providers[backend] = case
-      when backend == 'json', backend == 'yaml'
-        create_data_provider(backend, parent_data_provider, KEY_V3_DATA_HASH, "#{backend}_data", { KEY_DATADIR => datadir }, paths)
-      when backend == 'hocon' && Puppet.features.hocon?
-        create_data_provider(backend, parent_data_provider, KEY_V3_DATA_HASH, 'hocon_data', { KEY_DATADIR => datadir }, paths)
-      when 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
+      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),
+  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)
+                       _("%{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]
@@ -432,7 +447,7 @@ class HieraConfigV3 < HieraConfig
     config[KEY_MERGE_BEHAVIOR] ||= DEFAULT_CONFIG_HASH[KEY_MERGE_BEHAVIOR]
     config[KEY_DEEP_MERGE_OPTIONS] ||= {}
 
-    backends = [ config[KEY_BACKENDS] ].flatten
+    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
@@ -473,20 +488,22 @@ end
 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)
-      ))
-    })
+    @@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, _)
@@ -507,16 +524,28 @@ class HieraConfigV4 < HieraConfig
       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] = case
-      when provider_name == 'json', provider_name == 'yaml'
-        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}"))
-      when 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
+      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
@@ -524,7 +553,7 @@ class HieraConfigV4 < HieraConfig
   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)
+                       _("%{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' }]
@@ -540,6 +569,7 @@ end
 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
 
@@ -549,38 +579,43 @@ class HieraConfigV5 < HieraConfig
     # 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_DEFAULT_HIERARCHY) => hierarchy_t
-    })
+    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)
@@ -599,7 +634,15 @@ class HieraConfigV5 < HieraConfig
       return data_providers
     end
 
-    @config[use_default_hierarchy ? KEY_DEFAULT_HIERARCHY : KEY_HIERARCHY].each do |he|
+    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]|$)/)
@@ -621,40 +664,54 @@ class HieraConfigV5 < HieraConfig
       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 = 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
+      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)
+      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 =>
-            locations.nil? ? [] : locations.map do |loc|
-              path = loc.original_location
-              path.end_with?(".#{function_name}") ? path[0..-(function_name.length + 2)] : path
-            end,
-          function_name.to_sym => v3options,
-          :backends => [ function_name ],
-          :logger => 'puppet'
-        })
+        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
@@ -666,7 +723,7 @@ class HieraConfigV5 < HieraConfig
     @config.include?(KEY_DEFAULT_HIERARCHY)
   end
 
-  RESERVED_OPTION_KEYS = ['path', 'uri'].freeze
+  RESERVED_OPTION_KEYS = %w[path uri].freeze
 
   DEFAULT_CONFIG_HASH = {
     KEY_VERSION => 5,
@@ -690,11 +747,15 @@ class HieraConfigV5 < HieraConfig
     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
@@ -718,10 +779,11 @@ class HieraConfigV5 < HieraConfig
       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?
+
+      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]|$)/))
+             find_line_matching(/\s+#{KEY_V3_BACKEND}:\s*['"]?#{v3_backend}(?:[^\w]|$)/))
       end
     end