puppet 4.0.0 → 4.9.1

data/lib/puppet/util/plist.rb

@@ -0,0 +1,151 @@
+require 'cfpropertylist' if Puppet.features.cfpropertylist?
+require 'puppet/util/execution'
+
+module Puppet::Util::Plist
+
+  class FormatError < RuntimeError; end
+
+  # So I don't have to prepend every method name with 'self.' Most of the
+  # methods are going to be Provider methods (as opposed to methods of the
+  # INSTANCE of the provider).
+  class << self
+    # Defines the magic number for binary plists
+    #
+    # @api private
+    def binary_plist_magic_number
+      "bplist00"
+    end
+
+    # Defines a default doctype string that should be at the top of most plist
+    # files. Useful if we need to modify an invalid doctype string in memory.
+    # In version 10.9 and lower of OS X the plist at
+    # /System/Library/LaunchDaemons/org.ntp.ntpd.plist had an invalid doctype
+    # string. This corrects for that.
+    def plist_xml_doctype
+      '<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">'
+    end
+
+    # Read a plist file, whether its format is XML or in Apple's "binary1"
+    # format, using the CFPropertyList gem.
+    def read_plist_file(file_path)
+      # We can't really read the file until we know the source encoding in
+      # Ruby 1.9.x, so we use the magic number to detect it.
+      # 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)
+        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)
+        return plist if plist
+
+        Puppet.debug "Plist #{file_path} ill-formatted, converting with plutil"
+        begin
+          plist = Puppet::Util::Execution.execute(['/usr/bin/plutil', '-convert', 'xml1', '-o', '/dev/stdout', file_path],
+                                                  {:failonfail => true, :combine => true})
+          return parse_plist(plist)
+        rescue Puppet::ExecutionFailure => detail
+          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.
+    def parse_plist(plist_data, file_path = '')
+      bad_xml_doctype = /^.*<!DOCTYPE plist PUBLIC -\/\/Apple Computer.*$/
+      begin
+        if plist_data =~ bad_xml_doctype
+          plist_data.gsub!( bad_xml_doctype, plist_xml_doctype )
+          Puppet.debug("Had to fix plist with incorrect DOCTYPE declaration: #{file_path}")
+        end
+      rescue ArgumentError => e
+        Puppet.debug "Failed with #{e.class} on #{file_path}: #{e.inspect}"
+        return nil
+      end
+
+      begin
+        plist_obj = new_cfpropertylist(:data => plist_data)
+      # 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
+      convert_cfpropertylist_to_native_types(plist_obj)
+    end
+
+    # Helper method to assist in reading a file. It's its own method for
+    # stubbing purposes
+    #
+    # @api private
+    #
+    # @param args [String] Extra file operation mode information to use
+    #   (defaults to read-only mode 'r')
+    #   This is the standard mechanism Ruby uses in the IO class, and therefore
+    #   encoding may be explicitly like fmode : encoding or fmode : "BOM|UTF-*"
+    #   for example, a:ASCII or w+:UTF-8
+    def open_file_with_args(file, args)
+      File.open(file, args).read
+    end
+
+    # Helper method to assist in generating a new CFPropertyList Plist. It's
+    # its own method for stubbing purposes
+    #
+    # @api private
+    def new_cfpropertylist(plist_opts)
+      CFPropertyList::List.new(plist_opts)
+    end
+
+    # 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
+    def convert_cfpropertylist_to_native_types(plist_obj)
+      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
+    #
+    # @api private
+    def read_file_with_offset(file_path, offset)
+      IO.read(file_path, offset)
+    end
+
+    def to_format(format)
+      if format.to_sym == :xml
+        plist_format = CFPropertyList::List::FORMAT_XML
+      elsif format.to_sym == :binary
+        plist_format = CFPropertyList::List::FORMAT_BINARY
+      else
+        raise FormatError.new "Unknown plist format #{format}"
+      end
+    end
+
+    # This method will write a plist file using a specified format (or XML
+    # by default)
+    def write_plist_file(plist, file_path, format = :xml)
+      begin
+        plist_to_save       = CFPropertyList::List.new
+        plist_to_save.value = CFPropertyList.guess(plist)
+        plist_to_save.save(file_path, to_format(format), :formatted => true)
+      rescue IOError => e
+        Puppet.err("Unable to write the file #{file_path}. #{e.inspect}")
+      end
+    end
+
+    def dump_plist(plist_data, format = :xml)
+      plist_to_save       = CFPropertyList::List.new
+      plist_to_save.value = CFPropertyList.guess(plist_data)
+      plist_to_save.to_str(to_format(format), :formatted => true)
+    end
+  end
+end

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

