puppet 4.5.3-universal-darwin → 4.6.1-universal-darwin

data/lib/puppet/type/yumrepo.rb

@@ -11,15 +11,15 @@ Puppet::Type.newtype(:yumrepo) do
 
     Continuation lines that yum supports (for the `baseurl`, for example)
     are not supported. This type does not attempt to read or verify the
-    exinstence of files listed in the `include` attribute."
+    existence of files listed in the `include` attribute."
 
   # Ensure yumrepos can be removed too.
   ensurable
   # Doc string for properties that can be made 'absent'
   ABSENT_DOC="Set this to `absent` to remove it from the file completely."
   # False can be false/0/no and True can be true/1/yes in yum.
-  YUM_BOOLEAN=/^(True|False|0|1|No|Yes)$/i
-  YUM_BOOLEAN_DOC="Valid values are: False/0/No or True/1/Yes."
+  YUM_BOOLEAN=/^(true|false|0|1|no|yes)$/
+  YUM_BOOLEAN_DOC="Valid values are: false/0/no or true/1/yes."
 
   # Common munge logic for YUM_BOOLEAN values. Munges for two requirements:
   # 1) Because of how regex validation works in Puppet::Parameter::Value,

data/lib/puppet/type/zone.rb

@@ -343,7 +343,7 @@ end
 
   validate do
     return unless self[:ip]
-    # self[:ip] reflects the type passed from proeprty:ip.should. If we
+    # self[:ip] reflects the type passed from property:ip.should. If we
     # override it and pass @should, then we get an array here back.
     self[:ip].each do |ip|
       interface, address, router = ip.split(':')

data/lib/puppet/util.rb

@@ -118,8 +118,8 @@ module Util
 
   # Run some code with a specific environment.  Resets the environment back to
   # what it was at the end of the code.
-  # Windows can store unicode chars in the environment as keys or values, but
-  # Rubys ENV tries to roundtrip them through the local codepage, which can
+  # Windows can store Unicode chars in the environment as keys or values, but
+  # Ruby's ENV tries to roundtrip them through the local codepage, which can
   # cause encoding problems - underlying helpers use Windows APIs on Windows
   # see https://bugs.ruby-lang.org/issues/8822
   def withenv(hash, mode = :posix)

data/lib/puppet/util/classgen.rb

@@ -153,7 +153,7 @@ module Puppet::Util::ClassGen
   # @api private
   #
   def handleclassconst(klass, name, options)
-    const = genconst_string(name, options)
+   const = genconst_string(name, options)
 
     if is_constant_defined?(const)
       if options[:overwrite]

data/lib/puppet/util/command_line.rb

@@ -81,7 +81,11 @@ module Puppet
 
       def find_subcommand
         if subcommand_name.nil?
-          NilSubcommand.new(self)
+          if args.include?("--help") || args.include?("-h")
+            ApplicationSubcommand.new("help", CommandLine.new("puppet", ["help"]))
+          else
+            NilSubcommand.new(self)
+          end
         elsif Puppet::Application.available_application_names.include?(subcommand_name)
           ApplicationSubcommand.new(subcommand_name, self)
         elsif path_to_subcommand = external_subcommand
@@ -102,7 +106,7 @@ module Puppet
           # For most applications, we want to be able to load code from the modulepath,
           # such as apply, describe, resource, and faces.
           # For agent, we only want to load pluginsync'ed code from libdir.
-          # For master, we shouldn't ever be loading per-enviroment code into the master's
+          # 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
           # environment.

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

@@ -141,7 +141,7 @@ class Parser
   ## There's one ambiguous case to be aware of: when +:multi+: is true and a
   ## +:default+ is set to an array (of something), it's ambiguous whether this
   ## is a multi-value argument as well as a multi-occurrence argument.
-  ## In thise case, Trollop assumes that it's not a multi-value argument.
+  ## In this case, Trollop assumes that it's not a multi-value argument.
   ## If you want a multi-value, multi-occurrence argument with a default
   ## value, you must specify +:type+ as well.
 

data/lib/puppet/util/execution.rb

@@ -11,7 +11,7 @@ module Puppet
   end
 end
 
-# This module defines methods for execution of system commands. It is intented for inclusion
+# This module defines methods for execution of system commands. It is intended for inclusion
 # in classes that needs to execute system commands.
 # @api public
 module Puppet::Util::Execution
