puppet 5.0.0 → 6.0.0

data/ext/solaris/smf/puppet

@@ -2,16 +2,16 @@
 
 . /lib/svc/share/smf_include.sh
 
-[ -z "${SMF_FMRI}" ] && exit $SMF_EXIT_ERR
+[ -z "${SMF_FMRI}" ] && exit "$SMF_EXIT_ERR"
 
 CONF_FILE=/etc/puppetlabs/puppet/puppet.conf
-[ ! -f "${CONF_FILE}" ] && exit $SMF_EXIT_ERR_CONFIG
+[ ! -f "${CONF_FILE}" ] && exit "$SMF_EXIT_ERR_CONFIG"
 
 PUPPET=/opt/puppetlabs/bin/puppet
 
 case "$1" in
 start)
-  exec $PUPPET agent
+  exec "$PUPPET" agent
   ;;
 
 stop)
@@ -23,22 +23,22 @@ stop)
   # continues until all processes are killed.
   # svcs -p <fmri> lists all processes in the contract.
   # http://bnsmb.de/solaris/My_Little_SMF_FAQ.html
-  ctid=`svcprop -p restarter/contract $SMF_FMRI`
+  ctid=`svcprop -p restarter/contract "$SMF_FMRI"`
   if [ -n "$ctid" ]; then
-    smf_kill_contract $ctid TERM 1 30
+    smf_kill_contract "$ctid" TERM 1 30
     ret=$?
-    [ $ret -eq 1 ] && exit $SMF_EXIT_ERR_FATAL
+    [ "$ret" -eq 1 ] && exit "$SMF_EXIT_ERR_FATAL"
 
-    if [ $ret -eq 2 ] ; then
-      smf_kill_contract $ctid KILL 1
-      [ $? -ne 0 ] && exit $SMF_EXIT_ERR_FATAL
+    if [ "$ret" -eq 2 ] ; then
+      smf_kill_contract "$ctid" KILL 1
+      [ $? -ne 0 ] && exit "$SMF_EXIT_ERR_FATAL"
     fi
   fi
   ;;
 *)
   echo "Usage: $0 {start|stop}";
-  exit $SMF_EXIT_ERR_FATAL
+  exit "$SMF_EXIT_ERR_FATAL"
   ;;
 esac
-exit $SMF_EXIT_OK
+exit "$SMF_EXIT_OK"
 

data/ext/solaris/smf/svc-puppetd

@@ -28,14 +28,14 @@ start)
     ;;
 stop)
     printf "Stopping Puppet client services:"
-    kill `cat $pidfile`
+    kill `cat "$pidfile"`
 
     printf " puppetd"
     echo ""
     ;;
 restart)
     printf "Restarting Puppet client services:"
-    kill -HUP `cat $pidfile`
+    kill -HUP `cat "$pidfile"`
 
     printf " puppetd"
     echo ""
@@ -43,14 +43,14 @@ restart)
 reload)
     printf "Reloading Puppet client services:"
 
-    kill -HUP `cat $pidfile`
+    kill -HUP `cat "$pidfile"`
 
     printf " puppetd"
     echo ""
     ;;
 status)
-    if [ -f $pidfile ]; then
-        pid=`cat $pidfile`
+    if [ -f "$pidfile" ]; then
+        pid=`cat "$pidfile"`
         curpid=`pgrep puppetd`
         if [ "$pid" -eq "$curpid" ]; then
             exit 0

data/ext/solaris/smf/svc-puppetmasterd

@@ -24,14 +24,14 @@ start)
     ;;
 stop)
     printf "Stopping Puppet server services:"
-    kill `cat $pidfile`
+    kill `cat "$pidfile"`
 
     printf " puppetmasterd"
     echo ""
     ;;
 restart)
     printf "Restarting Puppet server services:"
-    kill -HUP `cat $pidfile`
+    kill -HUP `cat "$pidfile"`
 
     printf " puppetmasterd"
     echo ""
@@ -39,14 +39,14 @@ restart)
 reload)
     printf "Reloading Puppet server services:"
 
-    kill -HUP `cat $pidfile`
+    kill -HUP `cat "$pidfile"`
 
     printf " puppetmasterd"
     echo ""
     ;;
 status)
