puppet 2.7.26 → 3.0.0.rc4

data/lib/puppet/feature/rails.rb

@@ -4,6 +4,24 @@ Puppet.features.rubygems?
 
 Puppet.features.add(:rails) do
   begin
+    # Turn off the constant watching parts of ActiveSupport, which have a huge
+    # cost in terms of the system watching loaded code to figure out if it was
+    # a missing content, and which we don't actually *use* anywhere.
+    #
+    # In fact, we *can't* depend on the feature: we don't require
+    # ActiveSupport, just load it if we use rails, if we depend on a feature
+    # that it offers. --daniel 2012-07-16
+    require 'active_support'
+    begin
+      ActiveSupport::Dependencies.unhook!
+      ActiveSupport::Dependencies.mechanism = :require
+    rescue ScriptError, StandardError => e
+      # ignore any failure - worst case we run without disabling the CPU
+      # sucking features, so are slower but ... not actually failed, just
+      # because some random future version of ActiveRecord changes.
+      Puppet.debug("disabling ActiveSupport::Dependencies failed: #{e}")
+    end
+
     require 'active_record'
     require 'active_record/version'
   rescue LoadError => detail

data/lib/puppet/feature/rdoc1.rb

@@ -0,0 +1,16 @@
+require 'puppet/util/feature'
+
+# We have a version of RDoc compatible with our module documentation tool.
+# That is to say, we have the version that comes with Ruby 1.8.7 and earlier,
+# and not the version that comes with Ruby 1.9.1 or later.
+#
+# 1.8 => require 'rdoc/rdoc'; p RDoc::RDoc::VERSION_STRING
+#        => "RDoc V1.0.1 - 20041108"
+# 1.9 => require 'rdoc'; p RDoc::VERSION
+#        => "3.9.4"  # 1.9.2 has 2.5, 1.9.3 has 3.9
+#
+# Anything above that whole 1.0.1 thing is no good for us, and since that
+# ships with anything in the 1.8 series that we care about (eg: .5, ,7) we can
+# totally just use that as a proxy for the correct version of rdoc being
+# available. --daniel 2012-03-08
+Puppet.features.add(:rdoc1) { RUBY_VERSION[0,3] == "1.8" }

data/lib/puppet/file_bucket/dipper.rb

@@ -47,8 +47,9 @@ class Puppet::FileBucket::Dipper
 
       return file_bucket_file.checksum_data
     rescue => detail
-      puts detail.backtrace if Puppet[:trace]
-      raise Puppet::Error, "Could not back up #{file}: #{detail}"
+      message = "Could not back up #{file}: #{detail}"
+      Puppet.log_exception(detail, message)
+      raise Puppet::Error, message
     end
   end
 

data/lib/puppet/file_serving/base.rb

@@ -1,9 +1,12 @@
 require 'puppet/file_serving'
 require 'puppet/util'
+require 'puppet/util/methodhelper'
 
 # The base class for Content and Metadata; provides common
 # functionality like the behaviour around links.
 class Puppet::FileServing::Base
+  include Puppet::Util::MethodHelper
+
   # This is for external consumers to store the source that was used
   # to retrieve the metadata.
   attr_accessor :source
@@ -28,14 +31,7 @@ class Puppet::FileServing::Base
   def initialize(path, options = {})
     self.path = path
     @links = :manage
-
-    options.each do |param, value|
-      begin
-        send param.to_s + "=", value
-      rescue NoMethodError
-        raise ArgumentError, "Invalid option #{param} for #{self.class}"
-      end
-    end
+    set_options(options)
   end
 
   # Determine how we deal with links.

data/lib/puppet/file_serving/configuration.rb

@@ -29,16 +29,6 @@ class Puppet::FileServing::Configuration
   def find_mount(mount_name, environment)
     # Reparse the configuration if necessary.
     readconfig
