puppet 3.8.7 → 4.0.0.rc1

data/spec/unit/functions/hiera_spec.rb

@@ -22,38 +22,32 @@ describe 'when calling' do
     end
 
     it 'should use the priority resolution_type' do
-      Hiera.any_instance.expects(:lookup).with { |*args| args[4].should be(:priority) }.returns('foo_result')
+      Hiera.any_instance.expects(:lookup).with { |*args| expect(args[4]).to be(:priority) }.returns('foo_result')
       expect(hiera.call(scope, 'key')).to eql('foo_result')
     end
 
+    it 'should propagate optional default' do
+      dflt = 'the_default'
+      Hiera.any_instance.expects(:lookup).with { |*args| expect(args[1]).to be(dflt) }.returns('foo_result')
+      expect(hiera.call(scope, 'key', dflt)).to eql('foo_result')
+    end
+
     it 'should propagate optional override' do
       ovr = 'the_override'
-      Hiera.any_instance.expects(:lookup).with { |*args| args[3].should be(ovr) }.returns('foo_result')
+      Hiera.any_instance.expects(:lookup).with { |*args| expect(args[3]).to be(ovr) }.returns('foo_result')
       expect(hiera.call(scope, 'key', nil, ovr)).to eql('foo_result')
     end
 
-    it 'should return default value nil when key is not found' do
-       expect(hiera.call(scope, 'foo', nil)).to be_nil
-    end
-
-    it "should return default value '' when key is not found" do
-      expect(hiera.call(scope, 'foo', '')).to eq('')
-    end
-
     it 'should use default block' do
       #expect(hiera.call(scope, 'foo', lambda_1(scope, loader) { |k| "default for key '#{k}'" })).to eql("default for key 'foo'")
       expect(hiera.call(scope, 'foo') { |k| "default for key '#{k}'" }).to eql("default for key 'foo'")
     end
 
-    # Test disabled since it assumes that Yaml_backend returns nil when a key is not found and that this
-    # triggers use of default. This changes in Hiera 2.0 so that the backend throws a :no_such_key exception.
-    # Changing that here will invalidate tests using hiera stable.
-    #
-    # it 'should propagate optional override when combined with default block' do
-    #   ovr = 'the_override'
-    #   Hiera::Backend::Yaml_backend.any_instance.expects(:lookup).with { |*args| args[2].should be(ovr) }
-    #   expect(hiera.call(scope, 'foo', ovr) { |k| "default for key '#{k}'" }).to eql("default for key 'foo'")
-    # end
+    it 'should propagate optional override when combined with default block' do
+      ovr = {}
+      Hiera::Backend::Yaml_backend.any_instance.expects(:lookup).with { |*args| expect(args[2]).to be(ovr) }.returns(nil)
+      expect(hiera.call(scope, 'foo.bar', ovr) { |k| "default for key '#{k}'" }).to eql("default for key 'foo.bar'")
+    end
   end
 
   context 'hiera_array' do
@@ -69,7 +63,7 @@ describe 'when calling' do
     end
 
     it 'should use the array resolution_type' do
-      Hiera.any_instance.expects(:lookup).with { |*args| args[4].should be(:array) }.returns(%w[foo bar baz])
+      Hiera.any_instance.expects(:lookup).with { |*args| expect(args[4]).to be(:array) }.returns(%w[foo bar baz])
       expect(hiera_array.call(scope, 'key', {'key' => 'foo_result'})).to eql(%w[foo bar baz])
     end
 
@@ -90,7 +84,7 @@ describe 'when calling' do
     end
 
     it 'should use the hash resolution_type' do
-      Hiera.any_instance.expects(:lookup).with { |*args| args[4].should be(:hash) }.returns({'foo' => 'result'})
+      Hiera.any_instance.expects(:lookup).with { |*args| expect(args[4]).to be(:hash) }.returns({'foo' => 'result'})
       expect(hiera_hash.call(scope, 'key', {'key' => 'foo_result'})).to eql({'foo' => 'result'})
     end
 
@@ -111,8 +105,8 @@ describe 'when calling' do
     end
 
     it 'should use the array resolution_type' do
