puppet 8.3.1 → 8.4.0

data/lib/puppet/application/device.rb

@@ -1,22 +1,22 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/application'
 require_relative '../../puppet/configurer'
 require_relative '../../puppet/util/network_device'
 require_relative '../../puppet/ssl/oids'
 
 class Puppet::Application::Device < Puppet::Application
-
   run_mode :agent
 
   attr_accessor :args, :agent, :host
 
   def app_defaults
     super.merge({
-      :catalog_terminus => :rest,
-      :catalog_cache_terminus => :json,
-      :node_terminus => :rest,
-      :facts_terminus => :network_device,
-    })
+                  :catalog_terminus => :rest,
+                  :catalog_cache_terminus => :json,
+                  :node_terminus => :rest,
+                  :facts_terminus => :network_device,
+                })
   end
 
   def preinit
@@ -52,7 +52,7 @@ class Puppet::Application::Device < Puppet::Application
   option("--to_yaml","-y")
   option("--verbose","-v")
 
-  option("--detailed-exitcodes") do |arg|
+  option("--detailed-exitcodes") do |_arg|
     options[:detailed_exitcodes] = true
   end
 
@@ -85,149 +85,148 @@ class Puppet::Application::Device < Puppet::Application
   end
 
   def help
-      <<-HELP
-
-puppet-device(8) -- #{summary}
-========
-
-SYNOPSIS
---------
-Retrieves catalogs from the Puppet master and applies them to remote devices.
-
-This subcommand can be run manually; or periodically using cron,
-a scheduled task, or a similar tool.
-
-
-USAGE
------
-  puppet device [-h|--help] [-v|--verbose] [-d|--debug]
-                [-l|--logdest syslog|<file>|console] [--detailed-exitcodes]
-                [--deviceconfig <file>] [-w|--waitforcert <seconds>]
-                [--libdir <directory>]
-                [-a|--apply <file>] [-f|--facts] [-r|--resource <type> [name]]
-                [-t|--target <device>] [--user=<user>] [-V|--version]
-
-
-DESCRIPTION
------------
-Devices require a proxy Puppet agent to request certificates, collect facts,
-retrieve and apply catalogs, and store reports.
-
-
-USAGE NOTES
------------
-Devices managed by the puppet-device subcommand on a Puppet agent are
-configured in device.conf, which is located at $confdir/device.conf by default,
-and is configurable with the $deviceconfig setting.
-
-The device.conf file is an INI-like file, with one section per device:
-
-[<DEVICE_CERTNAME>]
-type <TYPE>
-url <URL>
-debug
-
-The section name specifies the certname of the device.
-
-The values for the type and url properties are specific to each type of device.
-
-The optional debug property specifies transport-level debugging,
-and is limited to telnet and ssh transports.
-
-See https://puppet.com/docs/puppet/latest/config_file_device.html for details.
-
-
-OPTIONS
--------
-Note that any setting that's valid in the configuration file is also a valid
-long argument. For example, 'server' is a valid configuration parameter, so
-you can specify '--server <servername>' as an argument.
-
-* --help, -h:
-  Print this help message
-
-* --verbose, -v:
-  Turn on verbose reporting.
-
-* --debug, -d:
-  Enable full debugging.
-
-* --logdest, -l:
-  Where to send log messages. Choose between 'syslog' (the POSIX syslog
-  service), 'console', or the path to a log file. If debugging or verbosity is
-  enabled, this defaults to 'console'. Otherwise, it defaults to 'syslog'.
-  Multiple destinations can be set using a comma separated list
-  (eg: `/path/file1,console,/path/file2`)"
-
-  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.
-
-* --detailed-exitcodes:
-  Provide transaction information via exit codes. If this is enabled, an exit
-  code of '1' means at least one device had a compile failure, an exit code of
-  '2' means at least one device had resource changes, and an exit code of '4'
-  means at least one device had resource failures. Exit codes of '3', '5', '6',
-  or '7' means that a bitwise combination of the preceding exit codes happened.
-
-* --deviceconfig:
-  Path to the device config file for puppet device.
-  Default: $confdir/device.conf
-
-* --waitforcert, -w:
-  This option only matters for targets that do not yet have certificates
-  and it is enabled by default, with a value of 120 (seconds).  This causes
-  +puppet device+ to poll the server every 2 minutes and ask it to sign a
-  certificate request.  This is useful for the initial setup of a target.
-  You can turn off waiting for certificates by specifying a time of 0.
-
-* --libdir:
-  Override the per-device libdir with a local directory. Specifying a libdir also
-  disables pluginsync. This is useful for testing.
-
-  A path ending with '.jsonl' will receive structured output in JSON Lines
-  format.
-
-* --apply:
-  Apply a manifest against a remote target. Target must be specified.
-
-* --facts:
-  Displays the facts of a remote target. Target must be specified.
-
-* --resource:
-  Displays a resource state as Puppet code, roughly equivalent to
-  `puppet resource`.  Can be filtered by title. Requires --target be specified.
-
-* --target:
-  Target a specific device/certificate in the device.conf. Doing so will perform a
-  device run against only that device/certificate.
-
-* --to_yaml:
-  Output found resources in yaml format, suitable to use with Hiera and
-  create_resources.
-
-* --user:
-  The user to run as.
-
-
-EXAMPLE
--------
-      $ puppet device --target remotehost --verbose
-
-AUTHOR
-------
-Brice Figureau
-
-
-COPYRIGHT
----------
-Copyright (c) 2011-2018 Puppet Inc., LLC
-Licensed under the Apache 2.0 License
-      HELP
+    <<~HELP
+      
+      puppet-device(8) -- #{summary}
+      ========
+      
+      SYNOPSIS
+      --------
+      Retrieves catalogs from the Puppet master and applies them to remote devices.
+      
+      This subcommand can be run manually; or periodically using cron,
+      a scheduled task, or a similar tool.
+      
+      
+      USAGE
+      -----
+        puppet device [-h|--help] [-v|--verbose] [-d|--debug]
+                      [-l|--logdest syslog|<file>|console] [--detailed-exitcodes]
+                      [--deviceconfig <file>] [-w|--waitforcert <seconds>]
+                      [--libdir <directory>]
+                      [-a|--apply <file>] [-f|--facts] [-r|--resource <type> [name]]
+                      [-t|--target <device>] [--user=<user>] [-V|--version]
+      
+      
+      DESCRIPTION
+      -----------
+      Devices require a proxy Puppet agent to request certificates, collect facts,
+      retrieve and apply catalogs, and store reports.
+      
+      
+      USAGE NOTES
+      -----------
+      Devices managed by the puppet-device subcommand on a Puppet agent are
+      configured in device.conf, which is located at $confdir/device.conf by default,
+      and is configurable with the $deviceconfig setting.
+      
+      The device.conf file is an INI-like file, with one section per device:
+      
+      [<DEVICE_CERTNAME>]
+      type <TYPE>
+      url <URL>
+      debug
+      
+      The section name specifies the certname of the device.
+      
+      The values for the type and url properties are specific to each type of device.
+      
+      The optional debug property specifies transport-level debugging,
+      and is limited to telnet and ssh transports.
+      
+      See https://puppet.com/docs/puppet/latest/config_file_device.html for details.
+      
+      
+      OPTIONS
+      -------
+      Note that any setting that's valid in the configuration file is also a valid
+      long argument. For example, 'server' is a valid configuration parameter, so
+      you can specify '--server <servername>' as an argument.
+      
+      * --help, -h:
+        Print this help message
+      
+      * --verbose, -v:
+        Turn on verbose reporting.
+      
+      * --debug, -d:
+        Enable full debugging.
+      
+      * --logdest, -l:
+        Where to send log messages. Choose between 'syslog' (the POSIX syslog
+        service), 'console', or the path to a log file. If debugging or verbosity is
+        enabled, this defaults to 'console'. Otherwise, it defaults to 'syslog'.
+        Multiple destinations can be set using a comma separated list
+        (eg: `/path/file1,console,/path/file2`)"
+      
+        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.
+      
+      * --detailed-exitcodes:
+        Provide transaction information via exit codes. If this is enabled, an exit
+        code of '1' means at least one device had a compile failure, an exit code of
+        '2' means at least one device had resource changes, and an exit code of '4'
+        means at least one device had resource failures. Exit codes of '3', '5', '6',
+        or '7' means that a bitwise combination of the preceding exit codes happened.
+      
+      * --deviceconfig:
+        Path to the device config file for puppet device.
+        Default: $confdir/device.conf
+      
+      * --waitforcert, -w:
+        This option only matters for targets that do not yet have certificates
+        and it is enabled by default, with a value of 120 (seconds).  This causes
+        +puppet device+ to poll the server every 2 minutes and ask it to sign a
+        certificate request.  This is useful for the initial setup of a target.
+        You can turn off waiting for certificates by specifying a time of 0.
+      
+      * --libdir:
+        Override the per-device libdir with a local directory. Specifying a libdir also
+        disables pluginsync. This is useful for testing.
+      
+        A path ending with '.jsonl' will receive structured output in JSON Lines
+        format.
+      
+      * --apply:
+        Apply a manifest against a remote target. Target must be specified.
+      
+      * --facts:
+        Displays the facts of a remote target. Target must be specified.
+      
+      * --resource:
+        Displays a resource state as Puppet code, roughly equivalent to
+        `puppet resource`.  Can be filtered by title. Requires --target be specified.
+      
+      * --target:
+        Target a specific device/certificate in the device.conf. Doing so will perform a
+        device run against only that device/certificate.
+      
+      * --to_yaml:
+        Output found resources in yaml format, suitable to use with Hiera and
+        create_resources.
+      
+      * --user:
+        The user to run as.
+      
+      
+      EXAMPLE
+      -------
+            $ puppet device --target remotehost --verbose
+      
+      AUTHOR
+      ------
+      Brice Figureau
+      
+      
+      COPYRIGHT
+      ---------
+      Copyright (c) 2011-2018 Puppet Inc., LLC
+      Licensed under the Apache 2.0 License
+    HELP
   end
 
