puppet 8.3.1 → 8.4.0

data/lib/puppet/util/command_line.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Bundler and rubygems maintain a set of directories from which to
 # load gems. If Bundler is loaded, let it determine what can be
 # loaded. If it's not loaded, then use rubygems. But do this before

data/lib/puppet/util/constant_inflector.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Created on 2008-02-12
 # Copyright Luke Kanies
 
@@ -7,17 +8,16 @@
 # A common module for converting between constants and
 # file names.
 
-
 module Puppet
   module Util
     module ConstantInflector
       def file2constant(file)
-        file.split("/").collect { |name| name.capitalize }.join("::").gsub(/_+(.)/) { |term| $1.capitalize }
+        file.split("/").collect { |name| name.capitalize }.join("::").gsub(/_+(.)/) { |_term| $1.capitalize }
       end
       module_function :file2constant
 
       def constant2file(constant)
-        constant.to_s.gsub(/([a-z])([A-Z])/) { |term| $1 + "_#{$2}" }.gsub("::", "/").downcase
+        constant.to_s.gsub(/([a-z])([A-Z])/) { |_term| $1 + "_#{$2}" }.gsub("::", "/").downcase
       end
       module_function :constant2file
     end

data/lib/puppet/util/diff.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'tempfile'
 
 # Provide a diff between two strings.
@@ -44,22 +45,21 @@ module Puppet::Util::Diff
 
     diffs.each do |piece|
       begin
-
         hunk = ::Diff::LCS::Hunk.new(
           data_old, data_new, piece,
-            context_lines,
-
-            file_length_difference)
+          context_lines,
+          file_length_difference)
         file_length_difference = hunk.file_length_difference
-      next unless oldhunk
-      # Hunks may overlap, which is why we need to be careful when our
-      # diff includes lines of context. Otherwise, we might print
-      # redundant lines.
-      if (context_lines > 0) and hunk.overlaps?(oldhunk)
-        hunk.unshift(oldhunk)
-      else
-        output << oldhunk.diff(format)
-      end
+        next unless oldhunk
+
+        # Hunks may overlap, which is why we need to be careful when our
+        # diff includes lines of context. Otherwise, we might print
+        # redundant lines.
+        if (context_lines > 0) and hunk.overlaps?(oldhunk)
+          hunk.unshift(oldhunk)
+        else
+          output << oldhunk.diff(format)
+        end
       ensure
         oldhunk = hunk
         output << "\n"

data/lib/puppet/util/docs.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Some simple methods for helping manage automatic documentation generation.
 module Puppet::Util::Docs
   # Specify the actual doc string.
@@ -66,6 +67,7 @@ module Puppet::Util::Docs
 
   # There is nothing that would ever set this. It gets read in reference/type.rb, but will never have any value but nil.
   attr_reader :nodoc
+
   def nodoc?
     nodoc
   end
@@ -115,6 +117,7 @@ module Puppet::Util::Docs
   def scrub(text)
     # One-liners are easy! (One-liners may be buffered with extra newlines.)
     return text.strip if text.strip !~ /\n/
+
     excluding_first_line = text.partition("\n").last
     indent = excluding_first_line.scan(/^[ \t]*(?=\S)/).min || '' # prevent nil
     # Clean hanging indent, if any

data/lib/puppet/util/errors.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Some helper methods for throwing and populating errors.
 #
 # @api public

data/lib/puppet/util/execution.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'timeout'
 require_relative '../../puppet/file_system/uniquefile'
 
@@ -16,7 +17,6 @@ end
 # in classes that needs to execute system commands.
 # @api public
 module Puppet::Util::Execution
-
   # This is the full output from a process. The object itself (a String) is the
   # stdout of the process.
   #
@@ -78,7 +78,8 @@ module Puppet::Util::Execution
     # a predictable output
     english_env = ENV.to_hash.merge( {'LANG' => 'C', 'LC_ALL' => 'C'} )
     output = Puppet::Util.withenv(english_env) do
-      open("| #{command_str} 2>&1") do |pipe|
+      # We are intentionally using 'pipe' with open to launch a process
+      open("| #{command_str} 2>&1") do |pipe| # rubocop:disable Security/Open
         yield pipe
       end
     end