-
-    if mount = mounts[mount_name]
-      return mount
-    end
-
-    if environment.module(mount_name)
-      Puppet::Util::Warnings.notice_once "DEPRECATION NOTICE: Files found in modules without specifying 'modules' in file path will be deprecated in the next major release.  Please fix module '#{mount_name}' when no 0.24.x clients are present"
-      return mounts["modules"]
-    end
-
     # This can be nil.
     mounts[mount_name]
   end
@@ -111,8 +101,7 @@ class Puppet::FileServing::Configuration
       newmounts = @parser.parse
       @mounts = newmounts
     rescue => detail
-      puts detail.backtrace if Puppet[:trace]
-      Puppet.err "Error parsing fileserver configuration: #{detail}; using old configuration"
+      Puppet.log_exception(detail, "Error parsing fileserver configuration: #{detail}; using old configuration")
     end
 
   ensure

data/lib/puppet/file_serving/configuration/parser.rb

@@ -99,7 +99,7 @@ class Puppet::FileServing::Configuration::Parser < Puppet::Util::LoadedFile
       begin
         mount.path = value
       rescue ArgumentError => detail
-        Puppet.err "Removing mount #{mount.name}: #{detail}"
+        Puppet.log_exception(detail, "Removing mount \"#{mount.name}\": #{detail}")
         @mounts.delete(mount.name)
       end
     else

data/lib/puppet/file_serving/metadata.rb

@@ -16,20 +16,6 @@ class Puppet::FileServing::Metadata < Puppet::FileServing::Base
 
   PARAM_ORDER = [:mode, :ftype, :owner, :group]
 
-  def attributes_with_tabs
-    raise(ArgumentError, "Cannot manage files of type #{ftype}") unless ['file','directory','link'].include? ftype
-    desc = []
-    PARAM_ORDER.each { |check|
-      check = :ftype if check == :type
-      desc << send(check)
-    }
-
-    desc << checksum
-    desc << @destination rescue nil if ftype == 'link'
-
-    desc.join("\t")
-  end
-
   def checksum_type=(type)
     raise(ArgumentError, "Unsupported checksum type #{type}") unless respond_to?("#{type}_file")
 

data/lib/puppet/file_serving/mount/plugins.rb

@@ -16,8 +16,17 @@ class Puppet::FileServing::Mount::Plugins < Puppet::FileServing::Mount
   def search(relative_path, request)
     # We currently only support one kind of search on plugins - return
     # them all.
+    Puppet.debug("Warning: calling Plugins.search with empty module path.") if request.environment.modules.empty?
     paths = request.environment.modules.find_all { |mod| mod.plugins? }.collect { |mod| mod.plugin_directory }
-    return(paths.empty? ? nil : paths)
+    if paths.empty?
+      # If the modulepath is valid then we still need to return a valid root
+      # directory for the search, but make sure nothing inside it is
+      # returned.
+      request.options[:recurse] = false
+      request.environment.modulepath.empty? ? nil : request.environment.modulepath
+    else
+      paths
+    end
   end
 
   def valid?

data/lib/puppet/file_serving/terminus_selector.rb

@@ -4,25 +4,27 @@ require 'puppet/file_serving'
 # in file-serving indirections.  This is necessary because
 # the terminus varies based on the URI asked for.
 module Puppet::FileServing::TerminusSelector
-  PROTOCOL_MAP = {"puppet" => :rest, "file" => :file}
-
   def select(request)
     # We rely on the request's parsing of the URI.
 
     # Short-circuit to :file if it's a fully-qualified path or specifies a 'file' protocol.
-    return PROTOCOL_MAP["file"] if Puppet::Util.absolute_path?(request.key)
-    return PROTOCOL_MAP["file"] if request.protocol == "file"
-
-    # We're heading over the wire the protocol is 'puppet' and we've got a server name or we're not named 'apply' or 'puppet'
-    if request.protocol == "puppet" and (request.server or !["puppet","apply"].include?(Puppet.settings[:name]))
-      return PROTOCOL_MAP["puppet"]
+    if Puppet::Util.absolute_path?(request.key)
+      return :file
     end
 
