puppet 6.16.0 → 7.0.0

data/spec/integration/util/windows/registry_spec.rb

@@ -259,23 +259,23 @@ describe Puppet::Util::Windows::Registry do
         {
           name: 'REG_SZ',
           type: Win32::Registry::REG_SZ,
-          value: "reg sz\u0000 string",
-          expected_value: "reg sz  string"
+          value: "reg sz\u0000\u0000 string",
+          expected_value: "reg sz"
         },
         {
           name: 'REG_SZ_2',
           type: Win32::Registry::REG_SZ,
-          value: "reg sz\x00 string",
-          expected_value: "reg sz  string"
+          value: "reg sz 2\x00\x00 string",
+          expected_value: "reg sz 2"
         },
         {
           name: 'REG_EXPAND_SZ',
           type: Win32::Registry::REG_EXPAND_SZ,
-          value: "\0reg expand string",
-          expected_value: " reg expand string"
+          value: "\0\0\0reg expand string",
+          expected_value: ""
         }
       ].each do |pair|
-        it 'replaces null bytes with spaces' do
+        it 'reads up to the first wide null' do
           hklm.create("#{puppet_key}\\#{subkey_name}", Win32::Registry::KEY_ALL_ACCESS) do |reg|
             reg.write(value_name, pair[:type], pair[:value])
           end

data/spec/integration/util/windows/security_spec.rb

@@ -822,7 +822,7 @@ describe "Puppet::Util::Windows::Security", :if => Puppet::Util::Platform.window
     end
 
     describe "locked files" do
-      let (:explorer) { File.join(Dir::WINDOWS, "explorer.exe") }
+      let (:explorer) { File.join(ENV['SystemRoot'], "explorer.exe") }
 
       it "should get the owner" do
         expect(winsec.get_owner(explorer)).to match(/^S-1-5-/)

data/spec/integration/util/windows/user_spec.rb

@@ -125,19 +125,16 @@ describe "Puppet::Util::Windows::User", :if => Puppet::Util::Platform.windows? d
       end
 
       it 'should raise error given that logon returns false' do
-
         allow(Puppet::Util::Windows::User).to receive(:logon_user_by_logon_type).with(
-            user, passwd, fLOGON32_LOGON_NETWORK, fLOGON32_PROVIDER_DEFAULT, anything).and_return (0)
+            user, '.', passwd, fLOGON32_LOGON_NETWORK, fLOGON32_PROVIDER_DEFAULT, anything).and_return (0)
         allow(Puppet::Util::Windows::User).to receive(:logon_user_by_logon_type).with(
-            user, passwd, fLOGON32_LOGON_INTERACTIVE, fLOGON32_PROVIDER_DEFAULT, anything).and_return(0)
+            user, '.', passwd, fLOGON32_LOGON_INTERACTIVE, fLOGON32_PROVIDER_DEFAULT, anything).and_return(0)
 
         expect {Puppet::Util::Windows::User.logon_user(user, passwd) {}}
             .to raise_error(Puppet::Util::Windows::Error, /Failed to logon user/)
-
       end
     end
 
-
     describe "password_is?" do
       it "should return false given an incorrect username and password" do
         expect(Puppet::Util::Windows::User.password_is?(username, bad_password)).to be_falsey
@@ -180,5 +177,50 @@ describe "Puppet::Util::Windows::User", :if => Puppet::Util::Platform.windows? d
         expect { Puppet::Util::Windows::User.check_token_membership }.not_to raise_error
       end
     end
