puppet 4.10.12-x64-mingw32 → 5.0.0-x64-mingw32

data/lib/puppet/application/face_base.rb

@@ -30,12 +30,8 @@ class Puppet::Application::FaceBase < Puppet::Application
   attr_accessor :face, :action, :type, :arguments, :render_as
 
   def render_as=(format)
-    if format == :json then
-      @render_as = Puppet::Network::FormatHandler.format(:pson)
-    else
-      @render_as = Puppet::Network::FormatHandler.format(format)
-    end
-    @render_as or raise ArgumentError, "I don't know how to render '#{format}'"
+    @render_as = Puppet::Network::FormatHandler.format(format)
+    @render_as or raise ArgumentError, _("I don't know how to render '%{format}'") % { format: format }
   end
 
   def render(result, args_and_options)
@@ -57,7 +53,7 @@ class Puppet::Application::FaceBase < Puppet::Application
   def preinit
     super
     Signal.trap(:INT) do
-      $stderr.puts "Cancelling Face"
+      $stderr.puts _("Cancelling Face")
       exit(0)
     end
   end
@@ -129,7 +125,7 @@ class Puppet::Application::FaceBase < Puppet::Application
 
         face   = @face.name
         action = action_name.nil? ? 'default' : "'#{action_name}'"
-        msg = "'#{face}' has no #{action} action.  See `puppet help #{face}`."
+        msg = _("'%{face}' has no %{action} action.  See `puppet help %{face}`.") % { face: face, action: action }
 
         Puppet.err(msg)
         Puppet::Util::Log.force_flushqueue()
@@ -207,7 +203,7 @@ class Puppet::Application::FaceBase < Puppet::Application
     # Call the method associated with the provided action (e.g., 'find').
     unless @action
       puts Puppet::Face[:help, :current].help(@face.name)
-      raise "#{face} does not respond to action #{arguments.first}"
+      raise _("%{face} does not respond to action %{arg}") % { face: face, arg: arguments.first }
     end
 
     # We need to do arity checking here because this is generic code
@@ -240,13 +236,12 @@ class Puppet::Application::FaceBase < Puppet::Application
     # --daniel 2011-04-27
     if (arity = @action.positional_arg_count) > 0
       unless (count = arguments.length) == arity then
-        s = arity == 2 ? '' : 's'
-        raise ArgumentError, "puppet #{@face.name} #{@action.name} takes #{arity-1} argument#{s}, but you gave #{count-1}"
+        raise ArgumentError, n_("puppet %{face} %{action} takes %{arg_count} argument, but you gave %{given_count}", "puppet %{face} %{action} takes %{arg_count} arguments, but you gave %{given_count}", arity - 1) % { face: @face.name, action: @action.name, arg_count: arity-1, given_count: count-1 }
       end
     end
 
     if @face.deprecated?
-      Puppet.deprecation_warning("'puppet #{@face.name}' is deprecated and will be removed in a future release")
+      Puppet.deprecation_warning(_("'puppet %{face}' is deprecated and will be removed in a future release") % { face: @face.name })
     end
 
     result = @face.send(@action.name, *arguments)
@@ -265,7 +260,7 @@ class Puppet::Application::FaceBase < Puppet::Application
 
   rescue => detail
     Puppet.log_exception(detail)
-    Puppet.err "Try 'puppet help #{@face.name} #{@action.name}' for usage"
+    Puppet.err _("Try 'puppet help %{face} %{action}' for usage") % { face: @face.name, action: @action.name }
 
   ensure
     exit status

data/lib/puppet/application/filebucket.rb

@@ -107,55 +107,38 @@ configuration options can also be generated by running puppet with
 * --version:
   Print version information.
 
-EXAMPLES
---------
-    ## Backup a file to the filebucket, then restore it to a temporary directory
+
+EXAMPLE
+-------
     $ 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 a local file
+    ## Diff between the file in the filebucket and the current one
     $ 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
@@ -183,15 +166,15 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
   end
 
   def backup
-    raise "You must specify a file to back up" unless args.length > 0
+    raise _("You must specify a file to back up") unless args.length > 0
 
     args.each do |file|
       unless Puppet::FileSystem.exist?(file)
