puppet 8.3.1 → 8.4.0

data/lib/puppet/daemon.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../puppet/application'
 require_relative '../puppet/scheduler'
 
@@ -25,6 +26,7 @@ class Puppet::Daemon
 
   def initialize(agent, pidfile, scheduler = Puppet::Scheduler::Scheduler.new())
     raise Puppet::DevError, _("Daemons must have an agent") unless agent
+
     @scheduler = scheduler
     @pidfile = pidfile
     @agent = agent
@@ -80,6 +82,7 @@ class Puppet::Daemon
 
   def reexec
     raise Puppet::DevError, _("Cannot reexec unless ARGV arguments are set") unless argv
+
     command = $0 + " " + argv.join(" ")
     Puppet.notice "Restarting with '#{command}'"
     stop(:exit => false)
@@ -170,7 +173,7 @@ class Puppet::Daemon
     end
 
     signal_loop = Puppet::Scheduler.create_job(SIGNAL_CHECK_INTERVAL) do
-      while method = @signals.shift #rubocop:disable Lint/AssignmentInCondition
+      while method = @signals.shift # rubocop:disable Lint/AssignmentInCondition
         Puppet.notice "Processing #{method}"
         send(method)
       end

data/lib/puppet/data_binding.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../puppet/indirector'
 
 # A class for managing data lookups
@@ -7,7 +8,7 @@ class Puppet::DataBinding
   extend Puppet::Indirector
 
   indirects(:data_binding, :terminus_setting => :data_binding_terminus,
-    :doc => "Where to find external data bindings.")
+                           :doc => "Where to find external data bindings.")
 
   class LookupError < Puppet::PreformattedError; end
 

data/lib/puppet/datatypes/error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 Puppet::DataTypes.create_type('Error') do
   interface <<-PUPPET
     type_parameters => {
@@ -14,7 +15,7 @@ Puppet::DataTypes.create_type('Error') do
     functions => {
       message => Callable[[], String[1]]
     }
-    PUPPET
+  PUPPET
 
   require_relative '../../puppet/datatypes/impl/error'
 

data/lib/puppet/datatypes/impl/error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Puppet::DataTypes::Error
   attr_reader :msg, :kind, :issue_code, :details
   alias message msg

data/lib/puppet/datatypes.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Data types in the Puppet Language can have implementations written in Ruby
 # and distributed in puppet modules. A data type can be declared together with
 # its implementation by creating a file in 'lib/puppet/functions/<modulename>'.
@@ -133,7 +134,6 @@ module Puppet::DataTypes
     rescue StandardError => e
       raise ArgumentError, _("Data Type Load Error for type '%{type_name}': %{message}") % {type_name: type_name, message: e.message}
     end
-
   end
 
   def self.create_loaded_type(type_name, loader, &block)
@@ -155,6 +155,7 @@ module Puppet::DataTypes
 
     def create_type(loader)
       raise ArgumentError, _('a data type must have an interface') unless @interface.is_a?(String)
+
       created_type = Puppet::Pops::Types::PObjectType.new(
         @type_name,
         Puppet::Pops::Parser::EvaluatingParser.new.parse_string("{ #{@interface} }").body)
@@ -194,16 +195,19 @@ module Puppet::DataTypes
 
     def interface(type_string)
       raise ArgumentError, _('a data type can only have one interface') unless @type_builder.interface.nil?
+
       @type_builder.interface = type_string
     end
 
     def implementation(&block)
       raise ArgumentError, _('a data type can only have one implementation') if @type_builder.has_implementation?
+
       @type_builder.implementation = block
     end
 
     def implementation_class(ruby_class)
       raise ArgumentError, _('a data type can only have one implementation') if @type_builder.has_implementation?
+
       @type_builder.implementation_class = ruby_class
     end
 

data/lib/puppet/defaults.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
+
 require_relative '../puppet/util/platform'
 
 module Puppet
-
   def self.default_diffargs
     '-u'
   end
@@ -31,6 +31,7 @@ module Puppet
 
   def self.default_cadir
     return "" if Puppet::Util::Platform.windows?
+
     old_ca_dir = "#{Puppet[:ssldir]}/ca"
     new_ca_dir = "/etc/puppetlabs/puppetserver/ca"
 
@@ -117,7 +118,7 @@ module Puppet
         :desc     => "The name of the application, if we are running as one.  The
           default is essentially $0 without the path or `.rb`.",
     }
