puppet 5.0.0 → 6.0.0

data/spec/unit/util/yaml_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require 'spec_helper'
 
 require 'puppet/util/yaml'
@@ -7,56 +8,189 @@ describe Puppet::Util::Yaml do
 
   let(:filename) { tmpfile("yaml") }
 
-  it "reads a YAML file from disk" do
-    write_file(filename, YAML.dump({ "my" => "data" }))
+  shared_examples_for 'yaml file loader' do |load_method|
+    it 'returns false when the file is empty' do
+      Puppet::FileSystem.touch(filename)
 
-    expect(Puppet::Util::Yaml.load_file(filename)).to eq({ "my" => "data" })
-  end
+      expect(load_method.call(filename)).to eq(false)
+    end
 
-  it "writes data formatted as YAML to disk" do
-    Puppet::Util::Yaml.dump({ "my" => "data" }, filename)
+    it 'reads a YAML file from disk' do
+      write_file(filename, YAML.dump({ "my" => "data" }))
 
-    expect(Puppet::Util::Yaml.load_file(filename)).to eq({ "my" => "data" })
-  end
+      expect(load_method.call(filename)).to eq({ "my" => "data" })
+    end
 
-  it "raises an error when the file is invalid YAML" do
-    write_file(filename, "{ invalid")
+    it 'reads YAML as UTF-8' do
+      write_file(filename, YAML.dump({ "my" => "𠜎" }))
 
-    expect { Puppet::Util::Yaml.load_file(filename) }.to raise_error(Puppet::Util::Yaml::YamlLoadError)
+      expect(load_method.call(filename)).to eq({ "my" => "𠜎" })
+    end
   end
 
-  it "raises an error when the file does not exist" do
-    expect { Puppet::Util::Yaml.load_file("no") }.to raise_error(Puppet::Util::Yaml::YamlLoadError, /No such file or directory/)
+  context "#safe_load" do
+    it 'raises an error if YAML is invalid' do
+      expect {
+        Puppet::Util::Yaml.safe_load('{ invalid')
+      }.to raise_error(Puppet::Util::Yaml::YamlLoadError, %r[\(<unknown>\): .* at line \d+ column \d+])
+    end
+
+    it 'raises if YAML contains classes not in the list' do
+      expect {
+        Puppet::Util::Yaml.safe_load(<<FACTS, [])
+--- !ruby/object:Puppet::Node::Facts
+name: localhost
+FACTS
+      }.to raise_error(Puppet::Util::Yaml::YamlLoadError, "(<unknown>): Tried to load unspecified class: Puppet::Node::Facts")
+    end
+
+    it 'includes the filename if YAML contains classes not in the list' do
+      expect {
+        Puppet::Util::Yaml.safe_load(<<FACTS, [], 'foo.yaml')
+--- !ruby/object:Puppet::Node::Facts
+name: localhost
+FACTS
+      }.to raise_error(Puppet::Util::Yaml::YamlLoadError, "(foo.yaml): Tried to load unspecified class: Puppet::Node::Facts")
+    end
+
+    it 'allows classes to be loaded' do
+      facts = Puppet::Util::Yaml.safe_load(<<FACTS, [Puppet::Node::Facts])
+--- !ruby/object:Puppet::Node::Facts
+name: localhost
+values:
+  puppetversion: 6.0.0
+FACTS
+      expect(facts.name).to eq('localhost')
+    end
+
+    it 'returns false if the content is empty' do
+      expect(Puppet::Util::Yaml.safe_load('')).to eq(false)
+    end
+
+    it 'loads true' do
+      expect(Puppet::Util::Yaml.safe_load('true')).to eq(true)
+    end
+
+    it 'loads false' do
+      expect(Puppet::Util::Yaml.safe_load('false')).to eq(false)
+    end
+
+    it 'loads nil' do
+      expect(Puppet::Util::Yaml.safe_load(<<~YAML)).to eq('a' => nil)
+        ---
+        a: null
+      YAML
+    end
+
+    it 'loads a numeric' do
+      expect(Puppet::Util::Yaml.safe_load('42')).to eq(42)
+    end
+
+    it 'loads a string' do
+      expect(Puppet::Util::Yaml.safe_load('puppet')).to eq('puppet')
+    end
+
+    it 'loads an array' do
+      expect(Puppet::Util::Yaml.safe_load(<<~YAML)).to eq([1, 2])
+        ---
+        - 1
+        - 2
+      YAML
+    end
+
+    it 'loads a hash' do
+      expect(Puppet::Util::Yaml.safe_load(<<~YAML)).to eq('a' => 1, 'b' => 2)
+        ---
+        a: 1
+        b: 2
+      YAML
+    end
+
+    it 'loads an alias' do
+      expect(Puppet::Util::Yaml.safe_load(<<~YAML)).to eq('a' => [], 'b' => [])
+        ---
+        a: &1 []
+        b: *1
+      YAML
+    end
   end
 
