puppet 6.0.5-x64-mingw32 → 8.8.1-x64-mingw32

data/lib/puppet/util/command_line.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 # Bundler and rubygems maintain a set of directories from which to
 # load gems. If Bundler is loaded, let it determine what can be
 # loaded. If it's not loaded, then use rubygems. But do this before
 # loading any puppet code, so that our gem loading system is sane.
-if not defined? ::Bundler
+unless defined? ::Bundler
   begin
     require 'rubygems'
   rescue LoadError
   end
 end
 
-require 'puppet'
-require 'puppet/util'
-require "puppet/util/rubygems"
-require "puppet/util/limits"
-require 'puppet/util/colors'
-require 'puppet/gettext/module_translations'
+require_relative '../../puppet'
+require_relative '../../puppet/util'
+require_relative '../../puppet/util/rubygems'
+require_relative '../../puppet/util/limits'
+require_relative '../../puppet/util/colors'
+require_relative '../../puppet/gettext/module_translations'
 
 module Puppet
   module Util
@@ -29,7 +31,7 @@ module Puppet
       # @param zero [String] the name of the executable
       # @param argv [Array<String>] the arguments passed on the command line
       # @param stdin [IO] (unused)
-      def initialize(zero = $0, argv = ARGV, stdin = STDIN)
+      def initialize(zero = $PROGRAM_NAME, argv = ARGV, stdin = STDIN)
         @command = File.basename(zero, '.rb')
         @argv = argv
       end
@@ -54,7 +56,7 @@ module Puppet
         if subcommand_name.nil?
           @argv
         else
-          @argv[1..-1]
+          @argv[1..]
         end
       end
 
@@ -64,8 +66,12 @@ module Puppet
       #
       # @return [void]
       def execute
+        require_config = true
+        if @argv.first =~ /help|-h|--help|-V|--version/
+          require_config = false
+        end
         Puppet::Util.exit_on_fail(_("Could not initialize global default settings")) do
-          Puppet.initialize_settings(args)
+          Puppet.initialize_settings(args, require_config)
         end
 
         setpriority(Puppet[:priority])
@@ -89,10 +95,13 @@ module Puppet
           end
         elsif Puppet::Application.available_application_names.include?(subcommand_name)
           ApplicationSubcommand.new(subcommand_name, self)
-        elsif path_to_subcommand = external_subcommand
-          ExternalSubcommand.new(path_to_subcommand, self)
         else
-          UnknownSubcommand.new(subcommand_name, self)
+          path_to_subcommand = external_subcommand
+          if path_to_subcommand
+            ExternalSubcommand.new(path_to_subcommand, self)
+          else
+            UnknownSubcommand.new(subcommand_name, self)
+          end
         end
       end
 
@@ -117,7 +126,8 @@ module Puppet
           # If we cannot find the configured environment, which may not exist,
           # we do not attempt to add plugin directories to the load path.
           unless @subcommand_name == 'master' || @subcommand_name == 'agent' || (@subcommand_name == 'device' && (['--apply', '--facts', '--resource'] - @command_line.args).empty?)
-            if configured_environment = Puppet.lookup(:environments).get(Puppet[:environment])
+            configured_environment = Puppet.lookup(:environments).get(Puppet[:environment])
+            if configured_environment
               configured_environment.each_plugin_directory do |dir|
                 $LOAD_PATH << dir unless $LOAD_PATH.include?(dir)
               end
@@ -127,7 +137,7 @@ module Puppet
 
               # Puppet requires Facter, which initializes its lookup paths. Reset Facter to
               # pickup the new $LOAD_PATH.
-              Facter.reset
+              Puppet.runtime[:facter].reset
             end
           end
 

data/lib/puppet/util/constant_inflector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Created on 2008-02-12
 # Copyright Luke Kanies
 
@@ -6,17 +8,16 @@
 # A common module for converting between constants and
 # file names.
 
-
 module Puppet
   module Util
     module ConstantInflector
       def file2constant(file)
-        file.split("/").collect { |name| name.capitalize }.join("::").gsub(/_+(.)/) { |term| $1.capitalize }
+        file.split("/").collect(&:capitalize).join("::").gsub(/_+(.)/) { |_term| ::Regexp.last_match(1).capitalize }
       end
       module_function :file2constant
 
       def constant2file(constant)
-        constant.to_s.gsub(/([a-z])([A-Z])/) { |term| $1 + "_#{$2}" }.gsub("::", "/").downcase
+        constant.to_s.gsub(/([a-z])([A-Z])/) { |_term| ::Regexp.last_match(1) + "_#{::Regexp.last_match(2)}" }.gsub("::", "/").downcase
       end
       module_function :constant2file
     end

