puppet 4.0.0 → 4.9.1

data/ext/windows/puppet_shell.bat

@@ -0,0 +1,9 @@
+@echo off
+SETLOCAL
+if exist "%~dp0environment.bat" (
+  call "%~dp0environment.bat" %0 %*
+) else (
+  SET "PATH=%~dp0;%PATH%"
+)
+REM Display Ruby version
+ruby.exe -v

data/ext/windows/run_puppet_interactive.bat

@@ -0,0 +1,9 @@
+@echo Running puppet on demand ...
+@echo off
+SETLOCAL
+if exist "%~dp0environment.bat" (
+  call "%~dp0environment.bat" %0 %*
+) else (
+  SET "PATH=%~dp0;%PATH%"
+)
+elevate.exe "%~dp0puppet_interactive.bat"

data/ext/windows/service/daemon.rb

@@ -123,7 +123,8 @@ class WindowsDaemon < Win32::Daemon
   def log(msg, level)
     if LEVELS.index(level) >= @loglevel
       if (@LOG_TO_FILE)
-        File.open(LOG_FILE, 'a') { |f| f.puts("#{Time.now} Puppet (#{level}): #{msg}") }
+        # without this change its possible that we get Encoding errors trying to write UTF-8 messages in current codepage
+        File.open(LOG_FILE, 'a:UTF-8') { |f| f.puts("#{Time.now} Puppet (#{level}): #{msg}") }
       end
 
       case level

data/ext/yaml_nodes.rb

@@ -30,7 +30,7 @@
 #   you may not use this file except in compliance with the License.
 #   You may obtain a copy of the License at
 #
-#       http://www.apache.org/licenses/LICENSE-2.0
+#       https://www.apache.org/licenses/LICENSE-2.0
 #
 #   Unless required by applicable law or agreed to in writing, software
 #   distributed under the License is distributed on an "AS IS" BASIS,

data/install.rb

@@ -33,13 +33,6 @@ require 'rbconfig'
 require 'find'
 require 'fileutils'
 require 'tempfile'
-begin
-  require 'ftools' # apparently on some system ftools doesn't get loaded
-  $haveftools = true
-rescue LoadError
-  puts "ftools not found.  Using FileUtils instead.."
-  $haveftools = false
-end
 require 'optparse'
 require 'ostruct'
 
