puppet 8.4.0-universal-darwin → 8.5.0-universal-darwin

data/lib/puppet/application/agent.rb

@@ -41,7 +41,7 @@ class Puppet::Application::Agent < Puppet::Application
       :fingerprint => false,
       :sourceaddress => nil,
       :start_time => Time.now,
-    }.each do |opt,val|
+    }.each do |opt, val|
       options[opt] = val
     end
 
@@ -54,10 +54,10 @@ class Puppet::Application::Agent < Puppet::Application
   end
 
   option("--enable")
-  option("--debug","-d")
-  option("--fqdn FQDN","-f")
-  option("--test","-t")
-  option("--verbose","-v")
+  option("--debug", "-d")
+  option("--fqdn FQDN", "-f")
+  option("--test", "-t")
+  option("--verbose", "-v")
 
   option("--fingerprint")
   option("--digest DIGEST")
@@ -86,19 +86,19 @@ class Puppet::Application::Agent < Puppet::Application
 
   def help
     <<~HELP
-      
+
       puppet-agent(8) -- #{summary}
       ========
-      
+
       SYNOPSIS
       --------
       Retrieves the client configuration from the Puppet master and applies it to
       the local host.
-      
+
       This service may be run as a daemon, run periodically using cron (or something
       similar), or run interactively for testing purposes.
-      
-      
+
+
       USAGE
       -----
       puppet agent [--certname <NAME>] [-D|--daemonize|--no-daemonize]
@@ -106,8 +106,8 @@ class Puppet::Application::Agent < Puppet::Application
         [--fingerprint] [-h|--help] [-l|--logdest syslog|eventlog|<ABS FILEPATH>|console]
         [--serverport <PORT>] [--noop] [-o|--onetime] [--sourceaddress <IP_ADDRESS>] [-t|--test]
         [-v|--verbose] [-V|--version] [-w|--waitforcert <SECONDS>]
-      
-      
+
+
       DESCRIPTION
       -----------
       This is the main puppet client. Its job is to retrieve the local
@@ -118,33 +118,33 @@ class Puppet::Application::Agent < Puppet::Application
       authority as part of the puppet server (which is the default). The
       client will connect and request a signed certificate, and will continue
       connecting until it receives one.
-      
+
       Once the client has a signed certificate, it will retrieve its
       configuration and apply it.
-      
-      
+
+
       USAGE NOTES
       -----------
       'puppet agent' does its best to find a compromise between interactive
       use and daemon use. If you run it with no arguments and no configuration, it
       goes into the background, attempts to get a signed certificate, and retrieves
       and applies its configuration every 30 minutes.
-      
+
       Some flags are meant specifically for interactive use --- in particular,
       'test', 'tags' and 'fingerprint' are useful.
-      
+
       '--test' runs once in the foreground with verbose logging, then exits.
-      It also exits if it can't get a valid catalog. `--test` includes the 
-      '--detailed-exitcodes' option by default and exits with one of the following 
+      It also exits if it can't get a valid catalog. `--test` includes the
+      '--detailed-exitcodes' option by default and exits with one of the following
       exit codes:
-      
-      * 0: The run succeeded with no changes or failures; the system was already in 
+
+      * 0: The run succeeded with no changes or failures; the system was already in
            the desired state.
       * 1: The run failed, or wasn't attempted due to another run already in progress.
       * 2: The run succeeded, and some resources were changed.
       * 4: The run succeeded, and some resources failed.
       * 6: The run succeeded, and included both changes and failures.
-      
+
       '--tags' allows you to specify what portions of a configuration you want
       to apply. Puppet elements are tagged with all of the class or definition
       names that contain them, and you can use the 'tags' flag to specify one
@@ -155,7 +155,7 @@ class Puppet::Application::Agent < Puppet::Application
       class, and call puppet with '--tags ntpd', which would only apply that
       small portion of the configuration during your testing, rather than
       applying the whole thing.
-      
+
       '--fingerprint' is a one-time flag. In this mode 'puppet agent' runs
       once and displays on the console (and in the log) the current certificate
       (or certificate request) fingerprint. Providing the '--digest' option
