puppet 3.1.1 → 3.2.0.rc1

data/lib/puppet/util/colors.rb

@@ -83,6 +83,61 @@ module Puppet::Util::Colors
     # We're on windows, need win32console for color to work
     begin
       require 'win32console'
+      require 'windows/wide_string'
+
+      # The win32console gem uses ANSI functions for writing to the console
+      # which doesn't work for unicode strings, e.g. module tool. Ruby 1.9
+      # does the same thing, but doesn't account for ANSI escape sequences
+      class WideConsole < Win32::Console
+        WriteConsole                = Win32API.new( "kernel32", "WriteConsoleW", ['l', 'p', 'l', 'p', 'p'], 'l' )
+        WriteConsoleOutputCharacter = Win32API.new( "kernel32", "WriteConsoleOutputCharacterW", ['l', 'p', 'l', 'l', 'p'], 'l' )
+
+        def initialize(t = nil)
+          super(t)
+        end
+
+        def WriteChar(str, col, row)
+          dwWriteCoord = (row << 16) + col
+          lpNumberOfCharsWritten = ' ' * 4
+          utf16, nChars = string_encode(str)
+          WriteConsoleOutputCharacter.call(@handle, utf16, nChars, dwWriteCoord, lpNumberOfCharsWritten)
+          lpNumberOfCharsWritten.unpack('L')
+        end
+
+        def Write(str)
+          written = 0.chr * 4
+          reserved = 0.chr * 4
+          utf16, nChars = string_encode(str)
+          WriteConsole.call(@handle, utf16, nChars, written, reserved)
+        end
+
+        if String.method_defined?("encode")
+          def string_encode(str)
+            wstr = str.encode('UTF-16LE')
+            [wstr, wstr.length]
+          end
+        else
+          require 'iconv'
+          def string_encode(str)
+            wstr = Iconv.conv('UTF-16LE', 'UTF-8', str)
+            [wstr, wstr.length/2]
+          end
+        end
+      end
+
+      # Override the win32console's IO class so we can supply
+      # our own Console class
+      class WideIO < Win32::Console::ANSI::IO
+        def initialize(fd_std = :stdout)
+          super(fd_std)
+
+          handle = FD_STD_MAP[fd_std][1]
+          @Out = WideConsole.new(handle)
+        end
+      end
+
+      $stdout = WideIO.new(:stdout)
+      $stderr = WideIO.new(:stderr)
     rescue LoadError
       def console_has_color?
         false

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

@@ -22,7 +22,7 @@ VERSION = "1.16.2"
 ## Thrown by Parser in the event of a commandline error. Not needed if
 ## you're using the Trollop::options entry.
 class CommandlineError < StandardError; end
-  
+
 ## Thrown by Parser if the user passes in '-h' or '--help'. Handled
 ## automatically by Trollop#options.
 class HelpNeeded < StandardError; end
@@ -273,7 +273,7 @@ class Parser
     syms.each { |sym| raise ArgumentError, "unknown option '#{sym}'" unless @specs[sym] }
     @constraints << [:depends, syms]
   end
-  
+
   ## Marks two (or more!) options as conflicting.
   def conflicts *syms
     syms.each { |sym| raise ArgumentError, "unknown option '#{sym}'" unless @specs[sym] }
@@ -465,7 +465,7 @@ class Parser
           # call this unless the cursor's at the beginning of a line.
 
     left = {}
-    @specs.each do |name, spec| 
+    @specs.each do |name, spec|
       left[name] = "--#{spec[:long]}" +
         (spec[:short] && spec[:short] != :none ? ", -#{spec[:short]}" : "") +
         case spec[:type]
@@ -686,7 +686,7 @@ private
     start = 0
     ret = []
     until start > str.length
-      nextt = 
+      nextt =
         if start + width >= str.length
           str.length
         else

data/lib/puppet/util/errors.rb

