puppet 5.3.3 → 5.3.4

data/CONTRIBUTING.md

@@ -76,7 +76,7 @@ for the translators.
 
 When adding user-facing strings to your work, follow these guidelines:
 * Use full sentences. Strings built up out of concatenated bits are hard to translate.
-* Use string formatting instead of interpolation.
+* Use string formatting instead of interpolation. Use the hash format and give good names to the placeholder values that can be used by translators to understand the meaning of the formatted values.
     Ex. `_('Creating new user %{name}.') % { name: user.name }`
 * Use `n_()` for pluralization. (see gettext gem docs linked above for details)
 

data/Gemfile

@@ -56,6 +56,7 @@ group(:development, :test) do
   if RUBY_VERSION >= '2.0'
     # pin rubocop as 0.50 requires a higher version of the rainbow gem (see below)
     gem 'rubocop', '~> 0.49.1', :platforms => [:ruby]
+    gem 'rubocop-i18n', '~> 1.2.0', :platforms => [:ruby]
   end
 
   # pin rainbow gem as 2.2.1 requires rubygems 2.6.9+ and (donotwant)
@@ -76,6 +77,8 @@ group(:development) do
   if RUBY_PLATFORM != 'java'
     gem 'ruby-prof', '>= 0.16.0', :require => false
   end
+
+  gem 'gettext-setup', '~> 0.28', :require => false
 end
 
 group(:extra) do

data/ext/puppet-test

@@ -195,10 +195,11 @@ class Suite
 
         $options[:repeat].times do |i|
             @count = i
+            escaped_doc = doc.gsub(/%/, '%%')
             if forked?
-                msg = doc + " in PID %s" % Process.pid
+                msg = escaped_doc + " in PID %{process_id} in %%{seconds} seconds" % { process_id: Process.pid }
             else
-                msg = doc
+                msg = escaped_doc + " in %{seconds} seconds"
             end
             Puppet::Util.benchmark(:notice, msg) do
                 begin

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://docs.puppet.com/puppet/%{minor_version}/reference/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_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.rb

@@ -42,11 +42,8 @@ module Puppet
   require 'puppet/environments'
 
   class << self
-    Puppet::GettextConfig.create_text_domain('production')
-    locale_dir = Puppet::GettextConfig.puppet_locale_path
-    if Puppet::GettextConfig.load_translations('puppet', locale_dir, Puppet::GettextConfig.translation_mode(locale_dir))
-      Puppet::GettextConfig.set_locale(Locale.current.language)
-    end
+    Puppet::GettextConfig.setup_locale
+    Puppet::GettextConfig.create_default_text_domain
 
     include Puppet::Util
     attr_reader :features

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,12 +47,26 @@ 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

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/application.rb

@@ -281,6 +281,23 @@ class Application
       @run_mode = Puppet::Util::RunMode[ mode_name || Puppet.settings.preferred_run_mode ]
     end
 
+    # Sets environment_mode name
+    # @param mode_name [Symbol] The name of the environment mode to run in. May
+    #   be one of :local, :remote, or :not_required. This impacts where the
+    #   application looks for its specified environment. If :not_required or
+    #   :remote are set, the application will not fail if the environment does
+    #   not exist on the local filesystem.
+    def environment_mode(mode_name)
+      raise Puppet::Error, _("Invalid environment mode '%{mode_name}'") % { mode_name: mode_name } unless [:local, :remote, :not_required].include?(mode_name)
+      @environment_mode = mode_name
+    end
+
+    # Gets environment_mode name. If none is set with `environment_mode=`,
+    # default to :local.
+    def get_environment_mode
+      @environment_mode || :local
+    end
+
     # This is for testing only
     def clear_everything_for_tests
       @run_mode = @banner = @run_status = @option_parser_commands = nil
@@ -343,7 +360,7 @@ class Application
       initialize_app_defaults
     end
 
-    Puppet::ApplicationSupport.push_application_context(self.class.run_mode)
+    Puppet::ApplicationSupport.push_application_context(self.class.run_mode, self.class.get_environment_mode)
 
     exit_on_fail(_("Could not initialize"))                { preinit }
     exit_on_fail(_("Could not parse application options")) { parse_options }

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
@@ -98,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>]
 
 
@@ -273,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',

data/lib/puppet/application/apply.rb

@@ -50,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>
 
 

data/lib/puppet/application/config.rb

@@ -1,4 +1,5 @@
 require 'puppet/application/face_base'
 
 class Puppet::Application::Config < Puppet::Application::FaceBase
