puppet 8.3.1 → 8.4.0

data/lib/puppet/type/tidy.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/parameter/boolean'
 
 Puppet::Type.newtype(:tidy) do
@@ -100,6 +101,7 @@ Puppet::Type.newtype(:tidy) do
     # Make sure we convert to an array.
     munge do |value|
       fail _("Tidy can't use matches with recurse 0, false, or undef") if "#{@resource[:recurse]}" =~ /^(0|false|)$/
+
       [value].flatten
     end
 
@@ -158,7 +160,7 @@ Puppet::Type.newtype(:tidy) do
         multi = Integer($1)
         unit = :d
       else
-        #TRANSLATORS tidy is the name of a program and should not be translated
+        # TRANSLATORS tidy is the name of a program and should not be translated
         self.fail _("Invalid tidy age %{age}") % { age: age }
       end
 
@@ -198,7 +200,7 @@ Puppet::Type.newtype(:tidy) do
         multi = Integer($1)
         unit = :k
       else
-        #TRANSLATORS tidy is the name of a program and should not be translated
+        # TRANSLATORS tidy is the name of a program and should not be translated
         self.fail _("Invalid tidy size %{age}") % { age: age }
       end
 
@@ -292,7 +294,7 @@ Puppet::Type.newtype(:tidy) do
     found_files = files.find_all { |path| tidy?(path) }.collect { |path| mkfile(path) }
     result = found_files.each { |file| debug "Tidying #{file.ref}" }.sort { |a,b| b[:path] <=> a[:path] }
     if found_files.size > 0
-      #TRANSLATORS "Tidy" is a program name and should not be translated
+      # TRANSLATORS "Tidy" is a program name and should not be translated
       notice _("Tidying %{count} files") % { count: found_files.size }
     end
 
@@ -308,6 +310,7 @@ Puppet::Type.newtype(:tidy) do
       dir = ::File.dirname(path)
       resource = files_by_name[dir]
       next unless resource
+
       if resource[:require]
         resource[:require] << Puppet::Resource.new(:file, path)
       else
@@ -353,12 +356,14 @@ Puppet::Type.newtype(:tidy) do
     [:age, :size].each do |name|
       param = parameter(name)
       next unless param
+
       tested = true
       return true if param.tidy?(path, stat)
     end
 
     # If they don't specify either, then the file should always be removed.
     return true unless tested
+
     false
   end
 
@@ -369,7 +374,7 @@ Puppet::Type.newtype(:tidy) do
       debug _("File does not exist")
       return nil
     rescue Errno::EACCES
-      #TRANSLATORS "stat" is a program name and should not be translated
+      # TRANSLATORS "stat" is a program name and should not be translated
       warning _("Could not stat; permission denied")
       return nil
     end

data/lib/puppet/type/user.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'etc'
 require_relative '../../puppet/parameter/boolean'
 require_relative '../../puppet/property/list'
@@ -22,47 +23,47 @@ module Puppet
       user resource will autorequire those role accounts."
 
     feature :allows_duplicates,
-      "The provider supports duplicate users with the same UID."
+            "The provider supports duplicate users with the same UID."
 
     feature :manages_homedir,
-      "The provider can create and remove home directories."
+            "The provider can create and remove home directories."
 
     feature :manages_passwords,
-      "The provider can modify user passwords, by accepting a password
+            "The provider can modify user passwords, by accepting a password
       hash."
 
     feature :manages_password_age,
-      "The provider can set age requirements and restrictions for
+            "The provider can set age requirements and restrictions for
       passwords."
 
     feature :manages_password_salt,
-      "The provider can set a password salt. This is for providers that
+            "The provider can set a password salt. This is for providers that
        implement PBKDF2 passwords with salt properties."
 
     feature :manages_solaris_rbac,
-      "The provider can manage normal users"
+            "The provider can manage normal users"
 
     feature :manages_roles,
-      "The provider can manage roles"
+            "The provider can manage roles"
 
     feature :manages_expiry,
-      "The provider can manage the expiry date for a user."
+            "The provider can manage the expiry date for a user."
 
-   feature :system_users,
-     "The provider allows you to create system users with lower UIDs."
+    feature :system_users,
+            "The provider allows you to create system users with lower UIDs."
 
     feature :manages_aix_lam,
-      "The provider can manage AIX Loadable Authentication Module (LAM) system."
+            "The provider can manage AIX Loadable Authentication Module (LAM) system."
 
     feature :manages_local_users_and_groups,
