puppet 8.3.1 → 8.4.0

data/lib/puppet/type/exec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet
   Type.newtype(:exec) do
     include Puppet::Util::Execution
@@ -82,7 +83,7 @@ module Puppet
       @checks.keys
     end
 
-    newproperty(:returns, :array_matching => :all, :event => :executed_command) do |property|
+    newproperty(:returns, :array_matching => :all, :event => :executed_command) do |_property|
       include Puppet::Util::Execution
       munge do |value|
         value.to_s
@@ -95,6 +96,7 @@ module Puppet
       defaultto "0"
 
       attr_reader :output
+
       desc "The expected exit code(s).  An error will be returned if the
         executed command has some other exit code. Can be specified as an array
         of acceptable exit codes or a single value.
@@ -147,6 +149,7 @@ module Puppet
             debug("Exec try #{try+1}/#{tries}") if tries > 1
             @output, @status = provider.run(self.resource[:command])
             break if self.should.include?(@status.exitstatus.to_s)
+
             if try_sleep > 0 and tries > 1
               debug("Sleeping for #{try_sleep} seconds between tries")
               sleep try_sleep
@@ -353,9 +356,11 @@ module Puppet
           unless value =~ /^[\d]+$/
             raise ArgumentError, _("Tries must be an integer")
           end
+
           value = Integer(value)
         end
         raise ArgumentError, _("Tries must be an integer >= 1") if value < 1
+
         value
       end
 
@@ -370,16 +375,17 @@ module Puppet
           unless value =~ /^[-\d.]+$/
             raise ArgumentError, _("try_sleep must be a number")
           end
+
           value = Float(value)
         end
         raise ArgumentError, _("try_sleep cannot be a negative number") if value < 0
+
         value
       end
 
       defaultto 0
     end
 
-
     newcheck(:refreshonly) do
       desc <<-'EOT'
         The command should only be run as a
@@ -443,7 +449,7 @@ module Puppet
       # If the file exists, return false (i.e., don't run the command),
       # else return true
       def check(value)
-        #TRANSLATORS 'creates' is a parameter name and should not be translated
+        # TRANSLATORS 'creates' is a parameter name and should not be translated
         debug(_("Checking that 'creates' path '%{creates_path}' exists") % { creates_path: value })
         ! Puppet::FileSystem.exist?(value)
       end
@@ -593,13 +599,17 @@ module Puppet
       cmd = self[:command]
       cmd = cmd[0] if cmd.is_a? Array
 
-      cmd.scan(file_regex) { |str|
-        reqs << str
-      }
+      if cmd.is_a?(Puppet::Pops::Evaluator::DeferredValue)
+        self.debug("The 'command' parameter is deferred and cannot be autorequired")
+      else
+        cmd.scan(file_regex) { |str|
+          reqs << str
+        }
 
-      cmd.scan(/^"([^"]+)"/) { |str|
-        reqs << str
-      }
+        cmd.scan(/^"([^"]+)"/) { |str|
+          reqs << str
+        }
+      end
 
       [:onlyif, :unless].each { |param|
         tmp = self[param]
@@ -614,7 +624,11 @@ module Puppet
           # unqualified files, but, well, that's a bit more annoying
           # to do.
           line = line[0] if line.is_a? Array
-          reqs += line.scan(file_regex)
+          if line.is_a?(Puppet::Pops::Evaluator::DeferredValue)
+            self.debug("The '#{param}' parameter is deferred and cannot be autorequired")
+          else
+            reqs += line.scan(file_regex)
+          end
         end
       }
 