-      Hiera.any_instance.expects(:lookup).with { |*args| args[4].should be(:array) }.returns(%w[foo bar baz])
-      hiera_include.expects(:call_function_with_scope).with(scope, 'include', %w[foo bar baz])
+      Hiera.any_instance.expects(:lookup).with { |*args| expect(args[4]).to be(:array) }.returns(%w[foo bar baz])
+      hiera_include.expects(:call_function).with('include', %w[foo bar baz])
       hiera_include.call(scope, 'key', {'key' => 'foo_result'})
     end
 
@@ -122,7 +116,7 @@ describe 'when calling' do
     end
 
     it 'should use default block' do
-      hiera_include.expects(:call_function_with_scope).with(scope,'include', %w[key foo])
+      hiera_include.expects(:call_function).with('include', %w[key foo])
       hiera_include.call(scope, 'foo') { |k| ['key', k] }
     end
   end

data/spec/unit/functions/inline_epp_spec.rb

@@ -4,14 +4,6 @@ require 'spec_helper'
 describe "the inline_epp function" do
   include PuppetSpec::Files
 
-  before :all do
-    Puppet::Parser::Functions.autoloader.loadall
-  end
-
-  before :each do
-    Puppet[:parser] = 'future'
-  end
-
   let :node     do Puppet::Node.new('localhost') end
   let :compiler do Puppet::Parser::Compiler.new(node) end
   let :scope    do Puppet::Parser::Scope.new(compiler) end
@@ -19,26 +11,26 @@ describe "the inline_epp function" do
   context "when accessing scope variables as $ variables" do
     it "looks up the value from the scope" do
       scope["what"] = "are belong"
-      eval_template("all your base <%= $what %> to us").should == "all your base are belong to us"
+      expect(eval_template("all your base <%= $what %> to us")).to eq("all your base are belong to us")
     end
 
     it "get nil accessing a variable that does not exist" do
-      eval_template("<%= $kryptonite == undef %>").should == "true"
+      expect(eval_template("<%= $kryptonite == undef %>")).to eq("true")
     end
 
     it "get nil accessing a variable that is undef" do
       scope['undef_var'] = :undef
-      eval_template("<%= $undef_var == undef %>").should == "true"
+      expect(eval_template("<%= $undef_var == undef %>")).to eq("true")
     end
 
     it "gets shadowed variable if args are given" do
       scope['phantom'] = 'of the opera'
-      eval_template_with_args("<%= $phantom == dragos %>", 'phantom' => 'dragos').should == "true"
+      expect(eval_template_with_args("<%= $phantom == dragos %>", 'phantom' => 'dragos')).to eq("true")
     end
 
     it "gets shadowed variable if args are given and parameters are specified" do
       scope['x'] = 'wrong one'
-      eval_template_with_args("<%-| $x |-%><%= $x == correct %>", 'x' => 'correct').should == "true"
+      expect(eval_template_with_args("<%-| $x |-%><%= $x == correct %>", 'x' => 'correct')).to eq("true")
     end
 
     it "raises an error if required variable is not given" do
@@ -67,18 +59,18 @@ describe "the inline_epp function" do
   end
 
   it "renders a block expression" do
-    eval_template_with_args("<%= { $y = $x $x + 1} %>", 'x' => 2).should == "3"
+    expect(eval_template_with_args("<%= { $y = $x $x + 1} %>", 'x' => 2)).to eq("3")
   end
 
   # although never a problem with epp
   it "is not interfered with by having a variable named 'string' (#14093)" do
     scope['string'] = "this output should not be seen"
-    eval_template("some text that is static").should == "some text that is static"
+    expect(eval_template("some text that is static")).to eq("some text that is static")
   end
 
   it "has access to a variable named 'string' (#14093)" do
     scope['string'] = "the string value"
-    eval_template("string was: <%= $string %>").should == "string was: the string value"
+    expect(eval_template("string was: <%= $string %>")).to eq("string was: the string value")
   end
 
 

data/spec/unit/functions/lookup_spec.rb