@@ -164,26 +164,26 @@ class Puppet::Application::Agent < Puppet::Application
       the master, the certificate request the master received is the same as
       the one the client sent (to prevent against man-in-the-middle attacks
       when signing certificates).
-      
+
       '--skip_tags' is a flag used to filter resources. If this is set, then
       only resources not tagged with the specified tags will be applied.
       Values must be comma-separated.
-      
-      
+
+
       OPTIONS
       -------
-      
+
       Note that any Puppet setting that's valid in the configuration file is also a
       valid long argument. For example, 'server' is a valid setting, so you can
-      specify '--server <servername>' as an argument. Boolean settings accept a '--no-' 
-      prefix to turn off a behavior, translating into '--setting' and '--no-setting' 
+      specify '--server <servername>' as an argument. Boolean settings accept a '--no-'
+      prefix to turn off a behavior, translating into '--setting' and '--no-setting'
       pairs, such as `--daemonize` and `--no-daemonize`.
-      
+
       See the configuration file documentation at
       https://puppet.com/docs/puppet/latest/configuration.html for the
       full list of acceptable settings. A commented list of all settings can also be
       generated by running puppet agent with '--genconfig'.
-      
+
       * --certname:
         Set the certname (unique ID) of the client. The master reads this
         unique identifying string, which is usually set to the node's
@@ -191,141 +191,141 @@ class Puppet::Application::Agent < Puppet::Application
         node will receive. Use this option to debug setup problems or
         implement unusual node identification schemes.
         (This is a Puppet setting, and can go in puppet.conf.)
-      
+
       * --daemonize:
         Send the process into the background. This is the default.
         (This is a Puppet setting, and can go in puppet.conf. Note the special 'no-'
         prefix for boolean settings on the command line.)
-      
+
       * --no-daemonize:
         Do not send the process into the background.
         (This is a Puppet setting, and can go in puppet.conf. Note the special 'no-'
         prefix for boolean settings on the command line.)
-      
+
       * --debug:
         Enable full debugging.
-      
+
       * --detailed-exitcodes:
         Provide extra information about the run via exit codes; works only if '--test'
         or '--onetime' is also specified. If enabled, 'puppet agent' uses the
         following exit codes:
-      
+
         0: The run succeeded with no changes or failures; the system was already in
         the desired state.
-      
+
         1: The run failed, or wasn't attempted due to another run already in progress.
-      
+
         2: The run succeeded, and some resources were changed.
-      
+
         4: The run succeeded, and some resources failed.
-      
+
         6: The run succeeded, and included both changes and failures.
-      
+
       * --digest:
         Change the certificate fingerprinting digest algorithm. The default is
         SHA256. Valid values depends on the version of OpenSSL installed, but
         will likely contain MD5, MD2, SHA1 and SHA256.
-      
+
       * --disable:
         Disable working on the local system. This puts a lock file in place,
         causing 'puppet agent' not to work on the system until the lock file
         is removed. This is useful if you are testing a configuration and do
         not want the central configuration to override the local state until
         everything is tested and committed.
-      
+
         Disable can also take an optional message that will be reported by the
         'puppet agent' at the next disabled run.
-      
+
         'puppet agent' uses the same lock file while it is running, so no more
         than one 'puppet agent' process is working at a time.
-      
+
         'puppet agent' exits after executing this.
-      
+
       * --enable:
         Enable working on the local system. This removes any lock file,
         causing 'puppet agent' to start managing the local system again
         However, it continues to use its normal scheduling, so it might
         not start for another half hour.
-      
+
         'puppet agent' exits after executing this.
-        
+
       *  --evaltrace:
         Logs each resource as it is being evaluated. This allows you to interactively
         see exactly what is being done. (This is a Puppet setting, and can go in
         puppet.conf. Note the special 'no-' prefix for boolean settings on the command line.)
-      
+
       * --fingerprint:
         Display the current certificate or certificate signing request
         fingerprint and then exit. Use the '--digest' option to change the
         digest algorithm used.