@@ -1,11 +1,24 @@
-# Some helper methods for throwing errors.
+# Some helper methods for throwing and populating errors.
+#
+# @api public
 module Puppet::Util::Errors
-  # Throw a dev error.
+  # Throw a Puppet::DevError with the specified message.  Used for unknown or
+  # internal application failures.
+  #
+  # @param msg [String] message used in raised error
+  # @raise [Puppet::DevError] always raised with the supplied message
   def devfail(msg)
     self.fail(Puppet::DevError, msg)
   end
 
-  # Add line and file info if available and appropriate.
+  # Add line and file info to the supplied exception if info is available from
+  # this object, is appropriately populated and the supplied exception supports
+  # it.  When other is supplied, the backtrace will be copied to the error
+  # object.
+  #
+  # @param error [Exception] exception that is populated with info
+  # @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
@@ -15,6 +28,10 @@ module Puppet::Util::Errors
     error
   end
 
+  # Return a human-readable string of this object's file and line attributes,
+  # if set.
+  #
+  # @return [String] description of file and line
   def error_context
     if file and line
       " at #{file}:#{line}"
@@ -29,6 +46,15 @@ module Puppet::Util::Errors
 
   # Wrap a call in such a way that we always throw the right exception and keep
   # as much context as possible.
+  #
+  # @param options [Hash<Symbol,Object>] options used to create error
+  # @option options [Class] :type error type to raise, defaults to
+  #   Puppet::DevError
+  # @option options [String] :message message to use in error, default mentions
+  #   the name of this class
+  # @raise [Puppet::Error] re-raised with extra context if the block raises it
+  # @raise [Error] of type options[:type], when the block raises other
+  #   exceptions
   def exceptwrap(options = {})
     options[:type] ||= Puppet::DevError
     begin
@@ -48,6 +74,16 @@ module Puppet::Util::Errors
   end
 
   # Throw an error, defaulting to a Puppet::Error.
+  #
+  # @overload fail(message, ..)
+  #   Throw a Puppet::Error with a message concatenated from the given
+  #   arguments.
+  #   @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)
   def fail(*args)
     if args[0].is_a?(Class)
       type = args.shift

data/lib/puppet/util/fileparsing.rb

@@ -141,6 +141,11 @@ module Puppet::Util::FileParsing
   end
 
   # Try to match a record.
+  #
+  # @param [String] line The line to be parsed
+  # @param [Puppet::Util::FileType] record The filetype to use for parsing
+  #
+  # @return [Hash<Symbol, Object>] The parsed elements of the line
   def handle_record_line(line, record)
     ret = nil
     if record.respond_to?(:process)

data/lib/puppet/util/filetype.rb

@@ -8,6 +8,8 @@ require 'fileutils'
 class Puppet::Util::FileType
   attr_accessor :loaded, :path, :synced
 
+  class FileReadError < Puppet::Error; end
+
   include Puppet::Util::SELinux
 
   class << self
@@ -166,7 +168,7 @@ class Puppet::Util::FileType
       begin
         @uid = Puppet::Util.uid(user)
       rescue Puppet::Error => detail
-        raise Puppet::Error, "Could not retrieve user #{user}: #{detail}", detail.backtrace
+        raise FileReadError, "Could not retrieve user #{user}: #{detail}", detail.backtrace
       end
 
       # XXX We have to have the user name, not the uid, because some
@@ -221,9 +223,9 @@ class Puppet::Util::FileType
       when /can't open your crontab/
         return ""
       when /you are not authorized to use cron/
-        raise Puppet::Error, "User #{@path} not authorized to use cron", detail.backtrace
+        raise FileReadError, "User #{@path} not authorized to use cron", detail.backtrace
       else
-        raise Puppet::Error, "Could not read crontab for #{@path}: #{detail}", detail.backtrace
+        raise FileReadError, "Could not read crontab for #{@path}: #{detail}", detail.backtrace
       end
     end
 