-        $stderr.puts "#{file}: no such file"
+        $stderr.puts _("%{file}: no such file") % { file: file }
         next
       end
       unless FileTest.readable?(file)
-        $stderr.puts "#{file}: cannot read file"
+        $stderr.puts _("%{file}: cannot read file") % { file: file }
         next
       end
       md5 = @client.backup(file)
@@ -213,7 +196,7 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
   end
 
   def diff
-    raise Puppet::Error, "Need exactly two arguments: filebucket diff <file_a> <file_b>" unless args.count == 2
+    raise Puppet::Error, _("Need exactly two arguments: filebucket diff <file_a> <file_b>") unless args.count == 2
     left = args.shift
     right = args.shift
     if Puppet::FileSystem.exist?(left)
@@ -233,10 +216,10 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
       checksum_b = right
     end
     if (checksum_a || file_a) && (checksum_b || file_b)
-      Puppet.info("Comparing #{checksum_a} #{checksum_b} #{file_a} #{file_b}")
+      Puppet.info(_("Comparing %{checksum_a} %{checksum_b} %{file_a} %{file_b}") % { checksum_a: checksum_a, checksum_b: checksum_b, file_a: file_a, file_b: file_b })
       print @client.diff(checksum_a, checksum_b, file_a, file_b)
     else
-      raise Puppet::Error, "Need exactly two arguments: filebucket diff <file_a> <file_b>"
+      raise Puppet::Error, _("Need exactly two arguments: filebucket diff <file_a> <file_b>")
     end
   end
 
@@ -247,7 +230,7 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
     @server = nil
 
     Signal.trap(:INT) do
-      $stderr.puts "Cancelling"
+      $stderr.puts _("Cancelling")
       exit(1)
     end
 

data/lib/puppet/application/help.rb

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

data/lib/puppet/application/lookup.rb

@@ -5,7 +5,7 @@ require 'puppet/parser/compiler'
 
 class Puppet::Application::Lookup < Puppet::Application
 
-  RUN_HELP = "Run 'puppet lookup --help' for more details".freeze
+  RUN_HELP = _("Run 'puppet lookup --help' for more details").freeze
   DEEP_MERGE_OPTIONS = '--knock-out-prefix, --sort-merged-arrays, and --merge-hash-arrays'.freeze
 
   run_mode :master
@@ -57,19 +57,12 @@ class Puppet::Application::Lookup < Puppet::Application
     if %w{.yaml .yml .json}.include?(arg.match(/\.[^.]*$/)[0])
       options[:fact_file] = arg
     else
-      raise "The --fact file only accepts yaml and json files.\n#{RUN_HELP}"
+      raise _("The --fact file only accepts yaml and json files.\n%{run_help}") % { run_help: RUN_HELP }
     end
   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
@@ -105,127 +98,149 @@ class Puppet::Application::Lookup < Puppet::Application
   def help
     <<-'HELP'
 
-puppet-lookup(8) -- Data in modules lookup function
+puppet-lookup(8) -- Interactive Hiera lookup
 ========
 
 SYNOPSIS
 --------
-The lookup command is used for debugging and testing a given data
-configuration. For a given data key, lookup will produce either a
-value or an explanation of how that value was obtained on the standard
-output stream with the specified rendering format. Lookup is designed
-to be run on a puppet master or a node in a masterless setup.
+Does Hiera lookups from the command line.
+
+Since this command needs access to your Hiera data, make sure to run it on a
+node that has a copy of that data. This usually means logging into a Puppet
+Server node and running 'puppet lookup' with sudo.
+
+The most common version of this command is:
+
+'puppet lookup <KEY> --node <NAME> --environment <ENV> --explain'
 
 USAGE
 -----
-puppet lookup [--help] [--type <TYPESTRING>] [--merge unique|hash|deep]
+puppet lookup [--help] [--type <TYPESTRING>] [--merge first|unique|hash|deep]
   [--knock-out-prefix <PREFIX-STRING>] [--sort-merged-arrays]