-    if [ -f $pidfile ]; then
-        pid=`cat $pidfile`
+    if [ -f "$pidfile" ]; then
+        pid=`cat "$pidfile"`
         curpid=`pgrep puppetmasterd`
         if [ "$pid" -eq "$curpid" ]; then
             exit 0

data/ext/upload_facts.rb

@@ -58,7 +58,7 @@ is also a valid long argument.  For example, 'server' is a valid configuration
 parameter, so you can specify '--server <servername>' as an argument.
 
 See the configuration file documentation at
-https://docs.puppetlabs.com/puppet/latest/reference/configuration.html for
+https://puppet.com/docs/puppet/latest/configuration.html for
 the full list of acceptable parameters. A commented list of all
 configuration options can also be generated by running puppet agent with
 '--genconfig'.
@@ -102,7 +102,7 @@ HELP
     files.each do |file|
       facts = YAML.load_file(file)
 
-      request = Puppet::Indirector::Request.new(:facts, :save, facts)
+      request = Puppet::Indirector::Request.new(:facts, :save, facts, nil)
 
       # The terminus warns for us if we fail.
       if terminus.save(request)

data/ext/windows/service/daemon.rb

@@ -142,7 +142,7 @@ class WindowsDaemon < Win32::Daemon
         :event_id    => id,     # 0x01 or 0x02, 0x03 etc.
         :data        => message # "the message"
       )
-    rescue Exception => e
+    rescue Exception
       # Ignore all errors
     ensure
       if (!eventlog.nil?)

data/install.rb

@@ -482,7 +482,6 @@ EOS
         FileUtils.install(tmp_file2.path, File.join(target, "#{op_file}.bat"), :mode => 0755, :preserve => true, :verbose => true)
 
         tmp_file2.unlink
-        installed_wrapper = true
       end
     end
   end
@@ -495,8 +494,8 @@ FileUtils.cd File.dirname(__FILE__) do
   # Set these values to what you want installed.
   configs = glob(%w{conf/auth.conf conf/puppet.conf conf/hiera.yaml})
   bins  = glob(%w{bin/*})
-  rdoc  = glob(%w{bin/* lib/**/*.rb README* }).reject { |e| e=~ /\.(bat|cmd)$/ }
-  ri    = glob(%w{bin/*.rb lib/**/*.rb}).reject { |e| e=~ /\.(bat|cmd)$/ }
+  #rdoc  = glob(%w{bin/* lib/**/*.rb README* }).reject { |e| e=~ /\.(bat|cmd)$/ }
+  #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/**/*})

data/lib/hiera/puppet_function.rb

@@ -60,8 +60,11 @@ class Hiera::PuppetFunction < Puppet::Functions::InternalFunction
 
   def lookup(scope, key, default, has_default, override, &default_block)
     unless Puppet[:strict] == :off
-      Puppet.warn_once('deprecations', self.class.name,
-        "The function '#{self.class.name}' is deprecated in favor of using 'lookup'. See https://docs.puppet.com/puppet/#{Puppet.minor_version}/reference/deprecated_language.html")
+      #TRANSLATORS 'lookup' is a puppet function and should not be translated
+      message = _("The function '%{class_name}' is deprecated in favor of using 'lookup'.") % { class_name: self.class.name }
+      message += ' '+ _("See https://puppet.com/docs/puppet/%{minor_version}/deprecated_language.html") %
+          { minor_version: Puppet.minor_version }
+      Puppet.warn_once('deprecations', self.class.name, message)
     end
     lookup_invocation = Puppet::Pops::Lookup::Invocation.new(scope, {}, {})
     adapter = lookup_invocation.lookup_adapter

data/lib/hiera/scope.rb

@@ -20,13 +20,35 @@ class Hiera
       elsif key == CALLING_CLASS_PATH
         ans = find_hostclass(@real).gsub(/::/, '/')
       elsif key == CALLING_MODULE
-        ans = @real.lookupvar(MODULE_NAME)
+        ans = safe_lookupvar(MODULE_NAME)
       else
-        ans = @real.lookupvar(key)
+        ans = safe_lookupvar(key)
       end
       ans == EMPTY_STRING ? nil : ans
     end
 