-  )
+    )
 
   settings.define_settings(:main,
     :logdir => {
@@ -371,6 +372,7 @@ module Puppet
           paths = ENV['PATH'].split(File::PATH_SEPARATOR)
           Puppet::Util::Platform.default_paths.each do |path|
             next if paths.include?(path)
+
             ENV['PATH'] = ENV['PATH'] + File::PATH_SEPARATOR + path
           end
           value
@@ -430,7 +432,7 @@ module Puppet
       between the configured or resolved path.
 
       When set to false, the resolved paths are reported instead of the configured paths.
-    EOT
+      EOT
     },
     :use_last_environment => {
       :type     => :boolean,
@@ -441,7 +443,7 @@ module Puppet
       environment and skip the node request.
 
       When set to false, we will do the node request and ignore the environment data from the last_run_summary file.
-    EOT
+      EOT
     },
     :always_retry_plugins => {
         :type     => :boolean,
@@ -462,7 +464,7 @@ module Puppet
         feature.  This behavior is almost always appropriate for the server,
         and can result in a significant performance improvement for types and
         features that are checked frequently.
-      EOT
+        EOT
     },
     :diff_args => {
         :default  => lambda { default_diffargs },
@@ -493,10 +495,10 @@ module Puppet
           currently cannot daemonize).",
         :short    => "D",
         :hook     => proc do |value|
-          if value and Puppet::Util::Platform.windows?
-            raise "Cannot daemonize on Windows"
-          end
-      end
+                       if value and Puppet::Util::Platform.windows?
+                         raise "Cannot daemonize on Windows"
+                       end
+                     end
     },
     :maximum_uid => {
         :default  => 4294967290,
@@ -709,7 +711,7 @@ Fine grained control of filetimeouts is deprecated. In future
 releases this value will only determine if file content is cached.
 
 Valid values are 0 (never cache) and 15 (15 second minimum wait time).
-            WARNING
+          WARNING
         end
       end
     },
@@ -813,7 +815,6 @@ Valid values are 0 (never cache) and 15 (15 second minimum wait time).
 
     settings.define_settings(
     :main,
-
     # We have to downcase the fqdn, because the current ssl stuff (as opposed to in master) doesn't have good facilities for
     # manipulating naming.
     :certname => {
@@ -1273,7 +1274,7 @@ EOT
     }
   )
 