-  [--merge-hash-arrays] [--explain]
+  [--merge-hash-arrays] [--explain] [--environment <ENV>]
   [--default <VALUE>] [--node <NODE-NAME>] [--facts <FILE>]
   [--compile]
   [--render-as s|json|yaml|binary|msgpack] <keys>
 
 DESCRIPTION
 -----------
-The lookup command is a CLI interface for the puppet lookup function.
-When given one or more keys, the lookup command will return the first
-value found when run from the puppet master or a masterless node.
+The lookup command is a CLI for Puppet's 'lookup()' function. It searches your
+Hiera data and returns a value for the requested lookup key, so you can test and
+explore your data. It is a modern replacement for the 'hiera' command.
 
-When an explanation has not been requested and
-lookup is simply looking up a value, the application will exit with 0
-if a value was found and 1 otherwise. When an explanation is requested,
-lookup will always exit with 0 unless there is a major error.
+Hiera usually relies on a node's facts to locate the relevant data sources. By
+default, 'puppet lookup' uses facts from the node you run the command on, but
+you can get data for any other node with the '--node <NAME>' option. If
+possible, the lookup command will use the requested node's real stored facts
+from PuppetDB; if PuppetDB isn't configured or you want to provide arbitrary
+fact values, you can pass alternate facts as a JSON or YAML file with '--facts
+<FILE>'.
 
-The other options are as passed into the lookup function, and the effect
-they have on the lookup is described in more detail in the header
-for the lookup function:
+If you're debugging your Hiera data and want to see where values are coming
+from, use the '--explain' option.
 
-http://links.puppetlabs.com/lookup-docs
+If '--explain' isn't specified, lookup exits with 0 if a value was found and 1
+otherwise. With '--explain', lookup always exits with 0 unless there is a major
+error.
+
+You can provide multiple lookup keys to this command, but it only returns a
+value for the first found key, omitting the rest.
+
+For more details about how Hiera works, see the Hiera documentation:
+https://docs.puppet.com/puppet/latest/hiera_intro.html
 
 OPTIONS
 -------
-These options and their effects are described in more detail in
-the puppet lookup function linked to above.
 
 * --help:
   Print this help message.
 
-* --type <TYPESTRING>:
-  Assert that the value has the specified type.
+* --explain
+  Explain the details of how the lookup was performed and where the final value
+  came from (or the reason no value was found).
 
-* --merge unique|hash|deep:
-  Specify the merge strategy. 'hash' performs a simple hash-merge by
-  overwriting keys of lower lookup priority. 'unique' appends everything
-  to an array containing no nested arrays and where all duplicates have been
-  removed. 'deep' Performs a deep merge on values of Array and Hash type. There
-  are additional option flags that can be used with 'deep'.
+* --node <NODE-NAME>
+  Specify which node to look up data for; defaults to the node where the command
+  is run. Since Hiera's purpose is to provide different values for different
+  nodes (usually based on their facts), you'll usually want to use some specific
+  node's facts to explore your data. If the node where you're running this
+  command is configured to talk to PuppetDB, the command will use the requested
+  node's most recent facts. Otherwise, you can override facts with the '--facts'
+  option.
+
+* --facts <FILE>
+  Specify a .json or .yaml file of key => value mappings to override the facts
+  for this lookup. Any facts not specified in this file maintain their
+  original value.
+
+* --environment <ENV>
+  Like with most Puppet commands, you can specify an environment on the command
+  line. This is important for lookup because different environments can have
+  different Hiera data.
+
+* --merge first|unique|hash|deep:
+  Specify the merge behavior, overriding any merge behavior from the data's
+  lookup_options. 'first' returns the first value found. 'unique' appends
+  everything to a merged, deduplicated array. 'hash' performs a simple hash
+  merge by overwriting keys of lower lookup priority. 'deep' performs a deep
+  merge on values of Array and Hash type. There are additional options that can
+  be used with 'deep'.
 
 * --knock-out-prefix <PREFIX-STRING>
-  Can be used with the 'deep' merge strategy. Specify string value to signify
-  prefix which deletes elements from existing element.
+  Can be used with the 'deep' merge strategy. Specifies a prefix to indicate a
+  value should be removed from the final result.
 
 * --sort-merged-arrays
