hiera 3.0.6-x64-mingw32 → 3.1.0-x64-mingw32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91c3060292dceb13da5b99fe4189aee0b395a23e
-  data.tar.gz: 5abce3cf33535c571d35114d50af19942a757dcd
+  metadata.gz: d13558560b89acbbd6720376162e7b5e7352c541
+  data.tar.gz: 6fd01d4e6590e18449bc6a70a43c46288e55e7ce
 SHA512:
-  metadata.gz: 6d07c5edaced3dc0d2d29316aa6009b937194c2fa992702a828eeb6c4e5942b8dd87535c9e73a6556779207d131603f7de243dfcad2a1d379e2858e8bf857597
-  data.tar.gz: 536c50491c59fa5f87235eaedf0bf73c89311bd890b8015e853d036b1c88f3e46860d8ff3490fe08133695fe38f1a7c06c30e0658ffb3d8b99e8fdcb759b5b27
+  metadata.gz: 69785d29b404ab6eca305dfa70167e8efdf7f72dc806938eb852bac48541118e197a857b6c59496583bd48c07816a116721d286738b2692b07863bbf96f62794
+  data.tar.gz: 0a5dfdc722e1c800339811f74a6e76354b380681f6d727f33285e383ff2a049bac1acaaface1705afea3e8c4e3f8cf205f7d935157f95419962593646877d39c

data/README.md

@@ -210,7 +210,7 @@ require 'hiera'
 require 'puppet'
 
 # load the facts for example.com
-scope = YAML.load_file("/opt/puppetlabs/puppet/cache/yaml/facts/example.com.yaml").values
+scope = YAML.load_file("/opt/puppetlabs/puppet/cache/yaml/facts/example.com.yaml")
 
 # create a new instance based on config file
 hiera = Hiera.new(:config => "/etc/puppetlabs/code/hiera.yaml")

data/lib/hiera/backend.rb

@@ -2,7 +2,7 @@ require 'hiera/util'
 require 'hiera/interpolate'
 
 begin
-  require 'deep_merge'
+  require 'deep_merge/rails_compat'
 rescue LoadError
 end
 
@@ -42,7 +42,7 @@ class Hiera
                 "datadir for #{backend} cannot be an array")
         end
 
-        parse_string(dir, scope)
+        interpolate_config(dir, scope, nil)
       end
 
       # Finds the path to a datafile based on the Backend#datadir
@@ -88,7 +88,7 @@ class Hiera
         hierarchy.insert(0, override) if override
 
         hierarchy.flatten.map do |source|
-          source = parse_string(source, scope, {}, :order_override => override)
+          source = interpolate_config(source, scope, override)
           yield(source) unless source == "" or source =~ /(^\/|\/\/|\/$)/
         end
       end
@@ -186,10 +186,11 @@ class Hiera
       #  :merge_behavior: {:native|:deep|:deeper}
       #
       # Deep merge options use the Hash utility function provided by [deep_merge](https://github.com/danielsdeleo/deep_merge)
+      # It uses the compatibility mode [deep_merge](https://github.com/danielsdeleo/deep_merge#using-deep_merge-in-rails)
       #
       #  :native => Native Hash.merge
-      #  :deep   => Use Hash.deep_merge
-      #  :deeper => Use Hash.deep_merge!
+      #  :deep   => Use Hash.deeper_merge
+      #  :deeper => Use Hash.deeper_merge!
       #
       # @param left [Hash] left side of the merge
       # @param right [Hash] right side of the merge
@@ -208,9 +209,9 @@ class Hiera
 
         case behavior
         when :deeper,'deeper'
-          left.deep_merge!(right, options)
+          left.deeper_merge!(right, options)
         when :deep,'deep'
-          left.deep_merge(right, options)
+          left.deeper_merge(right, options)
         else # Native and undefined
           left.merge(right)
         end
@@ -263,8 +264,14 @@ class Hiera
             backend = (@backends[backend] ||= find_backend(backend_constant))
             found_in_backend = false
             new_answer = catch(:no_such_key) do