@@ -231,7 +233,7 @@ class Puppet::Util::FileType
     def remove
       Puppet::Util::Execution.execute(%w{crontab -r}, cronargs)
     rescue => detail
-      raise Puppet::Error, "Could not remove crontab for #{@path}: #{detail}", detail.backtrace
+      raise FileReadError, "Could not remove crontab for #{@path}: #{detail}", detail.backtrace
     end
 
     # Overwrite a specific @path's cron tab; must be passed the @path name
@@ -245,7 +247,7 @@ class Puppet::Util::FileType
         File.chown(Puppet::Util.uid(@path), nil, output_file.path)
         Puppet::Util::Execution.execute(["crontab", output_file.path], cronargs)
       rescue => detail
-        raise Puppet::Error, "Could not write crontab for #{@path}: #{detail}", detail.backtrace
+        raise FileReadError, "Could not write crontab for #{@path}: #{detail}", detail.backtrace
       ensure
         output_file.close
         output_file.unlink
@@ -263,9 +265,9 @@ class Puppet::Util::FileType
       when /Cannot open a file in the .* directory/
         return ""
       when /You are not authorized to use the cron command/
-        raise Puppet::Error, "User #{@path} not authorized to use cron", detail.backtrace
+        raise FileReadError, "User #{@path} not authorized to use cron", detail.backtrace
       else
-        raise Puppet::Error, "Could not read crontab for #{@path}: #{detail}", detail.backtrace
+        raise FileReadError, "Could not read crontab for #{@path}: #{detail}", detail.backtrace
       end
     end
 
@@ -273,7 +275,7 @@ class Puppet::Util::FileType
     def remove
       Puppet::Util::Execution.execute(%w{crontab -r}, cronargs)
     rescue => detail
-      raise Puppet::Error, "Could not remove crontab for #{@path}: #{detail}", detail.backtrace
+      raise FileReadError, "Could not remove crontab for #{@path}: #{detail}", detail.backtrace
     end
 
     # Overwrite a specific @path's cron tab; must be passed the @path name
@@ -288,7 +290,7 @@ class Puppet::Util::FileType
         File.chown(Puppet::Util.uid(@path), nil, output_file.path)
         Puppet::Util::Execution.execute(["crontab", output_file.path], cronargs)
       rescue => detail
-        raise Puppet::Error, "Could not write crontab for #{@path}: #{detail}", detail.backtrace
+        raise FileReadError, "Could not write crontab for #{@path}: #{detail}", detail.backtrace
       ensure
         output_file.close
         output_file.unlink

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

@@ -83,11 +83,11 @@ module Puppet::Util::Instrumentation::Instrumentable
   #   this can either be a static symbol/string or a block. If it's a block
   #   this one will be evaluated on every call of the instrumented method and
   #   should return a string or a symbol
-  #   
+  #
   # data::
   #   this can be a hash or a block. If it's a block this one will be evaluated
   #   on every call of the instrumented method and should return a hash.
-  # 
+  #
   #Example:
   #
   #   class MyClass

data/lib/puppet/util/libuser.conf

@@ -0,0 +1,15 @@
+[import]
+login_defs = /etc/login.defs
+default_useradd = /etc/default/useradd
+
+[defaults]
+crypt_style = md5
+modules = files shadow
+create_modules = files shadow
+
+[userdefaults]
+LU_USERNAME = %n
+LU_GIDNUMBER = %u
+
+[groupdefaults]
+LU_GROUPNAME = %n

data/lib/puppet/util/libuser.rb

@@ -0,0 +1,12 @@
+module Puppet::Util::Libuser
+   def self.getconf
+     File.expand_path("../libuser.conf", __FILE__)
+   end
+
+   def self.getenv
+     newenv = {}
+     newenv['LIBUSER_CONF'] = getconf
+     newenv
+   end
+
+end

data/lib/puppet/util/monkey_patches.rb

@@ -126,6 +126,25 @@ class Array
 
     slice(n, length - n) or []
   end unless method_defined? :drop
