puppet 4.10.12 → 5.0.0

data/lib/puppet/application/master.rb

@@ -135,22 +135,15 @@ Copyright (c) 2012 Puppet Inc., LLC Licensed under the Apache 2.0 License
     HELP
   end
 
-  # Sets up the 'node_cache_terminus' default to use the Write Only Yaml terminus :write_only_yaml.
-  # If this is not wanted, the setting ´node_cache_terminus´ should be set to nil.
-  # @see Puppet::Node::WriteOnlyYaml
-  # @see #setup_node_cache
-  # @see puppet issue 16753
-  #
   def app_defaults
     super.merge({
-      :node_cache_terminus => :write_only_yaml,
       :facts_terminus => 'yaml'
     })
   end
 
   def preinit
     Signal.trap(:INT) do
-      $stderr.puts "Canceling startup"
+      $stderr.puts _("Canceling startup")
       exit(0)
     end
 
@@ -169,12 +162,12 @@ Copyright (c) 2012 Puppet Inc., LLC Licensed under the Apache 2.0 License
   def compile
     begin
       unless catalog = Puppet::Resource::Catalog.indirection.find(options[:node])
-        raise "Could not compile catalog for #{options[:node]}"
+        raise _("Could not compile catalog for %{node}") % { node: options[:node] }
       end
 
-      puts PSON::pretty_generate(catalog.to_resource, :allow_nan => true, :max_nesting => false)
+      puts JSON::pretty_generate(catalog.to_resource, :allow_nan => true, :max_nesting => false)
     rescue => detail
-      Puppet.log_exception(detail, "Failed to compile catalog for node #{options[:node]}: #{detail}")
+      Puppet.log_exception(detail, _("Failed to compile catalog for node %{node}: %{detail}") % { node: options[:node], detail: detail })
       exit(30)
     end
     exit(0)
@@ -194,20 +187,20 @@ Copyright (c) 2012 Puppet Inc., LLC Licensed under the Apache 2.0 License
         begin
           Puppet::Util.chuser
         rescue => detail
-          Puppet.log_exception(detail, "Could not change user to #{Puppet[:user]}: #{detail}")
+          Puppet.log_exception(detail, _("Could not change user to %{user}: %{detail}") % { user: Puppet[:user], detail: detail })
           exit(39)
         end
       else
-        Puppet.err("Could not change user to #{Puppet[:user]}. User does not exist and is required to continue.")
+        Puppet.err(_("Could not change user to %{user}. User does not exist and is required to continue.") % { user: Puppet[:user] })
         exit(74)
       end
     end
 
     if options[:rack]
-      Puppet.deprecation_warning("The Rack Puppet master server is deprecated and will be removed in a future release. Please use Puppet Server instead. See http://links.puppetlabs.com/deprecate-rack-webrick-servers for more information.")
+      Puppet.deprecation_warning(_("The Rack Puppet master server is deprecated and will be removed in a future release. Please use Puppet Server instead. See http://links.puppet.com/deprecate-rack-webrick-servers for more information."))
       start_rack_master
     else
-      Puppet.deprecation_warning("The WEBrick Puppet master server is deprecated and will be removed in a future release. Please use Puppet Server instead. See http://links.puppetlabs.com/deprecate-rack-webrick-servers for more information.")
+      Puppet.deprecation_warning(_("The WEBrick Puppet master server is deprecated and will be removed in a future release. Please use Puppet Server instead. See http://links.puppet.com/deprecate-rack-webrick-servers for more information."))
       start_webrick_master
     end
   end
@@ -256,18 +249,17 @@ Copyright (c) 2012 Puppet Inc., LLC Licensed under the Apache 2.0 License
     Puppet::SSL::Oids.load_custom_oid_file(Puppet[:trusted_oid_mapping_file])
   end
 
-  # Sets up a special node cache "write only yaml" that collects and stores node data in yaml
-  # but never finds or reads anything (this since a real cache causes stale data to be served
-  # in circumstances when the cache can not be cleared).
-  # @see puppet issue 16753
-  # @see Puppet::Node::WriteOnlyYaml
+  # Honor the :node_cache_terminus setting if users have specified it directly.
+  # We normally want this nil as use-cases for querying nodes should be going to
+  # PuppetDB.
+  # @see PUP-6060
   # @return [void]
   def setup_node_cache
     Puppet::Node.indirection.cache_class = Puppet[:node_cache_terminus]
   end
 
   def setup
