puppet 5.5.22 → 6.0.0

data/lib/puppet/util/autoload.rb

@@ -1,7 +1,6 @@
 require 'pathname'
 require 'puppet/util/rubygems'
 require 'puppet/util/warnings'
-require 'puppet/util/methodhelper'
 require 'puppet/pops/adaptable'
 
 # An adapter that ties the module_directories cache to the environment where the modules are parsed. This
@@ -10,20 +9,10 @@ require 'puppet/pops/adaptable'
 # @api private
 class Puppet::Util::ModuleDirectoriesAdapter < Puppet::Pops::Adaptable::Adapter
   attr_accessor :directories
-
-  def self.create_adapter(env)
-    adapter = super(env)
-    adapter.directories = env.modulepath.flat_map do |dir|
-      Dir.glob(File.join(dir, '*', 'lib'))
-    end
-    adapter
-  end
 end
 
 # Autoload paths, either based on names or all at once.
 class Puppet::Util::Autoload
-  include Puppet::Util::MethodHelper
-
   @loaded = {}
 
   class << self
@@ -46,19 +35,20 @@ class Puppet::Util::Autoload
     # Save the fact that a given path has been loaded.  This is so
     # we can load downloaded plugins if they've already been loaded
     # into memory.
+    # @api private
     def mark_loaded(name, file)
       name = cleanpath(name).chomp('.rb')
-      ruby_file = name + ".rb"
-      $LOADED_FEATURES << ruby_file unless $LOADED_FEATURES.include?(ruby_file)
+      file = File.expand_path(file)
+      $LOADED_FEATURES << file unless $LOADED_FEATURES.include?(file)
       loaded[name] = [file, File.mtime(file)]
     end
 
-    def changed?(name)
+    # @api private
+    def changed?(name, env)
       name = cleanpath(name).chomp('.rb')
       return true unless loaded.include?(name)
       file, old_mtime = loaded[name]
-      environment = Puppet.lookup(:current_environment)
-      return true unless file == get_file(name, environment)
+      return true unless file == get_file(name, env)
       begin
         old_mtime.to_i != File.mtime(file).to_i
       rescue Errno::ENOENT
@@ -84,7 +74,7 @@ class Puppet::Util::Autoload
       end
     end
 
-    def loadall(path, env = nil)
+    def loadall(path, env)
       # Load every instance of everything we can find.
       files_to_load(path, env).each do |file|
         name = file.chomp(".rb")
@@ -92,22 +82,28 @@ class Puppet::Util::Autoload
       end
     end
 
-    def reload_changed
-      loaded.keys.each { |file| load_file(file, nil) if changed?(file) }
+    def reload_changed(env)
+      loaded.keys.each do |file|
+        if changed?(file, env)
+          load_file(file, env)
+        end
+      end
     end
 
     # Get the correct file to load for a given path
     # returns nil if no file is found
+    # @api private
     def get_file(name, env)
       name = name + '.rb' unless name =~ /\.rb$/
       path = search_directories(env).find { |dir| Puppet::FileSystem.exist?(File.join(dir, name)) }
       path and File.join(path, name)
     end
 
-    def files_to_load(path, env = nil)
+    def files_to_load(path, env)
       search_directories(env).map {|dir| files_in_dir(dir, path) }.flatten.uniq
     end
 
+    # @api private
     def files_in_dir(dir, path)
       dir = Pathname.new(File.expand_path(dir))
       Dir.glob(File.join(dir, path, "*.rb")).collect do |file|
@@ -115,7 +111,39 @@ class Puppet::Util::Autoload
       end
     end
 
+    # @api private
     def module_directories(env)
+      raise ArgumentError, "Autoloader requires an environment" unless env
+
+      Puppet::Util::ModuleDirectoriesAdapter.adapt(env) do |a|
+        a.directories ||= env.modulepath.collect do |dir|
+          Dir.entries(dir).reject { |f| f =~ /^\./ }.collect { |f| File.join(dir, f, "lib") }
+        end.flatten.find_all do |d|
+          FileTest.directory?(d)
+        end
+      end.directories
+    end
+
+    # @api private
+    def vendored_modules
+      dir = Puppet[:vendormoduledir]
+      if dir && File.directory?(dir)
+        Dir.entries(dir)
+          .reject { |f| f =~ /^\./ }
+          .collect { |f| File.join(dir, f, "lib") }
+          .find_all { |d| FileTest.directory?(d) }
+      else
+        []
+      end
+    end
+
+    # @api private
+    def gem_directories
+      gem_source.directories
+    end
+
+    # @api private
+    def search_directories(env)
       # This is a little bit of a hack.  Basically, the autoloader is being
       # called indirectly during application bootstrapping when we do things
       # such as check "features".  However, during bootstrapping, we haven't
