puppet-parse 0.0.1 → 0.0.2

data/lib/vendor/puppet/indirector/file_metadata.rb

@@ -0,0 +1,5 @@
+# A stub class, so our constants work.
+class Puppet::Indirector::FileMetadata # :nodoc:
+end
+
+require 'puppet/file_serving/metadata'

data/lib/vendor/puppet/indirector/file_server.rb

@@ -0,0 +1,65 @@
+require 'puppet/file_serving/configuration'
+require 'puppet/file_serving/fileset'
+require 'puppet/file_serving/terminus_helper'
+require 'puppet/indirector/terminus'
+
+# Look files up using the file server.
+class Puppet::Indirector::FileServer < Puppet::Indirector::Terminus
+  include Puppet::FileServing::TerminusHelper
+
+  # Is the client authorized to perform this action?
+  def authorized?(request)
+    return false unless [:find, :search].include?(request.method)
+
+    mount, file_path = configuration.split_path(request)
+
+    # If we're not serving this mount, then access is denied.
+    return false unless mount
+    mount.allowed?(request.node, request.ip)
+  end
+
+  # Find our key using the fileserver.
+  def find(request)
+    mount, relative_path = configuration.split_path(request)
+
+    return nil unless mount
+
+    # The mount checks to see if the file exists, and returns nil
+    # if not.
+    return nil unless path = mount.find(relative_path, request)
+    result = model.new(path)
+    result.links = request.options[:links] if request.options[:links]
+    result.collect
+    result
+  end
+
+  # Search for files.  This returns an array rather than a single
+  # file.
+  def search(request)
+    mount, relative_path = configuration.split_path(request)
+
+    unless mount and paths = mount.search(relative_path, request)
+      Puppet.info "Could not find filesystem info for file '#{request.key}' in environment #{request.environment}"
+      return nil
+    end
+
+    filesets = paths.collect do |path|
+      # Filesets support indirector requests as an options collection
+      Puppet::FileServing::Fileset.new(path, request)
+    end
+
+    Puppet::FileServing::Fileset.merge(*filesets).collect do |file, base_path|
+      inst = model.new(base_path, :relative_path => file)
+      inst.links = request.options[:links] if request.options[:links]
+      inst.collect
+      inst
+    end
+  end
+
+  private
+
+  # Our fileserver configuration, if needed.
+  def configuration
+    Puppet::FileServing::Configuration.configuration
+  end
+end

data/lib/vendor/puppet/indirector/indirection.rb

