puppet 4.3.1 → 4.3.2

data/spec/unit/application/lookup_spec.rb

@@ -14,6 +14,16 @@ describe Puppet::Application::Lookup do
       expect { lookup.run_command }.to raise_error(RuntimeError, expected_error)
     end
 
+    it "does not allow invalid arguments for '--merge'" do
+      lookup.options[:node] = 'dantooine.local'
+      lookup.options[:merge] = 'something_bad'
+      lookup.command_line.stubs(:args).returns(['atton', 'kreia'])
+
+      expected_error = "The --merge option only accepts 'first', 'hash', 'unique', or 'deep'\nRun 'puppet lookup --help' for more details"
+
+      expect { lookup.run_command }.to raise_error(RuntimeError, expected_error)
+    end
+
     it "does not allow deep merge options if '--merge' was not set to deep" do
       lookup.options[:node] = 'dantooine.local'
       lookup.options[:merge_hash_arrays] = true
@@ -44,6 +54,18 @@ describe Puppet::Application::Lookup do
       expect { lookup.run_command }.to output("rand\n").to_stdout
     end
 
+    %w(first unique hash deep).each do |opt|
+
+      it "accepts --merge #{opt}" do
+        lookup.options[:node] = 'dantooine.local'
+        lookup.options[:merge] = opt
+        lookup.command_line.stubs(:args).returns(['atton', 'kreia'])
+        lookup.stubs(:generate_scope).yields('scope')
+        Puppet::Pops::Lookup.stubs(:lookup).returns('rand')
+        expect { lookup.run_command }.to output("--- rand\n...\n").to_stdout
+      end
+    end
+
     it "prints the value found by lookup" do
       lookup.options[:node] = 'dantooine.local'
       lookup.command_line.stubs(:args).returns(['atton', 'kreia'])
@@ -56,7 +78,7 @@ describe Puppet::Application::Lookup do
   end
 
 
-  context 'when asked to explain' do
+  context 'when given a valid configuration' do
     let (:lookup) { Puppet::Application[:lookup] }
 
     # There is a fully configured 'sample' environment in fixtures at this location
@@ -64,7 +86,7 @@ describe Puppet::Application::Lookup do
 
     let(:facts) { Puppet::Node::Facts.new("facts", {}) }
 
-    let(:node) { Puppet::Node.new("testnode", :facts => facts, :environment => environment) }
+    let(:node) { Puppet::Node.new("testnode", :facts => facts, :environment => 'production') }
 
     let(:expected_json_hash) { {
       'type' => 'merge',
@@ -104,30 +126,30 @@ describe Puppet::Application::Lookup do
       :event => :result,
       :value => 'This is A',
       :branches => [
-      { :key => 'a',
-        :event => :not_found,
-        :type => :global,
-        :name => :hiera
-      },
-      {
-        :type => :data_provider,
-        :name => 'Hiera Data Provider, version 4',
-        :configuration_path => "#{environmentpath}/production/hiera.yaml",
-        :branches => [
+        { :key => 'a',
+          :event => :not_found,
+          :type => :global,
+          :name => :hiera
+        },
         {
           :type => :data_provider,
-          :name => 'common',
+          :name => 'Hiera Data Provider, version 4',
+          :configuration_path => "#{environmentpath}/production/hiera.yaml",
           :branches => [
-          {
-            :key => 'a',
-            :value => 'This is A',
-            :event => :found,
-            :type => :path,
-            :original_path => 'common',
-            :path => "#{environmentpath}/production/data/common.yaml",
-          }]
-       }]
-      }]
+            {
+              :type => :data_provider,
+              :name => 'common',
+              :branches => [
+                {
+                  :key => 'a',
+                  :value => 'This is A',
+                  :event => :found,
+                  :type => :path,
+                  :original_path => 'common',
+                  :path => "#{environmentpath}/production/data/common.yaml",
+                }]
+            }]
+        }]
     } }
 
     around(:each) do |example|
