puppet 3.4.3 → 3.5.0.rc1

data/lib/puppet/util/docs.rb

@@ -112,8 +112,8 @@ module Puppet::Util::Docs
   #
   # See tests in spec/unit/util/docs_spec.rb for examples.
   def scrub(text)
-    # One-liners are easy!
-    return text.strip if text !~ /\n/
+    # 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

data/lib/puppet/util/errors.rb

@@ -85,6 +85,12 @@ module Puppet::Util::Errors
   #   the given arguments.
   #   @param [Class] type of error
   #   @param [String] message error message(s)
+  # @overload fail(error_klass, message, ..)
+  #   Throw an exception of type error_klass with a message concatenated from
+  #   the given arguments.
+  #   @param [Class] type of error
+  #   @param [String] message error message(s)
+  #   @param [Exception] original exception, source of backtrace info
   def fail(*args)
     if args[0].is_a?(Class)
       type = args.shift
@@ -92,7 +98,8 @@ module Puppet::Util::Errors
       type = Puppet::Error
     end
 
-    error = adderrorcontext(type.new(args.join(" ")))
+    other = args.count > 1 ? args.pop : nil
+    error = adderrorcontext(type.new(args.join(" ")), other)
 
     raise error
   end

data/lib/puppet/util/execution.rb

@@ -66,8 +66,15 @@ module Puppet::Util::Execution
       Puppet.debug "Executing '#{command_str}'"
     end
 
-    output = open("| #{command_str} 2>&1") do |pipe|
-      yield pipe
+    # 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'} )
+    output = Puppet::Util.withenv(english_env) do
+      open("| #{command_str} 2>&1") do |pipe|
+        yield pipe
+      end
     end
 
     if failonfail
@@ -87,7 +94,7 @@ module Puppet::Util::Execution
     output = execute(command)
     return output
   rescue Puppet::ExecutionFailure
-    raise exception, output
+    raise exception, output, exception.backtrace
   end
 
   # Default empty options for {execute}
@@ -185,7 +192,7 @@ module Puppet::Util::Execution
     end
 
     if options[:failonfail] and exit_status != 0
-      raise Puppet::ExecutionFailure, "Execution of '#{str}' returned #{exit_status}: #{output}"
+      raise Puppet::ExecutionFailure, "Execution of '#{str}' returned #{exit_status}: #{output.strip}"
     end
 
     Puppet::Util::Execution::ProcessOutput.new(output || '', exit_status)
@@ -286,7 +293,7 @@ module Puppet::Util::Execution
     #  about a race condition because all of the places that we call this from are preceded by a call to "waitpid2",
     #  meaning that the processes responsible for writing the file have completed before we get here.)
     2.times do |try|
-      if Puppet::FileSystem::File.exist?(stdout.path)
+      if Puppet::FileSystem.exist?(stdout.path)
         stdout.open
         begin
           return stdout.read

data/lib/puppet/util/filetype.rb

@@ -47,7 +47,7 @@ class Puppet::Util::FileType
         rescue => detail
           message = "#{self.class} could not read #{@path}: #{detail}"
           Puppet.log_exception(detail, message)
-          raise Puppet::Error, message
+          raise Puppet::Error, message, detail.backtrace
         end
       end
 
@@ -63,7 +63,7 @@ class Puppet::Util::FileType
         rescue => detail
           message = "#{self.class} could not write #{@path}: #{detail}"
           Puppet.log_exception(detail, message)
-          raise Puppet::Error, message
+          raise Puppet::Error, message, detail.backtrace
         end
       end
     end
@@ -98,12 +98,12 @@ class Puppet::Util::FileType
   newfiletype(:flat) do
     # Back the file up before replacing it.
     def backup
-      bucket.backup(@path) if Puppet::FileSystem::File.exist?(@path)
+      bucket.backup(@path) if Puppet::FileSystem.exist?(@path)
     end
 
     # Read the file.
     def read
-      if Puppet::FileSystem::File.exist?(@path)
+      if Puppet::FileSystem.exist?(@path)
         File.read(@path)
       else
         return nil
@@ -112,7 +112,7 @@ class Puppet::Util::FileType
 
     # Remove the file.
     def remove