+  
+  # Array does not have a to_hash method and Hash uses this instead of checking with "respond_to?" if an
+  # array can convert itself or not. (This is a bad thing in Hash). When Array is extended with a method_missing,
+  # (like when using the RGen package 0.6.1 where meta methods are available on arrays), this trips up the
+  # Hash implementation.
+  # This patch simply does what the regular to_hash does, and it is accompanied by a respond_to? method that
+  # returns false for :to_hash.
+  # This is really ugly, and should be removed when the implementation in lib/rgen/array_extension.rb is
+  # fixed to handle to_hash correctly.
+  def to_hash
+    raise NoMethodError.new
+  end
+  
+  # @see #to_hash   
+  def respond_to? m, include_private=false
+    return false if m == :to_hash
+    super
+  end
+
 end
 
 
@@ -394,3 +413,32 @@ class OpenSSL::SSL::SSLContext
     set_params(params)
   end
 end
+
+require 'puppet/util/platform'
+if Puppet::Util::Platform.windows?
+  require 'puppet/util/windows'
+  require 'openssl'
+
+  class OpenSSL::X509::Store
+    alias __original_set_default_paths set_default_paths
+    def set_default_paths
+      # This can be removed once openssl integrates with windows
+      # cert store, see http://rt.openssl.org/Ticket/Display.html?id=2158
+      Puppet::Util::Windows::RootCerts.instance.each do |x509|
+        add_cert(x509)
+      end
+
+      __original_set_default_paths
+    end
+  end
+end
+
+# Old puppet clients may make large GET requests, lets be reasonably tolerant
+# in our default WEBrick server.
+require 'webrick'
+if defined?(WEBrick::HTTPRequest::MAX_URI_LENGTH) and WEBrick::HTTPRequest::MAX_URI_LENGTH < 8192
+  # Silence ruby warning: already initialized constant MAX_URI_LENGTH
+  v, $VERBOSE = $VERBOSE, nil
+  WEBrick::HTTPRequest.const_set("MAX_URI_LENGTH", 8192)
+  $VERBOSE = v
+end

data/lib/puppet/util/network_device.rb

@@ -5,7 +5,7 @@ class Puppet::Util::NetworkDevice
 
   def self.init(device)
     require "puppet/util/network_device/#{device.provider}/device"
-    @current = Puppet::Util::NetworkDevice.const_get(device.provider.capitalize).const_get(:Device).new(device.url)
+    @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}"
   end

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

@@ -7,7 +7,7 @@ class Puppet::Util::NetworkDevice::Base
 
   attr_accessor :url, :transport
 
-  def initialize(url)
+  def initialize(url, options = {})
     @url = URI.parse(url)
 
     @autoloader = Puppet::Util::Autoload.new(
@@ -17,7 +17,7 @@ class Puppet::Util::NetworkDevice::Base
     )
 
     if @autoloader.load(@url.scheme)
-      @transport = Puppet::Util::NetworkDevice::Transport.const_get(@url.scheme.capitalize).new
+      @transport = Puppet::Util::NetworkDevice::Transport.const_get(@url.scheme.capitalize).new(options[:debug])
       @transport.host = @url.host
       @transport.port = @url.port || case @url.scheme ; when "ssh" ; 22 ; when "telnet" ; 23 ; end
       @transport.user = @url.user

data/lib/puppet/util/network_device/cisco/device.rb

@@ -13,26 +13,36 @@ class Puppet::Util::NetworkDevice::Cisco::Device < Puppet::Util::NetworkDevice::
   attr_accessor :enable_password
 
   def initialize(url, options = {})