data/lib/puppet/util/diff.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tempfile'
 
 # Provide a diff between two strings.
@@ -6,11 +8,13 @@ module Puppet::Util::Diff
   require 'tempfile'
 
   def diff(old, new)
-    return '' unless diff_cmd = Puppet[:diff] and diff_cmd != ""
+    diff_cmd = Puppet[:diff]
+    return '' unless diff_cmd && diff_cmd != ""
 
     command = [diff_cmd]
-    if args = Puppet[:diff_args] and args != ""
-      args.split(' ').each do|arg|
+    args = Puppet[:diff_args]
+    if args && args != ""
+      args.split(' ').each do |arg|
         command << arg
       end
     end
@@ -23,15 +27,15 @@ module Puppet::Util::Diff
   # return diff string of two input strings
   # format defaults to unified
   # context defaults to 3 lines
-  def lcs_diff(data_old, data_new, format=:unified, context_lines=3)
+  def lcs_diff(data_old, data_new, format = :unified, context_lines = 3)
     unless Puppet.features.diff?
       Puppet.warning _("Cannot provide diff without the diff/lcs Ruby library")
       return ""
     end
-    data_old = data_old.split(/\n/).map! { |e| e.chomp }
-    data_new = data_new.split(/\n/).map! { |e| e.chomp }
+    data_old = data_old.split(/\n/).map!(&:chomp)
+    data_new = data_new.split(/\n/).map!(&:chomp)
 
-    output = ""
+    output = ''.dup
 
     diffs = ::Diff::LCS.diff(data_old, data_new)
     return output if diffs.empty?
@@ -40,15 +44,14 @@ module Puppet::Util::Diff
     file_length_difference = 0
 
     diffs.each do |piece|
-      begin
-
-        hunk = ::Diff::LCS::Hunk.new(
-          data_old, data_new, piece,
-            context_lines,
-
-            file_length_difference)
-        file_length_difference = hunk.file_length_difference
+      hunk = ::Diff::LCS::Hunk.new(
+        data_old, data_new, piece,
+        context_lines,
+        file_length_difference
+      )
+      file_length_difference = hunk.file_length_difference
       next unless oldhunk
+
       # Hunks may overlap, which is why we need to be careful when our
       # diff includes lines of context. Otherwise, we might print
       # redundant lines.
@@ -57,10 +60,9 @@ module Puppet::Util::Diff
       else
         output << oldhunk.diff(format)
       end
-      ensure
-        oldhunk = hunk
-        output << "\n"
-      end
+    ensure
+      oldhunk = hunk
+      output << "\n"
     end
 
     # Handle the last remaining hunk
@@ -76,4 +78,3 @@ module Puppet::Util::Diff
     tempfile.delete
   end
 end
-

data/lib/puppet/util/docs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Some simple methods for helping manage automatic documentation generation.
 module Puppet::Util::Docs
   # Specify the actual doc string.
@@ -18,9 +20,9 @@ module Puppet::Util::Docs
 
   # Generate the full doc string.
   def doc
-    extra = methods.find_all { |m| m.to_s =~ /^dochook_.+/ }.sort.collect { |m|
-      self.send(m)
-    }.delete_if {|r| r.nil? }.collect {|r| "* #{r}"}.join("\n")
+    extra = methods.find_all { |m| m.to_s =~ /^dochook_.+/ }.sort.filter_map { |m|
+      send(m)
+    }.collect { |r| "* #{r}" }.join("\n")
 
     if @doc
       scrub(@doc) + (extra.empty? ? '' : "\n\n#{extra}")
@@ -65,6 +67,7 @@ module Puppet::Util::Docs
 
   # There is nothing that would ever set this. It gets read in reference/type.rb, but will never have any value but nil.
   attr_reader :nodoc
+
   def nodoc?
     nodoc
   end
@@ -114,6 +117,7 @@ module Puppet::Util::Docs
   def scrub(text)
     # One-liners are easy! (One-liners may be buffered with extra newlines.)
     return text.strip if text.strip !~ /\n/
+
     excluding_first_line = text.partition("\n").last
     indent = excluding_first_line.scan(/^[ \t]*(?=\S)/).min || '' # prevent nil
     # Clean hanging indent, if any