-              value = backend.lookup(segments[0], scope, order_override, resolution_type, context)
-              value = qualified_lookup(subsegments, value) unless subsegments.nil?
+              if subsegments.nil? 
+                value = backend.lookup(key, scope, order_override, resolution_type, context)
+              elsif backend.respond_to?(:lookup_with_segments)
+                value = backend.lookup_with_segments(segments, scope, order_override, resolution_type, context)
+              else
+                value = backend.lookup(segments[0], scope, order_override, resolution_type, context)
+                value = qualified_lookup(subsegments, value) unless subsegments.nil?
+              end
               found_in_backend = true
               value
             end
@@ -320,6 +327,20 @@ class Hiera
         return backend.method(:lookup).arity == 4 ? Backend1xWrapper.new(backend) : backend
       end
       private :find_backend
+
+      def interpolate_config(entry, scope, override)
+        if @config_lookup_context.nil?
+          @config_lookup_context = { :is_interpolate_config => true, :order_override => override, :recurse_guard => Hiera::RecursiveGuard.new }
+          begin
+            Hiera::Interpolate.interpolate(entry, scope, {}, @config_lookup_context)
+          ensure
+            @config_lookup_context = nil
+          end
+        else
+          # Nested call (will happen when interpolate method 'hiera' is used)
+          Hiera::Interpolate.interpolate(entry, scope, {}, @config_lookup_context.merge(:order_override => override))
+        end
+      end
     end
   end
 end

data/lib/hiera/config.rb

@@ -53,6 +53,7 @@ class Hiera::Config
       when :deep,'deep',:deeper,'deeper'
         begin
           require "deep_merge"
+          require "deep_merge/rails_compat"
         rescue LoadError
           raise Hiera::Error, "Must have 'deep_merge' gem installed for the configured merge_behavior."
         end
@@ -74,7 +75,7 @@ class Hiera::Config
         begin
           require "hiera/backend/#{backend.downcase}_backend"
         rescue LoadError => e
-          Hiera.warn "Cannot load backend #{backend}: #{e}"
+          raise "Cannot load backend #{backend}: #{e}"
         end
       end
     end

data/lib/hiera/interpolate.rb

@@ -21,7 +21,7 @@ class Hiera::Interpolate
 
           # Get interp method in case we are aliasing
           if data.is_a?(String) && (match = data.match(INTERPOLATION))
-            interpolate_method, key = get_interpolation_method_and_key(data)
+            interpolate_method, key = get_interpolation_method_and_key(data, new_context)
           else
             interpolate_method = nil
           end
@@ -44,8 +44,15 @@ class Hiera::Interpolate
     def do_interpolation(data, scope, extra_data, context)
       if data.is_a?(String) && (match = data.match(INTERPOLATION))
         interpolation_variable = match[1]
+
+        # HI-494
+        case interpolation_variable.strip
+        when '', '::'
+          return ''
+        end
+
         context[:recurse_guard].check(interpolation_variable) do
-          interpolate_method, key = get_interpolation_method_and_key(data)
+          interpolate_method, key = get_interpolation_method_and_key(data, context)
           interpolated_data = send(interpolate_method, data, key, scope, extra_data, context)
 
           # Halt recursion if we encounter a literal.
@@ -59,8 +66,9 @@ class Hiera::Interpolate
     end
     private :do_interpolation
 
-    def get_interpolation_method_and_key(data)
+    def get_interpolation_method_and_key(data, context)
       if (match = data.match(METHOD_INTERPOLATION))
+        Hiera.warn('Use of interpolation methods in hiera configuration file is deprecated') if context[:is_interpolate_config]
         case match[1]
         when 'hiera' then [:hiera_interpolate, match[2]]
         when 'scope' then [:scope_interpolate, match[2]]

data/lib/hiera/recursive_guard.rb

@@ -10,7 +10,7 @@ class Hiera::RecursiveGuard
 
   def check(value, &block)
     if @seen.include?(value)
-      raise Hiera::InterpolationLoop, "Detected in [#{@seen.join(', ')}]"
+      raise Hiera::InterpolationLoop, "Lookup recursion detected in [#{@seen.join(', ')}]"
     end
     @seen.push(value)
     ret = yield

data/lib/hiera/version.rb

@@ -7,7 +7,7 @@
 
 
 class Hiera
-  VERSION = "3.0.6"
+  VERSION = "3.1.0"
 
   ##
   # version is a public API method intended to always provide a fast and

data/spec/unit/backend_spec.rb

@@ -11,6 +11,15 @@ class Hiera
   end
 
   describe Backend do