-    super(url)
+    super(url, options)
     @enable_password = options[:enable_password] || parse_enable(@url.query)
     transport.default_prompt = /[#>]\s?\z/n
   end
 
   def parse_enable(query)
-    return $1 if query =~ /enable=(.*)/
+    if query
+      params = CGI.parse(query)
+      params['enable'].first unless params['enable'].empty?
+    end
   end
 
-  def command(cmd=nil)
-    Puppet.debug("command #{cmd}")
+  def connect
     transport.connect
     login
     transport.command("terminal length 0") do |out|
       enable if out =~ />\s?\z/n
     end
     find_capabilities
+  end
+
+  def disconnect
+    transport.close
+  end
+
+  def command(cmd = nil)
+    connect
     out = execute(cmd) if cmd
     yield self if block_given?
-    transport.close
+    disconnect
     out
   end
 
@@ -61,14 +71,14 @@ class Puppet::Util::NetworkDevice::Cisco::Device < Puppet::Util::NetworkDevice::
   end
 
   def find_capabilities
-    out = transport.command("sh vlan brief")
+    out = execute("sh vlan brief")
     lines = out.split("\n")
     lines.shift; lines.pop
 
     @support_vlan_brief = ! (lines.first =~ /^%/)
   end
 
-  IF={
+  IF = {
     :FastEthernet => %w{FastEthernet FastEth Fast FE Fa F},
     :GigabitEthernet => %w{GigabitEthernet GigEthernet GigEth GE Gi G},
     :TenGigabitEthernet => %w{TenGigabitEthernet TE Te},
@@ -116,7 +126,7 @@ class Puppet::Util::NetworkDevice::Cisco::Device < Puppet::Util::NetworkDevice::
 
   def parse_interface(name)
     resource = {}
-    out = transport.command("sh interface #{name}")
+    out = execute("sh interface #{name}")
     lines = out.split("\n")
     lines.shift; lines.pop
     lines.each do |l|
@@ -144,7 +154,7 @@ class Puppet::Util::NetworkDevice::Cisco::Device < Puppet::Util::NetworkDevice::
 
   def parse_interface_config(name)
     resource = Hash.new { |hash, key| hash[key] = Array.new ; }
-    out = transport.command("sh running-config interface #{name} | begin interface")
+    out = execute("sh running-config interface #{name} | begin interface")
     lines = out.split("\n")
     lines.shift; lines.pop
     lines.each do |l|
@@ -166,7 +176,7 @@ class Puppet::Util::NetworkDevice::Cisco::Device < Puppet::Util::NetworkDevice::
 
   def parse_vlans
     vlans = {}
-    out = transport.command(support_vlan_brief? ? "sh vlan brief" : "sh vlan-switch brief")
+    out = execute(support_vlan_brief? ? "sh vlan brief" : "sh vlan-switch brief")
     lines = out.split("\n")
     lines.shift; lines.shift; lines.shift; lines.pop
     vlan = nil
@@ -193,27 +203,27 @@ class Puppet::Util::NetworkDevice::Cisco::Device < Puppet::Util::NetworkDevice::
   def update_vlan(id, is = {}, should = {})
     if should[:ensure] == :absent
       Puppet.info "Removing #{id} from device vlan"
-      transport.command("conf t")
-      transport.command("no vlan #{id}")
-      transport.command("exit")
+      execute("conf t")
+      execute("no vlan #{id}")
+      execute("exit")
       return
     end
 
     # We're creating or updating an entry
-    transport.command("conf t")
-    transport.command("vlan #{id}")
+    execute("conf t")
+    execute("vlan #{id}")
     [is.keys, should.keys].flatten.uniq.each do |property|
       Puppet.debug("trying property: #{property}: #{should[property]}")
       next if property != :description
-      transport.command("name #{should[property]}")
+      execute("name #{should[property]}")
     end
-    transport.command("exit")
-    transport.command("exit")
+    execute("exit")
+    execute("exit")
   end
 
   def parse_trunking(interface)
     trunking = {}
-    out = transport.command("sh interface #{interface} switchport")
+    out = execute("sh interface #{interface} switchport")
     lines = out.split("\n")
     lines.shift; lines.pop
     lines.each do |l|