-  Can be used with the 'deep' merge strategy. When this flag is used all
-  merged arrays will be sorted.
+  Can be used with the 'deep' merge strategy. When this flag is used, all
+  merged arrays are sorted.
 
 * --merge-hash-arrays
-  Can be used with the 'deep' merge strategy. When this flag is used arrays
-  and hashes will be merged.
-
-* --explain
-  Print an explanation for the details of how the lookup performed rather
-  than the value returned for the key. The explanation will describe how
-  the result was obtained or why lookup failed to obtain the result.
+  Can be used with the 'deep' merge strategy. When this flag is used, hashes
+  WITHIN arrays are deep-merged with their counterparts by position.
 
 * --explain-options
-  Explain if a lookup_options hash will be used and how it was assembled
-  when performing a lookup.
+  Explain whether a lookup_options hash affects this lookup, and how that hash
+  was assembled. (lookup_options is how Hiera configures merge behavior in data.)
 
 * --default <VALUE>
-  A value produced if no value was found in the lookup.
-
-* --node <NODE-NAME>
-  Specify node which defines the scope in which the lookup will be performed.
-  If a node is not given, lookup will default to the machine from which the
-  lookup is being run (which should be the master).
+  A value to return if Hiera can't find a value in data. For emulating calls to
+  the 'lookup()' function that include a default.
 
-* --facts <FILE>
-  Specify a .json, or .yaml file holding key => value mappings that will
-  override the facts for the current node. Any facts not specified by the
-  user will maintain their original value.
+* --type <TYPESTRING>:
+  Assert that the value has the specified type. For emulating calls to the
+  'lookup()' function that include a data type.
 
 * --compile
-  Perform a full catalog compilation prior to the lookup. This is meaningful when
-  the catalog changes global variables that are referenced in interpolated values.
-  No catalog compilation takes place unless this flag is given.
+  Perform a full catalog compilation prior to the lookup. If your hierarchy and
+  data only use the $facts, $trusted, and $server_facts variables, you don't
+  need this option; however, if your Hiera configuration uses arbitrary
+  variables set by a Puppet manifest, you might need this option to get accurate
+  data. No catalog compilation takes place unless this flag is given.
 
 * --render-as s|json|yaml|binary|msgpack
-  Determines how the results will be rendered to the standard output where
-  s means plain text. The default when lookup is producing a value is yaml
-  and the default when producing an explanation is s.
+  Specify the output format of the results; "s" means plain text. The default
+  when producing a value is yaml and the default when producing an explanation
+  is s.
 
 EXAMPLE
 -------
-  If you wanted to lookup 'key_name' within the scope of the master, you would
-  call lookup like this:
+  To look up 'key_name' using the Puppet Server node's facts:
   $ puppet lookup key_name
 
-  If you wanted to lookup 'key_name' within the scope of the agent.local node,
-  you would call lookup like this:
+  To look up 'key_name' with agent.local's facts:
   $ puppet lookup --node agent.local key_name
 
-  If you wanted to get the first value found for 'key_name_one' and 'key_name_two'
-  within the scope of the agent.local node while merging values and knocking out
-  the prefix 'foo' while merging, you would call lookup like this:
+  To get the first value found for 'key_name_one' and 'key_name_two'
+  with agent.local's facts while merging values and knocking out
+  the prefix 'foo' while merging:
   $ puppet lookup --node agent.local --merge deep --knock-out-prefix foo key_name_one key_name_two
 
-  If you wanted to lookup 'key_name' within the scope of the agent.local node,
-  and return a default value of 'bar' if nothing was found, you would call
-  lookup like this:
+  To lookup 'key_name' with agent.local's facts, and return a default value of
+  'bar' if nothing was found:
   $ puppet lookup --node agent.local --default bar key_name
 
-  If you wanted to see an explanation of how the value for 'key_name' would be
-  obtained in the context of the agent.local node, you would call lookup like this:
+  To see an explanation of how the value for 'key_name' would be found, using
+  agent.local's facts:
   $ puppet lookup --node agent.local --explain key_name
 
 COPYRIGHT