+    # This method is used to handle the throw of :undefined_variable since when
+    # strict variables is not in effect, missing handling of the throw leads to
+    # a more expensive code path.
+    #
+    def safe_lookupvar(key)
+      reason = catch :undefined_variable do
+        return @real.lookupvar(key)
+      end
+
+      case Puppet[:strict]
+      when :off
+        # do nothing
+      when :warning
+        Puppet.warn_once(Puppet::Parser::Scope::UNDEFINED_VARIABLES_KIND, _("Variable: %{name}") % { name: key },
+        _("Undefined variable '%{name}'; %{reason}") % { name: key, reason: reason } )
+      when :error
+        raise ArgumentError, _("Undefined variable '%{name}'; %{reason}") % { name: key, reason: reason }
+      end
+      nil
+    end
+    private :safe_lookupvar
+
     def exist?(key)
       CALLING_KEYS.include?(key) || @real.exist?(key)
     end

data/lib/hiera_puppet.rb

@@ -11,7 +11,7 @@ module HieraPuppet
     answer = hiera.lookup(key, default, scope, override, resolution_type)
 
     if answer.nil?
-      raise(Puppet::ParseError, "Could not find data item #{key} in any Hiera data file and no default supplied")
+      raise Puppet::ParseError, _("Could not find data item %{key} in any Hiera data file and no default supplied") % { key: key }
     end
 
     answer
@@ -38,7 +38,7 @@ module HieraPuppet
     end
 
     if args.empty?
-      raise(Puppet::ParseError, "Please supply a parameter to perform a Hiera lookup")
+      raise Puppet::ParseError, _("Please supply a parameter to perform a Hiera lookup")
     end
 
     key      = args[0]
@@ -71,7 +71,7 @@ module HieraPuppet
     if Puppet::FileSystem.exist?(hiera_config)
       hiera_config
     else
-      Puppet.warning "Config file #{hiera_config} not found, using Hiera defaults"
+      Puppet.warning _("Config file %{hiera_config} not found, using Hiera defaults") % { hiera_config: hiera_config }
       nil
     end
   end

data/lib/puppet/agent/locker.rb

@@ -29,11 +29,12 @@ module Puppet::Agent::Locker
 
   # @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
+    #TRANSLATORS 'Puppet::Agent::Locker.running?' is a method name and should not be translated
+    message = _('Puppet::Agent::Locker.running? is deprecated as it is inherently unsafe.')
+    #TRANSLATORS 'LockError' should not be translated
+    message += ' ' + _('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.')
+    Puppet.deprecation_warning(message)
     lockfile.locked?
   end
 

data/lib/puppet/agent.rb

@@ -2,6 +2,8 @@ require 'puppet/application'
 require 'puppet/error'
 require 'puppet/util/at_fork'
 
+require 'timeout'
+
 # A general class for triggering a run of another
 # class.
 class Puppet::Agent
@@ -14,6 +16,10 @@ class Puppet::Agent
   require 'puppet/util/splayer'
   include Puppet::Util::Splayer
 
+  # Special exception class used to signal an agent run has timed out.
+  class RunTimeoutError < Exception
+  end
+
   attr_reader :client_class, :client, :should_fork
 
   def initialize(client_class, should_fork=true)
@@ -41,14 +47,29 @@ class Puppet::Agent
       splay client_options.fetch :splay, Puppet[:splay]
       result = run_in_fork(should_fork) do
         with_client(client_options[:transaction_uuid], client_options[:job_id]) do |client|
+          client_args = client_options.merge(:pluginsync => Puppet::Configurer.should_pluginsync?)
           begin
-            client_args = client_options.merge(:pluginsync => Puppet::Configurer.should_pluginsync?)
-            lock { client.run(client_args) }
+            lock do
+              # NOTE: Timeout is pretty heinous as the location in which it
+              # throws an error is entirely unpredictable, which means that
+              # it can interrupt code blocks that perform cleanup or enforce
+              # sanity. The only thing a Puppet agent should do after this
+              # error is thrown is die with as much dignity as possible.
+              Timeout.timeout(Puppet[:runtimeout], RunTimeoutError) do
+                client.run(client_args)
+              end
+            end
           rescue Puppet::LockError
             Puppet.notice _("Run of %{client_class} already in progress; skipping  (%{lockfile_path} exists)") % { client_class: client_class, lockfile_path: lockfile_path }
             return