@@ -642,6 +656,7 @@ module Puppet
     def check_all_attributes(refreshing = false)
       self.class.checks.each { |check|
         next if refreshing and check == :refreshonly
+
         if @parameters.include?(check)
           val = @parameters[check].value
           val = [val] unless val.is_a? Array
@@ -687,6 +702,7 @@ module Puppet
     end
 
     private
+
     def set_sensitive_parameters(sensitive_parameters)
       # If any are sensitive, mark all as sensitive
       sensitive = false

data/lib/puppet/type/file/checksum.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../puppet/util/checksums'
 
 # Specify which checksum algorithm to use when checksumming

data/lib/puppet/type/file/checksum_value.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../puppet/util/checksums'
 require_relative '../../../puppet/type/file/data_sync'
 
@@ -19,11 +20,12 @@ module Puppet
         return true
       end
 
-      checksum_insync?(resource.parameter(:source), is, true) {|_is| super(_is)}
+      checksum_insync?(resource.parameter(:source), is, true) {|inner| super(inner)}
     end
 
     def property_matches?(current, desired)
       return true if super(current, desired)
+
       return date_matches?(resource.parameter(:checksum).value, current, desired)
     end
 
@@ -50,6 +52,5 @@ module Puppet
       # so instruct the resource to write its contents.
       contents_sync(resource.parameter(:source))
     end
-
   end
 end

data/lib/puppet/type/file/content.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'net/http'
 require 'uri'
 require 'tempfile'
@@ -50,18 +51,18 @@ module Puppet
         # XXX This is potentially dangerous because it means users can't write a file whose
         # entire contents are a plain checksum unless it is a Binary content.
         Puppet.puppet_deprecation_warning([
-            #TRANSLATORS "content" is an attribute and should not be translated
-            _('Using a checksum in a file\'s "content" property is deprecated.'),
-            #TRANSLATORS "filebucket" is a resource type and should not be translated. The quoted occurrence of "content" is an attribute and should not be translated.
-            _('The ability to use a checksum to retrieve content from the filebucket using the "content" property will be removed in a future release.'),
-            #TRANSLATORS "content" is an attribute and should not be translated.
-            _('The literal value of the "content" property will be written to the file.'),
-            #TRANSLATORS "static catalogs" should not be translated.
-            _('The checksum retrieval functionality is being replaced by the use of static catalogs.'),
-            _('See https://puppet.com/docs/puppet/latest/static_catalogs.html for more information.')].join(" "),
-            :file => @resource.file,
-            :line => @resource.line
-        ) if !@actual_content && !resource.parameter(:source)
+          # TRANSLATORS "content" is an attribute and should not be translated
+          _('Using a checksum in a file\'s "content" property is deprecated.'),
+          # TRANSLATORS "filebucket" is a resource type and should not be translated. The quoted occurrence of "content" is an attribute and should not be translated.
+          _('The ability to use a checksum to retrieve content from the filebucket using the "content" property will be removed in a future release.'),
+          # TRANSLATORS "content" is an attribute and should not be translated.
+          _('The literal value of the "content" property will be written to the file.'),
+          # TRANSLATORS "static catalogs" should not be translated.
+          _('The checksum retrieval functionality is being replaced by the use of static catalogs.'),
+          _('See https://puppet.com/docs/puppet/latest/static_catalogs.html for more information.')].join(" "),
+                                          :file => @resource.file,
+                                          :line => @resource.line
+                                         ) if !@actual_content && !resource.parameter(:source)
         value
       else
         @actual_content = value.is_a?(Puppet::Pops::Types::PBinaryType::Binary) ? value.binary_buffer : value
@@ -104,7 +105,7 @@ module Puppet
       end
 
       contents_prop = resource.parameter(:source) || self
-      checksum_insync?(contents_prop, is, !resource[:content].nil?) {|_is| super(_is)}
+      checksum_insync?(contents_prop, is, !resource[:content].nil?) {|inner| super(inner)}
     end
 
     def property_matches?(current, desired)
@@ -117,6 +118,7 @@ module Puppet
 
       # The inherited equality is always accepted, so use it if valid.
       return true if super(current, desired)
+
       return date_matches?(checksum_type, current, desired)
     end
 
@@ -167,6 +169,7 @@ module Puppet
     def read_file_from_filebucket
       dipper = resource.bucket
       raise "Could not get filebucket from file" unless dipper
+
       sum = should.sub(/\{\w+\}/, '')
 
       dipper.getfile(sum)