-
   def main
     if options[:resource] and !options[:target]
       raise _("resource command requires target")
@@ -235,6 +234,7 @@ Licensed under the Apache 2.0 License
     if options[:facts] and !options[:target]
       raise _("facts command requires target")
     end
+
     unless options[:apply].nil?
       raise _("missing argument: --target is required when using --apply") if options[:target].nil?
       raise _("%{file} does not exist, cannot apply") % { file: options[:apply] } unless File.file?(options[:apply])
@@ -251,7 +251,7 @@ Licensed under the Apache 2.0 License
       require_relative '../../puppet/util/network_device/config'
       devices = Puppet::Util::NetworkDevice::Config.devices.dup
       if options[:target]
-        devices.select! { |key, value| key == options[:target] }
+        devices.select! { |key, _value| key == options[:target] }
       end
       if devices.empty?
         if options[:target]
@@ -261,7 +261,7 @@ Licensed under the Apache 2.0 License
           exit(1)
         end
       end
-      devices.collect do |devicename,device|
+      devices.collect do |_devicename,device|
         # TODO when we drop support for ruby < 2.5 we can remove the extra block here
         begin
           device_url = URI.parse(device.url)

data/lib/puppet/application/doc.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/application'
 
 class Puppet::Application::Doc < Puppet::Application
