openvox 7.37.1 → 8.19.0

data/lib/puppet/type/exec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Puppet
   Type.newtype(:exec) do
     include Puppet::Util::Execution
@@ -17,18 +19,18 @@ module Puppet
         during a noop Puppet run.
       * The exec has `refreshonly => true`, which allows Puppet to run the
         command only when some other resource is changed. (See the notes on refreshing
-        below.) 
-        
+        below.)
+
       The state managed by an `exec` resource represents whether the specified command
       _needs to be_ executed during the catalog run. The target state is always that
       the command does not need to be executed. If the initial state is that the
       command _does_ need to be executed, then successfully executing the command
       transitions it to the target state.
-      
+
       The `unless`, `onlyif`, and `creates` properties check the initial state of the
       resource. If one or more of these properties is specified, the exec might not
       need to run. If the exec does not need to run, then the system is already in
-      the target state. In such cases, the exec is considered successful without 
+      the target state. In such cases, the exec is considered successful without
       actually executing its command.
 
       A caution: There's a widespread tendency to use collections of execs to
@@ -81,11 +83,9 @@ 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
-      end
+      munge(&:to_s)
 
       def event_name
         :executed_command
@@ -94,6 +94,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.
@@ -128,31 +129,32 @@ module Puppet
         # value, which causes us to be treated as in_sync?, which means we
         # don't actually execute anything.  I think. --daniel 2011-03-10
         if @resource.check_all_attributes
-          return :notrun
+          :notrun
         else
-          return self.should
+          should
         end
       end
 
       # Actually execute the command.
       def sync
         event = :executed_command
-        tries = self.resource[:tries]
-        try_sleep = self.resource[:try_sleep]
+        tries = resource[:tries]
+        try_sleep = resource[:try_sleep]
 
         begin
           tries.times do |try|
             # Only add debug messages for tries > 1 to reduce log spam.
-            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)
+            debug("Exec try #{try + 1}/#{tries}") if tries > 1
+            @output, @status = provider.run(resource[:command])
+            break if should.include?(@status.exitstatus.to_s)
+
             if try_sleep > 0 and tries > 1
               debug("Sleeping for #{try_sleep} seconds between tries")
               sleep try_sleep
             end
           end
-        rescue Timeout::Error
-          self.fail Puppet::Error, _("Command exceeded timeout"), $!
+        rescue Timeout::Error => e
+          self.fail Puppet::Error, _("Command exceeded timeout"), e
         end
 
         log = @resource[:logoutput]
@@ -161,29 +163,29 @@ module Puppet
           when :true
             log = @resource[:loglevel]
           when :on_failure
-            unless self.should.include?(@status.exitstatus.to_s)
-              log = @resource[:loglevel]
-            else
+            if should.include?(@status.exitstatus.to_s)
               log = :false
+            else
+              log = @resource[:loglevel]
             end
           end
           unless log == :false
             if @resource.parameter(:command).sensitive
-              self.send(log, "[output redacted]")
+              send(log, "[output redacted]")
             else
               @output.split(/\n/).each { |line|
-                self.send(log, line)
+                send(log, line)
               }
             end
           end
         end
 
-        unless self.should.include?(@status.exitstatus.to_s)
+        unless should.include?(@status.exitstatus.to_s)
           if @resource.parameter(:command).sensitive
             # Don't print sensitive commands in the clear
-            self.fail(_("[command redacted] returned %{status} instead of one of [%{expected}]") % { status: @status.exitstatus, expected: self.should.join(",") })
+            self.fail(_("[command redacted] returned %{status} instead of one of [%{expected}]") % { status: @status.exitstatus, expected: should.join(",") })
           else
-            self.fail(_("'%{cmd}' returned %{status} instead of one of [%{expected}]") % { cmd: self.resource[:command], status: @status.exitstatus, expected: self.should.join(",") })
+            self.fail(_("'%{cmd}' returned %{status} instead of one of [%{expected}]") % { cmd: resource[:command], status: @status.exitstatus, expected: should.join(",") })
           end
         end
 
@@ -332,8 +334,8 @@ module Puppet
         value = value.shift if value.is_a?(Array)
         begin
           value = Float(value)
-        rescue ArgumentError
-          raise ArgumentError, _("The timeout must be a number."), $!.backtrace
+        rescue ArgumentError => e
+          raise ArgumentError, _("The timeout must be a number."), e.backtrace
         end
         [value, 0.0].max
       end
@@ -349,12 +351,14 @@ module Puppet
 
       munge do |value|
         if value.is_a?(String)
-          unless value =~ /^[\d]+$/
+          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
 
@@ -369,16 +373,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
@@ -408,11 +413,7 @@ module Puppet
       # on refresh.
       def check(value)
         # We have to invert the values.
-        if value == :true
-          false
-        else
-          true
-        end
+        value != :true
       end
     end
 
@@ -435,6 +436,13 @@ module Puppet
         back by re-extracting the tarball. If `important.tar` does **not**
         actually contain `myfile`, the exec will keep running every time
         Puppet runs.
