puppet 4.0.0 → 5.0.0

data/lib/puppet/application/master.rb

@@ -61,7 +61,7 @@ specify '--server <servername>' as an argument. Boolean settings translate into
 '--setting' and '--no-setting' pairs.
 
 See the configuration file documentation at
-http://docs.puppetlabs.com/references/stable/configuration.html for the
+https://docs.puppetlabs.com/puppet/latest/reference/configuration.html for the
 full list of acceptable settings. A commented list of all settings can also be
 generated by running puppet master with '--genconfig'.
 
@@ -86,8 +86,13 @@ generated by running puppet master with '--genconfig'.
   service), 'console', or the path to a log file. If debugging or verbosity is
   enabled, this defaults to 'console'. Otherwise, it defaults to 'syslog'.
 
+  A path ending with '.json' will receive structured output in JSON format. The
+  log file will not have an ending ']' automatically written to it due to the
+  appending nature of logging. It must be appended manually to make the content
+  valid JSON.
+
 * --masterport:
-  The port on which to listen for traffic.
+  The port on which to listen for traffic. The default port is 8140.
   (This is a Puppet setting, and can go in puppet.conf.)
 
 * --verbose:
@@ -125,27 +130,20 @@ Luke Kanies
 
 COPYRIGHT
 ---------
-Copyright (c) 2012 Puppet Labs, LLC Licensed under the Apache 2.0 License
+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
 
@@ -164,12 +162,12 @@ Copyright (c) 2012 Puppet Labs, 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)
@@ -185,17 +183,24 @@ Copyright (c) 2012 Puppet Labs, LLC Licensed under the Apache 2.0 License
     Puppet::SSL::Host.ca_location = :only if Puppet::SSL::CertificateAuthority.ca?
 
     if Puppet.features.root?