-      Puppet::FileSystem::File.unlink(@path) if Puppet::FileSystem::File.exist?(@path)
+      Puppet::FileSystem.unlink(@path) if Puppet::FileSystem.exist?(@path)
     end
 
     # Overwrite the file.

data/lib/puppet/util/inifile.rb

@@ -13,13 +13,15 @@ require 'puppet/util/filetype'
 module Puppet::Util::IniConfig
   # A section in a .ini file
   class Section
-    attr_reader :name, :file
+    attr_reader :name, :file, :entries
+    attr_writer :destroy
 
     def initialize(name, file)
       @name = name
       @file = file
       @dirty = false
       @entries = []
+      @destroy = false
     end
 
     # Has this section been modified since it's been read in
@@ -33,6 +35,11 @@ module Puppet::Util::IniConfig
       @dirty = false
     end
 
+    # Should the file be destroyed?
+    def destroy?
+      @destroy
+    end
+
     # Add a line of text (e.g., a comment) Such lines
     # will be written back out in exactly the same
     # place they were read in
@@ -142,8 +149,10 @@ module Puppet::Util::IniConfig
       @files.each do |file, lines|
         text = ""
         dirty = false
+        destroy = false
         lines.each do |l|
           if l.is_a?(Section)
+            destroy ||= l.destroy?
             dirty ||= l.dirty?
             text << l.format
             l.mark_clean
@@ -151,9 +160,15 @@ module Puppet::Util::IniConfig
             text << l
           end
         end
-        if dirty
-          Puppet::Util::FileType.filetype(:flat).new(file).write(text)
-          return file
+        # We delete the file and then remove it from the list of files.
+        if destroy
+          ::File.unlink(file)
+          @files.delete(file)
+        else
+          if dirty
+            Puppet::Util::FileType.filetype(:flat).new(file).write(text)
+            return file
+          end
         end
       end
     end

data/lib/puppet/util/instrumentation/data.rb

@@ -35,7 +35,12 @@ class Puppet::Util::Instrumentation::Data
     to_pson_data_hash.to_pson(*args)
   end
 
+  def self.from_data_hash(data)
+    data
+  end
+
   def self.from_pson(data)
+    Puppet.deprecation_warning("from_pson is being removed in favour of from_data_hash.")
     data
   end
 end

data/lib/puppet/util/instrumentation/indirection_probe.rb

@@ -30,7 +30,12 @@ class Puppet::Util::Instrumentation::IndirectionProbe
     to_pson_data_hash.to_pson(*args)
   end
 
-  def self.from_pson(data)
+  def self.from_data_hash(data)
     self.new(data["name"])
   end
+
+  def self.from_pson(data)
+    Puppet.deprecation_warning("from_pson is being removed in favour of from_data_hash.")
+    self.from_data_hash(data)
+  end
 end

data/lib/puppet/util/instrumentation/listener.rb

@@ -60,8 +60,13 @@ class Puppet::Util::Instrumentation::Listener
     to_pson_data_hash.to_pson(*args)
   end
 
-  def self.from_pson(data)
+  def self.from_data_hash(data)
     result = Puppet::Util::Instrumentation[data["name"]]
     self.new(result.listener, result.pattern, data["enabled"])
   end
+
+  def self.from_pson(data)
+    Puppet.deprecation_warning("from_pson is being removed in favour of from_data_hash.")
+    self.from_data_hash(data)
+  end
 end

data/lib/puppet/util/json_lockfile.rb

@@ -34,8 +34,11 @@ class Puppet::Util::JsonLockfile < Puppet::Util::Lockfile
   def lock_data
     return nil unless file_locked?
     file_contents = super
-    return nil if file_contents.nil?
+    return nil if file_contents.nil? or file_contents.empty?
     PSON.parse(file_contents)
+  rescue PSON::ParserError => e
+    Puppet.warning "Unable to read lockfile data from #{@file_path}: not in PSON"
+    nil
   end
 
 end

data/lib/puppet/util/ldap/connection.rb

@@ -66,6 +66,6 @@ class Puppet::Util::Ldap::Connection
       @connection.set_option(LDAP::LDAP_OPT_REFERRALS, LDAP::LDAP_OPT_ON)
       @connection.simple_bind(user, password)
   rescue => detail
-      raise Puppet::Error, "Could not connect to LDAP: #{detail}"
+      raise Puppet::Error, "Could not connect to LDAP: #{detail}", detail.backtrace
   end
 end