+          rescue RunTimeoutError => detail
+            Puppet.log_exception(detail, _("Execution of %{client_class} did not complete within %{runtimeout} seconds and was terminated.") %
+              {client_class: client_class,
+              runtimeout: Puppet[:runtimeout]})
+            return 1
           rescue StandardError => detail
             Puppet.log_exception(detail, _("Could not run %{client_class}: %{detail}") % { client_class: client_class, detail: detail })
+            1
           end
         end
       end
@@ -101,7 +122,7 @@ class Puppet::Agent
   # to it during the yield.
   def with_client(transaction_uuid, job_id = nil)
     begin
-      @client = client_class.new(Puppet::Configurer::DownloaderFactory.new, transaction_uuid, job_id)
+      @client = client_class.new(transaction_uuid, job_id)
     rescue StandardError => detail
       Puppet.log_exception(detail, _("Could not create instance of %{client_class}: %{detail}") % { client_class: client_class, detail: detail })
       return

data/lib/puppet/application/agent.rb

@@ -38,6 +38,7 @@ class Puppet::Application::Agent < Puppet::Application
       :digest => 'SHA256',
       :graph => true,
       :fingerprint => false,
+      :sourceaddress => nil,
     }.each do |opt,val|
       options[opt] = val
     end
@@ -59,6 +60,8 @@ class Puppet::Application::Agent < Puppet::Application
   option("--fingerprint")
   option("--digest DIGEST")
 
+  option("--sourceaddress IP_ADDRESS")
+
   option("--detailed-exitcodes") do |arg|
     options[:detailed_exitcodes] = true
   end
@@ -75,10 +78,14 @@ class Puppet::Application::Agent < Puppet::Application
     options[:job_id] = arg
   end
 
+  def summary
+    _("The puppet agent daemon")
+  end
+
   def help
-    <<-'HELP'
+    <<-HELP
 
-puppet-agent(8) -- The puppet agent daemon
+puppet-agent(8) -- #{summary}
 ========
 
 SYNOPSIS
@@ -94,8 +101,8 @@ USAGE
 -----
 puppet agent [--certname <NAME>] [-D|--daemonize|--no-daemonize]
   [-d|--debug] [--detailed-exitcodes] [--digest <DIGEST>] [--disable [MESSAGE]] [--enable]
-  [--fingerprint] [-h|--help] [-l|--logdest syslog|eventlog|<FILE>|console]
-  [--masterport <PORT>] [--noop] [-o|--onetime] [-t|--test]
+  [--fingerprint] [-h|--help] [-l|--logdest syslog|eventlog|<ABS FILEPATH>|console]
+  [--masterport <PORT>] [--noop] [-o|--onetime] [--sourceaddress <IP_ADDRESS>] [-t|--test]
   [-v|--verbose] [-V|--version] [-w|--waitforcert <SECONDS>]
 
 
@@ -159,7 +166,7 @@ specify '--server <servername>' as an argument. Boolean settings translate into
 '--setting' and '--no-setting' pairs.
 
 See the configuration file documentation at
-https://docs.puppetlabs.com/puppet/latest/reference/configuration.html for the
+https://puppet.com/docs/puppet/latest/configuration.html for the
 full list of acceptable settings. A commented list of all settings can also be
 generated by running puppet agent with '--genconfig'.
 
@@ -269,6 +276,10 @@ generated by running puppet agent with '--genconfig'.
   (This is a Puppet setting, and can go in puppet.conf. Note the special 'no-'
   prefix for boolean settings on the command line.)
 
+* --sourceaddress:
+  Set the source IP address for transactions. This defaults to automatically selected.
+  (This is a Puppet setting, and can go in puppet.conf.)
+
 * --test:
   Enable the most common options used for testing. These are 'onetime',
   'verbose', 'no-daemonize', 'no-usecacheonfailure', 'detailed-exitcodes',
@@ -411,18 +422,12 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
     # we want the last report to be persisted locally
     Puppet::Transaction::Report.indirection.cache_class = :yaml
 
