puppet 8.4.0 → 8.5.0

data/lib/puppet/application/filebucket.rb

@@ -5,15 +5,15 @@ require_relative '../../puppet/application'
 class Puppet::Application::Filebucket < Puppet::Application
   environment_mode :not_required
 
-  option("--bucket BUCKET","-b")
-  option("--debug","-d")
-  option("--fromdate FROMDATE","-f")
-  option("--todate TODATE","-t")
-  option("--local","-l")
-  option("--remote","-r")
-  option("--verbose","-v")
+  option("--bucket BUCKET", "-b")
+  option("--debug", "-d")
+  option("--fromdate FROMDATE", "-f")
+  option("--todate TODATE", "-t")
+  option("--local", "-l")
+  option("--remote", "-r")
+  option("--verbose", "-v")
 
-  attr :args
+  attr_reader :args
 
   def summary
     _("Store and retrieve files in a filebucket")
@@ -25,166 +25,166 @@ class Puppet::Application::Filebucket < Puppet::Application
 
   def help
     <<~HELP
-      
+
       puppet-filebucket(8) -- #{summary}
       ========
-      
+
       SYNOPSIS
       --------
       A stand-alone Puppet filebucket client.
-      
-      
+
+
       USAGE
       -----
       puppet filebucket <mode> [-h|--help] [-V|--version] [-d|--debug]
         [-v|--verbose] [-l|--local] [-r|--remote] [-s|--server <server>]
         [-f|--fromdate <date>] [-t|--todate <date>] [-b|--bucket <directory>]
         <file> <file> ...
-      
+
       Puppet filebucket can operate in three modes, with only one mode per call:
-      
+
       backup:
         Send one or more files to the specified file bucket. Each sent file is
         printed with its resulting #{digest_algorithm} sum.
-      
+
       get:
         Return the text associated with an #{digest_algorithm} sum. The text is printed to
         stdout, and only one file can be retrieved at a time.
-      
+
       restore:
         Given a file path and an #{digest_algorithm} sum, store the content associated with
         the sum into the specified file path. You can specify an entirely new
         path to this argument; you are not restricted to restoring the content
         to its original location.
-      
+
       diff:
         Print a diff in unified format between two checksums in the filebucket
         or between a checksum and its matching file.
-      
+
       list:
         List all files in the current local filebucket. Listing remote
         filebuckets is not allowed.
-      
+
       DESCRIPTION
       -----------
       This is a stand-alone filebucket client for sending files to a local or
       central filebucket.
-      
+
       Note that 'filebucket' defaults to using a network-based filebucket
       available on the server named 'puppet'. To use this, you'll have to be
       running as a user with valid Puppet certificates. Alternatively, you can
       use your local file bucket by specifying '--local', or by specifying
       '--bucket' with a local path.
-      
-      > **Note**: Enabling and using the backup option, and by extension the 
-        filebucket resource, requires appropriate planning and management to ensure 
-        that sufficient disk space is available for the file backups. Generally, you 
+
+      > **Note**: Enabling and using the backup option, and by extension the
+        filebucket resource, requires appropriate planning and management to ensure
+        that sufficient disk space is available for the file backups. Generally, you
         can implement this using one of the following two options:
-        - Use a `find` command and `crontab` entry to retain only the last X days 
-        of file backups. For example: 
-      
+        - Use a `find` command and `crontab` entry to retain only the last X days
+        of file backups. For example:
+
         ```shell
         find /opt/puppetlabs/server/data/puppetserver/bucket -type f -mtime +45 -atime +45 -print0 | xargs -0 rm
         ```
-      
+
         - Restrict the directory to a maximum size after which the oldest items are removed.
-      
-      
+
+
       OPTIONS
       -------
       Note that any setting that's valid in the configuration
       file is also a valid long argument. For example, 'ssldir' is a valid
       setting, so you can specify '--ssldir <directory>' as an
       argument.
-      
+
       See the configuration file documentation at
       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'.
-      
+
       * --bucket:
         Specify a local filebucket path. This overrides the default path
         set in '$clientbucketdir'.
-      
+
       * --debug:
         Enable full debugging.
-      
+
       * --fromdate:
         (list only) Select bucket files from 'fromdate'.
-      
+
       * --help:
         Print this help message.
-      
+
       * --local:
         Use the local filebucket. This uses the default configuration
         information and the bucket located at the '$clientbucketdir'
         setting by default. If '--bucket' is set, puppet uses that
         path instead.
-      
+
       * --remote:
         Use a remote filebucket. This uses the default configuration
         information and the bucket located at the '$bucketdir' setting
         by default.
-      
+
       * --server_list:
         A list of comma separated servers; only the first entry is used for file storage.
         This setting takes precidence over `server`.
-      
+
       * --server:
         The server to use for file storage. This setting is only used if `server_list`
         is not set.
-      
+
       * --todate:
         (list only) Select bucket files until 'todate'.
-      
+
       * --verbose:
         Print extra information.
-      
+
       * --version:
         Print version information.
