Merge pull request #9033 from tvpartytonight/PUP-11751-strictly-strict

(PUP-11751) Handle interpolation errors from hiera_config

Author: joshcooper

acceptance/tests/lookup/config5_interpolation.rb

@@ -10,7 +10,7 @@
                        # lookup in a masterless setup.
     'server'
 
-  pending_test('unexpected `::roles` returning undefined here, but the test passes when strict=warning')
+  # pending_test('unexpected `::roles` returning undefined here, but the test passes when strict=warning')
   # Should revisit this in PUP-11751
 
   app_type        = File.basename(__FILE__, '.*')

lib/puppet/parser/scope.rb

@@ -535,7 +535,12 @@ def variable_not_found(name, reason=nil)
         Puppet.warn_once(UNDEFINED_VARIABLES_KIND, _("Variable: %{name}") % { name: name },
         _("Undefined variable '%{name}'; %{reason}") % { name: name, reason: reason } )
       when :error
-        raise ArgumentError, _("Undefined variable '%{name}'; %{reason}") % { name: name, reason: reason }
+        if Puppet.lookup(:avoid_hiera_interpolation_errors){false}
+          Puppet.warn_once(UNDEFINED_VARIABLES_KIND, _("Variable: %{name}") % { name: name },
+          _("Interpolation failed with '%{name}', but compilation continuing; %{reason}") % { name: name, reason: reason } )
+        else
+          raise ArgumentError, _("Undefined variable '%{name}'; %{reason}") % { name: name, reason: reason }
+        end
       end
     end
     nil

lib/puppet/pops/lookup/hiera_config.rb

@@ -252,7 +252,7 @@ def scope_interpolations_stable?(lookup_invocation)
       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) }
@@ -633,23 +633,26 @@ def create_configured_data_providers(lookup_invocation, parent_data_provider, us
       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]

spec/unit/functions/lookup_spec.rb

@@ -286,7 +286,6 @@ def explain(key, options = {})
             YAML
 
           it 'fails and reports error' do
-            Puppet[:strict] = :error
             expect { lookup('a') }.to raise_error(
               "'default_hierarchy' is only allowed in the module layer (file: #{code_dir}/hiera.yaml, line: 5)")
           end
@@ -302,8 +301,7 @@ def explain(key, options = {})
             YAML
 
           it 'fails and reports errors when strict == error' do
-            Puppet[:strict] = :error
-            expect { lookup('a') }.to raise_error("Undefined variable '::nonesuch' (file: #{code_dir}/hiera.yaml, line: 4)")
+            expect { lookup('a') }.to raise_error("Function lookup() did not find a value for the name 'a'")
           end
         end
 
@@ -316,7 +314,6 @@ def explain(key, options = {})
             YAML
 
           it 'fails and reports errors when strict == error' do
-            Puppet[:strict] = :error
             expect { lookup('a') }.to raise_error("Interpolation using method syntax is not allowed in this context (file: #{code_dir}/hiera.yaml)")
           end
         end
@@ -604,9 +601,9 @@ def explain(key, options = {})
       context 'using global variable reference' do
         let(:data_path) { 'x%{::var.sub}.yaml' }
 
-        it 'raises an error when reloads the configuration if interpolating undefined values' do
+        it 'does not raise an error when reloads the configuration if interpolating undefined values' do
           collect_notices("notice('success')") do |scope|
-            expect { lookup_func.call(scope, 'y') }.to raise_error(/Undefined variable '::var'/)
+            expect { lookup_func.call(scope, 'y') }.to_not raise_error
           end
         end