-      begin
-        Puppet::Util.chuser
-      rescue => detail
-        Puppet.log_exception(detail, "Could not change user to #{Puppet[:user]}: #{detail}")
-        exit(39)
+      if Puppet::Type.type(:user).new(:name => Puppet[:user]).exists?
+        begin
+          Puppet::Util.chuser
+        rescue => 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 %{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.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.puppet.com/deprecate-rack-webrick-servers for more information."))
       start_webrick_master
     end
   end
@@ -244,18 +249,17 @@ Copyright (c) 2012 Puppet Labs, 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
 
@@ -283,6 +287,9 @@ Copyright (c) 2012 Puppet Labs, LLC Licensed under the Apache 2.0 License
     daemon.server = Puppet::Network::Server.new(Puppet[:bindaddress], Puppet[:masterport])
     daemon.daemonize if Puppet[:daemonize]
 
+    # Setup signal traps immediately after daemonization so we clean up the daemon
+    daemon.set_signal_traps
+
     announce_start_of_master
 
     daemon.start
@@ -301,6 +308,6 @@ Copyright (c) 2012 Puppet Labs, 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

@@ -72,7 +72,7 @@ setting, so you can specify '--ssldir <directory>' as an
 argument.
 
 See the configuration file documentation at
-http://docs.puppetlabs.com/references/stable/configuration.html for the
+https://docs.puppetlabs.com/puppet/latest/reference/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'.
@@ -84,10 +84,6 @@ configuration options can also be generated by running puppet with
   Write the results of the query to a file, open the file in an editor,
   and read the file back in as an executable Puppet manifest.
 
-* --host:
-  When specified, connect to the resource server on the named host
-  and retrieve the list of resouces of the type specified.
-
 * --help:
   Print this help message.
 
@@ -127,32 +123,35 @@ Luke Kanies
 
 COPYRIGHT
 ---------
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
+Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
 
     HELP
   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 { |resource| resource.prune_parameters(:parameters_to_include => @extra_params).to_hierayaml }.
-        join("\n")
+      text = resources.map do |resource|
+        resource.prune_parameters(:parameters_to_include => @extra_params).to_hierayaml.force_encoding(Encoding.default_external)
+      end.join("\n")
       text.prepend("#{type.downcase}:\n")
     else
-      text = resources.
-        map { |resource| resource.prune_parameters(:parameters_to_include => @extra_params).to_manifest }.
-        join("\n")
+      text = resources.map do |resource|
+        resource.prune_parameters(:parameters_to_include => @extra_params).to_manifest.force_encoding(Encoding.default_external)
+      end.join("\n")
     end
 
-    options[:edit] ?
-      handle_editing(text) :
-      (puts text)
+      options[:edit] ?
+        handle_editing(text) :
+        (puts text)
+    end
   end
 
   def setup
@@ -170,7 +169,7 @@ Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
     require 'tempfile'
     # Prefer the current directory, which is more likely to be secure
     # and, in the case of interactive use, accessible to the user.
-    tmpfile = Tempfile.new('x2puppet', Dir.pwd)
+    tmpfile = Tempfile.new('x2puppet', Dir.pwd, :encoding => Encoding::UTF_8)
     begin
       # sync write, so nothing buffers before we invoke the editor.
       tmpfile.sync = true
@@ -190,15 +189,15 @@ Copyright (c) 2011 Puppet Labs, 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
 
@@ -220,7 +219,7 @@ Copyright (c) 2011 Puppet Labs, 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.rb

@@ -75,7 +75,7 @@ module Puppet
 # Refer to +OptionParser+ documentation for the exact format.
 # * If the option method is given a block, this one will be called whenever
 # the option is encountered in the command-line argument.
-# * If the option method has no block, a default functionnality will be used, that
+# * If the option method has no block, a default functionality will be used, that
 # stores the argument (or true/false if the option doesn't require an argument) in
 # the global (to the application) options array.
 # * If a given option was not defined by a the +option+ method, but it exists as a Puppet settings:
@@ -83,7 +83,7 @@ module Puppet
 #  * if +unknown+ wasn't used, then the option/argument is handed to Puppet.settings.handlearg for
 #    a default behavior
 #
-# --help is managed directly by the Puppet::Application class, but can be overriden.
+# --help is managed directly by the Puppet::Application class, but can be overridden.
 #
 # === Setup
 # Applications can use the setup block to perform any initialization.
@@ -228,7 +228,7 @@ class Application
       begin
         require @loader.expand(application_name.to_s.downcase)
       rescue LoadError => e
-        Puppet.log_and_raise(e, "Unable to find application '#{application_name}'. #{e}")
+        Puppet.log_and_raise(e, _("Unable to find application '%{application_name}'. %{error}") % { application_name: application_name, error: e })
       end
 
       class_name = Puppet::Util::ConstantInflector.file2constant(application_name.to_s)
@@ -249,7 +249,7 @@ class Application
       ################################################################
 
       if clazz.nil?
-        raise Puppet::Error.new("Unable to load application class '#{class_name}' from file 'puppet/application/#{application_name}.rb'")
+        raise Puppet::Error.new(_("Unable to load application class '%{class_name}' from file 'puppet/application/%{application_name}.rb'") % { class_name: class_name, application_name: application_name })
       end
 
       return clazz
@@ -322,6 +322,15 @@ class Application
     @options = {}
   end
 
+  # call in setup of subclass to deprecate an application
+  def deprecate
+    @deprecated = true
+  end
+
+  def deprecated?
+    @deprecated
+  end
+
   # Execute the application.
   # @api public
   # @return [void]
@@ -330,22 +339,27 @@ class Application
     # I don't really like the names of these lifecycle phases.  It would be nice to change them to some more meaningful
     # names, and make deprecated aliases.  --cprice 2012-03-16
 
-    exit_on_fail("get application-specific default settings") do
+    exit_on_fail(_("get application-specific default settings")) do
       initialize_app_defaults
     end
 
     Puppet::ApplicationSupport.push_application_context(self.class.run_mode)
 
-    exit_on_fail("initialize")                                   { preinit }
-    exit_on_fail("parse application options")                    { parse_options }
-    exit_on_fail("prepare for execution")                        { setup }
-    exit_on_fail("configure routes from #{Puppet[:route_file]}") { configure_indirector_routes }
-    exit_on_fail("log runtime debug info")                       { log_runtime_environment }
-    exit_on_fail("run")                                          { run_command }
+    exit_on_fail(_("initialize"))                                   { preinit }
+    exit_on_fail(_("parse application options"))                    { parse_options }
+    exit_on_fail(_("prepare for execution"))                        { setup }
+
+    if deprecated?
+      Puppet.deprecation_warning(_("`puppet %{name}` is deprecated and will be removed in a future release.") % { name: name })
+    end
+
+    exit_on_fail(_("configure routes from %{route_file}") % { route_file: Puppet[:route_file] }) { configure_indirector_routes }
+    exit_on_fail(_("log runtime debug info"))                       { log_runtime_environment }
+    exit_on_fail(_("run"))                                          { run_command }
   end
 
   def main
-    raise NotImplementedError, "No valid command or main"
+    raise NotImplementedError, _("No valid command or main")
   end
 
   def run_command
@@ -357,8 +371,10 @@ class Application
   end
 
   def setup_logs
-    if options[:debug] || options[:verbose]
-      Puppet::Util::Log.newdestination(:console)
+    unless options[:setdest]
+      if options[:debug] || options[:verbose]
+        Puppet::Util::Log.newdestination(:console)
+      end
     end
 
     set_log_level
@@ -456,7 +472,7 @@ class Application
   end
 
   def help
-    "No help available for puppet #{name}"
+    _("No help available for puppet %{app_name}") % { app_name: name }
   end
 end
 end

data/lib/puppet/application_support.rb

@@ -36,7 +36,7 @@ module Puppet
     end
 
     # Reads the routes YAML settings from the file specified by Puppet[:route_file]
-    # and resets indirector terminii for the current application class if listed.
+    # and resets indirector termini for the current application class if listed.
     #
     # For instance, PE uses this to set the master facts terminus
     # to 'puppetdb' and its cache terminus to 'yaml'.

data/lib/puppet/compilable_resource_type.rb

@@ -0,0 +1,15 @@
+require 'puppet'
+# The CompilableResourceType module should be either included in a class or used as a class extension
+# to mark that the instance used as the 'resource type' of a resource instance
+# is an object that is compatible with Puppet::Type's API wrt. compiling.
+# Puppet Resource Types written in Ruby use a meta programmed Ruby Class as the type. Those classes
+# are subtypes of Puppet::Type. Meta data (Pcore/puppet language) based resource types uses instances of
+# a class instead.
+# 
+module Puppet::CompilableResourceType
+  # All 3.x resource types implemented in Ruby using Puppet::Type respond true.
+  # Other kinds of implementations should reimplement and return false.
+  def is_3x_ruby_plugin?
+    true
+  end
+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 => CGI.escape(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

data/lib/puppet/configurer/plugin_handler.rb

@@ -12,12 +12,14 @@ class Puppet::Configurer::PluginHandler
   def download_plugins(environment)
     plugin_downloader = @factory.create_plugin_downloader(environment)
 
-    if Puppet.features.external_facts?
-      plugin_fact_downloader = @factory.create_plugin_facts_downloader(environment)
-      plugin_fact_downloader.evaluate
-    end
+    result = []
 
-    plugin_downloader.evaluate
+    plugin_fact_downloader = @factory.create_plugin_facts_downloader(environment)
+    result += plugin_fact_downloader.evaluate
+
+    result += plugin_downloader.evaluate
     Puppet::Util::Autoload.reload_changed
+
+    result
   end
 end