-    if Puppet[:noop]
-      Puppet::Resource::Catalog.indirection.cache_class = nil
-    elsif Puppet[:catalog_cache_terminus]
+    if Puppet[:catalog_cache_terminus]
       Puppet::Resource::Catalog.indirection.cache_class = Puppet[:catalog_cache_terminus]
     end
 
-    if options[:fingerprint]
-      # in fingerprint mode we just need
-      # access to the local files and we don't need a ca
-      Puppet::SSL::Host.ca_location = :none
-    else
-      Puppet::SSL::Host.ca_location = :remote
+    # In fingerprint mode we don't need to set up the whole agent
+    unless options[:fingerprint]
       setup_agent
     end
   end

data/lib/puppet/application/apply.rb

@@ -31,10 +31,14 @@ class Puppet::Application::Apply < Puppet::Application
     exit 1
   end
 
+  def summary
+    _("Apply Puppet manifests locally")
+  end
+
   def help
-    <<-'HELP'
+    <<-HELP
 
-puppet-apply(8) -- Apply Puppet manifests locally
+puppet-apply(8) -- #{summary}
 ========
 
 SYNOPSIS
@@ -46,7 +50,7 @@ USAGE
 -----
 puppet apply [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]
   [-e|--execute] [--detailed-exitcodes] [-L|--loadclasses]
-  [-l|--logdest syslog|eventlog|<FILE>|console] [--noop]
+  [-l|--logdest syslog|eventlog|<ABS FILEPATH>|console] [--noop]
   [--catalog <catalog>] [--write-catalog-summary] <file>
 
 
@@ -74,7 +78,7 @@ valid setting, so you can specify '--tags <class>,<tag>'
 as an argument.
 
 See the configuration file documentation at
-https://docs.puppetlabs.com/puppet/latest/reference/configuration.html for the
+https://puppet.com/docs/puppet/latest/configuration.html for the
 full list of acceptable parameters. A commented list of all
 configuration options can also be generated by running puppet with
 '--genconfig'.
@@ -241,7 +245,7 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
             $stderr.puts _("%{file} is not readable") % { file: file }
             exit(63)
           end
-          node.classes = Puppet::FileSystem.read(file, :encoding => 'utf-8').split(/[\s\n]+/)
+          node.classes = Puppet::FileSystem.read(file, :encoding => 'utf-8').split(/[\s]+/)
         end
       end
 
@@ -261,20 +265,31 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
           exit(1)
         end
 
-        # Translate it to a RAL catalog
-        catalog = catalog.to_ral
+        # Loaders are required when resolving deferred values and at the end
+        # when apply_catalog is called - it is therefore used around all of the
+        # required steps as it is expensive to set up loaders twice (once for
+        # resolution and once for the apply).
+        #
+        exit_status = Puppet.override(:loaders => Puppet::Pops::Loaders.new(apply_environment)) do
 
-        catalog.finalize
+          # Resolve all deferred values and replace them / mutate the catalog
+          Puppet::Pops::Evaluator::DeferredResolver.resolve_and_replace(node.facts, catalog)
 
-        catalog.retrieval_duration = Time.now - starttime
+          # Translate it to a RAL catalog
+          catalog = catalog.to_ral
 
-        if options[:write_catalog_summary]
-          catalog.write_class_file
-          catalog.write_resource_file
-        end
+          catalog.finalize
 
-        exit_status = Puppet.override(:loaders => Puppet::Pops::Loaders.new(apply_environment)) { apply_catalog(catalog) }
+          catalog.retrieval_duration = Time.now - starttime
 
+          if options[:write_catalog_summary]
+            catalog.write_class_file
+            catalog.write_resource_file
+          end
+
+          #exit_status = Puppet.override(:loaders => Puppet::Pops::Loaders.new(apply_environment)) { apply_catalog(catalog) }
+          apply_catalog(catalog)
+        end
         if not exit_status
           exit(1)
         elsif options[:detailed_exitcodes] then
@@ -318,9 +333,7 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
     Puppet.settings.use :main, :agent, :ssl
 
 
-    if Puppet[:noop]
-      Puppet::Resource::Catalog.indirection.cache_class = nil
-    elsif Puppet[:catalog_cache_terminus]
+    if Puppet[:catalog_cache_terminus]
       Puppet::Resource::Catalog.indirection.cache_class = Puppet[:catalog_cache_terminus]
     end