@@ -140,8 +162,8 @@ describe Puppet::Application::Lookup do
       end
     end
 
-    it 'produces human readable text by default' do
-      lookup.options[:node] = Puppet::Node.new("testnode", :facts => facts, :environment => 'production')
+    it '--explain produces human readable text by default' do
+      lookup.options[:node] = node
       lookup.options[:explain] = true
       lookup.command_line.stubs(:args).returns(['a'])
       expect { lookup.run_command }.to output(<<-EXPLANATION).to_stdout
@@ -152,14 +174,70 @@ Merge strategy first
     ConfigurationPath "#{environmentpath}/production/hiera.yaml"
     Data Provider "common"
       Path "#{environmentpath}/production/data/common.yaml"
-        Original path: common
+        Original path: "common"
         Found key: "a" value: "This is A"
   Merged result: "This is A"
       EXPLANATION
     end
 
+    it '--explain produces human readable text of a hash merge when using --explain-options' do
+      lookup.options[:node] = node
+      lookup.options[:explain_options] = true
+      expect { lookup.run_command }.to output(<<-EXPLANATION).to_stdout
+Merge strategy hash
+  Data Binding "hiera"
+    No such key: "lookup_options"
+  Data Provider "Hiera Data Provider, version 4"
+    ConfigurationPath "#{environmentpath}/production/hiera.yaml"
+    Data Provider "common"
+      Path "#{environmentpath}/production/data/common.yaml"
+        Original path: "common"
+        Found key: "lookup_options" value: {
+          "a" => "first"
+        }
+  Merged result: {
+    "a" => "first"
+  }
+      EXPLANATION
+    end
+
+    it '--explain produces human readable text of a hash merge when using both --explain and --explain-options' do
+      lookup.options[:node] = node
+      lookup.options[:explain] = true
+      lookup.options[:explain_options] = true
+      lookup.command_line.stubs(:args).returns(['a'])
+      expect { lookup.run_command }.to output(<<-EXPLANATION).to_stdout
+Searching for "lookup_options"
+  Merge strategy hash
+    Data Binding "hiera"
+      No such key: "lookup_options"
+    Data Provider "Hiera Data Provider, version 4"
+      ConfigurationPath "#{environmentpath}/production/hiera.yaml"
+      Data Provider "common"
+        Path "#{environmentpath}/production/data/common.yaml"
+          Original path: "common"
+          Found key: "lookup_options" value: {
+            "a" => "first"
+          }
+    Merged result: {
+      "a" => "first"
+    }
+Searching for "a"
+  Merge strategy first
+    Data Binding "hiera"
+      No such key: "a"
+    Data Provider "Hiera Data Provider, version 4"
+      ConfigurationPath "#{environmentpath}/production/hiera.yaml"
+      Data Provider "common"
+        Path "#{environmentpath}/production/data/common.yaml"
+          Original path: "common"
+          Found key: "a" value: "This is A"
+    Merged result: "This is A"
+      EXPLANATION
+    end
+
     it 'can produce a yaml explanation' do
-      lookup.options[:node] = Puppet::Node.new("testnode", :facts => facts, :environment => 'production')
+      lookup.options[:node] = node
       lookup.options[:explain] = true
       lookup.options[:render_as] = :yaml
       lookup.command_line.stubs(:args).returns(['a'])
@@ -176,7 +254,7 @@ Merge strategy first
     end
 
     it 'can produce a json explanation' do
-      lookup.options[:node] = Puppet::Node.new("testnode", :facts => facts, :environment => 'production')
+      lookup.options[:node] = node
       lookup.options[:explain] = true
       lookup.options[:render_as] = :json
       lookup.command_line.stubs(:args).returns(['a'])
@@ -191,5 +269,37 @@ Merge strategy first
       end
       expect(JSON.parse(output)).to eq(expected_json_hash)
     end