-      
+
       * --help:
         Print this help message
-      
+
       * --job-id:
         Attach the specified job id to the catalog request and the report used for
         this agent run. This option only works when '--onetime' is used.  When using
         Puppet Enterprise this flag should not be used as the orchestrator sets the
         job-id for you and it must be unique.
-      
+
       * --logdest:
         Where to send log messages. Choose between 'syslog' (the POSIX syslog
         service), 'eventlog' (the Windows Event Log), 'console', or the path to a log
         file. If debugging or verbosity is enabled, this defaults to 'console'.
         Otherwise, it defaults to 'syslog' on POSIX systems and 'eventlog' on Windows.
-        Multiple destinations can be set using a comma separated list 
+        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.
-      
+
         A path ending with '.jsonl' will receive structured output in JSON Lines
         format.
-      
+
       * --masterport:
         The port on which to contact the Puppet Server.
         (This is a Puppet setting, and can go in puppet.conf.
         Deprecated in favor of the 'serverport' setting.)
-      
+
       * --noop:
         Use 'noop' mode where the daemon runs in a no-op or dry-run mode. This
         is useful for seeing what changes Puppet would make without actually
         executing the changes.
         (This is a Puppet setting, and can go in puppet.conf. Note the special 'no-'
         prefix for boolean settings on the command line.)
-      
+
       * --onetime:
         Run the configuration once. Runs a single (normally daemonized) Puppet
         run. Useful for interactively running puppet agent when used in
         conjunction with the --no-daemonize option.
         (This is a Puppet setting, and can go in puppet.conf. Note the special 'no-'
         prefix for boolean settings on the command line.)
-      
+
       * --serverport:
         The port on which to contact the Puppet Server.
         (This is a Puppet setting, and can go in puppet.conf.)
-      
+
       * --sourceaddress:
         Set the source IP address for transactions. This defaults to automatically selected.
         (This is a Puppet setting, and can go in puppet.conf.)
-      
+
       * --test:
         Enable the most common options used for testing. These are 'onetime',
         'verbose', 'no-daemonize', 'no-usecacheonfailure', 'detailed-exitcodes',
         'no-splay', and 'show_diff'.
-        
+
       * --trace
         Prints stack traces on some errors. (This is a Puppet setting, and can go in
         puppet.conf. Note the special 'no-' prefix for boolean settings on the command line.)
-      
+
       * --verbose:
         Turn on verbose reporting.
-      
+
       * --version:
         Print the puppet version number and exit.
-      
+
       * --waitforcert:
         This option only matters for daemons that do not yet have certificates
         and it is enabled by default, with a value of 120 (seconds). This
@@ -334,22 +334,22 @@ class Puppet::Application::Agent < Puppet::Application
         of a puppet client. You can turn off waiting for certificates by
         specifying a time of 0.
         (This is a Puppet setting, and can go in puppet.conf.)
-      
+
       * --write_catalog_summary
         After compiling the catalog saves the resource list and classes list to the node
         in the state directory named classes.txt and resources.txt
         (This is a Puppet setting, and can go in puppet.conf.)
-      
+
       EXAMPLE
       -------
           $ puppet agent --server puppet.domain.com
-      
-      
+
+
       DIAGNOSTICS
       -----------
-      
+
       Puppet agent accepts the following signals:
-      
+
       * SIGHUP:
         Restart the puppet agent daemon.
       * SIGINT and SIGTERM:
@@ -358,16 +358,16 @@ class Puppet::Application::Agent < Puppet::Application
         Immediately retrieve and apply configurations from the puppet master.
       * SIGUSR2:
         Close file descriptors for log files and reopen them. Used with logrotate.
-      
+
       AUTHOR
       ------
       Luke Kanies
-      
-      
+
+
       COPYRIGHT
       ---------
       Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
-      
+
     HELP
   end
 
@@ -403,13 +403,14 @@ class Puppet::Application::Agent < Puppet::Application
     # skip also config reading and parsing if debug is not enabled
     return unless Puppet::Util::Log.sendlevel?(:debug)
 