+
+    describe "default_system_account?" do
+      it "should succesfully identify 'SYSTEM' user as a default system account" do
+        allow(Puppet::Util::Windows::SID).to receive(:name_to_sid).with('SYSTEM').and_return(Puppet::Util::Windows::SID::LocalSystem)
+        expect(Puppet::Util::Windows::User.default_system_account?('SYSTEM')).to eq(true)
+      end
+
+      it "should succesfully identify 'NETWORK SERVICE' user as a default system account" do
+        allow(Puppet::Util::Windows::SID).to receive(:name_to_sid).with('NETWORK SERVICE').and_return(Puppet::Util::Windows::SID::NtNetwork)
+        expect(Puppet::Util::Windows::User.default_system_account?('NETWORK SERVICE')).to eq(true)
+      end
+
+      it "should succesfully identify 'LOCAL SERVICE' user as a default system account" do
+        allow(Puppet::Util::Windows::SID).to receive(:name_to_sid).with('LOCAL SERVICE').and_return(Puppet::Util::Windows::SID::NtLocal)
+        expect(Puppet::Util::Windows::User.default_system_account?('LOCAL SERVICE')).to eq(true)
+      end
+
+      it "should not identify user with unknown sid as a default system account" do
+        allow(Puppet::Util::Windows::SID).to receive(:name_to_sid).with('UnknownUser').and_return(Puppet::Util::Windows::SID::Null)
+        expect(Puppet::Util::Windows::User.default_system_account?('UnknownUser')).to eq(false)
+      end
+    end
+
+    describe "localsystem?" do
+      before do
+        allow(Puppet::Util::Windows::ADSI).to receive(:computer_name).and_return("myPC")
+      end
+
+      ['LocalSystem', '.\LocalSystem', 'myPC\LocalSystem', 'lOcALsysTem'].each do |input|
+        it "should succesfully identify #{input} as the 'LocalSystem' account" do
+          expect(Puppet::Util::Windows::User.localsystem?(input)).to eq(true)
+        end
+      end
+
+      it "should not identify any other user as the 'LocalSystem' account" do
+        expect(Puppet::Util::Windows::User.localsystem?('OtherUser')).to eq(false)
+      end
+    end
+
+    describe "get_rights" do
+      it "should be empty when given user does not exist" do
+        allow(Puppet::Util::Windows::SID).to receive(:name_to_principal).with('NonExistingUser').and_return(nil)
+        expect(Puppet::Util::Windows::User.get_rights('NonExistingUser')).to eq("")
+      end
+    end
   end
 end

data/spec/integration/util_spec.rb

@@ -1,32 +1,9 @@
+# coding: utf-8
 require 'spec_helper'
 
 describe Puppet::Util do
   include PuppetSpec::Files
 
-  describe "#execute", unless: Puppet::Util::Platform.jruby? do
-    it "should properly allow stdout and stderr to share a file" do
-      command = "ruby -e '(1..10).each {|i| (i%2==0) ? $stdout.puts(i) : $stderr.puts(i)}'"
-
-      expect(Puppet::Util::Execution.execute(command, :combine => true).split).to match_array([*'1'..'10'])
-    end
-
-    it "should return output and set $CHILD_STATUS" do
-      command = "ruby -e 'puts \"foo\"; exit 42'"
-
-      output = Puppet::Util::Execution.execute(command, {:failonfail => false})
-
-      expect(output).to eq("foo\n")
-      expect($CHILD_STATUS.exitstatus).to eq(42)
-    end
-
-    it "should raise an error if non-zero exit status is returned" do
-      command = "ruby -e 'exit 43'"
-
-      expect { Puppet::Util::Execution.execute(command) }.to raise_error(Puppet::ExecutionFailure, /Execution of '#{command}' returned 43: /)
-      expect($CHILD_STATUS.exitstatus).to eq(43)
-    end
-  end
-
   describe "#replace_file on Windows", :if => Puppet::Util::Platform.windows? do
     it "replace_file should preserve original ACEs from existing replaced file on Windows" do
 
@@ -110,18 +87,15 @@ describe Puppet::Util do
   describe "#which on Windows", :if => Puppet::Util::Platform.windows? do
     let (:rune_utf8) { "\u16A0\u16C7\u16BB\u16EB\u16D2\u16E6\u16A6\u16EB\u16A0\u16B1\u16A9\u16A0\u16A2\u16B1\u16EB\u16A0\u16C1\u16B1\u16AA\u16EB\u16B7\u16D6\u16BB\u16B9\u16E6\u16DA\u16B3\u16A2\u16D7" }
     let (:filename) { 'foo.exe' }
