puppet 5.3.4 → 6.29.0

data/spec/unit/application/lookup_spec.rb

@@ -13,7 +13,8 @@ describe Puppet::Application::Lookup do
     ensure
       $stdout = saved_stdout
     end
-    capture.string.strip
+    # Drop end of line and an optional yaml end of document
+    capture.string.gsub(/\n(\.\.\.\n)?\Z/m, '')
   end
 
   context "when running with incorrect command line options" do
@@ -29,7 +30,7 @@ describe Puppet::Application::Lookup do
     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'])
+      allow(lookup.command_line).to receive(:args).and_return(['atton', 'kreia'])
 
       expected_error = "The --merge option only accepts 'first', 'hash', 'unique', or 'deep'\nRun 'puppet lookup --help' for more details"
 
@@ -40,7 +41,7 @@ describe Puppet::Application::Lookup do
       lookup.options[:node] = 'dantooine.local'
       lookup.options[:merge_hash_arrays] = true
       lookup.options[:merge] = 'hash'
-      lookup.command_line.stubs(:args).returns(['atton', 'kreia'])
+      allow(lookup.command_line).to receive(:args).and_return(['atton', 'kreia'])
 
       expected_error = "The options --knock-out-prefix, --sort-merged-arrays, and --merge-hash-arrays are only available with '--merge deep'\nRun 'puppet lookup --help' for more details"
 
@@ -56,12 +57,12 @@ describe Puppet::Application::Lookup do
       lookup.options[:render_as] = :s;
       lookup.options[:merge_hash_arrays] = true
       lookup.options[:merge] = 'deep'
-      lookup.command_line.stubs(:args).returns(['atton', 'kreia'])
-      lookup.stubs(:generate_scope).yields('scope')
+      allow(lookup.command_line).to receive(:args).and_return(['atton', 'kreia'])
+      allow(lookup).to receive(:generate_scope).and_yield('scope')
 
       expected_merge = { "strategy" => "deep", "sort_merged_arrays" => false, "merge_hash_arrays" => true }
 
-      (Puppet::Pops::Lookup).expects(:lookup).with(['atton', 'kreia'], nil, nil, false, expected_merge, anything).returns('rand')
+      expect(Puppet::Pops::Lookup).to receive(:lookup).with(['atton', 'kreia'], nil, nil, false, expected_merge, anything).and_return('rand')
 
       expect(run_lookup(lookup)).to eql("rand")
     end
@@ -71,25 +72,26 @@ describe Puppet::Application::Lookup do
       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(run_lookup(lookup)).to eql("--- rand\n...")
+        lookup.options[:render_as] = :s
+        allow(lookup.command_line).to receive(:args).and_return(['atton', 'kreia'])
+        allow(lookup).to receive(:generate_scope).and_yield('scope')
+        allow(Puppet::Pops::Lookup).to receive(:lookup).and_return('rand')
+        expect(run_lookup(lookup)).to eql("rand")
       end
     end
 
     it "prints the value found by lookup" do
       lookup.options[:node] = 'dantooine.local'
-      lookup.command_line.stubs(:args).returns(['atton', 'kreia'])
-      lookup.stubs(:generate_scope).yields('scope')
+      lookup.options[:render_as] = :s
+      allow(lookup.command_line).to receive(:args).and_return(['atton', 'kreia'])
+      allow(lookup).to receive(:generate_scope).and_yield('scope')
 
-      Puppet::Pops::Lookup.stubs(:lookup).returns('rand')
+      allow(Puppet::Pops::Lookup).to receive(:lookup).and_return('rand')
 
-      expect(run_lookup(lookup)).to eql("--- rand\n...")
+      expect(run_lookup(lookup)).to eql("rand")
     end
   end
 
-
   context 'when given a valid configuration' do
     let (:lookup) { Puppet::Application[:lookup] }
 
@@ -269,7 +271,7 @@ describe Puppet::Application::Lookup do
     it '--explain produces human readable text by default and does not produce output to debug logger' do
       lookup.options[:node] = node
       lookup.options[:explain] = true
-      lookup.command_line.stubs(:args).returns(['a'])
+      allow(lookup.command_line).to receive(:args).and_return(['a'])
       logs = []
       Puppet::Util::Log.with_destination(Puppet::Test::LogCollector.new(logs)) do
         expect(run_lookup(lookup)).to eql(<<-EXPLANATION.chomp)