-    if request.protocol and PROTOCOL_MAP[request.protocol].nil?
-      raise(ArgumentError, "URI protocol '#{request.protocol}' is not currently supported for file serving")
+    case request.protocol
+    when "file"
+      :file
+    when "puppet"
+      if request.server
+        :rest
+      else
+        Puppet[:default_file_terminus].to_sym
+      end
+    when nil
+      :file_server
+    else
+      raise ArgumentError, "URI protocol '#{request.protocol}' is not currently supported for file serving"
     end
-
-    # If we're still here, we're using the file_server or modules.
-    :file_server
   end
 end

data/lib/puppet/forge.rb

@@ -4,8 +4,17 @@ require 'pathname'
 require 'uri'
 require 'puppet/forge/cache'
 require 'puppet/forge/repository'
+require 'puppet/forge/errors'
+
+class Puppet::Forge
+  # +consumer_name+ is a name to be used for identifying the consumer of the
+  # forge and +consumer_semver+ is a SemVer object to identify the version of
+  # the consumer
+  def initialize(consumer_name, consumer_semver)
+    @consumer_name = consumer_name
+    @consumer_semver = consumer_semver
+  end
 
-module Puppet::Forge
   # Return a list of module metadata hashes that match the search query.
   # This return value is used by the module_tool face install search,
   # and displayed to on the console.
@@ -25,27 +34,24 @@ module Puppet::Forge
   #   }
   # ]
   #
-  def self.search(term)
-    server = Puppet.settings[:module_repository].sub(/^(?!https?:\/\/)/, 'http://')
+  def search(term)
+    server = Puppet.settings[:module_repository]
     Puppet.notice "Searching #{server} ..."
-    request = Net::HTTP::Get.new("/modules.json?q=#{URI.escape(term)}")
-    response = repository.make_http_request(request)
+    response = repository.make_http_request("/modules.json?q=#{URI.escape(term)}")
 
     case response.code
     when "200"
       matches = PSON.parse(response.body)
     else
       raise RuntimeError, "Could not execute search (HTTP #{response.code})"
-      matches = []
     end
 
     matches
   end
 
-  def self.remote_dependency_info(author, mod_name, version)
+  def remote_dependency_info(author, mod_name, version)
     version_string = version ? "&version=#{version}" : ''
-    request = Net::HTTP::Get.new("/api/v1/releases.json?module=#{author}/#{mod_name}" + version_string)
-    response = repository.make_http_request(request)
+    response = repository.make_http_request("/api/v1/releases.json?module=#{author}/#{mod_name}#{version_string}")
     json = PSON.parse(response.body) rescue {}
     case response.code
     when "200"
@@ -60,7 +66,7 @@ module Puppet::Forge
     end
   end
 
-  def self.get_release_packages_from_repository(install_list)
+  def get_release_packages_from_repository(install_list)
     install_list.map do |release|
       modname, version, file = release
       cache_path = nil
@@ -80,7 +86,7 @@ module Puppet::Forge
   # Locate a module release package on the local filesystem and move it
   # into the `Puppet.settings[:module_working_dir]`. Do not unpack it, just
   # return the location of the package on disk.
-  def self.get_release_package_from_filesystem(filename)
+  def get_release_package_from_filesystem(filename)
     if File.exist?(File.expand_path(filename))
       repository = Repository.new('file:///')
       uri = URI.parse("file://#{URI.escape(File.expand_path(filename))}")
@@ -92,7 +98,17 @@ module Puppet::Forge
     cache_path
   end
 
-  def self.repository
-    @repository ||= Puppet::Forge::Repository.new
+  def retrieve(release)
+    repository.retrieve(release)
+  end
+
+  def uri
+    repository.uri
+  end
+
+  def repository
+    version = "#{@consumer_name}/#{[@consumer_semver.major, @consumer_semver.minor, @consumer_semver.tiny].join('.')}#{@consumer_semver.special}"
+    @repository ||= Puppet::Forge::Repository.new(Puppet[:module_repository], version)
   end