+
+    context 'the global scope' do
+      it "is unaffected by global variables unless '--compile' is used" do
+        lookup.options[:node] = node
+        lookup.command_line.stubs(:args).returns(['c'])
+        expect { lookup.run_command }.to output("--- This is\n...\n").to_stdout
+      end
+
+      it "is affected by global variables when '--compile' is used" do
+        lookup.options[:node] = node
+        lookup.options[:compile] = true
+        lookup.command_line.stubs(:args).returns(['c'])
+        expect { lookup.run_command }.to output("--- This is C from site.pp\n...\n").to_stdout
+      end
+    end
+
+    context 'using a puppet function as data provider' do
+      let(:node) { Puppet::Node.new("testnode", :facts => facts, :environment => 'puppet_func_provider') }
+
+      it "works OK in the absense of '--compile'" do
+        lookup.options[:node] = node
+        lookup.command_line.stubs(:args).returns(['c'])
+        expect { lookup.run_command }.to output("--- This is C from data.pp\n...\n").to_stdout
+      end
+
+      it "global scope is affected by global variables when '--compile' is used" do
+        lookup.options[:node] = node
+        lookup.options[:compile] = true
+        lookup.command_line.stubs(:args).returns(['c'])
+        expect { lookup.run_command }.to output("--- This is C from site.pp\n...\n").to_stdout
+      end
+    end
   end
 end

data/spec/unit/data_providers/hiera_data_provider_spec.rb

@@ -53,6 +53,12 @@ describe "when using a hiera data provider" do
     expect(resources).to include('module data param_a is 100, module data param_b is 200, module data param_c is 300, module data param_d is 400, module data param_e is 500')
   end
 
+  it 'keeps lookup_options in one module separate from lookup_options in another' do
+    resources1 = compile('hiera_modules', 'include one').resources.select {|r| r.ref.start_with?('Class[One]')}
+    resources2 = compile('hiera_modules', 'include two').resources.select {|r| r.ref.start_with?('Class[One]')}
+    expect(resources1).to eq(resources2)
+  end
+
   it 'does not perform merge of values declared in environment and module when resolving parameters' do
     resources = compile_and_get_notifications('hiera_misc')
     expect(resources).to include('env 1, ')
@@ -81,10 +87,8 @@ describe "when using a hiera data provider" do
     expect(resources[0]).to eq('A, B, C, MA, MB, MC')
   end
 
-  it "can lookup the 'lookup_options' hash as a regular value" do
-    resources = compile_and_get_notifications('hiera_misc', '$r = lookup(lookup_options, Hash[String,Hash[String,String]], hash) notify{"${r[one::lopts_test::hash][merge]}":}')
-    expect(resources.size).to eq(1)
-    expect(resources[0]).to eq('deep')
+  it "will not find 'lookup_options' as a regular value" do
+    expect { compile_and_get_notifications('hiera_misc', '$r = lookup("lookup_options")') }.to raise_error(Puppet::DataBinding::LookupError, /did not find a value/)
   end
 
   it 'does find unqualified keys in the environment' do
@@ -180,16 +184,189 @@ Merge strategy first
     ConfigurationPath "#{environmentpath}/hiera_misc/hiera.yaml"
     Data Provider "common"
       Path "#{environmentpath}/hiera_misc/data/common.yaml"
-        Original path: common
+        Original path: "common"
         Interpolation on "Value from interpolation %{scope("target_scope")}"
           Global Scope"
             Found key: "target_scope" value: "with scope"
         Found key: "km_scope" value: "Value from interpolation with scope"
   Merged result: "Value from interpolation with scope"