@@ -0,0 +1,323 @@
+require 'puppet/util/docs'
+require 'puppet/indirector/envelope'
+require 'puppet/indirector/request'
+require 'puppet/util/instrumentation/instrumentable'
+
+# The class that connects functional classes with their different collection
+# back-ends.  Each indirection has a set of associated terminus classes,
+# each of which is a subclass of Puppet::Indirector::Terminus.
+class Puppet::Indirector::Indirection
+  include Puppet::Util::Docs
+  extend Puppet::Util::Instrumentation::Instrumentable
+
+  attr_accessor :name, :model
+  attr_reader :termini
+
+  probe :find, :label => Proc.new { |parent, key, *args| "find_#{parent.name}_#{parent.terminus_class}" }, :data => Proc.new { |parent, key, *args| { :key => key }}
+  probe :save, :label => Proc.new { |parent, key, *args| "save_#{parent.name}_#{parent.terminus_class}" }, :data => Proc.new { |parent, key, *args| { :key => key }}
+  probe :search, :label => Proc.new { |parent, key, *args| "search_#{parent.name}_#{parent.terminus_class}" }, :data => Proc.new { |parent, key, *args| { :key => key }}
+  probe :destroy, :label => Proc.new { |parent, key, *args| "destroy_#{parent.name}_#{parent.terminus_class}" }, :data => Proc.new { |parent, key, *args| { :key => key }}
+
+  @@indirections = []
+
+  # Find an indirection by name.  This is provided so that Terminus classes
+  # can specifically hook up with the indirections they are associated with.
+  def self.instance(name)
+    @@indirections.find { |i| i.name == name }
+  end
+
+  # Return a list of all known indirections.  Used to generate the
+  # reference.
+  def self.instances
+    @@indirections.collect { |i| i.name }
+  end
+
+  # Find an indirected model by name.  This is provided so that Terminus classes
+  # can specifically hook up with the indirections they are associated with.
+  def self.model(name)
+    return nil unless match = @@indirections.find { |i| i.name == name }
+    match.model
+  end
+
+  # Create and return our cache terminus.
+  def cache
+    raise(Puppet::DevError, "Tried to cache when no cache class was set") unless cache_class
+    terminus(cache_class)
+  end
+
+  # Should we use a cache?
+  def cache?
+    cache_class ? true : false
+  end
+
+  attr_reader :cache_class
+  # Define a terminus class to be used for caching.
+  def cache_class=(class_name)
+    validate_terminus_class(class_name) if class_name
+    @cache_class = class_name
+  end
+
+  # This is only used for testing.
+  def delete
+    @@indirections.delete(self) if @@indirections.include?(self)
+  end
+
+  # Set the time-to-live for instances created through this indirection.
+  def ttl=(value)
+    raise ArgumentError, "Indirection TTL must be an integer" unless value.is_a?(Fixnum)
+    @ttl = value
+  end
+
+  # Default to the runinterval for the ttl.
+  def ttl
+    @ttl ||= Puppet[:runinterval].to_i
+  end
+
+  # Calculate the expiration date for a returned instance.
+  def expiration
+    Time.now + ttl
+  end
+
+  # Generate the full doc string.
+  def doc
+    text = ""
+
+    text += scrub(@doc) + "\n\n" if @doc
+
+    if s = terminus_setting
+      text += "* **Terminus Setting**: #{terminus_setting}"
+    end
+
+    text
+  end
+
+  def initialize(model, name, options = {})
+    @model = model
+    @name = name
+    @termini = {}
+
+    @cache_class = nil
+    @terminus_class = nil
+
+    raise(ArgumentError, "Indirection #{@name} is already defined") if @@indirections.find { |i| i.name == @name }
+    @@indirections << self
+
+    if mod = options[:extend]
+      extend(mod)
+      options.delete(:extend)
+    end
+
+    # This is currently only used for cache_class and terminus_class.
+    options.each do |name, value|
+      begin
+        send(name.to_s + "=", value)
+      rescue NoMethodError
+        raise ArgumentError, "#{name} is not a valid Indirection parameter"
+      end
+    end
+  end
+
+  # Set up our request object.
+  def request(*args)
+    Puppet::Indirector::Request.new(self.name, *args)
+  end
+
+  # Return the singleton terminus for this indirection.
+  def terminus(terminus_name = nil)
+    # Get the name of the terminus.
+    raise Puppet::DevError, "No terminus specified for #{self.name}; cannot redirect" unless terminus_name ||= terminus_class
+
+    termini[terminus_name] ||= make_terminus(terminus_name)
+  end
+
+  # This can be used to select the terminus class.
+  attr_accessor :terminus_setting
+
+  # Determine the terminus class.
+  def terminus_class
+    unless @terminus_class
+      if setting = self.terminus_setting
+        self.terminus_class = Puppet.settings[setting].to_sym
+      else
+        raise Puppet::DevError, "No terminus class nor terminus setting was provided for indirection #{self.name}"
+      end
+    end
+    @terminus_class
+  end
+
+  def reset_terminus_class
+    @terminus_class = nil
+  end
+
+  # Specify the terminus class to use.
+  def terminus_class=(klass)
+    validate_terminus_class(klass)
+    @terminus_class = klass
+  end
+
+  # This is used by terminus_class= and cache=.
+  def validate_terminus_class(terminus_class)
+    raise ArgumentError, "Invalid terminus name #{terminus_class.inspect}" unless terminus_class and terminus_class.to_s != ""
+    unless Puppet::Indirector::Terminus.terminus_class(self.name, terminus_class)
+      raise ArgumentError, "Could not find terminus #{terminus_class} for indirection #{self.name}"
+    end
+  end
+
+  # Expire a cached object, if one is cached.  Note that we don't actually
+  # remove it, we expire it and write it back out to disk.  This way people
+  # can still use the expired object if they want.
+  def expire(key, *args)
+    request = request(:expire, key, *args)
+
+    return nil unless cache?
+
+    return nil unless instance = cache.find(request(:find, key, *args))
+
+    Puppet.info "Expiring the #{self.name} cache of #{instance.name}"
+
+    # Set an expiration date in the past
+    instance.expiration = Time.now - 60
+
+    cache.save(request(:save, instance, *args))
+  end
+
+  # Search for an instance in the appropriate terminus, caching the
+  # results if caching is configured..
+  def find(key, *args)
+    request = request(:find, key, *args)
+    terminus = prepare(request)
+
+    if result = find_in_cache(request)
+      return result
+    end
+
+    # Otherwise, return the result from the terminus, caching if appropriate.
+    if ! request.ignore_terminus? and result = terminus.find(request)
+      result.expiration ||= self.expiration if result.respond_to?(:expiration)
+      if cache? and request.use_cache?
+        Puppet.info "Caching #{self.name} for #{request.key}"
+        cache.save request(:save, result, *args)
+      end
+
+      return terminus.respond_to?(:filter) ? terminus.filter(result) : result
+    end
+
+    nil
+  end
+
+  # Search for an instance in the appropriate terminus, and return a
+  # boolean indicating whether the instance was found.
+  def head(key, *args)
+    request = request(:head, key, *args)
+    terminus = prepare(request)
+
+    # Look in the cache first, then in the terminus.  Force the result
+    # to be a boolean.
+    !!(find_in_cache(request) || terminus.head(request))
+  end
+
+  def find_in_cache(request)
+    # See if our instance is in the cache and up to date.
+    return nil unless cache? and ! request.ignore_cache? and cached = cache.find(request)
+    if cached.expired?
+      Puppet.info "Not using expired #{self.name} for #{request.key} from cache; expired at #{cached.expiration}"
+      return nil
+    end
+
+    Puppet.debug "Using cached #{self.name} for #{request.key}"
+    cached
+  rescue => detail
+    puts detail.backtrace if Puppet[:trace]
+    Puppet.err "Cached #{self.name} for #{request.key} failed: #{detail}"
+    nil
+  end
+
+  # Remove something via the terminus.
+  def destroy(key, *args)
+    request = request(:destroy, key, *args)
+    terminus = prepare(request)
+
+    result = terminus.destroy(request)
+
+    if cache? and cached = cache.find(request(:find, key, *args))
+      # Reuse the existing request, since it's equivalent.
+      cache.destroy(request)
+    end
+
+    result
+  end
+
+  # Search for more than one instance.  Should always return an array.
+  def search(key, *args)
+    request = request(:search, key, *args)
+    terminus = prepare(request)
+
+    if result = terminus.search(request)
+      raise Puppet::DevError, "Search results from terminus #{terminus.name} are not an array" unless result.is_a?(Array)
+      result.each do |instance|
+        next unless instance.respond_to? :expiration
+        instance.expiration ||= self.expiration
+      end
+      return result
+    end
+  end
+
+  # Save the instance in the appropriate terminus.  This method is
+  # normally an instance method on the indirected class.
+  def save(instance, key = nil)
+    request = request(:save, key, instance)
+    terminus = prepare(request)
+
+    result = terminus.save(request)
+
+    # If caching is enabled, save our document there
+    cache.save(request) if cache?
+
+    result
+  end
+
+  private
+
+  # Check authorization if there's a hook available; fail if there is one
+  # and it returns false.
+  def check_authorization(request, terminus)
+    # At this point, we're assuming authorization makes no sense without
+    # client information.
+    return unless request.node
+
+    # This is only to authorize via a terminus-specific authorization hook.
+    return unless terminus.respond_to?(:authorized?)
+
+    unless terminus.authorized?(request)
+      msg = "Not authorized to call #{request.method} on #{request}"
+      msg += " with #{request.options.inspect}" unless request.options.empty?
+      raise ArgumentError, msg
+    end
+  end
+
+  # Setup a request, pick the appropriate terminus, check the request's authorization, and return it.
+  def prepare(request)
+    # Pick our terminus.
+    if respond_to?(:select_terminus)
+      unless terminus_name = select_terminus(request)
+        raise ArgumentError, "Could not determine appropriate terminus for #{request}"
+      end
+    else
+      terminus_name = terminus_class
+    end
+
+    dest_terminus = terminus(terminus_name)
+    check_authorization(request, dest_terminus)
+
+    dest_terminus
+  end
+
+  # Create a new terminus instance.
+  def make_terminus(terminus_class)
+    # Load our terminus class.
+    unless klass = Puppet::Indirector::Terminus.terminus_class(self.name, terminus_class)
+      raise ArgumentError, "Could not find terminus #{terminus_class} for indirection #{self.name}"
+    end
+    klass.new
+  end
+end