@@ -48,7 +48,7 @@ module Puppet::Util::Execution
   # @yield [pipe] to a block executing a subprocess
   # @yieldparam pipe [IO] the opened pipe
   # @yieldreturn [String] the output to return
-  # @raise [Puppet::ExecutionFailure] if the executed chiled process did not
+  # @raise [Puppet::ExecutionFailure] if the executed child process did not
   #   exit with status == 0 and `failonfail` is `true`.
   # @return [String] a string with the output from the subprocess executed by
   #   the given block

data/lib/puppet/util/http_proxy.rb

@@ -30,7 +30,7 @@ module Puppet::Util::HttpProxy
   # Other documentation suggests that just a leading '.' indicates a domain
   # level exclusion, e.g.:
   #   .example.com
-  # We'll accomodate both here.
+  # We'll accommodate both here.
   def self.no_proxy?(dest)
     unless no_proxy_env = ENV["no_proxy"] || ENV["NO_PROXY"]
       return false

data/lib/puppet/util/inifile.rb

@@ -56,7 +56,7 @@ module Puppet::Util::IniConfig
     end
 
     # Set the entry 'key=value'. If no entry with the
-    # given key exists, one is appended to teh end of the section
+    # given key exists, one is appended to the end of the section
     def []=(key, value)
       entry = find_entry(key)
       @dirty = true

data/lib/puppet/util/instance_loader.rb

@@ -60,7 +60,7 @@ module Puppet::Util::InstanceLoader
     @autoloaders[type.intern]
   end
 
-  # Retrieve an alread-loaded instance, or attempt to load our instance.
+  # Retrieve an already-loaded instance, or attempt to load our instance.
   def loaded_instance(type, name)
     name = name.intern
     return nil unless instances = instance_hash(type)

data/lib/puppet/util/logging.rb