+
+        This parameter can also take an array of files, and the command will
+        not run if **any** of these files exist. Consider this example:
+
+            creates => ['/tmp/file1', '/tmp/file2'],
+
+        The command is only run if both files don't exist.
       EOT
 
       accept_arrays
@@ -442,9 +450,9 @@ 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)
+        !Puppet::FileSystem.exist?(value)
       end
     end
 
@@ -500,10 +508,10 @@ module Puppet
         end
 
         if sensitive
-          self.debug("[output redacted]")
+          debug("[output redacted]")
         else
           output.split(/\n/).each { |line|
-            self.debug(line)
+            debug(line)
           }
         end
 
@@ -563,10 +571,10 @@ module Puppet
         end
 
         if sensitive
-          self.debug("[output redacted]")
+          debug("[output redacted]")
         else
           output.split(/\n/).each { |line|
-            self.debug(line)
+            debug(line)
           }
         end
 
@@ -593,7 +601,7 @@ module Puppet
       cmd = cmd[0] if cmd.is_a? Array
 
       if cmd.is_a?(Puppet::Pops::Evaluator::DeferredValue)
-        self.debug("The 'command' parameter is deferred and cannot be autorequired")
+        debug("The 'command' parameter is deferred and cannot be autorequired")
       else
         cmd.scan(file_regex) { |str|
           reqs << str
@@ -618,7 +626,7 @@ module Puppet
           # to do.
           line = line[0] if line.is_a? Array
           if line.is_a?(Puppet::Pops::Evaluator::DeferredValue)
-            self.debug("The '#{param}' parameter is deferred and cannot be autorequired")
+            debug("The '#{param}' parameter is deferred and cannot be autorequired")
           else
             reqs += line.scan(file_regex)
           end
@@ -649,20 +657,21 @@ 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
-          val.each do |value|
-            if !@parameters[check].check(value)
-              # Give a debug message so users can figure out what command would have been
-              # but don't print sensitive commands or parameters in the clear
-              cmdstring = @parameters[:command].sensitive ? "[command redacted]" : @parameters[:command].value
-
-              debug(_("'%{cmd}' won't be executed because of failed check '%{check}'") % { cmd: cmdstring, check: check })
-
-              return false
-            end
-          end
+
+        next unless @parameters.include?(check)
+
+        val = @parameters[check].value
+        val = [val] unless val.is_a? Array
+        val.each do |value|
+          next if @parameters[check].check(value)
+
+          # Give a debug message so users can figure out what command would have been
+          # but don't print sensitive commands or parameters in the clear
+          cmdstring = @parameters[:command].sensitive ? "[command redacted]" : @parameters[:command].value
+
+          debug(_("'%{cmd}' won't be executed because of failed check '%{check}'") % { cmd: cmdstring, check: check })
+
+          return false
         end
       }
 
@@ -670,21 +679,21 @@ module Puppet
     end
 
     def output
-      if self.property(:returns).nil?
-        return nil
+      if property(:returns).nil?
+        nil
       else
-        return self.property(:returns).output
+        property(:returns).output
       end
     end
 
     # Run the command, or optionally run a separately-specified command.
     def refresh
-      if self.check_all_attributes(true)
+      if check_all_attributes(true)
         cmd = self[:refresh]
         if cmd
           provider.run(cmd)
         else
-          self.property(:returns).sync
+          property(:returns).sync
         end
       end
     end
@@ -694,6 +703,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,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../../puppet/util/checksums'
 
 # Specify which checksum algorithm to use when checksumming
@@ -5,11 +7,13 @@ require_relative '../../../puppet/util/checksums'
 Puppet::Type.type(:file).newparam(:checksum) do
   include Puppet::Util::Checksums
 
+  # The default is defined in Puppet.default_digest_algorithm
   desc "The checksum type to use when determining whether to replace a file's contents.
 
-    The default checksum type is #{Puppet.default_digest_algorithm}."
+    The default checksum type is sha256."
 
-  newvalues(*Puppet::Util::Checksums.known_checksum_types)
+  # The values are defined in Puppet::Util::Checksums.known_checksum_types
+  newvalues(:sha256, :sha256lite, :md5, :md5lite, :sha1, :sha1lite, :sha512, :sha384, :sha224, :mtime, :ctime, :none)
 
   defaultto do
     Puppet[:digest_algorithm].to_sym

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../../puppet/util/checksums'
 require_relative '../../../puppet/type/file/data_sync'
 
@@ -7,7 +9,7 @@ module Puppet
     include Puppet::DataSync
 
     desc "The checksum of the source contents. Only md5, sha256, sha224, sha384 and sha512
-      are supported when specifying this parameter. If this parameter is set, 
+      are supported when specifying this parameter. If this parameter is set,
       source_permissions will be assumed to be false, and ownership and permissions
       will not be read from source."
 
@@ -18,12 +20,13 @@ 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)
+
+      date_matches?(resource.parameter(:checksum).value, current, desired)
     end
 
     def retrieve