+  private :repository
 end

data/lib/puppet/forge/cache.rb

@@ -1,6 +1,6 @@
 require 'uri'
 
-module Puppet::Forge
+class Puppet::Forge
   # = Cache
   #
   # Provides methods for reading files from local cache, filesystem or network.

data/lib/puppet/forge/errors.rb

@@ -0,0 +1,69 @@
+require 'puppet/error'
+
+# Puppet::Forge specific exceptions
+module Puppet::Forge::Errors
+
+  # This exception is the parent for all Forge API errors
+  class ForgeError < Puppet::Error
+    # This is normally set by the child class, but if it is not this will
+    # fall back to displaying the message as a multiline.
+    #
+    # @return [String] the multiline version of the error message
+    def multiline
+      self.message
+    end
+  end
+
+  # This exception is raised when there is an SSL verification error when
+  # communicating with the forge.
+  class SSLVerifyError < ForgeError
+    # @option options [String] :uri The URI that failed
+    # @option options [String] :original the original exception
+    def initialize(options)
+      @uri     = options[:uri]
+      original = options[:original]
+
+      super("Unable to verify the SSL certificate at #{@uri}", original)
+    end
+
+    # Return a multiline version of the error message
+    #
+    # @return [String] the multiline version of the error message
+    def multiline
+      message = <<-EOS.chomp
+Could not connect via HTTPS to #{@uri}
+  Unable to verify the SSL certificate
+    The certificate may not be signed by a valid CA
+    The CA bundle included with OpenSSL may not be valid or up to date
+      EOS
+    end
+  end
+
+  # This exception is raised when there is a communication error when connecting
+  # to the forge
+  class CommunicationError < ForgeError
+    # @option options [String] :uri The URI that failed
+    # @option options [String] :original the original exception
+    def initialize(options)
+      @uri     = options[:uri]
+      original = options[:original]
+      @detail  = original.message
+
+      message = "Unable to connect to the server at #{@uri}. Detail: #{@detail}."
+      super(message, original)
+    end
+
+    # Return a multiline version of the error message
+    #
+    # @return [String] the multiline version of the error message
+    def multiline
+      message = <<-EOS.chomp
+Could not connect to #{@uri}
+  There was a network communications problem
+    The error we caught said '#{@detail}'
+    Check your network connection and try again
+      EOS
+    end
+  end
+
+end

data/lib/puppet/forge/repository.rb

@@ -1,20 +1,40 @@
-require 'net/http'
+require 'net/https'
+require 'zlib'
 require 'digest/sha1'
 require 'uri'
+require 'puppet/forge/errors'
 
-module Puppet::Forge
+class Puppet::Forge
   # = Repository
   #
   # This class is a file for accessing remote repositories with modules.
   class Repository
+    include Puppet::Forge::Errors
 
     attr_reader :uri, :cache
 
-    # Instantiate a new repository instance rooted at the optional string
-    # +url+, else an instance of the default Puppet modules repository.
-    def initialize(url=Puppet[:module_repository])
-      @uri = url.is_a?(::URI) ? url : ::URI.parse(url.sub(/^(?!https?:\/\/)/, 'http://'))
+    # List of Net::HTTP exceptions to catch
+    NET_HTTP_EXCEPTIONS = [
+      EOFError,
+      Errno::ECONNABORTED,
+      Errno::ECONNREFUSED,
+      Errno::ECONNRESET,
+      Errno::EINVAL,
+      Errno::ETIMEDOUT,
+      Net::HTTPBadResponse,
+      Net::HTTPHeaderSyntaxError,
+      Net::ProtocolError,
+      SocketError,
+      Zlib::GzipFile::Error,
+    ]
+
+    # Instantiate a new repository instance rooted at the +url+.
+    # The agent will report +consumer_version+ in the User-Agent to
+    # the repository.
+    def initialize(url, consumer_version)
+      @uri = url.is_a?(::URI) ? url : ::URI.parse(url)
       @cache = Cache.new(self)