@@ -0,0 +1,324 @@
+#! /usr/bin/env ruby
+require 'spec_helper'
+require 'puppet_spec/compiler'
+require 'puppet/pops'
+
+describe "when performing lookup" do
+  include PuppetSpec::Compiler
+
+  # Assembles code that includes the *abc* class and compiles it into a catalog. This class will use the global
+  # variable $args to perform a lookup and assign the result to $abc::result. Unless the $block is set to
+  # the string 'no_block_present', it will be passed as a lambda to the lookup. The assembled code will declare
+  # a notify resource with a name that is formed by interpolating the result into a format string.
+  #
+  # The method performs the folloging steps.
+  #
+  # - Build the code that:
+  #    - sets the $args variable from _lookup_args_
+  #    - sets the $block parameter to the given block or the string 'no_block_present'
+  #    - includes the abc class
+  #    - assigns the $abc::result to $r
+  #    - interpolates a string using _fmt_ (which is assumed to use $r)
+  #    - declares a notify resource from the interpolated string
+  # - Compile the code into a catalog
+  # - Return the name of all Notify resources in that catalog
+  #
+  # @param fmt [String] The puppet interpolated string used when creating the notify title
+  # @param *args [String] splat of args that will be concatenated to form the puppet args sent to lookup
+  # @return [Array<String>] List of names of Notify resources in the resulting catalog
+  #
+  def assemble_and_compile(fmt, *lookup_args)
+    assemble_and_compile_with_block(fmt, "'no_block_present'", *lookup_args)
+  end
+
+  def assemble_and_compile_with_block(fmt, block, *lookup_args)
+    Puppet[:code] = <<-END.gsub(/^ {6}/, '')
+      $args = [#{lookup_args.join(',')}]
+      $block = #{block}
+      include abc
+      $r = if $abc::result == undef { 'no_value' } else { $abc::result }
+      notify { \"#{fmt}\": }
+    END
+    compiler.compile().resources.map(&:ref).select { |r| r.start_with?('Notify[') }.map { |r| r[7..-2] }
+  end
+
+  # There is a fully configured 'production' environment in fixtures at this location
+  let(:environmentpath) { File.join(my_fixture_dir, 'environments') }
+  let(:node) { Puppet::Node.new("testnode", :facts => Puppet::Node::Facts.new("facts", {}), :environment => 'production') }
+  let(:compiler) { Puppet::Parser::Compiler.new(node) }
+
+  around(:each) do |example|
+    # Initialize settings to get a full compile as close as possible to a real
+    # environment load
+    Puppet.settings.initialize_global_settings
+
+    # Initialize loaders based on the environmentpath. It does not work to
+    # just set the setting environmentpath for some reason - this achieves the same:
+    # - first a loader is created, loading directory environments from the fixture (there is
+    # one environment, 'sample', which will be loaded since the node references this
+    # environment by name).
+    # - secondly, the created env loader is set as 'environments' in the puppet context.
+    #
+    environments = Puppet::Environments::Directories.new(environmentpath, [])
+    Puppet.override(:environments => environments) do
+      example.run
+    end
+  end
+
+  context 'using normal parameters' do
+    it 'can lookup value provided by the environment' do
+      resources = assemble_and_compile('${r}', "'a'")
+      expect(resources).to include('env_a')
+    end
+
+    it 'can lookup value provided by the module' do
+      resources = assemble_and_compile('${r}', "'b'")
+      expect(resources).to include('module_b')
+    end
+
+    it 'can lookup value provided in global scope' do
+      Hiera.any_instance.expects(:lookup).with('a', any_parameters).returns('global_a')
+      resources = assemble_and_compile('${r}', "'a'")
+      expect(resources).to include('global_a')
+    end
+
+    it 'will stop at first found name when several names are provided' do
+      resources = assemble_and_compile('${r}', "['b', 'a']")
+      expect(resources).to include('module_b')
+    end
+
+    it 'can lookup value provided by the module that is overriden by environment' do
+      resources = assemble_and_compile('${r}', "'c'")
+      expect(resources).to include('env_c')
+    end
+
+    it "can 'unique' merge values provided by both the module and the environment" do
+      resources = assemble_and_compile('${r[0]}_${r[1]}', "'c'", 'Array[String]', "'unique'")
+      expect(resources).to include('env_c_module_c')
+    end
+
+    it "can 'hash' merge values provided by the environment only" do
+      resources = assemble_and_compile('${r[k1]}_${r[k2]}_${r[k3]}', "'d'", 'Hash[String,String]', "'hash'")
+      expect(resources).to include('env_d1_env_d2_env_d3')
+    end
+
+    it "can 'hash' merge values provided by both the environment and the module" do
+      resources = assemble_and_compile('${r[k1]}_${r[k2]}_${r[k3]}', "'e'", 'Hash[String,String]', "'hash'")
+      expect(resources).to include('env_e1_module_e2_env_e3')
+    end
+
+    it "can 'hash' merge values provided by global, environment, and module" do
+      Hiera.any_instance.expects(:lookup).with('e', any_parameters).returns({ 'k1' => 'global_e1' })
+      resources = assemble_and_compile('${r[k1]}_${r[k2]}_${r[k3]}', "'e'", 'Hash[String,String]', "'hash'")
+      expect(resources).to include('global_e1_module_e2_env_e3')
+    end
+
+    it "can pass merge parameter in the form of a hash with a 'strategy=>unique'" do
+      resources = assemble_and_compile('${r[0]}_${r[1]}', "'c'", 'Array[String]', "{strategy => 'unique'}")
+      expect(resources).to include('env_c_module_c')
+    end
+
+    it "can pass merge parameter in the form of a hash with 'strategy=>hash'" do
+      resources = assemble_and_compile('${r[k1]}_${r[k2]}_${r[k3]}', "'e'", 'Hash[String,String]', "{strategy => 'hash'}")
+      expect(resources).to include('env_e1_module_e2_env_e3')
+    end
+
+    it "can pass merge parameter in the form of a hash with a 'strategy=>deep'" do
+      resources = assemble_and_compile('${r[k1]}_${r[k2]}_${r[k3]}', "'e'", 'Hash[String,String]', "{strategy => 'deep'}")
+      expect(resources).to include('env_e1_module_e2_env_e3')
+    end
+
+    it "will fail unless merge in the form of a hash contains a 'strategy'" do
+      expect do
+        assemble_and_compile('${r[k1]}_${r[k2]}_${r[k3]}', "'e'", 'Hash[String,String]', "{merge_key => 'hash'}")
+      end.to raise_error(Puppet::ParseError, /hash given as 'merge' must contain the name of a strategy/)
+    end
+
+    it 'will raise an exception when value is not found for single key and no default is provided' do
+      expect do
+        assemble_and_compile('${r}', "'x'")
+      end.to raise_error(Puppet::ParseError, /did not find a value for the name 'x'/)
+    end
+
+    it 'can lookup an undef value' do
+      resources = assemble_and_compile('${r}', "'n'")
+      expect(resources).to include('no_value')
+    end
+
+    it 'will not replace an undef value with a given default' do
+      resources = assemble_and_compile('${r}', "'n'", 'undef', 'undef', '"default_n"')
+      expect(resources).to include('no_value')
+    end
+
+    it 'will not accept a succesful lookup of an undef value when the type rejects it' do
+      expect do
+        assemble_and_compile('${r}', "'n'", 'String')
+      end.to raise_error(Puppet::ParseError, /found value has wrong type/)
+    end
+
+    it 'will raise an exception when value is not found for array key and no default is provided' do
+      expect do
+        assemble_and_compile('${r}', "['x', 'y']")
+      end.to raise_error(Puppet::ParseError, /did not find a value for any of the names \['x', 'y'\]/)
+    end
+
+    it 'can lookup and deep merge shallow values provided by the environment only' do
+      resources = assemble_and_compile('${r[k1]}_${r[k2]}_${r[k3]}', "'d'", 'Hash[String,String]', "'deep'")
+      expect(resources).to include('env_d1_env_d2_env_d3')
+    end
+
+    it 'can lookup and deep merge shallow values provided by both the module and the environment' do
+      resources = assemble_and_compile('${r[k1]}_${r[k2]}_${r[k3]}', "'e'", 'Hash[String,String]', "'deep'")
+      expect(resources).to include('env_e1_module_e2_env_e3')
+    end
+
+    it 'can lookup and deep merge deep values provided by global, environment, and module' do
+      Hiera.any_instance.expects(:lookup).with('f', any_parameters).returns({ 'k1' => { 's1' => 'global_f11' }, 'k2' => { 's3' => 'global_f23' }})
+      resources = assemble_and_compile('${r[k1][s1]}_${r[k1][s2]}_${r[k1][s3]}_${r[k2][s1]}_${r[k2][s2]}_${r[k2][s3]}', "'f'", 'Hash[String,Hash[String,String]]', "'deep'")
+      expect(resources).to include('global_f11_env_f12_module_f13_env_f21_module_f22_global_f23')
+    end
+
+    it 'will propagate resolution_type :array to Hiera when merge == \'unique\''  do
+      Hiera.any_instance.expects(:lookup).with('c', anything, anything, anything, :array).returns(['global_c'])
+      resources = assemble_and_compile('${r[0]}_${r[1]}_${r[2]}', "'c'", 'Array[String]', "'unique'")
+      expect(resources).to include('global_c_env_c_module_c')
+    end
+
+    it 'will propagate a Hash resolution_type with :behavior => :native to Hiera when merge == \'hash\''  do
+      Hiera.any_instance.expects(:lookup).with('e', anything, anything, anything, { :behavior => :native }).returns({ 'k1' => 'global_e1' })
+      resources = assemble_and_compile('${r[k1]}_${r[k2]}_${r[k3]}', "'e'", 'Hash[String,String]', "{strategy => 'hash'}")
+      expect(resources).to include('global_e1_module_e2_env_e3')
+    end
+
+    it 'will propagate a Hash resolution_type with :behavior => :deeper to Hiera when merge == \'deep\''  do
+      Hiera.any_instance.expects(:lookup).with('f', anything, anything, anything, { :behavior => :deeper }).returns({ 'k1' => { 's1' => 'global_f11' }, 'k2' => { 's3' => 'global_f23' }})
+      resources = assemble_and_compile('${r[k1][s1]}_${r[k1][s2]}_${r[k1][s3]}_${r[k2][s1]}_${r[k2][s2]}_${r[k2][s3]}', "'f'", 'Hash[String,Hash[String,String]]', "'deep'")
+      expect(resources).to include('global_f11_env_f12_module_f13_env_f21_module_f22_global_f23')
+    end
+
+    it 'will propagate a Hash resolution_type with symbolic deep merge options to Hiera'  do
+      Hiera.any_instance.expects(:lookup).with('f', anything, anything, anything, { :behavior => :deeper, :knockout_prefix => '--' }).returns({ 'k1' => { 's1' => 'global_f11' }, 'k2' => { 's3' => 'global_f23' }})
+      resources = assemble_and_compile('${r[k1][s1]}_${r[k1][s2]}_${r[k1][s3]}_${r[k2][s1]}_${r[k2][s2]}_${r[k2][s3]}', "'f'", 'Hash[String,Hash[String,String]]', "{ 'strategy' => 'deep', 'knockout_prefix' => '--' }")
+      expect(resources).to include('global_f11_env_f12_module_f13_env_f21_module_f22_global_f23')
+    end
+
+    context 'with provided default' do
+      it 'will return default when lookup fails' do
+        resources = assemble_and_compile('${r}', "'x'", 'String', 'undef', "'dflt_x'")
+        expect(resources).to include('dflt_x')
+      end
+
+      it 'can precede default parameter with undef as the value_type and undef as the merge type' do
+        resources = assemble_and_compile('${r}', "'x'", 'undef', 'undef', "'dflt_x'")
+        expect(resources).to include('dflt_x')
+      end
+
+      it 'can use array' do
+        resources = assemble_and_compile('${r[0]}_${r[1]}', "'x'", 'Array[String]', 'undef', "['dflt_x', 'dflt_y']")
+        expect(resources).to include('dflt_x_dflt_y')
+      end
+
+      it 'can use hash' do
+        resources = assemble_and_compile('${r[a]}_${r[b]}', "'x'", 'Hash[String,String]', 'undef', "{'a' => 'dflt_x', 'b' => 'dflt_y'}")
+        expect(resources).to include('dflt_x_dflt_y')
+      end
+
+      it 'fails unless default is an instance of value_type' do
+        expect do
+          assemble_and_compile('${r[a]}_${r[b]}', "'x'", 'Hash[String,String]', 'undef', "{'a' => 'dflt_x', 'b' => 32}")
+        end.to raise_error(Puppet::ParseError, /default_value value has wrong type/)
+      end
+    end
+
+    context 'with a default block' do
+      it 'will be called when lookup fails' do
+        resources = assemble_and_compile_with_block('${r}', "'dflt_x'", "'x'")
+        expect(resources).to include('dflt_x')
+      end
+
+      it 'will not called when lookup succeeds but the found value is nil' do
+        resources = assemble_and_compile_with_block('${r}', "'dflt_x'", "'n'")
+        expect(resources).to include('no_value')
+      end
+
+      it 'can use array' do
+        resources = assemble_and_compile_with_block('${r[0]}_${r[1]}', "['dflt_x', 'dflt_y']", "'x'")
+        expect(resources).to include('dflt_x_dflt_y')
+      end
+
+      it 'can use hash' do
+        resources = assemble_and_compile_with_block('${r[a]}_${r[b]}', "{'a' => 'dflt_x', 'b' => 'dflt_y'}", "'x'")
+        expect(resources).to include('dflt_x_dflt_y')
+      end
+
+      it 'can return undef from block' do
+        resources = assemble_and_compile_with_block('${r}', 'undef', "'x'")
+        expect(resources).to include('no_value')
+      end
+
+      it 'fails unless block returns an instance of value_type' do
+        expect do
+          assemble_and_compile_with_block('${r[a]}_${r[b]}', "{'a' => 'dflt_x', 'b' => 32}", "'x'", 'Hash[String,String]')
+        end.to raise_error(Puppet::ParseError, /default_block value has wrong type/)
+      end
+
+      it 'receives a single name parameter' do
+        resources = assemble_and_compile_with_block('${r}', 'true', "'name_x'")
+        expect(resources).to include('name_x')
+      end
+
+      it 'receives an array name parameter' do
+        resources = assemble_and_compile_with_block('${r[0]}_${r[1]}', 'true', "['name_x', 'name_y']")
+        expect(resources).to include('name_x_name_y')
+      end
+    end
+  end
+
+  context 'when passing a hash as the only parameter' do
+    it 'can pass a single name correctly' do
+      resources = assemble_and_compile('${r}', "{name => 'a'}")
+      expect(resources).to include('env_a')
+    end
+
+    it 'can pass a an array of names correctly' do
+      resources = assemble_and_compile('${r}', "{name => ['b', 'a']}")
+      expect(resources).to include('module_b')
+    end
+
+    it 'can pass an override map and find values there even though they would be found' do
+      resources = assemble_and_compile('${r}', "{name => 'a', override => { a => 'override_a'}}")
+      expect(resources).to include('override_a')
+    end
+
+    it 'can pass an default_values_hash and find values there correctly' do
+      resources = assemble_and_compile('${r}', "{name => 'x', default_values_hash => { x => 'extra_x'}}")
+      expect(resources).to include('extra_x')
+    end
+
+    it 'can pass an default_values_hash but not use it when value is found elsewhere' do
+      resources = assemble_and_compile('${r}', "{name => 'a', default_values_hash => { a => 'extra_a'}}")
+      expect(resources).to include('env_a')
+    end
+
+    it 'can pass an default_values_hash but not use it when value is found elsewhere even when found value is undef' do
+      resources = assemble_and_compile('${r}', "{name => 'n', default_values_hash => { n => 'extra_n'}}")
+      expect(resources).to include('no_value')
+    end
+
+    it 'can pass an override and an default_values_hash and find the override value' do
+      resources = assemble_and_compile('${r}', "{name => 'x', override => { x => 'override_x'}, default_values_hash => { x => 'extra_x'}}")
+      expect(resources).to include('override_x')
+    end
+
+    it 'will raise an exception when value is not found for single key and no default is provided' do
+      expect do
+        assemble_and_compile('${r}', "{name => 'x'}")
+      end.to raise_error(Puppet::ParseError, /did not find a value for the name 'x'/)
+    end
+
+    it 'will not raise an exception when value is not found default value is nil' do
+      resources = assemble_and_compile('${r}', "{name => 'x', default_value => undef}")
+      expect(resources).to include('no_value')
+    end
+  end
+end