@@ -49,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,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'uri'
 require 'tempfile'
 
 require_relative '../../../puppet/util/checksums'
-require_relative '../../../puppet/type/file/data_sync.rb'
+require_relative '../../../puppet/type/file/data_sync'
 
 module Puppet
   Puppet::Type.type(:file).newproperty(:content) do
@@ -49,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
@@ -71,17 +73,17 @@ module Puppet
     # Checksums need to invert how changes are printed.
     def change_to_s(currentvalue, newvalue)
       # Our "new" checksum value is provided by the source.
-      source = resource.parameter(:source) 
+      source = resource.parameter(:source)
       tmp = source.checksum if source
       if tmp
         newvalue = tmp
       end
       if currentvalue == :absent
-        return "defined content as '#{newvalue}'"
+        "defined content as '#{newvalue}'"
       elsif newvalue == :absent
-        return "undefined content from '#{currentvalue}'"
+        "undefined content from '#{currentvalue}'"
       else
-        return "content changed '#{currentvalue}' to '#{newvalue}'"
+        "content changed '#{currentvalue}' to '#{newvalue}'"
       end
     end
 
@@ -90,7 +92,7 @@ module Puppet
     end
 
     def content
-      self.should
+      should
     end
 
     # Override this method to provide diffs if asked for.
@@ -103,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)
@@ -116,7 +118,8 @@ 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)
+
+      date_matches?(checksum_type, current, desired)
     end
 
     def retrieve
@@ -166,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,8 +1,10 @@
+# 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
+    desc "A read-only state to check the file ctime. On most modern \*nix-like
       systems, this is the time of the most recent change to the owner, group,
-      permissions, or content of the file.}
+      permissions, or content of the file."
 
     def retrieve
       current_value = :absent
@@ -13,9 +15,8 @@ module Puppet
       current_value.to_s
     end
 
-    validate do |val|
+    validate do |_val|
       fail "ctime is read-only"
     end
   end
 end
-

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../../puppet/util/checksums'
 require_relative '../../../puppet/util/diff'
 require 'date'
@@ -27,13 +29,13 @@ 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
-          resource.warning _("Ensure set to :present but file type is %{file_type} so no content will be synced") % { file_type: s.ftype}
+          # 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
       end
 
-      return true if ! resource.replace?
+      return true unless resource.replace?
 
       is_insync = yield(is)
 
@@ -59,12 +61,13 @@ module Puppet
 
     def date_matches?(checksum_type, current, desired)
       time_types = [:mtime, :ctime]
-      return false if !time_types.include?(checksum_type)
+      return false unless time_types.include?(checksum_type)
       return false unless current && desired
 
       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
@@ -77,9 +80,10 @@ 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)
+      return nil if %w[directory link fifo socket].include?(ftype)
 
       begin
         resource.parameter(:checksum).sum_file(resource[:path])
@@ -93,6 +97,5 @@ module Puppet
       resource.write(param)
       return_event
     end
-
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Puppet
   Puppet::Type.type(:file).ensurable do
@@ -71,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.
@@ -83,11 +84,11 @@ 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
-          Dir.mkdir(@resource[:path], symbolic_mode_to_int(mode, 0755, true))
+        Puppet::Util.withumask(0o00) do
+          Dir.mkdir(@resource[:path], symbolic_mode_to_int(mode, 0o755, true))
         end
       else
         Dir.mkdir(@resource[:path])
@@ -96,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
@@ -112,7 +113,10 @@ module Puppet
 
     munge do |value|
       value = super(value)
-      value,resource[:target] = :link,value unless value.is_a? Symbol
+      unless value.is_a? Symbol
+        resource[:target] = value
+        value = :link
+      end
       resource[:links] = :manage if value == :link and resource[:links] != :follow
       value
     end
@@ -144,12 +148,12 @@ module Puppet
     def check
       basedir = File.dirname(@resource[:path])
 
-      if ! Puppet::FileSystem.exist?(basedir)
+      if !Puppet::FileSystem.exist?(basedir)
         raise Puppet::Error,
-          "Can not create #{@resource.title}; parent directory does not exist"
-      elsif ! FileTest.directory?(basedir)
+              "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
 
@@ -160,36 +164,31 @@ module Puppet
         return true
       end
 
-      if self.should == :present
-        return !(currentvalue.nil? or currentvalue == :absent)
+      if should == :present
+        !(currentvalue.nil? or currentvalue == :absent)
       else
-        return super(currentvalue)
+        super(currentvalue)
       end
     end
 
     def retrieve
       stat = @resource.stat
       if stat
-        return stat.ftype.intern
+        stat.ftype.intern
+      elsif should == :false
+        :false
       else
-        if self.should == :false
-          return :false
-        else
-          return :absent
-        end
+        :absent
       end
     end
 
     def sync
-      @resource.remove_existing(self.should)
-      if self.should == :absent
+      @resource.remove_existing(should)
+      if should == :absent
         return :file_removed
       end
 
-      event = super
-
-      event
+      super
     end
   end
 end
-