-      "Allows local users to be managed on systems that also use some other
+            "Allows local users to be managed on systems that also use some other
        remote Name Service Switch (NSS) method of managing accounts."
 
     feature :manages_shell,
-      "The provider allows for setting shell and validates if possible"
+            "The provider allows for setting shell and validates if possible"
 
     feature :manages_loginclass,
-      "The provider can manage the login class for a user."
+            "The provider can manage the login class for a user."
 
     newproperty(:ensure, :parent => Puppet::Property::Ensure) do
       newvalue(:present, :event => :user_created) do
@@ -193,6 +194,7 @@ module Puppet
         if !@should.empty? && provider.respond_to?(:comments_insync?)
           return provider.comments_insync?(is, @should)
         end
+
         super(is)
       end
 
@@ -203,6 +205,7 @@ module Puppet
         if newvalue.is_a?(String) && !Encoding.compatible?(currentvalue, newvalue)
           return super(currentvalue, newvalue.dup.force_encoding(currentvalue.encoding))
         end
+
         super(currentvalue, newvalue)
       end
     end
@@ -452,8 +455,8 @@ module Puppet
 
       validate do |value|
         if value.intern != :absent and value !~ /^\d{4}-\d{2}-\d{2}$/
-          #TRANSLATORS YYYY-MM-DD represents a date with a four-digit year, a two-digit month, and a two-digit day,
-          #TRANSLATORS separated by dashes.
+          # TRANSLATORS YYYY-MM-DD represents a date with a four-digit year, a two-digit month, and a two-digit day,
+          # TRANSLATORS separated by dashes.
           raise ArgumentError, _("Expiry dates must be YYYY-MM-DD or the string \"absent\"")
         end
       end
@@ -527,7 +530,7 @@ module Puppet
       end
     end
 
-    #autorequire the roles that the user has
+    # autorequire the roles that the user has
     autorequire(:user) do
       reqs = []
 
@@ -687,8 +690,8 @@ module Puppet
     end
 
     newparam(:forcelocal, :boolean => true,
-            :required_features => :manages_local_users_and_groups,
-            :parent => Puppet::Parameter::Boolean) do
+                          :required_features => :manages_local_users_and_groups,
+                          :parent => Puppet::Parameter::Boolean) do
       desc "Forces the management of local accounts when accounts are also
             being managed by some other Name Service Switch (NSS). For AIX, refer to the `ia_load_module` parameter.
             
@@ -733,10 +736,10 @@ module Puppet
         if [ :true, :false ].include? value.to_s.intern
           return
         end
+
         value = [ value ] if value.is_a?(String)
         if value.is_a?(Array)
           value.each do |entry|
-
             raise ArgumentError, _("Each entry for purge_ssh_keys must be a string, not a %{klass}") % { klass: entry.class } unless entry.is_a?(String)
 
             valid_home = Puppet::Util.absolute_path?(entry) || entry =~ %r{^~/|^%h/}
@@ -806,10 +809,10 @@ module Puppet
     # @see generate
     # @api private
     def find_unmanaged_keys
-      self[:purge_ssh_keys].
-        select { |f| File.readable?(f) }.
-        map { |f| unknown_keys_in_file(f) }.
-        flatten.each do |res|
+      self[:purge_ssh_keys]
+        .select { |f| File.readable?(f) }
+        .map { |f| unknown_keys_in_file(f) }
+        .flatten.each do |res|
           res[:ensure] = :absent
           res[:user] = self[:name]
           res.copy_metaparams(@parameters)
@@ -835,6 +838,7 @@ module Puppet
       # the authorized_keys file may contain UTF-8 comments
       Puppet::FileSystem.open(keyfile, nil, 'r:UTF-8').each do |line|
         next unless line =~ Puppet::Type.type(:ssh_authorized_key).keyline_regex
+
         # the name is stored in the 4th capture of the regex
         name = $4
         if name.empty?

data/lib/puppet/type/whit.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 Puppet::Type.newtype(:whit) do
   desc "Whits are internal artifacts of Puppet's current implementation, and
     Puppet suppresses their appearance in all logs. We make no guarantee of
@@ -10,7 +11,6 @@ Puppet::Type.newtype(:whit) do
     desc "The name of the whit, because it must have one."
   end
 
-
   # Hide the fact that we're a whit from logs.
   #
   # I hate you, milkman whit.  You are so painful, so often.

data/lib/puppet/type.rb

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 # frozen_string_literal: true
+
 require_relative '../puppet'
 require_relative '../puppet/util/log'
 require_relative '../puppet/util/metric'