data/lib/puppet/util/lockfile.rb

@@ -23,15 +23,19 @@ class Puppet::Util::Lockfile
 
   # @return [boolean] true if lock is successfully acquired, false otherwise.
   def lock(lock_data = nil)
-    return false if locked?
-
-    File.open(@file_path, 'w') { |fd| fd.print(lock_data) }
-    true
+    begin
+      Puppet::FileSystem.exclusive_create(@file_path, nil) do |fd|
+        fd.print(lock_data)
+      end
+      true
+    rescue Errno::EEXIST
+      false
+    end
   end
 
   def unlock
     if locked?
-      Puppet::FileSystem::File.unlink(@file_path)
+      Puppet::FileSystem.unlink(@file_path)
       true
     else
       false
@@ -56,7 +60,7 @@ class Puppet::Util::Lockfile
   #  being overridden by child classes.
   # @return [boolean] true if the file is locked, false if it is not.
   def file_locked?()
-    Puppet::FileSystem::File.exist? @file_path
+    Puppet::FileSystem.exist? @file_path
   end
   private :file_locked?
 end

data/lib/puppet/util/log.rb

@@ -233,12 +233,17 @@ class Puppet::Util::Log
     @levels.include?(level)
   end
 
-  def self.from_pson(data)
+  def self.from_data_hash(data)
     obj = allocate
     obj.initialize_from_hash(data)
     obj
   end
 
+  def self.from_pson(data)
+    Puppet.deprecation_warning("from_pson is being removed in favour of from_data_hash.")
+    self.from_data_hash(data)
+  end
+
   attr_accessor :time, :remote, :file, :line, :source
   attr_reader :level, :message
 

data/lib/puppet/util/log/destinations.rb

@@ -18,7 +18,7 @@ Puppet::Util::Log.newdesttype :syslog do
     begin
       facility = Syslog.const_get("LOG_#{str.upcase}")
     rescue NameError
-      raise Puppet::Error, "Invalid syslog facility #{str}"
+      raise Puppet::Error, "Invalid syslog facility #{str}", $!.backtrace
     end
 
     @syslog = Syslog.open(name, options, facility)
@@ -68,7 +68,7 @@ Puppet::Util::Log.newdesttype :file do
     # first make sure the directory exists
     # We can't just use 'Config.use' here, because they've
     # specified a "special" destination.
-    unless Puppet::FileSystem::File.exist?(File.dirname(path))
+    unless Puppet::FileSystem.exist?(Puppet::FileSystem.dir(path))
       FileUtils.mkdir_p(File.dirname(path), :mode => 0755)
       Puppet.info "Creating log directory #{File.dirname(path)}"
     end

data/lib/puppet/util/metric.rb

@@ -11,12 +11,17 @@ class Puppet::Util::Metric
 
   attr_writer :basedir
 
-  def self.from_pson(data)
+  def self.from_data_hash(data)
     metric = new(data['name'], data['label'])
     metric.values = data['values']
     metric
   end
 