@@ -298,7 +300,7 @@ Searching for "a"
 
     it '--debug using multiple interpolation functions produces output to the logger' do
       lookup.options[:node] = node
-      lookup.command_line.stubs(:args).returns(['ab'])
+      allow(lookup.command_line).to receive(:args).and_return(['ab'])
       Puppet.debug = true
       logs = []
       begin
@@ -318,7 +320,7 @@ Searching for "a"
     it '--explain produces human readable text by default and --debug produces the same output to debug logger' do
       lookup.options[:node] = node
       lookup.options[:explain] = true
-      lookup.command_line.stubs(:args).returns(['a'])
+      allow(lookup.command_line).to receive(:args).and_return(['a'])
       Puppet.debug = true
       logs = []
       Puppet::Util::Log.with_destination(Puppet::Test::LogCollector.new(logs)) do
@@ -432,7 +434,7 @@ Lookup of '__global__'
       lookup.options[:node] = node
       lookup.options[:explain] = true
       lookup.options[:explain_options] = true
-      lookup.command_line.stubs(:args).returns(['a'])
+      allow(lookup.command_line).to receive(:args).and_return(['a'])
       expect(run_lookup(lookup)).to eql(<<-EXPLANATION.chomp)
 Searching for "lookup_options"
   Global Data Provider (hiera configuration version 5)
@@ -459,16 +461,16 @@ Searching for "a"
       lookup.options[:node] = node
       lookup.options[:explain] = true
       lookup.options[:render_as] = :yaml
-      lookup.command_line.stubs(:args).returns(['a'])
+      allow(lookup.command_line).to receive(:args).and_return(['a'])
       output = run_lookup(lookup)
-      expect(YAML.load(output)).to eq(expected_yaml_hash)
+      expect(Puppet::Util::Yaml.safe_load(output, [Symbol])).to eq(expected_yaml_hash)
     end
 
     it 'can produce a json explanation' do
       lookup.options[:node] = node
       lookup.options[:explain] = true
       lookup.options[:render_as] = :json
-      lookup.command_line.stubs(:args).returns(['a'])
+      allow(lookup.command_line).to receive(:args).and_return(['a'])
       output = run_lookup(lookup)
       expect(JSON.parse(output)).to eq(expected_json_hash)
     end
@@ -476,7 +478,7 @@ Searching for "a"
     it 'can access values using dotted keys' do
       lookup.options[:node] = node
       lookup.options[:render_as] = :json
-      lookup.command_line.stubs(:args).returns(['d.one.two.three'])
+      allow(lookup.command_line).to receive(:args).and_return(['d.one.two.three'])
       output = run_lookup(lookup)
       expect(JSON.parse("[#{output}]")).to eq(['the value'])
     end
@@ -484,7 +486,7 @@ Searching for "a"
     it 'can access values using quoted dotted keys' do
       lookup.options[:node] = node
       lookup.options[:render_as] = :json
-      lookup.command_line.stubs(:args).returns(['"e.one.two.three"'])
+      allow(lookup.command_line).to receive(:args).and_return(['"e.one.two.three"'])
       output = run_lookup(lookup)
       expect(JSON.parse("[#{output}]")).to eq(['the value'])
     end
@@ -492,7 +494,7 @@ Searching for "a"
     it 'can access values using mix of dotted keys and quoted dotted keys' do
       lookup.options[:node] = node
       lookup.options[:render_as] = :json
-      lookup.command_line.stubs(:args).returns(['"f.one"."two.three".1'])
+      allow(lookup.command_line).to receive(:args).and_return(['"f.one"."two.three".1'])
       output = run_lookup(lookup)
       expect(JSON.parse("[#{output}]")).to eq(['second value'])
     end
@@ -502,43 +504,168 @@ Searching for "a"
 
       it "is unaffected by global variables unless '--compile' is used" do
         lookup.options[:node] = node
-        lookup.command_line.stubs(:args).returns(['c'])
-        expect(run_lookup(lookup)).to eql("--- This is\n...")
+        lookup.options[:render_as] = :s
+        allow(lookup.command_line).to receive(:args).and_return(['c'])
+        expect(run_lookup(lookup)).to eql("This is")
       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(run_lookup(lookup)).to eql("--- This is C from site.pp\n...")
+        lookup.options[:render_as] = :s
+        allow(lookup.command_line).to receive(:args).and_return(['c'])
+        expect(run_lookup(lookup)).to eql("This is C from site.pp")
       end
 
       it 'receives extra facts in top scope' do