-    raise Puppet::Error.new("Puppet master is not supported on Microsoft Windows") if Puppet.features.microsoft_windows?
+    raise Puppet::Error.new(_("Puppet master is not supported on Microsoft Windows")) if Puppet.features.microsoft_windows?
 
     setup_logs
 
@@ -316,6 +308,6 @@ Copyright (c) 2012 Puppet Inc., LLC Licensed under the Apache 2.0 License
   end
 
   def announce_start_of_master
-    Puppet.notice "Starting Puppet master version #{Puppet.version}"
+    Puppet.notice _("Starting Puppet master version %{version}") % { version: Puppet.version }
   end
 end

data/lib/puppet/application/resource.rb

@@ -129,11 +129,13 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
   end
 
   def main
-    type, name, params = parse_args(command_line.args)
+    env = Puppet.lookup(:environments).get(Puppet[:environment])
+    Puppet.override(:current_environment => env, :loaders => Puppet::Pops::Loaders.new(env)) do
+      type, name, params = parse_args(command_line.args)
 
-    raise "Editing with Yaml output is not supported" if options[:edit] and options[:to_yaml]
+      raise _("Editing with Yaml output is not supported") if options[:edit] and options[:to_yaml]
 
-    resources = find_or_save_resources(type, name, params)
+      resources = find_or_save_resources(type, name, params)
 
     if options[:to_yaml]
       text = resources.map do |resource|
@@ -146,9 +148,10 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
       end.join("\n")
     end
 
-    options[:edit] ?
-      handle_editing(text) :
-      (puts text)
+      options[:edit] ?
+        handle_editing(text) :
+        (puts text)
+    end
   end
 
   def setup
@@ -186,15 +189,15 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
   end
 
   def parse_args(args)
-    type = args.shift or raise "You must specify the type to display"
-    Puppet::Type.type(type) or raise "Could not find type #{type}"
+    type = args.shift or raise _("You must specify the type to display")
+    Puppet::Type.type(type) or raise _("Could not find type %{type}") % { type: type }
     name = args.shift
     params = {}
     args.each do |setting|
       if setting =~ /^(\w+)=(.+)$/
         params[$1] = $2
       else
-        raise "Invalid parameter setting #{setting}"
+        raise _("Invalid parameter setting %{setting}") % { setting: setting }
       end
     end
 
@@ -216,7 +219,7 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
       end
     else
       if type == "file"
-        raise "Listing all file instances is not supported.  Please specify a file or directory, e.g. puppet resource file /etc"
+        raise _("Listing all file instances is not supported.  Please specify a file or directory, e.g. puppet resource file /etc")
       end
       Puppet::Resource.indirection.search( key, {} )
     end

data/lib/puppet/application_support.rb

@@ -14,11 +14,9 @@ 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, environment_mode = :local)
+    def self.push_application_context(run_mode)
       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
@@ -27,9 +25,6 @@ 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/configurer.rb

@@ -19,7 +19,7 @@ class Puppet::Configurer
 
   # Provide more helpful strings to the logging that the Agent does
   def self.to_s
-    "Puppet configuration client"
+    _("Puppet configuration client")
   end
 
   def self.should_pluginsync?
@@ -47,21 +47,22 @@ class Puppet::Configurer
       Puppet::Util::Storage.load
       @compile_time ||= Puppet::Util::Storage.cache(:configuration)[:compile_time]
   rescue => detail
-    Puppet.log_exception(detail, "Removing corrupt state file #{Puppet[:statefile]}: #{detail}")
+    Puppet.log_exception(detail, _("Removing corrupt state file %{file}: %{detail}") % { file: Puppet[:statefile], detail: detail })
     begin
       Puppet::FileSystem.unlink(Puppet[:statefile])
       retry
     rescue => detail
-      raise Puppet::Error.new("Cannot remove #{Puppet[:statefile]}: #{detail}", detail)
+      raise Puppet::Error.new(_("Cannot remove %{file}: %{detail}") % { file: Puppet[:statefile], detail: detail }, detail)
     end
   end
 