-      
+
       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 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
           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
           ## Manage files in a specific local filebucket
@@ -192,21 +192,21 @@ class Puppet::Application::Filebucket < Puppet::Application
           /tmp/TestFile2: d41d8cd98f00b204e9800998ecf8427e
           $ puppet filebucket -b /tmp/TestBucket list
           d41d8cd98f00b204e9800998ecf8427e 2015-05-11 09:33:22 /tmp/TestFile2
-      
+
           ## From a Puppet Server, list files in the server bucketdir
           $ puppet filebucket -b $(puppet config print bucketdir --section server) list
           d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
           7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile
-      
+
       AUTHOR
       ------
       Luke Kanies
-      
-      
+
+
       COPYRIGHT
       ---------
       Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
-      
+
     HELP
   end
 

data/lib/puppet/application/generate.rb

@@ -2,6 +2,6 @@
 
 require_relative '../../puppet/application/face_base'
 
-# The Generate application. 
+# The Generate application.
 class Puppet::Application::Generate < Puppet::Application::FaceBase
 end

data/lib/puppet/application/lookup.rb

@@ -105,22 +105,22 @@ class Puppet::Application::Lookup < Puppet::Application
 
   def help
     <<~HELP
-      
+
       puppet-lookup(8) -- #{summary}
       ========
-      
+
       SYNOPSIS
       --------
       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 first|unique|hash|deep]
@@ -129,7 +129,7 @@ class Puppet::Application::Lookup < Puppet::Application
         [--default <VALUE>] [--node <NODE-NAME>] [--facts <FILE>]
         [--compile]
         [--render-as s|json|yaml|binary|msgpack] <keys>
-      
+
       DESCRIPTION
       -----------
       The lookup command is a CLI for Puppet's 'lookup()' function. It searches your
@@ -145,30 +145,30 @@ class Puppet::Application::Lookup < Puppet::Application
       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>'.
-      
+
       If you're debugging your Hiera data and want to see where values are coming
       from, use the '--explain' option.
-      
+
       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://puppet.com/docs/puppet/latest/hiera_intro.html
-      
+
       OPTIONS
       -------
-      
+
       * --help:
         Print this help message.
-      
+
       * --explain
         Explain the details of how the lookup was performed and where the final value
         came from (or the reason no value was found).
-      
+
       * --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
@@ -177,18 +177,18 @@ class Puppet::Application::Lookup < Puppet::Application
         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. This environment will be always be the one used regardless
         of any other factors.
-      
+
       * --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
@@ -196,76 +196,76 @@ class Puppet::Application::Lookup < Puppet::Application
         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. 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 are sorted.
-      
+
       * --merge-hash-arrays
         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 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 to return if Hiera can't find a value in data. For emulating calls to
         the 'lookup()' function that include a default.
-      
+
       * --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. 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
         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
       -------
         To look up 'key_name' using the Puppet Server node's facts:
         $ puppet lookup key_name
-      
-        To look up 'key_name' using the Puppet Server node's arbitrary variables from a manifest, and 
+
+        To look up 'key_name' using the Puppet Server node's arbitrary variables from a manifest, and
         classify the node if applicable:
         $ puppet lookup key_name --compile
-      
+
         To look up 'key_name' using the Puppet Server node's facts, overridden by facts given in a file:
         $ puppet lookup key_name --facts fact_file.yaml
-      
+
         To look up 'key_name' with agent.local's facts:
         $ puppet lookup --node agent.local key_name
-      
+
         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
-      
+
         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
-      
+
         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
       ---------
       Copyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License
-      
-      
+
+
     HELP
   end
 
@@ -283,21 +283,21 @@ class Puppet::Application::Lookup < Puppet::Application
     unless merge.nil?
       strategies = Puppet::Pops::MergeStrategy.strategy_keys
       unless strategies.include?(merge.to_sym)
-        strategies = strategies.map {|k| "'#{k}'"}
+        strategies = strategies.map { |k| "'#{k}'" }
         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?,
-                         'merge_hash_arrays' => !options[:merge_hash_arrays].nil?}
+        merge_options = { 'strategy' => 'deep',
+                          'sort_merged_arrays' => !options[:sort_merged_arrays].nil?,
+                          'merge_hash_arrays' => !options[:merge_hash_arrays].nil? }
 
         if options[:prefix]
           merge_options['knockout_prefix'] = options[:prefix]
         end
 
       else
-        merge_options = {'strategy' => merge}
+        merge_options = { 'strategy' => merge }
       end
     end
 
@@ -364,7 +364,7 @@ class Puppet::Application::Lookup < Puppet::Application
       if TRUSTED_INFORMATION_FACTS.any? { |key| given_facts.key? key }
         unless TRUSTED_INFORMATION_FACTS.all? { |key| given_facts.key? key }
           raise _("When overriding any of the %{trusted_facts_list} facts with %{fact_file} "\
-            "given via the --facts flag, they must all be overridden.") % { fact_file: fact_file ,trusted_facts_list: TRUSTED_INFORMATION_FACTS.join(',')}
+                  "given via the --facts flag, they must all be overridden.") % { fact_file: fact_file, trusted_facts_list: TRUSTED_INFORMATION_FACTS.join(',') }
         end
       end
     end