-    let (:filepath) { File.expand_path('C:\\' + rune_utf8 + '\\' + filename) }
 
-    before :each do
-      allow(FileTest).to receive(:file?).and_return(false)
-      allow(FileTest).to receive(:file?).with(filepath).and_return(true)
+    it "should be able to use UTF8 characters in the path" do
+      utf8 = tmpdir(rune_utf8)
+      Puppet::FileSystem.mkpath(utf8)
 
-      allow(FileTest).to receive(:executable?).and_return(false)
-      allow(FileTest).to receive(:executable?).with(filepath).and_return(true)
-    end
+      filepath = File.join(utf8, filename)
+      Puppet::FileSystem.touch(filepath)
 
-    it "should be able to use UTF8 characters in the path" do
-      path = "C:\\" + rune_utf8 + "#{File::PATH_SEPARATOR}c:\\windows\\system32#{File::PATH_SEPARATOR}c:\\windows"
+      path = [utf8, "c:\\windows\\system32", "c:\\windows"].join(File::PATH_SEPARATOR)
       Puppet::Util.withenv( { "PATH" => path } , :windows) do
         expect(Puppet::Util.which(filename)).to eq(filepath)
       end

data/spec/lib/puppet_spec/matchers.rb

@@ -41,86 +41,6 @@ RSpec::Matchers.define :exit_with do |expected|
   end
 end
 
-
-RSpec::Matchers.define :have_printed do |expected|
-
-  case expected
-  when String, Regexp, Proc
-    expected = expected
-  else
-    expected = expected.to_s
-  end
-
-  chain :and_exit_with do |code|
-    @expected_exit_code = code
-  end
-
-  define_method :matches_exit_code? do |actual|
-    @expected_exit_code.nil? || @expected_exit_code == actual
-  end
-
-  define_method :matches_output? do |actual|
-    return false unless actual
-    case expected
-      when String
-        actual.include?(expected)
-      when Regexp
-        expected.match(actual)
-      when Proc
-        expected.call(actual)
-      else
-        raise ArgumentError, "No idea how to match a #{actual.class.name}"
-    end
-  end
-
-  match do |block|
-    $stderr = $stdout = StringIO.new
-    $stdout.set_encoding('UTF-8') if $stdout.respond_to?(:set_encoding)
-
-    begin
-      block.call
-    rescue SystemExit => e
-      raise unless @expected_exit_code
-      @actual_exit_code = e.status
-    ensure
-      $stdout.rewind
-      @actual = $stdout.read
-
-      $stdout = STDOUT
-      $stderr = STDERR
-    end
-
-    matches_output?(@actual) && matches_exit_code?(@actual_exit_code)
-  end
-
-  supports_block_expectations
-
-  failure_message do |actual|
-    if actual.nil? then
-      "expected #{expected.inspect}, but nothing was printed"
-    else
-      if !@expected_exit_code.nil? && matches_output?(actual)
-        "expected exit with code #{@expected_exit_code} but " +
-          (@actual_exit_code.nil? ? " exit was not called" : "exited with #{@actual_exit_code} instead")
-      else
-        "expected #{expected.inspect} to be printed; got:\n#{actual}"
-      end
-    end
-  end
-
-  failure_message_when_negated do |actual|
-    if @expected_exit_code && matches_exit_code?(@actual_exit_code)
-      "expected exit code to not be #{@actual_exit_code}"
-    else
-      "expected #{expected.inspect} to not be printed; got:\n#{actual}"
-    end
-  end
-
-  description do
-    "expect #{expected.inspect} to be printed" + (@expected_exit_code.nil ? '' : " with exit code #{@expected_exit_code}")
-  end
-end
-
 RSpec::Matchers.define :equal_attributes_of do |expected|
   match do |actual|
     actual.instance_variables.all? do |attr|

data/spec/lib/puppet_spec/puppetserver.rb