-  # Define the config default.
+    # Define the config default.
 
     settings.define_settings(:application,
       :config_file_name => {
@@ -1298,7 +1299,7 @@ EOT
         :default    => nil,
         :desc       => "The address the agent should use to initiate requests.",
       },
-  )
+    )
 
   settings.define_settings(:environment,
     :manifest => {
@@ -1622,7 +1623,7 @@ EOT
       :owner => "root",
       :mode => "0640",
       :desc => "The file in which puppet agent stores a list of the resources
-        associated with the retrieved configuration."  },
+        associated with the retrieved configuration." },
     :puppetdlog => {
       :default => "$logdir/puppetd.log",
       :type => :file,
@@ -2036,7 +2037,7 @@ EOT
       :type       => :boolean,
       :desc       => "Whether plugins should be synced with the central server. This setting is
         deprecated.",
-      :hook => proc { |value|
+      :hook => proc { |_value|
         #TRANSLATORS 'pluginsync' is a setting and should not be translated
         Puppet.deprecation_warning(_("Setting 'pluginsync' is deprecated."))
       }
@@ -2054,7 +2055,7 @@ EOT
     }
   )
 
-  # Central fact information.
+    # Central fact information.
 
     settings.define_settings(
     :main,
@@ -2135,7 +2136,7 @@ EOT
 
           For more info, see [the ENC documentation](https://puppet.com/docs/puppet/latest/nodes_external.html).",
     }
-    )
+  )
 
         settings.define_settings(
         :ldap,
@@ -2205,7 +2206,7 @@ EOT
           have one already set.  Generally, it should be the 'ou=Hosts'
           branch under your main directory.",
     }
-  )
+      )
 
   settings.define_settings(:server,
     :storeconfigs => {

data/lib/puppet/environments.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
+
 require_relative '../puppet/concurrent/synchronized'
 
 # @api private
 module Puppet::Environments
-
   class EnvironmentNotFound < Puppet::Error
     def initialize(environment_name, original = nil)
       environmentpath = Puppet[:environmentpath]
@@ -139,7 +139,6 @@ module Puppet::Environments
   #
   # @api private
   class StaticPrivate < Static
-
     # Unlisted
     #
     # @!macro loader_list
@@ -160,6 +159,7 @@ module Puppet::Environments
     # @!macro loader_get_conf
     def get_conf(name)
       return nil unless name.intern == @env_name
+
       Puppet::Settings::EnvironmentConf.load_from(@env_dir, [])
     end
   end
@@ -268,6 +268,7 @@ module Puppet::Environments
 
     def valid_environment_names
       return [] unless Puppet::FileSystem.directory?(@environment_dir)
+
       Puppet::FileSystem.children(@environment_dir).map do |child|
         Puppet::FileSystem.basename_string(child).intern if validated_directory(child)
       end.compact

data/lib/puppet/error.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
+
 module Puppet
   # The base class for all Puppet errors. It can wrap another exception
   class Error < RuntimeError
     attr_accessor :original
+
     def initialize(message, original=nil)
       super(message.scrub)
       @original = original
@@ -97,13 +99,13 @@ module Puppet
       filename, line = Puppet::Pops::PuppetStack.top_of_stack
 
       self.new(
-            issue.format(args),
-            filename,
-            line,
-            nil,
-            nil,
-            issue.issue_code,
-            args)
+        issue.format(args),
+        filename,
+        line,
+        nil,
+        nil,
+        issue.issue_code,
+        args)
     end
   end
 

data/lib/puppet/etc.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../puppet/util/character_encoding'
 # Wrapper around Ruby Etc module allowing us to manage encoding in a single
 # place.
@@ -40,7 +41,6 @@ require_relative '../puppet/util/character_encoding'
 # @api private
 module Puppet::Etc
   class << self
-
     # Etc::getgrent returns an Etc::Group struct object
     # On first call opens /etc/group and returns parse of first entry. Each subsquent call
     # returns new struct the next entry or nil if EOF. Call ::endgrent to close file.
@@ -70,7 +70,7 @@ module Puppet::Etc
       ::Etc.endpwent
     end
 
-    #effectively equivalent to IO#rewind of /etc/passwd
+    # effectively equivalent to IO#rewind of /etc/passwd
     def setpwent
       ::Etc.setpwent
     end
@@ -116,7 +116,7 @@ module Puppet::Etc
 
       setgrent
       begin
-        while cur_group = getgrent #rubocop:disable Lint/AssignmentInCondition
+        while cur_group = getgrent # rubocop:disable Lint/AssignmentInCondition
           yield cur_group
         end
       ensure
@@ -132,6 +132,7 @@ module Puppet::Etc
     # these fields as well. API compatible with Etc::Passwd. Because Struct.new
     # defines a new Class object, we memoize to avoid superfluous extra Class
     # instantiations.
+    # rubocop:disable Naming/MemoizedInstanceVariableName
     def puppet_etc_passwd_class
       @password_class ||= Struct.new(*Etc::Passwd.members, *Etc::Passwd.members.map { |member| "canonical_#{member}".to_sym })
     end
@@ -145,6 +146,7 @@ module Puppet::Etc
     def puppet_etc_group_class
       @group_class ||= Struct.new(*Etc::Group.members, *Etc::Group.members.map { |member| "canonical_#{member}".to_sym })
     end
+    # rubocop:enable Naming/MemoizedInstanceVariableName
 
     # Utility method for overriding the String values of a struct returned by
     # the Etc module to UTF-8. Structs returned by the ruby Etc module contain
@@ -160,6 +162,7 @@ module Puppet::Etc
     #   :canonical_<member name> struct member.
     def override_field_values_to_utf8(struct)
       return nil if struct.nil?
+
       new_struct = struct.is_a?(Etc::Passwd) ? puppet_etc_passwd_class.new : puppet_etc_group_class.new
       struct.each_pair do |member, value|
         if value.is_a?(String)

data/lib/puppet/external/dot.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # rdot.rb
 #
 #
@@ -8,7 +9,6 @@
 # It also supports undirected edges.
 
 module DOT
-
   # These global vars are used to make nice graph source.
 
   $tab  = '    '
@@ -116,7 +116,6 @@ module DOT
   # a root class for any element in dot notation
 
   class DOTSimpleElement
-
     attr_accessor :name
 
     def initialize(params = {})
@@ -131,7 +130,6 @@ module DOT
   # an element that has options ( node, edge, or graph )
 
   class DOTElement < DOTSimpleElement
-
     # attr_reader :parent
     attr_accessor :name, :options
 
@@ -153,20 +151,12 @@ module DOT
     def each_option_pair
       @options.each_pair{ |key, val| yield key, val }
     end
-
-    #def parent=( thing )
-    #    @parent.delete( self ) if defined?( @parent ) and @parent
-    #    @parent = thing
-    #end
-
   end
 
-
   # This is used when we build nodes that have shape=record
   # ports don't have options :)
 
   class DOTPort < DOTSimpleElement
-
     attr_accessor :label
 
     def initialize(params = {})
@@ -204,7 +194,6 @@ module DOT
     end
 
     def to_s(t = '')
-
       # This code is totally incomprehensible; it needs to be replaced!
 
       label = @options['shape'] != 'record' && @ports.length == 0 ?
@@ -218,13 +207,13 @@ module DOT
           }.join( "| \\\n" ) + " \\\n" +
           t + $tab + '"' + "\n"
 
