puppet 8.3.1 → 8.5.0

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"
 
@@ -48,7 +49,7 @@ module Puppet
   def self.default_basemodulepath
     if Puppet::Util::Platform.windows?
       path = ['$codedir/modules']
-      installdir = ENV["FACTER_env_windows_installdir"]
+      installdir = ENV.fetch("FACTER_env_windows_installdir", nil)
       if installdir
         path << "#{installdir}/puppet/modules"
       end
@@ -60,7 +61,7 @@ module Puppet
 
   def self.default_vendormoduledir
     if Puppet::Util::Platform.windows?
-      installdir = ENV["FACTER_env_windows_installdir"]
+      installdir = ENV.fetch("FACTER_env_windows_installdir", nil)
       if installdir
         "#{installdir}\\puppet\\vendor_modules"
       else
@@ -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,7 +372,8 @@ 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
+
+            ENV['PATH'] = ENV.fetch('PATH', nil) + File::PATH_SEPARATOR + path
           end
           value
         end
@@ -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,10 +464,10 @@ 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 },
+        :default  => -> { default_diffargs },
         :desc     => "Which arguments to pass to the diff command when printing differences between
           files. The command to use can be chosen with the `diff` setting.",
     },
@@ -487,16 +489,16 @@ module Puppet
     },
     :daemonize => {
         :type     => :boolean,
-        :default  => (Puppet::Util::Platform.windows? ? false : true),
+        :default  => (!Puppet::Util::Platform.windows?),
         :desc     => "Whether to send the process into the background.  This defaults
           to true on POSIX systems, and to false on Windows (where 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,11 +815,10 @@ 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 => {
-      :default => lambda { Puppet::Settings.default_certname.downcase },
+      :default => -> { Puppet::Settings.default_certname.downcase },
       :desc => "The name to use when handling certificates. When a node
         requests a certificate from the CA Puppet Server, it uses the value of the
         `certname` setting as its requested Subject CN.
@@ -1085,7 +1086,7 @@ EOT
                    Default is `prime256v1`."
     },
     :digest_algorithm => {
-        :default  => lambda { default_digest_algorithm },
+        :default  => -> { default_digest_algorithm },
         :type     => :enum,
         :values   => valid_digest_algorithms,
         :desc     => "Which digest algorithm to use for file resources and the filebucket.
@@ -1093,7 +1094,7 @@ EOT
                       #{default_digest_algorithm}.",
     },
     :supported_checksum_types => {
-      :default => lambda { default_file_checksum_types },
+      :default => -> { default_file_checksum_types },
       :type    => :array,
       :desc    => "Checksum types supported by this agent for use in file resources of a
                    static catalog. Values must be comma-separated. Valid types are
@@ -1128,7 +1129,7 @@ EOT
       :desc    => "The name to use the Certificate Authority certificate.",
     },
     :cadir => {
-      :default => lambda { default_cadir },
+      :default => -> { default_cadir },
       :type => :directory,
       :desc => "The root directory for the certificate authority.",
     },
@@ -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 => {
@@ -1418,7 +1419,7 @@ EOT
       :desc       => "File that provides mapping between custom SSL oids and user-friendly names"
     },
     :basemodulepath => {
-      :default => lambda { default_basemodulepath },
+      :default => -> { default_basemodulepath },
       :type => :path,
       :desc => "The search path for **global** modules. Should be specified as a
         list of directories separated by the system path separator character. (The
@@ -1430,7 +1431,7 @@ EOT
         <https://puppet.com/docs/puppet/latest/environments_about.html>",
     },
     :vendormoduledir => {
-      :default => lambda { default_vendormoduledir },
+      :default => -> { default_vendormoduledir },
       :type => :string,
       :desc => "The directory containing **vendored** modules. These modules will
       be used by _all_ environments like those in the `basemodulepath`. The only
@@ -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,
@@ -1665,7 +1666,7 @@ EOT
       :desc       => "Whether the server will search for SRV records in DNS for the current domain.",
     },
     :srv_domain => {
-      :default    => lambda { Puppet::Settings.domain_fact },
+      :default    => -> { Puppet::Settings.domain_fact },
       :desc       => "The domain which will be queried to find the SRV records of servers to use.",
     },
     :http_extra_headers => {
@@ -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,9 +268,10 @@ module Puppet::Environments
 
     def valid_environment_names
       return [] unless Puppet::FileSystem.directory?(@environment_dir)
-      Puppet::FileSystem.children(@environment_dir).map do |child|
+
+      Puppet::FileSystem.children(@environment_dir).filter_map do |child|
         Puppet::FileSystem.basename_string(child).intern if validated_directory(child)
-      end.compact
+      end
     end
   end
 
@@ -316,7 +317,7 @@ module Puppet::Environments
     end
 
     def clear_all
-      @loaders.each {|loader| loader.clear_all}
+      @loaders.each { |loader| loader.clear_all }
     end
   end
 
@@ -371,7 +372,7 @@ module Puppet::Environments
       removed_envs = cached_envs - loader_envs
 
       removed_envs.each do |env_name|
-        Puppet.debug { "Environment no longer exists '#{env_name}'"}
+        Puppet.debug { "Environment no longer exists '#{env_name}'" }
         clear(env_name)
       end
 
@@ -408,7 +409,7 @@ module Puppet::Environments
       name = name.to_sym
       entry = @cache[name]
       if entry
-        Puppet.debug {"Found in cache #{name.inspect} #{entry.label}"}
+        Puppet.debug { "Found in cache #{name.inspect} #{entry.label}" }
         # found in cache
         entry.touch
       elsif (env = @loader.get(name))
@@ -422,7 +423,7 @@ module Puppet::Environments
 
     # Adds a cache entry to the cache
     def add_entry(name, cache_entry)
-      Puppet.debug {"Caching environment #{name.inspect} #{cache_entry.label}"}
+      Puppet.debug { "Caching environment #{name.inspect} #{cache_entry.label}" }
       @cache[name] = cache_entry
       @cache_expiration_service.created(cache_entry.value)
     end
@@ -430,7 +431,7 @@ module Puppet::Environments
 
     def clear_entry(name, entry)
       @cache.delete(name)
-      Puppet.debug {"Evicting cache entry for environment #{name.inspect}"}
+      Puppet.debug { "Evicting cache entry for environment #{name.inspect}" }
       @cache_expiration_service.evicted(name.to_sym)
       Puppet::GettextConfig.delete_text_domain(name)
       Puppet.settings.clear_environment_settings(name)

data/lib/puppet/error.rb

@@ -1,9 +1,11 @@
 # 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)
+
+    def initialize(message, original = nil)
       super(message.scrub)
       @original = original
     end
@@ -18,8 +20,8 @@ module Puppet
     # May be called with 3 arguments for message, file, line, and exception, or
     # 4 args including the position on the line.
     #
-    def initialize(message, file=nil, line=nil, pos=nil, original=nil)
-      if pos.kind_of? Exception
+    def initialize(message, file = nil, line = nil, pos = nil, original = nil)
+      if pos.is_a? Exception
         original = pos
         pos = nil
       end
@@ -66,7 +68,7 @@ module Puppet
     # @param issue_code [Symbol] The issue code
     # @param arguments [Hash{Symbol=>Object}] Issue arguments
     #
-    def initialize(message, file=nil, line=nil, pos=nil, original=nil, issue_code= nil, arguments = nil)
+    def initialize(message, file = nil, line = nil, pos = nil, original = nil, issue_code = nil, arguments = nil)
       super(message, file, line, pos, original)
       @issue_code = issue_code
       @basic_message = message
@@ -97,13 +99,14 @@ 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
 
@@ -131,7 +134,7 @@ module Puppet
     include ExternalFileError
     attr_reader :error_data
 
-    def initialize(error_data, message, file: nil, line: nil, pos: nil, original:nil)
+    def initialize(error_data, message, file: nil, line: nil, pos: nil, original: nil)
       super(message, file, line, pos, original)
       @error_data = error_data
     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,12 +162,14 @@ 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)
+        case value
+        when String
           new_struct["canonical_#{member}".to_sym] = value.dup
           new_struct[member] = Puppet::Util::CharacterEncoding.override_encoding_to_utf_8(value).scrub
-        elsif value.is_a?(Array)
+        when Array
           new_struct["canonical_#{member}".to_sym] = value.inject([]) { |acc, elem| acc << elem.dup }
           new_struct[member] = value.inject([]) do |acc, elem|
             acc << Puppet::Util::CharacterEncoding.override_encoding_to_utf_8(elem).scrub

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  = '    '
@@ -46,7 +46,7 @@ module DOT
     'shape',       # default: ellipse; node shape; see Section 2.1 and Appendix E
     'shapefile',   # external EPSF or SVG custom shape file
     'sides',       # default: 4; number of sides for shape=polygon
-    'skew' ,       # default: 0.0; skewing of node for shape=polygon
+    'skew',        # default: 0.0; skewing of node for shape=polygon
     'style',       # graphics options, e.g. bold, dotted, filled; cf. Section 2.3
     'toplabel',    # auxiliary label for nodes of shape M*
     'URL',         # URL associated with node (format-dependent)
@@ -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
 
@@ -140,33 +138,25 @@ module DOT
       @name   = params['name']   ? params['name']   : nil
       @parent = params['parent'] ? params['parent'] : nil
       @options = {}
-      option_list.each{ |i|
+      option_list.each { |i|
         @options[i] = params[i] if params[i]
       }
       @options['label'] ||= @name if @name != 'node'
     end
 
     def each_option
-      @options.each{ |i| yield i }
+      @options.each { |i| yield i }
     end
 
     def each_option_pair
-      @options.each_pair{ |key, val| yield key, val }
+      @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 = {})
@@ -175,7 +165,7 @@ module DOT
     end
 
     def to_s
-      ( @name && @name != "" ? "<#{@name}>" : "" ) + "#{@label}"
+      (@name && @name != "" ? "<#{@name}>" : "") + "#{@label}"
     end
   end
 
@@ -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 ?
@@ -212,17 +201,17 @@ module DOT
             t + $tab + "label = #{stringify(@options['label'])}\n" :
             '' :
           t + $tab + 'label = "' + " \\\n" +
-          t + $tab2 + "#{stringify(@options['label'])}| \\\n" +
-          @ports.collect{ |i|
-            t + $tab2 + i.to_s
-          }.join( "| \\\n" ) + " \\\n" +
-          t + $tab + '"' + "\n"
-
-        t + "#{@name} [\n" +
-        @options.to_a.collect{ |i|
+            t + $tab2 + "#{stringify(@options['label'])}| \\\n" +
+            @ports.collect { |i|
+              t + $tab2 + i.to_s
+            }.join("| \\\n") + " \\\n" +
+            t + $tab + '"' + "\n"
+
+      t + "#{@name} [\n" +
+        @options.to_a.filter_map { |i|
           i[1] && i[0] != 'label' ?
             t + $tab + "#{i[0]} = #{i[1]}" : nil
-        }.compact.join( ",\n" ) + ( label != '' ? ",\n" : "\n" ) +
+        }.join(",\n") + (label != '' ? ",\n" : "\n") +
         label +
         t + "]\n"
     end
@@ -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
@@ -246,7 +234,7 @@ module DOT
     end
 
     def each_node
-      @nodes.each{ |i| yield i }
+      @nodes.each { |i| yield i }
     end
 
     def <<(thing)
@@ -254,7 +242,7 @@ module DOT
     end
 
     def push(thing)
-      @nodes.push( thing )
+      @nodes.push(thing)
     end
 
     def pop
@@ -264,35 +252,31 @@ module DOT
     def to_s(t = '')
       hdr = t + "#{@dot_string} #{@name} {\n"
 
-      options = @options.to_a.collect{ |name, val|
+      options = @options.to_a.filter_map { |name, val|
         val && name != 'label' ?
           t + $tab + "#{name} = #{val}" :
           name ? t + $tab + "#{name} = \"#{val}\"" : nil
-      }.compact.join( "\n" ) + "\n"
+      }.join("\n") + "\n"
 
-      nodes = @nodes.collect{ |i|
-        i.to_s( t + $tab )
-      }.join( "\n" ) + "\n"
+      nodes = @nodes.collect { |i|
+        i.to_s(t + $tab)
+      }.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)
@@ -307,20 +291,17 @@ module DOT
 
     def to_s(t = '')
       t + "#{@from} #{edge_link} #{to} [\n" +
-        @options.to_a.collect{ |i|
+        @options.to_a.filter_map { |i|
           i[1] && i[0] != 'label' ?
             t + $tab + "#{i[0]} = #{i[1]}" :
             i[1] ? t + $tab + "#{i[0]} = \"#{i[1]}\"" : nil
-        }.compact.join( "\n" ) + "\n#{t}]\n"
+        }.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
@@ -43,7 +44,7 @@ Puppet::Face.define(:catalog, '0.0.1') do
       if value.nil? then
         _("no matching resources found")
       else
-        value.map {|x| x.to_s }.join("\n")
+        value.map { |x| x.to_s }.join("\n")
       end
     end
   end