@@ -47,9 +47,13 @@ class PuppetSpec::Puppetserver
   class FilebucketServlet < WEBrick::HTTPServlet::AbstractServlet
     def do_GET request, response
     end
+
     def do_PUT request, response
+      upload = File.join(@config.config[:TempDir], 'filebucket')
+      File.open(upload, 'wb') { |f| f.write(request.body) }
       response['Content-Type'] = 'application/octet-stream'
     end
+
     def do_HEAD request, response
       response.status = 404
     end
@@ -99,7 +103,7 @@ class PuppetSpec::Puppetserver
   end
 
   def register_mounts(mounts: {})
-    register_mount('/status/v1/simple/master', proc { |req, res|  }, nil)
+    register_mount('/status/v1/simple/server', proc { |req, res|  }, nil)
     register_mount('/puppet/v3/node', mounts[:node], NodeServlet)
     register_mount('/puppet/v3/catalog', mounts[:catalog], CatalogServlet)
     register_mount('/puppet/v3/file_metadatas', mounts[:file_metadatas], FileMetadatasServlet)
@@ -116,4 +120,8 @@ class PuppetSpec::Puppetserver
               end
     @https.mount(path, handler)
   end
+
+  def upload_directory
+    @https.config[:TempDir]
+  end
 end

data/spec/lib/puppet_spec/settings.rb

@@ -11,8 +11,14 @@ module PuppetSpec::Settings
     :confdir      => { :type => :directory, :default => "test", :desc => "confdir" },
     :codedir      => { :type => :directory, :default => "test", :desc => "codedir" },
     :vardir       => { :type => :directory, :default => "test", :desc => "vardir" },
+    :publicdir    => { :type => :directory, :default => "test", :desc => "publicdir" },
     :rundir       => { :type => :directory, :default => "test", :desc => "rundir" },
-  }
+  }.freeze
+
+  TEST_APP_DEFAULT_VALUES = TEST_APP_DEFAULT_DEFINITIONS.inject({}) do |memo, (key, value)|
+    memo[key] = value[:default]
+    memo
+  end.freeze
 
   def set_puppet_conf(confdir, settings)
     write_file(File.join(confdir, "puppet.conf"), settings)

data/spec/shared_contexts/types_setup.rb

@@ -187,6 +187,8 @@ shared_context 'types_setup' do
     result << Puppet::Pops::Types::PURIType
     result << Puppet::Pops::Types::PTupleType.new([tf.rich_data])
     result << Puppet::Pops::Types::PObjectType
+    result << Puppet::Pops::Types::PTypeType
+    result << Puppet::Pops::Types::PTypeSetType
     result
   end
   def rich_data_compatible_types

data/spec/spec_helper.rb

@@ -148,6 +148,7 @@ RSpec.configure do |config|
 
     base = PuppetSpec::Files.tmpdir('tmp_settings')
     Puppet[:vardir] = File.join(base, 'var')
+    Puppet[:publicdir] = File.join(base, 'public')
     Puppet[:confdir] = File.join(base, 'etc')
     Puppet[:codedir] = File.join(base, 'code')
     Puppet[:logdir] = "$vardir/log"
@@ -155,6 +156,7 @@ RSpec.configure do |config|
     Puppet[:hiera_config] = File.join(base, 'hiera')
 
     FileUtils.mkdir_p Puppet[:statedir]
+    FileUtils.mkdir_p Puppet[:publicdir]
 
     Puppet::Test::TestHelper.before_each_test()
   end

data/spec/unit/agent_spec.rb

@@ -20,8 +20,6 @@ end
 
 describe Puppet::Agent do
   before do
-    allow(Puppet::Status.indirection).to receive(:find).and_return(Puppet::Status.new("version" => Puppet.version))
-
     @agent = Puppet::Agent.new(AgentTestClient, false)
 
     # make Puppet::Application safe for stubbing; restore in an :after block; silence warnings for this.

data/spec/unit/application/agent_spec.rb