@@ -39,7 +40,7 @@ class Puppet::Application::Doc < Puppet::Application
     end
   end
 
-  option("--list", "-l") do |arg|
+  option("--list", "-l") do |_arg|
     require_relative '../../puppet/util/reference'
     refs = Puppet::Util::Reference.references(Puppet.lookup(:current_environment))
     puts refs.collect { |r| Puppet::Util::Reference.reference(r).doc }.join("\n")
@@ -55,64 +56,64 @@ class Puppet::Application::Doc < Puppet::Application
   end
 
   def help
-    <<-HELP
-
-puppet-doc(8) -- #{summary}
-========
-
-SYNOPSIS
---------
-Generates a reference for all Puppet types. Largely meant for internal
-Puppet Inc. use. (Deprecated)
-
-
-USAGE
------
-puppet doc [-h|--help] [-l|--list]
-  [-r|--reference <reference-name>]
-
-
-DESCRIPTION
------------
-This deprecated command generates a Markdown document to stdout
-describing all installed Puppet types or all allowable arguments to
-puppet executables. It is largely meant for internal use and is used to
-generate the reference document available on the Puppet Inc. web site.
-
-For Puppet module documentation (and all other use cases) this command
-has been superseded by the "puppet-strings"
-module - see https://github.com/puppetlabs/puppetlabs-strings for more information.
-
-This command (puppet-doc) will be removed once the
-puppetlabs internal documentation processing pipeline is completely based
-on puppet-strings.
-
-OPTIONS
--------
-
-* --help:
-  Print this help message
-
-* --reference:
-  Build a particular reference. Get a list of references by running
-  'puppet doc --list'.
-
-
-EXAMPLE
--------
-    $ puppet doc -r type > /tmp/type_reference.markdown
-
-
-AUTHOR
-------
-Luke Kanies
-
-
-COPYRIGHT
----------
-Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
-
-HELP
+    <<~HELP
+      
+      puppet-doc(8) -- #{summary}
+      ========
+      
+      SYNOPSIS
+      --------
+      Generates a reference for all Puppet types. Largely meant for internal
+      Puppet Inc. use. (Deprecated)
+      
+      
+      USAGE
+      -----
+      puppet doc [-h|--help] [-l|--list]
+        [-r|--reference <reference-name>]
+      
+      
+      DESCRIPTION
+      -----------
+      This deprecated command generates a Markdown document to stdout
+      describing all installed Puppet types or all allowable arguments to
+      puppet executables. It is largely meant for internal use and is used to
+      generate the reference document available on the Puppet Inc. web site.
+      
+      For Puppet module documentation (and all other use cases) this command
+      has been superseded by the "puppet-strings"
+      module - see https://github.com/puppetlabs/puppetlabs-strings for more information.
+      
+      This command (puppet-doc) will be removed once the
+      puppetlabs internal documentation processing pipeline is completely based
+      on puppet-strings.
+      
+      OPTIONS
+      -------
+      
+      * --help:
+        Print this help message
+      
+      * --reference:
+        Build a particular reference. Get a list of references by running
+        'puppet doc --list'.
+      
+      
+      EXAMPLE
+      -------
+          $ puppet doc -r type > /tmp/type_reference.markdown
+      
+      
+      AUTHOR
+      ------
+      Luke Kanies
+      
+      
+      COPYRIGHT
+      ---------
+      Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
+      
+    HELP
   end
 
   def handle_unknown( opt, arg )