-  def initialize(factory = Puppet::Configurer::DownloaderFactory.new, transaction_uuid = nil)
+  def initialize(factory = Puppet::Configurer::DownloaderFactory.new, transaction_uuid = nil, job_id = nil)
     @running = false
     @splayed = false
     @cached_catalog_status = 'not_used'
     @environment = Puppet[:environment]
     @transaction_uuid = transaction_uuid || SecureRandom.uuid
+    @job_id = job_id
     @static_catalog = true
     @checksum_type = Puppet[:supported_checksum_types]
     @handler = Puppet::Configurer::PluginHandler.new(factory)
@@ -73,13 +74,13 @@ class Puppet::Configurer
     if (Puppet[:use_cached_catalog] && result = retrieve_catalog_from_cache(query_options))
       @cached_catalog_status = 'explicitly_requested'
 
-      Puppet.info "Using cached catalog from environment '#{result.environment}'"
+      Puppet.info _("Using cached catalog from environment '%{environment}'") % { environment: result.environment }
     else
       result = retrieve_new_catalog(query_options)
 
       if !result
         if !Puppet[:usecacheonfailure]
-          Puppet.warning "Not using cache on failed catalog"
+          Puppet.warning _("Not using cache on failed catalog")
           return nil
         end
 
@@ -88,12 +89,12 @@ class Puppet::Configurer
         if result
           # don't use use cached catalog if it doesn't match server specified environment
           if @node_environment && result.environment != @environment
-            Puppet.err "Not using cached catalog because its environment '#{result.environment}' does not match '#{@environment}'"
+            Puppet.err _("Not using cached catalog because its environment '%{catalog_env}' does not match '%{local_env}'") % { catalog_env: result.environment, local_env: @environment }
             return nil
           end
 
           @cached_catalog_status = 'on_failure'
-          Puppet.info "Using cached catalog from environment '#{result.environment}'"
+          Puppet.info _("Using cached catalog from environment '%{catalog_env}'") % { catalog_env: result.environment }
         end
       end
     end
@@ -133,6 +134,7 @@ class Puppet::Configurer
     # set report host name now that we have the fact
     options[:report].host = Puppet[:node_name_value]
     query_options[:transaction_uuid] = @transaction_uuid
+    query_options[:job_id] = @job_id
     query_options[:static_catalog] = @static_catalog
 
     # Query params don't enforce ordered evaluation, so munge this list into a
@@ -147,27 +149,26 @@ class Puppet::Configurer
     catalog = retrieve_catalog(query_options)
     return convert_catalog(catalog, @duration) if catalog
 
-    Puppet.err "Could not retrieve catalog; skipping run"
+    Puppet.err _("Could not retrieve catalog; skipping run")
     nil
   end
 
   def prepare_and_retrieve_catalog_from_cache
     result = retrieve_catalog_from_cache({:transaction_uuid => @transaction_uuid, :static_catalog => @static_catalog})
     if result
-      Puppet.info "Using cached catalog from environment '#{result.environment}'"
+      Puppet.info _("Using cached catalog from environment '%{catalog_env}'") % { catalog_env: result.environment }
       return convert_catalog(result, @duration)
     end
     nil
   end
 
-  # Retrieve (optionally) and apply a catalog. If a catalog is passed in
-  # the options, then apply that one, otherwise retrieve it.
+  # Apply supplied catalog and return associated application report
   def apply_catalog(catalog, options)
     report = options[:report]
     begin
       report.configuration_version = catalog.version
 
-      benchmark(:notice, "Applied catalog") do
+      benchmark(:notice, _("Applied catalog")) do
         catalog.apply(options)
       end
     ensure
@@ -185,7 +186,7 @@ class Puppet::Configurer
     # environment and transaction_uuid very early, this is to ensure
     # they are sent regardless of any catalog compilation failures or
     # exceptions.
-    options[:report] ||= Puppet::Transaction::Report.new("apply", nil, @environment, @transaction_uuid)
+    options[:report] ||= Puppet::Transaction::Report.new(nil, @environment, @transaction_uuid, @job_id)
     report = options[:report]
     init_storage
 
@@ -206,7 +207,7 @@ class Puppet::Configurer
           found = find_functional_server()
           server = found[:server]
           if server.nil?
-            Puppet.warning "Could not select a functional puppet master"
+            Puppet.warning _("Could not select a functional puppet master")
             server = [nil, nil]
           end
           Puppet.override(:server => server[0], :serverport => server[1]) do
