puppet 8.3.1 → 8.5.0

data/lib/puppet/type/package.rb

@@ -1,5 +1,6 @@
 # coding: utf-8
 # frozen_string_literal: true
+
 # Define the different packaging systems.  Each package system is implemented
 # in a module, which then gets used to individually extend each package object.
 # This allows packages to exist on the same machine using different packaging
@@ -34,20 +35,20 @@ module Puppet
       resource will autorequire those files."
 
     feature :reinstallable, "The provider can reinstall packages.",
-      :methods => [:reinstall]
+            :methods => [:reinstall]
     feature :installable, "The provider can install packages.",
-      :methods => [:install]
+            :methods => [:install]
     feature :uninstallable, "The provider can uninstall packages.",
-      :methods => [:uninstall]
+            :methods => [:uninstall]
     feature :upgradeable, "The provider can upgrade to the latest version of a
         package.  This feature is used by specifying `latest` as the
         desired value for the package.",
-      :methods => [:update, :latest]
+            :methods => [:update, :latest]
     feature :purgeable, "The provider can purge packages.  This generally means
         that all traces of the package are removed, including
         existing configuration files.  This feature is thus destructive
         and should be used with the utmost care.",
-      :methods => [:purge]
+            :methods => [:purge]
     feature :versionable, "The provider is capable of interrogating the
         package database for installed version(s), and can select
         which out of a set of available versions of a package to
@@ -57,7 +58,7 @@ module Puppet
         such that they are not automatically upgraded as a result of
         other package dependencies unless explicit action is taken by
         a user or another package.",
-      :methods => [:hold, :unhold]
+            :methods => [:hold, :unhold]
     feature :install_only, "The provider accepts options to only install packages never update (kernels, etc.)"
     feature :install_options, "The provider accepts options to be
       passed to the installer command."
@@ -65,12 +66,12 @@ module Puppet
       passed to the uninstaller command."
     feature :disableable, "The provider can disable packages. This feature is used by specifying `disabled` as the
       desired value for the package.",
-      :methods => [:disable]
+            :methods => [:disable]
     feature :supports_flavors, "The provider accepts flavors, which are specific variants of packages."
     feature :package_settings, "The provider accepts package_settings to be
       ensured for the given package. The meaning and format of these settings is
       provider-specific.",
-      :methods => [:package_settings_insync?, :package_settings, :package_settings=]
+            :methods => [:package_settings_insync?, :package_settings, :package_settings=]
     feature :virtual_packages, "The provider accepts virtual package names for install and uninstall."
 
     feature :targetable, "The provider accepts a targeted package management command."
@@ -165,7 +166,7 @@ module Puppet
 
             # Don't run 'latest' more than about every 5 minutes
             if @latest and ((Time.now.to_i - @lateststamp) / 60) < 5
-              #self.debug "Skipping latest check"
+              # self.debug "Skipping latest check"
             else
               begin
                 @latest = provider.latest
@@ -178,19 +179,18 @@ module Puppet
             end
 
             case
-              when is.is_a?(Array) && is.include?(@latest)
-                return true
-              when is == @latest
-                return true
-              when is == :present
-                # This will only happen on packaging systems
-                # that can't query versions.
-                return true
-              else
-                self.debug "#{@resource.name} #{is.inspect} is installed, latest is #{@latest.inspect}"
+            when is.is_a?(Array) && is.include?(@latest)
+              return true
+            when is == @latest
+              return true
+            when is == :present
+              # This will only happen on packaging systems
+              # that can't query versions.
+              return true
+            else
+              self.debug "#{@resource.name} #{is.inspect} is installed, latest is #{@latest.inspect}"
             end
 
-
           when :absent
             return true if is == :absent || is == :purged
           when :purged
@@ -343,10 +343,10 @@ module Puppet
     def self.title_patterns
       # This is the default title pattern for all types, except hard-wired to
       # set only name.
-      [ [ /(.*)/m, [ [:name] ] ] ]
+      [[/(.*)/m, [[:name]]]]
     end
 