data/lib/vendor/puppet/indirector/instrumentation_data/local.rb

@@ -0,0 +1,19 @@
+require 'puppet/indirector/instrumentation_data'
+
+class Puppet::Indirector::InstrumentationData::Local < Puppet::Indirector::Code
+  def find(request)
+    model.new(request.key)
+  end
+
+  def search(request)
+    raise Puppet::DevError, "You cannot search for instrumentation data"
+  end
+
+  def save(request)
+    raise Puppet::DevError, "You cannot save instrumentation data"
+  end
+
+  def destroy(request)
+    raise Puppet::DevError, "You cannot remove instrumentation data"
+  end
+end

data/lib/vendor/puppet/indirector/instrumentation_data/rest.rb

@@ -0,0 +1,5 @@
+require 'puppet/indirector/rest'
+require 'puppet/indirector/instrumentation_data'
+
+class Puppet::Indirector::InstrumentationData::Rest < Puppet::Indirector::REST
+end

data/lib/vendor/puppet/indirector/instrumentation_data.rb

@@ -0,0 +1,3 @@
+# A stub class, so our constants work.
+class Puppet::Indirector::InstrumentationData
+end

data/lib/vendor/puppet/indirector/instrumentation_listener/local.rb

@@ -0,0 +1,23 @@
+require 'puppet/indirector/instrumentation_listener'
+
+class Puppet::Indirector::InstrumentationListener::Local < Puppet::Indirector::Code
+  def find(request)
+    Puppet::Util::Instrumentation[request.key]
+  end
+
+  def search(request)
+    Puppet::Util::Instrumentation.listeners
+  end
+
+  def save(request)
+    res = request.instance
+    Puppet::Util::Instrumentation[res.name] = res
+    nil # don't leak the listener
+  end
+
+  def destroy(request)
+    listener = Puppet::Util::Instrumentation[request.key]
+    raise "Listener #{request.key} hasn't been subscribed" unless listener
+    Puppet::Util::Instrumentation.unsubscribe(listener)
+  end
+end