@@ -42,7 +42,7 @@ class Puppet::Util::Profiler::Aggregate < Puppet::Util::Profiler::WallClock
   end
 
   def print_metrics(metrics_hash, prefix)
-    metrics_hash.sort_by {|k,v| v.time }.reverse.each do |k,v|
+    metrics_hash.sort_by {|k,v| v.time }.reverse_each do |k,v|
       @logger.call("#{prefix}#{k}: #{v.time} s (#{v.count} calls)")
       print_metrics(metrics_hash[k], "#{prefix}#{k} -> ")
     end

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/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/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/generators/puppet_generator.rb

@@ -225,7 +225,7 @@ module Generators
         'style_url'  => style_url('', @options.css),
       }
 
-      File.open(filename, "w") do |f|
+      Puppet::FileSystem.open(filename, nil, "w:UTF-8") do |f|
         template.write_html_on(f, values)
       end
     end
@@ -301,7 +301,7 @@ module Generators
       values["plugins"] = res4 if res4.size>0
       values["nodes"] = res5 if res5.size>0
 
-      File.open(filename, "w") do |f|
+      Puppet::FileSystem.open(filename, nil, "w:UTF-8") do |f|
         template.write_html_on(f, values)
       end
     end

data/lib/puppet/util/rdoc/parser/puppet_parser_core.rb

@@ -104,7 +104,8 @@ module RDoc::PuppetParserCore
     comment = ""
     %w{README README.rdoc}.each do |rfile|
       readme = File.join(File.dirname(File.dirname(@input_file_name)), rfile)
-      comment = File.open(readme,"r") { |f| f.read } if FileTest.readable?(readme)
+      # module README should be UTF-8, not default system encoding
+      comment = File.open(readme,"r:UTF-8") { |f| f.read } if FileTest.readable?(readme)
     end
     look_for_directives_in(container, comment) unless comment.empty?
 

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/resource_template.rb

@@ -40,7 +40,7 @@ class Puppet::Util::ResourceTemplate
 
   def evaluate
     set_resource_variables
-    ERB.new(File.read(@file), 0, "-").result(binding)
+    ERB.new(Puppet::FileSystem.read(@file, :encoding => 'utf-8'), 0, "-").result(binding)
   end
 
   def initialize(file, resource)

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/run_mode.rb

@@ -1,5 +1,4 @@
 require 'etc'
-require 'fileutils'
 
 module Puppet
   module Util
@@ -45,27 +44,15 @@ module Puppet
       # select the system or the user directory depending on the context of
       # this process.  The most common use is determining filesystem path
       # values for confdir and vardir.  The intended semantics are:
-      # {http://projects.puppetlabs.com/issues/16637 #16637} for Puppet 3.x
+      # {https://projects.puppetlabs.com/issues/16637 #16637} for Puppet 3.x
       #
       # @todo this code duplicates {Puppet::Settings#which\_configuration\_file}
-      #   as described in {http://projects.puppetlabs.com/issues/16637 #16637}
+      #   as described in {https://projects.puppetlabs.com/issues/16637 #16637}
       def which_dir( system, user )
         if Puppet.features.root?
           File.expand_path(system)
         else
-          # Starting with puppet 4 and AIO packaging, AIO introduced new paths for
-          # both root and non-root users. The paths used by the root user are created
-          # by packaging, so no special action is required in the code.
-          #
-          # However, for non-root users, these new paths introduce deep paths (see below
-          # in the two RunMode sub-classes). Since puppet doesn't create parent directories
-          # for directories in the settings catalog, we take this opportunity to create
-          # those parent directories. (Note that pre-AIO this code would have had to do the
-          # same thing, except that everything was under ~/.puppet which was confdir so was
-          # created.)
-          expanded_user = File.expand_path(user)
-          FileUtils.mkdir_p(File.dirname(expanded_user)) if File.exists?(File.expand_path('~'))
-          expanded_user
+          File.expand_path(user)
         end
       end
     end