-  it "raises an error when the filename is illegal" do
-    expect { Puppet::Util::Yaml.load_file("not\0allowed") }.to raise_error(Puppet::Util::Yaml::YamlLoadError, /null byte/)
+  context "#safe_load_file" do
+    it_should_behave_like 'yaml file loader', Puppet::Util::Yaml.method(:safe_load_file)
+
+    it 'raises an error when the file is invalid YAML' do
+      write_file(filename, '{ invalid')
+
+      expect {
+        Puppet::Util::Yaml.safe_load_file(filename)
+      }.to raise_error(Puppet::Util::Yaml::YamlLoadError, %r[\(#{filename}\): .* at line \d+ column \d+])
+    end
+
+    it 'raises an error when the filename is illegal' do
+      expect {
+        Puppet::Util::Yaml.safe_load_file("not\0allowed")
+      }.to raise_error(ArgumentError, /pathname contains null byte/)
+    end
+
+    it 'raises an error when the file does not exist' do
+      expect {
+        Puppet::Util::Yaml.safe_load_file('does/not/exist.yaml')
+      }.to raise_error(Errno::ENOENT, /No such file or directory/)
+    end
   end
 
-  context "when the file is empty" do
-    it "returns false" do
-      Puppet::FileSystem.touch(filename)
+  context '#load_file' do
+    it_should_behave_like 'yaml file loader', Puppet::Util::Yaml.method(:load_file)
+
+    it 'raises an error when the file is invalid YAML' do
+      write_file(filename, '{ invalid')
 
-      expect(Puppet::Util::Yaml.load_file(filename)).to be_falsey
+      expect {
+        Puppet::Util::Yaml.load_file(filename)
+      }.to raise_error(Puppet::Util::Yaml::YamlLoadError, %r{\(#{filename}\): .* at line \d+ column \d+})
     end
 
-    it "allows return value to be overridden" do
+    it 'raises an error when the filename is illegal' do
+      expect {
+        Puppet::Util::Yaml.load_file("not\0allowed")
+      }.to raise_error(Puppet::Util::Yaml::YamlLoadError, /null byte/)
+    end
+
+    it 'raises an error when the file does not exist' do
+      expect {
+        Puppet::Util::Yaml.load_file('does/not/exist.yaml')
+      }.to raise_error(Puppet::Util::Yaml::YamlLoadError, /No such file or directory/)
+    end
+
+    it 'allows return value to be overridden' do
       Puppet::FileSystem.touch(filename)
 
       expect(Puppet::Util::Yaml.load_file(filename, {})).to eq({})
     end
-  end
 
-  it "should allow one to strip ruby tags that would otherwise not parse" do
-    write_file(filename, "---\nweirddata: !ruby/hash:Not::A::Valid::Class {}")
+    it 'loads arbitrary objects' do
+      write_file(filename, "--- !ruby/object {}\n")
 
-    expect(Puppet::Util::Yaml.load_file(filename, {}, true)).to eq({"weirddata" => {}})
-  end
+      expect(Puppet::Util::Yaml.load_file(filename, {})).to be_instance_of(Object)
+    end
 
-  it "should not strip non-ruby tags" do
-    write_file(filename, "---\nweirddata: !binary |-\n          e21kNX04MTE4ZGY2NmM5MTc3OTg4ZWE4Y2JiOWEzMjMyNzFkYg==")
+    it 'should allow one to strip ruby tags that would otherwise not parse' do
+      write_file(filename, "---\nweirddata: !ruby/hash:Not::A::Valid::Class {}")
 
-    expect(Puppet::Util::Yaml.load_file(filename, {}, true)).to eq({"weirddata" => "{md5}8118df66c9177988ea8cbb9a323271db"})
+      expect(Puppet::Util::Yaml.load_file(filename, {}, true)).to eq({"weirddata" => {}})
+    end
+
+    it 'should not strip non-ruby tags' do
+      write_file(filename, "---\nweirddata: !binary |-\n          e21kNX04MTE4ZGY2NmM5MTc3OTg4ZWE4Y2JiOWEzMjMyNzFkYg==")
+
+      expect(Puppet::Util::Yaml.load_file(filename, {}, true)).to eq({"weirddata" => "{md5}8118df66c9177988ea8cbb9a323271db"})
+    end
+
+    it 'writes data formatted as YAML to disk' do
+      Puppet::Util::Yaml.dump({ "my" => "data" }, filename)
+
+      expect(Puppet::Util::Yaml.load_file(filename)).to eq({ "my" => "data" })
+    end
   end
 
   def write_file(name, contents)

data/spec/unit/util_spec.rb

@@ -11,7 +11,7 @@ describe Puppet::Util do
     @gte_ruby_2_4 ||= SemanticPuppet::Version.parse(RUBY_VERSION) >= SemanticPuppet::Version.parse('2.4.0')
   end
 
-  if Puppet.features.microsoft_windows?
+  if Puppet::Util::Platform.windows?
     def set_mode(mode, file)
       Puppet::Util::Windows::Security.set_mode(mode, file)
     end
@@ -30,7 +30,7 @@ describe Puppet::Util do
   end
 
   describe "#withenv" do
-    let(:mode) { Puppet.features.microsoft_windows? ? :windows : :posix }
+    let(:mode) { Puppet::Util::Platform.windows? ? :windows : :posix }
 
     before :each do
       @original_path = ENV["PATH"]
@@ -75,7 +75,7 @@ describe Puppet::Util do
     end
   end
 
-  describe "#withenv on POSIX", :unless => Puppet.features.microsoft_windows? do
+  describe "#withenv on POSIX", :unless => Puppet::Util::Platform.windows? do
     it "should preserve case" do
       # start with lower case key,
       env_key = SecureRandom.uuid.downcase
@@ -98,7 +98,7 @@ describe Puppet::Util do
     end
   end
 
-  describe "#withenv on Windows", :if => Puppet.features.microsoft_windows? do
+  describe "#withenv on Windows", :if => Puppet::Util::Platform.windows? do
 
     let(:process) { Puppet::Util::Windows::Process }
 
@@ -150,46 +150,9 @@ describe Puppet::Util do
     # Ruby retrieves / stores ENV names in the current codepage
     # when these tests no longer pass, Ruby has fixed its bugs and workarounds can be removed
 
-
-    # interestingly we would expect some of these tests to fail when codepage is 65001
-    # but instead the env values are in Encoding::ASCII_8BIT!
-    it "works around Ruby bug 8822 (which fails to preserve UTF-8 properly when accessing ENV) (Ruby <= 2.1) ",
-      :if => ((RUBY_VERSION =~ /^(1\.|2\.0\.|2\.1\.)/) && Puppet.features.microsoft_windows?) do
-
-      withenv_utf8 do |utf_8_key, utf_8_value, codepage_key|
-        # both a string in UTF-8 and current codepage are deemed valid keys to the hash
-        # which is because Ruby compares the BINARY versions of the string, but ignores encoding
-        expect(ENV.key?(codepage_key)).to eq(true)
-        expect(ENV.key?(utf_8_key)).to eq(true)
-
-        # Ruby's ENV.keys has slightly different behavior than ENV.key?(key)
-        # the keys collection in 2.1 has a string with the correct bytes
-        # (codepage_key / utf_8_key have same bytes for the sake of searching)
-        found = ENV.keys.find { |k| k.bytes == codepage_key.bytes }
-        # but the string is actually a binary string
-        expect(found.encoding).to eq(Encoding::BINARY)
-        # meaning we can't use include? to find it in either UTF-8 or codepage encoding
-        expect(ENV.keys.include?(codepage_key)).to eq(false)
-        expect(ENV.keys.include?(utf_8_key)).to eq(false)
-
-        # and can only search with a BINARY encoded string
-        expect(ENV.keys.include?(utf_8_key.dup.force_encoding(Encoding::BINARY))).to eq(true)
-
-        # similarly the value stored at the real key is in current codepage
-        # but won't match real UTF-8 value
-        env_value = ENV[utf_8_key]
-        expect(env_value).to_not eq(utf_8_value)
-        expect(env_value.encoding).to_not eq(Encoding::UTF_8)
-
-        # but it can be forced back to UTF-8 to make it match.. ugh
-        converted_value = ENV[utf_8_key].dup.force_encoding(Encoding::UTF_8)
-        expect(converted_value).to eq(utf_8_value)
-      end
-    end
-
-    # but in 2.3, the behavior is mostly correct when external codepage is 65001 / UTF-8
+    # In 2.3, the behavior is mostly correct when external codepage is 65001 / UTF-8
     it "works around Ruby bug 8822 (which fails to preserve UTF-8 properly when accessing ENV) (Ruby >= 2.3.x) ",
-      :if => ((match = RUBY_VERSION.match(/^2\.(\d+)\./)) && match.captures[0].to_i >= 3 && Puppet.features.microsoft_windows?) do
+      :if => Puppet::Util::Platform.windows? do
 
       raise 'This test requires a non-UTF8 codepage' if Encoding.default_external == Encoding::UTF_8
 
@@ -266,7 +229,7 @@ describe Puppet::Util do
       end
     end
 
-    describe "on windows", :if => Puppet.features.microsoft_windows? do
+    describe "on windows", :if => Puppet::Util::Platform.windows? do
       it "should default to the platform of the local system" do
         expect(Puppet::Util).to be_absolute_path('C:/foo')
         expect(Puppet::Util).not_to be_absolute_path('/foo')
@@ -336,17 +299,14 @@ describe Puppet::Util do
       path = "/foo+foo bar?foo+foo bar"
       uri = Puppet::Util.path_to_uri(path)
 
-      # Ruby 1.9.3 URI#to_s has a bug that returns ASCII always
-      # despite parts being UTF-8 strings
-      expected_encoding = RUBY_VERSION == '1.9.3' ? Encoding::ASCII : Encoding::UTF_8
-
+      expected_encoding = Encoding::UTF_8
       expect(uri.to_s.encoding).to eq(expected_encoding)
       expect(uri.path).to eq("/foo+foo%20bar")
       # either + or %20 is correct for an encoded space in query
       # + is usually used for backward compatibility, but %20 is preferred for compat with Uri.unescape
       expect(uri.query).to eq("foo%2Bfoo%20bar")
       # complete roundtrip
-      expect(URI.unescape(uri.to_s)).to eq("file:#{path}")
+      expect(URI.unescape(uri.to_s).sub(%r{^file:(//)?}, '')).to eq(path)
       expect(URI.unescape(uri.to_s).encoding).to eq(expected_encoding)
     end
 
@@ -360,7 +320,7 @@ describe Puppet::Util do
     describe "when using platform :posix" do
       before :each do
         Puppet.features.stubs(:posix).returns true
-        Puppet.features.stubs(:microsoft_windows?).returns false
+        Puppet::Util::Platform.stubs(:windows?).returns false
       end
 
       %w[/ /foo /foo/../bar].each do |path|
@@ -373,7 +333,7 @@ describe Puppet::Util do
     describe "when using platform :windows" do
       before :each do
         Puppet.features.stubs(:posix).returns false
-        Puppet.features.stubs(:microsoft_windows?).returns true
+        Puppet::Util::Platform.stubs(:windows?).returns true
       end
 
       it "should normalize backslashes" do
@@ -507,7 +467,7 @@ describe Puppet::Util do
     describe "when using platform :posix" do
       before :each do
         Puppet.features.stubs(:posix).returns true
-        Puppet.features.stubs(:microsoft_windows?).returns false
+        Puppet::Util::Platform.stubs(:windows?).returns false
       end
 
       %w[/ /foo /foo/../bar].each do |path|
@@ -546,7 +506,7 @@ describe Puppet::Util do
     describe "when using platform :windows" do
       before :each do
         Puppet.features.stubs(:posix).returns false
-        Puppet.features.stubs(:microsoft_windows?).returns true
+        Puppet::Util::Platform.stubs(:windows?).returns true
       end
 
       it "should url encode \\ as %5C, but not replace : as %3F" do
@@ -614,7 +574,7 @@ describe Puppet::Util do
       end
     end
 
-    describe "when using platform :windows", :if => Puppet.features.microsoft_windows? do
+    describe "when using platform :windows", :if => Puppet::Util::Platform.windows? do
       it "should accept root" do
         expect(Puppet::Util.uri_to_path(URI.parse('file:/C:/'))).to eq('C:/')
       end
@@ -680,7 +640,7 @@ describe Puppet::Util do
       Kernel.expects(:fork).returns(pid).yields
 
       Puppet::Util.safe_posix_fork do
-        message = "Fork this!"
+        "Fork this!"
       end
     end
 
@@ -713,7 +673,7 @@ describe Puppet::Util do
       env_path = %w[~/bin /usr/bin /bin].join(File::PATH_SEPARATOR)
 
       env = {:HOME => nil, :PATH => env_path}
-      env.merge!({:HOMEDRIVE => nil, :USERPROFILE => nil}) if Puppet.features.microsoft_windows?
+      env.merge!({:HOMEDRIVE => nil, :USERPROFILE => nil}) if Puppet::Util::Platform.windows?
 
       Puppet::Util.withenv(env) do
         Puppet::Util::Warnings.expects(:warnonce).once
@@ -739,7 +699,7 @@ describe Puppet::Util do
     describe "on POSIX systems" do
       before :each do
         Puppet.features.stubs(:posix?).returns true
-        Puppet.features.stubs(:microsoft_windows?).returns false
+        Puppet::Util::Platform.stubs(:windows?).returns false
       end
 
       it "should walk the search PATH returning the first executable" do
@@ -755,7 +715,7 @@ describe Puppet::Util do
 
       before :each do
         Puppet.features.stubs(:posix?).returns false
-        Puppet.features.stubs(:microsoft_windows?).returns true
+        Puppet::Util::Platform.stubs(:windows?).returns true
       end
 
       describe "when a file extension is specified" do
@@ -837,7 +797,7 @@ describe Puppet::Util do
     end
 
     it "should fail if no block is given" do
-      expect { subject.replace_file(target.path, 0600) }.to raise_error /block/
+      expect { subject.replace_file(target.path, 0600) }.to raise_error(/block/)
     end
 
     it "should replace a file when invoked" do
@@ -857,7 +817,7 @@ describe Puppet::Util do
     # Windows collapses the owner and group modes into a single ACE, resulting
     # in set(0600) => get(0660) and so forth. --daniel 2012-03-30
     modes = [0555, 0660, 0770]
-    modes += [0600, 0700] unless Puppet.features.microsoft_windows?
+    modes += [0600, 0700] unless Puppet::Util::Platform.windows?
     modes.each do |mode|
       it "should copy 0#{mode.to_s(8)} permissions from the target file by default" do
         set_mode(mode, target.path)
@@ -871,13 +831,13 @@ describe Puppet::Util do
       end
     end
 
-    it "should copy the permissions of the source file before yielding on Unix", :if => !Puppet.features.microsoft_windows? do
+    it "should copy the permissions of the source file after yielding on Unix", :if => !Puppet::Util::Platform.windows? do
       set_mode(0555, target.path)
       inode = Puppet::FileSystem.stat(target.path).ino
 
       yielded = false
-      subject.replace_file(target.path, 0600) do |fh|
-        expect(get_mode(fh.path)).to eq(0555)
+      subject.replace_file(target.path, 0660) do |fh|
+        expect(get_mode(fh.path)).to eq(0600)
         yielded = true
       end
       expect(yielded).to be_truthy
@@ -886,6 +846,20 @@ describe Puppet::Util do
       expect(get_mode(target.path)).to eq(0555)
     end
 
+    it "should be able to create a new file with read-only permissions when it doesn't already exist" do
+      temp_file = Tempfile.new('puppet-util-replace-file')
+      temp_path = temp_file.path
+      temp_file.close
+      temp_file.unlink
+
+      subject.replace_file(temp_path, 0440) do |fh|
+        fh.puts('some text in there')
+      end
+      
+      expect(File.read(temp_path)).to eq("some text in there\n")
+      expect(get_mode(temp_path)).to eq(0440)
+    end
+
     it "should use the default permissions if the source file doesn't exist" do
       new_target = target.path + '.foo'
       expect(Puppet::FileSystem.exist?(new_target)).to be_falsey
@@ -966,19 +940,10 @@ describe Puppet::Util do
       expect(rand()).not_to eql(rand_one)
     end
 
-    if defined?(Random) == 'constant' && Random.class == Class
-      it "should not fiddle with the global seed" do
-        srand(1234)
-        Puppet::Util.deterministic_rand(123,20)
-        expect(srand()).to eql(1234)
-      end
-    # ruby below 1.9.2 variant
-    else
-      it "should set a new global seed" do
-        srand(1234)
-        Puppet::Util.deterministic_rand(123,20)
-        expect(srand()).not_to eql(1234)
-      end
+    it "should not fiddle with the global seed" do
+      srand(1234)
+      Puppet::Util.deterministic_rand(123,20)
+      expect(srand()).to eql(1234)
     end
   end
 end

data/spec/watchr.rb

@@ -65,7 +65,6 @@ end
 def run_test(command)
   clear
   result = run_comp(command).split("\n").last
-  status = result.include?('0 failures, 0 errors') ? :pass : :fail
   growl result.split("\n").last rescue nil
 end
 

data/tasks/benchmark.rake

@@ -1,6 +1,7 @@
 require 'benchmark'
 require 'tmpdir'
 require 'csv'
+require 'objspace'
 
 namespace :benchmark do
   def generate_scenario_tasks(location, name)
@@ -99,6 +100,46 @@ namespace :benchmark do
         puts "Generated callgrind file: #{path}"
       end
 
+      desc "Print a memory profile of the #{name} scenario."
+      task :memory_profile, [*run_args] => :generate do |_, args|
+        begin
+          require 'memory_profiler'
+        rescue LoadError
+          abort("Run `bundle install --with development` to install the 'memory_profiler' gem.")
+        end
+
+        report = MemoryProfiler.report do
+          @benchmark.run(args)
+        end
+
+        path = "mem_profile_#{$PID}"
+        report.pretty_print(to_file: path)
+
+        puts "Generated memory profile: #{File.absolute_path(path)}"
+      end
+
+      desc "Generate a heap dump with object allocation tracing of the #{name} scenario."
+      task :heap_dump, [*run_args] => :generate do |_, args|
+        ObjectSpace.trace_object_allocations_start
+
+        if ENV['DISABLE_GC']
+          GC.disable
+        end
+
+        @benchmark.run(args)
+
+        unless ENV['DISABLE_GC']
+          GC.start
+        end
+
+        path = "heap_#{$PID}.json"
+        File.open(path, 'w') do |file|
+          ObjectSpace.dump_all(output: file)
+        end
+
+        puts "Generated heap dump: #{File.absolute_path(path)}"
+      end
+
       def to_millis(seconds)
         (seconds * 1000).round
       end

data/tasks/ci.rake

@@ -2,11 +2,6 @@ require 'yaml'
 require 'time'
 
 namespace "ci" do
-  task :spec do
-    ENV["LOG_SPEC_ORDER"] = "true"
-    sh %{rspec --require rspec/legacy_formatters -r yarjuf -f JUnit -o result.xml -fp spec}
-  end
-
   desc "Tar up the acceptance/ directory so that package test runs have tests to run against."
   task :acceptance_artifacts => :tag_creator do
     Dir.chdir("acceptance") do