data/lib/vendor/puppet/indirector/instrumentation_listener/rest.rb

@@ -0,0 +1,5 @@
+require 'puppet/indirector/instrumentation_listener'
+require 'puppet/indirector/rest'
+
+class Puppet::Indirector::InstrumentationListener::Rest < Puppet::Indirector::REST
+end

data/lib/vendor/puppet/indirector/instrumentation_listener.rb

@@ -0,0 +1,3 @@
+# A stub class, so our constants work.
+class Puppet::Indirector::InstrumentationListener
+end

data/lib/vendor/puppet/indirector/instrumentation_probe/local.rb

@@ -0,0 +1,24 @@
+require 'puppet/indirector/instrumentation_probe'
+require 'puppet/indirector/code'
+require 'puppet/util/instrumentation/indirection_probe'
+
+class Puppet::Indirector::InstrumentationProbe::Local < Puppet::Indirector::Code
+  def find(request)
+  end
+
+  def search(request)
+    probes = []
+    Puppet::Util::Instrumentation::Instrumentable.each_probe do |probe|
+      probes << Puppet::Util::Instrumentation::IndirectionProbe.new("#{probe.klass}.#{probe.method}")
+    end
+    probes
+  end
+
+  def save(request)
+    Puppet::Util::Instrumentation::Instrumentable.enable_probes
+  end
+
+  def destroy(request)
+    Puppet::Util::Instrumentation::Instrumentable.disable_probes
+  end
+end

data/lib/vendor/puppet/indirector/instrumentation_probe/rest.rb

@@ -0,0 +1,5 @@
+require 'puppet/indirector/rest'
+require 'puppet/indirector/instrumentation_probe'
+
+class Puppet::Indirector::InstrumentationProbe::Rest < Puppet::Indirector::REST
+end

data/lib/vendor/puppet/indirector/instrumentation_probe.rb

@@ -0,0 +1,3 @@
+# A stub class, so our constants work.
+class Puppet::Indirector::InstrumentationProbe
+end

data/lib/vendor/puppet/indirector/inventory/yaml.rb