@@ -571,10 +571,9 @@ describe Puppet::Application::Agent do
         allow_any_instance_of(Puppet::X509::CertProvider).to receive(:load_request).and_return(nil)
 
         expect {
-          expect {
-            @puppetd.fingerprint
-          }.to exit_with(1)
-        }.to output(/Fingerprint asked but neither the certificate, nor the certificate request have been issued/).to_stderr
+          @puppetd.fingerprint
+        }.to exit_with(1)
+         .and output(/Fingerprint asked but neither the certificate, nor the certificate request have been issued/).to_stderr
       end
 
       it "should log an error if an exception occurs" do

data/spec/unit/application/config_spec.rb

@@ -1,12 +1,232 @@
+# coding: utf-8
 require 'spec_helper'
 require 'puppet/application/config'
 
 describe Puppet::Application::Config do
-  it "should be a subclass of Puppet::Application::FaceBase" do
-    expect(Puppet::Application::Config.superclass).to equal(Puppet::Application::FaceBase)
+  include PuppetSpec::Files
+
+  # different UTF-8 widths
+  # 1-byte A
+  # 2-byte ۿ - http://www.fileformat.info/info/unicode/char/06ff/index.htm - 0xDB 0xBF / 219 191
+  # 3-byte ᚠ - http://www.fileformat.info/info/unicode/char/16A0/index.htm - 0xE1 0x9A 0xA0 / 225 154 160
+  # 4-byte 𠜎 - http://www.fileformat.info/info/unicode/char/2070E/index.htm - 0xF0 0xA0 0x9C 0x8E / 240 160 156 142
+  MIXED_UTF8 = "A\u06FF\u16A0\u{2070E}" # Aۿᚠ𠜎
+
+  let(:app) { Puppet::Application[:config] }
+
+  before :each do
+    Puppet[:config] = tmpfile('config')
+  end
+
+  def initialize_app(args)
+    app.command_line.args = args
+    # ensure global defaults are initialized prior to app defaults
+    Puppet.initialize_settings(args)
+  end
+
+  def read_utf8(path)
+    File.read(path, :encoding => 'UTF-8')
+  end
+
+  def write_utf8(path, content)
+    File.write(path, content, 0, :encoding => 'UTF-8')
+  end
+
+  context "when printing" do
+    it "prints a value" do
+      initialize_app(%w[print certname])
+
+      expect {
+        app.run
+      }.to exit_with(0)
+       .and output(a_string_matching(Puppet[:certname])).to_stdout
+    end
+
+    it "prints a value from a section" do
+      File.write(Puppet[:config], <<~END)
+        [main]
+        external_nodes=none
+        [server]
+        external_nodes=exec
+      END
+
+      initialize_app(%w[print external_nodes --section server])
+
+      expect {
+        app.run
+      }.to exit_with(0)
+       .and output(a_string_matching('exec')).to_stdout
+    end
+
+    it "doesn't require the environment to exist" do
+      initialize_app(%w[print certname --environment doesntexist])
+
+      expect {
+        app.run
+      }.to exit_with(0)
+       .and output(a_string_matching(Puppet[:certname])).to_stdout
+    end
   end
 