-        t + "#{@name} [\n" +
-        @options.to_a.collect{ |i|
-          i[1] && i[0] != 'label' ?
-            t + $tab + "#{i[0]} = #{i[1]}" : nil
-        }.compact.join( ",\n" ) + ( label != '' ? ",\n" : "\n" ) +
-        label +
-        t + "]\n"
+      t + "#{@name} [\n" +
+      @options.to_a.collect{ |i|
+        i[1] && i[0] != 'label' ?
+          t + $tab + "#{i[0]} = #{i[1]}" : nil
+      }.compact.join( ",\n" ) + ( label != '' ? ",\n" : "\n" ) +
+      label +
+      t + "]\n"
     end
 
     private
@@ -232,7 +221,6 @@ module DOT
     def stringify(s)
       %("#{s.gsub('"', '\\"')}")
     end
-
   end
 
   # A subgraph element is the same to graph, but has another header in dot
@@ -275,24 +263,20 @@ module DOT
       }.join( "\n" ) + "\n"
       hdr + options + nodes + t + "}\n"
     end
-
   end
 
   # This is a graph.
 
   class DOTDigraph < DOTSubgraph
-
-  def initialize(params = {}, option_list = GRAPH_OPTS)
-    super(params, option_list)
-    @dot_string = 'digraph'
-  end
-
+    def initialize(params = {}, option_list = GRAPH_OPTS)
+      super(params, option_list)
+      @dot_string = 'digraph'
+    end
   end
 
   # This is an edge.
 
   class DOTEdge < DOTElement
-
     attr_accessor :from, :to
 
     def initialize(params = {}, option_list = EDGE_OPTS)
@@ -313,14 +297,11 @@ module DOT
             i[1] ? t + $tab + "#{i[0]} = \"#{i[1]}\"" : nil
         }.compact.join( "\n" ) + "\n#{t}]\n"
     end
-
   end
 
   class DOTDirectedEdge < DOTEdge
-
     def edge_link
       '->'
     end
-
   end
 end

data/lib/puppet/face/catalog/select.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Select and show a list of resources of a given type.
 Puppet::Face.define(:catalog, '0.0.1') do
   action :select do
@@ -25,7 +26,7 @@ Puppet::Face.define(:catalog, '0.0.1') do
 
       $ puppet catalog select --terminus rest somenode.magpie.lan file
     EOT
-    when_invoked do |host, type, options|
+    when_invoked do |host, type, _options|
       # REVISIT: Eventually, type should have a default value that triggers
       # the non-specific behaviour.  For now, though, this will do.
       # --daniel 2011-05-03

data/lib/puppet/face/catalog.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/indirector/face'
 
 Puppet::Indirector::Face.define(:catalog, '0.0.1') do
@@ -61,7 +62,7 @@ Puppet::Indirector::Face.define(:catalog, '0.0.1') do
           # ...
     EOT
 
-    when_invoked do |options|
+    when_invoked do |_options|
       catalog = Puppet::Face[:catalog, "0.0.1"].find(Puppet[:certname]) or raise "Could not find catalog for #{Puppet[:certname]}"
       catalog = catalog.to_ral
 
@@ -131,7 +132,7 @@ Puppet::Indirector::Face.define(:catalog, '0.0.1') do
           Puppet::Face[:catalog, '0.0.1'].download
           # ...
     EOT
-    when_invoked do |options|
+    when_invoked do |_options|
       Puppet::Resource::Catalog.indirection.terminus_class = :rest
       Puppet::Resource::Catalog.indirection.cache_class = nil
       catalog = nil

data/lib/puppet/face/config.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/face'
 require_relative '../../puppet/settings/ini_file'
 
@@ -16,7 +17,7 @@ Puppet::Face.define(:config, '0.0.1') do
   DEFAULT_SECTION_MARKER = Object.new
   DEFAULT_SECTION = "main"
   option "--section " + _("SECTION_NAME") do
-    default_to { DEFAULT_SECTION_MARKER } #Sentinel object for default detection during commands
+    default_to { DEFAULT_SECTION_MARKER } # Sentinel object for default detection during commands
     summary _("The section of the configuration file to interact with.")
     description <<-EOT
       The section of the puppet.conf configuration file to interact with.