@@ -138,16 +139,16 @@ module Puppet::Util::Execution
     # specifying these here rather than in the method signature to allow callers to pass in a partial
     # set of overrides without affecting the default values for options that they don't pass in
     default_options = {
-        :failonfail => NoOptionsSpecified.equal?(options),
-        :uid => nil,
-        :gid => nil,
-        :combine => NoOptionsSpecified.equal?(options),
-        :stdinfile => nil,
-        :squelch => false,
-        :override_locale => true,
-        :custom_environment => {},
-        :sensitive => false,
-        :suppress_window => false,
+      :failonfail => NoOptionsSpecified.equal?(options),
+      :uid => nil,
+      :gid => nil,
+      :combine => NoOptionsSpecified.equal?(options),
+      :stdinfile => nil,
+      :squelch => false,
+      :override_locale => true,
+      :custom_environment => {},
+      :sensitive => false,
+      :suppress_window => false,
     }
 
     options = default_options.merge(options)
@@ -228,7 +229,7 @@ module Puppet::Util::Execution
             # below will use maximum CPU available.
 
             wait_flags = Process::WNOHANG
-            until results = Process.waitpid2(child_pid, wait_flags) #rubocop:disable Lint/AssignmentInCondition
+            until results = Process.waitpid2(child_pid, wait_flags) # rubocop:disable Lint/AssignmentInCondition
 
               # If not done, wait for data to read with a timeout
               # This timeout is selected to keep activity low while waiting on
@@ -311,8 +312,8 @@ module Puppet::Util::Execution
   #
   def self.ruby_path()
     File.join(RbConfig::CONFIG['bindir'],
-              RbConfig::CONFIG['ruby_install_name'] + RbConfig::CONFIG['EXEEXT']).
-      sub(/.*\s.*/m, '"\&"')
+              RbConfig::CONFIG['ruby_install_name'] + RbConfig::CONFIG['EXEEXT'])
+      .sub(/.*\s.*/m, '"\&"')
   end
 
   # Because some modules provide their own version of this method.
@@ -320,7 +321,6 @@ module Puppet::Util::Execution
     alias util_execute execute
   end
 
-
   # This is private method.
   # @comment see call to private_class_method after method definition
   # @api private
@@ -374,7 +374,6 @@ module Puppet::Util::Execution
   end
   private_class_method :execute_posix
 
-
   # This is private method.
   # @comment see call to private_class_method after method definition
   # @api private
@@ -391,7 +390,6 @@ module Puppet::Util::Execution
   end
   private_class_method :execute_windows
 
-
   # This is private method.
   # @comment see call to private_class_method after method definition
   # @api private

data/lib/puppet/util/execution_stub.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet::Util
   class ExecutionStub
     class << self

data/lib/puppet/util/feature.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet'
 require_relative '../../puppet/util/warnings'
 

data/lib/puppet/util/file_watcher.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Puppet::Util::FileWatcher
   include Enumerable
 
@@ -16,6 +17,7 @@ class Puppet::Util::FileWatcher
 
   def watch(filename)
     return if watching?(filename)
+
     @files[filename] = Puppet::Util::WatchedFile.new(filename)
   end
 

data/lib/puppet/util/fileparsing.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # A mini-language for parsing files.  This is only used file the ParsedFile
 # provider, but it makes more sense to split it out so it's easy to maintain
 # in one place.
@@ -42,6 +43,7 @@ module Puppet::Util::FileParsing
       @fields = fields.collect do |field|
         r = field.intern
         raise ArgumentError.new(_("Cannot have fields named %{name}") % { name: r }) if INVALID_FIELDS.include?(r)
+
         r
       end
     end

data/lib/puppet/util/filetype.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Basic classes for reading, writing, and emptying files.  Not much
 # to see here.
 
@@ -15,6 +16,7 @@ class Puppet::Util::FileType
 
   class << self
     attr_accessor :name
+
     include Puppet::Util::ClassGen
   end
 
@@ -81,6 +83,7 @@ class Puppet::Util::FileType
 
   def initialize(path, default_mode = nil)
     raise ArgumentError.new(_("Path is nil")) if path.nil?
+
     @path = path
     @default_mode = default_mode
   end

data/lib/puppet/util/http_proxy.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/http'
 
 # for backwards compatibility

data/lib/puppet/util/inifile.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Module Puppet::IniConfig
 # A generic way to parse .ini style files and manipulate them in memory
 # One 'file' can be made up of several physical files. Changes to sections
@@ -95,17 +96,16 @@ module Puppet::Util::IniConfig
     end
 
     private