-    Puppet.settings.stringify_settings(:agent, :all).each_pair do |k,v|
+    Puppet.settings.stringify_settings(:agent, :all).each_pair do |k, v|
       next if k.include?("password") || v.to_s.empty?
 
       Puppet.debug("Using setting: #{k}=#{v}")
     end
   end
 
+  # rubocop:disable Lint/RedundantStringCoercion
   def fingerprint
     Puppet::Util::Log.newdestination(:console)
     cert_provider = Puppet::X509::CertProvider.new
@@ -426,13 +427,14 @@ class Puppet::Application::Agent < Puppet::Application
       end
     end
   rescue => e
-    Puppet.log_exception(e, _("Failed to generate fingerprint: %{message}") % {message: e.message})
+    Puppet.log_exception(e, _("Failed to generate fingerprint: %{message}") % { message: e.message })
     exit(1)
   end
+  # rubocop:enable Lint/RedundantStringCoercion
 
   def onetime(daemon)
     begin
-      exitstatus = daemon.agent.run({:job_id => options[:job_id], :start_time => options[:start_time], :waitforcert => options[:waitforcert]})
+      exitstatus = daemon.agent.run({ :job_id => options[:job_id], :start_time => options[:start_time], :waitforcert => options[:waitforcert] })
     rescue => detail
       Puppet.log_exception(detail)
     end

data/lib/puppet/application/apply.rb

@@ -8,13 +8,13 @@ class Puppet::Application::Apply < Puppet::Application
   require_relative '../../puppet/util/splayer'
   include Puppet::Util::Splayer
 
-  option("--debug","-d")
-  option("--execute EXECUTE","-e") do |arg|
+  option("--debug", "-d")
+  option("--execute EXECUTE", "-e") do |arg|
     options[:code] = arg
   end
-  option("--loadclasses","-L")
-  option("--test","-t")
-  option("--verbose","-v")
+  option("--loadclasses", "-L")
+  option("--test", "-t")
+  option("--verbose", "-v")
   option("--use-nodes")
   option("--detailed-exitcodes")
 
@@ -41,132 +41,132 @@ class Puppet::Application::Apply < Puppet::Application
 
   def help
     <<~HELP
-      
+
       puppet-apply(8) -- #{summary}
       ========
-      
+
       SYNOPSIS
       --------
       Applies a standalone Puppet manifest to the local system.
-      
-      
+
+
       USAGE
       -----
       puppet apply [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]
         [-e|--execute] [--detailed-exitcodes] [-L|--loadclasses]
         [-l|--logdest syslog|eventlog|<ABS FILEPATH>|console] [--noop]
         [--catalog <catalog>] [--write-catalog-summary] <file>
-      
-      
+
+
       DESCRIPTION
       -----------
       This is the standalone puppet execution tool; use it to apply
       individual manifests.
-      
+
       When provided with a modulepath, via command line or config file, puppet
       apply can effectively mimic the catalog that would be served by puppet
       master with access to the same modules, although there are some subtle
       differences. When combined with scheduling and an automated system for
       pushing manifests, this can be used to implement a serverless Puppet
       site.
-      
+
       Most users should use 'puppet agent' and 'puppet master' for site-wide
       manifests.
-      
-      
+
+
       OPTIONS
       -------
       Any setting that's valid in the configuration
       file is a valid long argument for puppet apply. For example, 'tags' is a
       valid setting, so you can specify '--tags <class>,<tag>'
       as an argument.
-      
+
       See the configuration file documentation at
       https://puppet.com/docs/puppet/latest/configuration.html for the
       full list of acceptable parameters. You can generate a commented list of all
       configuration options by running puppet with
       '--genconfig'.
-      
+
       * --debug:
         Enable full debugging.
-      
+
       * --detailed-exitcodes:
         Provide extra information about the run via exit codes. If enabled, 'puppet
         apply' will use the following exit codes:
-      
+
         0: The run succeeded with no changes or failures; the system was already in
         the desired state.
-      
+
         1: The run failed.