data/lib/puppet/application/epp.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/application/face_base'
 require_relative '../../puppet/face'
 

data/lib/puppet/application/face_base.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/application'
 require_relative '../../puppet/face'
 require 'optparse'
 require 'pp'
 
 class Puppet::Application::FaceBase < Puppet::Application
-  option("--debug", "-d") do |arg|
+  option("--debug", "-d") do |_arg|
     set_log_level(:debug => true)
   end
 
@@ -17,7 +18,7 @@ class Puppet::Application::FaceBase < Puppet::Application
     self.render_as = format.to_sym
   end
 
-  option("--help", "-h") do |arg|
+  option("--help", "-h") do |_arg|
     if action && !@is_default_action
       # Only invoke help on the action if it was specified, not if
       # it was the default action.
@@ -155,9 +156,10 @@ class Puppet::Application::FaceBase < Puppet::Application
   end
 
   def find_global_settings_argument(item)
-    Puppet.settings.each do |name, object|
+    Puppet.settings.each do |_name, object|
       object.optparse_args.each do |arg|
         next unless arg =~ /^-/
+
         # sadly, we have to emulate some of optparse here...
         pattern = /^#{arg.sub('[no-]', '').sub(/[ =].*$/, '')}(?:[ =].*)?$/
         pattern.match item and return object
@@ -167,11 +169,13 @@ class Puppet::Application::FaceBase < Puppet::Application
   end
 
   def find_application_argument(item)
-    self.class.option_parser_commands.each do |options, function|
+    self.class.option_parser_commands.each do |options, _function|
       options.each do |option|
         next unless option =~ /^-/
+
         pattern = /^#{option.sub('[no-]', '').sub(/[ =].*$/, '')}(?:[ =].*)?$/
         next unless pattern.match(item)
+
         return {
           :argument => option =~ /[ =]/,
           :optional => option =~ /[ =]\[/
@@ -205,7 +209,6 @@ class Puppet::Application::FaceBase < Puppet::Application
     self.render_as ||= (@action.render_as || :console)
   end
 
-
   def main
     status = false
 
@@ -266,11 +269,9 @@ class Puppet::Application::FaceBase < Puppet::Application
   # --kelsey 2012-02-14
   rescue SystemExit => detail
     status = detail.status
-
   rescue => detail
     Puppet.log_exception(detail)
     Puppet.err _("Try 'puppet help %{face} %{action}' for usage") % { face: @face.name, action: @action.name }
-
   ensure
     exit status
   end

data/lib/puppet/application/facts.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/application/indirection_base'
 
 class Puppet::Application::Facts < Puppet::Application::IndirectionBase