-    newproperty(:package_settings, :required_features=>:package_settings) do
+    newproperty(:package_settings, :required_features => :package_settings) do
       desc "Settings that can change the contents or configuration of a package.
 
         The formatting and effects of package_settings are provider-specific; any
@@ -395,7 +395,7 @@ module Puppet
         end
       end
 
-      def is_to_s(currentvalue)
+      def is_to_s(currentvalue) # rubocop:disable Naming/PredicateName
         if provider.respond_to?(:package_settings_is_to_s)
           provider.package_settings_is_to_s(should, currentvalue)
         else
@@ -407,7 +407,7 @@ module Puppet
         if provider.respond_to?(:package_settings_change_to_s)
           provider.package_settings_change_to_s(currentvalue, newvalue)
         else
-          super(currentvalue,newvalue)
+          super(currentvalue, newvalue)
         end
       end
     end
@@ -652,16 +652,16 @@ module Puppet
     # that support the reinstall_on_refresh parameter.
     def refresh
       if provider.reinstallable? &&
-        @parameters[:reinstall_on_refresh].value == :true &&
-        @parameters[:ensure].value != :purged &&
-        @parameters[:ensure].value != :absent
+         @parameters[:reinstall_on_refresh].value == :true &&
+         @parameters[:ensure].value != :purged &&
+         @parameters[:ensure].value != :absent
 
         provider.reinstall
       end
     end
 
     newproperty(:mark, :required_features => :holdable) do
-      mark_doc='Valid values are: hold/none'
+      mark_doc = 'Valid values are: hold/none'
       desc <<-EOT
         Set to hold to tell Debian apt/Solaris pkg to hold the package version
 
@@ -680,7 +680,7 @@ module Puppet
         when "none", :none
           :none
         else
-          raise ArgumentError, _('Invalid hold value %{value}. %{doc}') % { value: value.inspect, doc: mark_doc}
+          raise ArgumentError, _('Invalid hold value %{value}. %{doc}') % { value: value.inspect, doc: mark_doc }
         end
       end
 

data/lib/puppet/type/resources.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet'
 require_relative '../../puppet/parameter/boolean'
 
@@ -8,6 +9,7 @@ Puppet::Type.newtype(:resources) do
     so you can purge unmanaged resources but set `noop` to true so the
     purging is only logged and does not actually happen."
 
+  apply_to_all
 
   newparam(:name) do
     desc "The name of the type to be managed."
@@ -77,22 +79,22 @@ Puppet::Type.newtype(:resources) do
       value = [value] unless value.is_a? Array
       value.flatten.collect do |v|
         case v
-          when Integer
-            v
-          when String
-            Integer(v)
-          else
-            raise ArgumentError, _("Invalid value %{value}.") % { value: v.inspect }
+        when Integer
+          v
+        when String
+          Integer(v)
+        else
+          raise ArgumentError, _("Invalid value %{value}.") % { value: v.inspect }
         end
       end
     end
   end
 
   WINDOWS_SYSTEM_SID_REGEXES =
-      # Administrator, Guest, Domain Admins, Schema Admins, Enterprise Admins.
-      # https://support.microsoft.com/en-us/help/243330/well-known-security-identifiers-in-windows-operating-systems
-      [/S-1-5-21.+-500/, /S-1-5-21.+-501/, /S-1-5-21.+-512/, /S-1-5-21.+-518/,
-       /S-1-5-21.+-519/]
+    # Administrator, Guest, Domain Admins, Schema Admins, Enterprise Admins.
+    # https://support.microsoft.com/en-us/help/243330/well-known-security-identifiers-in-windows-operating-systems
+    [/S-1-5-21.+-500/, /S-1-5-21.+-501/, /S-1-5-21.+-512/, /S-1-5-21.+-518/,
+     /S-1-5-21.+-519/]
 
   def check(resource)
     @checkmethod ||= "#{self[:name]}_check"
@@ -105,25 +107,26 @@ Puppet::Type.newtype(:resources) do
   end
 
   def able_to_ensure_absent?(resource)
-      resource[:ensure] = :absent
+    resource[:ensure] = :absent
   rescue ArgumentError, Puppet::Error