@@ -15,7 +16,6 @@ require_relative '../puppet/concurrent/lock'
 
 # see the bottom of the file for the rest of the inclusions
 
-
 module Puppet
 # The base class for all Puppet types.
 #
@@ -101,6 +101,7 @@ class Type
     # Order is only maintained against other types, not arbitrary objects.
     # The natural order is based on the reference name used when comparing
     return nil unless other.is_a?(Puppet::CompilableResourceType) || other.class.is_a?(Puppet::CompilableResourceType)
+
     # against other type instances.
     self.ref <=> other.ref
   end
@@ -136,10 +137,10 @@ class Type
     # of times (as in, hundreds of thousands in a given run).
     unless @attrclasses.include?(name)
       @attrclasses[name] = case self.attrtype(name)
-      when :property; @validproperties[name]
-      when :meta; @@metaparamhash[name]
-      when :param; @paramhash[name]
-      end
+                           when :property; @validproperties[name]
+                           when :meta; @@metaparamhash[name]
+                           when :param; @paramhash[name]
+                           end
     end
     @attrclasses[name]
   end
@@ -153,10 +154,10 @@ class Type
     @attrtypes ||= {}
     unless @attrtypes.include?(attr)
       @attrtypes[attr] = case
-        when @validproperties.include?(attr); :property
-        when @paramhash.include?(attr); :param
-        when @@metaparamhash.include?(attr); :meta
-        end
+                         when @validproperties.include?(attr); :property
+                         when @paramhash.include?(attr); :param
+                         when @@metaparamhash.include?(attr); :meta
+                         end
     end
 
     @attrtypes[attr]
@@ -295,6 +296,7 @@ class Type
   #
   def self.metaparamclass(name)
     return nil if name.nil?
+
     @@metaparamhash[name.intern]
   end
 
@@ -386,7 +388,9 @@ class Type
   #
   def self.key_attributes
     # This is a cache miss around 0.05 percent of the time. --daniel 2012-07-17
+    # rubocop:disable Naming/MemoizedInstanceVariableName
     @key_attributes_cache ||= key_attribute_parameters.collect { |p| p.name }
+    # rubocop:enable Naming/MemoizedInstanceVariableName
   end
 
   # Returns any parameters that should be included by default in puppet resource's output
@@ -462,12 +466,12 @@ class Type
 
     param = genclass(
       name,
-      :parent     => options[:parent] || Puppet::Parameter,
+      :parent => options[:parent] || Puppet::Parameter,
       :attributes => options[:attributes],
-      :block      => block,
-      :prefix     => "Parameter",
-      :array      => @parameters,
-      :hash       => @paramhash
+      :block => block,
+      :prefix => "Parameter",
+      :array => @parameters,
+      :hash => @paramhash
     )
 
     handle_param_options(name, options)
@@ -548,6 +552,7 @@ class Type
   # @return [Array<String>] Returns the parameter names
   def self.parameters
     return [] unless defined?(@parameters)
+
     @parameters.collect { |klass| klass.name }
   end
 
@@ -567,6 +572,7 @@ class Type
   def self.validattr?(name)
     name = name.intern
     return true if name == :name
+
     @validattrs ||= {}
 
     unless @validattrs.include?(name)
@@ -595,6 +601,7 @@ class Type
   # @return [Boolean] Returns true if the given name is the name of an existing parameter
   def self.validparameter?(name)
     raise Puppet::DevError, _("Class %{class_name} has not defined parameters") % { class_name: self } unless defined?(@parameters)
+
     !!(@paramhash.include?(name) or @@metaparamhash.include?(name))
   end
 
@@ -630,6 +637,7 @@ class Type
   #
   def name_var
     return @name_var_cache unless @name_var_cache.nil?
+
     key_attributes = self.class.key_attributes
     @name_var_cache = (key_attributes.length == 1) && key_attributes.first
   end
@@ -659,7 +667,7 @@ class Type
   end
 
   # Sets the 'should' (wanted state) value of a property, or the value of a parameter.
-  # @return
+  #
   # @raise [Puppet::Error] if the setting of the value fails, or if the given name is nil.
   # @raise [Puppet::ResourceError] when the parameter validation raises Puppet::Error or
   #   ArgumentError
@@ -687,8 +695,6 @@ class Type
         raise error
       end
     end
-
-    nil
   end
 
   # Removes an attribute from the object; useful in testing or in cleanup
@@ -907,6 +913,7 @@ class Type
   # @return [???] the version of the catalog or 0 if there is no catalog.
   def version
     return 0 unless catalog
+
     catalog.version
   end
 