-      
+
         2: The run succeeded, and some resources were changed.
-      
+
         4: The run succeeded, and some resources failed.
-      
+
         6: The run succeeded, and included both changes and failures.
-      
+
       * --help:
         Print this help message
-      
+
       * --loadclasses:
         Load any stored classes. 'puppet agent' caches configured classes
         (usually at /etc/puppetlabs/puppet/classes.txt), and setting this option causes
         all of those classes to be set in your puppet manifest.
-      
+
       * --logdest:
         Where to send log messages. Choose between 'syslog' (the POSIX syslog
         service), 'eventlog' (the Windows Event Log), 'console', or the path to a log
         file. Defaults to 'console'.
         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.
-      
+
         A path ending with '.jsonl' will receive structured output in JSON Lines
         format.
-      
+
       * --noop:
         Use 'noop' mode where Puppet runs in a no-op or dry-run mode. This
         is useful for seeing what changes Puppet will make without actually
         executing the changes.
-      
+
       * --execute:
         Execute a specific piece of Puppet code
-      
+
       * --test:
         Enable the most common options used for testing. These are 'verbose',
         'detailed-exitcodes' and 'show_diff'.
-      
+
       * --verbose:
         Print extra information.
-      
+
       * --catalog:
         Apply a JSON catalog (such as one generated with 'puppet master --compile'). You can
         either specify a JSON file or pipe in JSON from standard input.
-      
+
       * --write-catalog-summary
         After compiling the catalog saves the resource list and classes list to the node
         in the state directory named classes.txt and resources.txt
-      
+
       EXAMPLE
       -------
           $ puppet apply -l /tmp/manifest.log manifest.pp
           $ puppet apply --modulepath=/root/dev/modules -e "include ntpd::server"
           $ puppet apply --catalog catalog.json
-      
-      
+
+
       AUTHOR
       ------
       Luke Kanies
-      
-      
+
+
       COPYRIGHT
       ---------
       Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
-      
+
     HELP
   end
 
@@ -213,7 +213,7 @@ class Puppet::Application::Apply < Puppet::Application
     # rubocop:enable Layout/ExtraSpacing
 
     # TRANSLATORS "puppet apply" is a program command and should not be translated
-    Puppet.override({:current_environment => apply_environment, :loaders => create_loaders(apply_environment)}, _("For puppet apply")) do
+    Puppet.override({ :current_environment => apply_environment, :loaders => create_loaders(apply_environment) }, _("For puppet apply")) do
       configure_node_facts(node, facts)
 
       # Allow users to load the classes that puppet agent creates.
@@ -340,7 +340,7 @@ class Puppet::Application::Apply < Puppet::Application
     configured_environment = get_configured_environment(node)
 
     # TRANSLATORS "puppet apply" is a program command and should not be translated
-    Puppet.override({:current_environment => configured_environment}, _("For puppet apply")) do
+    Puppet.override({ :current_environment => configured_environment }, _("For puppet apply")) do
       configure_node_facts(node, facts)
 
       # NOTE: Does not set rich_data = true automatically (which would ensure always reading catalog with rich data
@@ -366,7 +366,7 @@ class Puppet::Application::Apply < Puppet::Application
 
   # Returns facts or nil
   #
-  def get_facts()
+  def get_facts
     facts = nil
     unless Puppet[:node_name_fact].empty?
       # Collect our facts.
@@ -381,7 +381,7 @@ class Puppet::Application::Apply < Puppet::Application
 
   # Returns the node or raises and error if node not found.
   #
-  def get_node()
+  def get_node
     node = Puppet::Node.indirection.find(Puppet[:node_name_value])
     raise _("Could not find node %{node}") % { node: Puppet[:node_name_value] } unless node
 
@@ -390,7 +390,7 @@ class Puppet::Application::Apply < Puppet::Application
 
   # Returns either a manifest (filename) or nil if apply should use content of Puppet[:code]
   #
-  def get_manifest()
+  def get_manifest
     manifest = nil
     # Set our code or file to use.
     if options[:code] or command_line.args.length == 0