puppet 8.3.1 → 8.4.0

data/lib/puppet/util/log.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/util/tagging'
 require_relative '../../puppet/util/classgen'
 require_relative '../../puppet/util/psych_support'
@@ -21,13 +22,12 @@ class Puppet::Util::Log
 
   # Create a new destination type.
   def self.newdesttype(name, options = {}, &block)
-
     dest = genclass(
       name,
-      :parent     => Puppet::Util::Log::Destination,
-      :prefix     => "Dest",
-      :block      => block,
-      :hash       => @desttypes,
+      :parent => Puppet::Util::Log::Destination,
+      :prefix => "Dest",
+      :block => block,
+      :hash => @desttypes,
       :attributes => options
     )
     dest.match(dest.name)
@@ -63,19 +63,19 @@ class Puppet::Util::Log
     @destinations.keys.each { |dest|
       close(dest)
     }
-    #TRANSLATORS "Log.close_all" is a method name and should not be translated
+    # TRANSLATORS "Log.close_all" is a method name and should not be translated
     raise Puppet::DevError.new(_("Log.close_all failed to close %{destinations}") % { destinations: @destinations.keys.inspect }) if !@destinations.empty?
   end
 
   # Flush any log destinations that support such operations.
   def Log.flush
-    @destinations.each { |type, dest|
+    @destinations.each { |_type, dest|
       dest.flush if dest.respond_to?(:flush)
     }
   end
 
   def Log.autoflush=(v)
-    @destinations.each do |type, dest|
+    @destinations.each do |_type, dest|
       dest.autoflush = v if dest.respond_to?(:autoflush=)
     end
   end
@@ -85,6 +85,7 @@ class Puppet::Util::Log
   def Log.create(hash)
     raise Puppet::DevError, _("Logs require a level") unless hash.include?(:level)
     raise Puppet::DevError, _("Invalid log level %{level}") % { level: hash[:level] } unless @levels.index(hash[:level])
+
     @levels.index(hash[:level]) >= @loglevel ? Puppet::Util::Log.new(hash) : nil
   end
 
@@ -126,11 +127,11 @@ class Puppet::Util::Log
   # Create a new log destination.
   def Log.newdestination(dest)
     # Each destination can only occur once.
-    if @destinations.find { |name, obj| obj.name == dest }
+    if @destinations.find { |_name, obj| obj.name == dest }
       return
     end
 
-    _, type = @desttypes.find do |name, klass|
+    _, type = @desttypes.find do |_name, klass|
       klass.match?(dest)
     end
 
@@ -197,7 +198,7 @@ class Puppet::Util::Log
 
     queuemessage(msg) if @destinations.length == 0
 
-    @destinations.each do |name, dest|
+    @destinations.each do |_name, dest|
       dest.handle(msg)
     end
   end
@@ -208,6 +209,7 @@ class Puppet::Util::Log
 
   def Log.flushqueue
     return unless @destinations.size >= 1
+
     @queued.each do |msg|
       Log.newmessage(msg)
     end
@@ -236,7 +238,7 @@ class Puppet::Util::Log
   def Log.reopen
     Puppet.notice _("Reopening log files")
     types = @destinations.keys
-    @destinations.each { |type, dest|
+    @destinations.each { |_type, dest|
       dest.close if dest.respond_to?(:close)
     }
     @destinations.clear
@@ -294,7 +296,6 @@ class Puppet::Util::Log
     nil
   end
 
-
   attr_accessor :time, :remote, :file, :line, :pos, :issue_code, :environment, :node, :backtrace
   attr_reader :level, :message, :source
 
@@ -314,6 +315,7 @@ class Puppet::Util::Log
     [:file, :line, :pos, :issue_code, :environment, :node, :backtrace].each do |attr|
       value = args[attr]
       next unless value
+
       send(attr.to_s + '=', value)
     end
 
@@ -333,6 +335,7 @@ class Puppet::Util::Log
     %w(file line pos issue_code environment node backtrace).each do |name|
       value = data[name]
       next unless value
+
       send(name + '=', value)
     end
   end
@@ -369,16 +372,18 @@ class Puppet::Util::Log
   end
 
   def message=(msg)
-    #TRANSLATORS 'Puppet::Util::Log' refers to a Puppet source code class
+    # TRANSLATORS 'Puppet::Util::Log' refers to a Puppet source code class
     raise ArgumentError, _("Puppet::Util::Log requires a message") unless msg
+
     @message = msg.to_s
   end
 
   def level=(level)
-    #TRANSLATORS 'Puppet::Util::Log' refers to a Puppet source code class
+    # TRANSLATORS 'Puppet::Util::Log' refers to a Puppet source code class
     raise ArgumentError, _("Puppet::Util::Log requires a log level") unless level
-    #TRANSLATORS 'Puppet::Util::Log' refers to a Puppet source code class
+    # TRANSLATORS 'Puppet::Util::Log' refers to a Puppet source code class
     raise ArgumentError, _("Puppet::Util::Log requires a symbol or string") unless level.respond_to? "to_sym"
+
     @level = level.to_sym
     raise ArgumentError, _("Invalid log level %{level}") % { level: @level } unless self.class.validlevel?(@level)
 
@@ -419,7 +424,6 @@ class Puppet::Util::Log
     end
     msg
   end
-
 end
 
 # This is for backward compatibility from when we changed the constant to

data/lib/puppet/util/logging.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
+
 # A module to make logging a bit easier.
 require_relative '../../puppet/util/log'
 require_relative '../../puppet/error'
 
 module Puppet::Util
 module Logging
-
   def send_log(level, message)
     Puppet::Util::Log.create({:level => level, :source => log_source, :message => message}.merge(log_metadata))
   end
@@ -14,6 +14,7 @@ module Logging
   Puppet::Util::Log.eachlevel do |level|
     # handle debug a special way for performance reasons
     next if level == :debug
+
     define_method(level) do |args|
       args = args.join(" ") if args.is_a?(Array)
       send_log(level, args)
@@ -32,6 +33,7 @@ module Logging
   #
   def debug(*args)
     return nil unless Puppet::Util::Log.level == :debug
+
     if block_given?
       send_log(:debug, yield(*args))
     else
@@ -55,17 +57,17 @@ module Logging
       # Retain all detailed info and keep plain message and stacktrace separate
       backtrace = build_exception_trace(exception, combined_trace, puppet_trace)
       Puppet::Util::Log.create({
-          :level => level,
-          :source => log_source,
-          :message => exception.basic_message,
-          :issue_code => exception.issue_code,
-          :backtrace => backtrace.empty? ? nil : backtrace,
-          :file => exception.file,
-          :line => exception.line,
-          :pos => exception.pos,
-          :environment => exception.environment,
-          :node => exception.node
-        }.merge(log_metadata))
+        :level => level,
+        :source => log_source,
+        :message => exception.basic_message,
+        :issue_code => exception.issue_code,
+        :backtrace => backtrace.empty? ? nil : backtrace,
+        :file => exception.file,
+        :line => exception.line,
+        :pos => exception.pos,
+        :environment => exception.environment,
+        :node => exception.node
+      }.merge(log_metadata))
     else
       send_log(level, format_exception(exception, message, combined_trace, puppet_trace))
     end