@@ -243,8 +258,8 @@ Copyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License
     #  raise "No node was given via the '--node' flag for the scope of the lookup.\n#{RUN_HELP}"
     #end
 
-    if (options[:sort_merged_arrays] || options[:merge_hash_arrays] || options[:prefix]) && options[:merge] != 'deep'
-      raise "The options #{DEEP_MERGE_OPTIONS} are only available with '--merge deep'\n#{RUN_HELP}"
+    if (options[:sort_merge_arrays] || options[:merge_hash_arrays] || options[:prefix]) && options[:merge] != 'deep'
+      raise _("The options %{deep_merge_opts} are only available with '--merge deep'\n%{run_help}") % { deep_merge_opts: DEEP_MERGE_OPTIONS, run_help: RUN_HELP }
     end
 
     use_default_value = !options[:default_value].nil?
@@ -255,12 +270,12 @@ Copyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License
       strategies = Puppet::Pops::MergeStrategy.strategy_keys
       unless strategies.include?(merge.to_sym)
         strategies = strategies.map {|k| "'#{k}'"}
-        raise "The --merge option only accepts #{strategies[0...-1].join(', ')}, or #{strategies.last}\n#{RUN_HELP}"
+        raise _("The --merge option only accepts %{strategies}, or %{last_strategy}\n%{run_help}") % { strategies: strategies[0...-1].join(', '), last_strategy: strategies.last, run_help: RUN_HELP }
       end
 
       if merge == 'deep'
         merge_options = {'strategy' => 'deep',
-          'sort_merged_arrays' => !options[:sort_merged_arrays].nil?,
+          'sort_merge_arrays' => !options[:sort_merge_arrays].nil?,
           'merge_hash_arrays' => !options[:merge_hash_arrays].nil?}
 
         if options[:prefix]
@@ -280,16 +295,15 @@ Copyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License
         # Explain lookup_options for lookup of an unqualified value.
         keys = Puppet::Pops::Lookup::GLOBAL
       else
-        raise 'No keys were given to lookup.'
+        raise _('No keys were given to lookup.')
       end
     end
     explain = explain_data || explain_options
 
     # Format defaults to text (:s) when producing an explanation and :yaml when producing the value
     format = options[:render_as] || (explain ? :s : :yaml)
-    renderer = Puppet::Network::FormatHandler.format(format == :json ? :pson : format)
-    raise "Unknown rendering format '#{format}'" if renderer.nil?
-
+    renderer = Puppet::Network::FormatHandler.format(format)
+    raise _("Unknown rendering format '%{format}'") % { format: format } if renderer.nil?
 
     generate_scope do |scope|
       lookup_invocation = Puppet::Pops::Lookup::Invocation.new(scope, {}, {}, explain ? Puppet::Pops::Lookup::Explainer.new(explain_options, only_explain_options) : nil)
@@ -315,24 +329,14 @@ Copyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License
       # If we want to lookup the node we are currently on
       # we must returning these settings to their default values
       Puppet.settings[:facts_terminus] = 'facter'
-      Puppet.settings[:node_cache_terminus] = nil
     end
 
-    unless node.is_a?(Puppet::Node) # to allow unit tests to pass a node instance
-      ni = Puppet::Node.indirection
-      tc = ni.terminus_class
-      if tc == :plain || options[:compile]
-        node = ni.find(node)
-      else
-        ni.terminus_class = :plain
-        node = ni.find(node)
-        ni.terminus_class = tc
-      end
-    end
+    node = Puppet::Node.indirection.find(node) unless node.is_a?(Puppet::Node) # to allow unit tests to pass a node instance
 
     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
@@ -340,9 +344,10 @@ Copyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License
       end
 
       unless given_facts.instance_of?(Hash)
-        raise "Incorrect formatted data in #{fact_file} given via the --facts flag"
+        raise _("Incorrect formatted data in %{fact_file} given via the --facts flag") % { fact_file: fact_file }
       end
-      node.add_extra_facts(given_facts)
+
+      node.parameters = original_facts.merge(given_facts)
     end
 
     Puppet[:code] = 'undef' unless options[:compile]