data/lib/puppet/type/file/ctime.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet
   Puppet::Type.type(:file).newproperty(:ctime) do
     desc %q{A read-only state to check the file ctime. On most modern \*nix-like
@@ -14,7 +15,7 @@ module Puppet
       current_value.to_s
     end
 
-    validate do |val|
+    validate do |_val|
       fail "ctime is read-only"
     end
   end

data/lib/puppet/type/file/data_sync.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../puppet/util/checksums'
 require_relative '../../../puppet/util/diff'
 require 'date'
@@ -28,7 +29,7 @@ module Puppet
         return false if is == :absent
       else
         if resource[:ensure] == :present && has_contents && (s = resource.stat)
-          #TRANSLATORS 'Ensure' is an attribute and ':present' is a value and should not be translated
+          # TRANSLATORS 'Ensure' is an attribute and ':present' is a value and should not be translated
           resource.warning _("Ensure set to :present but file type is %{file_type} so no content will be synced") % { file_type: s.ftype}
         end
         return true
@@ -66,6 +67,7 @@ module Puppet
       begin
         if checksum?(current) || checksum?(desired)
           raise if !time_types.include?(sumtype(current).to_sym) || !time_types.include?(sumtype(desired).to_sym)
+
           current = sumdata(current)
           desired = sumdata(desired)
         end
@@ -78,6 +80,7 @@ module Puppet
     def retrieve_checksum(resource)
       stat = resource.stat
       return :absent unless stat
+
       ftype = stat.ftype
       # Don't even try to manage the content on directories or links
       return nil if ['directory', 'link', 'fifo', 'socket'].include?(ftype)
@@ -94,6 +97,5 @@ module Puppet
       resource.write(param)
       return_event
     end
-
   end
 end

data/lib/puppet/type/file/ensure.rb

@@ -72,7 +72,7 @@ module Puppet
       end
     end
 
-    #aliasvalue(:present, :file)
+    # aliasvalue(:present, :file)
     newvalue(:present, :event => :file_created) do
       # Make a file if they want something, but this will match almost
       # anything.
@@ -84,7 +84,7 @@ module Puppet
       parent = File.dirname(@resource[:path])
       unless Puppet::FileSystem.exist? parent
         raise Puppet::Error,
-          "Cannot create #{@resource[:path]}; parent directory #{parent} does not exist"
+              "Cannot create #{@resource[:path]}; parent directory #{parent} does not exist"
       end
       if mode
         Puppet::Util.withumask(000) do
@@ -97,10 +97,10 @@ module Puppet
       return :directory_created
     end
 
-
     newvalue(:link, :event => :link_created, :required_features => :manages_symlinks) do
       property = resource.property(:target)
       fail "Cannot create a symlink without a target" unless property
+
       property.retrieve
       property.mklink
     end
@@ -147,10 +147,10 @@ module Puppet
 
       if ! Puppet::FileSystem.exist?(basedir)
         raise Puppet::Error,
-          "Can not create #{@resource.title}; parent directory does not exist"
+              "Can not create #{@resource.title}; parent directory does not exist"
       elsif ! FileTest.directory?(basedir)
         raise Puppet::Error,
-          "Can not create #{@resource.title}; #{dirname} is not a directory"
+              "Can not create #{@resource.title}; #{dirname} is not a directory"
       end
     end
 

data/lib/puppet/type/file/group.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../puppet/util/posix'
 
 module Puppet
@@ -38,7 +39,7 @@ module Puppet
     end
 
     # We want to print names, not numbers
-    def is_to_s(currentvalue)
+    def is_to_s(currentvalue) # rubocop:disable Naming/PredicateName
       super(provider.gid2name(currentvalue) || currentvalue)
     end
 

data/lib/puppet/type/file/mode.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
+
 # Manage file modes.  This state should support different formats
 # for specification (e.g., u+rwx, or -0011), but for now only supports
 # specifying the full mode.
 
-
 module Puppet
   Puppet::Type.type(:file).newproperty(:mode) do
     require_relative '../../../puppet/util/symbolic_file_mode'
@@ -126,6 +126,7 @@ module Puppet
       if provider.respond_to?(:munge_windows_system_group)
         munged_mode = provider.munge_windows_system_group(currentvalue, @should)
         return false if munged_mode.nil?
+
         currentvalue = munged_mode
       end
       stat = @resource.stat
@@ -139,6 +140,7 @@ module Puppet
 
     def property_matches?(current, desired)
       return false unless current
+
       current_bits = normalize_symbolic_mode(current)
       desired_bits = desired_mode_from_current(desired, current).to_s(8)
       current_bits == desired_bits
@@ -177,7 +179,7 @@ module Puppet
       "'#{should_value.rjust(4, '0')}'"
     end
 
-    def is_to_s(currentvalue)
+    def is_to_s(currentvalue) # rubocop:disable Naming/PredicateName
       if currentvalue == :absent
         # This can occur during audits---if a file is transitioning from
         # present to absent the mode will have a value of `:absent`.

data/lib/puppet/type/file/mtime.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet
   Puppet::Type.type(:file).newproperty(:mtime) do
     desc %q{A read-only state to check the file mtime. On \*nix-like systems, this
@@ -13,7 +14,7 @@ module Puppet
       current_value.to_s
     end
 
-    validate do |val|
+    validate do |_val|
       fail "mtime is read-only"
     end
   end

data/lib/puppet/type/file/owner.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet
   Puppet::Type.type(:file).newproperty(:owner) do
     include Puppet::Util::Warnings
@@ -40,7 +41,7 @@ module Puppet
     end
 
     # We want to print names, not numbers
-    def is_to_s(currentvalue)
+    def is_to_s(currentvalue) # rubocop:disable Naming/PredicateName
       super(provider.uid2name(currentvalue) || currentvalue)
     end
 

data/lib/puppet/type/file/selcontext.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Manage SELinux context of files.
 #
 # This code actually manages three pieces of data in the context.
@@ -20,7 +21,6 @@
 #
 # See https://www.nsa.gov/selinux/ for complete docs on SELinux.
 
-
 module Puppet
   require_relative '../../../puppet/util/selinux'
 
@@ -29,6 +29,7 @@ module Puppet
 
     def retrieve
       return :absent unless @resource.stat
+
       context = self.get_selinux_current_context(@resource[:path])
       is = parse_selinux_context(name, context)
       if name == :selrange and selinux_support?
@@ -138,6 +139,5 @@ module Puppet
     @event = :file_changed
     defaultto { self.retrieve_default_context(:selrange) }
   end
-
 end
 

data/lib/puppet/type/file/source.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../puppet/file_serving/content'
 require_relative '../../../puppet/file_serving/metadata'
 require_relative '../../../puppet/file_serving/terminus_helper'
@@ -12,8 +13,8 @@ module Puppet
   # this state, during retrieval, modifies the appropriate other states
   # so that things get taken care of appropriately.
   Puppet::Type.type(:file).newparam(:source) do
-
     attr_accessor :source, :local
+
     desc <<-'EOT'
       A source file, which will be copied into place on the local system. This
       attribute is mutually exclusive with `content` and `target`. Allowed
@@ -186,13 +187,14 @@ module Puppet
       return @metadata if @metadata
 
       return nil unless value
+
       value.each do |source|
         begin
           options = {
-            :environment          => resource.catalog.environment_instance,
-            :links                => resource[:links],
-            :checksum_type        => resource[:checksum],
-            :source_permissions   => resource[:source_permissions]
+            :environment => resource.catalog.environment_instance,
+            :links => resource[:links],
+            :checksum_type => resource[:checksum],
+            :source_permissions => resource[:source_permissions]
           }
 
           data = Puppet::FileServing::Metadata.indirection.find(source, options)
@@ -218,7 +220,7 @@ module Puppet
     end
 
     def server?
-       uri && uri.host && !uri.host.empty?
+      uri && uri.host && !uri.host.empty?
     end
 
     def server
@@ -283,7 +285,7 @@ module Puppet
 
     def chunk_file_from_disk(local_path)
       File.open(local_path, "rb") do |src|
-        while chunk = src.read(8192) #rubocop:disable Lint/AssignmentInCondition
+        while chunk = src.read(8192) # rubocop:disable Lint/AssignmentInCondition
           yield chunk
         end
       end
@@ -367,14 +369,14 @@ module Puppet
 
     defaultto :ignore
     newvalues(:use, :use_when_creating, :ignore)
-     munge do |value|
+    munge do |value|
       value = value ? value.to_sym : :ignore
       if @resource.file && @resource.line && value != :ignore
-        #TRANSLATORS "source_permissions" is a parameter name and should not be translated
+        # TRANSLATORS "source_permissions" is a parameter name and should not be translated
         Puppet.puppet_deprecation_warning(_("The `source_permissions` parameter is deprecated. Explicitly set `owner`, `group`, and `mode`."), file: @resource.file, line: @resource.line)
       end
 
       value
-     end
+    end
   end
 end

data/lib/puppet/type/file/target.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet
   Puppet::Type.type(:file).newproperty(:target) do
     desc "The target for creating a link.  Currently, symlinks are the
@@ -27,7 +28,7 @@ module Puppet
       @resource[:ensure] = :link if ! @resource.should(:ensure)
 
       # Only call mklink if ensure didn't call us in the first place.
-      currentensure  = @resource.property(:ensure).retrieve
+      currentensure = @resource.property(:ensure).retrieve
       mklink if @resource.property(:ensure).safe_insync?(currentensure)
     end
 
@@ -71,7 +72,6 @@ module Puppet
       end
     end
 
-
     def retrieve
       stat = @resource.stat
       if stat

data/lib/puppet/type/file/type.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet
   Puppet::Type.type(:file).newproperty(:type) do
     require 'etc'
@@ -13,7 +14,7 @@ module Puppet
       current_value
     end
 
-    validate do |val|
+    validate do |_val|
       fail "type is read-only"
     end
   end