@@ -0,0 +1,81 @@
+require 'puppet/node/inventory'
+require 'puppet/indirector/yaml'
+
+class Puppet::Node::Inventory::Yaml < Puppet::Indirector::Yaml
+  desc "Return node names matching the fact query"
+
+  # Return the path to a given node's file.
+  def yaml_dir_path
+    base = Puppet.run_mode.master? ? Puppet[:yamldir] : Puppet[:clientyamldir]
+    File.join(base, 'facts', '*.yaml')
+  end
+
+  def node_matches?(facts, options)
+    options.each do |key, value|
+      type, name, operator = key.to_s.split(".")
+      operator ||= 'eq'
+
+      return false unless node_matches_option?(type, name, operator, value, facts)
+    end
+    return true
+  end
+
+  def search(request)
+    node_names = []
+    Dir.glob(yaml_dir_path).each do |file|
+      facts = YAML.load_file(file)
+      node_names << facts.name if node_matches?(facts, request.options)
+    end
+    node_names
+  end
+
+  private
+
+  def node_matches_option?(type, name, operator, value, facts)
+    case type
+    when "meta"
+      case name
+      when "timestamp"
+        compare_timestamp(operator, facts.timestamp, Time.parse(value))
+      end
+    when "facts"
+      compare_facts(operator, facts.values[name], value)
+    end
+  end
+
+  def compare_facts(operator, value1, value2)
+    return false unless value1
+
+    case operator
+    when "eq"
+      value1.to_s == value2.to_s
+    when "le"
+      value1.to_f <= value2.to_f
+    when "ge"
+      value1.to_f >= value2.to_f
+    when "lt"
+      value1.to_f < value2.to_f
+    when "gt"
+      value1.to_f > value2.to_f
+    when "ne"
+      value1.to_s != value2.to_s
+    end
+  end
+
+  def compare_timestamp(operator, value1, value2)
+    case operator
+    when "eq"
+      value1 == value2
+    when "le"
+      value1 <= value2
+    when "ge"
+      value1 >= value2
+    when "lt"
+      value1 < value2
+    when "gt"
+      value1 > value2
+    when "ne"
+      value1 != value2
+    end
+  end
+end

data/lib/vendor/puppet/indirector/key/ca.rb

@@ -0,0 +1,12 @@
+require 'puppet/indirector/ssl_file'
+require 'puppet/ssl/key'
+
+class Puppet::SSL::Key::Ca < Puppet::Indirector::SslFile
+  desc "Manage the CA's private on disk.  This terminus *only* works
+    with the CA key, because that's the only key that the CA ever interacts
+    with."
+
+  store_in :privatekeydir
+
+  store_ca_at :cakey
+end

data/lib/vendor/puppet/indirector/key/disabled_ca.rb

@@ -0,0 +1,22 @@
+require 'puppet/indirector/code'
+require 'puppet/ssl/key'
+
+class Puppet::SSL::Key::DisabledCa < Puppet::Indirector::Code
+  desc "Manage the CA private key, but reject any remote access
+to the SSL data store. Used when a master has an explicitly disabled CA to
+prevent clients getting confusing 'success' behaviour."
+
+  def initialize
+    @file = Puppet::SSL::Key.indirection.terminus(:file)
+  end
+
+  [:find, :head, :search, :save, :destroy].each do |name|
+    define_method(name) do |request|
+      if request.remote?
+        raise Puppet::Error, "this master is not a CA"
+      else
+        @file.send(name, request)
+      end
+    end
+  end
+end

data/lib/vendor/puppet/indirector/key/file.rb

@@ -0,0 +1,42 @@
+require 'puppet/indirector/ssl_file'
+require 'puppet/ssl/key'
+
+class Puppet::SSL::Key::File < Puppet::Indirector::SslFile
+  desc "Manage SSL private and public keys on disk."
+
+  store_in :privatekeydir
+  store_ca_at :cakey
+
+  # Where should we store the public key?
+  def public_key_path(name)
+    if ca?(name)
+      Puppet[:capub]
+    else
+      File.join(Puppet[:publickeydir], name.to_s + ".pem")
+    end
+  end
+
+  # Remove the public key, in addition to the private key
+  def destroy(request)
+    super
+
+    return unless FileTest.exist?(public_key_path(request.key))
+
+    begin
+      File.unlink(public_key_path(request.key))
+    rescue => detail
+      raise Puppet::Error, "Could not remove #{request.key} public key: #{detail}"
+    end
+  end
+
+  # Save the public key, in addition to the private key.
+  def save(request)
+    super
+
+    begin
+      Puppet.settings.writesub(:publickeydir, public_key_path(request.key)) { |f| f.print request.instance.content.public_key.to_pem }
+    rescue => detail
+      raise Puppet::Error, "Could not write #{request.key}: #{detail}"
+    end
+  end
+end