+    describe "loading non existing backend" do
+      it "fails if a backend cannot be loaded" do
+        Config.load({:datadir => "/tmp/%{interpolate}", :backends => ['bogus']})
+        expect do
+          Config.load_backends
+        end.to raise_error(/Cannot load backend bogus/)
+      end
+    end
+
     describe "#datadir" do
       it "interpolates any values in the configured value" do
         Config.load({:rspec => {:datadir => "/tmp/%{interpolate}"}})
@@ -92,8 +101,8 @@ class Hiera
       end
 
       it "parses the names of the hierarchy levels using the given scope" do
-        Backend.expects(:parse_string).with('nodes/%{::trusted.certname}', {:rspec => :tests}, {}, {:order_override => nil})
-        Backend.expects(:parse_string).with('common', {:rspec => :tests}, {}, {:order_override => nil})
+        Backend.expects(:interpolate_config).with('nodes/%{::trusted.certname}', {:rspec => :tests}, nil)
+        Backend.expects(:interpolate_config).with('common', {:rspec => :tests}, nil)
         Backend.datasources({:rspec => :tests}) { }
       end
 
@@ -248,7 +257,7 @@ class Hiera
         input = "test_%{first}_test"
         expect do
           Backend.parse_string(input, scope)
-        end.to raise_error Hiera::InterpolationLoop, "Detected in [first, second]"
+        end.to raise_error Hiera::InterpolationLoop, "Lookup recursion detected in [first, second]"
       end
 
       it "replaces repeated occurances of the same lookup" do
@@ -713,30 +722,30 @@ class Hiera
 
       it "uses deep_merge! when configured with :merge_behavior => :deeper" do
         Config.load({:merge_behavior => :deeper})
-        Hash.any_instance.expects('deep_merge!').with({"b" => "bnswer"}, {}).returns({"a" => "answer", "b" => "bnswer"})
+        Hash.any_instance.expects('deeper_merge!').with({"b" => "bnswer"}, {}).returns({"a" => "answer", "b" => "bnswer"})
         expect(Backend.merge_answer({"a" => "answer"},{"b" => "bnswer"})).to eq({"a" => "answer", "b" => "bnswer"})
       end
 
       it "uses deep_merge when configured with :merge_behavior => :deep" do
         Config.load({:merge_behavior => :deep})
-        Hash.any_instance.expects('deep_merge').with({"b" => "bnswer"}, {}).returns({"a" => "answer", "b" => "bnswer"})
+        Hash.any_instance.expects('deeper_merge').with({"b" => "bnswer"}, {}).returns({"a" => "answer", "b" => "bnswer"})
         expect(Backend.merge_answer({"a" => "answer"},{"b" => "bnswer"})).to eq({"a" => "answer", "b" => "bnswer"})
       end
 
       it "disregards configuration when 'merge' parameter is given as a Hash" do
         Config.load({:merge_behavior => :deep})
-        Hash.any_instance.expects('deep_merge!').with({"b" => "bnswer"}, {}).returns({"a" => "answer", "b" => "bnswer"})
+        Hash.any_instance.expects('deeper_merge!').with({"b" => "bnswer"}, {}).returns({"a" => "answer", "b" => "bnswer"})
         expect(Backend.merge_answer({"a" => "answer"},{"b" => "bnswer"}, {:behavior => 'deeper' })).to eq({"a" => "answer", "b" => "bnswer"})
       end
 
       it "propagates deep merge options when given Hash 'merge' parameter" do
-        Hash.any_instance.expects('deep_merge!').with({"b" => "bnswer"}, { :knockout_prefix => '-' }).returns({"a" => "answer", "b" => "bnswer"})
+        Hash.any_instance.expects('deeper_merge!').with({"b" => "bnswer"}, { :knockout_prefix => '-' }).returns({"a" => "answer", "b" => "bnswer"})
         expect(Backend.merge_answer({"a" => "answer"},{"b" => "bnswer"}, {:behavior => 'deeper', :knockout_prefix => '-'})).to eq({"a" => "answer", "b" => "bnswer"})
       end
 
       it "passes Config[:deep_merge_options] into calls to deep_merge" do
         Config.load({:merge_behavior => :deep, :deep_merge_options => { :knockout_prefix => '-' } })