@@ -237,7 +238,7 @@ class Puppet::Configurer
         @cached_catalog_status = 'explicitly_requested'
 
         if @environment != catalog.environment && !Puppet[:strict_environment_mode]
-          Puppet.notice "Local environment: '#{@environment}' doesn't match the environment of the cached catalog '#{catalog.environment}', switching agent to '#{catalog.environment}'."
+          Puppet.notice _("Local environment: '%{local_env}' doesn't match the environment of the cached catalog '%{catalog_env}', switching agent to '%{catalog_env}'.") % { local_env: @environment, catalog_env: catalog.environment }
           @environment = catalog.environment
         end
 
@@ -277,16 +278,16 @@ class Puppet::Configurer
             @node_environment = node.environment.to_s
 
             if node.environment.to_s != @environment
-              Puppet.notice "Local environment: '#{@environment}' doesn't match server specified node environment '#{node.environment}', switching agent to '#{node.environment}'."
+              Puppet.notice _("Local environment: '%{local_env}' doesn't match server specified node environment '%{node_env}', switching agent to '%{node_env}'.") % { local_env: @environment, node_env: node.environment }
               @environment = node.environment.to_s
               report.environment = @environment
               query_options = nil
             else
-              Puppet.info "Using configured environment '#{@environment}'"
+              Puppet.info _("Using configured environment '%{env}'") % { env: @environment }
             end
           end
         rescue StandardError => detail
-          Puppet.warning("Unable to fetch my node definition, but the agent run will continue:")
+          Puppet.warning(_("Unable to fetch my node definition, but the agent run will continue:"))
           Puppet.warning(detail)
         end
       end
@@ -311,7 +312,7 @@ class Puppet::Configurer
       end
 
       if Puppet[:strict_environment_mode] && catalog.environment != @environment
-        Puppet.err "Not using catalog because its environment '#{catalog.environment}' does not match agent specified environment '#{@environment}' and strict_environment_mode is set"
+        Puppet.err _("Not using catalog because its environment '%{catalog_env}' does not match agent specified environment '%{local_env}' and strict_environment_mode is set") % { catalog_env: catalog.environment, local_env: @environment }
         return nil
       end
 
@@ -322,9 +323,9 @@ class Puppet::Configurer
       tries = 0
       while catalog.environment and not catalog.environment.empty? and catalog.environment != @environment
         if tries > 3
-          raise Puppet::Error, "Catalog environment didn't stabilize after #{tries} fetches, aborting run"
+          raise Puppet::Error, _("Catalog environment didn't stabilize after %{tries} fetches, aborting run") % { tries: tries }
         end
-        Puppet.notice "Local environment: '#{@environment}' doesn't match server specified environment '#{catalog.environment}', restarting agent run with environment '#{catalog.environment}'"
+        Puppet.notice _("Local environment: '%{local_env}' doesn't match server specified environment '%{catalog_env}', restarting agent run with environment '%{catalog_env}'") % { local_env: @environment, catalog_env: catalog.environment }
         @environment = catalog.environment
         report.environment = @environment
 
@@ -343,7 +344,7 @@ class Puppet::Configurer
       apply_catalog(catalog, options)
       report.exit_status
     rescue => detail
-      Puppet.log_exception(detail, "Failed to apply catalog: #{detail}")
+      Puppet.log_exception(detail, _("Failed to apply catalog: %{detail}") % { detail: detail })
       return nil
     ensure
       execute_postrun_command or return nil
@@ -390,7 +391,7 @@ class Puppet::Configurer
     save_last_run_summary(report)
     Puppet::Transaction::Report.indirection.save(report, nil, :environment => Puppet::Node::Environment.remote(@environment)) if Puppet[:report]
   rescue => detail
-    Puppet.log_exception(detail, "Could not send report: #{detail}")
+    Puppet.log_exception(detail, _("Could not send report: %{detail}") % { detail: detail })
   end
 
   def save_last_run_summary(report)
@@ -399,7 +400,7 @@ class Puppet::Configurer
       fh.print YAML.dump(report.raw_summary)
     end
   rescue => detail
-    Puppet.log_exception(detail, "Could not save last run local report: #{detail}")
+    Puppet.log_exception(detail, _("Could not save last run local report: %{detail}") % { detail: detail })
   end
 
   private
@@ -411,7 +412,7 @@ class Puppet::Configurer
       Puppet::Util::Execution.execute([command])
       true
     rescue => detail