@@ -125,7 +127,7 @@ module Logging
     raise exception, message + "\n" + exception.to_s, exception.backtrace
   end
 
-  class DeprecationWarning < Exception; end
+  class DeprecationWarning < Exception; end # rubocop:disable Lint/InheritException
 
   # Logs a warning indicating that the Ruby code path is deprecated.  Note that
   # this method keeps track of the offending lines of code that triggered the
@@ -157,7 +159,7 @@ module Logging
     key = options[:key]
     file = options[:file]
     line = options[:line]
-    #TRANSLATORS the literals ":file", ":line", and ":key" should not be translated
+    # TRANSLATORS the literals ":file", ":line", and ":key" should not be translated
     raise Puppet::DevError, _("Need either :file and :line, or :key") if (key.nil?) && (file.nil? || line.nil?)
 
     key ||= "#{file}:#{line}"
@@ -178,6 +180,7 @@ module Logging
   # Either :file and :line and/or :key must be passed.
   def warn_once(kind, key, message, file = nil, line = nil, level = :warning)
     return if Puppet[:disable_warnings].include?(kind)
+
     $unique_warnings ||= {}
     if $unique_warnings.length < 100 then
       if (! $unique_warnings.has_key?(key)) then
@@ -261,6 +264,7 @@ module Logging
 
   def issue_deprecation_warning(message, key, file, line, use_caller)
     return if Puppet[:disable_warnings].include?('deprecations')
+
     $deprecation_warnings ||= {}
     if $deprecation_warnings.length < 100
       key ||= (offender = get_deprecation_offender)