@@ -121,7 +125,7 @@ module Puppet::Util::Docs
       text = text.gsub(/^#{indent}/, '')
     end
     # Clean trailing space
-    text.lines.map{|line|line.rstrip}.join("\n").rstrip
+    text.lines.map(&:rstrip).join("\n").rstrip
   end
 
   module_function :scrub

data/lib/puppet/util/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Some helper methods for throwing and populating errors.
 #
 # @api public
@@ -20,8 +22,8 @@ module Puppet::Util::Errors
   # @param other [Exception] original exception, source of backtrace info
   # @return [Exception] error parameter
   def adderrorcontext(error, other = nil)
-    error.line ||= self.line if error.respond_to?(:line=) and self.respond_to?(:line) and self.line
-    error.file ||= self.file if error.respond_to?(:file=) and self.respond_to?(:file) and self.file
+    error.line ||= line if error.respond_to?(:line=) and respond_to?(:line) and line
+    error.file ||= file if error.respond_to?(:file=) and respond_to?(:file) and file
     error.original ||= other if error.respond_to?(:original=)
 
     error.set_backtrace(other.backtrace) if other and other.respond_to?(:backtrace)
@@ -39,10 +41,10 @@ module Puppet::Util::Errors
   # @param column [String] the column number for the error (nil or "",  for not known)
   # @return [String] description of file, line, and column
   #
-  def self.error_location(file, line=nil, column=nil)
-    file = nil if (file.is_a?(String) && file.empty?)
-    line = nil if (line.is_a?(String) && line.empty?)
-    column = nil if (column.is_a?(String) && column.empty?)
+  def self.error_location(file, line = nil, column = nil)
+    file = nil if file.is_a?(String) && file.empty?
+    line = nil if line.is_a?(String) && line.empty?
+    column = nil if column.is_a?(String) && column.empty?
     if file and line and column
       _("(file: %{file}, line: %{line}, column: %{column})") % { file: file, line: line, column: column }
     elsif file and line
@@ -67,7 +69,7 @@ module Puppet::Util::Errors
   # @param column [String] the column number for the error (nil or "",  for not known)
   # @return [String] description of file, line, and column
   #
-  def self.error_location_with_space(file, line=nil, column=nil)
+  def self.error_location_with_space(file, line = nil, column = nil)
     error_location_str = error_location(file, line, column)
     if error_location_str.empty?
       ''
@@ -83,10 +85,10 @@ module Puppet::Util::Errors
   # @param line [String] the line number for the error (nil or "", for not known)
   # @return [String] description of file, and line
   def self.error_location_with_unknowns(file, line)
-    file = nil if (file.is_a?(String) && file.empty?)
-    line = nil if (line.is_a?(String) && line.empty?)
-    file = _('unknown') unless file
-    line = _('unknown') unless line
+    file = nil if file.is_a?(String) && file.empty?
+    line = nil if line.is_a?(String) && line.empty?
+    file ||= _('unknown')
+    line ||= _('unknown')
     error_location(file, line)
   end
 

data/lib/puppet/util/execution.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'timeout'
-require 'puppet/file_system/uniquefile'
+require_relative '../../puppet/file_system/uniquefile'
 
 module Puppet
   require 'rbconfig'
 
-  require 'puppet/error'
+  require_relative '../../puppet/error'
   # A command failed to execute.
   # @api public
   class ExecutionFailure < Puppet::Error
@@ -15,7 +17,6 @@ end
 # in classes that needs to execute system commands.
 # @api public
 module Puppet::Util::Execution
-
   # This is the full output from a process. The object itself (a String) is the
   # stdout of the process.
   #
@@ -26,7 +27,7 @@ module Puppet::Util::Execution
     attr_reader :exitstatus
 
     # @api private
-    def initialize(value,exitstatus)
+    def initialize(value, exitstatus)
       super(value)
       @exitstatus = exitstatus
     end
@@ -68,16 +69,17 @@ module Puppet::Util::Execution
     if respond_to? :debug
       debug "Executing '#{command_str}'"
     else
-      Puppet.debug "Executing '#{command_str}'"
+      Puppet.debug { "Executing '#{command_str}'" }
     end
 
     # force the run of the command with
     # the user/system locale to "C" (via environment variables LANG and LC_*)
     # it enables to have non localized output for some commands and therefore
     # a predictable output
-    english_env = ENV.to_hash.merge( {'LANG' => 'C', 'LC_ALL' => 'C'} )
+    english_env = ENV.to_hash.merge({ 'LANG' => 'C', 'LC_ALL' => 'C' })
     output = Puppet::Util.withenv(english_env) do
-      open("| #{command_str} 2>&1") do |pipe|
+      # We are intentionally using 'pipe' with open to launch a process
+      open("| #{command_str} 2>&1") do |pipe| # rubocop:disable Security/Open
         yield pipe
       end
     end
@@ -94,17 +96,6 @@ module Puppet::Util::Execution
   end
   private_class_method :exitstatus
 
-  # Wraps execution of {execute} with mapping of exception to given exception (and output as argument).
-  # @raise [exception] under same conditions as {execute}, but raises the given `exception` with the output as argument
-  # @return (see execute)
-  # @api public
-  # @deprecated
-  def self.execfail(command, exception)
-    execute(command)
-  rescue Puppet::ExecutionFailure => detail
-    raise exception, detail.message, detail.backtrace
-  end
-
   # Default empty options for {execute}
   NoOptionsSpecified = {}
 
@@ -148,30 +139,32 @@ module Puppet::Util::Execution
     # specifying these here rather than in the method signature to allow callers to pass in a partial
     # set of overrides without affecting the default values for options that they don't pass in
     default_options = {
-        :failonfail => NoOptionsSpecified.equal?(options),
-        :uid => nil,
-        :gid => nil,
-        :combine => NoOptionsSpecified.equal?(options),
-        :stdinfile => nil,
-        :squelch => false,
-        :override_locale => true,
-        :custom_environment => {},
-        :sensitive => false,
-        :suppress_window => false,
+      :failonfail => NoOptionsSpecified.equal?(options),
+      :uid => nil,
+      :gid => nil,
+      :combine => NoOptionsSpecified.equal?(options),
+      :stdinfile => nil,
+      :squelch => false,
+      :override_locale => true,
+      :custom_environment => {},
+      :sensitive => false,
+      :suppress_window => false,
     }
 
     options = default_options.merge(options)
 
-    if options[:sensitive]
-      command_str = '[redacted]'
-    elsif command.is_a?(Array)
+    case command
+    when Array
       command = command.flatten.map(&:to_s)
       command_str = command.join(" ")
-    elsif command.is_a?(String)
+    when String
       command_str = command
     end
 
-    user_log_s = ''
+    # do this after processing 'command' array or string
+    command_str = '[redacted]' if options[:sensitive]
+
+    user_log_s = ''.dup
     if options[:uid]
       user_log_s << " uid=#{options[:uid]}"
     end
@@ -185,13 +178,13 @@ module Puppet::Util::Execution
     if respond_to? :debug
       debug "Executing#{user_log_s}: '#{command_str}'"
     else
-      Puppet.debug "Executing#{user_log_s}: '#{command_str}'"
+      Puppet.debug { "Executing#{user_log_s}: '#{command_str}'" }
     end
 
     null_file = Puppet::Util::Platform.windows? ? 'NUL' : '/dev/null'
 
     cwd = options[:cwd]
-    if cwd && ! Puppet::FileSystem.directory?(cwd)
+    if cwd && !Puppet::FileSystem.directory?(cwd)
       raise ArgumentError, _("Working directory %{cwd} does not exist!") % { cwd: cwd }
     end
 
@@ -211,27 +204,45 @@ module Puppet::Util::Execution
       stderr = options[:combine] ? stdout : Puppet::FileSystem.open(null_file, nil, 'w')
 
       exec_args = [command, options, stdin, stdout, stderr]
-      output = ''
+      output = ''.dup
 
       # We close stdin/stdout/stderr immediately after fork/exec as they're no longer needed by
       # this process. In most cases they could be closed later, but when `stdout` is the "writer"
       # pipe we must close it or we'll never reach eof on the `reader` pipe.
-      if execution_stub = Puppet::Util::ExecutionStub.current_value
+      execution_stub = Puppet::Util::ExecutionStub.current_value
+      if execution_stub
         child_pid = execution_stub.call(*exec_args)
-        [stdin, stdout, stderr].each {|io| io.close rescue nil}
+        [stdin, stdout, stderr].each { |io|
+          begin
+            io.close
+          rescue
+            nil
+          end
+        }
         return child_pid
       elsif Puppet.features.posix?
         child_pid = nil
         begin
           child_pid = execute_posix(*exec_args)
-          [stdin, stdout, stderr].each {|io| io.close rescue nil}
+          [stdin, stdout, stderr].each { |io|
+            begin
+              io.close
+            rescue
+              nil
+            end
+          }
           if options[:squelch]
             exit_status = Process.waitpid2(child_pid).last.exitstatus
           else
             # Use non-blocking read to check for data. After each attempt,
             # check whether the child is done. This is done in case the child
             # forks and inherits stdout, as happens in `foo &`.
-            until results = Process.waitpid2(child_pid, Process::WNOHANG)
+            # If we encounter EOF, though, then switch to a blocking wait for
+            # the child; after EOF, IO.select will never block and the loop
+            # below will use maximum CPU available.
+
+            wait_flags = Process::WNOHANG
+            until results = Process.waitpid2(child_pid, wait_flags) # rubocop:disable Lint/AssignmentInCondition
 
               # If not done, wait for data to read with a timeout
               # This timeout is selected to keep activity low while waiting on
@@ -242,6 +253,7 @@ module Puppet::Util::Execution
                 output << reader.read_nonblock(4096) if ready
               rescue Errno::EAGAIN
               rescue EOFError
+                wait_flags = 0
               end
             end
 
@@ -276,7 +288,13 @@ module Puppet::Util::Execution
       elsif Puppet::Util::Platform.windows?
         process_info = execute_windows(*exec_args)
         begin
-          [stdin, stderr].each {|io| io.close rescue nil}
+          [stdin, stderr].each { |io|
+            begin
+              io.close
+            rescue
+              nil
+            end
+          }
           exit_status = Puppet::Util::Windows::Process.wait_process(process_info.process_handle)
 
           # read output in if required
@@ -295,11 +313,17 @@ module Puppet::Util::Execution
       end
     ensure
       # Make sure all handles are closed in case an exception was thrown attempting to execute.
-      [stdin, stdout, stderr].each {|io| io.close rescue nil}
-      if !options[:squelch]
+      [stdin, stdout, stderr].each { |io|
+        begin
+          io.close
+        rescue
+          nil
+        end
+      }
+      unless options[:squelch]
         # if we opened a pipe, we need to clean it up.
         reader.close if reader
-        stdout.close! if Puppet::Util::Platform.windows?
+        stdout.close! if stdout && Puppet::Util::Platform.windows?
       end
     end
 
@@ -311,10 +335,10 @@ module Puppet::Util::Execution
   # @return [String] the path to the Ruby executable
   # @api private
   #
-  def self.ruby_path()
+  def self.ruby_path
     File.join(RbConfig::CONFIG['bindir'],
-              RbConfig::CONFIG['ruby_install_name'] + RbConfig::CONFIG['EXEEXT']).
-      sub(/.*\s.*/m, '"\&"')
+              RbConfig::CONFIG['ruby_install_name'] + RbConfig::CONFIG['EXEEXT'])
+        .sub(/.*\s.*/m, '"\&"')
   end
 
   # Because some modules provide their own version of this method.