data/lib/puppet/util/skip_tags.rb

@@ -0,0 +1,9 @@
+require 'puppet/util/tagging'
+
+class Puppet::Util::SkipTags
+  include Puppet::Util::Tagging
+
+  def initialize(stags)
+    self.tags = stags unless defined?(@tags)
+  end
+end

data/lib/puppet/util/splayer.rb

@@ -0,0 +1,18 @@
+# Handle splay options (sleeping for a random interval before executing)
+module Puppet::Util::Splayer
+  # Have we splayed already?
+  def splayed?
+    !!@splayed
+  end
+
+  # Sleep when splay is enabled; else just return.
+  def splay(do_splay = Puppet[:splay])
+    return unless do_splay
+    return if splayed?
+
+    time = rand(Puppet[:splaylimit] + 1)
+    Puppet.info "Sleeping for #{time} seconds (splay is enabled)"
+    sleep(time)
+    @splayed = true
+  end
+end

data/lib/puppet/util/tagging.rb

@@ -1,7 +1,7 @@
 require 'puppet/util/tag_set'
 
 module Puppet::Util::Tagging
-  ValidTagRegex = /^[0-9A-Za-z_][0-9A-Za-z_:.-]*$/
+  ValidTagRegex = /\A[0-9A-Za-z_][0-9A-Za-z_:.-]*\Z/
 
   # Add a tag to the current tag set.
   # When a tag set is used for a scope, these tags will be added to all of
@@ -18,8 +18,10 @@ module Puppet::Util::Tagging
       if @tags.add?(name)
         # not seen before, so now we test if it is valid
         if name =~ ValidTagRegex
+          if split_qualified_tags?
           # avoid adding twice by first testing if the string contains '::'
-          @tags.merge(name.split('::')) if name.include?('::')
+            @tags.merge(name.split('::')) if name.include?('::')
+          end
         else
           @tags.delete(name)
           fail(Puppet::ParseError, "Invalid tag '#{name}'")
@@ -106,6 +108,10 @@ module Puppet::Util::Tagging
 
   private
 
+  def split_qualified_tags?
+    true
+  end
+
   def new_tags
     Puppet::Util::TagSet.new
   end

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

@@ -3,7 +3,7 @@
 # Represents an access control entry, which grants or denies a subject,
 # identified by a SID, rights to a securable object.
 #
-# @see http://msdn.microsoft.com/en-us/library/windows/desktop/aa374868(v=vs.85).aspx
+# @see https://msdn.microsoft.com/en-us/library/windows/desktop/aa374868(v=vs.85).aspx
 # @api private
 class Puppet::Util::Windows::AccessControlEntry
   require 'puppet/util/windows/security'
@@ -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/access_control_list.rb

@@ -2,7 +2,7 @@
 #
 # Represents a list of access control entries (ACEs).
 #
-# @see http://msdn.microsoft.com/en-us/library/windows/desktop/aa374872(v=vs.85).aspx
+# @see https://msdn.microsoft.com/en-us/library/windows/desktop/aa374872(v=vs.85).aspx
 # @api private
 class Puppet::Util::Windows::AccessControlList
   include Enumerable
@@ -76,7 +76,7 @@ class Puppet::Util::Windows::AccessControlList
         else
           new_ace.sid = new_sid
 
-          prepend_needed = old_sid == Win32::Security::SID::LocalSystem
+          prepend_needed = old_sid == Puppet::Util::Windows::SID::LocalSystem
         end
       end
       new_aces << new_ace
@@ -87,7 +87,7 @@ class Puppet::Util::Windows::AccessControlList
     if prepend_needed
       mask = Puppet::Util::Windows::File::STANDARD_RIGHTS_ALL | Puppet::Util::Windows::File::SPECIFIC_RIGHTS_ALL
       ace = Puppet::Util::Windows::AccessControlEntry.new(
-              Win32::Security::SID::LocalSystem,
+              Puppet::Util::Windows::SID::LocalSystem,
               mask)
       @aces << ace
     end