-      err _("The 'ensure' attribute on %{name} resources does not accept 'absent' as a value") % { name: self[:name] }
-      false
+    err _("The 'ensure' attribute on %{name} resources does not accept 'absent' as a value") % { name: self[:name] }
+    false
   end
 
   # Generate any new resources we need to manage.  This is pretty hackish
   # right now, because it only supports purging.
   def generate
     return [] unless self.purge?
-    resource_type.instances.
-      reject { |r| catalog.resource_refs.include? r.ref }.
-      select { |r| check(r) }.
-      select { |r| r.class.validproperty?(:ensure) }.
-      select { |r| able_to_ensure_absent?(r) }.
-      each { |resource|
-        resource.copy_metaparams(@parameters)
-        resource.purging
-      }
+
+    resource_type.instances
+                 .reject { |r| catalog.resource_refs.include? r.ref }
+                 .select { |r| check(r) }
+                 .select { |r| r.class.validproperty?(:ensure) }
+                 .select { |r| able_to_ensure_absent?(r) }
+                 .each { |resource|
+      resource.copy_metaparams(@parameters)
+      resource.purging
+    }
   end
 
   def resource_type
@@ -132,6 +135,7 @@ Puppet::Type.newtype(:resources) do
       unless type
         raise Puppet::DevError, _("Could not find resource type")
       end
+
       @resource_type = type
     end
     @resource_type
@@ -141,6 +145,7 @@ Puppet::Type.newtype(:resources) do
   def user_check(resource)
     return true unless self[:name] == "user"
     return true unless self[:unless_system_user]
+
     resource[:audit] = :uid
     current_values = resource.retrieve_resource
     current_uid = current_values[resource.property(:uid)]
@@ -148,6 +153,7 @@ Puppet::Type.newtype(:resources) do
 
     return false if system_users.include?(resource[:name])
     return false if unless_uids && unless_uids.include?(current_uid)
+
     if current_uid.is_a?(String)
       # Windows user; is a system user if any regex matches.
       WINDOWS_SYSTEM_SID_REGEXES.none? { |regex| current_uid =~ regex }
@@ -171,12 +177,11 @@ Puppet::Type.newtype(:resources) do
     end
 
     # Otherwise, use a sensible default based on the OS family
-    @system_users_max_uid ||= case Puppet.runtime[:facter].value('os.family')
-      when 'OpenBSD', 'FreeBSD'
-        999
-      else
-        499
-    end
+    @system_users_max_uid ||=
+      case Puppet.runtime[:facter].value('os.family')
+      when 'OpenBSD', 'FreeBSD' then 999
+      else                           499
+      end
 
     @system_users_max_uid
   end

data/lib/puppet/type/schedule.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet
   Type.newtype(:schedule) do
     @doc = <<-'EOT'
@@ -54,7 +55,7 @@ module Puppet
       resource could be checked & applied multiple times in the schedule as
       the information about when the resource was last checked will have
       expired from the cache.
-      EOT
+    EOT
 
     apply_to_all
 
@@ -72,7 +73,7 @@ module Puppet
               schedule => 'everyday',
             }
 
-        EOT
+      EOT
       isnamevar
     end
 
@@ -99,8 +100,8 @@ module Puppet
       validate do |values|
         values = [values] unless values.is_a?(Array)
         values.each { |value|
-          unless  value.is_a?(String) and
-              value =~ /\d+(:\d+){0,2}\s*-\s*\d+(:\d+){0,2}/
+          unless value.is_a?(String) and
+                 value =~ /\d+(:\d+){0,2}\s*-\s*\d+(:\d+){0,2}/
             self.fail _("Invalid range value '%{value}'") % { value: value }
           end
         }
@@ -221,7 +222,7 @@ module Puppet
 
         See the `periodmatch` attribute for tuning whether to match
         times by their distance apart or by their specific value.
-        
+
         > **Tip**: You can use `period => never,` to prevent a resource from being applied
         in the given `range`. This is useful if you need to create a blackout window to
         perform sensitive operations without interruption.