+  def self.from_pson(data)
+    Puppet.deprecation_warning("from_pson is being removed in favour of from_data_hash.")
+    self.from_data_hash(data)
+  end
+
   def to_data_hash
     {
       'name' => @name,
@@ -71,7 +76,7 @@ class Puppet::Util::Metric
         RRD.create( self.path, '-s', Puppet[:rrdinterval].to_s, '-b', start.to_i.to_s, *args)
       end
     rescue => detail
-      raise "Could not create RRD file #{path}: #{detail}"
+      raise detail, "Could not create RRD file #{path}: #{detail}", detail.backtrace
     end
   end
 
@@ -161,7 +166,7 @@ class Puppet::Util::Metric
       Puppet.warning "RRD library is missing; cannot store metrics"
       return
     end
-    self.create(time - 5) unless Puppet::FileSystem::File.exist?(self.path)
+    self.create(time - 5) unless Puppet::FileSystem.exist?(self.path)
 
     if Puppet.features.rrd_legacy? && ! Puppet.features.rrd?
       @rrd ||= RRDtool.new(self.path)
@@ -185,7 +190,7 @@ class Puppet::Util::Metric
       end
       #system("rrdtool updatev #{self.path} '#{arg}'")
     rescue => detail
-      raise Puppet::Error, "Failed to update #{self.name}: #{detail}"
+      raise Puppet::Error, "Failed to update #{self.name}: #{detail}", detail.backtrace
     end
   end
 

data/lib/puppet/util/nagios_maker.rb

@@ -11,7 +11,21 @@ module Puppet::Util::NagiosMaker
 
     raise(Puppet::DevError, "No nagios type for #{name}") unless nagtype = Nagios::Base.type(name)
 
-    type = Puppet::Type.newtype(full_name) {}
+    type = Puppet::Type.newtype(full_name) do
+
+      # Generate a file resource if necessary.
+      #
+      # @see Puppet::Type::File and its properties owner, group and mode.
+      def generate
+        return nil unless self[:owner] or self[:group] or self[:mode]
+        props = { :name => self[:target] }
+        [ :owner, :group, :mode ].each do |prop|
+          props[prop] = self[prop] if self[prop]
+        end
+        Puppet::Type.type(:file).new(props)
+      end
+
+    end
 
     type.ensurable
 
@@ -19,6 +33,17 @@ module Puppet::Util::NagiosMaker
       desc "The name of this nagios_#{nagtype.name} resource."
     end
 
+    [ :owner, :group, :mode].each do |fileprop|
+      type.newparam(fileprop) do
+        desc "The desired #{fileprop} of the config file for this nagios_#{nagtype.name} resource.
+ 
+          NOTE: If the target file is explicitly managed by a file resource in your manifest,
+          this parameter has no effect. If a parent directory of the target is managed by
+          a recursive file resource, this limitation does not apply (i.e., this parameter
+          takes precedence, and if purge is used, the target file is exempt)."
+      end
+    end
+
     # We deduplicate the parameters because it makes sense to allow Naginator to have dupes.
     nagtype.parameters.uniq.each do |param|
       next if param == nagtype.namevar

data/lib/puppet/util/network_device.rb

@@ -7,7 +7,7 @@ class Puppet::Util::NetworkDevice
     require "puppet/util/network_device/#{device.provider}/device"
     @current = Puppet::Util::NetworkDevice.const_get(device.provider.capitalize).const_get(:Device).new(device.url, device.options)
   rescue => detail
-    raise "Can't load #{device.provider} for #{device.name}: #{detail}"
+    raise detail, "Can't load #{device.provider} for #{device.name}: #{detail}", detail.backtrace
   end
 
   # Should only be used in tests

data/lib/puppet/util/network_device/config.rb

@@ -15,7 +15,7 @@ class Puppet::Util::NetworkDevice::Config
   attr_reader :devices
 
   def exists?
-    Puppet::FileSystem::File.exist?(@file)
+    Puppet::FileSystem.exist?(@file.to_str)
   end
 
   def initialize

data/lib/puppet/util/network_device/transport/ssh.rb

@@ -33,11 +33,11 @@ class Puppet::Util::NetworkDevice::Transport::Ssh < Puppet::Util::NetworkDevice:
       Puppet.debug("connecting to #{host} as #{user}")
       @ssh = Net::SSH.start(host, user, :port => port, :password => password, :timeout => timeout)
     rescue TimeoutError
-      raise TimeoutError, "timed out while opening an ssh connection to the host"
+      raise TimeoutError, "timed out while opening an ssh connection to the host", $!.backtrace
     rescue Net::SSH::AuthenticationFailed
-      raise Puppet::Error, "SSH authentication failure connecting to #{host} as #{user}"
+      raise Puppet::Error, "SSH authentication failure connecting to #{host} as #{user}", $!.backtrace
     rescue Net::SSH::Exception
-      raise Puppet::Error, "SSH connection failure to #{host}"
+      raise Puppet::Error, "SSH connection failure to #{host}", $!.backtrace
     end
 
     @buf = ""

data/lib/puppet/util/plugins.rb

@@ -37,7 +37,7 @@ module Puppet
     def self.known
       Paths[Loaded.length...Paths.length].each { |path|
         file = File.join(path,'plugin_init.rb')
-        Loaded << (Puppet::FileSystem::File.exist?(file) && new(file))
+        Loaded << (Puppet::FileSystem.exist?(file) && new(file))
       }
       Loaded.compact
     end