@@ -421,7 +421,7 @@ class Puppet::Application::Lookup < Puppet::Application
     facts.add_extra_values(given_facts) if given_facts
 
     if facts.values.empty?
-      raise _("No facts available for target node: %{node}") % { node: node}
+      raise _("No facts available for target node: %{node}") % { node: node }
     end
 
     facts

data/lib/puppet/application/resource.rb

@@ -11,10 +11,10 @@ class Puppet::Application::Resource < Puppet::Application
     @extra_params = [:provider]
   end
 
-  option("--debug","-d")
-  option("--verbose","-v")
-  option("--edit","-e")
-  option("--to_yaml","-y")
+  option("--debug", "-d")
+  option("--verbose", "-v")
+  option("--edit", "-e")
+  option("--to_yaml", "-y")
 
   option("--types", "-t") do |_arg|
     env = Puppet.lookup(:environments).get(Puppet[:environment]) || create_default_environment
@@ -39,81 +39,81 @@ class Puppet::Application::Resource < Puppet::Application
 
   def help
     <<~HELP
-      
+
       puppet-resource(8) -- #{summary}
       ========
-      
+
       SYNOPSIS
       --------
       Uses the Puppet RAL to directly interact with the system.
-      
-      
+
+
       USAGE
       -----
       puppet resource [-h|--help] [-d|--debug] [-v|--verbose] [-e|--edit]
         [-p|--param <parameter>] [-t|--types] [-y|--to_yaml] <type>
         [<name>] [<attribute>=<value> ...]
-      
-      
+
+
       DESCRIPTION
       -----------
       This command provides simple facilities for converting current system
       state into Puppet code, along with some ability to modify the current
       state using Puppet's RAL.
-      
+
       By default, you must at least provide a type to list, in which case
       puppet resource will tell you everything it knows about all resources of
       that type. You can optionally specify an instance name, and puppet
       resource will only describe that single instance.
-      
+
       If given a type, a name, and a series of <attribute>=<value> pairs,
       puppet resource will modify the state of the specified resource.
       Alternately, if given a type, a name, and the '--edit' flag, puppet
       resource will write its output to a file, open that file in an editor,
       and then apply the saved file as a Puppet transaction.
-      
-      
+
+
       OPTIONS
       -------
       Note that any setting that's valid in the configuration
       file is also a valid long argument. For example, 'ssldir' is a valid
       setting, so you can specify '--ssldir <directory>' as an
       argument.
-      
+
       See the configuration file documentation at
       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'.
-      
+
       * --debug:
         Enable full debugging.
-      
+
       * --edit:
         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.
-      
+
       * --help:
         Print this help message.
-      
+
       * --param:
         Add more parameters to be outputted from queries.
-      
+
       * --types:
         List all available types.
-      
+
       * --verbose:
         Print extra information.
-      
+
       * --to_yaml:
         Output found resources in yaml format, suitable to use with Hiera and
         create_resources.
-      
+
       EXAMPLE
       -------
       This example uses `puppet resource` to return a Puppet configuration for
       the user `luke`:
-      
+
           $ puppet resource user luke
           user { 'luke':
            home => '/home/luke',
@@ -124,17 +124,17 @@ class Puppet::Application::Resource < Puppet::Application
            shell => '/bin/bash',
            groups => ['sysadmin','audio','video','puppet']
           }
-      
-      
+
+
       AUTHOR
       ------
       Luke Kanies
-      
-      
+
+
       COPYRIGHT
       ---------
       Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
-      
+
     HELP
   end
 
@@ -188,7 +188,7 @@ class Puppet::Application::Resource < Puppet::Application
       tmpfile.puts text
 
       # edit the content
-      system(ENV["EDITOR"] || 'vi', tmpfile.path)
+      system(ENV.fetch("EDITOR", nil) || 'vi', tmpfile.path)
 
       # ...and, now, pass that file to puppet to apply.  Because
       # many editors rename or replace the original file we need to
@@ -231,20 +231,20 @@ class Puppet::Application::Resource < Puppet::Application
     Puppet.override(stringify_rich: true) do
       if name
         if params.empty?
-          [ Puppet::Resource.indirection.find( key ) ]
+          [Puppet::Resource.indirection.find(key)]
         else
-          resource = Puppet::Resource.new( type, name, :parameters => params )
+          resource = Puppet::Resource.new(type, name, :parameters => params)
 
           # save returns [resource that was saved, transaction log from applying the resource]
           save_result = Puppet::Resource.indirection.save(resource, key)
-          [ save_result.first ]
+          [save_result.first]
         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")
         end
 
-        Puppet::Resource.indirection.search( key, {} )
+        Puppet::Resource.indirection.search(key, {})
       end
     end
   end