-        Hash.any_instance.expects('deep_merge').with({"b" => "bnswer"}, {:knockout_prefix => '-'}).returns({"a" => "answer", "b" => "bnswer"})
+        Hash.any_instance.expects('deeper_merge').with({"b" => "bnswer"}, {:knockout_prefix => '-'}).returns({"a" => "answer", "b" => "bnswer"})
         expect(Backend.merge_answer({"a" => "answer"},{"b" => "bnswer"})).to eq({"a" => "answer", "b" => "bnswer"})
       end
     end

data/spec/unit/fixtures/interpolate/config/hiera.yaml

@@ -4,3 +4,4 @@
 :hierarchy:
   - recursive
   - niltest
+  - empty_%{}inter%{::}polation

data/spec/unit/fixtures/interpolate/config/hiera_iplm_hiera.yaml

@@ -0,0 +1,6 @@
+:backends:
+  - json
+
+:hierarchy:
+  - role
+  - "%{hiera('role')}"

data/spec/unit/fixtures/interpolate/config/hiera_iplm_hiera_bad.yaml

@@ -0,0 +1,5 @@
+:backends:
+  - yaml
+
+:hierarchy:
+  - "%{hiera('role')}"

data/spec/unit/fixtures/interpolate/data/empty_interpolation.yaml

@@ -0,0 +1,6 @@
+empty_interpolation: 'clown%{}shoe'
+escaped_empty_interpolation: 'clown%%{}{shoe}s'
+only_empty_interpolation: '%{}'
+empty_namespace: '%{::}'
+whitespace1: '%{ :: }'
+whitespace2: '%{   }'

data/spec/unit/fixtures/interpolate/data/frontend.json

@@ -0,0 +1 @@
+{ "foo": "Foo" }

data/spec/unit/fixtures/interpolate/data/role.json

@@ -0,0 +1 @@
+{ "role": "frontend" }

data/spec/unit/interpolate_spec.rb

@@ -10,7 +10,7 @@ describe "Hiera" do
       hiera = Hiera.new(:config => File.join(fixtures, 'config', 'hiera.yaml'))
       expect do
         hiera.lookup('foo', nil, {})
-      end.to raise_error Hiera::InterpolationLoop, 'Detected in [hiera("bar"), hiera("foo")]'
+      end.to raise_error Hiera::InterpolationLoop, 'Lookup recursion detected in [hiera("bar"), hiera("foo")]'
     end
   end
 
@@ -24,6 +24,46 @@ describe "Hiera" do
     end
   end
 
+  context "when there are empty interpolations %{} in data" do
+    let(:fixtures) { File.join(HieraSpec::FIXTURE_DIR, 'interpolate') }
+
+    it 'should should produce an empty string for the interpolation' do
+      Hiera::Util.expects(:var_dir).at_least_once.returns(File.join(fixtures, 'data'))
+      hiera = Hiera.new(:config => File.join(fixtures, 'config', 'hiera.yaml'))
+      expect(hiera.lookup('empty_interpolation', nil, {})).to eq('clownshoe')
+    end
+
+    it 'the empty interpolation can be escaped' do
+      Hiera::Util.expects(:var_dir).at_least_once.returns(File.join(fixtures, 'data'))
+      hiera = Hiera.new(:config => File.join(fixtures, 'config', 'hiera.yaml'))
+      expect(hiera.lookup('escaped_empty_interpolation', nil, {})).to eq('clown%{shoe}s')
+    end
+
+    it 'the value can consist of only an empty escape' do
+      Hiera::Util.expects(:var_dir).at_least_once.returns(File.join(fixtures, 'data'))
+      hiera = Hiera.new(:config => File.join(fixtures, 'config', 'hiera.yaml'))
+      expect(hiera.lookup('only_empty_interpolation', nil, {})).to eq('')
+    end
+
+    it 'the value can consist of an empty namespace %{::}' do
+      Hiera::Util.expects(:var_dir).at_least_once.returns(File.join(fixtures, 'data'))
+      hiera = Hiera.new(:config => File.join(fixtures, 'config', 'hiera.yaml'))
+      expect(hiera.lookup('empty_namespace', nil, {})).to eq('')
+    end
+
+    it 'the value can consist of whitespace %{ :: }' do
+      Hiera::Util.expects(:var_dir).at_least_once.returns(File.join(fixtures, 'data'))
+      hiera = Hiera.new(:config => File.join(fixtures, 'config', 'hiera.yaml'))
+      expect(hiera.lookup('whitespace1', nil, {})).to eq('')
+    end
+
+    it 'the value can consist of whitespace %{  }' do
+      Hiera::Util.expects(:var_dir).at_least_once.returns(File.join(fixtures, 'data'))
+      hiera = Hiera.new(:config => File.join(fixtures, 'config', 'hiera.yaml'))
+      expect(hiera.lookup('whitespace2', nil, {})).to eq('')
+    end
+  end
+
   context "when doing interpolation with override" do
     let(:fixtures) { File.join(HieraSpec::FIXTURE_DIR, 'override') }
 