@@ -136,38 +164,17 @@ class Puppet::Util::Autoload
       # "app_defaults_initialized?" method on the main puppet Settings object.
       # --cprice 2012-03-16
       if Puppet.settings.app_defaults_initialized?
-        env ||= Puppet.lookup(:environments).get(Puppet[:environment])
-
-        if env
-          # if the app defaults have been initialized then it should be safe to access the module path setting.
-          Puppet::Util::ModuleDirectoriesAdapter.adapt(env).directories
-        else
-          []
+        unless @initialized
+          $LOAD_PATH.unshift(Puppet[:libdir])
+          $LOAD_PATH.concat(vendored_modules)
+          @initialized = true
         end
+        gem_directories + module_directories(env) + $LOAD_PATH
       else
-        # if we get here, the app defaults have not been initialized, so we basically use an empty module path.
-        []
-      end
-    end
-
-    def libdirs()
-      # See the comments in #module_directories above.  Basically, we need to be careful not to try to access the
-      # libdir before we know for sure that all of the settings have been initialized (e.g., during bootstrapping).
-      if (Puppet.settings.app_defaults_initialized?)
-        [Puppet[:libdir]]
-      else
-        []
+        gem_directories + $LOAD_PATH
       end
     end
 
-    def gem_directories
-      gem_source.directories
-    end
-
-    def search_directories(env)
-      [gem_directories, module_directories(env), libdirs(), $LOAD_PATH].flatten
-    end
-
     # Normalize a path. This converts ALT_SEPARATOR to SEPARATOR on Windows
     # and eliminates unnecessary parts of a path.
     def cleanpath(path)
@@ -184,15 +191,13 @@ class Puppet::Util::Autoload
 
   attr_accessor :object, :path
 
-  def initialize(obj, path, options = {})
+  def initialize(obj, path)
     @path = path.to_s
     raise ArgumentError, _("Autoload paths cannot be fully qualified") if Puppet::Util.absolute_path?(@path)
     @object = obj
-
-    set_options(options)
   end
 
-  def load(name, env = nil)
+  def load(name, env)
     self.class.load_file(expand(name), env)
   end
 
@@ -206,7 +211,7 @@ class Puppet::Util::Autoload
   #
   # This uses require, rather than load, so that already-loaded files don't get
   # reloaded unnecessarily.
-  def loadall(env = nil)
+  def loadall(env)
     self.class.loadall(@path, env)
   end
 
@@ -214,12 +219,13 @@ class Puppet::Util::Autoload
     self.class.loaded?(expand(name))
   end
 
-  def changed?(name)
-    self.class.changed?(expand(name))
+  # @api private
+  def changed?(name, env)
+    self.class.changed?(expand(name), env)
   end
 
-  def files_to_load
-    self.class.files_to_load(@path)
+  def files_to_load(env)
+    self.class.files_to_load(@path, env)
   end
 
   def expand(name)

data/lib/puppet/util/character_encoding.rb

@@ -72,27 +72,5 @@ module Puppet::Util::CharacterEncoding
         return string_copy.force_encoding(original_encoding)
       end
     end
-
-    REPLACEMENT_CHAR_MAP = {
-      Encoding::UTF_8 => "\uFFFD",
-      Encoding::UTF_16LE => "\xFD\xFF".force_encoding(Encoding::UTF_16LE),
-    }
-
-    # Given a string, return a copy of that string with any invalid byte
-    # sequences in its current encoding replaced with the replacement character
-    # "\uFFFD" (UTF-8) if the string is UTF-8 or UTF-16LE, or "?" otherwise.
-    # @param string a string to remove invalid byte sequences from
-    # @return a copy of string invalid byte sequences replaced by the unicode
-    #   replacement character or "?" character
-    # @note does not modify encoding, but new string will have different bytes
-    #   from original. Only needed for ruby 1.9.3 support.
-    def scrub(string)
-      if string.respond_to?(:scrub)
-        string.scrub
-      else
-        replacement_character = REPLACEMENT_CHAR_MAP[string.encoding] || '?'
-        string.chars.map { |c| c.valid_encoding? ? c : replacement_character }.join
-      end
-    end
   end
 end

data/lib/puppet/util/classgen.rb