+EOS
+      end
+    end
+
+    it 'will report that merge options was found in the lookup_options hash' do
+      compile('hiera_misc', '$target_scope = "with scope"') do |compiler|
+        lookup_invocation = Puppet::Pops::Lookup::Invocation.new(compiler.topscope, {}, {}, true)
+        value = Puppet::Pops::Lookup.lookup('one::loptsm_test::hash', nil, nil, nil, nil, lookup_invocation)
+        expect(lookup_invocation.explainer.to_s).to eq(<<EOS)
+Using merge options from "lookup_options" hash
+Merge strategy deep
+  Data Binding "hiera"
+    No such key: "one::loptsm_test::hash"
+  Data Provider "Hiera Data Provider, version 4"
+    ConfigurationPath "#{environmentpath}/hiera_misc/hiera.yaml"
+    Data Provider "common"
+      Path "#{environmentpath}/hiera_misc/data/common.yaml"
+        Original path: "common"
+        Found key: "one::loptsm_test::hash" value: {
+          "a" => "A",
+          "b" => "B",
+          "m" => {
+            "ma" => "MA",
+            "mb" => "MB"
+          }
+        }
+  Module "one" using Data Provider "Hiera Data Provider, version 4"
+    ConfigurationPath "#{environmentpath}/hiera_misc/modules/one/hiera.yaml"
+    Data Provider "common"
+      Path "#{environmentpath}/hiera_misc/modules/one/data/common.yaml"
+        Original path: "common"
+        Found key: "one::loptsm_test::hash" value: {
+          "a" => "A",
+          "c" => "C",
+          "m" => {
+            "ma" => "MA",
+            "mc" => "MC",
+            "mb" => "MB"
+          }
+        }
+  Merged result: {
+    "a" => "A",
+    "c" => "C",
+    "m" => {
+      "ma" => "MA",
+      "mc" => "MC",
+      "mb" => "MB"
+    },
+    "b" => "B"
+  }
+EOS
+      end
+    end
+
+    it 'will report lookup_options details in combination with details of found value' do
+      compile('hiera_misc', '$target_scope = "with scope"') do |compiler|
+        lookup_invocation = Puppet::Pops::Lookup::Invocation.new(compiler.topscope, {}, {}, Puppet::Pops::Lookup::Explainer.new(true))
+        value = Puppet::Pops::Lookup.lookup('one::loptsm_test::hash', nil, nil, nil, nil, lookup_invocation)
+        expect(lookup_invocation.explainer.to_s).to eq(<<EOS)
+Searching for "lookup_options"
+  Merge strategy hash
+    Data Binding "hiera"
+      No such key: "lookup_options"
+    Data Provider "Hiera Data Provider, version 4"
+      ConfigurationPath "#{environmentpath}/hiera_misc/hiera.yaml"
+      Data Provider "common"
+        Path "#{environmentpath}/hiera_misc/data/common.yaml"
+          Original path: "common"
+          Found key: "lookup_options" value: {
+            "one::lopts_test::hash" => {
+              "merge" => "deep"
+            }
+          }
+    Module "one" using Data Provider "Hiera Data Provider, version 4"
+      ConfigurationPath "#{environmentpath}/hiera_misc/modules/one/hiera.yaml"
+      Data Provider "common"
+        Path "#{environmentpath}/hiera_misc/modules/one/data/common.yaml"
+          Original path: "common"
+          Found key: "lookup_options" value: {
+            "one::loptsm_test::hash" => {
+              "merge" => "deep"
+            }
+          }
+    Merged result: {
+      "one::loptsm_test::hash" => {
+        "merge" => "deep"
+      },
+      "one::lopts_test::hash" => {
+        "merge" => "deep"
+      }
+    }
+Searching for "one::loptsm_test::hash"
+  Merge strategy deep
+    Data Binding "hiera"
+      No such key: "one::loptsm_test::hash"
+    Data Provider "Hiera Data Provider, version 4"
+      ConfigurationPath "#{environmentpath}/hiera_misc/hiera.yaml"
+      Data Provider "common"
+        Path "#{environmentpath}/hiera_misc/data/common.yaml"
+          Original path: "common"
+          Found key: "one::loptsm_test::hash" value: {
+            "a" => "A",
+            "b" => "B",
+            "m" => {
+              "ma" => "MA",
+              "mb" => "MB"
+            }
+          }
+    Module "one" using Data Provider "Hiera Data Provider, version 4"
+      ConfigurationPath "#{environmentpath}/hiera_misc/modules/one/hiera.yaml"
+      Data Provider "common"
+        Path "#{environmentpath}/hiera_misc/modules/one/data/common.yaml"
+          Original path: "common"
+          Found key: "one::loptsm_test::hash" value: {
+            "a" => "A",
+            "c" => "C",
+            "m" => {
+              "ma" => "MA",
+              "mc" => "MC",
+              "mb" => "MB"
+            }
+          }
+    Merged result: {
+      "a" => "A",
+      "c" => "C",
+      "m" => {
+        "ma" => "MA",
+        "mc" => "MC",
+        "mb" => "MB"
+      },
+      "b" => "B"
+    }
+EOS
+      end
+    end
+
+    it 'will report config path (original and resolved), data path (original and resolved), and interpolation (before and after)' do
+      compile('hiera_misc', '$target_scope = "with scope"') do |compiler|
+        lookup_invocation = Puppet::Pops::Lookup::Invocation.new(compiler.topscope, {}, {}, Puppet::Pops::Lookup::Explainer.new(true, true))
+        value = Puppet::Pops::Lookup.lookup('one::loptsm_test::hash', nil, nil, nil, nil, lookup_invocation)
+        expect(lookup_invocation.explainer.to_s).to eq(<<EOS)
+Merge strategy hash
+  Data Binding "hiera"
+    No such key: "lookup_options"
+  Data Provider "Hiera Data Provider, version 4"
+    ConfigurationPath "#{environmentpath}/hiera_misc/hiera.yaml"
+    Data Provider "common"
+      Path "#{environmentpath}/hiera_misc/data/common.yaml"
+        Original path: "common"
+        Found key: "lookup_options" value: {
+          "one::lopts_test::hash" => {
+            "merge" => "deep"
+          }
+        }
+  Module "one" using Data Provider "Hiera Data Provider, version 4"
+    ConfigurationPath "#{environmentpath}/hiera_misc/modules/one/hiera.yaml"
+    Data Provider "common"
+      Path "#{environmentpath}/hiera_misc/modules/one/data/common.yaml"
+        Original path: "common"
+        Found key: "lookup_options" value: {
+          "one::loptsm_test::hash" => {
+            "merge" => "deep"
+          }
+        }
+  Merged result: {
+    "one::loptsm_test::hash" => {
+      "merge" => "deep"
+    },
+    "one::lopts_test::hash" => {
+      "merge" => "deep"
+    }
+  }
 EOS
       end
     end
   end
+
   def parent_fixture(dir_name)
     File.absolute_path(File.join(my_fixture_dir(), "../#{dir_name}"))
   end

data/spec/unit/face/epp_face_spec.rb

@@ -150,7 +150,7 @@ describe Puppet::Face[:epp, :current] do
       dir = dir_containing('templates', { template_name => "<% 1 2 3 %>" })
       template = File.join(dir, template_name)
       expect(eppface.dump(template, :validate => true)).to eq("")
-      expect(@logs.join).to match(/This Literal Integer has no effect.* line 1:4/)
+      expect(@logs.join).to match(/This Literal Integer has no effect.*\/template1.epp:1:4/)
     end
 
     it "validated content by default" do
@@ -158,7 +158,7 @@ describe Puppet::Face[:epp, :current] do
       dir = dir_containing('templates', { template_name => "<% 1 2 3 %>" })
       template = File.join(dir, template_name)
       expect(eppface.dump(template)).to eq("")
-      expect(@logs.join).to match(/This Literal Integer has no effect.* line 1:4/)
+      expect(@logs.join).to match(/This Literal Integer has no effect.*\/template1.epp:1:4/)
     end
 
     it "informs the user of files that don't exist" do