@@ -99,9 +100,9 @@ Puppet::Face.define(:config, '0.0.1') do
     messages = []
     messages << _("No section specified; defaulting to '%{section_name}'.") %
       { section_name: section_name }
-    #TRANSLATORS '--section' is a command line option and should not be translated
+    # TRANSLATORS '--section' is a command line option and should not be translated
     messages << _("Set the config section by using the `--section` flag.")
-    #TRANSLATORS `puppet config --section user print foo` is a command line example and should not be translated
+    # TRANSLATORS `puppet config --section user print foo` is a command line example and should not be translated
     messages << _("For example, `puppet config --section user print foo`.")
     messages << _("For more information, see https://puppet.com/docs/puppet/latest/configuration.html")
 
@@ -109,9 +110,9 @@ Puppet::Face.define(:config, '0.0.1') do
   end
 
   def report_section_and_environment(section_name, environment_name)
-      $stderr.puts colorize(:hyellow,
-        _("Resolving settings from section '%{section_name}' in environment '%{environment_name}'") %
-          { section_name: section_name, environment_name: environment_name })
+    $stderr.puts colorize(:hyellow,
+                          _("Resolving settings from section '%{section_name}' in environment '%{environment_name}'") %
+                            { section_name: section_name, environment_name: environment_name })
   end
 
   action(:set) do
@@ -136,7 +137,6 @@ Puppet::Face.define(:config, '0.0.1') do
     EOT
 
     when_invoked do |name, value, options|
-
       @default_section = false
       if options[:section] == DEFAULT_SECTION_MARKER
         options[:section] = DEFAULT_SECTION
@@ -144,15 +144,15 @@ Puppet::Face.define(:config, '0.0.1') do
       end
 
       if name == 'environment' && options[:section] == 'main'
-        Puppet.warning _(<<-EOM).chomp
-The environment should be set in either the `[user]`, `[agent]`, or `[server]`
-section. Variables set in the `[agent]` section are used when running
-`puppet agent`. Variables set in the `[user]` section are used when running
-various other puppet subcommands, like `puppet apply` and `puppet module`; these
-require the defined environment directory to exist locally. Set the config
-section by using the `--section` flag. For example,
-`puppet config --section user set environment foo`. For more information, see
-https://puppet.com/docs/puppet/latest/configuration.html#environment
+        Puppet.warning _(<<~EOM).chomp
+          The environment should be set in either the `[user]`, `[agent]`, or `[server]`
+          section. Variables set in the `[agent]` section are used when running
+          `puppet agent`. Variables set in the `[user]` section are used when running
+          various other puppet subcommands, like `puppet apply` and `puppet module`; these
+          require the defined environment directory to exist locally. Set the config
+          section by using the `--section` flag. For example,
+          `puppet config --section user set environment foo`. For more information, see
+          https://puppet.com/docs/puppet/latest/configuration.html#environment
         EOM
       end
 
@@ -201,7 +201,7 @@ https://puppet.com/docs/puppet/latest/configuration.html#environment
   action(:delete) do
     summary _("Delete a Puppet setting.")
     arguments _("<setting>")
-    #TRANSLATORS 'main' is a specific section name and should not be translated
+    # TRANSLATORS 'main' is a specific section name and should not be translated
     description "Deletes a setting from the specified section. (The default is the section 'main')."
     notes <<-'EOT'
       By default, this action deletes the configuration setting from the 'main'
@@ -219,7 +219,6 @@ https://puppet.com/docs/puppet/latest/configuration.html#environment
     EOT
 
     when_invoked do |name, options|
-
       @default_section = false
       if options[:section] == DEFAULT_SECTION_MARKER
         options[:section] = DEFAULT_SECTION
@@ -230,7 +229,6 @@ https://puppet.com/docs/puppet/latest/configuration.html#environment
       if Puppet::FileSystem.exist?(path)
         Puppet::FileSystem.open(path, nil, 'r+:UTF-8') do |file|
           Puppet::Settings::IniFile.update(file) do |config|
-
             # delete from both master section and server section
             if options[:section] == "master" || options[:section] == "server"
               master_setting_string = config.delete("master", name)
@@ -259,7 +257,7 @@ https://puppet.com/docs/puppet/latest/configuration.html#environment
           end
         end
       else
-        #TRANSLATORS the 'puppet.conf' is a specific file and should not be translated
+        # TRANSLATORS the 'puppet.conf' is a specific file and should not be translated
         Puppet.warning(_("The puppet.conf file does not exist %{puppet_conf}") % { puppet_conf: path })
       end
       nil