@@ -322,13 +346,12 @@ module Puppet::Util::Execution
     alias util_execute execute
   end
 
-
   # This is private method.
   # @comment see call to private_class_method after method definition
   # @api private
   #
   def self.execute_posix(command, options, stdin, stdout, stderr)
-    child_pid = Puppet::Util.safe_posix_fork(stdin, stdout, stderr) do
+    Puppet::Util.safe_posix_fork(stdin, stdout, stderr) do
       # We can't just call Array(command), and rely on it returning
       # things like ['foo'], when passed ['foo'], because
       # Array(command) will call command.to_a internally, which when
@@ -346,7 +369,7 @@ module Puppet::Util::Execution
         Puppet::Util::SUIDManager.change_privileges(options[:uid], options[:gid], true)
 
         # if the caller has requested that we override locale environment variables,
-        if (options[:override_locale]) then
+        if options[:override_locale] then
           # loop over them and clear them
           Puppet::Util::POSIX::LOCALE_ENV_VARS.each { |name| ENV.delete(name) }
           # set LANG and LC_ALL to 'C' so that the command will have consistent, predictable output
@@ -372,28 +395,25 @@ module Puppet::Util::Execution
         exit!(1)
       end
     end
-    child_pid
   end
   private_class_method :execute_posix
 
-
   # This is private method.
   # @comment see call to private_class_method after method definition
   # @api private
   #
   def self.execute_windows(command, options, stdin, stdout, stderr)
     command = command.map do |part|
-      part.include?(' ') ? %Q["#{part.gsub(/"/, '\"')}"] : part
+      part.include?(' ') ? %Q("#{part.gsub(/"/, '\"')}") : part
     end.join(" ") if command.is_a?(Array)
 
     options[:custom_environment] ||= {}
-    Puppet::Util.withenv(options[:custom_environment], :windows) do
+    Puppet::Util.withenv(options[:custom_environment]) do
       Puppet::Util::Windows::Process.execute(command, options, stdin, stdout, stderr)
     end
   end
   private_class_method :execute_windows
 
-
   # This is private method.
   # @comment see call to private_class_method after method definition
   # @api private

data/lib/puppet/util/execution_stub.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Puppet::Util
   class ExecutionStub
     class << self