@@ -1,5 +1,3 @@
-require 'puppet/util/methodhelper'
-
 module Puppet
   class ConstantAlreadyDefined < Error; end
   class SubclassAlreadyDefined < Error; end
@@ -9,7 +7,6 @@ end
 # @api public
 #
 module Puppet::Util::ClassGen
-  include Puppet::Util::MethodHelper
   include Puppet::Util
 
   # Create a new class.
@@ -66,7 +63,6 @@ module Puppet::Util::ClassGen
   # @return [Boolean] whether the class was removed or not
   #
   def rmclass(name, options)
-    options = symbolize_options(options)
     const = genconst_string(name, options)
     retval = false
     if is_constant_defined?(const)
@@ -100,8 +96,6 @@ module Puppet::Util::ClassGen
   # slightly abstract version of genclass.
   # @api private
   def genthing(name, type, options, block)
-    options = symbolize_options(options)
-
     name = name.to_s.downcase.intern
 
     if type == Module

data/lib/puppet/util/command_line.rb

@@ -64,12 +64,8 @@ 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, require_config)
+          Puppet.initialize_settings(args)
         end
 
         setpriority(Puppet[:priority])
@@ -110,7 +106,7 @@ module Puppet
         def run
           # For most applications, we want to be able to load code from the modulepath,
           # such as apply, describe, resource, and faces.
-          # For agent and device in agent mode, we only want to load pluginsync'ed code from libdir.
+          # For agent, we only want to load pluginsync'ed code from libdir.
           # For master, we shouldn't ever be loading per-environment code into the master's
           # ruby process, but that requires fixing (#17210, #12173, #8750). So for now
           # we try to restrict to only code that can be autoloaded from the node's
@@ -120,7 +116,8 @@ module Puppet
           # have an appropriate application-wide current_environment set.
           # 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 @subcommand_name != 'master' and @subcommand_name != 'agent'
             if configured_environment = Puppet.lookup(:environments).get(Puppet[:environment])
               configured_environment.each_plugin_directory do |dir|
                 $LOAD_PATH << dir unless $LOAD_PATH.include?(dir)

data/lib/puppet/util/command_line/trollop.rb

@@ -215,7 +215,7 @@ class Parser
     opts[:type] = opts[:type] || type_from_default || :flag
 
     ## fill in :long
-    opts[:long] = opts[:long] ? opts[:long].to_s : name.to_s.tr("_", "-")
+    opts[:long] = opts[:long] ? opts[:long].to_s : name.to_s.gsub("_", "-")
     opts[:long] =
       case opts[:long]
       when /^--([^-].*)$/

data/lib/puppet/util/connection.rb

@@ -0,0 +1,74 @@
+require 'puppet'
+
+module Puppet::Util
+  module Connection
+    # The logic for server and port is kind of gross. In summary:
+    # IF an endpoint-specific setting is requested AND that setting has been set by the user
+    #    Use that setting.
+    #         The defaults for these settings are the "normal" server/masterport settings, so
+    #         when they are unset we instead want to "fall back" to the failover-selected
+    #         host/port pair.
+    # ELSE IF we have a failover-selected host/port
+    #    Use what the failover logic came up with
+    # ELSE IF the server_list setting is in use
+    #    Use the first entry - failover hasn't happened yet, but that
+    #    setting is still authoritative
+    # ELSE
+    #    Go for the legacy server/masterport settings, and hope for the best
+
+    # Determines which server to use based on the specified setting, taking into
+    # account HA fallback from server_list.
+    # @param [Symbol] setting The preferred server setting to use
+    # @return [String] the name of the server for use in the request
+    def self.determine_server(setting)
+      if setting && setting != :server && Puppet.settings.set_by_config?(setting)
+        Puppet[setting]
+      else
+        server = Puppet.lookup(:server) do
+          if primary_server = Puppet.settings[:server_list][0]
+            Puppet.debug "Dynamically-bound server lookup failed; using first entry"
+            primary_server[0]
+          else
+            setting ||= :server
+            Puppet.debug "Dynamically-bound server lookup failed, falling back to #{setting} setting"
+            Puppet.settings[setting]
+          end
+        end
+        server
+      end
+    end
+
+    # Determines which port to use based on the specified setting, taking into
+    # account HA fallback from server_list.
+    # For port there's a little bit of an extra snag: setting a specific
+    # server setting and relying on the default port for that server is
+    # common, so we also want to check if the assocaited SERVER setting
+    # has been set by the user. If either of those are set we ignore the
+    # failover-selected port.
+    # @param [Symbol] port_setting The preferred port setting to use
+    # @param [Symbol] server_setting The server setting assoicated with this route.
+    # @return [String] the port to use for use in the request
+    def self.determine_port(port_setting, server_setting)
+      if (port_setting && port_setting != :masterport && Puppet.settings.set_by_config?(port_setting)) ||
+         (server_setting && server_setting != :server && Puppet.settings.set_by_config?(server_setting))
+        Puppet.settings[port_setting].to_i
+      else
+        port = Puppet.lookup(:serverport) do
+          if primary_server = Puppet.settings[:server_list][0]
+            Puppet.debug "Dynamically-bound port lookup failed; using first entry"
+
+            # Port might not be set, so we want to fallback in that
+            # case. We know we don't need to use `setting` here, since
+            # the default value of every port setting is `masterport`
+            (primary_server[1] || Puppet.settings[:masterport])
+          else
+            port_setting ||= :masterport
+            Puppet.debug "Dynamically-bound port lookup failed; falling back to #{port_setting} setting"
+            Puppet.settings[port_setting]
+          end
+        end
+        port.to_i
+      end
+    end
+  end
+end