data/lib/puppet/util/metaid.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Object
   # The hidden singleton lurks behind everyone
   def singleton_class; class << self; self; end; end

data/lib/puppet/util/metric.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # included so we can test object types
 require_relative '../../puppet'
 require_relative '../../puppet/network/format_support'
@@ -51,6 +52,7 @@ class Puppet::Util::Metric
 
   def newvalue(name,value,label = nil)
     raise ArgumentError.new("metric name #{name.inspect} is not a string") unless name.is_a? String
+
     label ||= self.class.labelize(name)
     @values.push [name,label,value]
   end

data/lib/puppet/util/monkey_patches.rb

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

data/lib/puppet/util/multi_match.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # MultiMatch allows multiple values to be tested at once in a case expression.
 # This class is needed since Array does not implement the === operator to mean
 # "each v === other.each v". 
@@ -23,13 +24,15 @@ class MultiMatch
   end
 
   def ===(other)
-    lv = @values  # local var is faster than instance var
+    lv = @values # local var is faster than instance var
     case other
     when MultiMatch
       return false unless other.values.size == values.size
+
       other.values.each_with_index {|v, i| return false unless lv[i] === v || v === lv[i]}
     when Array
       return false unless other.size == values.size
+
       other.each_with_index {|v, i| return false unless lv[i] === v || v === lv[i]}
     else
       false

data/lib/puppet/util/network_device/base.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
+
 require_relative '../../../puppet/util/autoload'
 require 'uri'
 require_relative '../../../puppet/util/network_device/transport'
 require_relative '../../../puppet/util/network_device/transport/base'
 
 class Puppet::Util::NetworkDevice::Base
-
   attr_accessor :url, :transport
 
   def initialize(url, options = {})

data/lib/puppet/util/network_device/config.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
+
 require 'ostruct'
 require_relative '../../../puppet/util/watched_file'
 require_relative '../../../puppet/util/network_device'
 
 class Puppet::Util::NetworkDevice::Config
-
   def self.main
     @main ||= self.new
   end
@@ -47,7 +47,7 @@ class Puppet::Util::NetworkDevice::Config
           when /^\s*#/ # skip comments
             file_line_count += 1
             next
-          when /^\s*$/  # skip blank lines
+          when /^\s*$/ # skip blank lines
             file_line_count += 1
             next
           when /^\[([\w.-]+)\]\s*$/ # [device.fqdn]
@@ -76,7 +76,7 @@ class Puppet::Util::NetworkDevice::Config
       end
     rescue Errno::EACCES
       Puppet.err _("Configuration error: Cannot read %{file}; cannot serve") % { file: @file }
-      #raise Puppet::Error, "Cannot read #{@config}"
+      # raise Puppet::Error, "Cannot read #{@config}"
     rescue Errno::ENOENT
       Puppet.err _("Configuration error: '%{file}' does not exit; cannot serve") % { file: @file }
     end
@@ -102,5 +102,4 @@ class Puppet::Util::NetworkDevice::Config
       raise Puppet::Error, _("Invalid argument '%{var}' at %{error_location}") % { var: var, error_location: error_location_str }
     end
   end
-
 end

data/lib/puppet/util/network_device/transport/base.rb

@@ -23,5 +23,4 @@ class Puppet::Util::NetworkDevice::Transport::Base
       yield output if block_given?
     end
   end
-
 end

data/lib/puppet/util/network_device/transport.rb

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

data/lib/puppet/util/network_device.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Puppet::Util::NetworkDevice
   class << self
     attr_reader :current

data/lib/puppet/util/package/version/debian.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
+
 module Puppet::Util::Package::Version
   class Debian < Numeric
     include Comparable
 
     # Version string matching regexes
-    REGEX_EPOCH   = '(?:([0-9]+):)?'
+    REGEX_EPOCH = '(?:([0-9]+):)?'
     # alphanumerics and the characters . + - ~ , starts with a digit, ~ only of debian_revision is present
     REGEX_UPSTREAM_VERSION = '([\.\+~0-9a-zA-Z-]+?)'
-    #alphanumerics and the characters + . ~
+    # alphanumerics and the characters + . ~
     REGEX_DEBIAN_REVISION = '(?:-([\.\+~0-9a-zA-Z]*))?'
 
     REGEX_FULL    = REGEX_EPOCH + REGEX_UPSTREAM_VERSION + REGEX_DEBIAN_REVISION.freeze