+      @consumer_version = consumer_version
     end
 
     # Read HTTP proxy configurationm from Puppet's config file, or the
@@ -53,8 +73,9 @@ module Puppet::Forge
       return Puppet.settings[:http_proxy_port]
     end
 
-    # Return a Net::HTTPResponse read for this +request+.
-    def make_http_request(request, options = {})
+    # Return a Net::HTTPResponse read for this +request_path+.
+    def make_http_request(request_path)
+      request = Net::HTTP::Get.new(request_path, { "User-Agent" => user_agent })
       if ! @uri.user.nil? && ! @uri.password.nil?
         request.basic_auth(@uri.user, @uri.password)
       end
@@ -62,23 +83,53 @@ module Puppet::Forge
     end
 
     # Return a Net::HTTPResponse read from this HTTPRequest +request+.
+    #
+    # @param request [Net::HTTPRequest] request to make
+    # @return [Net::HTTPResponse] response from request
+    # @raise [Puppet::Forge::Errors::CommunicationError] if there is a network
+    #   related error
+    # @raise [Puppet::Forge::Errors::SSLVerifyError] if there is a problem
+    #  verifying the remote SSL certificate
     def read_response(request)
-      begin
-        Net::HTTP::Proxy(
-            http_proxy_host,
-            http_proxy_port
-            ).start(@uri.host, @uri.port) do |http|
-          http.request(request)
-        end
-      rescue Errno::ECONNREFUSED, SocketError
-        msg = "Error: Could not connect to #{@uri}\n"
-        msg << "  There was a network communications problem\n"
-        msg << "    Check your network connection and try again\n"
-        Puppet.err msg
-        exit(1)
+      http_object = get_http_object
+
+      http_object.start do |http|
+        http.request(request)
+      end
+    rescue *NET_HTTP_EXCEPTIONS => e
+      raise CommunicationError.new(:uri => @uri.to_s, :original => e)
+    rescue OpenSSL::SSL::SSLError => e
+      if e.message =~ /certificate verify failed/
+        raise SSLVerifyError.new(:uri => @uri.to_s, :original => e)
+      else
+        raise e
       end
     end
 
+    # Return a Net::HTTP::Proxy object constructed from the settings provided
+    # accessing the repository.
+    #
+    # This method optionally configures SSL correctly if the URI scheme is
+    # 'https', including setting up the root certificate store so remote server
+    # SSL certificates can be validated.
+    #
+    # @return [Net::HTTP::Proxy] object constructed from repo settings
+    def get_http_object
+      proxy_class = Net::HTTP::Proxy(http_proxy_host, http_proxy_port)
+      proxy = proxy_class.new(@uri.host, @uri.port)
+
+      if @uri.scheme == 'https'
+        cert_store = OpenSSL::X509::Store.new
+        cert_store.set_default_paths
+
+        proxy.use_ssl = true
+        proxy.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        proxy.cert_store = cert_store
+      end
+
+      proxy
+    end
+
     # Return the local file name containing the data downloaded from the
     # repository at +release+ (e.g. "myuser-mymodule").
     def retrieve(release)
@@ -98,5 +149,17 @@ module Puppet::Forge
         Digest::SHA1.hexdigest(@uri.to_s)
       ].join('-')
     end
+
+    def user_agent
+      "#{@consumer_version} Puppet/#{Puppet.version} (#{Facter.value(:operatingsystem)} #{Facter.value(:operatingsystemrelease)}) #{ruby_version}"
+    end
+    private :user_agent
+
+    def ruby_version
+      # the patchlevel is not available in ruby 1.8.5
+      patch = defined?(RUBY_PATCHLEVEL) ? "-p#{RUBY_PATCHLEVEL}" : ""
+      "Ruby/#{RUBY_VERSION}#{patch} (#{RUBY_RELEASE_DATE}; #{RUBY_PLATFORM})"
+    end
+    private :ruby_version
   end
 end