+
     def find_entry(key)
       @entries.each do |entry|
         return entry if entry.is_a?(Array) && entry[0] == key
       end
       nil
     end
-
   end
 
   class PhysicalFile
-
     # @!attribute [r] filetype
     #   @api private
     #   @return [Puppet::Util::FileType::FileTypeFlat]
@@ -139,6 +139,7 @@ module Puppet::Util::IniConfig
       if text.nil?
         raise IniParseError, _("Cannot read nonexistent file %{file}") % { file: @file.inspect }
       end
+
       parse(text)
     end
 
@@ -261,7 +262,6 @@ module Puppet::Util::IniConfig
   end
 
   class FileCollection
-
     attr_reader :files
 
     def initialize

data/lib/puppet/util/instance_loader.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/util/autoload'
 require_relative '../../puppet/util'
 require_relative '../../puppet/concurrent/lock'
@@ -51,6 +52,7 @@ module Puppet::Util::InstanceLoader
       name = name.intern
       instances = instance_hash(type)
       return nil unless instances
+
       unless instances.include? name
         if instance_loader(type).load(name, Puppet.lookup(:current_environment))
           unless instances.include? name

data/lib/puppet/util/json.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet::Util
   module Json
     class ParseError < StandardError

data/lib/puppet/util/json_lockfile.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/util/lockfile'
 
 # This class provides a simple API for managing a lock file
@@ -34,12 +35,13 @@ class Puppet::Util::JsonLockfile < Puppet::Util::Lockfile
   #  they will be converted to Strings.
   def lock_data
     return nil unless file_locked?
+
     file_contents = super
     return nil if file_contents.nil? or file_contents.empty?
+
     Puppet::Util::Json.load(file_contents)
   rescue Puppet::Util::Json::ParseError
     Puppet.warning _("Unable to read lockfile data from %{path}: not in JSON") % { path: @file_path }
     nil
   end
-
 end

data/lib/puppet/util/ldap/connection.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../puppet/util/ldap'
 
 class Puppet::Util::Ldap::Connection
@@ -9,12 +10,12 @@ class Puppet::Util::Ldap::Connection
   # Return a default connection, using our default settings.
   def self.instance
     ssl = if Puppet[:ldaptls]
-      :tls
-        elsif Puppet[:ldapssl]
-          true
-        else
-          false
-        end
+            :tls
+          elsif Puppet[:ldapssl]
+            true
+          else
+            false
+          end
 
     options = {}
     options[:ssl] = ssl
@@ -57,18 +58,18 @@ class Puppet::Util::Ldap::Connection
 
   # Start our ldap connection.
   def start
-      case ssl
-      when :tls
-        @connection = LDAP::SSLConn.new(host, port, true)
-      when true
-        @connection = LDAP::SSLConn.new(host, port)
-      else
-        @connection = LDAP::Conn.new(host, port)
-      end
-      @connection.set_option(LDAP::LDAP_OPT_PROTOCOL_VERSION, 3)
-      @connection.set_option(LDAP::LDAP_OPT_REFERRALS, LDAP::LDAP_OPT_ON)
-      @connection.simple_bind(user, password)
+    case ssl
+    when :tls
+      @connection = LDAP::SSLConn.new(host, port, true)
+    when true
+      @connection = LDAP::SSLConn.new(host, port)
+    else
+      @connection = LDAP::Conn.new(host, port)
+    end
+    @connection.set_option(LDAP::LDAP_OPT_PROTOCOL_VERSION, 3)
+    @connection.set_option(LDAP::LDAP_OPT_REFERRALS, LDAP::LDAP_OPT_ON)
+    @connection.simple_bind(user, password)
   rescue => detail
-      raise Puppet::Error, _("Could not connect to LDAP: %{detail}") % { detail: detail }, detail.backtrace
+    raise Puppet::Error, _("Could not connect to LDAP: %{detail}") % { detail: detail }, detail.backtrace
   end
 end

data/lib/puppet/util/ldap/generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../puppet/util/ldap'
 
 class Puppet::Util::Ldap::Generator

data/lib/puppet/util/ldap/manager.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../puppet/util/ldap'
 require_relative '../../../puppet/util/ldap/connection'
 require_relative '../../../puppet/util/ldap/generator'
@@ -45,7 +46,7 @@ class Puppet::Util::Ldap::Manager
   # Open, yield, and close the connection.  Cannot be left
   # open, at this point.
   def connect