-  it "should set `environment_mode` to :not_required" do
-    expect(Puppet::Application::Config.get_environment_mode).to equal(:not_required)
+  context "when setting" do
+    it "sets a value in its config file" do
+      initialize_app(%w[set certname www.example.com])
+
+      expect {
+        app.run
+      }.to exit_with(0)
+
+      expect(File.read(Puppet[:config])).to eq("[main]\ncertname = www.example.com\n")
+    end
+
+    it "sets a value in the server section" do
+      initialize_app(%w[set external_nodes exec --section server])
+
+      expect {
+        app.run
+      }.to exit_with(0)
+
+      expect(File.read(Puppet[:config])).to eq("[server]\nexternal_nodes = exec\n")
+    end
+
+    {
+      %w[certname WWW.EXAMPLE.COM] => /Certificate names must be lower case/,
+      %w[log_level all] => /Invalid loglevel all/,
+      %w[disable_warnings true] => /Cannot disable unrecognized warning types 'true'/,
+      %w[strict on] => /Invalid value 'on' for parameter strict/,
+      %w[digest_algorithm rot13] => /Invalid value 'rot13' for parameter digest_algorithm/,
+      %w[http_proxy_password a#b] => /Passwords set in the http_proxy_password setting must be valid as part of a URL/,
+    }.each_pair do |args, message|
+      it "rejects #{args.join(' ')}" do
+        initialize_app(['set', *args])
+
+        expect {
+          app.run
+        }.to exit_with(1)
+         .and output(message).to_stderr
+      end
+    end
+
+    it 'sets unknown settings' do
+      initialize_app(['set', 'notarealsetting', 'true'])
+
+      expect {
+        app.run
+      }.to exit_with(0)
+
+      expect(File.read(Puppet[:config])).to eq("[main]\nnotarealsetting = true\n")
+    end
+  end
+
+  context "when deleting" do
+    it "deletes a value" do
+      initialize_app(%w[delete external_nodes])
+
+      File.write(Puppet[:config], <<~END)
+        [main]
+        external_nodes=none
+      END
+
+      expect {
+        app.run
+      }.to exit_with(0)
+       .and output(/Deleted setting from 'main': 'external_nodes=none'/).to_stdout
+
+      expect(File.read(Puppet[:config])).to eq("[main]\n")
+    end
+
+    it "warns when deleting a value that isn't set" do
+      initialize_app(%w[delete external_nodes])
+
+      File.write(Puppet[:config], "")
+
+      expect {
+        app.run
+      }.to exit_with(0)
+       .and output(a_string_matching("Warning: No setting found in configuration file for section 'main' setting name 'external_nodes'")).to_stderr
+
+      expect(File.read(Puppet[:config])).to eq("")
+    end
+
+    it "deletes a value from main" do
+      initialize_app(%w[delete external_nodes])
+
+      File.write(Puppet[:config], <<~END)
+        [main]
+        external_nodes=none
+      END
+
+      expect {
+        app.run
+      }.to exit_with(0)
+       .and output(/Deleted setting from 'main': 'external_nodes=none'/).to_stdout
+
+      expect(File.read(Puppet[:config])).to eq("[main]\n")
+    end
+
+    it "deletes a value from main a section" do
+      initialize_app(%w[delete external_nodes --section server])
+
+      File.write(Puppet[:config], <<~END)
+        [main]
+        external_nodes=none
+        [server]
+        external_nodes=exec
+      END
+
+      expect {
+        app.run
+      }.to exit_with(0)
+       .and output(/Deleted setting from 'server': 'external_nodes'/).to_stdout
+
+      expect(File.read(Puppet[:config])).to eq("[main]\nexternal_nodes=none\n[server]\n")
+    end
+  end
+
+  context "when managing UTF-8 values" do
+    it "reads a UTF-8 value" do
+      write_utf8(Puppet[:config], <<~EOF)
+        [main]
+        tags=#{MIXED_UTF8}
+      EOF
+
+      initialize_app(%w[print tags])
+
+      expect {
+        app.run
+      }.to exit_with(0)
+       .and output("#{MIXED_UTF8}\n").to_stdout
+    end
+
+    it "sets a UTF-8 value" do
+      initialize_app(['set', 'tags', MIXED_UTF8])
+
+      expect {
+        app.run
+      }.to exit_with(0)
+
+      expect(read_utf8(Puppet[:config])).to eq(<<~EOF)
+        [main]
+        tags = #{MIXED_UTF8}
+      EOF
+    end
+
+    it "deletes a UTF-8 value" do
+      initialize_app(%w[delete tags])
+
+      write_utf8(Puppet[:config], <<~EOF)
+        [main]
+        tags=#{MIXED_UTF8}
+      EOF
+
+      expect {
+        app.run
+      }.to exit_with(0)
+       .and output(/Deleted setting from 'main': 'tags=#{MIXED_UTF8}'/).to_stdout
+
+      expect(read_utf8(Puppet[:config])).to eq(<<~EOF)
+        [main]
+      EOF
+    end
   end
 end