+  environment_mode :not_required
 end

data/lib/puppet/application/device.rb

@@ -155,8 +155,7 @@ you can specify '--server <servername>' as an argument.
   device run against only that device/certificate.
 
 * --user:
-  The user to run as. '--user=root' is required, even when run as root,
-  for runs that create device certificates or keys.
+  The user to run as.
 
 * --verbose:
   Turn on verbose reporting.

data/lib/puppet/application/filebucket.rb

@@ -111,38 +111,55 @@ configuration options can also be generated by running puppet with
 * --version:
   Print version information.
 
-
-EXAMPLE
--------
+EXAMPLES
+--------
+    ## Backup a file to the filebucket, then restore it to a temporary directory
     $ puppet filebucket backup /etc/passwd
     /etc/passwd: 429b225650b912a2ee067b0a4cf1e949
     $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949
+
     ## Diff between two files in the filebucket
     $ puppet filebucket -l diff d43a6ecaa892a1962398ac9170ea9bf2 7ae322f5791217e031dc60188f4521ef
     1a2
     > again
-    ## Diff between the file in the filebucket and the current one
+
+    ## Diff between the file in the filebucket and a local file
     $ puppet filebucket -l diff d43a6ecaa892a1962398ac9170ea9bf2 /tmp/testFile
     1a2
     > again
+
+    ## Backup a file to the filebucket and observe that it keeps each backup separate
     $ puppet filebucket -l list
     d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
+
     $ echo again >> /tmp/TestFile
+
     $ puppet filebucket -l backup /tmp/TestFile
     /tmp/TestFile: 7ae322f5791217e031dc60188f4521ef
-    $ puppet filebucket -l  list
+
+    $ puppet filebucket -l list
     d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
     7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile
+
+    ## List files in a filebucket within date ranges
     $ puppet filebucket -l -f 2015-01-01 -t 2015-01-11 list
     <Empty Output>
+
     $ puppet filebucket -l -f 2015-05-10 list
     d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
     7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile
+
     $ puppet filebucket -l -f "2015-05-11 09:30:00" list
     7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile
+
     $ puppet filebucket -l -t "2015-05-11 09:30:00" list
     d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
 
+    ## From a Puppet master, list files in the master bucketdir
+    $ puppet filebucket -b $(puppet config print bucketdir --section master) list
+    d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
+    7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile
+
 AUTHOR
 ------
 Luke Kanies

data/lib/puppet/application/help.rb

@@ -1,4 +1,5 @@
 require 'puppet/application/face_base'
 
 class Puppet::Application::Help < Puppet::Application::FaceBase
+  environment_mode :not_required
 end

data/lib/puppet/application/lookup.rb

@@ -340,7 +340,6 @@ Copyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License
     fact_file = options[:fact_file]
 
     if fact_file
-      original_facts = node.parameters
       if fact_file.end_with?("json")
         given_facts = JSON.parse(Puppet::FileSystem.read(fact_file, :encoding => 'utf-8'))
       else
@@ -350,8 +349,7 @@ Copyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License
       unless given_facts.instance_of?(Hash)
         raise _("Incorrect formatted data in %{fact_file} given via the --facts flag") % { fact_file: fact_file }
       end
-
-      node.parameters = original_facts.merge(given_facts)
+      node.add_extra_facts(given_facts)
     end
 
     Puppet[:code] = 'undef' unless options[:compile]

data/lib/puppet/application_support.rb

@@ -14,9 +14,11 @@ module Puppet
     # before being set in a pushed Puppet Context.
     #
     # @param run_mode [Puppet::Util::RunMode] Puppet's current Run Mode.
+    # @param environment_mode [Symbol] optional, Puppet's
+    #   current Environment Mode. Defaults to :local
     # @return [void]
     # @api private
-    def self.push_application_context(run_mode)
+    def self.push_application_context(run_mode, environment_mode = :local)
       Puppet.push_context(Puppet.base_context(Puppet.settings), "Update for application settings (#{run_mode})")
       # This use of configured environment is correct, this is used to establish
       # the defaults for an application that does not override, or where an override
@@ -25,6 +27,9 @@ module Puppet
       configured_environment_name = Puppet[:environment]
       if run_mode.name == :agent
         configured_environment = Puppet::Node::Environment.remote(configured_environment_name)