-    #TRANSLATORS '#connect' is a method name and and should not be translated, 'block' refers to a Ruby code block
+    # TRANSLATORS '#connect' is a method name and and should not be translated, 'block' refers to a Ruby code block
     raise ArgumentError, _("You must pass a block to #connect") unless block_given?
 
     unless @connection
@@ -89,7 +90,7 @@ class Puppet::Util::Ldap::Manager
 
   # Convert an ldap-style entry hash to a provider-style hash.
   def entry2provider(entry)
-    #TRANSLATOR 'dn' refers to a 'distinguished name' in LDAP (Lightweight Directory Access Protocol) and they should not be translated
+    # TRANSLATOR 'dn' refers to a 'distinguished name' in LDAP (Lightweight Directory Access Protocol) and they should not be translated
     raise ArgumentError, _("Could not get dn from ldap entry") unless entry["dn"]
 
     # DN is always a single-entry array.  Strip off the bits before the

data/lib/puppet/util/ldap.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
+
 module Puppet::Util::Ldap
 end

data/lib/puppet/util/libuser.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet::Util::Libuser
    def self.getconf
      File.expand_path("../libuser.conf", __FILE__)
@@ -9,5 +10,4 @@ module Puppet::Util::Libuser
      newenv['LIBUSER_CONF'] = getconf
      newenv
    end
-
 end

data/lib/puppet/util/limits.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/util'
 
 module Puppet::Util::Limits

data/lib/puppet/util/lockfile.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # This class provides a simple API for managing a lock file
 # whose contents are an (optional) String.  In addition
 # to querying the basic state (#locked?) of the lock, managing

data/lib/puppet/util/log/destination.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # A type of log destination.
 class Puppet::Util::Log::Destination
   class << self

data/lib/puppet/util/log/destinations.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 Puppet::Util::Log.newdesttype :syslog do
   def self.suitable?(obj)
     Puppet.features.syslog?
@@ -36,7 +37,7 @@ Puppet::Util::Log.newdesttype :syslog do
     else
       msg.to_s.split("\n").each do |line|
         @syslog.send(msg.level, "(%s) %s" % [msg.source.to_s.delete("%"),
-            line.gsub("%", '%%')
+                                             line.gsub("%", '%%')
           ]
         )
       end
@@ -147,15 +148,15 @@ Puppet::Util::Log.newdesttype :console do
 
   def handle(msg)
     levels = {
-      :emerg   => { :name => 'Emergency', :color => :hred,     :stream => $stderr },
-      :alert   => { :name => 'Alert',     :color => :hred,     :stream => $stderr },
-      :crit    => { :name => 'Critical',  :color => :hred,     :stream => $stderr },
-      :err     => { :name => 'Error',     :color => :hred,     :stream => $stderr },
-      :warning => { :name => 'Warning',   :color => :hyellow,  :stream => $stderr },
-
-      :notice  => { :name => 'Notice',    :color => :reset,    :stream => $stdout },
-      :info    => { :name => 'Info',      :color => :green,    :stream => $stdout },
-      :debug   => { :name => 'Debug',     :color => :cyan,     :stream => $stdout },
+      :emerg => { :name => 'Emergency', :color => :hred,     :stream => $stderr },
+      :alert => { :name => 'Alert',     :color => :hred,     :stream => $stderr },
+      :crit => { :name => 'Critical', :color => :hred, :stream => $stderr },
+      :err => { :name => 'Error', :color => :hred, :stream => $stderr },
+      :warning => { :name => 'Warning', :color => :hyellow, :stream => $stderr },
+
+      :notice => { :name => 'Notice', :color => :reset, :stream => $stdout },
+      :info => { :name => 'Info', :color => :green, :stream => $stdout },
+      :debug => { :name => 'Debug', :color => :cyan, :stream => $stdout },
     }
 
     str = msg.respond_to?(:multiline) ? msg.multiline : msg.to_s
@@ -239,9 +240,9 @@ Puppet::Util::Log.newdesttype :eventlog do
     end
 
     @eventlog.report_event(
-      :event_type  => native_type,
-      :event_id    => native_id,
-      :data        => (msg.source && msg.source != 'Puppet' ? "#{msg.source}: " : '') + msg.to_s
+      :event_type => native_type,
+      :event_id => native_id,
+      :data => (msg.source && msg.source != 'Puppet' ? "#{msg.source}: " : '') + msg.to_s
     )
   end