-        file_path = tmpdir('lookup_spec')
-        filename = File.join(file_path, "facts.yaml")
-        File.open(filename, "w+") { |f| f.write(<<-YAML.unindent) }
+        file_path = file_containing('facts.yaml', <<~CONTENT)
           ---
           cx: ' C from facts'
-          YAML
+        CONTENT
 
         lookup.options[:node] = node
-        lookup.options[:fact_file] = filename
-        lookup.command_line.stubs(:args).returns(['c'])
-        expect(run_lookup(lookup)).to eql("--- This is C from facts\n...")
+        lookup.options[:fact_file] = file_path
+        lookup.options[:render_as] = :s
+        allow(lookup.command_line).to receive(:args).and_return(['c'])
+        expect(run_lookup(lookup)).to eql("This is C from facts")
       end
 
       it 'receives extra facts in the facts hash' do
-        file_path = tmpdir('lookup_spec')
-        filename = File.join(file_path, "facts.yaml")
-        File.open(filename, "w+") { |f| f.write(<<-YAML.unindent) }
+        file_path = file_containing('facts.yaml', <<~CONTENT)
           ---
           cx: ' G from facts'
-        YAML
+        CONTENT
 
         lookup.options[:node] = node
-        lookup.options[:fact_file] = filename
-        lookup.command_line.stubs(:args).returns(['g'])
-        expect(run_lookup(lookup)).to eql("--- This is G from facts in facts hash\n...")
+        lookup.options[:fact_file] = file_path
+        lookup.options[:render_as] = :s
+        allow(lookup.command_line).to receive(:args).and_return(['g'])
+        expect(run_lookup(lookup)).to eql("This is G from facts in facts hash")
+      end
+
+      describe 'when retrieving given facts' do
+        before do
+          lookup.options[:node] = node
+          allow(lookup.command_line).to receive(:args).and_return(['g'])
+        end
+
+        it 'loads files with yaml extension as yaml on first try' do
+          file_path = file_containing('facts.yaml', <<~CONTENT)
+            ---
+            cx: ' G from facts'
+          CONTENT
+          lookup.options[:fact_file] = file_path
+
+          expect(Puppet::Util::Yaml).to receive(:safe_load_file).with(file_path, []).and_call_original
+          run_lookup(lookup)
+        end
+
+        it 'loads files with yml extension as yaml on first try' do
+          file_path = file_containing('facts.yml', <<~CONTENT)
+            ---
+            cx: ' G from facts'
+          CONTENT
+          lookup.options[:fact_file] = file_path
+
+          expect(Puppet::Util::Yaml).to receive(:safe_load_file).with(file_path, []).and_call_original
+          run_lookup(lookup)
+        end
+
+        it 'loads files with json extension as json on first try' do
+          file_path = file_containing('facts.json', <<~CONTENT)
+            {
+              "cx": " G from facts"
+            }
+          CONTENT
+          lookup.options[:fact_file] = file_path
+
+          expect(Puppet::Util::Json).to receive(:load_file).with(file_path, {}).and_call_original
+          run_lookup(lookup)
+        end
+
+        it 'detects file format accordingly even with random file extension' do
+          file_path = file_containing('facts.txt', <<~CONTENT)
+            {
+              "cx": " G from facts"
+            }
+          CONTENT
+          lookup.options[:fact_file] = file_path
+
+          expect(Puppet::Util::Json).to receive(:load_file_if_valid).with(file_path).and_call_original
+          expect(Puppet::Util::Yaml).not_to receive(:safe_load_file_if_valid).with(file_path)
+          run_lookup(lookup)
+        end
+
+        it 'detects file without extension as json due to valid contents' do
+          file_path = file_containing('facts', <<~CONTENT)
+            {
+              "cx": " G from facts"
+            }
+          CONTENT
+          lookup.options[:fact_file] = file_path
+
+          expect(Puppet::Util::Json).to receive(:load_file_if_valid).with(file_path).and_call_original
+          expect(Puppet::Util::Yaml).not_to receive(:safe_load_file_if_valid).with(file_path)
+          run_lookup(lookup)
+        end
+
+        it 'detects file without extension as yaml due to valid contents' do
+          file_path = file_containing('facts', <<~CONTENT)
+            ---
+            cx: ' G from facts'
+          CONTENT
+          lookup.options[:fact_file] = file_path
+
+          expect(Puppet::Util::Json.load_file_if_valid(file_path)).to be_nil
+          expect(Puppet::Util::Yaml).to receive(:safe_load_file_if_valid).with(file_path).and_call_original
+          run_lookup(lookup)
+        end
+
+        it 'raises error due to invalid contents' do
+          file_path = file_containing('facts.yml', <<~CONTENT)
+            INVALID CONTENT
+          CONTENT
+          lookup.options[:fact_file] = file_path
+
+          expect {
+            lookup.run_command
+          }.to raise_error(/Incorrectly formatted data in .+ given via the --facts flag \(only accepts yaml and json files\)/)
+        end
+
+        it "fails when a node doesn't have facts" do
+          lookup.options[:node] = "bad.node"
+          allow(lookup.command_line).to receive(:args).and_return(['c'])
+
+          expected_error = "No facts available for target node: #{lookup.options[:node]}"
+          expect { lookup.run_command }.to raise_error(RuntimeError, expected_error)
+        end
+
+        it 'raises error due to missing trusted information facts in --facts file' do
+          file_path = file_containing('facts.yaml', <<~CONTENT)
+            ---
+            fqdn: some.fqdn.com
+          CONTENT
+          lookup.options[:fact_file] = file_path
+
+          expect {
+            lookup.run_command
+          }.to raise_error(/When overriding any of the hostname,domain,fqdn,clientcert facts with #{file_path} given via the --facts flag, they must all be overridden./)
+        end
+
+        it 'does not fail when all trusted information facts are provided via --facts file' do
+          file_path = file_containing('facts.yaml', <<~CONTENT)
+            ---
+            fqdn: some.fqdn.com
+            hostname: some.hostname
+            domain: some.domain
+            clientcert: some.clientcert
+          CONTENT
+          lookup.options[:fact_file] = file_path
+
+          expect {
+            lookup.run_command
+          }.to exit_with(0)
+        end
       end
     end
 
@@ -547,15 +674,17 @@ Searching for "a"
 
       it "works OK in the absense of '--compile'" do
         lookup.options[:node] = node
-        lookup.command_line.stubs(:args).returns(['c'])
-        expect(run_lookup(lookup)).to eql("--- This is C from data.pp\n...")
+        allow(lookup.command_line).to receive(:args).and_return(['c'])
+        lookup.options[:render_as] = :s
+        expect(run_lookup(lookup)).to eql("This is C from data.pp")
       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(run_lookup(lookup)).to eql("--- This is C from site.pp\n...")
+        lookup.options[:render_as] = :s
+        allow(lookup.command_line).to receive(:args).and_return(['c'])
+        expect(run_lookup(lookup)).to eql("This is C from site.pp")
       end
     end
   end

data/spec/unit/application/man_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'puppet/face'
+
+describe Puppet::Face[:man, :current] do
+  let(:pager) { '/path/to/our/pager' }
+
+  around do |example|
+    Puppet::Util.withenv('MANPAGER' => pager) do
+      example.run
+    end
+  end
+
+  it 'is deprecated' do
+    expect(subject).to be_deprecated
+  end
+
+  it 'has a man action' do
+    expect(subject).to be_action(:man)
+  end
+
+  it 'accepts a call with no arguments' do
+    expect { subject.man }.to output(/USAGE: puppet man <action>/).to_stdout
+  end
+
+  it 'raises an ArgumentError when given too many arguments' do
+    expect {
+      subject.man(:man, 'agent', 'extra')
+    }.to raise_error(ArgumentError)
+     .and output(/USAGE: puppet man <action>/).to_stdout
+  end
+
+  it "exits with 0 when generating man documentation for each available application" do
+    # turn off deprecation warning
+    Puppet[:disable_warnings] = ['deprecations']
+
+    allow(Puppet::Util).to receive(:which).with('ronn').and_return(nil)
+    allow(Puppet::Util).to receive(:which).with(pager).and_return(pager)
+
+    Puppet::Application.available_application_names.each do |name|
+      next if %w{man face_base indirection_base}.include? name
+
+      app = Puppet::Application[:man]
+      app.command_line.args << 'man' << name
+
+      expect {
+        allow(IO).to receive(:popen).with(pager, 'w:UTF-8').and_yield($stdout)
+        app.run
+      }.to exit_with(0)
+       .and output(/puppet-#{name}/m).to_stdout
+    end
+  end
+end