+      elsif environment_mode == :not_required
+        configured_environment =
+          Puppet.lookup(:environments).get(configured_environment_name) || Puppet::Node::Environment.remote(configured_environment_name)
       else
         configured_environment = Puppet.lookup(:environments).get!(configured_environment_name)
       end

data/lib/puppet/bindings.rb

@@ -134,7 +134,8 @@ class Puppet::Bindings
 
     def []=(name, value)
       unless value.is_a?(Puppet::Pops::Binder::Bindings::NamedBindings) || value.is_a?(Proc)
-        raise ArgumentError, "Given value must be a NamedBindings, or a Proc producing one, got: #{value.class}."
+        #TRANSLATORS 'NameBindings' is a class name and should not be translated, 'Proc' refers to a Ruby proc.
+        raise ArgumentError, _("Given value must be a NamedBindings, or a Proc producing one, got: %{class_name}.") % { class_name: value.class }
       end
       @named_bindings[name] = value
     end

data/lib/puppet/configurer.rb

@@ -116,6 +116,9 @@ class Puppet::Configurer
     if options[:pluginsync]
       remote_environment_for_plugins = Puppet::Node::Environment.remote(@environment)
       download_plugins(remote_environment_for_plugins)
+
+      Puppet::GettextConfig.reset_text_domain('agent')
+      Puppet::ModuleTranslations.load_from_vardir(Puppet[:vardir])
     end
 
     facts_hash = {}
@@ -168,7 +171,7 @@ class Puppet::Configurer
     begin
       report.configuration_version = catalog.version
 
-      benchmark(:notice, _("Applied catalog")) do
+      benchmark(:notice, _("Applied catalog in %{seconds} seconds")) do
         catalog.apply(options)
       end
     ensure
@@ -233,6 +236,9 @@ class Puppet::Configurer
     # If a cached catalog is explicitly requested, attempt to retrieve it. Skip the node request,
     # don't pluginsync and switch to the catalog's environment if we successfully retrieve it.
     if Puppet[:use_cached_catalog]
+      Puppet::GettextConfig.reset_text_domain('agent')
+      Puppet::ModuleTranslations.load_from_vardir(Puppet[:vardir])
+
       if catalog = prepare_and_retrieve_catalog_from_cache
         options[:catalog] = catalog
         @cached_catalog_status = 'explicitly_requested'
@@ -293,11 +299,10 @@ class Puppet::Configurer
       end
 
       current_environment = Puppet.lookup(:current_environment)
-      local_node_environment =
       if current_environment.name == @environment.intern
-        current_environment
+        local_node_environment = current_environment
       else
-        Puppet::Node::Environment.create(@environment,
+        local_node_environment = Puppet::Node::Environment.create(@environment,
                                          current_environment.modulepath,
                                          current_environment.manifest,
                                          current_environment.config_version)

data/lib/puppet/configurer/downloader_factory.rb

@@ -31,4 +31,14 @@ class Puppet::Configurer::DownloaderFactory
       source_permissions
     )
   end
+
+  def create_locales_downloader(environment)
+    locales_downloader = Puppet::Configurer::Downloader.new(
+      "locales",
+      Puppet[:localedest],
+      Puppet[:localesource],
+      Puppet[:pluginsignore] + " config.yaml",
+      environment
+    )
+  end
 end

data/lib/puppet/configurer/plugin_handler.rb

@@ -3,7 +3,10 @@
 # easier to test.
 require 'puppet/configurer'
 
+
 class Puppet::Configurer::PluginHandler
+  SUPPORTED_LOCALES_MOUNT_AGENT_VERSION = Gem::Version.new("5.3.4")
+
   def initialize(factory)
     @factory = factory
   end
@@ -11,13 +14,17 @@ class Puppet::Configurer::PluginHandler
   # Retrieve facts from the central server.
   def download_plugins(environment)
     plugin_downloader = @factory.create_plugin_downloader(environment)
-
-    result = []
-
     plugin_fact_downloader = @factory.create_plugin_facts_downloader(environment)
+    result = []
     result += plugin_fact_downloader.evaluate
-
     result += plugin_downloader.evaluate
+
+    server_agent_version = Puppet.lookup(:server_agent_version) { "0.0" }
+    if Gem::Version.new(server_agent_version) >= SUPPORTED_LOCALES_MOUNT_AGENT_VERSION
+      locales_downloader = @factory.create_locales_downloader(environment)
+      result += locales_downloader.evaluate
+    end
+
     Puppet::Util::Autoload.reload_changed
 
     result