@@ -280,7 +281,7 @@ module Puppet
       validate do |value|
         unless value.is_a?(Integer) or value =~ /^\d+$/
           raise Puppet::Error,
-            _("Repeat must be a number")
+                _("Repeat must be a number")
         end
 
         # This implicitly assumes that 'periodmatch' is distance -- that
@@ -289,7 +290,7 @@ module Puppet
 
         if value != 1 and @resource[:periodmatch] != :distance
           raise Puppet::Error,
-            _("Repeat must be 1 unless periodmatch is 'distance', not '%{period}'") % { period: @resource[:periodmatch] }
+                _("Repeat must be 1 unless periodmatch is 'distance', not '%{period}'") % { period: @resource[:periodmatch] }
         end
       end
 
@@ -367,7 +368,7 @@ module Puppet
           when 0..6
             index = value
           else
-            index = weekdays[value[0,3].downcase]
+            index = weekdays[value[0, 3].downcase]
           end
           ret[index] = true
         end
@@ -382,6 +383,7 @@ module Puppet
         return true if @resource[:range]
 
         return true if value.has_key?(now.wday)
+
         false
       end
     end
@@ -399,8 +401,7 @@ module Puppet
 
       Puppet.debug "Creating default schedules"
 
-            result << self.new(
-
+      result << self.new(
         :name => "puppet",
         :period => :hourly,
 
@@ -409,8 +410,7 @@ module Puppet
 
       # And then one for every period
       @parameters.find { |p| p.name == :period }.value_collection.values.each { |value|
-
-              result << self.new(
+        result << self.new(
           :name => value.to_s,
           :period => value
         )
@@ -420,7 +420,6 @@ module Puppet
     end
 
     def match?(previous = nil, now = nil)
-
       # If we've got a value, then convert it to a Time instance
       previous &&= Time.at(previous)
 
@@ -429,7 +428,7 @@ module Puppet
       # Pull them in order
       self.class.allattrs.each { |param|
         if @parameters.include?(param) and
-          @parameters[param].respond_to?(:match?)
+           @parameters[param].respond_to?(:match?)
           return false unless @parameters[param].match?(previous, now)
         end
       }

data/lib/puppet/type/service.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
+
 # This is our main way of managing processes right now.
 #
 # a service is distinct from a process in that services
 # can only be managed through the interface of an init script
 # which is why they have a search path for initscripts and such
 
-
 module Puppet
-
   Type.newtype(:service) do
     @doc = "Manage running services.  Service support unfortunately varies
       widely by platform --- some platforms have very little if any concept of a
@@ -34,23 +33,23 @@ module Puppet
       * If you do neither, the service's stop and start commands will be used."
 
     feature :refreshable, "The provider can restart the service.",
-      :methods => [:restart]
+            :methods => [:restart]
 
     feature :enableable, "The provider can enable and disable the service.",
-      :methods => [:disable, :enable, :enabled?]
+            :methods => [:disable, :enable, :enabled?]
 
     feature :delayed_startable, "The provider can set service to delayed start",
-      :methods => [:delayed_start]
+            :methods => [:delayed_start]
 
     feature :manual_startable, "The provider can set service to manual start",
-      :methods => [:manual_start]
+            :methods => [:manual_start]
 
     feature :controllable, "The provider uses a control variable."
 
     feature :flaggable, "The provider can pass flags to the service."
 
     feature :maskable, "The provider can 'mask' the service.",
-      :methods => [:mask]
+            :methods => [:mask]
 
     feature :configurable_timeout, "The provider can specify a minumum timeout for syncing service properties"
 
@@ -61,9 +60,9 @@ module Puppet
         This property behaves differently depending on the platform;
         wherever possible, it relies on local tools to enable or disable
         a given service. Default values depend on the platform.
-        
+
         If you don't specify a value for the `enable` attribute, Puppet leaves
-        that aspect of the service alone and your operating system determines 
+        that aspect of the service alone and your operating system determines
         the behavior."
 
       newvalue(:true, :event => :service_enabled) do
@@ -94,6 +93,7 @@ module Puppet
 
       def insync?(current)
         return provider.enabled_insync?(current) if provider.respond_to?(:enabled_insync?)
+
         super(current)
       end
     end
@@ -141,6 +141,7 @@ module Puppet
 
       def insync?(current)
         return provider.logonaccount_insync?(current) if provider.respond_to?(:logonaccount_insync?)
+
         super(current)
       end
     end
@@ -257,7 +258,7 @@ module Puppet
       desc "The control variable used to manage services (originally for HP-UX).
         Defaults to the upcased service name plus `START` replacing dots with
         underscores, for those providers that support the `controllable` feature."
-      defaultto { resource.name.tr(".","_").upcase + "_START" if resource.provider.controllable? }
+      defaultto { resource.name.tr(".", "_").upcase + "_START" if resource.provider.controllable? }
     end
 
     newparam :hasrestart do
@@ -279,6 +280,7 @@ module Puppet
         begin
           value = value.to_i
           raise if value < 1
+
           value
         rescue
           raise Puppet::Error.new(_("\"%{value}\" is not a positive integer: the timeout parameter must be specified as a positive integer") % { value: value })
@@ -303,7 +305,7 @@ module Puppet
 
     validate do
       if @parameters[:logonpassword] && @parameters[:logonaccount].nil?
-        raise Puppet::Error.new(_"The 'logonaccount' parameter is mandatory when setting 'logonpassword'.")
+        raise Puppet::Error.new(_("The 'logonaccount' parameter is mandatory when setting 'logonpassword'."))
       end
     end
   end

data/lib/puppet/type/stage.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 Puppet::Type.newtype(:stage) do
   desc "A resource type for creating new run stages.  Once a stage is available,
     classes can be assigned to it by declaring them with the resource-like syntax

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
 
@@ -108,7 +110,7 @@ Puppet::Type.newtype(:tidy) do
     def tidy?(path, stat)
       basename = File.basename(path)
       flags = File::FNM_DOTMATCH | File::FNM_PATHNAME
-      return(value.find {|pattern| File.fnmatch(pattern, basename, flags) } ? true : false)
+      return(value.find { |pattern| File.fnmatch(pattern, basename, flags) } ? true : false)
     end
   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
 
@@ -290,9 +292,9 @@ Puppet::Type.newtype(:tidy) do
       files = [self[:path]]
     end
     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] }
+    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
 
@@ -302,12 +304,13 @@ Puppet::Type.newtype(:tidy) do
 
     # Now make sure that all directories require the files they contain, if all are available,
     # so that a directory is emptied before we try to remove it.
-    files_by_name = result.inject({}) { |hash, file| hash[file[:path]] = file; hash }
+    files_by_name = result.each_with_object({}) { |file, hash| hash[file[:path]] = file; }
 
-    files_by_name.keys.sort { |a,b| b <=> a }.each do |path|
+    files_by_name.keys.sort { |a, b| b <=> a }.each do |path|
       dir = ::File.dirname(path)
       resource = files_by_name[dir]
       next unless resource
+
       if resource[:require]
         resource[:require] << Puppet::Resource.new(:file, path)
       else
@@ -325,7 +328,7 @@ Puppet::Type.newtype(:tidy) do
 
     basename = File.basename(path)
     flags = File::FNM_DOTMATCH | File::FNM_PATHNAME
-    if self[:matches].find {|pattern| File.fnmatch(pattern, basename, flags) }
+    if self[:matches].find { |pattern| File.fnmatch(pattern, basename, flags) }
       return true
     else
       debug "No specified patterns match #{path}, not tidying"
@@ -342,23 +345,25 @@ Puppet::Type.newtype(:tidy) do
     stat = self.stat(path)
     return false unless stat
 
-    return false if stat.ftype == "directory" and ! rmdirs?
+    return false if stat.ftype == "directory" and !rmdirs?
 
     # The 'matches' parameter isn't OR'ed with the other tests --
     # it's just used to reduce the list of files we can match.
     param = parameter(:matches)
-    return false if param && ! param.tidy?(path, stat)
+    return false if param && !param.tidy?(path, stat)
 
     tested = false
     [: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