@@ -982,7 +989,7 @@ class Type
   def remove()
     # This is hackish (mmm, cut and paste), but it works for now, and it's
     # better than warnings.
-    @parameters.each do |name, obj|
+    @parameters.each do |_name, obj|
       obj.remove
     end
     @parameters.clear
@@ -1066,6 +1073,7 @@ class Type
 
     properties.each do |property|
       next if property.name == :ensure
+
       if ensure_state == :absent
         result[property] = :absent
       else
@@ -1218,7 +1226,6 @@ class Type
     resource
   end
 
-
   # Returns an array of strings representing the containment hierarchy
   # (types/classes) that make up the path to the resource from the root
   # of the catalog.  This is mostly used for logging purposes.
@@ -1311,6 +1318,7 @@ class Type
       unless list == [:all]
         list.each do |param|
           next if @resource.class.validattr?(param)
+
           fail "Cannot audit #{param}: not a valid attribute for #{resource}"
         end
       end
@@ -1319,6 +1327,7 @@ class Type
     munge do |args|
       properties_to_audit(args).each do |param|
         next unless resource.class.validproperty?(param)
+
         resource.newattr(param)
       end
     end
@@ -1417,7 +1426,7 @@ class Type
       aliases.each do |other|
         obj = @resource.catalog.resource(@resource.class.name, other)
         if obj
-          unless obj.object_id == @resource.object_id
+          unless obj.equal?(@resource) # same object?
             self.fail("#{@resource.title} can not create alias #{other}: object already exists")
           end
           next
@@ -1548,13 +1557,13 @@ class Type
         # i.e. before, after, subscribe, notify
         self.debug do
           relation = case self.class.name
-          when "subscribe"
-            "subscribes"
-          when "notify"
-            "notifies"
-          else
-            self.class.name
-          end
+                     when "subscribe"
+                       "subscribes"
+                     when "notify"
+                       "notifies"
+                     else
+                       self.class.name
+                     end
 
           "#{relation} to #{related_resource.ref}"
         end
@@ -1570,7 +1579,6 @@ class Type
     RelationshipMetaparam.subclasses
   end
 
-
   # Note that the order in which the relationships params is defined
   # matters.  The labeled params (notify and subscribe) must be later,
   # so that if both params are used, those ones win.  It's a hackish
@@ -1717,7 +1725,7 @@ class Type
 
     if defaults.length > 1
       Puppet.warning(_("Found multiple default providers for %{name}: %{provider_list}; using %{selected_provider}") %
-                         { name: self.name, provider_list:  defaults.collect { |i| i.name.to_s }.join(", "), selected_provider: defaults[0].name })
+                         { name: self.name, provider_list: defaults.collect { |i| i.name.to_s }.join(", "), selected_provider: defaults[0].name })
     end
 
     @defaultprovider = defaults.shift unless defaults.empty?
@@ -1795,20 +1803,20 @@ class Type
 
     pname = options[:parent]
     parent = if pname
-      options.delete(:parent)
-      if pname.is_a? Class
-        pname
-      else
-        provider = self.provider(pname)
-        if provider
-          provider
-        else
-          raise Puppet::DevError, _("Could not find parent provider %{parent} of %{name}") % { parent: pname, name: name }
-        end
-      end
-    else
-      Puppet::Provider
-    end
+               options.delete(:parent)
+               if pname.is_a? Class
+                 pname
+               else
+                 provider = self.provider(pname)
+                 if provider
+                   provider
+                 else
+                   raise Puppet::DevError, _("Could not find parent provider %{parent} of %{name}") % { parent: pname, name: name }
+                 end
+               end
+             else
+               Puppet::Provider
+             end
 
     options[:resource_type] ||= self
 
@@ -1816,12 +1824,12 @@ class Type
 
     provider = genclass(
       name,
-      :parent     => parent,
-      :hash       => provider_hash,
-      :prefix     => "Provider",
-      :block      => block,
-      :include    => feature_module,
-      :extend     => feature_module,
+      :parent => parent,
+      :hash => provider_hash,
+      :prefix => "Provider",
+      :block => block,
+      :include => feature_module,
+      :extend => feature_module,
       :attributes => options
     )
 
@@ -1915,9 +1923,9 @@ class Type
   #
   def self.suitableprovider
     providerloader.loadall(Puppet.lookup(:current_environment)) if provider_hash.empty?