@@ -33,4 +73,27 @@ describe "Hiera" do
       expect(hiera.lookup('foo', nil, {}, 'alternate')).to eq('alternate')
     end
   end
+
+  context 'when doing interpolation in config file' do
+    let(:fixtures) { File.join(HieraSpec::FIXTURE_DIR, 'interpolate') }
+
+    it 'should allow and resolve a correctly configured interpolation using "hiera" method' do
+      Hiera::Util.expects(:var_dir).at_least_once.returns(File.join(fixtures, 'data'))
+      hiera = Hiera.new(:config => File.join(fixtures, 'config', 'hiera_iplm_hiera.yaml'))
+      expect(hiera.lookup('foo', nil, {})).to eq('Foo')
+    end
+
+    it 'should detect interpolation recursion when using "hiera" method' do
+      Hiera::Util.expects(:var_dir).at_least_once.returns(File.join(fixtures, 'data'))
+      hiera = Hiera.new(:config => File.join(fixtures, 'config', 'hiera_iplm_hiera_bad.yaml'))
+      expect{ hiera.lookup('foo', nil, {}) }.to raise_error(Hiera::InterpolationLoop, "Lookup recursion detected in [hiera('role')]")
+    end
+
+    it 'should issue warning when interpolation methods are used' do
+      Hiera.expects(:warn).with('Use of interpolation methods in hiera configuration file is deprecated').at_least_once
+      Hiera::Util.expects(:var_dir).at_least_once.returns(File.join(fixtures, 'data'))
+      hiera = Hiera.new(:config => File.join(fixtures, 'config', 'hiera_iplm_hiera.yaml'))
+      expect(hiera.lookup('foo', nil, {})).to eq('Foo')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hiera
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 3.1.0
 platform: x64-mingw32
 authors:
 - Puppet Labs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-21 00:00:00.000000000 Z
+date: 2016-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -73,8 +73,13 @@ files:
 - spec/unit/fallback_logger_spec.rb
 - spec/unit/filecache_spec.rb
 - spec/unit/fixtures/interpolate/config/hiera.yaml
+- spec/unit/fixtures/interpolate/config/hiera_iplm_hiera.yaml
+- spec/unit/fixtures/interpolate/config/hiera_iplm_hiera_bad.yaml
+- spec/unit/fixtures/interpolate/data/empty_interpolation.yaml
+- spec/unit/fixtures/interpolate/data/frontend.json
 - spec/unit/fixtures/interpolate/data/niltest.yaml
 - spec/unit/fixtures/interpolate/data/recursive.yaml
+- spec/unit/fixtures/interpolate/data/role.json
 - spec/unit/fixtures/override/config/hiera.yaml
 - spec/unit/fixtures/override/data/alternate.yaml
 - spec/unit/fixtures/override/data/common.yaml
@@ -116,8 +121,13 @@ test_files:
 - spec/unit/fallback_logger_spec.rb
 - spec/unit/filecache_spec.rb
 - spec/unit/fixtures/interpolate/config/hiera.yaml
+- spec/unit/fixtures/interpolate/config/hiera_iplm_hiera.yaml
+- spec/unit/fixtures/interpolate/config/hiera_iplm_hiera_bad.yaml
+- spec/unit/fixtures/interpolate/data/empty_interpolation.yaml
+- spec/unit/fixtures/interpolate/data/frontend.json
 - spec/unit/fixtures/interpolate/data/niltest.yaml
 - spec/unit/fixtures/interpolate/data/recursive.yaml
+- spec/unit/fixtures/interpolate/data/role.json
 - spec/unit/fixtures/override/config/hiera.yaml
 - spec/unit/fixtures/override/data/alternate.yaml
 - spec/unit/fixtures/override/data/common.yaml