@@ -67,21 +60,13 @@ def do_configs(configs, target, strip = 'conf/')
   Dir.mkdir(target) unless File.directory? target
   configs.each do |cf|
     ocf = File.join(InstallOptions.config_dir, cf.gsub(/#{strip}/, ''))
-    if $haveftools
-      File.install(cf, ocf, 0644, true)
-    else
-      FileUtils.install(cf, ocf, {:mode => 0644, :preserve => true, :verbose => true})
-    end
+    FileUtils.install(cf, ocf, {:mode => 0644, :preserve => true, :verbose => true})
   end
 
   if $operatingsystem == 'windows'
     src_dll = 'ext/windows/eventlog/puppetres.dll'
     dst_dll = File.join(InstallOptions.bin_dir, 'puppetres.dll')
-    if $haveftools
-      File.install(src_dll, dst_dll, 0644, true)
-    else
-      FileUtils.install(src_dll, dst_dll, {:mode => 0644, :preserve => true, :verbose => true})
-    end
+    FileUtils.install(src_dll, dst_dll, {:mode => 0644, :preserve => true, :verbose => true})
 
     require 'win32/registry'
     include Win32::Registry::Constants
@@ -110,15 +95,9 @@ def do_libs(libs, strip = 'lib/')
     next if File.directory? lf
     olf = File.join(InstallOptions.site_dir, lf.sub(/^#{strip}/, ''))
     op = File.dirname(olf)
-    if $haveftools
-      File.makedirs(op, true)
-      File.chmod(0755, op)
-      File.install(lf, olf, 0644, true)
-    else
-      FileUtils.makedirs(op, {:mode => 0755, :verbose => true})
-      FileUtils.chmod(0755, op)
-      FileUtils.install(lf, olf, {:mode => 0644, :preserve => true, :verbose => true})
-    end
+    FileUtils.makedirs(op, {:mode => 0755, :verbose => true})
+    FileUtils.chmod(0755, op)
+    FileUtils.install(lf, olf, {:mode => 0644, :preserve => true, :verbose => true})
   end
 end
 
@@ -126,18 +105,27 @@ def do_man(man, strip = 'man/')
   man.each do |mf|
     omf = File.join(InstallOptions.man_dir, mf.gsub(/#{strip}/, ''))
     om = File.dirname(omf)
-    if $haveftools
-      File.makedirs(om, true)
-      File.chmod(0755, om)
-      File.install(mf, omf, 0644, true)
-    else
-      FileUtils.makedirs(om, {:mode => 0755, :verbose => true})
-      FileUtils.chmod(0755, om)
-      FileUtils.install(mf, omf, {:mode => 0644, :preserve => true, :verbose => true})
+    FileUtils.makedirs(om, {:mode => 0755, :verbose => true})
+    FileUtils.chmod(0755, om)
+    FileUtils.install(mf, omf, {:mode => 0644, :preserve => true, :verbose => true})
+    # Solaris does not support gzipped man pages. When called with
+    # --no-check-prereqs/without facter the default gzip behavior still applies
+    unless $operatingsystem == "Solaris"
+      gzip = %x{which gzip}
+      gzip.chomp!
+      %x{#{gzip} -f #{omf}}
     end
-    gzip = %x{which gzip}
-    gzip.chomp!
-    %x{#{gzip} -f #{omf}}
+  end
+end
+
+def do_locales(locale, strip = 'locales/')
+  locale.each do |lf|
+    next if File.directory? lf
+    olf = File.join(InstallOptions.locale_dir, lf.sub(/^#{strip}/, ''))
+    op = File.dirname(olf)
+    FileUtils.makedirs(op, {:mode => 0755, :verbose => true})
+    FileUtils.chmod(0755, op)
+    FileUtils.install(lf, olf, {:mode => 0644, :preserve => true, :verbose => true})
   end
 end
 
@@ -166,14 +154,14 @@ end
 # Prepare the file installation.
 #
 def prepare_installation
-  $operatingsystem = Facter.value :operatingsystem
-
   InstallOptions.configs = true
+  InstallOptions.check_prereqs = true
+  InstallOptions.batch_files = true
 
   # Only try to do docs if we're sure they have rdoc
   if $haverdoc
     InstallOptions.rdoc  = true
-    InstallOptions.ri  = $operatingsystem != "windows"
+    InstallOptions.ri  = true
   else
     InstallOptions.rdoc  = false
     InstallOptions.ri  = false
@@ -217,6 +205,9 @@ def prepare_installation
     opts.on('--bindir[=OPTIONAL]', 'Installation directory for binaries', 'overrides RbConfig::CONFIG["bindir"]') do |bindir|
       InstallOptions.bindir = bindir
     end
+    opts.on('--localedir[=OPTIONAL]', 'Installation directory for locale information', 'Default /opt/puppetlabs/puppet/share/locale') do |localedir|
+      InstallOptions.localedir = localedir
+    end
     opts.on('--ruby[=OPTIONAL]', 'Ruby interpreter to use with installation', 'overrides ruby used to call install.rb') do |ruby|
       InstallOptions.ruby = ruby
     end
@@ -226,6 +217,12 @@ def prepare_installation
     opts.on('--mandir[=OPTIONAL]', 'Installation directory for man pages', 'overrides RbConfig::CONFIG["mandir"]') do |mandir|
       InstallOptions.mandir = mandir
     end
+    opts.on('--[no-]check-prereqs', 'Prevents validation of prerequisite libraries', 'Default on') do |prereq|
+      InstallOptions.check_prereqs = prereq
+    end
+    opts.on('--no-batch-files', 'Prevents installation of batch files for windows', 'Default off') do |batch_files|
+      InstallOptions.batch_files = false
+    end
     opts.on('--quick', 'Performs a quick installation. Only the', 'installation is done.') do |quick|
       InstallOptions.rdoc    = false
       InstallOptions.ri      = false
@@ -256,15 +253,26 @@ def prepare_installation
     RbConfig::CONFIG['bindir'] = "/usr/bin"
   end
 
-  if not InstallOptions.configdir.nil?
-    configdir = InstallOptions.configdir
-  elsif $operatingsystem == "windows"
+  # Here we only set $operatingsystem if we have opted to check for prereqs.
+  # Otherwise facter won't be guaranteed to be present.
+  if InstallOptions.check_prereqs
+    check_prereqs
+    $operatingsystem = Facter.value :operatingsystem
+  end
+
+  if $operatingsystem == "windows"
     begin
+      # populates constants used to specify default Windows directories
       require 'win32/dir'
     rescue LoadError => e
       puts "Cannot run on Microsoft Windows without the win32-process, win32-dir & win32-service gems: #{e}"
       exit -1
     end
+  end
+
+  if not InstallOptions.configdir.nil?
+    configdir = InstallOptions.configdir
+  elsif $operatingsystem == "windows"
     configdir = File.join(Dir::COMMON_APPDATA, "PuppetLabs", "puppet", "etc")
   else
     configdir = "/etc/puppetlabs/puppet"
@@ -308,6 +316,16 @@ def prepare_installation
     bindir = RbConfig::CONFIG['bindir']
   end
 
+  if not InstallOptions.localedir.nil?
+    localedir = InstallOptions.localedir
+  else
+    if $operatingsystem == "windows"
+      localedir = File.join(Dir::PROGRAM_FILES, "Puppet Labs", "Puppet", "puppet", "share", "locale")
+    else
+      localedir = "/opt/puppetlabs/puppet/share/locale"
+    end
+  end
+
   if not InstallOptions.sitelibdir.nil?
     sitelibdir = InstallOptions.sitelibdir
   else
@@ -345,6 +363,7 @@ def prepare_installation
   rundir = join(destdir, rundir)
   logdir = join(destdir, logdir)
   bindir = join(destdir, bindir)
+  localedir = join(destdir, localedir)
   mandir = join(destdir, mandir)
   sitelibdir = join(destdir, sitelibdir)
 
@@ -356,6 +375,7 @@ def prepare_installation
   FileUtils.makedirs(vardir)
   FileUtils.makedirs(rundir)
   FileUtils.makedirs(logdir)
+  FileUtils.makedirs(localedir)
 
   InstallOptions.site_dir = sitelibdir
   InstallOptions.codedir = codedir
@@ -366,6 +386,7 @@ def prepare_installation
   InstallOptions.var_dir = vardir
   InstallOptions.run_dir = rundir
   InstallOptions.log_dir = logdir
+  InstallOptions.locale_dir = localedir
 end
 
 ##
@@ -395,6 +416,7 @@ end
 
 def build_ri(files)
   return unless $haverdoc
+  return if $operatingsystem == "windows"
   begin
     ri = RDoc::RDoc.new
     #ri.document(["--ri-site", "--merge"] + files)
@@ -423,40 +445,45 @@ def install_binfile(from, op_file, target)
 
   File.open(from) do |ip|
     File.open(tmp_file.path, "w") do |op|
-      op.puts "#!#{ruby}"
+      op.puts "#!#{ruby}" unless $operatingsystem == "windows"
       contents = ip.readlines
       contents.shift if contents[0] =~ /^#!/
       op.write contents.join
     end
   end
 
-  if $operatingsystem == "windows"
+  if $operatingsystem == "windows" && InstallOptions.batch_files
     installed_wrapper = false
 
-    if File.exists?("#{from}.bat")
-      FileUtils.install("#{from}.bat", File.join(target, "#{op_file}.bat"), :mode => 0755, :preserve => true, :verbose => true)
-      installed_wrapper = true
-    end
+    unless File.extname(from).match(/\.(cmd|bat)/)
+      if File.exists?("#{from}.bat")
+        FileUtils.install("#{from}.bat", File.join(target, "#{op_file}.bat"), :mode => 0755, :preserve => true, :verbose => true)
+        installed_wrapper = true
+      end
 
-    if File.exists?("#{from}.cmd")
-      FileUtils.install("#{from}.cmd", File.join(target, "#{op_file}.cmd"), :mode => 0755, :preserve => true, :verbose => true)
-      installed_wrapper = true
-    end
+      if File.exists?("#{from}.cmd")
+        FileUtils.install("#{from}.cmd", File.join(target, "#{op_file}.cmd"), :mode => 0755, :preserve => true, :verbose => true)
+        installed_wrapper = true
+      end
 
-    if not installed_wrapper
-      tmp_file2 = Tempfile.new('puppet-wrapper')
-      cwv = <<-EOS
+      if not installed_wrapper
+        tmp_file2 = Tempfile.new('puppet-wrapper')
+        cwv = <<-EOS
 @echo off
-setlocal
-set RUBY_BIN=%~dp0
-set RUBY_BIN=%RUBY_BIN:\\=/%
-"%RUBY_BIN%ruby.exe" -x "%RUBY_BIN%puppet" %*
+SETLOCAL
+if exist "%~dp0environment.bat" (
+  call "%~dp0environment.bat" %0 %*
+) else (
+  SET "PATH=%~dp0;%PATH%"
+)
+ruby.exe -S -- puppet %*
 EOS
-      File.open(tmp_file2.path, "w") { |cw| cw.puts cwv }
-      FileUtils.install(tmp_file2.path, File.join(target, "#{op_file}.bat"), :mode => 0755, :preserve => true, :verbose => true)
+        File.open(tmp_file2.path, "w") { |cw| cw.puts cwv }
+        FileUtils.install(tmp_file2.path, File.join(target, "#{op_file}.bat"), :mode => 0755, :preserve => true, :verbose => true)
 
-      tmp_file2.unlink
-      installed_wrapper = true
+        tmp_file2.unlink
+        installed_wrapper = true
+      end
     end
   end
   FileUtils.install(tmp_file.path, File.join(target, op_file), :mode => 0755, :preserve => true, :verbose => true)
@@ -472,14 +499,20 @@ FileUtils.cd File.dirname(__FILE__) do
   ri    = glob(%w{bin/*.rb lib/**/*.rb}).reject { |e| e=~ /\.(bat|cmd)$/ }
   man   = glob(%w{man/man[0-9]/*})
   libs  = glob(%w{lib/**/*})
+  locales = glob(%w{locales/**/*})
 
-  check_prereqs
   prepare_installation
 
+  if $operatingsystem == "windows"
+    windows_bins = glob(%w{ext/windows/*bat})
+  end
+
   #build_rdoc(rdoc) if InstallOptions.rdoc
   #build_ri(ri) if InstallOptions.ri
   do_configs(configs, InstallOptions.config_dir) if InstallOptions.configs
   do_bins(bins, InstallOptions.bin_dir)
+  do_bins(windows_bins, InstallOptions.bin_dir, 'ext/windows/') if $operatingsystem == "windows" && InstallOptions.batch_files
   do_libs(libs)
+  do_locales(locales)
   do_man(man) unless $operatingsystem == "windows"
 end

data/lib/hiera/puppet_function.rb

@@ -12,10 +12,15 @@ class Hiera::PuppetFunction < Puppet::Functions::InternalFunction
       param 'Tuple[String, Any, Any, 1, 3]', :args
     end
 
-    dispatch :hiera do
+    dispatch :hiera_no_default do
       scope_param
       param 'String',:key
-      optional_param 'Any',   :default
+    end
+
+    dispatch :hiera_with_default do
+      scope_param
+      param 'String',:key
+      param 'Any',   :default
       optional_param 'Any',   :override
     end
 
@@ -37,35 +42,39 @@ class Hiera::PuppetFunction < Puppet::Functions::InternalFunction
     hiera(scope, *args)
   end
 
-  def hiera(scope, key, default = nil, override = nil)
-    post_lookup(key, lookup(scope, key, default, override))
+  def hiera_no_default(scope, key)
+    post_lookup(scope, key, lookup(scope, key, nil, false, nil))
   end
 
-  def hiera_block1(scope, key, &default_block)
-    common(scope, key, nil, default_block)
+  def hiera_with_default(scope, key, default, override = nil)
+    post_lookup(scope, key, lookup(scope, key, default, true, override))
   end
 
-  def hiera_block2(scope, key, override, &default_block)
-    common(scope, key, override, default_block)
+  def hiera_block1(scope, key, &default_block)
+    post_lookup(scope, key, lookup(scope, key, nil, false, nil, &default_block))
   end
 
-  def common(scope, key, override, default_block)
-    undefined = (@@undefined_value ||= Object.new)
-    result = lookup(scope, key, undefined, override)
-    post_lookup(key, result.equal?(undefined) ? default_block.call(key) : result)
+  def hiera_block2(scope, key, override, &default_block)
+    post_lookup(scope, key, lookup(scope, key, nil, false, override, &default_block))
   end
 
-  private :common
-
-  def lookup(scope, key, default, override)
-    HieraPuppet.lookup(key, default,scope, override, merge_type)
+  def lookup(scope, key, default, has_default, override, &default_block)
+    unless Puppet[:strict] == :off
+      Puppet.warn_once(:deprecation, self.class.name,
+        "The function '#{self.class.name}' is deprecated in favor of using 'lookup'. See https://docs.puppet.com/puppet/#{Puppet.version}/reference/deprecated_language.html")
+    end
+    lookup_invocation = Puppet::Pops::Lookup::Invocation.new(scope, {}, {})
+    adapter = lookup_invocation.lookup_adapter
+    lookup_invocation.set_global_only unless adapter.global_only? || adapter.has_environment_data_provider?(lookup_invocation)
+    lookup_invocation.set_hiera_v3_location_overrides(override) unless override.nil? || override.is_a?(Array) && override.empty?
+    Puppet::Pops::Lookup.lookup(key, nil, default, has_default, merge_type, lookup_invocation, &default_block)
   end
 
   def merge_type
-    :priority
+    :first
   end
 
-  def post_lookup(key, result)
+  def post_lookup(scope, key, result)
     result
   end
 end

data/lib/hiera/scope.rb

@@ -1,9 +1,12 @@
 class Hiera
   class Scope
-    CALLING_CLASS = "calling_class"
-    CALLING_CLASS_PATH = "calling_class_path"
-    CALLING_MODULE = "calling_module"
-    MODULE_NAME = "module_name"
+    CALLING_CLASS = 'calling_class'.freeze
+    CALLING_CLASS_PATH = 'calling_class_path'.freeze
+    CALLING_MODULE = 'calling_module'.freeze
+    MODULE_NAME = 'module_name'.freeze
+
+    CALLING_KEYS = [CALLING_CLASS, CALLING_CLASS_PATH, CALLING_MODULE].freeze
+    EMPTY_STRING = ''.freeze
 
     attr_reader :real
 
@@ -21,20 +24,15 @@ class Hiera
       else
         ans = @real.lookupvar(key)
       end
+      ans == EMPTY_STRING ? nil : ans
+    end
 
-      if ans.nil? or ans == ""
-        nil
-      else
-        ans
-      end
+    def exist?(key)
+      CALLING_KEYS.include?(key) || @real.exist?(key)
     end
 
     def include?(key)
-      if [CALLING_CLASS, CALLING_CLASS_PATH, CALLING_MODULE].include? key
-        true
-      else
-        @real.lookupvar(key) != ""
-      end
+      CALLING_KEYS.include?(key) || @real.include?(key)
     end
 
     def catalog

data/lib/hiera_puppet.rb

@@ -67,21 +67,13 @@ module HieraPuppet
   end
 
   def hiera_config_file
-    config_file = nil
-
-    if Puppet.settings[:hiera_config].is_a?(String)
-      expanded_config_file = File.expand_path(Puppet.settings[:hiera_config])
-      if Puppet::FileSystem.exist?(expanded_config_file)
-        config_file = expanded_config_file
-      end
-    elsif Puppet.settings[:confdir].is_a?(String)
-      expanded_config_file = File.expand_path(File.join(Puppet.settings[:confdir], '/hiera.yaml'))
-      if Puppet::FileSystem.exist?(expanded_config_file)
-        config_file = expanded_config_file
-      end
+    hiera_config = Puppet.settings[:hiera_config]
+    if Puppet::FileSystem.exist?(hiera_config)
+      hiera_config
+    else
+      Puppet.warning "Config file #{hiera_config} not found, using Hiera defaults"
+      nil
     end
-
-    config_file
   end
 end
 

data/lib/puppet/agent/locker.rb

@@ -1,4 +1,5 @@
 require 'puppet/util/pidlock'
+require 'puppet/error'
 
 # This module is responsible for encapsulating the logic for "locking" the
 # puppet agent during a catalog run; in other words, keeping track of enough
@@ -12,8 +13,8 @@ require 'puppet/util/pidlock'
 # For more information, please see docs on the website.
 #  http://links.puppetlabs.com/agent_lockfiles
 module Puppet::Agent::Locker
-  # Yield if we get a lock, else do nothing.  Return
-  # true/false depending on whether we get the lock.
+  # Yield if we get a lock, else raise Puppet::LockError. Return
+  # value of block yielded.
   def lock
     if lockfile.lock
       begin
@@ -21,10 +22,18 @@ module Puppet::Agent::Locker
       ensure
         lockfile.unlock
       end
+    else
+      fail Puppet::LockError, 'Failed to acquire lock'
     end
   end
 
+  # @deprecated
   def running?
+    Puppet.deprecation_warning <<-ENDHEREDOC
+Puppet::Agent::Locker.running? is deprecated as it is inherently unsafe.
+The only safe way to know if the lock is locked is to try lock and perform some
+action and then handle the LockError that may result.
+ENDHEREDOC
     lockfile.locked?
   end
 

data/lib/puppet/agent.rb

@@ -1,4 +1,5 @@
 require 'puppet/application'
+require 'puppet/error'
 
 # A general class for triggering a run of another
 # class.
@@ -9,11 +10,12 @@ class Puppet::Agent
   require 'puppet/agent/disabler'
   include Puppet::Agent::Disabler
 
-  attr_reader :client_class, :client, :splayed, :should_fork
+  require 'puppet/util/splayer'
+  include Puppet::Util::Splayer
 
-  def initialize(client_class, should_fork=true)
-    @splayed = false
+  attr_reader :client_class, :client, :should_fork
 
+  def initialize(client_class, should_fork=true)
     @should_fork = can_fork? && should_fork
     @client_class = client_class
   end
@@ -28,10 +30,6 @@ class Puppet::Agent
 
   # Perform a run with our client.
   def run(client_options = {})
-    if running?
-      Puppet.notice "Run of #{client_class} already in progress; skipping  (#{lockfile_path} exists)"
-      return
-    end
     if disabled?
       Puppet.notice "Skipping run of #{client_class}; administratively disabled (Reason: '#{disable_message}');\nUse 'puppet agent --enable' to re-enable."
       return
@@ -41,10 +39,13 @@ class Puppet::Agent
     block_run = Puppet::Application.controlled_run do
       splay client_options.fetch :splay, Puppet[:splay]
       result = run_in_fork(should_fork) do
-        with_client do |client|
+        with_client(client_options[:transaction_uuid]) do |client|
           begin
-            client_args = client_options.merge(:pluginsync => Puppet[:pluginsync])
+            client_args = client_options.merge(:pluginsync => Puppet::Configurer.should_pluginsync?)
             lock { client.run(client_args) }
+          rescue Puppet::LockError
+            Puppet.notice "Run of #{client_class} already in progress; skipping  (#{lockfile_path} exists)"
+            return
           rescue StandardError => detail
             Puppet.log_exception(detail, "Could not run #{client_class}: #{detail}")
           end
@@ -60,22 +61,6 @@ class Puppet::Agent
     Puppet::Application.stop_requested?
   end
 
-  # Have we splayed already?
-  def splayed?
-    splayed
-  end
-
-  # Sleep when splay is enabled; else just return.
-  def splay(do_splay = Puppet[:splay])
-    return unless do_splay
-    return if splayed?
-
-    time = rand(Puppet[:splaylimit] + 1)
-    Puppet.info "Sleeping for #{time} seconds (splay is enabled)"
-    sleep(time)
-    @splayed = true
-  end
-
   def run_in_fork(forking = true)
     return yield unless forking or Puppet.features.windows?
 
@@ -103,9 +88,9 @@ class Puppet::Agent
 
   # Create and yield a client instance, keeping a reference
   # to it during the yield.
-  def with_client
+  def with_client(transaction_uuid)
     begin
-      @client = client_class.new
+      @client = client_class.new(Puppet::Configurer::DownloaderFactory.new, transaction_uuid)
     rescue StandardError => detail
       Puppet.log_exception(detail, "Could not create instance of #{client_class}: #{detail}")
       return