@@ -43,6 +44,7 @@ module Puppet::Util::Package::Version
 
     def <=>(other)
       return nil unless other.is_a?(self.class)
+
       cmp = @epoch <=> other.epoch
       if cmp == 0
         cmp = compare_upstream_version(other)
@@ -97,7 +99,7 @@ module Puppet::Util::Package::Version
       mine ||= ''
       yours ||= ''
       while mine_index < mine.length && yours_index < yours.length && cmp == 0
-        #handle ~
+        # handle ~
         _mymatch, mytilde = *match_tildes(mine.slice(mine_index..-1))
         mytilde ||= ''
 

data/lib/puppet/util/package/version/gem.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
+
 module Puppet::Util::Package::Version
   class Gem < ::Gem::Version
     def self.parse(version)
       raise ValidationFailure, version unless version.is_a? String
       raise ValidationFailure, version unless version =~ ANCHORED_VERSION_PATTERN
+
       new(version)
     end
 

data/lib/puppet/util/package/version/pip.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet::Util::Package::Version
   class Pip
     include Comparable
@@ -71,6 +72,7 @@ module Puppet::Util::Package::Version
 
     def <=>(other)
       raise ValidationFailure, other.to_s unless other.is_a?(self.class)
+
       compare(key, other.key)
     end
 
@@ -118,6 +120,7 @@ module Puppet::Util::Package::Version
       release_key = release.reverse
       release_key.each_with_index do |element, index|
         break unless element == 0
+
         release_key.delete_at(index) unless release_key.at(index + 1) != 0
       end
       release_key.reverse!
@@ -150,10 +153,12 @@ module Puppet::Util::Package::Version
           return compare(element, other.at(index)) if element != other.at(index)
         end
       elsif (this.is_a? Array) && !(other.is_a? Array)
-        raise Puppet::Error, 'Cannot compare #{this} (Array) with #{other} (#{other.class}). Only ±Float::INFINITY accepted.' unless other.abs == Float::INFINITY
+        raise Puppet::Error, "Cannot compare #{this} (Array) with #{other} (#{other.class}). Only ±Float::INFINITY accepted." unless other.abs == Float::INFINITY
+
         return other == -Float::INFINITY ? 1 : -1
       elsif !(this.is_a? Array) && (other.is_a? Array)
-        raise Puppet::Error, 'Cannot compare #{this} (#{this.class}) with #{other} (Array). Only ±Float::INFINITY accepted.' unless this.abs == Float::INFINITY
+        raise Puppet::Error, "Cannot compare #{this} (#{this.class}) with #{other} (Array). Only ±Float::INFINITY accepted." unless this.abs == Float::INFINITY
+
         return this == -Float::INFINITY ? -1 : 1
       end
       this <=> other

data/lib/puppet/util/package/version/range/eq.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../../../puppet/util/package/version/range/simple'
 
 module Puppet::Util::Package::Version
@@ -7,6 +8,7 @@ module Puppet::Util::Package::Version
       def to_s
         "#{@version}"
       end
+
       def include?(version)
         version == @version
       end

data/lib/puppet/util/package/version/range/gt.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../../../puppet/util/package/version/range/simple'
 
 module Puppet::Util::Package::Version
@@ -7,6 +8,7 @@ module Puppet::Util::Package::Version
       def to_s
         ">#{@version}"
       end
+
       def include?(version)
         version > @version
       end

data/lib/puppet/util/package/version/range/gt_eq.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../../../puppet/util/package/version/range/simple'
 
 module Puppet::Util::Package::Version
@@ -7,6 +8,7 @@ module Puppet::Util::Package::Version
       def to_s
         ">=#{@version}"
       end
+
       def include?(version)
         version >= @version
       end

data/lib/puppet/util/package/version/range/lt.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../../../puppet/util/package/version/range/simple'
 
 module Puppet::Util::Package::Version
@@ -7,6 +8,7 @@ module Puppet::Util::Package::Version
       def to_s
         "<#{@version}"
       end
+
       def include?(version)
         version < @version
       end

data/lib/puppet/util/package/version/range/lt_eq.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../../../puppet/util/package/version/range/simple'
 
 module Puppet::Util::Package::Version
@@ -7,6 +8,7 @@ module Puppet::Util::Package::Version
       def to_s
         "<=#{@version}"
       end
+
       def include?(version)
         version <= @version
       end

data/lib/puppet/util/package/version/range/min_max.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../../../puppet/util/package/version/range'
 
 module Puppet::Util::Package::Version