-    provider_hash.find_all { |name, provider|
+    provider_hash.find_all { |_name, provider|
       provider.suitable?
-    }.collect { |name, provider|
+    }.collect { |_name, provider|
       provider
     }.reject { |p| p.name == :fake } # For testing
   end
@@ -2093,6 +2101,7 @@ class Type
       # Retrieve the list of names from the block.
       list = self.instance_eval(&block)
       next unless list
+
       list = [list] unless list.is_a?(Array)
 
       # Collect the current prereqs
@@ -2191,6 +2200,7 @@ class Type
     # @return [Boolean] true if the type should send itself a refresh event on change.
     #
     attr_accessor :self_refresh
+
     include Enumerable, Puppet::Util::ClassGen
 
     include Puppet::Util
@@ -2222,9 +2232,9 @@ class Type
         "Param Documentation for #{key} not found"
       end
     }
-
+    # rubocop:disable Naming/MemoizedInstanceVariableName
     @doc ||= ""
-
+    # rubocop:enable Naming/MemoizedInstanceVariableName
   end
 
   # Returns the name of this type (if specified) or the parent type #to_s.
@@ -2282,9 +2292,7 @@ class Type
   # @return [void]
   #
   def log(msg)
-
     Puppet::Util::Log.create(
-
       :level => @parameters[:loglevel].value,
       :message => msg,
 
@@ -2292,7 +2300,6 @@ class Type
     )
   end
 
-
   # instance methods related to instance intrinsics
   # e.g., initialize and name
 
@@ -2409,8 +2416,9 @@ class Type
       end
     end
 
-    parameters.each do |name, param|
+    parameters.each do |_name, param|
       next if param.sensitive
+
       if param.is_a?(Puppet::Parameter)
         param.sensitive = param.is_sensitive if param.respond_to?(:is_sensitive)
       end
@@ -2518,12 +2526,13 @@ class Type
   def parent
     return nil unless catalog
     return @parent if @parent
+
     parents = catalog.adjacent(self, :direction => :in)
     @parent = if parents
-      parents.shift
-    else
-      nil
-    end
+                parents.shift
+              else
+                nil
+              end
   end
 
   # Returns a reference to this as a string in "Type[name]" format.
@@ -2607,6 +2616,7 @@ class Type
 
       # We've already got property values
       next if param.is_a?(Puppet::Property)
+
       resource[name] = param.value
     end
 

data/lib/puppet/util/at_fork/noop.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # A noop implementation of the Puppet::Util::AtFork handler
 class Puppet::Util::AtFork::Noop
   class << self

data/lib/puppet/util/at_fork/solaris.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../puppet'
 require 'fiddle'
 
@@ -22,7 +23,7 @@ class Puppet::Util::AtFork::Solaris
 
   {
     'libcontract.so.1' => [
-      #function name,            return value type, parameter types, ...
+      # function name,            return value type, parameter types, ...
       [:ct_ctl_abandon,          Fiddle::TYPE_INT,  Fiddle::TYPE_INT],
       [:ct_tmpl_activate,        Fiddle::TYPE_INT,  Fiddle::TYPE_INT],
       [:ct_tmpl_clear,           Fiddle::TYPE_INT,  Fiddle::TYPE_INT],

data/lib/puppet/util/at_fork.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet'
 
 # A module for building AtFork handlers. These handlers are objects providing
@@ -13,7 +14,7 @@ require_relative '../../puppet'
 #   killed in the process as a consequence of running in the same contract as the
 #   service.
 module Puppet::Util::AtFork
-  @handler_class = loop do
+  @handler_class = loop do # rubocop:disable Lint/UnreachableLoop
     if Puppet::Util::Platform.solaris?
       begin
         require_relative 'at_fork/solaris'

data/lib/puppet/util/autoload.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'pathname'
 require_relative '../../puppet/util/rubygems'
 require_relative '../../puppet/util/warnings'
@@ -60,8 +61,10 @@ class Puppet::Util::Autoload
     def changed?(name, env)
       name = cleanpath(name).chomp('.rb')
       return true unless loaded.include?(name)
+
       file, old_mtime = loaded[name]
       return true unless file == get_file(name, env)
+
       begin
         old_mtime.to_i != File.mtime(file).to_i
       rescue Errno::ENOENT
@@ -74,6 +77,7 @@ class Puppet::Util::Autoload
     def load_file(name, env)
       file = get_file(name.to_s, env)
       return false unless file
+
       begin
         mark_loaded(name, file)
         Kernel.load file
@@ -176,6 +180,7 @@ class Puppet::Util::Autoload
   def initialize(obj, path)
     @path = path.to_s
     raise ArgumentError, _("Autoload paths cannot be fully qualified") if Puppet::Util.absolute_path?(@path)
+
     @object = obj
   end