-      Puppet.log_exception(detail, "Could not run command from #{setting}: #{detail}")
+      Puppet.log_exception(detail, _("Could not run command from %{setting}: %{detail}") % { setting: setting, detail: detail })
       false
     end
   end
@@ -419,37 +420,24 @@ class Puppet::Configurer
   def retrieve_catalog_from_cache(query_options)
     result = nil
     @duration = thinmark do
-      result = Puppet::Resource::Catalog.indirection.find(
-        Puppet[:node_name_value],
-        query_options.merge(
-          :ignore_terminus => true,
-          :environment     => Puppet::Node::Environment.remote(@environment)
-        )
-      )
+      result = Puppet::Resource::Catalog.indirection.find(Puppet[:node_name_value],
+        query_options.merge(:ignore_terminus => true, :environment => Puppet::Node::Environment.remote(@environment)))
     end
     result
   rescue => detail
-    Puppet.log_exception(detail, "Could not retrieve catalog from cache: #{detail}")
+    Puppet.log_exception(detail, _("Could not retrieve catalog from cache: %{detail}") % { detail: detail })
     return nil
   end
 
   def retrieve_new_catalog(query_options)
     result = nil
     @duration = thinmark do
-      result = Puppet::Resource::Catalog.indirection.find(
-        Puppet[:node_name_value],
-        query_options.merge(
-          :ignore_cache      => true,
-          # We never want to update the cached Catalog if we're running in noop mode.
-          :ignore_cache_save => Puppet[:noop],
-          :environment       => Puppet::Node::Environment.remote(@environment),
-          :fail_on_404       => true
-        )
-      )
+      result = Puppet::Resource::Catalog.indirection.find(Puppet[:node_name_value],
+        query_options.merge(:ignore_cache => true, :environment => Puppet::Node::Environment.remote(@environment), :fail_on_404 => true))
     end
     result
   rescue StandardError => detail
-    Puppet.log_exception(detail, "Could not retrieve catalog from remote server: #{detail}")
+    Puppet.log_exception(detail, _("Could not retrieve catalog from remote server: %{detail}") % { detail: detail })
     return nil
   end
 

data/lib/puppet/configurer/downloader.rb

@@ -6,7 +6,7 @@ class Puppet::Configurer::Downloader
 
   # Evaluate our download, returning the list of changed values.
   def evaluate
-    Puppet.info "Retrieving #{name}"
+    Puppet.info _("Retrieving %{name}") % { name: name }
 
     files = []
     begin
@@ -17,7 +17,7 @@ class Puppet::Configurer::Downloader
         end
       end
     rescue Puppet::Error => detail
-      Puppet.log_exception(detail, "Could not retrieve #{name}: #{detail}")
+      Puppet.log_exception(detail, _("Could not retrieve %{name}: %{detail}") % { name: name, detail: detail })
     end
     files
   end

data/lib/puppet/configurer/fact_handler.rb

@@ -21,7 +21,7 @@ module Puppet::Configurer::FactHandler
     rescue SystemExit,NoMemoryError
       raise
     rescue Exception => detail
-      message = "Could not retrieve local facts: #{detail}"
+      message = _("Could not retrieve local facts: %{detail}") % { detail: detail }
       Puppet.log_exception(detail, message)
       raise Puppet::Error, message, detail.backtrace
     end
@@ -30,8 +30,17 @@ module Puppet::Configurer::FactHandler
   def facts_for_uploading
     facts = find_facts
 
-    text = facts.render(:pson)
-
-    {:facts_format => :pson, :facts => Puppet::Util.uri_query_encode(text)}
+    # NOTE: :facts specified as parameters are URI encoded here,
+    # then  encoded for a second time depending on their length:
+    #
+    # <= 1024 characters sent via query string of a HTTP GET, additionally query string encoded
+    # > 1024 characters sent in POST data, additionally x-www-form-urlencoded
+    # so it's only important that encoding method here return original values
+    # correctly when CGI.unescape called against it (in compiler code)
+    if Puppet[:preferred_serialization_format] == "pson"
+      {:facts_format => :pson, :facts => Puppet::Util.uri_query_encode(facts.render(:pson)) }
+    else
+      {:facts_format => 'application/json', :facts => Puppet::Util.uri_query_encode(facts.render(:json)) }
+    end
   end
 end