@@ -55,7 +55,7 @@ module Logging
       backtrace = []
       build_exception_trace(backtrace, exception, trace)
       Puppet::Util::Log.create({
-          :level => :err,
+          :level => options[:level] || :err,
           :source => log_source,
           :message => exception.basic_message,
           :issue_code => exception.issue_code,

data/lib/puppet/util/multi_match.rb

@@ -3,7 +3,7 @@
 # "each v === other.each v". 
 #
 # This class is useful in situations when the Puppet Type System cannot be used
-# (e.g. in Logging, since it needs to be able to log very early i the intialization
+# (e.g. in Logging, since it needs to be able to log very early in the initialization
 # cycle of puppet)
 #
 # Typically used with the constants

data/lib/puppet/util/plist.rb

@@ -1,4 +1,4 @@
-require 'cfpropertylist'
+require 'cfpropertylist' if Puppet.features.cfpropertylist?
 require 'puppet/util/execution'
 
 module Puppet::Util::Plist
@@ -33,7 +33,7 @@ module Puppet::Util::Plist
       # NOTE: We used IO.read originally to be Ruby 1.8.x compatible.
       if read_file_with_offset(file_path, binary_plist_magic_number.length) == binary_plist_magic_number
         plist_obj = new_cfpropertylist(:file => file_path)
-        convert_cfpropertylist_to_native_types(plist_obj)
+        return convert_cfpropertylist_to_native_types(plist_obj)
       else
         plist_data = open_file_with_args(file_path, "r:UTF-8")
         plist = parse_plist(plist_data, file_path)
@@ -48,6 +48,7 @@ module Puppet::Util::Plist
           Puppet.warning("Cannot read file #{file_path}; Puppet is skipping it.\n" + "Details: #{detail}")
         end
       end
+      return nil
     end
 
     # Read plist text using the CFPropertyList gem.
@@ -60,7 +61,8 @@ module Puppet::Util::Plist
 
       begin
         plist_obj = new_cfpropertylist(:data => plist_data)
-      rescue CFFormatError => e
+      # CFPropertyList library will raise NoMethodError for invalid data
+      rescue CFFormatError, NoMethodError => e
         Puppet.debug "Failed with #{e.class} on #{file_path}: #{e.inspect}"
         return nil
       end
@@ -75,7 +77,7 @@ module Puppet::Util::Plist
       File.open(file, args).read
     end
 
-    # Helper method to assist in generating a new CFPropertList Plist. It's
+    # Helper method to assist in generating a new CFPropertyList Plist. It's
     # its own method for stubbing purposes
     #
     # @api private
@@ -83,7 +85,7 @@ module Puppet::Util::Plist
       CFPropertyList::List.new(plist_opts)
     end
 
-    # Helper method to assist in converting a native CFPropertList object to a
+    # Helper method to assist in converting a native CFPropertyList object to a
     # native Ruby object (hash). It's its own method for stubbing purposes
     #
     # @api private
@@ -91,6 +93,14 @@ module Puppet::Util::Plist
       CFPropertyList.native_types(plist_obj.value)
     end
 
+    # Helper method to convert a string into a CFProperty::Blob, which is
+    # needed to properly handle binary strings
+    #
+    # @api private
+    def string_to_blob(str)
+      CFPropertyList::Blob.new(str)
+    end
+
     # Helper method to assist in reading a file with an offset value. It's its
     # own method for stubbing purposes
     #

data/lib/puppet/util/profiler.rb

@@ -41,7 +41,7 @@ module Puppet::Util::Profiler
   # This outputs logs entries to the Puppet masters logging destination
   # providing the time it took, a message describing the profiled code
   # and a leaf location marking where the profile method was called
-  # in the profiled hierachy.
+  # in the profiled hierarchy.
   #
   # @param message [String] A description of the profiled event
   # @param metric_id [Array] A list of strings making up the ID of a metric to profile

data/lib/puppet/util/profiler/around_profiler.rb

@@ -41,7 +41,7 @@ class Puppet::Util::Profiler::AroundProfiler
   # This outputs logs entries to the Puppet masters logging destination
   # providing the time it took, a message describing the profiled code
   # and a leaf location marking where the profile method was called
-  # in the profiled hierachy.
+  # in the profiled hierarchy.
   #
   # @param message [String] A description of the profiled event
   # @param metric_id [Array] A list of strings making up the ID of a metric to profile

data/lib/puppet/util/psych_support.rb

@@ -1,5 +1,5 @@
 # This module should be included when a class can be serialized to yaml and
-# needs to handle the deserialization from Psych with more control. Psych normall
+# needs to handle the deserialization from Psych with more control. Psych normally
 # pokes values directly into an instance using `instance_variable_set` which completely
 # bypasses encapsulation.
 #

data/lib/puppet/util/rdoc.rb

@@ -2,7 +2,7 @@ require 'puppet/util'
 module Puppet::Util::RDoc
   module_function
 
-  # launch a rdoc documenation process
+  # launch a rdoc documentation process
   # with the files/dir passed in +files+
   def rdoc(outputdir, files, charset = nil)
 
@@ -26,7 +26,7 @@ module Puppet::Util::RDoc
 
     options << "--force-update"
     options += [ "--charset", charset] if charset
-    # Rdoc root default is Dir.pwd, but the win32-dir gem monkey patchs Dir.pwd
+    # Rdoc root default is Dir.pwd, but the win32-dir gem monkey patches Dir.pwd
     # replacing Ruby's normal / with \.  When RDoc generates relative paths it
     # uses relative_path_from that will generate errors when the slashes don't
     # properly match.  This is a workaround for that issue.

data/lib/puppet/util/rubygems.rb

@@ -39,7 +39,7 @@ module Puppet::Util::RubyGems
   # @api private
   class Gems18Source < Source
     def directories
-      # `require 'mygem'` will consider and potentally load
+      # `require 'mygem'` will consider and potentially load
       # prerelease gems, so we need to match that behavior.
       Gem::Specification.latest_specs(true).collect do |spec|
         File.join(spec.full_gem_path, 'lib')

data/lib/puppet/util/watcher/periodic_watcher.rb

@@ -1,8 +1,8 @@
 # Monitor a given watcher for changes on a periodic interval.
 class Puppet::Util::Watcher::PeriodicWatcher
   # @param watcher [Puppet::Util::Watcher::ChangeWatcher] a watcher for the value to watch
-  # @param timer [Puppet::Util::Watcher::Timer] A timer to determin when to
-  #   recheck the watcher. If the timout of the timer is negative, then the
+  # @param timer [Puppet::Util::Watcher::Timer] A timer to determine when to
+  #   recheck the watcher. If the timeout of the timer is negative, then the
   #   watched value is always considered to be changed
   def initialize(watcher, timer)
     @watcher = watcher

data/lib/puppet/util/windows/access_control_entry.rb

@@ -47,7 +47,7 @@ class Puppet::Util::Windows::AccessControlEntry
 
   # Returns true if this ACE applies to child directories.
   #
-  # @return [Boolean] true if the ACE applies to child direcories
+  # @return [Boolean] true if the ACE applies to child directories
   def container_inherit?
     (@flags & CONTAINER_INHERIT_ACE) == CONTAINER_INHERIT_ACE
   end

data/lib/puppet/util/windows/adsi.rb

@@ -57,7 +57,7 @@ module Puppet::Util::Windows::ADSI
     end
 
     # This method should *only* be used to generate WinNT://<SID> style monikers
-    # used for IAdsGroup::Add / IAdsGroup::Remove.  These URIs are not useable
+    # used for IAdsGroup::Add / IAdsGroup::Remove.  These URIs are not usable
     # to resolve an account with WIN32OLE.connect
     # Valid input is a SID::Principal, S-X-X style SID string or any valid
     # account name with or without domain prefix
@@ -107,8 +107,19 @@ module Puppet::Util::Windows::ADSI
   end
 
   module Shared
+    def localized_domains
+      @localized_domains ||= [
+        # localized version of BUILTIN
+        # for instance VORDEFINIERT on German Windows
+        Puppet::Util::Windows::SID.sid_to_name('S-1-5-32').upcase,
+        # localized version of NT AUTHORITY (can't use S-1-5)
+        # for instance AUTORITE NT on French Windows
+        Puppet::Util::Windows::SID.name_to_sid_object('SYSTEM').domain.upcase
+      ]
+    end
+
     def uri(name, host = '.')
-      host = '.' if ['NT AUTHORITY', 'BUILTIN', Socket.gethostname].include?(host)
+      host = '.' if (localized_domains << Socket.gethostname.upcase).include?(host.upcase)
 
       # group or user
       account_type = self.name.split('::').last.downcase
@@ -184,7 +195,10 @@ module Puppet::Util::Windows::ADSI
     end
 
     def [](attribute)
-      native_user.Get(attribute)
+      value = native_user.Get(attribute)
+      # Rubys WIN32OLE errantly converts UTF-16 values to Encoding.default_external
+      return value.encode(Encoding::UTF_8) if value.is_a?(String)
+      value
     end
 
     def []=(attribute, value)
@@ -234,7 +248,8 @@ module Puppet::Util::Windows::ADSI
       # https://msdn.microsoft.com/en-us/library/aa746342.aspx
       # WIN32OLE objects aren't enumerable, so no map
       groups = []
-      native_user.Groups.each {|g| groups << g.Name} rescue nil
+      # Rubys WIN32OLE errantly converts UTF-16 values to Encoding.default_external
+      native_user.Groups.each {|g| groups << g.Name.encode(Encoding::UTF_8)} rescue nil
       groups
     end
 
@@ -320,6 +335,10 @@ module Puppet::Util::Windows::ADSI
       user_name
     end
 
+    def self.current_user_sid
+      Puppet::Util::Windows::SID.name_to_sid_object(current_user_name)
+    end
+
     def self.exists?(name_or_sid)
       well_known = false
       if (sid = Puppet::Util::Windows::SID.name_to_sid_object(name_or_sid))
@@ -353,7 +372,8 @@ module Puppet::Util::Windows::ADSI
 
       users = []
       wql.each do |u|
-        users << new(u.name)
+        # Rubys WIN32OLE errantly converts UTF-16 values to Encoding.default_external
+        users << new(u.name.encode(Encoding::UTF_8))
       end
 
       users.each(&block)
@@ -377,7 +397,7 @@ module Puppet::Util::Windows::ADSI
         Puppet::Util::Windows::ADSI.wmi_connection.Delete("Win32_UserProfile.SID='#{sid}'")
       rescue WIN32OLERuntimeError => e
         # https://social.technet.microsoft.com/Forums/en/ITCG/thread/0f190051-ac96-4bf1-a47f-6b864bfacee5
-        # Prior to Vista SP1, there's no builtin way to programmatically
+        # Prior to Vista SP1, there's no built-in way to programmatically
         # delete user profiles (except for delprof.exe). So try to delete
         # but warn if we fail
         raise e unless e.message.include?('80041010')
@@ -445,7 +465,8 @@ module Puppet::Util::Windows::ADSI
     def members
       # WIN32OLE objects aren't enumerable, so no map
       members = []
-      native_group.Members.each {|m| members << m.Name}
+      # Rubys WIN32OLE errantly converts UTF-16 values to Encoding.default_external
+      native_group.Members.each {|m| members << m.Name.encode(Encoding::UTF_8)}
       members
     end
 
@@ -514,7 +535,8 @@ module Puppet::Util::Windows::ADSI
 
       groups = []
       wql.each do |g|
-        groups << new(g.name)
+        # Rubys WIN32OLE errantly converts UTF-16 values to Encoding.default_external
+        groups << new(g.name.encode(Encoding::UTF_8))
       end
 
       groups.each(&block)

data/lib/puppet/util/windows/api_types.rb

@@ -59,7 +59,7 @@ module Puppet::Util::Windows::APITypes
       str.encode(dst_encoding)
     end
 
-    # @param max_char_length [Integer] Maximum number of wide chars tp return (typically excluding NULLs), *not* bytes
+    # @param max_char_length [Integer] Maximum number of wide chars to return (typically excluding NULLs), *not* bytes
     # @param null_terminator [Symbol] Number of number of null wchar characters, *not* bytes, that determine the end of the string
     #   null_terminator = :single_null, then the terminating sequence is two bytes of zero.   This is UNIT16 = 0
     #   null_terminator = :double_null, then the terminating sequence is four bytes of zero.  This is UNIT32 = 0

data/lib/puppet/util/windows/file.rb

@@ -257,6 +257,45 @@ module Puppet::Util::Windows::File
   end
   module_function :readlink
 
+  ERROR_FILE_NOT_FOUND = 2
+  ERROR_PATH_NOT_FOUND = 3
+
+  def get_long_pathname(path)
+    converted = ''
+    FFI::Pointer.from_string_to_wide_string(path) do |path_ptr|
+      # includes terminating NULL
+      buffer_size = GetLongPathNameW(path_ptr, FFI::Pointer::NULL, 0)
+      FFI::MemoryPointer.new(:wchar, buffer_size) do |converted_ptr|
+        if GetLongPathNameW(path_ptr, converted_ptr, buffer_size) == FFI::WIN32_FALSE
+          raise Puppet::Util::Windows::Error.new("Failed to call GetLongPathName")
+        end
+
+        converted = converted_ptr.read_wide_string(buffer_size - 1)
+      end
+    end
+
+    converted
+  end
+  module_function :get_long_pathname
+
+  def get_short_pathname(path)
+    converted = ''
+    FFI::Pointer.from_string_to_wide_string(path) do |path_ptr|
+      # includes terminating NULL
+      buffer_size = GetShortPathNameW(path_ptr, FFI::Pointer::NULL, 0)
+      FFI::MemoryPointer.new(:wchar, buffer_size) do |converted_ptr|
+        if GetShortPathNameW(path_ptr, converted_ptr, buffer_size) == FFI::WIN32_FALSE
+          raise Puppet::Util::Windows::Error.new("Failed to call GetShortPathName")
+        end
+
+        converted = converted_ptr.read_wide_string(buffer_size - 1)
+      end
+    end
+
+    converted
+  end
+  module_function :get_short_pathname
+
   def stat(file_name)
     file_name = file_name.to_s # accommodate PathName or String
     stat = File.stat(file_name)
@@ -422,4 +461,24 @@ module Puppet::Util::Windows::File
            # technically a WCHAR buffer, but we care about size in bytes here
            :PathBuffer, [:byte, MAXIMUM_REPARSE_DATA_BUFFER_SIZE - 20]
   end
+
+  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa364980(v=vs.85).aspx
+  # DWORD WINAPI GetLongPathName(
+  #   _In_  LPCTSTR lpszShortPath,
+  #   _Out_ LPTSTR  lpszLongPath,
+  #   _In_  DWORD   cchBuffer
+  # );
+  ffi_lib :kernel32
+  attach_function_private :GetLongPathNameW,
+    [:lpcwstr, :lpwstr, :dword], :dword
+
+  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa364989(v=vs.85).aspx
+  # DWORD WINAPI GetShortPathName(
+  #   _In_  LPCTSTR lpszLongPath,
+  #   _Out_ LPTSTR  lpszShortPath,
+  #   _In_  DWORD   cchBuffer
+  # );
+  ffi_lib :kernel32
+  attach_function_private :GetShortPathNameW,
+    [:lpcwstr, :lpwstr, :dword], :dword
 end