@@ -8,12 +9,15 @@ module Puppet::Util::Package::Version
         @min = min
         @max = max
       end
+
       def to_s
         "#{@min} #{@max}"
       end
+
       def to_gem_version
         "#{@min}, #{@max}"
       end
+
       def include?(version)
         @min.include?(version) && @max.include?(version)
       end

data/lib/puppet/util/package/version/range/simple.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../../../puppet/util/package/version/range'
 
 module Puppet::Util::Package::Version

data/lib/puppet/util/package/version/range.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'range/lt'
 require_relative 'range/lt_eq'
 require_relative 'range/gt'
@@ -30,9 +31,11 @@ module Puppet::Util::Package::Version
     # @api public
     def self.parse(range_string, version_class)
       raise ValidationFailure, "Unable to parse '#{range_string}' as a string" unless range_string.is_a?(String)
+
       simples = range_string.split(RANGE_SPLIT).map do |simple|
         match, operator, version = *simple.match(FULL_REGEX)
         raise ValidationFailure, "Unable to parse '#{simple}' as a version range identifier" unless match
+
         case operator
         when '>'
           Gt.new(version_class::parse(version))

data/lib/puppet/util/package/version/rpm.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../../puppet/util/rpm_compare'
 
 module Puppet::Util::Package::Version
@@ -14,13 +15,14 @@ module Puppet::Util::Package::Version
 
     def self.parse(ver)
       raise ValidationFailure unless ver.is_a?(String)
+
       version = rpm_parse_evr(ver)
       new(version[:epoch], version[:version], version[:release], version[:arch]).freeze
     end
 
     def to_s
       version_found = ''.dup
-      version_found += "#{@epoch}:"   if @epoch
+      version_found += "#{@epoch}:" if @epoch
       version_found += @version
       version_found += "-#{@release}" if @release
       version_found
@@ -39,18 +41,18 @@ module Puppet::Util::Package::Version
     def <=>(other)
       raise ArgumentError, _("Cannot compare, as %{other} is not a Rpm Version") % { other: other } unless other.is_a?(self.class)
 
-      rpm_compareEVR(self.to_s, other.to_s)
+      rpm_compare_evr(self.to_s, other.to_s)
     end
 
     private
 
-    # overwrite rpm_compareEVR to treat no epoch as zero epoch
+    # overwrite rpm_compare_evr to treat no epoch as zero epoch
     # in order to compare version correctly
     #
     # returns 1 if a is newer than b,
     #         0 if they are identical
     #        -1 if a is older than b
-    def rpm_compareEVR(a, b)
+    def rpm_compare_evr(a, b)
       a_hash = rpm_parse_evr(a)
       b_hash = rpm_parse_evr(b)
 

data/lib/puppet/util/package.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet::Util::Package
   def versioncmp(version_a, version_b, ignore_trailing_zeroes = false)
     vre = /[-.]|\d+|[^-.\d]+/
@@ -20,8 +21,10 @@ module Puppet::Util::Package
       return 1  if b == '-'
       return -1 if a == '.'
       return 1  if b == '.'
+
       if a =~ /^\d+$/ && b =~ /^\d+$/
         return a.to_s.upcase <=> b.to_s.upcase if a =~ /^0/ || b =~ /^0/
+
         return a.to_i <=> b.to_i
       end
       return a.upcase <=> b.upcase

data/lib/puppet/util/pidlock.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
+
 require 'fileutils'
 require_relative '../../puppet/util/lockfile'
 
 class Puppet::Util::Pidlock
-
   def initialize(lockfile)
     @lockfile = Puppet::Util::Lockfile.new(lockfile)
   end
@@ -48,12 +48,12 @@ class Puppet::Util::Pidlock
 
   def ps_argument_for_current_kernel
     case Puppet.runtime[:facter].value(:kernel)
-      when "Linux"
-        "-eq"
-      when "AIX"
-        "-T"
-      else
-        "-p"
+    when "Linux"
+      "-eq"
+    when "AIX"
+      "-T"
+    else
+      "-p"
     end
   end
 

data/lib/puppet/util/platform.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet
   module Util
     module Platform

data/lib/puppet/util/plist.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
+
 require 'cfpropertylist' if Puppet.features.cfpropertylist?
 require_relative '../../puppet/util/execution'
 
 module Puppet::Util::Plist
-
   class FormatError < RuntimeError; end
 
   # So I don't have to prepend every method name with 'self.' Most of the