data/lib/puppet/util/execution.rb

@@ -114,9 +114,6 @@ module Puppet::Util::Execution
   #   an Array the first element should be the executable and the rest of the
   #   elements should be the individual arguments to that executable.
   # @param options [Hash] a Hash of options
-  # @option options [String] :cwd the directory from which to run the command. Raises an error if the directory does not exist.
-  #   This option is only available on the agent. It cannot be used on the master, meaning it cannot be used in, for example,
-  #   regular functions, hiera backends, or report processors.
   # @option options [Boolean]  :failonfail if this value is set to true, then this method will raise an error if the
   #   command is not executed successfully.
   # @option options [Integer, String] :uid (nil) the user id of the user that the process should be run as. Will be ignored if the
@@ -157,21 +154,19 @@ module Puppet::Util::Execution
         :override_locale => true,
         :custom_environment => {},
         :sensitive => false,
-        :suppress_window => false,
     }
 
     options = default_options.merge(options)
 
-    if command.is_a?(Array)
+    if options[:sensitive]
+      command_str = '[redacted]'
+    elsif command.is_a?(Array)
       command = command.flatten.map(&:to_s)
       command_str = command.join(" ")
     elsif command.is_a?(String)
       command_str = command
     end
 
-    # do this after processing 'command' array or string
-    command_str = '[redacted]' if options[:sensitive]
-
     user_log_s = ''
     if options[:uid]
       user_log_s << " uid=#{options[:uid]}"
@@ -189,12 +184,7 @@ module Puppet::Util::Execution
       Puppet.debug "Executing#{user_log_s}: '#{command_str}'"
     end
 
-    null_file = Puppet.features.microsoft_windows? ? 'NUL' : '/dev/null'
-
-    cwd = options[:cwd]
-    if cwd && ! Puppet::FileSystem.directory?(cwd)
-      raise ArgumentError, _("Working directory %{cwd} does not exist!") % { cwd: cwd }
-    end
+    null_file = Puppet::Util::Platform.windows? ? 'NUL' : '/dev/null'
 
     begin
       stdin = Puppet::FileSystem.open(options[:stdinfile] || null_file, nil, 'r')
@@ -274,7 +264,7 @@ module Puppet::Util::Execution
 
           raise e
         end
-      elsif Puppet.features.microsoft_windows?
+      elsif Puppet::Util::Platform.windows?
         process_info = execute_windows(*exec_args)
         begin
           [stdin, stderr].each {|io| io.close rescue nil}
@@ -300,7 +290,7 @@ module Puppet::Util::Execution
       if !options[:squelch]
         # if we opened a pipe, we need to clean it up.
         reader.close if reader
-        stdout.close! if Puppet.features.microsoft_windows?
+        stdout.close! if Puppet::Util::Platform.windows?
       end
     end
 
@@ -330,6 +320,7 @@ module Puppet::Util::Execution
   #
   def self.execute_posix(command, options, stdin, stdout, stderr)
     child_pid = 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
@@ -338,12 +329,6 @@ module Puppet::Util::Execution
       command = [command].flatten
       Process.setsid
       begin
-        # We need to chdir to our cwd before changing privileges as there's a
-        # chance that the user may not have permissions to access the cwd, which
-        # would cause execute_posix to fail.
-        cwd = options[:cwd]
-        Dir.chdir(cwd) if cwd
-
         Puppet::Util::SUIDManager.change_privileges(options[:uid], options[:gid], true)
 
         # if the caller has requested that we override locale environment variables,